ostream_text_ostream.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

#ifndef OBJTOOLS_FORMAT___OSTREAM_TEXT_OSTREAM_HPP
#define OBJTOOLS_FORMAT___OSTREAM_TEXT_OSTREAM_HPP
 
/*  $Id: ostream_text_ostream.hpp 99481 2023-04-04 13:16:28Z stakhovv $
* ===========================================================================
*
*                            PUBLIC DOMAIN NOTICE
*               National Center for Biotechnology Information
*
*  This software/database is a "United States Government Work" under the
*  terms of the United States Copyright Act.  It was written as part of
*  the author's official duties as a United States Government employee and
*  thus cannot be copyrighted.  This software/database is freely available
*  to the public for use. The National Library of Medicine and the U.S.
*  Government have not placed any restriction on its use or reproduction.
*
*  Although all reasonable efforts have been taken to ensure the accuracy
*  and reliability of the software and data, the NLM and the U.S.
*  Government do not and cannot warrant the performance or results that
*  may be obtained by using this software or data. The NLM and the U.S.
*  Government disclaim all warranties, express or implied, including
*  warranties of performance, merchantability or fitness for any particular
*  purpose.
*
*  Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
* Author:  Aaron Ucko, NCBI
*          Mati Shomrat
*
* File Description:
*   Text output stream that utilizes an ostream object as its target.
*/
#include <corelib/ncbistd.hpp>
#include <corelib/ncbiobj.hpp>
#include <corelib/ncbistre.hpp>
 
#include <objtools/format/text_ostream.hpp>
 
 
BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects)
 
 
/////////////////////////////////////////////////////////////////////////////
//
// OStreamTextOStream
 
class NCBI_FORMAT_EXPORT COStreamTextOStream : public IFlatTextOStream
{
public:
 
    COStreamTextOStream(void);
    COStreamTextOStream(CNcbiOstream& os);
 
    virtual void AddParagraph(const list<string>& text,
                              const CSerialObject* obj = nullptr);
 
    virtual void AddLine( const CTempString& line,
                          const CSerialObject* obj = nullptr,
                          EAddNewline add_newline = eAddNewline_Yes );
 
    virtual void Flush( void );
 
private:
    CNcbiOstream&   m_Ostream;
};
 
 
/////////////////////////////////////////////////////////////////////////////
//
// OStreamTextOStreamFactory
/*
class COStreamTextOStreamFactory : public IFlatTextOStreamFactory
{
public:
 
    COStreamTextOStreamFactory(void);
    COStreamTextOStreamFactory(CNcbiOstream& os);
 
    virtual IFlatTextOStream* Get(void) { return m_TextOStream; }
 
private:
 
    CRef<COStreamTextOStream>   m_TextOStream;
};
*/
 
 
END_SCOPE(objects)
END_NCBI_SCOPE
 
#endif  /* OBJTOOLS_FORMAT___OSTREAM_TEXT_OSTREAM_HPP */