TextStream Class Reference

Text streaming class that buffers data. More...

#include <src/textstream.h>

Public Member Functions
	TextStream (size_t capacity=INITIAL_CAPACITY)
	Creates an empty stream object.
	TextStream (std::ostream *s)
	Create a text stream object for writing to a std::ostream.
	TextStream (const std::string &s)
	Create a text stream, initializing the buffer with string s.
	~TextStream ()
	Writes any data that is buffered to the attached std::ostream.
void	setStream (std::ostream *s)
	Sets or changes the std::ostream to write to.
void	setFile (FILE *f)
std::ostream *	stream () const
	Returns the attached std::ostream object.
FILE *	file () const
TextStream &	operator<< (char c)
	Adds a character to the stream.
TextStream &	operator<< (unsigned char c)
	Adds an unsigned character to the stream.
TextStream &	operator<< (unsigned char *s)
	Adds an unsigned character string to the stream.
TextStream &	operator<< (const char *s)
	Adds a C-style string to the stream.
TextStream &	operator<< (const QCString &s)
	Adds a QCString to the stream.
TextStream &	operator<< (const std::string &s)
	Adds a std::string to the stream.
TextStream &	operator<< (signed short i)
	Adds a signed short integer to the stream.
TextStream &	operator<< (unsigned short i)
	Adds a unsigned short integer to the stream.
TextStream &	operator<< (signed int i)
	Adds a signed integer to the stream.
TextStream &	operator<< (unsigned int i)
	Adds a unsigned integer to the stream.
template<typename T, typename std::enable_if< std::is_same< T, size_t >::value, T >::type * = nullptr>
TextStream &	operator<< (T i)
	Adds a size_t integer to the stream.
TextStream &	operator<< (float f)
	Adds a float to the stream.
TextStream &	operator<< (double d)
	Adds a double to the stream.
void	write (const char *buf, size_t len)
	Adds a array of character to the stream.
void	flush ()
	Flushes the buffer.
void	clear ()
	Clears any buffered data.
std::string	str () const
	Return the contents of the buffer as a std::string object.
void	str (const std::string &s)
	Sets the buffer's contents to string s.
void	str (const char *s)
	Sets the buffer's contents to string s Any data already in the buffer will be flushed.
bool	empty () const
	Returns true iff the buffer is empty.

Private Member Functions
void	output_int32 (uint32_t n, bool neg)
	Writes a string representation of an integer to the buffer.
void	output_double (double d)

Private Attributes
std::string	m_buffer
std::ostream *	m_s = nullptr
FILE *	m_f = nullptr

Static Private Attributes
static const int	INITIAL_CAPACITY = 4096

Detailed Description

Text streaming class that buffers data.

Simpler version of std::ostringstream that has much better performance.

Definition at line 35 of file textstream.h.

Constructor & Destructor Documentation

TextStream() [1/3]

TextStream::TextStream ( size_t capacity = INITIAL_CAPACITY )

inlineexplicit

Creates an empty stream object.

Definition at line 41 of file textstream.h.

    {
      m_buffer.reserve(capacity);
    }

References INITIAL_CAPACITY, and m_buffer.

Referenced by operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), and operator<<().

TextStream() [2/3]

TextStream::TextStream ( std::ostream * s )

inlineexplicit

Create a text stream object for writing to a std::ostream.

Note

data is buffered until flush() is called or the object is destroyed.

Definition at line 48 of file textstream.h.

                                       : m_s(s)
    {
      m_buffer.reserve(INITIAL_CAPACITY);
    }

References INITIAL_CAPACITY, m_buffer, and m_s.

TextStream() [3/3]

TextStream::TextStream ( const std::string & s )

inlineexplicit

Create a text stream, initializing the buffer with string s.

Definition at line 54 of file textstream.h.

                                            : m_buffer(s)
    {
      m_buffer.reserve(s.length()+INITIAL_CAPACITY);
    }

References INITIAL_CAPACITY, and m_buffer.

~TextStream()

TextStream::~TextStream ( )

inline

Writes any data that is buffered to the attached std::ostream.

Definition at line 60 of file textstream.h.

{ flush(); }

References flush().

Member Function Documentation

clear()

void TextStream::clear ( )

inline

Clears any buffered data.

Definition at line 223 of file textstream.h.

    {
      m_buffer.clear();
    }

References m_buffer.

empty()

bool TextStream::empty ( ) const

inline

Returns true iff the buffer is empty.

Definition at line 253 of file textstream.h.

    {
      return m_buffer.empty();
    }

References m_buffer.

Referenced by HtmlGenerator::endClassDiagram(), insertMapFile(), DotFilePatcher::run(), and writeDotImageMapFromFile().

file()

FILE * TextStream::file ( ) const

inline

Definition at line 89 of file textstream.h.

    {
      return m_f;
    }

References m_f.

flush()

void TextStream::flush ( )

inline

Flushes the buffer.

