commit 2d998818193c2b83a2dce723aa5bea374374cac3 Author: Edouard DUPIN Date: Fri Dec 6 16:07:02 2013 +0100 [DEV] add first exml documentation diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0d20b64 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.pyc diff --git a/base.css b/base.css new file mode 100644 index 0000000..aa94d74 --- /dev/null +++ b/base.css @@ -0,0 +1,131 @@ + +html { + display: block; +} + +body { + font-family: 'Ubuntu',Tahoma,sans-serif; + padding-top: 40px; + padding-bottom: 40px; + font-size: 15px; + line-height: 150%; + margin: 0; + color: #333333; + background-color: #ffffff; + display: block; + margin-left: 250px; + margin-right: 50px; +}; + +.container{ + width:940px; + margin-right: auto; + margin-left: auto; + display: block; +}; + +.navbar { + z-index: 1; + overflow: visible; + color: #ffffff; + display: block; +} + +.navbar div { + display: block; + margin-left: 5px; + margin-right: 5px; +} + +.navbar-fixed-top { + width:210px; + display: block; + position: fixed; + padding-top: 0px; + top: 0; + height: 100%; + right: 0; + left: 0; + margin-bottom: 0; + background-color: #d44413; + border: 1px solid #c64012; + font-size: 15px; + font-weight: 200; + color: #ffffff; + text-shadow: 0 1px 0 #ce4213; + padding: 10px 20px 10px; + margin-left: -20px; + overflow:scroll; + overflow-x:hidden; +} +/* +.navbar ul { + font-size: 15px; +}; +*/ +h1, h2, h3, h4, h5, h6 { + display: block; + margin: 10px 0; + font-family: inherit; + font-weight: bold; + line-height: 1; + color: inherit; + text-rendering: optimizelegibility; +} + +p { + margin: 0 0 10px; + display: block; +} + +pre { + #margin-left: 20px; + display: block; + padding: 9.5px; + margin: 0 0 10px; + font-size: 13px; + line-height: 20px; + word-break: break-all; + word-wrap: break-word; + white-space: pre; + white-space: pre-wrap; + background-color: #f5f5f5; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.15); + border-radius: 4px; +} + + + +.code-function { + text-decoration:none; + color:#09857e; + font-weight:bold; +} + +.code-type { + text-decoration:none; + color:#376d0a; + font-weight:bold; +} + +.code-argument { + text-decoration:none; + color:#B80000; + font-weight:bold; +} + +.code-number { + text-decoration:none; + color:#007b00; +} + +.code-keyword { + text-decoration:none; + color:#215eb8; + font-weight:bold; +} +.code-storage-keyword { + text-decoration:none; + color:#466cb4; +} \ No newline at end of file diff --git a/exml__Attribute.html b/exml__Attribute.html new file mode 100644 index 0000000..1ebec69 --- /dev/null +++ b/exml__Attribute.html @@ -0,0 +1,181 @@ + + + + + exml Library + + + +
+
+

exml Library

+
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::Attribute ()

    + +
    +Attribute(void);
    +
    +Constructor +

    + +
    +

    exml::Attribute ()

    + +
    +Attribute(const std::string & _name,
+          const std::string & _value);
    +
    +Constructor +
    +
    + +
    +

    exml::Attribute ()

    + +
    +Attribute(const std::u32string & _name,
+          const std::u32string & _value);
    +
    +
    + +
    +

    exml::~Attribute ()

    + +
    +~Attribute(void);
    +
    +Destructor +

    + +
    +

    setName ()

    + +
    +void setName(const std::string & _name);
    +
    +set the name of the attribute +
    +
    + +
    +

    setName ()

    + +
    +void setName(const std::u32string & _name);
    +
    +
    + +
    +

    getName ()

    + +
    +const std::string & getName(void);
    +
    +get the current name of the Attribute +
    +
    + +
    +

    getUName ()

    + +
    +std::u32string getUName(void);
    +
    +
    + +
    +

    getType ()

    + +
    +enum nodeType getType(void);
    +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            int32_t & _pos,
+            bool _caseSensitive,
+            exml::filePos & _filePos,
+            exml::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +
    + +
    +

    toAttribute ()

    + +
    +exml::Attribute * toAttribute(void);
    +
    +
    + +
    +

    toAttribute ()

    + +
    +const exml::Attribute * toAttribute(void);
    +
    +
    + +
    +

    clear ()

    + +
    +void clear(void);
    +
    +
    + +
    +
    + + diff --git a/exml__AttributeList.html b/exml__AttributeList.html new file mode 100644 index 0000000..081ca8a --- /dev/null +++ b/exml__AttributeList.html @@ -0,0 +1,213 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::AttributeList ()

    + +
    +AttributeList(void);
    +
    +Constructor +

    + +
    +

    exml::AttributeList ()

    + +
    +AttributeList(const std::string & _value);
    +
    +Constructor +
    +
    + +
    +

    exml::AttributeList ()

    + +
    +AttributeList(const std::u32string & _value);
    +
    +
    + +
    +

    exml::~AttributeList ()

    + +
    +~AttributeList(void);
    +
    +Destructor +

    + +
    +

    sizeAttribute ()

    + +
    +size_t sizeAttribute(void);
    +
    +get the number of attribute in the Node +
    +
    + +
    +

    appendAttribute ()

    + +
    +void appendAttribute(exml::Attribute * _attr);
    +
    +add attribute on the List +
    +
    + +
    +

    getAttr ()

    + +
    +Attribute * getAttr(int32_t _id);
    +
    +get attribute whith his ID +
    +
    + +
    +

    getAttr ()

    + +
    +const Attribute * getAttr(int32_t _id);
    +
    +
    + +
    +

    getAttribute ()

    + +
    +const std::string & getAttribute(const std::string & _name);
    +
    +get the attribute value with searching in the List with his name +
    +
    + +
    +

    getAttribute ()

    + +
    +std::u32string getAttribute(const std::u32string & _name);
    +
    +
    + +
    +

    existAttribute ()

    + +
    +bool existAttribute(const std::string & _name);
    +
    +check if an attribute exist or not with his name. +
    +
    + +
    +

    existAttribute ()

    + +
    +bool existAttribute(const std::u32string & _name);
    +
    +
    + +
    +

    setAttribute ()

    + +
    +void setAttribute(const std::string & _name,
+                  const std::string & _value);
    +
    +Sen A new attribute or replace data of the previous one +
    +
    + +
    +

    setAttribute ()

    + +
    +void setAttribute(const std::u32string & _name,
+                  const std::u32string & _value);
    +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +
    + +
    +

    clear ()

    + +
    +void clear(void);
    +
    +
    + +
    +
    + + diff --git a/exml__Comment.html b/exml__Comment.html new file mode 100644 index 0000000..6d64931 --- /dev/null +++ b/exml__Comment.html @@ -0,0 +1,130 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

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

    + +
    +Comment(void);
    +
    +Constructor +

    + +
    +

    exml::Comment ()

    + +
    +Comment(const std::string & _value);
    +
    +Constructor +
    +
    + +
    +

    exml::Comment ()

    + +
    +Comment(const std::u32string & _value);
    +
    +
    + +
    +

    exml::~Comment ()

    + +
    +~Comment(void);
    +
    +Destructor +

    + +
    +

    getType ()

    + +
    +enum nodeType getType(void);
    +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            int32_t & _pos,
+            bool _caseSensitive,
+            exml::filePos & _filePos,
+            exml::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +
    + +
    +

    toComment ()

    + +
    +exml::Comment * toComment(void);
    +
    +
    + +
    +

    toComment ()

    + +
    +const exml::Comment * toComment(void);
    +
    +
    + +
    +
    + + diff --git a/exml__Declaration.html b/exml__Declaration.html new file mode 100644 index 0000000..5b7c7eb --- /dev/null +++ b/exml__Declaration.html @@ -0,0 +1,132 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::Declaration ()

    + +
    +Declaration(void);
    +
    +Constructor +

    + +
    +

    exml::Declaration ()

    + +
    +Declaration(const std::string & _name);
    +
    +Constructor +
    +
    + +
    +

    exml::Declaration ()

    + +
    +Declaration(const std::u32string & _name);
    +
    +
    + +
    +

    exml::~Declaration ()

    + +
    +~Declaration(void);
    +
    +Destructor +

    + +
    +

    getType ()

    + +
    +enum nodeType getType(void);
    +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            int32_t & _pos,
+            bool _caseSensitive,
+            exml::filePos & _filePos,
+            exml::Document & _doc);
    +
    +
    + +
    +

    toDeclaration ()

    + +
    +exml::Declaration * toDeclaration(void);
    +
    +
    + +
    +

    toDeclaration ()

    + +
    +const exml::Declaration * toDeclaration(void);
    +
    +
    + +
    +
    + + diff --git a/exml__DeclarationXML.html b/exml__DeclarationXML.html new file mode 100644 index 0000000..f50af12 --- /dev/null +++ b/exml__DeclarationXML.html @@ -0,0 +1,84 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::DeclarationXML ()

    + +
    +DeclarationXML(const std::string & _version,
+               enum unicode::charset _format,
+               bool _standalone);
    +
    +Constructor for the generic declaration : +
    +
    + +
    +

    exml::DeclarationXML ()

    + +
    +DeclarationXML(const std::u32string & _version,
+               enum unicode::charset _format,
+               bool _standalone);
    +
    +
    + +
    +

    exml::~DeclarationXML ()

    + +
    +~DeclarationXML(void);
    +
    +Destructor +

    + +
    +
    + + diff --git a/exml__Document.html b/exml__Document.html new file mode 100644 index 0000000..9ff499b --- /dev/null +++ b/exml__Document.html @@ -0,0 +1,279 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::Document ()

    + +
    +Document(void);
    +
    +Constructor +

    + +
    +

    exml::~Document ()

    + +
    +~Document(void);
    +
    +Destructor +

    + +
    +

    setCharset ()

    + +
    +void setCharset(enum unicode::charset _charset);
    +
    +get the current charset of the Parsing +
    +
    + +
    +

    getCharset ()

    + +
    +enum unicode::charset getCharset(void);
    +
    +get the current charset of the Parsing +
    +
    + +
    +

    setCaseSensitive ()

    + +
    +void setCaseSensitive(bool _val);
    +
    +Enable or diasable the case sensitive (must be done before the call of parsing) +
    +
    + +
    +

    getCaseSensitive ()

    + +
    +bool getCaseSensitive(void);
    +
    +get the status of case sensitive mode. +
    +
    + +
    +

    parse ()

    + +
    +bool parse(const std::string & _data);
    +
    +parse a string that contain an XML +
    +
    + +
    +

    parse ()

    + +
    +bool parse(const std::u32string & _data);
    +
    +
    + +
    +

    generate ()

    + +
    +bool generate(std::string & _data);
    +
    +generate a string that contain the created XML +
    +
    + +
    +

    generate ()

    + +
    +bool generate(std::u32string & _data);
    +
    +
    + +
    +

    load ()

    + +
    +bool load(const std::string & _file);
    +
    +Load the file that might contain the xml +
    +
    + +
    +

    load ()

    + +
    +bool load(const std::u32string & _file);
    +
    +
    + +
    +

    store ()

    + +
    +bool store(const std::string & _file);
    +
    +Store the Xml in the file +
    +
    + +
    +

    store ()

    + +
    +bool store(const std::u32string & _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 ()

    + +
    +enum nodeType getType(void);
    +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +
    + +
    +

    toDocument ()

    + +
    +exml::Document * toDocument(void);
    +
    +
    + +
    +

    toDocument ()

    + +
    +const exml::Document * toDocument(void);
    +
    +
    + +
    +
    + + diff --git a/exml__Element.html b/exml__Element.html new file mode 100644 index 0000000..1d7ef3b --- /dev/null +++ b/exml__Element.html @@ -0,0 +1,275 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::Element ()

    + +
    +Element(void);
    +
    +Constructor +

    + +
    +

    exml::Element ()

    + +
    +Element(const std::string & _value);
    +
    +Constructor +
    +
    + +
    +

    exml::Element ()

    + +
    +Element(const std::u32string & _value);
    +
    +
    + +
    +

    exml::~Element ()

    + +
    +~Element(void);
    +
    +Destructor +

    + +
    +

    size ()

    + +
    +size_t size(void);
    +
    +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 ()

    + +
    +const enum nodeType getType(int32_t _id);
    +
    +
    + +
    +

    getNode ()

    + +
    +Node * getNode(int32_t _id);
    +
    +get the Node pointer of the element id. +
    +
    + +
    +

    getNode ()

    + +
    +const Node * getNode(int32_t _id);
    +
    +
    + +
    +

    getElement ()

    + +
    +Element * getElement(int32_t _id);
    +
    +get the element casted in Element (if the node is not an element return NULL). +
    +
    + +
    +

    getElement ()

    + +
    +const Element * getElement(int32_t _id);
    +
    +
    + +
    +

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

    getNamed ()

    + +
    +Element * getNamed(const std::u32string & _name);
    +
    +
    + +
    +

    getNamed ()

    + +
    +const Element * getNamed(const std::u32string & _name);
    +
    +
    + +
    +

    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 +
    +
    + +
    +

    getType ()

    + +
    +enum nodeType getType(void);
    +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            int32_t & _pos,
+            bool _caseSensitive,
+            exml::filePos & _filePos,
+            exml::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +
    + +
    +

    toElement ()

    + +
    +exml::Element * toElement(void);
    +
    +
    + +
    +

    toElement ()

    + +
    +const exml::Element * toElement(void);
    +
    +
    + +
    +

    clear ()

    + +
    +void clear(void);
    +
    +
    + +
    +

    subParse ()

    + +
    +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 new file mode 100644 index 0000000..a830c98 --- /dev/null +++ b/exml__Node.html @@ -0,0 +1,434 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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 +
    +
    + +
    +

    exml::Node ()

    + +
    +Node(const std::u32string & _value);
    +
    +
    + +
    +

    exml::~Node ()

    + +
    +~Node(void);
    +
    +destructor +

    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            int32_t & _pos,
+            bool _caseSensitive,
+            exml::filePos & _filePos,
+            exml::Document & _doc);
    +
    +parse the Current node [pure VIRUAL] +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +generate a string with the tree of the xml +
    +
    + +
    +

    getPos ()

    + +
    +const exml::filePos & getPos(void);
    +
    +get the current position where the element is in the file +

    + +
    +

    setValue ()

    + +
    +void setValue(std::string _value);
    +
    +set the value of the node. +
    +
    + +
    +

    setValue ()

    + +
    +void setValue(std::u32string _value);
    +
    +
    + +
    +

    getValue ()

    + +
    +const std::string & getValue(void);
    +
    +get the current element Value. +
    +
    + +
    +

    getUValue ()

    + +
    +std::u32string getUValue(void);
    +
    +
    + +
    +

    getType ()

    + +
    +enum nodeType getType(void);
    +
    +get the node type. +
    +
    + +
    +

    toDocument ()

    + +
    +exml::Document * toDocument(void);
    +
    +Cast the element in a Document if it is possible. +
    +
    + +
    +

    toDocument ()

    + +
    +const exml::Document * toDocument(void);
    +
    +
    + +
    +

    toAttribute ()

    + +
    +exml::Attribute * toAttribute(void);
    +
    +Cast the element in a Attribute if it is possible. +
    +
    + +
    +

    toAttribute ()

    + +
    +const exml::Attribute * toAttribute(void);
    +
    +
    + +
    +

    toComment ()

    + +
    +exml::Comment * toComment(void);
    +
    +Cast the element in a Comment if it is possible. +
    +
    + +
    +

    toComment ()

    + +
    +const exml::Comment * toComment(void);
    +
    +
    + +
    +

    toDeclaration ()

    + +
    +exml::Declaration * toDeclaration(void);
    +
    +Cast the element in a Declaration if it is possible. +
    +
    + +
    +

    toDeclaration ()

    + +
    +const exml::Declaration * toDeclaration(void);
    +
    +
    + +
    +

    toElement ()

    + +
    +exml::Element * toElement(void);
    +
    +Cast the element in a Element if it is possible. +
    +
    + +
    +

    toElement ()

    + +
    +const exml::Element * toElement(void);
    +
    +
    + +
    +

    toText ()

    + +
    +exml::Text * toText(void);
    +
    +Cast the element in a Text if it is possible. +
    +
    + +
    +

    toText ()

    + +
    +const exml::Text * toText(void);
    +
    +
    + +
    +

    isDocument ()

    + +
    +bool isDocument(void);
    +
    +check if the node is a exml::Document +
    +
    + +
    +

    isAttribute ()

    + +
    +bool isAttribute(void);
    +
    +check if the node is a exml::Attribute +
    +
    + +
    +

    isComment ()

    + +
    +bool isComment(void);
    +
    +check if the node is a exml::Comment +
    +
    + +
    +

    isDeclaration ()

    + +
    +bool isDeclaration(void);
    +
    +check if the node is a exml::Declaration +
    +
    + +
    +

    isElement ()

    + +
    +bool isElement(void);
    +
    +check if the node is a exml::Element +
    +
    + +
    +

    isText ()

    + +
    +bool isText(void);
    +
    +check if the node is a exml::Text +
    +
    + +
    +

    clear ()

    + +
    +void clear(void);
    +
    +clear the Node +

    + +
    +

    addIndent ()

    + +
    +void addIndent(std::string & _data,
+               int32_t _indent);
    +
    +add indentation of the string input. +
    +
    + +
    +

    drawElementParsed ()

    + +
    +void drawElementParsed(char32_t _val,
+                       const exml::filePos & _filePos);
    +
    +Display the cuurent element that is curently parse. +
    +
    + +
    +

    checkAvaillable ()

    + +
    +bool checkAvaillable(char32_t _val,
+                     bool _firstChar);
    +
    +check if an element or attribute is availlable (not : !"#$%&'()*+,/;<=>?
    +
    + +
    +

    countWhiteChar ()

    + +
    +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) +
    +
    + +
    +
    + + diff --git a/exml__Text.html b/exml__Text.html new file mode 100644 index 0000000..fe8af5c --- /dev/null +++ b/exml__Text.html @@ -0,0 +1,134 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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 +
    +
    + +
    +

    exml::~Text ()

    + +
    +~Text(void);
    +
    +Destructor +

    + +
    +

    countLines ()

    + +
    +int32_t countLines(void);
    +
    +count the number of line in the current text +
    +
    + +
    +

    getType ()

    + +
    +enum nodeType getType(void);
    +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            int32_t & _pos,
