diff --git a/base.css b/base.css
index aa94d74..d350ffe 100644
--- a/base.css
+++ b/base.css
@@ -56,13 +56,14 @@ body {
padding: 10px 20px 10px;
margin-left: -20px;
overflow:scroll;
+ overflow-y:auto;
overflow-x:hidden;
}
-/*
-.navbar ul {
- font-size: 15px;
-};
-*/
+.navbar-fixed-top a {
+ text-decoration: none;
+ color: #000000;
+}
+
h1, h2, h3, h4, h5, h6 {
display: block;
margin: 10px 0;
@@ -95,7 +96,15 @@ pre {
border-radius: 4px;
}
+.enumeration-list td {
+ padding-left:10px;
+ padding-right:10px;
+}
+.parameter-list td {
+ padding-left:5px;
+ padding-right:5px;
+}
.code-function {
text-decoration:none;
@@ -128,4 +137,67 @@ pre {
.code-storage-keyword {
text-decoration:none;
color:#466cb4;
-}
\ No newline at end of file
+}
+
+.code-doxygen {
+ text-decoration:none;
+ color:#bf3e00;
+ font-weight:bold;
+}
+
+.code-comment {
+ text-decoration:none;
+ color:#b704b5;
+}
+
+.code-preproc {
+ text-decoration:none;
+ color:#ac0000;
+}
+
+.code-text-quote {
+ text-decoration:none;
+ color:#008e00;
+}
+.code-number {
+ text-decoration:none;
+ color:#007b00;
+}
+.code-member {
+ text-decoration:none;
+ color:#7c5406;
+}
+.code-input-function {
+ text-decoration:none;
+ color:#B80000;
+ font-weight:bold;
+}
+.code-function-name {
+ text-decoration:none;
+ color:#09857e;
+ font-weight:bold;
+}
+.code-function-system {
+ text-decoration:none;
+ color:#acaa00;
+}
+.code-generic-define {
+ text-decoration:none;
+ color:#3c850b;
+}
+.code-macro {
+ text-decoration:none;
+ color:#3c850b;
+}
+.code-operator {
+ text-decoration:none;
+ color:#1633a3;
+}
+.code-keyword {
+ text-decoration:none;
+ color:#466cb4;
+}
+.code-class {
+ text-decoration:none;
+ color:#006cb4;
+}
diff --git a/class_exml__Attribute.html b/class_exml__Attribute.html
new file mode 100644
index 0000000..de918b2
--- /dev/null
+++ b/class_exml__Attribute.html
@@ -0,0 +1,164 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::Attribute Description:
+
+
+
Constructor and Destructor:
+
++ Attribute (void ); + Attribute (const std::string & _name , const std::string & _value ); + virtual ~Attribute (void );
+
+
Synopsis:
+
+# std::string m_name ; + virtual void setName (const std::string & _name ); + virtual const std::string & getName (void ) const ; + virtual enum nodeType getType (void ) const ; + virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + virtual bool iGenerate (std::string & _data , int32_t _indent ) const ; + virtual exml::Attribute * toAttribute (void ); + virtual const exml::Attribute * toAttribute (void ) const ; + virtual void clear (void );
+
+
Object Hierarchy:
+
++exml::Node +--> exml::Attribute
+Detail:
+Attribute
++ Attribute (void );
+Constructor
+
+
+Attribute
++ Attribute (const std::string & _name , const std::string & _value );
+Constructor
+
+Parameter [input]: _name Name of the attribute.
+Parameter [input]: _value Value of the attribute.
+
+
+
+
+
+~Attribute
++ virtual ~Attribute (void );
+Destructor
+
+
+m_name
+# std::string m_name ;
+
+
+
+
+setName
++ virtual void setName (const std::string & _name );
+set the name of the attribute
+
+
+
+getName
++ virtual const std::string & getName (void ) const ;
+get the current name of the Attribute
+
+Return: String of the attribute
+
+
+
+
+getType
++ virtual enum nodeType getType (void ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+iParse
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
+parse the Current node [pure VIRUAL]
+
+Parameter [input]: _data data string to parse.
+Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
+Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
+Parameter [input] [output]: file parsing position (line x col x)
+Return: false if an error occured.
+
+
+
+
+iGenerate
++ virtual bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+toAttribute
++ virtual exml::Attribute * toAttribute (void );
+Cast the element in a Attribute if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toAttribute
++ virtual const exml::Attribute * toAttribute (void ) const ;
+Cast the element in a Attribute if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+clear
++ virtual void clear (void );
+clear the Node
+
+
+
+
+
+
diff --git a/class_exml__AttributeList.html b/class_exml__AttributeList.html
new file mode 100644
index 0000000..c054586
--- /dev/null
+++ b/class_exml__AttributeList.html
@@ -0,0 +1,170 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::AttributeList Description:
+
+
+
Constructor and Destructor:
+
++ AttributeList (void ); + AttributeList (const std::string & _value ); + virtual ~AttributeList (void );
+
+
Synopsis:
+
+# std::vector <exml::Attribute*> m_listAttribute ; + size_t sizeAttribute (void ) const ; + void appendAttribute (exml::Attribute * _attr ); + Attribute* getAttr (int32_t _id ); + const Attribute* getAttr (int32_t _id ) const ; + const std::string & getAttribute (const std::string & _name ) const ; + bool existAttribute (const std::string & _name ) const ; + void setAttribute (const std::string & _name , const std::string & _value ); + bool iGenerate (std::string & _data , int32_t _indent ) const ; + virtual void clear (void );
+
+
Object Hierarchy:
+
++exml::Node +--> exml::AttributeList +--> exml::Declaration +--> exml::Element
+Detail:
+AttributeList
++ AttributeList (void );
+Constructor
+
+
+AttributeList
++ AttributeList (const std::string & _value );
+Constructor
+
+Parameter [input]: _value Node value;
+
+
+
+
+
+~AttributeList
++ virtual ~AttributeList (void );
+Destructor
+
+
+m_listAttribute
+# std::vector <exml::Attribute*> m_listAttribute ;
+
+list of all attribute
+
+
+sizeAttribute
++ size_t sizeAttribute (void ) const ;
+get the number of attribute in the Node
+
+Return: Nulber of attribute >=0
+
+
+
+
+appendAttribute
++ void appendAttribute (exml::Attribute * _attr );
+add attribute on the List
+
+Parameter [input]: _attr Pointer on the attribute
+
+
+
+
+
+getAttr
++ Attribute* getAttr (int32_t _id );
+get attribute whith his ID
+
+
+
+getAttr
++ const Attribute* getAttr (int32_t _id ) const ;
+
+
+
+
+getAttribute
++ const std::string & getAttribute (const std::string & _name ) const ;
+get the attribute value with searching in the List with his name
+
+Parameter [input]: _name Attribute Name.
+Return: Value of the attribute or no data in the string
+
+
+
+
+existAttribute
++ bool existAttribute (const std::string & _name ) const ;
+check if an attribute exist or not with his name.
+
+Parameter [input]: _name Attribute Name.
+Return: true if the attribute exist or False
+
+
+
+
+setAttribute
++ void setAttribute (const std::string & _name , const std::string & _value );
+Sen A new attribute or replace data of the previous one
+
+Parameter [input]: _name Name of the attribute
+Parameter [input]: _value Value of the attribute
+
+
+
+
+
+iGenerate
++ bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+clear
++ virtual void clear (void );
+clear the Node
+
+
+
+
+
+
diff --git a/class_exml__Comment.html b/class_exml__Comment.html
new file mode 100644
index 0000000..743c047
--- /dev/null
+++ b/class_exml__Comment.html
@@ -0,0 +1,133 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::Comment Description:
+
+
+
Constructor and Destructor:
+
++ Comment (void ); + Comment (const std::string & _value ); + virtual ~Comment (void );
+
+
Synopsis:
+
++ virtual enum nodeType getType (void ) const ; + virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + virtual bool iGenerate (std::string & _data , int32_t _indent ) const ; + virtual exml::Comment * toComment (void ); + virtual const exml::Comment * toComment (void ) const ;
+
+
Object Hierarchy:
+
++exml::Node +--> exml::Comment
+Detail:
+Comment
++ Comment (void );
+Constructor
+
+
+Comment
++ Comment (const std::string & _value );
+Constructor
+
+Parameter [input]: _value comment value
+
+
+
+
+
+~Comment
++ virtual ~Comment (void );
+Destructor
+
+
+getType
++ virtual enum nodeType getType (void ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+iParse
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
+parse the Current node [pure VIRUAL]
+
+Parameter [input]: _data data string to parse.
+Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
+Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
+Parameter [input] [output]: file parsing position (line x col x)
+Return: false if an error occured.
+
+
+
+
+iGenerate
++ virtual bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+toComment
++ virtual exml::Comment * toComment (void );
+Cast the element in a Comment if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toComment
++ virtual const exml::Comment * toComment (void ) const ;
+Cast the element in a Comment if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+
+
+
+
diff --git a/class_exml__Declaration.html b/class_exml__Declaration.html
new file mode 100644
index 0000000..dcb62dd
--- /dev/null
+++ b/class_exml__Declaration.html
@@ -0,0 +1,133 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::Declaration Description:
+
+
+
Constructor and Destructor:
+
++ Declaration (void ); + Declaration (const std::string & _name ); + virtual ~Declaration (void );
+
+
Synopsis:
+
++ virtual enum nodeType getType (void ) const ; + virtual bool iGenerate (std::string & _data , int32_t _indent ) const ; + virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + virtual exml::Declaration * toDeclaration (void ); + virtual const exml::Declaration * toDeclaration (void ) const ;
+
+
Object Hierarchy:
+
++exml::Node +--> +exml::AttributeList +--> exml::Declaration +--> exml::DeclarationXML
+Detail:
+Declaration
++ Declaration (void );
+Constructor
+
+
+Declaration
++ Declaration (const std::string & _name );
+Constructor
+
+
+
+~Declaration
++ virtual ~Declaration (void );
+Destructor
+
+
+getType
++ virtual enum nodeType getType (void ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+iGenerate
++ virtual bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+iParse
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
+parse the Current node [pure VIRUAL]
+
+Parameter [input]: _data data string to parse.
+Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
+Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
+Parameter [input] [output]: file parsing position (line x col x)
+Return: false if an error occured.
+
+
+
+
+toDeclaration
++ virtual exml::Declaration * toDeclaration (void );
+Cast the element in a Declaration if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toDeclaration
++ virtual const exml::Declaration * toDeclaration (void ) const ;
+Cast the element in a Declaration if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+
+
+
+
diff --git a/class_exml__DeclarationXML.html b/class_exml__DeclarationXML.html
new file mode 100644
index 0000000..192213a
--- /dev/null
+++ b/class_exml__DeclarationXML.html
@@ -0,0 +1,75 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::DeclarationXML Description:
+
+
+
Constructor and Destructor:
+
++ DeclarationXML (const std::string & _version , const std::string & _format , bool _standalone ); + virtual ~DeclarationXML (void );
+
+
Object Hierarchy:
+
++exml::Node +--> +exml::AttributeList +--> +exml::Declaration +--> exml::DeclarationXML
+Detail:
+DeclarationXML
++ DeclarationXML (const std::string & _version , const std::string & _format , bool _standalone );
+Constructor for the generic declaration : <?xml version="" format="UTF-8"?>
+
+
+
+~DeclarationXML
++ virtual ~DeclarationXML (void );
+Destructor
+
+
+
+
+
+
diff --git a/class_exml__Document.html b/class_exml__Document.html
new file mode 100644
index 0000000..153ea3f
--- /dev/null
+++ b/class_exml__Document.html
@@ -0,0 +1,198 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::Document Description:
+
+
+
Constructor and Destructor:
+
++ Document (void ); + virtual ~Document (void );
+
+
Synopsis:
+
++ virtual void setCaseSensitive (bool _val ); + virtual bool getCaseSensitive (void ) const ; + bool parse (const std::string & _data ); + bool generate (std::string & _data ); + bool load (const std::string & _file ); + bool store (const std::string & _file ); + void display (void ); + void displayErrorWhenDetected (void ); + void notDisplayErrorWhenDetected (void ); + void createError (const std::string & _data , int32_t _pos , const exml::filePos & _filePos , const std::string & _comment ); + void displayError (void ); + virtual enum nodeType getType (void ) const ; + bool iGenerate (std::string & _data , int32_t _indent ) const ; + virtual exml::Document * toDocument (void ); + virtual const exml::Document * toDocument (void ) const ;
+
+
Object Hierarchy:
+
++exml::Node +--> +exml::AttributeList +--> +exml::Element +--> exml::Document
+Detail:
+Document
++ Document (void );
+Constructor
+
+
+~Document
++ virtual ~Document (void );
+Destructor
+
+
+setCaseSensitive
++ virtual void setCaseSensitive (bool _val );
+Enable or diasable the case sensitive (must be done before the call of parsing)
+
+
+
+getCaseSensitive
++ virtual bool getCaseSensitive (void ) const ;
+get the status of case sensitive mode.
+
+Return: true if case sensitive is active
+
+
+
+
+parse
++ bool parse (const std::string & _data );
+parse a string that contain an XML
+
+Parameter [input]: _data Data to parse
+Return: false : An error occured<br/>true : Parsing is OK
+
+
+
+
+generate
++ bool generate (std::string & _data );
+generate a string that contain the created XML
+
+
+
+load
++ bool load (const std::string & _file );
+Load the file that might contain the xml
+
+
+
+store
++ bool store (const std::string & _file );
+Store the Xml in the file
+
+
+
+display
++ void display (void );
+Display the Document on console
+
+
+displayErrorWhenDetected
++ void displayErrorWhenDetected (void );
+
+
+
+
+notDisplayErrorWhenDetected
++ void notDisplayErrorWhenDetected (void );
+
+
+
+
+createError
++ void createError (const std::string & _data , int32_t _pos , const exml::filePos & _filePos , const std::string & _comment );
+
+
+
+
+displayError
++ void displayError (void );
+
+
+
+
+getType
++ virtual enum nodeType getType (void ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+iGenerate
++ bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+toDocument
++ virtual exml::Document * toDocument (void );
+Cast the element in a Document if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toDocument
++ virtual const exml::Document * toDocument (void ) const ;
+Cast the element in a Document if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+
+
+
+
diff --git a/class_exml__Element.html b/class_exml__Element.html
new file mode 100644
index 0000000..d773a66
--- /dev/null
+++ b/class_exml__Element.html
@@ -0,0 +1,245 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::Element Description:
+
+
+
Constructor and Destructor:
+
++ Element (void ); + Element (const std::string & _value ); + virtual ~Element (void );
+
+
Synopsis:
+
+# std::vector <exml::Node*> m_listSub ; + size_t size (void ) const ; + void append (Node* _node ); + enum nodeType getType (int32_t _id ); + const enum nodeType getType (int32_t _id ) const ; + Node* getNode (int32_t _id ); + const Node* getNode (int32_t _id ) const ; + Element* getElement (int32_t _id ); + const Element* getElement (int32_t _id ) const ; + Element* getNamed (const std::string & _name ); + const Element* getNamed (const std::string & _name ) const ; + std::string getText (void ); # bool subParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc , bool _mainNode ); + virtual enum nodeType getType (void ) const ; + virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + virtual bool iGenerate (std::string & _data , int32_t _indent ) const ; + virtual exml::Element * toElement (void ); + virtual const exml::Element * toElement (void ) const ; + virtual void clear (void );
+
+
Object Hierarchy:
+
++exml::Node +--> +exml::AttributeList +--> exml::Element +--> exml::Document
+Detail:
+Element
++ Element (void );
+Constructor
+
+
+Element
++ Element (const std::string & _value );
+Constructor
+
+Parameter [input]: _value Element name;
+
+
+
+
+
+~Element
++ virtual ~Element (void );
+Destructor
+
+
+m_listSub
+# std::vector <exml::Node*> m_listSub ;
+
+
+
+
+size
++ size_t size (void ) const ;
+get the number of sub element in the node (can be exml::Comment ; exml::Element ; exml::Text :exml::Declaration).
+
+
+
+append
++ void append (Node* _node );
+add a node at the element (not exml::Attribute (move in the attribute automaticly).
+
+
+
+getType
++ enum nodeType getType (int32_t _id );
+get the type of the element id.
+
+Parameter [input]: _id Id of the element.
+Return: the Current type of the element or exml::typeUnknow.
+
+
+
+
+getType
++ const enum nodeType getType (int32_t _id ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+getNode
++ Node* getNode (int32_t _id );
+get the Node pointer of the element id.
+
+Parameter [input]: _id Id of the element.
+Return: Pointer on node.
+
+
+
+
+getNode
++ const Node* getNode (int32_t _id ) const ;
+
+
+
+
+getElement
++ Element* getElement (int32_t _id );
+get the element casted in Element (if the node is not an element return NULL).
+
+Parameter [input]: _id Id of the element.
+Return: Pointer on the element or NULL.
+
+
+
+
+getElement
++ const Element* getElement (int32_t _id ) const ;
+
+
+
+
+getNamed
++ Element* getNamed (const std::string & _name );
+get an element with his name (work only with exml::Element)
+
+
+
+getNamed
++ const Element* getNamed (const std::string & _name ) const ;
+
+
+
+
+getText
++ std::string getText (void );
+get the internal data of the element (if the element has some sub node thay are converted in xml string == > like this it is not needed to use <![CDATA[...]]>
+
+Return: the curent data string.
+
+
+
+
+subParse
+# bool subParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc , bool _mainNode );
+
+
+
+
+getType
++ virtual enum nodeType getType (void ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+iParse
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
+parse the Current node [pure VIRUAL]
+
+Parameter [input]: _data data string to parse.
+Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
+Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
+Parameter [input] [output]: file parsing position (line x col x)
+Return: false if an error occured.
+
+
+
+
+iGenerate
++ virtual bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+toElement
++ virtual exml::Element * toElement (void );
+Cast the element in a Element if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toElement
++ virtual const exml::Element * toElement (void ) const ;
+Cast the element in a Element if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+clear
++ virtual void clear (void );
+clear the Node
+
+
+
+
+
+
diff --git a/class_exml__Node.html b/class_exml__Node.html
new file mode 100644
index 0000000..61197f6
--- /dev/null
+++ b/class_exml__Node.html
@@ -0,0 +1,345 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::Node Description:
+
+
+
Constructor and Destructor:
+
++ Node (void ); + Node (const std::string & _value ); + virtual ~Node (void );
+
+
Synopsis:
+
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ) = 0; + virtual bool iGenerate (std::string & _data , int32_t _indent ) const ; # exml::filePos m_pos ; + const exml::filePos & getPos (void ); # std::string m_value ; + virtual void setValue (std::string _value ); + virtual const std::string & getValue (void ) const ; + virtual enum nodeType getType (void ) const ; # void addIndent (std::string & _data , int32_t _indent ) const ; # void drawElementParsed (char32_t _val , const exml::filePos & _filePos ) const ; # bool checkAvaillable (char32_t _val , bool _firstChar ) const ; # int32_t countWhiteChar (const std::string & _data , int32_t _pos , exml::filePos & _filePos ) const ; + virtual exml::Document * toDocument (void ); + virtual const exml::Document * toDocument (void ) const ; + virtual exml::Attribute * toAttribute (void ); + virtual const exml::Attribute * toAttribute (void ) const ; + virtual exml::Comment * toComment (void ); + virtual const exml::Comment * toComment (void ) const ; + virtual exml::Declaration * toDeclaration (void ); + virtual const exml::Declaration * toDeclaration (void ) const ; + virtual exml::Element * toElement (void ); + virtual const exml::Element * toElement (void ) const ; + virtual exml::Text * toText (void ); + virtual const exml::Text * toText (void ) const ; + bool isDocument (void ) const ; + bool isAttribute (void ) const ; + bool isComment (void ) const ; + bool isDeclaration (void ) const ; + bool isElement (void ) const ; + bool isText (void ) const ; + virtual void clear (void );
+
+
Object Hierarchy:
+
+exml::Node +--> exml::Comment +--> exml::Attribute +--> exml::Text +--> exml::AttributeList
+Detail:
+Node
++ Node (void );
+basic element of a xml structure
+
+
+Node
++ Node (const std::string & _value );
+basic element of a xml structure
+
+Parameter [input]: value of the node
+
+
+
+
+
+~Node
++ virtual ~Node (void );
+destructor
+
+
+iParse
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ) = 0;
+parse the Current node [pure VIRUAL]
+
+Parameter [input]: _data data string to parse.
+Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
+Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
+Parameter [input] [output]: file parsing position (line x col x)
+Return: false if an error occured.
+
+
+
+
+iGenerate
++ virtual bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+m_pos
+# exml::filePos m_pos ;
+
+position in the readed file == > not correct when the file is generated
+
+
+getPos
++ const exml::filePos & getPos (void );
+get the current position where the element is in the file
+
+
+m_value
+# std::string m_value ;
+
+value of the node (for element this is the name, for text it is the inside text ...)
+
+
+setValue
++ virtual void setValue (std::string _value );
+set the value of the node.
+
+Parameter [input]: _value New value of the node.
+
+
+
+
+
+getValue
++ virtual const std::string & getValue (void ) const ;
+get the current element Value.
+
+Return: the reference of the string value.
+
+
+
+
+getType
++ virtual enum nodeType getType (void ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+addIndent
+# void addIndent (std::string & _data , int32_t _indent ) const ;
+add indentation of the string input.
+
+Parameter [input] [output]: _data String where the indentation is done.
+Parameter [input]: _indent Number of tab to add at the string.
+
+
+
+
+
+drawElementParsed
+# void drawElementParsed (char32_t _val , const exml::filePos & _filePos ) const ;
+Display the cuurent element that is curently parse.
+
+
+
+checkAvaillable
+# bool checkAvaillable (char32_t _val , bool _firstChar ) const ;
+check if an element or attribute is availlable (not : !"#$%&'()+,/;<=>?@[\]^`{|}~ \n\t\r and for first char : not -.0123456789).
+
+
+
+countWhiteChar
+# int32_t countWhiteChar (const std::string & _data , int32_t _pos , exml::filePos & _filePos ) const ;
+count the number of white char in the string from the specify position (stop at the first element that is not a white char)
+
+
+
+toDocument
++ virtual exml::Document * toDocument (void );
+Cast the element in a Document if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toDocument
++ virtual const exml::Document * toDocument (void ) const ;
+
+
+
+
+toAttribute
++ virtual exml::Attribute * toAttribute (void );
+Cast the element in a Attribute if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toAttribute
++ virtual const exml::Attribute * toAttribute (void ) const ;
+
+
+
+
+toComment
++ virtual exml::Comment * toComment (void );
+Cast the element in a Comment if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toComment
++ virtual const exml::Comment * toComment (void ) const ;
+
+
+
+
+toDeclaration
++ virtual exml::Declaration * toDeclaration (void );
+Cast the element in a Declaration if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toDeclaration
++ virtual const exml::Declaration * toDeclaration (void ) const ;
+
+
+
+
+toElement
++ virtual exml::Element * toElement (void );
+Cast the element in a Element if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toElement
++ virtual const exml::Element * toElement (void ) const ;
+
+
+
+
+toText
++ virtual exml::Text * toText (void );
+Cast the element in a Text if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toText
++ virtual const exml::Text * toText (void ) const ;
+
+
+
+
+isDocument
++ bool isDocument (void ) const ;
+check if the node is a exml::Document
+
+Return: true if the node is a exml::Document
+
+
+
+
+isAttribute
++ bool isAttribute (void ) const ;
+check if the node is a exml::Attribute
+
+Return: true if the node is a exml::Attribute
+
+
+
+
+isComment
++ bool isComment (void ) const ;
+check if the node is a exml::Comment
+
+Return: true if the node is a exml::Comment
+
+
+
+
+isDeclaration
++ bool isDeclaration (void ) const ;
+check if the node is a exml::Declaration
+
+Return: true if the node is a exml::Declaration
+
+
+
+
+isElement
++ bool isElement (void ) const ;
+check if the node is a exml::Element
+
+Return: true if the node is a exml::Element
+
+
+
+
+isText
++ bool isText (void ) const ;
+check if the node is a exml::Text
+
+Return: true if the node is a exml::Text
+
+
+
+
+clear
++ virtual void clear (void );
+clear the Node
+
+
+
+
+
+
diff --git a/class_exml__Text.html b/class_exml__Text.html
new file mode 100644
index 0000000..a6c9ac1
--- /dev/null
+++ b/class_exml__Text.html
@@ -0,0 +1,142 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::Text Description:
+
+
+
Constructor and Destructor:
+
++ Text (void ); + Text (const std::string & _data ); + virtual ~Text (void );
+
+
Synopsis:
+
++ int32_t countLines (void ) const ; + virtual enum nodeType getType (void ) const ; + virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + virtual bool iGenerate (std::string & _data , int32_t _indent ) const ; + virtual exml::Text * toText (void ); + virtual const exml::Text * toText (void ) const ;
+
+
Object Hierarchy:
+
++exml::Node +--> exml::Text +--> exml::TextCDATA
+Detail:
+Text
++ Text (void );
+Constructor
+
+
+Text
++ Text (const std::string & _data );
+Constructor
+
+
+
+~Text
++ virtual ~Text (void );
+Destructor
+
+
+countLines
++ int32_t countLines (void ) const ;
+count the number of line in the current text
+
+Return: The number of lines
+
+
+
+
+getType
++ virtual enum nodeType getType (void ) const ;
+get the node type.
+
+Return: the type of the Node.
+
+
+
+
+iParse
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
+parse the Current node [pure VIRUAL]
+
+Parameter [input]: _data data string to parse.
+Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
+Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
+Parameter [input] [output]: file parsing position (line x col x)
+Return: false if an error occured.
+
+
+
+
+iGenerate
++ virtual bool iGenerate (std::string & _data , int32_t _indent ) const ;
+generate a string with the tree of the xml
+
+
+
+toText
++ virtual exml::Text * toText (void );
+Cast the element in a Text if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+toText
++ virtual const exml::Text * toText (void ) const ;
+Cast the element in a Text if it is possible.
+
+Return: pointer on the class or NULL.
+
+
+
+
+
+
+
+
diff --git a/class_exml__TextCDATA.html b/class_exml__TextCDATA.html
new file mode 100644
index 0000000..c7e7f65
--- /dev/null
+++ b/class_exml__TextCDATA.html
@@ -0,0 +1,85 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::TextCDATA Description:
+
+
+
Constructor and Destructor:
+
++ TextCDATA (void ); + virtual ~TextCDATA (void );
+
+
Synopsis:
+
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
+
+
Object Hierarchy:
+
++exml::Node +--> +exml::Text +--> exml::TextCDATA
+Detail:
+TextCDATA
++ TextCDATA (void );
+Constructor
+
+
+~TextCDATA
++ virtual ~TextCDATA (void );
+Destructor
+
+
+iParse
++ virtual bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
+parse the Current node [pure VIRUAL]
+
+Parameter [input]: _data data string to parse.
+Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
+Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
+Parameter [input] [output]: file parsing position (line x col x)
+Return: false if an error occured.
+
+
+
+
+
+
+
+
diff --git a/class_exml__filePos.html b/class_exml__filePos.html
new file mode 100644
index 0000000..0f14a68
--- /dev/null
+++ b/class_exml__filePos.html
@@ -0,0 +1,145 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
class: exml::filePos Description:
+
+
+
Associated Namespace:
+
Constructor and Destructor:
+
++ filePos (void ); + filePos (int32_t _line , int32_t _col ); + ~filePos (void );
+
+
Synopsis:
+
++ filePos & operator ++ (void ); + filePos & operator -- (void ); + const filePos & operator += (const filePos & _obj ); + const filePos & operator += (int32_t _col ); + const filePos & operator = (const filePos & _obj ); + void newLine (void ); + bool check (char32_t _val ); + void set (int32_t _line , int32_t _col ); + void clear (void ); + int32_t getCol (void ) const ; + int32_t getLine (void ) const ;
+
+
Detail:
+
filePos
++ filePos (void );
+
+
+
+
+
filePos
++ filePos (int32_t _line , int32_t _col );
+
+
+
+
+
~filePos
++ ~filePos (void );
+
+
+
+
+
operator ++
++ filePos & operator ++ (void );
+
+
+
+
+
operator --
++ filePos & operator -- (void );
+
+
+
+
+
operator +=
++ const filePos & operator += (const filePos & _obj );
+
+
+
+
+
operator +=
++ const filePos & operator += (int32_t _col );
+
+
+
+
+
operator =
++ const filePos & operator = (const filePos & _obj );
+
+
+
+
+
newLine
++ void newLine (void );
+
+
+
+
+
check
++ bool check (char32_t _val );
+
+
+
+
+
set
++ void set (int32_t _line , int32_t _col );
+
+
+
+
+
clear
++ void clear (void );
+
+
+
+
+
getCol
++ int32_t getCol (void ) const ;
+
+
+
+
+
getLine
++ int32_t getLine (void ) const ;
+
+
+
+
+
+
+
+
diff --git a/enum_exml__nodeType.html b/enum_exml__nodeType.html
new file mode 100644
index 0000000..1d8d454
--- /dev/null
+++ b/enum_exml__nodeType.html
@@ -0,0 +1,103 @@
+
+
+
+
+ exml Library
+
+
+
+
+
+
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
+
+
+
+
enum: exml::nodeType Description:
+
+
+
Value list
+
+
Detail:
+
typeUnknow
+typeUnknow = 0
+
+might be an error ...
+
typeNode
+typeNode = 1
+
+might be an error ...
+
typeDocument
+typeDocument = 2
+
+all the file main access
+
typeDeclaration
+typeDeclaration = 3
+
+<?xml ... ?>
+
typeAttribute
+typeAttribute = 4
+
+the <Element ATTRIBUTE="ATTRIBUTE_VALUE" />
+
typeElement
+typeElement = 5
+
+the <XXX> ... </XXX>
+
typeComment
+typeComment = 6
+
+comment node : <!-- -->
+
typeText
+typeText = 7
+
+<XXX> InsideText </XXX>
+
+
+
diff --git a/exml__Attribute.html b/exml__Attribute.html
deleted file mode 100644
index 1ebec69..0000000
--- a/exml__Attribute.html
+++ /dev/null
@@ -1,181 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::Attribute
-
-
Synopsis:
-
-+ Attribute (void ); + Attribute (const std::string & _name , const std::string & _value ); + Attribute (const std::u32string & _name , const std::u32string & _value ); + ~Attribute (void ); + void setName (const std::string & _name ); + void setName (const std::u32string & _name ); + const std::string & getName (void ); + std::u32string getUName (void ); + enum nodeType getType (void ); + bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + bool iGenerate (std::string & _data , int32_t _indent ); + exml::Attribute * toAttribute (void ); + const exml::Attribute * toAttribute (void ); + void clear (void );
-
-
-
Object Hierarchy:
-
-Node
- +--> exml::Attribute
-
-
-
Detail:
-
-
-
-Attribute (void );
-
-Constructor
-
-
-
-
-
-
-Attribute (const std::string & _name ,
- const std::string & _value );
-
-Constructor
-
-Parameter [input]: _name Name of the attribute.
-Parameter [input]: _value Value of the attribute.
-
-
-
-
-
-
-
-Attribute (const std::u32string & _name ,
- const std::u32string & _value );
-
-
-
-
-
-
-
-~Attribute (void );
-
-Destructor
-
-
-
-
-
-
-void setName (const std::string & _name );
-
-set the name of the attribute
-
-Parameter [input]: _name New name of the attribute
-
-
-
-
-
-
-
-void setName (const std::u32string & _name );
-
-
-
-
-
-
-
-const std::string & getName (void );
-
-get the current name of the Attribute
-
-Return: String of the attribute
-
-
-
-
-
-
-
-std::u32string getUName (void );
-
-
-
-
-
-
-
-enum nodeType getType (void );
-
-
-
-
-
-
-
-bool iParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc );
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-
-
-
-
-
-
-exml::Attribute * toAttribute (void );
-
-
-
-
-
-
-
-const exml::Attribute * toAttribute (void );
-
-
-
-
-
-
-
-void clear (void );
-
-
-
-
-
-
-
diff --git a/exml__AttributeList.html b/exml__AttributeList.html
deleted file mode 100644
index 081ca8a..0000000
--- a/exml__AttributeList.html
+++ /dev/null
@@ -1,213 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::AttributeList
-
-
Synopsis:
-
-+ AttributeList (void ); + AttributeList (const std::string & _value ); + AttributeList (const std::u32string & _value ); + ~AttributeList (void ); + size_t sizeAttribute (void ); + void appendAttribute (exml::Attribute * _attr ); + Attribute * getAttr (int32_t _id ); + const Attribute * getAttr (int32_t _id ); + const std::string & getAttribute (const std::string & _name ); + std::u32string getAttribute (const std::u32string & _name ); + bool existAttribute (const std::string & _name ); + bool existAttribute (const std::u32string & _name ); + void setAttribute (const std::string & _name , const std::string & _value ); + void setAttribute (const std::u32string & _name , const std::u32string & _value ); + bool iGenerate (std::string & _data , int32_t _indent ); + void clear (void );
-
-
-
Object Hierarchy:
-
-Node
- +--> exml::AttributeList
- +--> exml::Declaration
-
-
-
Detail:
-
-
-
-AttributeList (void );
-
-Constructor
-
-
-
-
-
-
-AttributeList (const std::string & _value );
-
-Constructor
-
-Parameter [input]: _value Node value;
-
-
-
-
-
-
-
-AttributeList (const std::u32string & _value );
-
-
-
-
-
-
-
-~AttributeList (void );
-
-Destructor
-
-
-
-
-
-
-size_t sizeAttribute (void );
-
-get the number of attribute in the Node
-
-Return: Nulber of attribute >=0
-
-
-
-
-
-
-
-void appendAttribute (exml::Attribute * _attr );
-
-add attribute on the List
-
-Parameter [input]: _attr Pointer on the attribute
-
-
-
-
-
-
-
-Attribute * getAttr (int32_t _id );
-
-get attribute whith his ID
-
-Parameter [input]: _id Identifier of the attribute 0<= _id < sizeAttribute()
-Return: Pointer on the attribute or NULL
-
-
-
-
-
-
-
-const Attribute * getAttr (int32_t _id );
-
-
-
-
-
-
-
-const std::string & getAttribute (const std::string & _name );
-
-get the attribute value with searching in the List with his name
-
-Parameter [input]: _name Attribute Name.
-Return: Value of the attribute or no data in the string
-
-
-
-
-
-
-
-std::u32string getAttribute (const std::u32string & _name );
-
-
-
-
-
-
-
-bool existAttribute (const std::string & _name );
-
-check if an attribute exist or not with his name.
-
-Parameter [input]: _name Attribute Name.
-Return: true if the attribute exist or False
-
-
-
-
-
-
-
-bool existAttribute (const std::u32string & _name );
-
-
-
-
-
-
-
-void setAttribute (const std::string & _name ,
- const std::string & _value );
-
-Sen A new attribute or replace data of the previous one
-
-Parameter [input]: _name Name of the attribute
-Parameter [input]: _value Value of the attribute
-
-
-
-
-
-
-
-void setAttribute (const std::u32string & _name ,
- const std::u32string & _value );
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-
-
-
-
-
-
-void clear (void );
-
-
-
-
-
-
-
diff --git a/exml__Comment.html b/exml__Comment.html
deleted file mode 100644
index 6d64931..0000000
--- a/exml__Comment.html
+++ /dev/null
@@ -1,130 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::Comment
-
-
Synopsis:
-
-+ Comment (void ); + Comment (const std::string & _value ); + Comment (const std::u32string & _value ); + ~Comment (void ); + enum nodeType getType (void ); + bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + bool iGenerate (std::string & _data , int32_t _indent ); + exml::Comment * toComment (void ); + const exml::Comment * toComment (void );
-
-
-
Object Hierarchy:
-
-Node
- +--> exml::Comment
-
-
-
Detail:
-exml:: ()
-
-
-Comment (void );
-
-Constructor
-
-
-
-exml:: ()
-
-
-Comment (const std::string & _value );
-
-Constructor
-
-Parameter [input]: _value comment value
-
-
-
-
-exml:: ()
-
-
-Comment (const std::u32string & _value );
-
-
-
-
-exml::~ ()
-
-
-~Comment (void );
-
-Destructor
-
-
-
-
-
-
-enum nodeType getType (void );
-
-
-
-
-
-
-
-bool iParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc );
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-
-
-
- ()
-
-
-exml::Comment * toComment (void );
-
-
-
-
- ()
-
-
-const exml::Comment * toComment (void );
-
-
-
-
-
-
-
diff --git a/exml__Declaration.html b/exml__Declaration.html
deleted file mode 100644
index 5b7c7eb..0000000
--- a/exml__Declaration.html
+++ /dev/null
@@ -1,132 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::Declaration
-
-
Synopsis:
-
-+ Declaration (void ); + Declaration (const std::string & _name ); + Declaration (const std::u32string & _name ); + ~Declaration (void ); + enum nodeType getType (void ); + bool iGenerate (std::string & _data , int32_t _indent ); + bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + exml::Declaration * toDeclaration (void ); + const exml::Declaration * toDeclaration (void );
-
-
-
Object Hierarchy:
-
-Node
- +--> exml::AttributeList
- +--> exml::Declaration
- +--> exml::DeclarationXML
-
-
-
Detail:
-
-
-
-Declaration (void );
-
-Constructor
-
-
-
-
-
-
-Declaration (const std::string & _name );
-
-Constructor
-
-Parameter [input]: _name name of the declaration (xml, xml:xxxx ...)
-
-
-
-
-
-
-
-Declaration (const std::u32string & _name );
-
-
-
-
-
-
-
-~Declaration (void );
-
-Destructor
-
-
-
-
-
-
-enum nodeType getType (void );
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-
-
-
-
-
-
-bool iParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc );
-
-
-
-
-
-
-
-exml::Declaration * toDeclaration (void );
-
-
-
-
-
-
-
-const exml::Declaration * toDeclaration (void );
-
-
-
-
-
-
-
diff --git a/exml__DeclarationXML.html b/exml__DeclarationXML.html
deleted file mode 100644
index f50af12..0000000
--- a/exml__DeclarationXML.html
+++ /dev/null
@@ -1,84 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::DeclarationXML
-
-
Synopsis:
-
-+ DeclarationXML (const std::string & _version , enum unicode::charset _format , bool _standalone ); + DeclarationXML (const std::u32string & _version , enum unicode::charset _format , bool _standalone ); + ~DeclarationXML (void );
-
-
-
Object Hierarchy:
-
-Node
- +--> exml::AttributeList
- +--> exml::Declaration
- +--> exml::DeclarationXML
-
-
-
Detail:
-
-
-
-DeclarationXML (const std::string & _version ,
- enum unicode::charset _format ,
- bool _standalone );
-
-Constructor for the generic declaration :
-
-Parameter [input]: _version Xml version.
-Parameter [input]: _format charset of the XML
-Parameter [input]: _standalone this document is standalone
-
-
-
-
-
-
-
-DeclarationXML (const std::u32string & _version ,
- enum unicode::charset _format ,
- bool _standalone );
-
-
-
-
-
-
-
-~DeclarationXML (void );
-
-Destructor
-
-
-
-
-
-
diff --git a/exml__Document.html b/exml__Document.html
deleted file mode 100644
index 9ff499b..0000000
--- a/exml__Document.html
+++ /dev/null
@@ -1,279 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::Document
-
-
Synopsis:
-
-+ Document (void ); + ~Document (void ); + void setCharset (enum unicode::charset _charset ); + enum unicode::charset getCharset (void ); + void setCaseSensitive (bool _val ); + bool getCaseSensitive (void ); + bool parse (const std::string & _data ); + bool parse (const std::u32string & _data ); + bool generate (std::string & _data ); + bool generate (std::u32string & _data ); + bool load (const std::string & _file ); + bool load (const std::u32string & _file ); + bool store (const std::string & _file ); + bool store (const std::u32string & _file ); + void display (void ); + void displayErrorWhenDetected (void ); + void notDisplayErrorWhenDetected (void ); + void createError (const std::string & _data , int32_t _pos , const exml::filePos & _filePos , const std::string & _comment ); + void displayError (void ); + enum nodeType getType (void ); + bool iGenerate (std::string & _data , int32_t _indent ); + exml::Document * toDocument (void ); + const exml::Document * toDocument (void );
-
-
-
Object Hierarchy:
-
-AttributeList
- +--> exml::Element
- +--> exml::Document
-
-
-
Detail:
-
-
-
-Document (void );
-
-Constructor
-
-
-
-
-
-
-~Document (void );
-
-Destructor
-
-
-
-
-
-
-void setCharset (enum unicode::charset _charset );
-
-get the current charset of the Parsing
-
-Parameter [input]: _charset The new charset
-
-
-
-
-
-
-
-enum unicode::charset getCharset (void );
-
-get the current charset of the Parsing
-
-Return: The current charset
-
-
-
-
-
-
-
-void setCaseSensitive (bool _val );
-
-Enable or diasable the case sensitive (must be done before the call of parsing)
-
-Parameter [input]: _val true if enable; false else.
-
-
-
-
-
-
-
-bool getCaseSensitive (void );
-
-get the status of case sensitive mode.
-
-Return: true if case sensitive is active
-
-
-
-
-
-
-
-bool parse (const std::string & _data );
-
-parse a string that contain an XML
-
-Parameter [input]: _data Data to parse
-Return: false : An error occured
-Return: true : Parsing is OK
-
-
-
-
-
-
-
-bool parse (const std::u32string & _data );
-
-
-
-
-
-
-
-bool generate (std::string & _data );
-
-generate a string that contain the created XML
-
-Parameter [output]: _data Data where the xml is stored
-Return: false : An error occured
-Return: true : Parsing is OK
-
-
-
-
-
-
-
-bool generate (std::u32string & _data );
-
-
-
-
-
-
-
-bool load (const std::string & _file );
-
-Load the file that might contain the xml
-
-Parameter [input]: _file Filename of the xml (compatible with etk FSNode naming)
-Return: false : An error occured
-Return: true : Parsing is OK
-
-
-
-
-
-
-
-bool load (const std::u32string & _file );
-
-
-
-
-
-
-
-bool store (const std::string & _file );
-
-Store the Xml in the file
-
-Parameter [input]: _file Filename of the xml (compatible with etk FSNode naming)
-Return: false : An error occured
-Return: true : Parsing is OK
-
-
-
-
-
-
-
-bool store (const std::u32string & _file );
-
-
-
-
-
-
-
-void display (void );
-
-Display the Document on console
-
-
-
-
-
-
-void displayErrorWhenDetected (void );
-
-
-
-
-
-
-
-void notDisplayErrorWhenDetected (void );
-
-
-
-
-
-
-
-void createError (const std::string & _data ,
- int32_t _pos ,
- const exml::filePos & _filePos ,
- const std::string & _comment );
-
-
-
-
-
-
-
-void displayError (void );
-
-
-
-
-
-
-
-enum nodeType getType (void );
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-
-
-
-
-
-
-exml::Document * toDocument (void );
-
-
-
-
-
-
-
-const exml::Document * toDocument (void );
-
-
-
-
-
-
-
diff --git a/exml__Element.html b/exml__Element.html
deleted file mode 100644
index 1d7ef3b..0000000
--- a/exml__Element.html
+++ /dev/null
@@ -1,275 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::Element
-
-
Synopsis:
-
-+ Element (void ); + Element (const std::string & _value ); + Element (const std::u32string & _value ); + ~Element (void ); + size_t size (void ); + void append (Node * _node ); + const enum nodeType getType (int32_t _id ); + Node * getNode (int32_t _id ); + const Node * getNode (int32_t _id ); + Element * getElement (int32_t _id ); + const Element * getElement (int32_t _id ); + Element * getNamed (const std::string & _name ); + const Element * getNamed (const std::string & _name ); + Element * getNamed (const std::u32string & _name ); + const Element * getNamed (const std::u32string & _name ); + std::string getText (void ); + enum nodeType getType (void ); + bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + bool iGenerate (std::string & _data , int32_t _indent ); + exml::Element * toElement (void ); + const exml::Element * toElement (void ); + void clear (void ); # bool subParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc , bool _mainNode );
-
-
-
Object Hierarchy:
-
-AttributeList
- +--> exml::Element
- +--> exml::Document
-
-
-
Detail:
-
-
-
-Element (void );
-
-Constructor
-
-
-
-
-
-
-Element (const std::string & _value );
-
-Constructor
-
-Parameter [input]: _value Element name;
-
-
-
-
-
-
-
-Element (const std::u32string & _value );
-
-
-
-
-
-
-
-~Element (void );
-
-Destructor
-
-
-
-
-
-
-size_t size (void );
-
-get the number of sub element in the node (can be exml::Comment ; exml::Element ; exml::Text :exml::Declaration).
-
-
-
-
-
-
-
-void append (Node * _node );
-
-add a node at the element (not exml::Attribute (move in the attribute automaticly).
-
-Parameter [input]: _node Pointer of the node to add.
-
-
-
-
-
-
-
-const enum nodeType getType (int32_t _id );
-
-
-
-
-
-
-
-Node * getNode (int32_t _id );
-
-get the Node pointer of the element id.
-
-Parameter [input]: _id Id of the element.
-Return: Pointer on node.
-
-
-
-
-
-
-
-const Node * getNode (int32_t _id );
-
-
-
-
-
-
-
-Element * getElement (int32_t _id );
-
-get the element casted in Element (if the node is not an element return NULL).
-
-Parameter [input]: _id Id of the element.
-Return: Pointer on the element or NULL.
-
-
-
-
-
-
-
-const Element * getElement (int32_t _id );
-
-
-
-
-
-
-
-Element * getNamed (const std::string & _name );
-
-get an element with his name (work only with exml::Element)
-
-Parameter [input]: _name Name of the element that is requested
-Return: Pointer on the element or NULL.
-
-
-
-
-
-
-
-const Element * getNamed (const std::string & _name );
-
-
-
-
-
-
-
-Element * getNamed (const std::u32string & _name );
-
-
-
-
-
-
-
-const Element * getNamed (const std::u32string & _name );
-
-
-
-
-
-
-
-std::string getText (void );
-
-get the internal data of the element (if the element has some sub node thay are converted in xml string == > like this it is not needed to use
-
-Return: the curent data string.
-
-
-
-
-
-
-
-enum nodeType getType (void );
-
-
-
-
-
-
-
-bool iParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc );
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-
-
-
-
-
-
-exml::Element * toElement (void );
-
-
-
-
-
-
-
-const exml::Element * toElement (void );
-
-
-
-
-
-
-
-void clear (void );
-
-
-
-
-
-
-
-bool subParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc ,
- bool _mainNode );
-
-
-
-
-
-
-
diff --git a/exml__Node.html b/exml__Node.html
deleted file mode 100644
index a830c98..0000000
--- a/exml__Node.html
+++ /dev/null
@@ -1,434 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::Node
-
-
Synopsis:
-
-+ Node (void ); + Node (const std::string & _value ); + Node (const std::u32string & _value ); + ~Node (void ); + bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + bool iGenerate (std::string & _data , int32_t _indent ); + const exml::filePos & getPos (void ); + void setValue (std::string _value ); + void setValue (std::u32string _value ); + const std::string & getValue (void ); + std::u32string getUValue (void ); + enum nodeType getType (void ); + exml::Document * toDocument (void ); + const exml::Document * toDocument (void ); + exml::Attribute * toAttribute (void ); + const exml::Attribute * toAttribute (void ); + exml::Comment * toComment (void ); + const exml::Comment * toComment (void ); + exml::Declaration * toDeclaration (void ); + const exml::Declaration * toDeclaration (void ); + exml::Element * toElement (void ); + const exml::Element * toElement (void ); + exml::Text * toText (void ); + const exml::Text * toText (void ); + bool isDocument (void ); + bool isAttribute (void ); + bool isComment (void ); + bool isDeclaration (void ); + bool isElement (void ); + bool isText (void ); + void clear (void ); # void addIndent (std::string & _data , int32_t _indent ); # void drawElementParsed (char32_t _val , const exml::filePos & _filePos ); # bool checkAvaillable (char32_t _val , bool _firstChar ); # int32_t countWhiteChar (const std::string & _data , int32_t _pos , exml::filePos & _filePos );
-
-
-
Detail:
-exml::Node ()
-
-
-Node (void );
-
-basic element of a xml structure
-
-
-
-exml::Node ()
-
-
-Node (const std::string & _value );
-
-basic element of a xml structure
-
-Parameter [input]: value of the node
-
-
-
-
-exml::Node ()
-
-
-Node (const std::u32string & _value );
-
-
-
-
-exml::~Node ()
-
-
-~Node (void );
-
-destructor
-
-
-
-
-
-
-bool iParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc );
-
-parse the Current node [pure VIRUAL]
-
-Parameter [input]: _data data string to parse.
-Parameter [input] [output]: _pos position in the string to start parse, return the position end of parsing.
-Parameter [input]: _caseSensitive Request a parsion of element that is not case sensitive (all element is in low case)
-Parameter [input] [output]: file parsing position (line x col x)
-Return: false if an error occured.
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-generate a string with the tree of the xml
-
-Parameter [input] [output]: _data string where to add the elements
-Parameter [input]: current indentation of the file
-Return: false if an error occured.
-
-
-
-
-
-
-
-const exml::filePos & getPos (void );
-
-get the current position where the element is in the file
-
-
-
-
-
-
-void setValue (std::string _value );
-
-set the value of the node.
-
-Parameter [input]: _value New value of the node.
-
-
-
-
-
-
-
-void setValue (std::u32string _value );
-
-
-
-
-
-
-
-const std::string & getValue (void );
-
-get the current element Value.
-
-Return: the reference of the string value.
-
-
-
-
-
-
-
-std::u32string getUValue (void );
-
-
-
-
-
-
-
-enum nodeType getType (void );
-
-get the node type.
-
-Return: the type of the Node.
-
-
-
-
-
-
-
-exml::Document * toDocument (void );
-
-Cast the element in a Document if it is possible.
-
-Return: pointer on the class or NULL.
-
-
-
-
-
-
-
-const exml::Document * toDocument (void );
-
-
-
-
-
-
-
-exml::Attribute * toAttribute (void );
-
-Cast the element in a Attribute if it is possible.
-
-Return: pointer on the class or NULL.
-
-
-
-
-
-
-
-const exml::Attribute * toAttribute (void );
-
-
-
-
- ()
-
-
-exml::Comment * toComment (void );
-
-Cast the element in a Comment if it is possible.
-
-Return: pointer on the class or NULL.
-
-
-
-
- ()
-
-
-const exml::Comment * toComment (void );
-
-
-
-
-
-
-
-exml::Declaration * toDeclaration (void );
-
-Cast the element in a Declaration if it is possible.
-
-Return: pointer on the class or NULL.
-
-
-
-
-
-
-
-const exml::Declaration * toDeclaration (void );
-
-
-
-
-
-
-
-exml::Element * toElement (void );
-
-Cast the element in a Element if it is possible.
-
-Return: pointer on the class or NULL.
-
-
-
-
-
-
-
-const exml::Element * toElement (void );
-
-
-
-
-
-
-
-exml::Text * toText (void );
-
-Cast the element in a Text if it is possible.
-
-Return: pointer on the class or NULL.
-
-
-
-
-
-
-
-const exml::Text * toText (void );
-
-
-
-
-
-
-
-bool isDocument (void );
-
-check if the node is a exml::Document
-
-Return: true if the node is a exml::Document
-
-
-
-
-
-
-
-bool isAttribute (void );
-
-check if the node is a exml::Attribute
-
-Return: true if the node is a exml::Attribute
-
-
-
-
- ()
-
-
-bool isComment (void );
-
-check if the node is a exml::Comment
-
-Return: true if the node is a exml::Comment
-
-
-
-
-
-
-
-bool isDeclaration (void );
-
-check if the node is a exml::Declaration
-
-Return: true if the node is a exml::Declaration
-
-
-
-
-
-
-
-bool isElement (void );
-
-check if the node is a exml::Element
-
-Return: true if the node is a exml::Element
-
-
-
-
-
-
-
-bool isText (void );
-
-check if the node is a exml::Text
-
-Return: true if the node is a exml::Text
-
-
-
-
-
-
-
-void clear (void );
-
-clear the Node
-
-
-
-
-
-
-void addIndent (std::string & _data ,
- int32_t _indent );
-
-add indentation of the string input.
-
-Parameter [input] [output]: _data String where the indentation is done.
-Parameter [input]: _indent Number of tab to add at the string.
-
-
-
-
-
-
-
-void drawElementParsed (char32_t _val ,
- const exml::filePos & _filePos );
-
-Display the cuurent element that is curently parse.
-
-Parameter [input]: _val Char that is parsed.
-Parameter [input]: _filePos Position of the char in the file.
-
-
-
-
-
-
-
-bool checkAvaillable (char32_t _val ,
- bool _firstChar );
-
-check if an element or attribute is availlable (not : !"#$%&'()*+,/;<=>?
-Parameter [input]: _val Value to check the conformity.
-Parameter [input]: _firstChar True if the element check is the first char.
-
-
-
-
-
-
-
-int32_t countWhiteChar (const std::string & _data ,
- int32_t _pos ,
- exml::filePos & _filePos );
-
-count the number of white char in the string from the specify position (stop at the first element that is not a white char)
-
-Parameter [input]: _data Data to parse.
-Parameter [input]: _pos Start position in the string.
-Parameter [output]: _filePos new poistion of te file to add.
-Return: number of white element.
-
-
-
-
-
-
-
diff --git a/exml__Text.html b/exml__Text.html
deleted file mode 100644
index fe8af5c..0000000
--- a/exml__Text.html
+++ /dev/null
@@ -1,134 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::Text
-
-
Synopsis:
-
-+ Text (void ); + Text (const std::string & _data ); + ~Text (void ); + int32_t countLines (void ); + enum nodeType getType (void ); + bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc ); + bool iGenerate (std::string & _data , int32_t _indent ); + exml::Text * toText (void ); + const exml::Text * toText (void );
-
-
-
Object Hierarchy:
-
-Node
- +--> exml::Text
-
-
-
Detail:
-exml::Text ()
-
-
-Text (void );
-
-Constructor
-
-
-
-exml::Text ()
-
-
-Text (const std::string & _data );
-
-Constructor
-
-Parameter [input]: _data String data of the current Text
-
-
-
-
-exml::~Text ()
-
-
-~Text (void );
-
-Destructor
-
-
-
-
-
-
-int32_t countLines (void );
-
-count the number of line in the current text
-
-Return: The number of lines
-
-
-
-
-
-
-
-enum nodeType getType (void );
-
-
-
-
-
-
-
-bool iParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc );
-
-
-
-
-
-
-
-bool iGenerate (std::string & _data ,
- int32_t _indent );
-
-
-
-
-
-
-
-exml::Text * toText (void );
-
-
-
-
-
-
-
-const exml::Text * toText (void );
-
-
-
-
-
-
-
diff --git a/exml__TextCDATA.html b/exml__TextCDATA.html
deleted file mode 100644
index 269bc0c..0000000
--- a/exml__TextCDATA.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::TextCDATA
-
-
Synopsis:
-
-+ TextCDATA (void ); + ~TextCDATA (void ); + bool iParse (const std::string & _data , int32_t & _pos , bool _caseSensitive , exml::filePos & _filePos , exml::Document & _doc );
-
-
-
Object Hierarchy:
-
-Text
- +--> exml::TextCDATA
-
-
-
Detail:
-
-
-
-TextCDATA (void );
-
-Constructor
-
-
-
-
-
-
-~TextCDATA (void );
-
-Destructor
-
-
-
-
-
-
-bool iParse (const std::string & _data ,
- int32_t & _pos ,
- bool _caseSensitive ,
- exml::filePos & _filePos ,
- exml::Document & _doc );
-
-
-
-
-
-
-
diff --git a/exml__filePos.html b/exml__filePos.html
deleted file mode 100644
index b6abd1d..0000000
--- a/exml__filePos.html
+++ /dev/null
@@ -1,155 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Class: exml::filePos
-
-
Synopsis:
-
-+ filePos (void ); + filePos (int32_t _line , int32_t _col ); + ~filePos (void ); + filePos & operator++ (void ); + filePos & operator-- (void ); + const filePos & operator+= (const filePos & _obj ); + const filePos & operator+= (int32_t _col ); + const filePos & operator= (const filePos & _obj ); + void newLine (void ); + bool check (char32_t _val ); + void set (int32_t _line , int32_t _col ); + void clear (void ); + int32_t getCol (void ); + int32_t getLine (void );
-
-
-
Detail:
-
-
-
-filePos (void );
-
-
-
-
-
-
-
-filePos (int32_t _line ,
- int32_t _col );
-
-
-
-
-
-
-
-~filePos (void );
-
-
-
-
-
-
-
-filePos & operator++ (void );
-
-
-
-
-
-
-
-filePos & operator-- (void );
-
-
-
-
-
-
-
-const filePos & operator+= (const filePos & _obj );
-
-
-
-
-
-
-
-const filePos & operator+= (int32_t _col );
-
-
-
-
-
-
-
-const filePos & operator= (const filePos & _obj );
-
-
-
-
-
-
-
-void newLine (void );
-
-
-
-
-
-
-
-bool check (char32_t _val );
-
-
-
-
-
-
-
-void set (int32_t _line ,
- int32_t _col );
-
-
-
-
-
-
-
-void clear (void );
-
-
-
-
-
-
-
-int32_t getCol (void );
-
-
-
-
-
-
-
-int32_t getLine (void );
-
-
-
-
-
-
-
diff --git a/exml__nodeType.html b/exml__nodeType.html
deleted file mode 100644
index 1b1309f..0000000
--- a/exml__nodeType.html
+++ /dev/null
@@ -1,38 +0,0 @@
-
-
-
-
- exml Library
-
-
-
-
-
-
Enum: exml::nodeType
-
-Value :
-
-typeUnknow typeNode typeDocument typeDeclaration typeAttribute typeElement typeComment typeText
-
-
-
diff --git a/index.html b/index.html
index d89cc69..b7a427d 100644
--- a/index.html
+++ b/index.html
@@ -4,30 +4,44 @@
exml Library
+
-
exml Library
-
exml
-
-
nodeType
-
+
+
+
API:
+
Associate libraries:
+
+
+
+
+
+
exml TODO : Main page ...
+