Detailed Description

Helper class to create XML files using "printf", "fprintf", "cout",... functions.

The ToXMLStringTool class helps you creating XML files using "printf", "fprintf", "cout",... functions. The "ToXMLStringTool" class is processing strings so that all the characters &,",',<,> are replaced by their XML equivalent:

&amp;, &quot;, &apos;, &lt;, &gt;

Using the "ToXMLStringTool class" and the "fprintf function" is THE most efficient way to produce VERY large XML documents VERY fast.

Note: If you are creating from scratch an XML file using the provided XMLNode class you must not use the "ToXMLStringTool" class (because the "XMLNode" class does the processing job for you during rendering).

Definition at line 704 of file xmlParser.h.

#include <utils/xmlparser/xmlParser.h>

Public Member Functions
	ToXMLStringTool ()

	~ToXMLStringTool ()

void	freeBuffer ()
	call this function when you have finished using this object to release memory used by the internal buffer. More...

XMLSTR	toXML (XMLCSTR source)
	returns a pointer to an internal buffer that contains a XML-encoded string based on the "source" parameter. More...

Static Public Member Functions
static XMLSTR	toXMLUnSafe (XMLSTR dest, XMLCSTR source)
	The "toXMLUnSafe" function is deprecated because there is a possibility of "destination-buffer-overflow". More...

static int	lengthXMLString (XMLCSTR source)
	deprecated: use "toXML" instead More...

Private Attributes
XMLSTR	buf

int	buflen

Constructor & Destructor Documentation

◆ ToXMLStringTool()

ToXMLStringTool::ToXMLStringTool ( )

inline

Definition at line 707 of file xmlParser.h.

◆ ~ToXMLStringTool()

ToXMLStringTool::~ToXMLStringTool ( )

Definition at line 642 of file xmlParser.cpp.

References freeBuffer().

Member Function Documentation

◆ freeBuffer()

void ToXMLStringTool::freeBuffer ( )

call this function when you have finished using this object to release memory used by the internal buffer.

Definition at line 643 of file xmlParser.cpp.

References buf, and buflen.

Referenced by ~ToXMLStringTool().

◆ lengthXMLString()

int ToXMLStringTool::lengthXMLString ( XMLCSTR source )

static

deprecated: use "toXML" instead

Definition at line 618 of file xmlParser.cpp.

References XMLCharacterEntity::c, XMLCharacterEntity::l, XMLCharacterEntity::s, XML_ByteTable, XMLCHAR, and XMLEntities.

Referenced by XMLNode::CreateXMLStringR(), and toXML().

◆ toXML()

XMLSTR ToXMLStringTool::toXML ( XMLCSTR source )

returns a pointer to an internal buffer that contains a XML-encoded string based on the "source" parameter.

Definition at line 644 of file xmlParser.cpp.

References buf, buflen, lengthXMLString(), toXMLUnSafe(), XMLCHAR, and XMLSTR.

◆ toXMLUnSafe()

XMLSTR ToXMLStringTool::toXMLUnSafe	(	XMLSTR	dest,
		XMLCSTR	source
	)

static

The "toXMLUnSafe" function is deprecated because there is a possibility of "destination-buffer-overflow".

It converts the string "source" to the string "dest". deprecated: use "toXML" instead

Definition at line 586 of file xmlParser.cpp.

References XMLCharacterEntity::c, XMLCharacterEntity::l, XMLCharacterEntity::s, XML_ByteTable, XMLCHAR, XMLEntities, XMLSTR, and xstrcpy().

Referenced by XMLNode::CreateXMLStringR(), and toXML().

Member Data Documentation

◆ buf

XMLSTR ToXMLStringTool::buf

private

Definition at line 720 of file xmlParser.h.

Referenced by freeBuffer(), and toXML().

◆ buflen

int ToXMLStringTool::buflen