xmlParser.h File Reference

#include <cstdlib>
#include <tchar.h>

Go to the source code of this file.

Classes
struct	XMLResults
	Structure used to obtain error details if the parse fails. More...
struct	XMLClear
	Structure for XML clear (unformatted) node (usually comments) More...
struct	XMLAttribute
	Structure for XML attribute. More...
struct	XMLNode
	Main Class representing a XML node. More...
struct	XMLNode::XMLNodeDataTag
struct	XMLNodeContents
	This structure is given by the function XMLNode::enumContents. More...
struct	ToXMLStringTool
	Helper class to create XML files using "printf", "fprintf", "cout",... More...
struct	XMLParserBase64Tool
	Helper class to include binary data inside XML strings using "Base64 encoding". More...

Macros
#define	_XMLWINDOWS
#define	XMLDLLENTRY
#define	_CXML(c)   c
#define	XMLCSTR   const char*
#define	XMLSTR   char*
#define	XMLCHAR   char
#define	FALSE   0
#define	TRUE   1

Typedefs
typedef enum XMLError	XMLError
	Enumeration for XML parse errors. More...
typedef enum XMLElementType	XMLElementType
	Enumeration used to manage type of data. More...
typedef struct XMLResults	XMLResults
	Structure used to obtain error details if the parse fails. More...
typedef struct XMLClear	XMLClear
	Structure for XML clear (unformatted) node (usually comments) More...
typedef struct XMLAttribute	XMLAttribute
	Structure for XML attribute. More...
typedef int	XMLElementPosition
	XMLElementPosition are not interchangeable with simple indexes. More...
typedef struct XMLDLLENTRY XMLNode	XMLNode
	Main Class representing a XML node. More...
typedef struct XMLNodeContents	XMLNodeContents
	This structure is given by the function XMLNode::enumContents. More...
typedef struct XMLDLLENTRY ToXMLStringTool	ToXMLStringTool
	Helper class to create XML files using "printf", "fprintf", "cout",... More...
typedef struct XMLDLLENTRY XMLParserBase64Tool	XMLParserBase64Tool
	Helper class to include binary data inside XML strings using "Base64 encoding". More...

Enumerations
enum	XMLError {   eXMLErrorNone = 0, eXMLErrorMissingEndTag, eXMLErrorNoXMLTagFound, eXMLErrorEmpty,   eXMLErrorMissingTagName, eXMLErrorMissingEndTagName, eXMLErrorUnmatchedEndTag, eXMLErrorUnmatchedEndClearTag,   eXMLErrorUnexpectedToken, eXMLErrorNoElements, eXMLErrorFileNotFound, eXMLErrorFirstTagNotFound,   eXMLErrorUnknownCharacterEntity, eXMLErrorCharacterCodeAbove255, eXMLErrorCharConversionError, eXMLErrorCannotOpenWriteFile,   eXMLErrorCannotWriteFile, eXMLErrorBase64DataSizeIsNotMultipleOf4, eXMLErrorBase64DecodeIllegalCharacter, eXMLErrorBase64DecodeTruncatedData,   eXMLErrorBase64DecodeBufferTooSmall }
	Enumeration for XML parse errors. More...
enum	XMLElementType {   eNodeChild = 0, eNodeAttribute = 1, eNodeText = 2, eNodeClear = 3,   eNodeNULL = 4 }
	Enumeration used to manage type of data. More...

Functions
XMLDLLENTRY XMLSTR	stringDup (XMLCSTR source, int cbData=-1)
	Duplicate (copy in a new allocated buffer) the source string. More...
XMLDLLENTRY void	freeXMLString (XMLSTR t)
	to free the string allocated inside the "stringDup" function or the "createXMLString" function. More...
XMLDLLENTRY char	xmltob (XMLCSTR xmlString, char defautValue=0)
XMLDLLENTRY int	xmltoi (XMLCSTR xmlString, int defautValue=0)
XMLDLLENTRY long	xmltol (XMLCSTR xmlString, long defautValue=0)
XMLDLLENTRY double	xmltof (XMLCSTR xmlString, double defautValue=.0)
XMLDLLENTRY XMLCSTR	xmltoa (XMLCSTR xmlString, XMLCSTR defautValue=_CXML(""))
XMLDLLENTRY XMLCHAR	xmltoc (XMLCSTR xmlString, XMLCHAR defautValue=_CXML('\0'))

Macro Definition Documentation

_CXML

#define _CXML

(

c

)

c

Definition at line 226 of file xmlParser.h.

Referenced by CountLinesAndColumns(), XMLNode::createXMLString(), XMLNode::CreateXMLStringR(), XMLParserBase64Tool::encode(), fromXMLString(), XMLNode::getError(), GetNextToken(), XMLNode::getVersion(), myTagCompare(), XMLNode::openFileHelper(), XMLNode::parseClearTag(), XMLNode::parseFile(), XMLNode::ParseXMLElement(), and XMLNode::writeToFile().