If a std::ostream is attached, the buffer's contents will be written to the stream.

Definition at line 209 of file textstream.h.

    {
      if (m_s)
      {
        m_s->write(m_buffer.c_str(),m_buffer.length());
      }
      else if (m_f)
      {
        fwrite(m_buffer.c_str(),1,m_buffer.length(),m_f);
      }
      m_buffer.clear();
    }

References m_buffer, m_f, and m_s.

Referenced by Qhp::addContentsItem(), FormulaManager::createLatexFile(), RTFGenerator::preProcessFileInplace(), DotFilePatcher::run(), setFile(), setStream(), str(), str(), FlowChart::writeFlowChart(), and ~TextStream().

operator<<() [1/13]

TextStream & TextStream::operator<< ( char c )

inline

Adds a character to the stream.

Definition at line 95 of file textstream.h.

    {
      m_buffer+=c;
      return static_cast<TextStream&>(*this);
    }

References m_buffer, and TextStream().

operator<<() [2/13]

TextStream & TextStream::operator<< ( const char * s )

inline

Adds a C-style string to the stream.

Definition at line 123 of file textstream.h.

    {
      if (s) m_buffer+=s;
      return static_cast<TextStream&>(*this);
    }

References m_buffer, and TextStream().

operator<<() [3/13]

TextStream & TextStream::operator<< ( const QCString & s )

inline

Adds a QCString to the stream.

Definition at line 130 of file textstream.h.

    {
      m_buffer+=s.str();
      return static_cast<TextStream&>(*this);
    }

References m_buffer, QCString::str(), and TextStream().

operator<<() [4/13]

TextStream & TextStream::operator<< ( const std::string & s )

inline

Adds a std::string to the stream.

Definition at line 137 of file textstream.h.

    {
      m_buffer+=s;
      return static_cast<TextStream&>(*this);
    }

References m_buffer, and TextStream().

operator<<() [5/13]

TextStream & TextStream::operator<< ( double d )

inline

Adds a double to the stream.

Definition at line 191 of file textstream.h.

    {
      output_double(d);
      return static_cast<TextStream&>(*this);
    }

References output_double(), and TextStream().

operator<<() [6/13]

TextStream & TextStream::operator<< ( float f )

inline

Adds a float to the stream.

Definition at line 184 of file textstream.h.

    {
      output_double(static_cast<double>(f));
      return static_cast<TextStream&>(*this);
    }

References output_double(), and TextStream().

operator<<() [7/13]

TextStream & TextStream::operator<< ( signed int i )

inline

Adds a signed integer to the stream.

Definition at line 158 of file textstream.h.

    {
      output_int32(i,i<0);
      return static_cast<TextStream&>(*this);
    }

References output_int32(), and TextStream().

operator<<() [8/13]

TextStream & TextStream::operator<< ( signed short i )

inline

Adds a signed short integer to the stream.

Definition at line 144 of file textstream.h.

    {
      output_int32(i,i<0);
      return static_cast<TextStream&>(*this);
    }

References output_int32(), and TextStream().

operator<<() [9/13]

template<typename T, typename std::enable_if< std::is_same< T, size_t >::value, T >::type * = nullptr>

TextStream & TextStream::operator<< ( T i )

inline

Adds a size_t integer to the stream.

We use SFINAE to avoid a compiler error in case size_t already matches the 'unsigned int' overload.

Definition at line 177 of file textstream.h.

    {
      output_int32(static_cast<uint32_t>(i),false);
      return static_cast<TextStream&>(*this);
    }

References output_int32(), and TextStream().

operator<<() [10/13]

TextStream & TextStream::operator<< ( unsigned char * s )

inline

Adds an unsigned character string to the stream.

Definition at line 108 of file textstream.h.

    {
      if (s)
      {
        unsigned char *p = s;
        while(*p)
        {
          m_buffer+=*p;
          p++;
        }
      }
      return static_cast<TextStream&>(*this);
    }

References m_buffer, and TextStream().

operator<<() [11/13]

TextStream & TextStream::operator<< ( unsigned char c )

inline

Adds an unsigned character to the stream.

Definition at line 101 of file textstream.h.

    {
      m_buffer+=c;
      return static_cast<TextStream&>(*this);
    }

References m_buffer, and TextStream().

operator<<() [12/13]

TextStream & TextStream::operator<< ( unsigned int i )

inline

Adds a unsigned integer to the stream.

Definition at line 165 of file textstream.h.

    {
      output_int32(i,false);
      return static_cast<TextStream&>(*this);
    }

References output_int32(), and TextStream().

operator<<() [13/13]

TextStream & TextStream::operator<< ( unsigned short i )

inline

Adds a unsigned short integer to the stream.

Definition at line 151 of file textstream.h.

    {
      output_int32(i,false);
      return static_cast<TextStream&>(*this);
    }

References output_int32(), and TextStream().

output_double()

void TextStream::output_double ( double d )

inlineprivate