+            bool _caseSensitive,
+            exml::filePos & _filePos,
+            exml::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

    + +
    +bool iGenerate(std::string & _data,
+               int32_t _indent);
    +
    +
    + +
    +

    toText ()

    + +
    +exml::Text * toText(void);
    +
    +
    + +
    +

    toText ()

    + +
    +const exml::Text * toText(void);
    +
    +
    + +
    +
    + + diff --git a/exml__TextCDATA.html b/exml__TextCDATA.html new file mode 100644 index 0000000..269bc0c --- /dev/null +++ b/exml__TextCDATA.html @@ -0,0 +1,77 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::TextCDATA ()

    + +
    +TextCDATA(void);
    +
    +Constructor +

    + +
    +

    exml::~TextCDATA ()

    + +
    +~TextCDATA(void);
    +
    +Destructor +

    + +
    +

    iParse ()

    + +
    +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 new file mode 100644 index 0000000..b6abd1d --- /dev/null +++ b/exml__filePos.html @@ -0,0 +1,155 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    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:

    +

    exml::filePos ()

    + +
    +filePos(void);
    +
    +
    + +
    +

    exml::filePos ()

    + +
    +filePos(int32_t _line,
+        int32_t _col);
    +
    +
    + +
    +

    exml::~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);
    +
    +
    + +
    +

    getLine ()

    + +
    +int32_t getLine(void);
    +
    +
    + +
    +
    + + diff --git a/exml__nodeType.html b/exml__nodeType.html new file mode 100644 index 0000000..1b1309f --- /dev/null +++ b/exml__nodeType.html @@ -0,0 +1,38 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    Enum: exml::nodeType

    +
    +Value :
    + +
    + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..d89cc69 --- /dev/null +++ b/index.html @@ -0,0 +1,33 @@ + + + + + exml Library + + + +
    +
    +

    exml Library

    +
  • exml
    • + +
  • nodeType
    • + +
    +
    +
    +

    exml


    TODO : Main page ...

    + +