TiXmlPrinter Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlPrinter:

Collaboration diagram for TiXmlPrinter:

Public Member Functions
const char *	CStr ()
	Return the result. More...
const char *	Indent ()
	Query the indention string. More...
const char *	LineBreak ()
	Query the current line breaking string. More...
void	SetIndent (const char *_indent)
void	SetLineBreak (const char *_lineBreak)
void	SetStreamPrinting ()
size_t	Size ()
	Return the length of the result string. More...
	TiXmlPrinter ()
virtual bool	Visit (const TiXmlComment &comment)
	Visit a comment node. 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 TiXmlUnknown &unknown)
	Visit an unknown node. More...
virtual bool	VisitEnter (const TiXmlDocument &doc)
	Visit a document. More...
virtual bool	VisitEnter (const TiXmlElement &element, const TiXmlAttribute *firstAttribute)
	Visit an element. More...
virtual bool	VisitExit (const TiXmlDocument &doc)
	Visit a document. More...
virtual bool	VisitExit (const TiXmlElement &element)
	Visit an element. More...
Public Member Functions inherited from TiXmlVisitor
virtual	~TiXmlVisitor ()

Private Member Functions
void	DoIndent ()
void	DoLineBreak ()

Private Attributes
TIXML_STRING	buffer
int	depth
TIXML_STRING	indent
TIXML_STRING	lineBreak
bool	simpleTextPrint

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() );

Constructor & Destructor Documentation

TiXmlPrinter()

TiXmlPrinter::TiXmlPrinter ( )

inline

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

Member Function Documentation

CStr()

const char* TiXmlPrinter::CStr ( )

inline

Return the result.

{ return buffer.c_str(); }

DoIndent()

void TiXmlPrinter::DoIndent ( )

inlineprivate

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

DoLineBreak()

void TiXmlPrinter::DoLineBreak ( )

inlineprivate

                       {
        buffer += lineBreak;
    }

Indent()

const char* TiXmlPrinter::Indent ( )

inline

Query the indention string.

{ return indent.c_str(); }

LineBreak()

const char* TiXmlPrinter::LineBreak ( )

inline

Query the current line breaking string.

{ return lineBreak.c_str(); }

SetIndent()

void TiXmlPrinter::SetIndent ( const char *  _indent )

inline

Set the indent characters for printing. By default 4 spaces but tab (\t) is also useful, or null/empty string for no indentation.

{ 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.

{ 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.

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

Size()

size_t TiXmlPrinter::Size ( )

inline

Return the length of the result string.

{ return buffer.size(); }

Visit() [1/4]

bool TiXmlPrinter::Visit ( const TiXmlComment &  )

virtual

Visit a comment node.

Reimplemented from TiXmlVisitor.

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

Visit() [2/4]

bool TiXmlPrinter::Visit ( const TiXmlDeclaration &  )

virtual

Visit a declaration.

Reimplemented from TiXmlVisitor.

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

Visit() [3/4]

bool TiXmlPrinter::Visit ( const TiXmlText &  )

virtual

Visit a text node.

Reimplemented from TiXmlVisitor.

{
    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;
}

Visit() [4/4]

bool TiXmlPrinter::Visit ( const TiXmlUnknown &  )

virtual

Visit an unknown node.

Reimplemented from TiXmlVisitor.

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

VisitEnter() [1/2]

bool TiXmlPrinter::VisitEnter ( const TiXmlDocument &  )

virtual

Visit a document.

Reimplemented from TiXmlVisitor.

{
    return true;
}

VisitEnter() [2/2]

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

virtual

Visit an element.

Reimplemented from TiXmlVisitor.

{
    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;
}

VisitExit() [1/2]

bool TiXmlPrinter::VisitExit ( const TiXmlDocument &  )

virtual

Visit a document.

Reimplemented from TiXmlVisitor.

{
    return true;
}

VisitExit() [2/2]

bool TiXmlPrinter::VisitExit ( const TiXmlElement &  )

virtual

Visit an element.

Reimplemented from TiXmlVisitor.

{
    --depth;
    if ( !element.FirstChild() ) 
    {
        // nothing.
    }
    else 
    {
        if ( simpleTextPrint )
        {
            simpleTextPrint = false;
        }
        else
        {
            DoIndent();
        }
        buffer += "</";
        buffer += element.Value();
        buffer += ">";
        DoLineBreak();
    }
    return true;
}

Member Data Documentation

buffer

TIXML_STRING TiXmlPrinter::buffer

private

depth

int TiXmlPrinter::depth

private

indent

TIXML_STRING TiXmlPrinter::indent

private

lineBreak

TIXML_STRING TiXmlPrinter::lineBreak

private

simpleTextPrint

bool TiXmlPrinter::simpleTextPrint

private

---

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

• src/libScan/tinyxml.h
• src/libScan/tinyxml.cpp