From 162b4b37656ac677f9f8e7e7a4b86cbb54d12111 Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Fri, 6 Dec 2013 16:13:37 +0100 Subject: [PATCH] [DEV] add first exml documentation --- .gitignore | 1 + base.css | 131 ++++++++++++ ejson__Array.html | 364 ++++++++++++++++++++++++++++++++++ ejson__Boolean.html | 147 ++++++++++++++ ejson__Document.html | 208 +++++++++++++++++++ ejson__Null.html | 123 ++++++++++++ ejson__Number.html | 171 ++++++++++++++++ ejson__Object.html | 367 ++++++++++++++++++++++++++++++++++ ejson__String.html | 147 ++++++++++++++ ejson__Value.html | 461 +++++++++++++++++++++++++++++++++++++++++++ ejson__filePos.html | 153 ++++++++++++++ ejson__nodeType.html | 36 ++++ index.html | 31 +++ 13 files changed, 2340 insertions(+) create mode 100644 .gitignore create mode 100644 base.css create mode 100644 ejson__Array.html create mode 100644 ejson__Boolean.html create mode 100644 ejson__Document.html create mode 100644 ejson__Null.html create mode 100644 ejson__Number.html create mode 100644 ejson__Object.html create mode 100644 ejson__String.html create mode 100644 ejson__Value.html create mode 100644 ejson__filePos.html create mode 100644 ejson__nodeType.html create mode 100644 index.html 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/ejson__Array.html b/ejson__Array.html new file mode 100644 index 0000000..8d56815 --- /dev/null +++ b/ejson__Array.html @@ -0,0 +1,364 @@ + + + + + ejson Library + + + +
+
+

ejson Library

+
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::Array

    +
    +

    Synopsis:

    +
    ++                        Array           (void);
    +                       ~Array           (void);
    +  size_t                size            (void);
    +  const ejson::Value *  get             (size_t _id);
    +  ejson::Value *        get             (size_t _id);
    +  ejson::Object *       getObject       (size_t _id);
    +  ejson::String *       getString       (size_t _id);
    +  const std::string &   getStringValue  (size_t _id);
    +  std::string           getStringValue  (size_t _id,
                                              const std::string & _errorValue);
    +  ejson::Array *        getArray        (size_t _id);
    +  ejson::Null *         getNull         (size_t _id);
    +  ejson::Number *       getNumber       (size_t _id);
    +  double                getNumberValue  (size_t _id,
                                              double _errorValue);
    +  ejson::Boolean *      getBoolean      (size_t _id);
    +  bool                  getBooleanValue (size_t _id,
                                              bool _errorValue);
    +  bool                  add             (ejson::Value * _element);
    +  bool                  addString       (const std::string & _value);
    +  bool                  addNull         (void);
    +  bool                  addBoolean      (bool _value);
    +  bool                  addNumber       (double _value);
    +  bool                  iParse          (const std::string & _data,
                                              size_t & _pos,
                                              ejson::filePos & _filePos,
                                              ejson::Document & _doc);
    +  bool                  iGenerate       (std::string & _data,
                                              size_t _indent);
    +  enum nodeType         getType         (void);
    +  ejson::Array *        toArray         (void);
    +  const ejson::Array *  toArray         (void);
    +  void                  clear           (void);
    +  bool                  transfertIn     (ejson::Value * _obj);
    +  ejson::Value *        duplicate       (void);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::Array
