TextStream类 参考

Text streaming class that buffers data. 更多...

#include <textstream.h>

Public 成员函数
	TextStream ()
	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 更多...
	TextStream (const TextStream &)=delete
TextStream &	operator= (const TextStream &)=delete
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<< (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 更多...
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 成员函数
void	output_int32 (uint32_t n, bool neg)
	Writes a string representation of an integer to the buffer 更多...
void	output_double (double d)

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

静态 Private 属性
static const int	INITIAL_CAPACITY = 4096

详细描述

Text streaming class that buffers data.

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

在文件 textstream.h 第 33 行定义.

构造及析构函数说明

TextStream() [1/4]

TextStream::TextStream ( )

inline

Creates an empty stream object.

在文件 textstream.h 第 52 行定义.

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

引用了 INITIAL_CAPACITY , 以及 m_buffer.

TextStream() [2/4]

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

inline

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

注解

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

在文件 textstream.h 第 59 行定义.

TextStream() [3/4]

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

inline

Create a text stream, initializing the buffer with string s

在文件 textstream.h 第 65 行定义.

    {
      flush();

引用了 flush(), m_f , 以及 m_s.

~TextStream()

TextStream::~TextStream ( )

inline

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

在文件 textstream.h 第 71 行定义.

{

TextStream() [4/4]

TextStream::TextStream ( const TextStream &  )

delete

成员函数说明

clear()

void TextStream::clear ( )

inline

Clears any buffered data

在文件 textstream.h 第 202 行定义.

    {
      flush();

引用了 flush() , 以及 m_buffer.

empty()

bool TextStream::empty ( ) const

inline

Returns true iff the buffer is empty

在文件 textstream.h 第 232 行定义.

      {

被这些函数引用 HtmlGenerator::endClassDiagram(), ClassContext::Private::inheritanceDiagram(), insertMapFile(), DotFilePatcher::run() , 以及 writeDotImageMapFromFile().

file()

FILE* TextStream::file ( ) const

inline

在文件 textstream.h 第 101 行定义.

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

引用了 m_buffer.

被这些函数引用 TextGeneratorOLImpl::writeLink().

flush()

void TextStream::flush ( )

inline

Flushes the buffer.

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

在文件 textstream.h 第 188 行定义.

    {
      m_buffer.clear();
    }
 
    /** Return the contents of the buffer as a std::string object */
    std::string str() const
    {
      return m_buffer;
    }
 

引用了 m_buffer.

被这些函数引用 clear(), OutputGenerator::endPlainFile(), FormulaManager::generateImages(), RTFGenerator::preProcessFileInplace(), TemplateNodeMsg::render(), DotFilePatcher::run(), str(), TextStream(), FlowChart::writeFlowChart() , 以及 VhdlDocGen::writeOverview().

operator<<() [1/10]

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

inline

Adds a character to the stream

在文件 textstream.h 第 107 行定义.

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

引用了 m_buffer , 以及 QCString::str().

operator<<() [2/10]

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

inline

Adds a C-style string to the stream

在文件 textstream.h 第 114 行定义.

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

引用了 m_buffer.

operator<<() [3/10]

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

inline

Adds a QCString to the stream

在文件 textstream.h 第 121 行定义.

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

引用了 output_int32().

operator<<() [4/10]

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

inline

Adds a std::string to the stream

在文件 textstream.h 第 128 行定义.

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

引用了 output_int32().

operator<<() [5/10]

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

inline

Adds a double to the stream

在文件 textstream.h 第 170 行定义.

    {

operator<<() [6/10]

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

inline

Adds a float to the stream

在文件 textstream.h 第 163 行定义.

    {

引用了 m_buffer.

operator<<() [7/10]

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

inline

Adds a signed integer to the stream

在文件 textstream.h 第 149 行定义.

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

引用了 output_double().

operator<<() [8/10]

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

inline

Adds a signed short integer to the stream

在文件 textstream.h 第 135 行定义.

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

引用了 output_int32().

operator<<() [9/10]

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

inline

Adds a unsigned integer to the stream

在文件 textstream.h 第 156 行定义.

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

引用了 output_double().

operator<<() [10/10]

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

inline

Adds a unsigned short integer to the stream

在文件 textstream.h 第 142 行定义.

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

引用了 output_int32().

operator=()

TextStream& TextStream::operator= ( const TextStream &  )

delete

output_double()

void TextStream::output_double ( double  d )

inlineprivate

在文件 textstream.h 第 255 行定义.

被这些函数引用 operator<<().

output_int32()

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

inlineprivate

Writes a string representation of an integer to the buffer

参数

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

在文件 textstream.h 第 242 行定义.

    {
      char buf[64];
      snprintf(buf,64,"%f",d);
      m_buffer+=buf;
    }
    std::string m_buffer;
    std::ostream *m_s = nullptr;
    FILE *m_f = nullptr;
};
 
#endif

引用了 m_buffer.

被这些函数引用 operator<<().

setFile()

void TextStream::setFile ( FILE *  f )

inline

在文件 textstream.h 第 86 行定义.

    {
      return m_f;
    }

被这些函数引用 OutputGenerator::startPlainFile().

setStream()

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

inline

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

注解

Any data already buffered will be flushed.

在文件 textstream.h 第 79 行定义.

    {

引用了 m_s.

被这些函数引用 OutputGenerator::endPlainFile() , 以及 DotFilePatcher::run().

str() [1/3]

std::string TextStream::str ( ) const

inline

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

在文件 textstream.h 第 208 行定义.

    {

引用了 flush() , 以及 m_buffer.

被这些函数引用 addConceptToContext(), addEnumValuesToEnums(), addMemberDocs(), addVariableToClass(), addVariableToFile(), MemberContext::Private::callerGraph(), MemberContext::Private::callGraph(), ClassContext::Private::collaborationDiagram(), DotGraph::computeGraph(), DotGroupCollaboration::computeTheGraph(), DotLegendGraph::computeTheGraph(), DotGfxHierarchyTable::computeTheGraph(), DotDirDeps::computeTheGraph(), convertToLaTeX(), InheritanceGraphContext::Private::createGraph(), createLinkedText(), DirContext::Private::dirGraph(), QhpXmlWriter::dumpTo(), HtmlGenerator::endClassDiagram(), Entry::Entry(), escapeCommas(), getMscImageMapFromFile(), getSearchBox(), ModuleContext::Private::groupGraph(), FileContext::Private::includedByGraph(), FileContext::Private::includeGraph(), ClassContext::Private::inheritanceDiagram(), QhpXmlWriter::insert(), insertMapFile(), latexEscapeIndexChars(), latexEscapeLabelName(), latexEscapePDFString(), latexFilterURL(), parseCode(), parseCommentAsText(), parseDoc(), LatexSpaceless::remove(), HtmlSpaceless::remove(), removeAnonymousScopes(), TemplateNodeBlock::render(), TemplateNodeCreate::render(), TemplateNodeTree::renderChildren(), Entry::reset(), DotFilePatcher::run(), searchId(), stripIndentation(), substituteLatexKeywords(), templateSpec(), writeAnnotatedIndexGeneric(), writeConceptIndex(), ConceptDefImpl::writeDefinition(), writeDotImageMapFromFile(), writeFileIndex(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeNamespaceIndex() , 以及 writePageIndex().

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.

在文件 textstream.h 第 225 行定义.

    {

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.

在文件 textstream.h 第 216 行定义.

    {

stream()

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

inline

Returns the attached std::ostream object.

参见

setStream()

在文件 textstream.h 第 96 行定义.

    {

被这些函数引用 OutputGenerator::operator=() , 以及 OutputGenerator::OutputGenerator().

write()

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

inline

Adds a array of character to the stream

参数

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

在文件 textstream.h 第 180 行定义.

      {
        fwrite(m_buffer.c_str(),1,m_buffer.length(),m_f);

被这些函数引用 DotGfxHierarchyTable::computeTheGraph(), generateXML() , 以及 writeUTF8Char().

类成员变量说明

INITIAL_CAPACITY

const int TextStream::INITIAL_CAPACITY = 4096

staticprivate

在文件 textstream.h 第 48 行定义.

被这些函数引用 TextStream().

m_buffer

std::string TextStream::m_buffer

private

在文件 textstream.h 第 261 行定义.

被这些函数引用 clear(), file(), flush(), operator<<(), output_int32(), str() , 以及 TextStream().

m_f

FILE* TextStream::m_f = nullptr

private

在文件 textstream.h 第 263 行定义.

被这些函数引用 TextStream().

m_s

std::ostream* TextStream::m_s = nullptr

private

在文件 textstream.h 第 262 行定义.

被这些函数引用 setStream() , 以及 TextStream().

---

该类的文档由以下文件生成:

• src/textstream.h