TiXmlPrinter Class Reference

Print to memory functionality. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlPrinter:

Collaboration diagram for TiXmlPrinter:

Public Member Functions
	TiXmlPrinter ()
virtual bool	VisitEnter (const TiXmlDocument &doc)
	Visit a document. More...
virtual bool	VisitExit (const TiXmlDocument &doc)
	Visit a document. More...
virtual bool	VisitEnter (const TiXmlElement &element, const TiXmlAttribute *firstAttribute)
	Visit an element. More...
virtual bool	VisitExit (const TiXmlElement &element)
	Visit an element. More...
virtual bool	Visit (const TiXmlDeclaration &declaration)
	Visit a declaration. More...
virtual bool	Visit (const TiXmlText &text)
	Visit a text node. More...
virtual bool	Visit (const TiXmlComment &comment)
	Visit a comment node. More...
virtual bool	Visit (const TiXmlUnknown &unknown)
	Visit an unknow node. More...
virtual bool	Visit (const TiXmlStylesheetReference &stylesheet)
	Visit a stylesheet reference. More...
void	SetIndent (const char *_indent)
	Set the indent characters for printing. More...
const char *	Indent ()
	Query the indention string. More...
void	SetLineBreak (const char *_lineBreak)
	Set the line breaking string. More...
const char *	LineBreak ()
	Query the current line breaking string. More...
void	SetStreamPrinting ()
	Switch over to "stream printing" which is the most dense formatting without linebreaks. More...
const char *	CStr ()
	Return the result. More...
size_t	Size ()
	Return the length of the result string. More...
const std::string &	Str ()
	Return the result. More...

Detailed Description

Print to memory functionality.

The TiXmlPrinter is useful when you need to:

1. Print to memory (especially in non-STL mode)
2. Control formatting (line endings, etc.)

When constructed, the TiXmlPrinter is in its default "pretty printing" mode. Before calling Accept() you can call methods to control the printing of the XML document. After TiXmlNode::Accept() is called, the printed document can be accessed via the CStr(), Str(), and Size() methods.

TiXmlPrinter uses the Visitor API.

TiXmlPrinter printer;
printer.SetIndent( "\t" );

doc.Accept( &printer );
fprintf( stdout, "%s", printer.CStr() );

Definition at line 2070 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlPrinter()

TiXmlPrinter::TiXmlPrinter ( )

inline

Definition at line 2072 of file tinyxml.h.

      : depth(0)
      , simpleTextPrint(false)
      , buffer()
      , indent("    ")
      , lineBreak("\n") {}

Member Function Documentation

CStr()

const char* TiXmlPrinter::CStr ( )

inline

Return the result.

Definition at line 2117 of file tinyxml.h.

{ return buffer.c_str(); }

DoIndent()

void TiXmlPrinter::DoIndent ( )

inlineprivate

Definition at line 2127 of file tinyxml.h.

                  {
    for (int i = 0; i < depth; ++i)
      buffer += indent;
  }

DoLineBreak()

void TiXmlPrinter::DoLineBreak ( )

inlineprivate

Definition at line 2131 of file tinyxml.h.

{ buffer += lineBreak; }

Indent()

const char* TiXmlPrinter::Indent ( )

inline

Query the indention string.

Definition at line 2097 of file tinyxml.h.

{ return indent.c_str(); }

LineBreak()

const char* TiXmlPrinter::LineBreak ( )

inline

Query the current line breaking string.

Definition at line 2106 of file tinyxml.h.

{ return lineBreak.c_str(); }

SetIndent()

void TiXmlPrinter::SetIndent ( const char *  _indent )

inline

Set the indent characters for printing.

By default 4 spaces but tab is also useful, or null/empty string for no indentation.

Definition at line 2095 of file tinyxml.h.

{ indent = _indent ? _indent : ""; }

SetLineBreak()

void TiXmlPrinter::SetLineBreak ( const char *  _lineBreak )

inline

Set the line breaking string.

By default set to newline (
). Some operating systems prefer other characters, or can be set to the null/empty string for no indenation.

Definition at line 2102 of file tinyxml.h.

                                            {
    lineBreak = _lineBreak ? _lineBreak : "";
  }

SetStreamPrinting()

void TiXmlPrinter::SetStreamPrinting ( )

inline

Switch over to "stream printing" which is the most dense formatting without linebreaks.

Common when the XML is needed for network transmission.

Definition at line 2112 of file tinyxml.h.

Referenced by operator<<().

                           {
    indent = "";
    lineBreak = "";
  }

Here is the caller graph for this function:

Size()

size_t TiXmlPrinter::Size ( )

inline

Return the length of the result string.

Definition at line 2119 of file tinyxml.h.

{ return buffer.size(); }

Str()

const std::string& TiXmlPrinter::Str ( )

inline

Return the result.

Definition at line 2123 of file tinyxml.h.

Referenced by operator<<().

{ return buffer; }

Here is the caller graph for this function:

Visit() [1/5]

bool TiXmlPrinter::Visit ( const TiXmlDeclaration &  )

virtual

Visit a declaration.

Reimplemented from TiXmlVisitor.

Definition at line 1715 of file tinyxml.cpp.

References TiXmlDeclaration::Print().

                                                            {
  DoIndent();
  declaration.Print(0, 0, &buffer);
  DoLineBreak();
  return true;
}