+
    +
    +

    Detail:

    +

    ejson::Array ()

    + +
    +Array(void);
    +
    +basic element of a xml structure +

    + +
    +

    ejson::~Array ()

    + +
    +~Array(void);
    +
    +destructor +

    + +
    +

    size ()

    + +
    +size_t size(void);
    +
    +get the number of sub element in the current one +
    +
    + +
    +

    get ()

    + +
    +const ejson::Value * get(size_t _id);
    +
    +get the pointer on an element reference with his ID. +
    +
    + +
    +

    get ()

    + +
    +ejson::Value * get(size_t _id);
    +
    +
    + +
    +

    getObject ()

    + +
    +ejson::Object * getObject(size_t _id);
    +
    +get the pointer on an element reference with his ID (casted in Object if it is an object). +
    +
    + +
    +

    getString ()

    + +
    +ejson::String * getString(size_t _id);
    +
    +get the pointer on an element reference with his ID (casted in String if it is an String). +
    +
    + +
    +

    getStringValue ()

    + +
    +const std::string & getStringValue(size_t _id);
    +
    +get the value of the string element (if not a string return "") +
    +
    + +
    +

    getStringValue ()

    + +
    +std::string getStringValue(size_t _id,
+                           const std::string & _errorValue);
    +
    +get the value of the string element +
    +
    + +
    +

    getArray ()

    + +
    +ejson::Array * getArray(size_t _id);
    +
    +get the pointer on an element reference with his ID (casted in Array if it is an Array). +
    +
    + +
    +

    getNull ()

    + +
    +ejson::Null * getNull(size_t _id);
    +
    +get the pointer on an element reference with his ID (casted in Null if it is an Null). +
    +
    + +
    +

    getNumber ()

    + +
    +ejson::Number * getNumber(size_t _id);
    +
    +get the pointer on an element reference with his ID (casted in Number if it is an Number). +
    +
    + +
    +

    getNumberValue ()

    + +
    +double getNumberValue(size_t _id,
+                      double _errorValue);
    +
    +get the value of the Number element +
    +
    + +
    +

    getBoolean ()

    + +
    +ejson::Boolean * getBoolean(size_t _id);
    +
    +get the pointer on an element reference with his ID (casted in Boolean if it is an Boolean). +
    +
    + +
    +

    getBooleanValue ()

    + +
    +bool getBooleanValue(size_t _id,
+                     bool _errorValue);
    +
    +get the value of the Boolean element +
    +
    + +
    +

    add ()

    + +
    +bool add(ejson::Value * _element);
    +
    +add an element on the array. +
    +
    + +
    +

    addString ()

    + +
    +bool addString(const std::string & _value);
    +
    +add a string element in the Object (automatic creation) +
    +
    + +
    +

    addNull ()

    + +
    +bool addNull(void);
    +
    +add a "null" element in the Object (automatic creation) +
    +
    + +
    +

    addBoolean ()

    + +
    +bool addBoolean(bool _value);
    +
    +add a boolean element in the Object (automatic creation) +
    +
    + +
    +

    addNumber ()

    + +
    +bool addNumber(double _value);
    +
    +add a double element in the Object (automatic creation) +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            size_t & _pos,
