xmlParser  2.44
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Classes | Macros | Typedefs | Enumerations | Functions
xmlParser.h File Reference
#include <stdlib.h>
#include <wchar.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  XMLNodeContents
 This structure is given by the function XMLNode::enumContents. More...
 
struct  ToXMLStringTool
 Helper class to create XML files using "printf", "fprintf", "cout",... functions. More...
 
struct  XMLParserBase64Tool
 Helper class to include binary data inside XML strings using "Base64 encoding". More...
 

Macros

#define XMLDLLENTRY
 
#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. Use in conjunction with structure XMLNodeContents. 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",... functions. 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. Use in conjunction with structure XMLNodeContents. 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 long xmltol (XMLCSTR xmlString, long long defautValue=0)
 
XMLDLLENTRY double xmltof (XMLCSTR xmlString, double defautValue=.0)
 
XMLDLLENTRY XMLCSTR xmltoa (XMLCSTR xmlString, XMLCSTR defautValue=_CXML(""))
 
XMLDLLENTRY XMLCHAR xmltoc (XMLCSTR xmlString, const XMLCHAR defautValue=_CXML('\0'))
 

Macro Definition Documentation

#define _CXML (   c)    c

Definition at line 142 of file xmlParser.h.

#define FALSE   0

Definition at line 148 of file xmlParser.h.

#define TRUE   1

Definition at line 151 of file xmlParser.h.

#define XMLCHAR   char

Definition at line 145 of file xmlParser.h.

#define XMLCSTR   const char *

Definition at line 143 of file xmlParser.h.

#define XMLDLLENTRY

Definition at line 128 of file xmlParser.h.

#define XMLDLLENTRY

Definition at line 128 of file xmlParser.h.

#define XMLSTR   char *

Definition at line 144 of file xmlParser.h.

Typedef Documentation

typedef struct XMLAttribute XMLAttribute

Structure for XML attribute.

typedef struct XMLClear XMLClear

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

typedef int XMLElementPosition

XMLElementPosition are not interchangeable with simple indexes.

Definition at line 211 of file xmlParser.h.

Enumeration used to manage type of data. Use in conjunction with structure XMLNodeContents.

typedef enum XMLError XMLError

Enumeration for XML parse errors.

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:

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

typedef struct XMLResults XMLResults

Structure used to obtain error details if the parse fails.

Enumeration Type Documentation

Enumeration used to manage type of data. Use in conjunction with structure XMLNodeContents.

Enumerator
eNodeChild 
eNodeAttribute 
eNodeText 
eNodeClear 
eNodeNULL 

Definition at line 184 of file xmlParser.h.

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 156 of file xmlParser.h.