Here is the call graph for this function:

Visit() [2/5]

bool TiXmlPrinter::Visit ( const TiXmlText &  )

virtual

Visit a text node.

Reimplemented from TiXmlVisitor.

Definition at line 1693 of file tinyxml.cpp.

References TiXmlText::CDATA(), TiXmlBase::EncodeString(), TIXML_STRING, TiXmlNode::Value(), and TiXmlNode::ValueTStr().

                                              {
  if (text.CDATA()) {
    DoIndent();
    buffer += "<![CDATA[";
    buffer += text.Value();
    buffer += "]]>";
    DoLineBreak();
  } else if (simpleTextPrint) {
    TIXML_STRING str;
    TiXmlBase::EncodeString(text.ValueTStr(), &str);
    buffer += str;
  } else {
    DoIndent();
    TIXML_STRING str;
    TiXmlBase::EncodeString(text.ValueTStr(), &str);
    buffer += str;
    DoLineBreak();
  }

  return true;
}

Here is the call graph for this function:

Visit() [3/5]

bool TiXmlPrinter::Visit ( const TiXmlComment &  )

virtual

Visit a comment node.

Reimplemented from TiXmlVisitor.

Definition at line 1722 of file tinyxml.cpp.

References TiXmlNode::Value().

                                                    {
  DoIndent();
  buffer += "<!--";
  buffer += comment.Value();
  buffer += "-->";
  DoLineBreak();
  return true;
}

Here is the call graph for this function:

Visit() [4/5]

bool TiXmlPrinter::Visit ( const TiXmlUnknown &  )

virtual

Visit an unknow node.

Reimplemented from TiXmlVisitor.

Definition at line 1731 of file tinyxml.cpp.

References TiXmlNode::Value().

                                                    {
  DoIndent();
  buffer += "<";
  buffer += unknown.Value();
  buffer += ">";
  DoLineBreak();
  return true;
}

Here is the call graph for this function:

Visit() [5/5]

bool TiXmlPrinter::Visit ( const TiXmlStylesheetReference &  )

virtual

Visit a stylesheet reference.

Reimplemented from TiXmlVisitor.

Definition at line 1740 of file tinyxml.cpp.

References TiXmlStylesheetReference::Print().

                                                                   {
  DoIndent();
  stylesheet.Print(0, 0, &buffer);
  DoLineBreak();
  return true;
}

Here is the call graph for this function:

VisitEnter() [1/2]

bool TiXmlPrinter::VisitEnter ( const TiXmlDocument &  )

virtual

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1636 of file tinyxml.cpp.

{ return true; }

VisitEnter() [2/2]

bool TiXmlPrinter::VisitEnter ( const TiXmlElement &  , const TiXmlAttribute *    )

virtual

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1640 of file tinyxml.cpp.

References TiXmlText::CDATA(), TiXmlNode::FirstChild(), TiXmlNode::LastChild(), TiXmlAttribute::Next(), TiXmlNode::ToText(), and TiXmlNode::Value().

                                                                    {
  DoIndent();
  buffer += "<";
  buffer += element.Value();

  for (const TiXmlAttribute* attrib = firstAttribute; attrib;
       attrib = attrib->Next()) {
    buffer += " ";
    attrib->Print(0, 0, &buffer);
  }

  if (!element.FirstChild()) {
    buffer += " />";
    DoLineBreak();
  } else {
    buffer += ">";

    if (element.FirstChild()->ToText() &&
        element.LastChild() == element.FirstChild() &&
        element.FirstChild()->ToText()->CDATA() == false) {
      simpleTextPrint = true;
      // no DoLineBreak()!
    } else {
      DoLineBreak();
    }
  }

  ++depth;
  return true;
}

Here is the call graph for this function:

VisitExit() [1/2]

bool TiXmlPrinter::VisitExit ( const TiXmlDocument &  )

virtual

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1638 of file tinyxml.cpp.

{ return true; }

VisitExit() [2/2]

bool TiXmlPrinter::VisitExit ( const TiXmlElement &  )

virtual

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1672 of file tinyxml.cpp.

References TiXmlNode::FirstChild(), and TiXmlNode::Value().

                                                        {
  --depth;

  if (!element.FirstChild()) {
    // nothing.
  } else {
    if (simpleTextPrint) {
      simpleTextPrint = false;
    } else {
      DoIndent();
    }

    buffer += "</";
    buffer += element.Value();
    buffer += ">";
    DoLineBreak();
  }

  return true;
}

Here is the call graph for this function:

Member Data Documentation

buffer

TIXML_STRING TiXmlPrinter::buffer

private

Definition at line 2135 of file tinyxml.h.

depth

int TiXmlPrinter::depth

private

Definition at line 2133 of file tinyxml.h.

indent

TIXML_STRING TiXmlPrinter::indent

private

Definition at line 2136 of file tinyxml.h.

lineBreak

TIXML_STRING TiXmlPrinter::lineBreak

private

Definition at line 2137 of file tinyxml.h.

simpleTextPrint

bool TiXmlPrinter::simpleTextPrint

private

Definition at line 2134 of file tinyxml.h.

---

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

• agrum/external/tinyxml/ticpp/tinyxml.h
• agrum/external/tinyxml/ticpp/tinyxml.cpp