+            ejson::filePos & _filePos,
+            ejson::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

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

    getType ()

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

    toArray ()

    + +
    +ejson::Array * toArray(void);
    +
    +
    + +
    +

    toArray ()

    + +
    +const ejson::Array * toArray(void);
    +
    +
    + +
    +

    clear ()

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

    transfertIn ()

    + +
    +bool transfertIn(ejson::Value * _obj);
    +
    +
    + +
    +

    duplicate ()

    + +
    +ejson::Value * duplicate(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__Boolean.html b/ejson__Boolean.html new file mode 100644 index 0000000..4c1fc94 --- /dev/null +++ b/ejson__Boolean.html @@ -0,0 +1,147 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::Boolean

    +
    +

    Synopsis:

    +
    ++                          Boolean      (bool _value);
    +                         ~Boolean      (void);
    +  void                    set          (bool _value);
    +  bool                    get          (void);
    +  bool                    iParse       (const std::string & _data,
                                             size_t & _pos,
                                             ejson::filePos & _filePos,
                                             ejson::Document & _doc);
    +  bool                    iGenerate    (std::string & _data,
                                             size_t _indent);
    +  enum nodeType           getType      (void);
    +  ejson::Boolean *        toBoolean    (void);
    +  const ejson::Boolean *  toBoolean    (void);
    +  bool                    transfertIn  (ejson::Value * _obj);
    +  ejson::Value *          duplicate    (void);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::Boolean
+
    +
    +

    Detail:

    +

    ejson::Boolean ()

    + +
    +Boolean(bool _value);
    +
    +basic element of a xml structure +

    + +
    +

    ejson::~Boolean ()

    + +
    +~Boolean(void);
    +
    +destructor +

    + +
    +

    set ()

    + +
    +void set(bool _value);
    +
    +set the value of the node. +
    +
    + +
    +

    get ()

    + +
    +bool get(void);
    +
    +get the current element Value. +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            size_t & _pos,
+            ejson::filePos & _filePos,
+            ejson::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

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

    getType ()

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

    toBoolean ()

    + +
    +ejson::Boolean * toBoolean(void);
    +
    +
    + +
    +

    toBoolean ()

    + +
    +const ejson::Boolean * toBoolean(void);
    +
    +
    + +
    +

    transfertIn ()

    + +
    +bool transfertIn(ejson::Value * _obj);
    +
    +
    + +
    +

    duplicate ()

    + +
    +ejson::Value * duplicate(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__Document.html b/ejson__Document.html new file mode 100644 index 0000000..697667f --- /dev/null +++ b/ejson__Document.html @@ -0,0 +1,208 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::Document

    +
    +

    Synopsis:

    +
    ++                           Document                     (void);
    +                          ~Document                     (void);
    +  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,
                                                              size_t _pos,
                                                              const ejson::filePos & _filePos,
                                                              const std::string & _comment);
    +  void                     displayError                 (void);
    +  enum nodeType            getType                      (void);
    +  bool                     iParse                       (const std::string & _data,
                                                              size_t & _pos,
                                                              ejson::filePos & _filePos,
                                                              ejson::Document & _doc);
    +  bool                     iGenerate                    (std::string & _data,
                                                              size_t _indent);
    +  ejson::Document *        toDocument                   (void);
    +  const ejson::Document *  toDocument                   (void);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::Object
+        +--> ejson::Document
+
    +
    +

    Detail:

    +

    ejson::Document ()

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

    + +
    +

    ejson::~Document ()

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

    + +
    +

    parse ()

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

    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,
+                 size_t _pos,
+                 const ejson::filePos & _filePos,
+                 const std::string & _comment);
    +
    +
    + +
    +

    displayError ()

    + +
    +void displayError(void);
    +
    +
    + +
    +

    getType ()

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

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            size_t & _pos,
+            ejson::filePos & _filePos,
+            ejson::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

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

    toDocument ()

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

    toDocument ()

    + +
    +const ejson::Document * toDocument(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__Null.html b/ejson__Null.html new file mode 100644 index 0000000..6d58616 --- /dev/null +++ b/ejson__Null.html @@ -0,0 +1,123 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::Null

    +
    +

    Synopsis:

    +
    ++                       Null         (void);
    +                      ~Null         (void);
    +  bool                 iParse       (const std::string & _data,
                                          size_t & _pos,
                                          ejson::filePos & _filePos,
                                          ejson::Document & _doc);
    +  bool                 iGenerate    (std::string & _data,
                                          size_t _indent);
    +  enum nodeType        getType      (void);
    +  ejson::Null *        toNull       (void);
    +  const ejson::Null *  toNull       (void);
    +  bool                 transfertIn  (ejson::Value * _obj);
    +  ejson::Value *       duplicate    (void);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::Null
+
    +
    +

    Detail:

    +

    ejson::Null ()

    + +
    +Null(void);
    +
    +basic element of a xml structure +

    + +
    +

    ejson::~Null ()

    + +
    +~Null(void);
    +
    +destructor +

    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            size_t & _pos,
+            ejson::filePos & _filePos,
+            ejson::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

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

    getType ()

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

    toNull ()

    + +
    +ejson::Null * toNull(void);
    +
    +
    + +
    +

    toNull ()

    + +
    +const ejson::Null * toNull(void);
    +
    +
    + +
    +

    transfertIn ()

    + +
    +bool transfertIn(ejson::Value * _obj);
    +
    +
    + +
    +

    duplicate ()

    + +
    +ejson::Value * duplicate(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__Number.html b/ejson__Number.html new file mode 100644 index 0000000..58d57db --- /dev/null +++ b/ejson__Number.html @@ -0,0 +1,171 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::Number

    +
    +

    Synopsis:

    +
    ++                         Number       (double _value);
    +                        ~Number       (void);
    +  void                   set          (double _value);
    +  double                 get          (void);
    +  int32_t                getInt32     (void);
    +  int64_t                getInt64     (void);
    +  bool                   iParse       (const std::string & _data,
                                            size_t & _pos,
                                            ejson::filePos & _filePos,
                                            ejson::Document & _doc);
    +  bool                   iGenerate    (std::string & _data,
                                            size_t _indent);
    +  enum nodeType          getType      (void);
    +  ejson::Number *        toNumber     (void);
    +  const ejson::Number *  toNumber     (void);
    +  bool                   transfertIn  (ejson::Value * _obj);
    +  ejson::Value *         duplicate    (void);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::Number
+
    +
    +

    Detail:

    +

    ejson::Number ()

    + +
    +Number(double _value);
    +
    +basic element of a xml structure +

    + +
    +

    ejson::~Number ()

    + +
    +~Number(void);
    +
    +destructor +

    + +
    +

    set ()

    + +
    +void set(double _value);
    +
    +set the value of the node. +
    +
    + +
    +

    get ()

    + +
    +double get(void);
    +
    +Get the current element Value. +
    +
    + +
    +

    getInt32 ()

    + +
    +int32_t getInt32(void);
    +
    +Get the current element Value. +
    +
    + +
    +

    getInt64 ()

    + +
    +int64_t getInt64(void);
    +
    +Get the current element Value. +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            size_t & _pos,
+            ejson::filePos & _filePos,
+            ejson::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

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

    getType ()

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

    toNumber ()

    + +
    +ejson::Number * toNumber(void);
    +
    +
    + +
    +

    toNumber ()

    + +
    +const ejson::Number * toNumber(void);
    +
    +
    + +
    +

    transfertIn ()

    + +
    +bool transfertIn(ejson::Value * _obj);
    +
    +
    + +
    +

    duplicate ()

    + +
    +ejson::Value * duplicate(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__Object.html b/ejson__Object.html new file mode 100644 index 0000000..fed5e8a --- /dev/null +++ b/ejson__Object.html @@ -0,0 +1,367 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::Object

    +
    +

    Synopsis:

    +
    ++                         Object          (void);
    +                        ~Object          (void);
    +  bool                   exist           (const std::string & _name);
    +  ejson::Value *         get             (const std::string & _name);
    +  ejson::Object *        getObject       (const std::string & _name);
    +  ejson::Array *         getArray        (const std::string & _name);
    +  ejson::Null *          getNull         (const std::string & _name);
    +  ejson::String *        getString       (const std::string & _name);
    +  const std::string &    getStringValue  (const std::string & _name);
    +  std::string            getStringValue  (const std::string & _name,
                                               const std::string & _errorValue);
    +  ejson::Boolean *       getBoolean      (const std::string & _name);
    +  bool                   getBooleanValue (const std::string & _name,
                                               bool _errorValue);
    +  ejson::Number *        getNumber       (const std::string & _name);
    +  double                 getNumberValue  (const std::string & _name,
                                               double _errorValue);
    +  bool                   add             (const std::string & _name,
                                               ejson::Value * _value);
    +  bool                   addString       (const std::string & _name,
                                               const std::string & _value);
    +  bool                   addNull         (const std::string & _name);
    +  bool                   addBoolean      (const std::string & _name,
                                               bool _value);
    +  bool                   addNumber       (const std::string & _name,
                                               double _value);
    +  bool                   iParse          (const std::string & _data,
                                               size_t & _pos,
                                               ejson::filePos & _filePos,
                                               ejson::Document & _doc);
    +  bool                   iGenerate       (std::string & _data,
                                               size_t _indent);
    +  enum nodeType          getType         (void);
    +  ejson::Object *        toObject        (void);
    +  const ejson::Object *  toObject        (void);
    +  void                   clear           (void);
    +  bool                   transfertIn     (ejson::Value * _obj);
    +  ejson::Value *         duplicate       (void);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::Object
+        +--> ejson::Document
+
    +
    +

    Detail:

    +

    ejson::Object ()

    + +
    +Object(void);
    +
    +basic element of a xml structure +

    + +
    +

    ejson::~Object ()

    + +
    +~Object(void);
    +
    +destructor +

    + +
    +

    exist ()

    + +
    +bool exist(const std::string & _name);
    +
    +check if an element exist. +
    +
    + +
    +

    get ()

    + +
    +ejson::Value * get(const std::string & _name);
    +
    +get the sub element with his name (no cast check) +
    +
    + +
    +

    getObject ()

    + +
    +ejson::Object * getObject(const std::string & _name);
    +
    +get the sub element with his name (Casted as Object if it is possible) +
    +
    + +
    +

    getArray ()

    + +
    +ejson::Array * getArray(const std::string & _name);
    +
    +get the sub element with his name (Casted as Array if it is possible) +
    +
    + +
    +

    getNull ()

    + +
    +ejson::Null * getNull(const std::string & _name);
    +
    +get the sub element with his name (Casted as Null if it is possible) +
    +
    + +
    +

    getString ()

    + +
    +ejson::String * getString(const std::string & _name);
    +
    +get the sub element with his name (Casted as String if it is possible) +
    +
    + +
    +

    getStringValue ()

    + +
    +const std::string & getStringValue(const std::string & _name);
    +
    +get the sub string value of the requested element +
    +
    + +
    +

    getStringValue ()

    + +
    +std::string getStringValue(const std::string & _name,
+                           const std::string & _errorValue);
    +
    +get the sub string value of the requested element (with error return value) +
    +
    + +
    +

    getBoolean ()

    + +
    +ejson::Boolean * getBoolean(const std::string & _name);
    +
    +get the sub element with his name (Casted as Boolean if it is possible) +
    +
    + +
    +

    getBooleanValue ()

    + +
    +bool getBooleanValue(const std::string & _name,
+                     bool _errorValue);
    +
    +get the sub boolean value of the requested element. +
    +
    + +
    +

    getNumber ()

    + +
    +ejson::Number * getNumber(const std::string & _name);
    +
    +get the sub element with his name (Casted as Number if it is possible) +
    +
    + +
    +

    getNumberValue ()

    + +
    +double getNumberValue(const std::string & _name,
+                      double _errorValue);
    +
    +get the sub Number value of the requested element. +
    +
    + +
    +

    add ()

    + +
    +bool add(const std::string & _name,
+         ejson::Value * _value);
    +
    +add an element in the Object +
    +
    + +
    +

    addString ()

    + +
    +bool addString(const std::string & _name,
+               const std::string & _value);
    +
    +add a string element in the Object (automatic creation) +
    +
    + +
    +

    addNull ()

    + +
    +bool addNull(const std::string & _name);
    +
    +add a "null" element in the Object (automatic creation) +
    +
    + +
    +

    addBoolean ()

    + +
    +bool addBoolean(const std::string & _name,
+                bool _value);
    +
    +add a boolean element in the Object (automatic creation) +
    +
    + +
    +

    addNumber ()

    + +
    +bool addNumber(const std::string & _name,
+               double _value);
    +
    +add a double element in the Object (automatic creation) +
    +
    + +
    +

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            size_t & _pos,
+            ejson::filePos & _filePos,
+            ejson::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

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

    getType ()

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

    toObject ()

    + +
    +ejson::Object * toObject(void);
    +
    +
    + +
    +

    toObject ()

    + +
    +const ejson::Object * toObject(void);
    +
    +
    + +
    +

    clear ()

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

    transfertIn ()

    + +
    +bool transfertIn(ejson::Value * _obj);
    +
    +
    + +
    +

    duplicate ()

    + +
    +ejson::Value * duplicate(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__String.html b/ejson__String.html new file mode 100644 index 0000000..9abac56 --- /dev/null +++ b/ejson__String.html @@ -0,0 +1,147 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::String

    +
    +

    Synopsis:

    +
    ++                         String       (const std::string & _value);
    +                        ~String       (void);
    +  void                   set          (const std::string & _value);
    +  const std::string &    get          (void);
    +  bool                   iParse       (const std::string & _data,
                                            size_t & _pos,
                                            ejson::filePos & _filePos,
                                            ejson::Document & _doc);
    +  bool                   iGenerate    (std::string & _data,
                                            size_t _indent);
    +  enum nodeType          getType      (void);
    +  ejson::String *        toString     (void);
    +  const ejson::String *  toString     (void);
    +  bool                   transfertIn  (ejson::Value * _obj);
    +  ejson::Value *         duplicate    (void);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::String
+
    +
    +

    Detail:

    +

    ejson::String ()

    + +
    +String(const std::string & _value);
    +
    +basic element of a xml structure +

    + +
    +

    ejson::~String ()

    + +
    +~String(void);
    +
    +destructor +

    + +
    +

    set ()

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

    get ()

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

    iParse ()

    + +
    +bool iParse(const std::string & _data,
+            size_t & _pos,
+            ejson::filePos & _filePos,
+            ejson::Document & _doc);
    +
    +
    + +
    +

    iGenerate ()

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

    getType ()

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

    toString ()

    + +
    +ejson::String * toString(void);
    +
    +
    + +
    +

    toString ()

    + +
    +const ejson::String * toString(void);
    +
    +
    + +
    +

    transfertIn ()

    + +
    +bool transfertIn(ejson::Value * _obj);
    +
    +
    + +
    +

    duplicate ()

    + +
    +ejson::Value * duplicate(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__Value.html b/ejson__Value.html new file mode 100644 index 0000000..7d0392c --- /dev/null +++ b/ejson__Value.html @@ -0,0 +1,461 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::Value

    +
    +

    Synopsis:

    +
    ++                           Value              (void);
    +                          ~Value              (void);
    +  bool                     iParse             (const std::string & _data,
                                                    size_t & _pos,
                                                    ejson::filePos & _filePos,
                                                    ejson::Document & _doc);
    +  bool                     iGenerate          (std::string & _data,
                                                    size_t _indent);
    +  enum nodeType            getType            (void);
    +  ejson::Value *           toValue            (void);
    +  const ejson::Value *     toValue            (void);
    +  ejson::Document *        toDocument         (void);
    +  const ejson::Document *  toDocument         (void);
    +  ejson::Array *           toArray            (void);
    +  const ejson::Array *     toArray            (void);
    +  ejson::Object *          toObject           (void);
    +  const ejson::Object *    toObject           (void);
    +  ejson::String *          toString           (void);
    +  const ejson::String *    toString           (void);
    +  ejson::Number *          toNumber           (void);
    +  const ejson::Number *    toNumber           (void);
    +  ejson::Boolean *         toBoolean          (void);
    +  const ejson::Boolean *   toBoolean          (void);
    +  ejson::Null *            toNull             (void);
    +  const ejson::Null *      toNull             (void);
    +  bool                     isDocument         (void);
    +  bool                     isArray            (void);
    +  bool                     isObject           (void);
    +  bool                     isString           (void);
    +  bool                     isNumber           (void);
    +  bool                     isBoolean          (void);
    +  bool                     isNull             (void);
    +  void                     clear              (void);
    +  bool                     transfertIn        (ejson::Value * _obj);
    +  ejson::Value *           duplicate          (void);
    #  void                     addIndent          (std::string & _data,
                                                    size_t _indent);
    #  void                     drawElementParsed  (char32_t _val,
                                                    const ejson::filePos & _filePos);
    #  bool                     checkString        (char32_t _val);
    #  bool                     checkNumber        (char32_t _val);
    #  int32_t                  countWhiteChar     (const std::string & _data,
                                                    size_t _pos,
                                                    ejson::filePos & _filePos);
    + + +

    Object Hierarchy:

    +
    +ejson::Value
+    +--> ejson::Boolean
+    +--> ejson::Number
+    +--> ejson::Array
+    +--> ejson::Object
+    +--> ejson::String
+    +--> ejson::Null
+
    +
    +

    Detail:

    +

    ejson::Value ()

    + +
    +Value(void);
    +
    +basic element of a xml structure +

    + +
    +

    ejson::~Value ()

    + +
    +~Value(void);
    +
    +destructor +

    + +
    +

    iParse ()

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

    iGenerate ()

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

    getType ()

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

    toValue ()

    + +
    +ejson::Value * toValue(void);
    +
    +Cast the element in a Value if it is possible. +
    +
    + +
    +

    toValue ()

    + +
    +const ejson::Value * toValue(void);
    +
    +
    + +
    +

    toDocument ()

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

    toDocument ()

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

    toArray ()

    + +
    +ejson::Array * toArray(void);
    +
    +Cast the element in a Array if it is possible. +
    +
    + +
    +

    toArray ()

    + +
    +const ejson::Array * toArray(void);
    +
    +
    + +
    +

    toObject ()

    + +
    +ejson::Object * toObject(void);
    +
    +Cast the element in a Object if it is possible. +
    +
    + +
    +

    toObject ()

    + +
    +const ejson::Object * toObject(void);
    +
    +
    + +
    +

    toString ()

    + +
    +ejson::String * toString(void);
    +
    +Cast the element in a String if it is possible. +
    +
    + +
    +

    toString ()

    + +
    +const ejson::String * toString(void);
    +
    +
    + +
    +

    toNumber ()

    + +
    +ejson::Number * toNumber(void);
    +
    +Cast the element in a Number if it is possible. +
    +
    + +
    +

    toNumber ()

    + +
    +const ejson::Number * toNumber(void);
    +
    +
    + +
    +

    toBoolean ()

    + +
    +ejson::Boolean * toBoolean(void);
    +
    +Cast the element in a Boolean if it is possible. +
    +
    + +
    +

    toBoolean ()

    + +
    +const ejson::Boolean * toBoolean(void);
    +
    +
    + +
    +

    toNull ()

    + +
    +ejson::Null * toNull(void);
    +
    +Cast the element in a Null if it is possible. +
    +
    + +
    +

    toNull ()

    + +
    +const ejson::Null * toNull(void);
    +
    +
    + +
    +

    isDocument ()

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

    isArray ()

    + +
    +bool isArray(void);
    +
    +check if the node is a ejson::Array +
    +
    + +
    +

    isObject ()

    + +
    +bool isObject(void);
    +
    +check if the node is a ejson::Object +
    +
    + +
    +

    isString ()

    + +
    +bool isString(void);
    +
    +check if the node is a ejson::String +
    +
    + +
    +

    isNumber ()

    + +
    +bool isNumber(void);
    +
    +check if the node is a ejson::Number +
    +
    + +
    +

    isBoolean ()

    + +
    +bool isBoolean(void);
    +
    +check if the node is a ejson::Boolean +
    +
    + +
    +

    isNull ()

    + +
    +bool isNull(void);
    +
    +check if the node is a ejson::Null +
    +
    + +
    +

    clear ()

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

    + +
    +

    transfertIn ()

    + +
    +bool transfertIn(ejson::Value * _obj);
    +
    +Tranfert all element in the element set in parameter +
    Notes: all element is remove from the curent element. +
    +
    + +
    +

    duplicate ()

    + +
    +ejson::Value * duplicate(void);
    +
    +Copy the curent node and all the child in the curent one. +
    +
    + +
    +

    addIndent ()

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

    drawElementParsed ()

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

    checkString ()

    + +
    +bool checkString(char32_t _val);
    +
    +check if an name (for object named) (not : !"#$%&'()*+,/;<=>?
    +
    + +
    +

    checkNumber ()

    + +
    +bool checkNumber(char32_t _val);
    +
    +check if an number -+.0123456789e). +
    +
    + +
    +

    countWhiteChar ()

    + +
    +int32_t countWhiteChar(const std::string & _data,
+                       size_t _pos,
+                       ejson::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/ejson__filePos.html b/ejson__filePos.html new file mode 100644 index 0000000..5221700 --- /dev/null +++ b/ejson__filePos.html @@ -0,0 +1,153 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Class: ejson::filePos

    +
    +

    Synopsis:

    +
    ++                   filePos     (void);
    +                   filePos     (size_t _line,
                                     size_t _col);
    +                  ~filePos     (void);
    +  filePos &        operator++  (void);
    +  filePos &        operator--  (void);
    +  const filePos &  operator+=  (const filePos & _obj);
    +  const filePos &  operator+=  (size_t _col);
    +  const filePos &  operator=   (const filePos & _obj);
    +  void             newLine     (void);
    +  bool             check       (char32_t _val);
    +  void             set         (size_t _line,
                                     size_t _col);
    +  void             clear       (void);
    +  int32_t          getCol      (void);
    +  int32_t          getLine     (void);
    + + +

    Detail:

    +

    ejson::filePos ()

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

    ejson::filePos ()

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

    ejson::~filePos ()

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

    operator++ ()

    + +
    +filePos & operator++(void);
    +
    +
    + +
    +

    operator-- ()

    + +
    +filePos & operator--(void);
    +
    +
    + +
    +

    operator+= ()

    + +
    +const filePos & operator+=(const filePos & _obj);
    +
    +
    + +
    +

    operator+= ()

    + +
    +const filePos & operator+=(size_t _col);
    +
    +
    + +
    +

    operator= ()

    + +
    +const filePos & operator=(const filePos & _obj);
    +
    +
    + +
    +

    newLine ()

    + +
    +void newLine(void);
    +
    +
    + +
    +

    check ()

    + +
    +bool check(char32_t _val);
    +
    +
    + +
    +

    set ()

    + +
    +void set(size_t _line,
+         size_t _col);
    +
    +
    + +
    +

    clear ()

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

    getCol ()

    + +
    +int32_t getCol(void);
    +
    +
    + +
    +

    getLine ()

    + +
    +int32_t getLine(void);
    +
    +
    + +
    +
    + + diff --git a/ejson__nodeType.html b/ejson__nodeType.html new file mode 100644 index 0000000..dc2865e --- /dev/null +++ b/ejson__nodeType.html @@ -0,0 +1,36 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    Enum: ejson::nodeType

    +
    +Value :
    + +
    + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..63e597a --- /dev/null +++ b/index.html @@ -0,0 +1,31 @@ + + + + + ejson Library + + + +
    +
    +

    ejson Library

    +
  • ejson
    • + +
  • nodeType
    • + +
    +
    +
    +

    ejson


    TODO : Main page ...

    + +