Definition at line 276 of file textstream.h.

    {
      char buf[64];
      snprintf(buf,64,"%f",d);
      m_buffer+=buf;
    }

References m_buffer.

Referenced by operator<<(), and operator<<().

output_int32()

void TextStream::output_int32 ( uint32_t n, bool neg )

inlineprivate

Writes a string representation of an integer to the buffer.

Parameters

n	the absolute value of the integer
neg	indicates if the integer is negative

Definition at line 263 of file textstream.h.

    {
      char buf[20];
      char *p = &buf[19];
      *p = '\0';
      if ( neg )
      {
        n = static_cast<uint32_t>(-static_cast<int32_t>(n));
      }
      do { *--p = (static_cast<char>(n%10)) + '0'; n /= 10; } while ( n );
      if ( neg ) *--p = '-';
      m_buffer+=p;
    }

References m_buffer.

Referenced by operator<<(), operator<<(), operator<<(), operator<<(), and operator<<().

setFile()

void TextStream::setFile ( FILE * f )

inline

Definition at line 74 of file textstream.h.

    {
      flush();
      m_s = nullptr;
      m_f = f;
    }

References flush(), m_f, and m_s.

setStream()

void TextStream::setStream ( std::ostream * s )

inline

Sets or changes the std::ostream to write to.

Note

Any data already buffered will be flushed.

Definition at line 67 of file textstream.h.

    {
      flush();
      m_s = s;
      m_f = nullptr;
    }

References flush(), m_f, m_s, and setStream().

Referenced by Qhp::addContentsItem(), DotFilePatcher::run(), and setStream().

str() [1/3]

std::string TextStream::str ( ) const

inline

Return the contents of the buffer as a std::string object.

Definition at line 229 of file textstream.h.

    {
      return m_buffer;
    }

References m_buffer.

Referenced by addConceptToContext(), addMemberDocs(), addVariableToClass(), addVariableToFile(), DotGraph::computeGraph(), DotDirDeps::computeTheGraph(), DotGfxHierarchyTable::computeTheGraph(), DotGroupCollaboration::computeTheGraph(), DotLegendGraph::computeTheGraph(), convertToLaTeX(), HtmlGenerator::endClassDiagram(), Entry::Entry(), generateHtmlOutput(), getMscImageMapFromFile(), getSearchBox(), getSQLDocBlock(), insertMapFile(), latexEscapeIndexChars(), latexEscapeLabelName(), latexEscapePDFString(), latexFilterURL(), HtmlDocVisitor::operator()(), parseCommentAsText(), DotFilePatcher::run(), stripIndentation(), substituteLatexKeywords(), templateSpec(), SearchTerm::termEncoded(), writeAnnotatedIndexGeneric(), writeConceptIndex(), ConceptDefImpl::writeDefinition(), writeDotImageMapFromFile(), writeFileIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeModuleIndex(), writeNamespaceIndex(), writePageIndex(), and writeTopicIndex().

str() [2/3]

void TextStream::str ( const char * s )

inline

Sets the buffer's contents to string s Any data already in the buffer will be flushed.

Definition at line 246 of file textstream.h.

    {
      flush();
      if (s) m_buffer=s;
    }

References flush(), and m_buffer.

str() [3/3]

void TextStream::str ( const std::string & s )

inline

Sets the buffer's contents to string s.

Any data already in the buffer will be flushed.

Definition at line 237 of file textstream.h.

    {
      flush();
      m_buffer=s;
    }

References flush(), and m_buffer.

stream()

std::ostream * TextStream::stream ( ) const

inline

Returns the attached std::ostream object.

See also

setStream()

Definition at line 84 of file textstream.h.

    {
      return m_s;
    }

References m_s.

write()

void TextStream::write ( const char * buf, size_t len )

inline

Adds a array of character to the stream.

Parameters

buf	the character buffer
len	the number of characters in the buffer to write

Definition at line 201 of file textstream.h.

    {
      m_buffer.append(buf,len);
    }

References m_buffer.

Referenced by generateXML(), and writeUTF8Char().

Member Data Documentation

INITIAL_CAPACITY

const int TextStream::INITIAL_CAPACITY = 4096

staticprivate

Definition at line 37 of file textstream.h.

Referenced by TextStream(), TextStream(), and TextStream().

m_buffer

std::string TextStream::m_buffer

private

Definition at line 282 of file textstream.h.

Referenced by clear(), empty(), flush(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), operator<<(), output_double(), output_int32(), str(), str(), str(), TextStream(), TextStream(), TextStream(), and write().

m_f

FILE* TextStream::m_f = nullptr

private

Definition at line 284 of file textstream.h.

Referenced by file(), flush(), setFile(), and setStream().

m_s

std::ostream* TextStream::m_s = nullptr

private

Definition at line 283 of file textstream.h.

Referenced by flush(), setFile(), setStream(), stream(), and TextStream().

---

The documentation for this class was generated from the following file:

• src/textstream.h