_XMLWINDOWS

#define _XMLWINDOWS

Definition at line 173 of file xmlParser.h.

FALSE

#define FALSE   0

Definition at line 232 of file xmlParser.h.

TRUE

#define TRUE   1

Definition at line 235 of file xmlParser.h.

XMLCHAR

#define XMLCHAR   char

Definition at line 229 of file xmlParser.h.

Referenced by CountLinesAndColumns(), XMLNode::createXMLString(), XMLParserBase64Tool::encode(), fromXMLString(), XMLNode::getChildNodeByPath(), getNextChar(), GetNextToken(), ToXMLStringTool::lengthXMLString(), XMLNode::maybeAddTxT(), myTagCompare(), stringDup(), ToXMLStringTool::toXML(), ToXMLStringTool::toXMLUnSafe(), and XMLNode::writeToFile().

XMLCSTR

#define XMLCSTR   const char*

Definition at line 227 of file xmlParser.h.

Referenced by XMLNode::addText_priv(), XMLNode::CreateXMLStringR(), XMLNode::deepCopy(), XMLNode::deleteText(), XMLNode::exactMemory(), fromXMLString(), XMLNode::getChildNodeWithAttribute(), XMLNode::indexText(), mrpt::utils::CSimpleDatabase::loadFromXML(), XMLNode::maybeAddTxT(), XMLNode::openFileHelper(), XMLNode::parseClearTag(), XMLNode::parseString(), XMLNode::ParseXMLElement(), and XMLNode::updateText_WOSD().

XMLDLLENTRY

#define XMLDLLENTRY

Definition at line 186 of file xmlParser.h.

XMLSTR

#define XMLSTR   char*

Definition at line 228 of file xmlParser.h.

Referenced by XMLNode::addText_priv(), XMLNode::createXMLString(), XMLParserBase64Tool::encode(), XMLNode::exactMemory(), fromXMLString(), XMLNode::getChildNodeByPath(), XMLNode::maybeAddTxT(), XMLNode::parseFile(), XMLNode::ParseXMLElement(), stringDup(), ToXMLStringTool::toXML(), ToXMLStringTool::toXMLUnSafe(), XMLNode::updateAttribute_WOSD(), XMLNode::updateClear_WOSD(), XMLNode::writeToFile(), xstrcpy(), and xstrstr().

Typedef Documentation

XMLAttribute

typedef struct XMLAttribute XMLAttribute

Structure for XML attribute.

XMLClear

typedef struct XMLClear XMLClear

Structure for XML clear (unformatted) node (usually comments)

XMLElementPosition

typedef int XMLElementPosition

XMLElementPosition are not interchangeable with simple indexes.

Definition at line 297 of file xmlParser.h.

XMLElementType

typedef enum XMLElementType XMLElementType

Enumeration used to manage type of data.

Use in conjunction with structure XMLNodeContents

XMLError

typedef enum XMLError XMLError

Enumeration for XML parse errors.

XMLNode

typedef struct XMLDLLENTRY XMLNode XMLNode

Main Class representing a XML node.

All operations are performed using this class.

Note

The constructors of the XMLNode class are protected, so use instead one of these four methods to get your first instance of XMLNode:

• XMLNode::parseString
• XMLNode::parseFile
• XMLNode::openFileHelper
• XMLNode::createXMLTopNode (or XMLNode::createXMLTopNode_WOSD)

XMLNodeContents

typedef struct XMLNodeContents XMLNodeContents

This structure is given by the function XMLNode::enumContents.

XMLResults

typedef struct XMLResults XMLResults

Structure used to obtain error details if the parse fails.

Enumeration Type Documentation

XMLElementType

enum XMLElementType

Enumeration used to manage type of data.

Use in conjunction with structure XMLNodeContents

Enumerator
eNodeChild
eNodeAttribute
eNodeText
eNodeClear
eNodeNULL

Definition at line 266 of file xmlParser.h.

XMLError

enum XMLError

Enumeration for XML parse errors.

Enumerator
eXMLErrorNone
eXMLErrorMissingEndTag
eXMLErrorNoXMLTagFound
eXMLErrorEmpty
eXMLErrorMissingTagName
eXMLErrorMissingEndTagName
eXMLErrorUnmatchedEndTag
eXMLErrorUnmatchedEndClearTag
eXMLErrorUnexpectedToken
eXMLErrorNoElements
eXMLErrorFileNotFound
eXMLErrorFirstTagNotFound
eXMLErrorUnknownCharacterEntity
eXMLErrorCharacterCodeAbove255
eXMLErrorCharConversionError
eXMLErrorCannotOpenWriteFile
eXMLErrorCannotWriteFile
eXMLErrorBase64DataSizeIsNotMultipleOf4
eXMLErrorBase64DecodeIllegalCharacter
eXMLErrorBase64DecodeTruncatedData
eXMLErrorBase64DecodeBufferTooSmall

Definition at line 239 of file xmlParser.h.