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]

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

bool iGenerate(std::string & _data,
               size_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.

---

getType ()

enum nodeType getType(void);

get the node type.

Return: the type of the Node.

---

toValue ()

ejson::Value * toValue(void);

Cast the element in a Value if it is possible.

Return: pointer on the class or NULL.

---

toValue ()

const ejson::Value * toValue(void);

---

toDocument ()

ejson::Document * toDocument(void);

Cast the element in a Document if it is possible.

Return: pointer on the class or NULL.

---

toDocument ()

const ejson::Document * toDocument(void);

---

toArray ()

ejson::Array * toArray(void);

Cast the element in a Array if it is possible.

Return: pointer on the class or NULL.

---

toArray ()

const ejson::Array * toArray(void);

---

toObject ()

ejson::Object * toObject(void);

Cast the element in a Object if it is possible.

Return: pointer on the class or NULL.

---

toObject ()

const ejson::Object * toObject(void);

---

toString ()

ejson::String * toString(void);

Cast the element in a String if it is possible.

Return: pointer on the class or NULL.

---

toString ()

const ejson::String * toString(void);

---

toNumber ()

ejson::Number * toNumber(void);

Cast the element in a Number if it is possible.

Return: pointer on the class or NULL.

---

toNumber ()

const ejson::Number * toNumber(void);

---

toBoolean ()

ejson::Boolean * toBoolean(void);

Cast the element in a Boolean if it is possible.

Return: pointer on the class or NULL.

---

toBoolean ()

const ejson::Boolean * toBoolean(void);

---

toNull ()

ejson::Null * toNull(void);

Cast the element in a Null if it is possible.

Return: pointer on the class or NULL.

---

toNull ()

const ejson::Null * toNull(void);

---

isDocument ()

bool isDocument(void);

check if the node is a ejson::Document

Return: true if the node is a ejson::Document

---

isArray ()

bool isArray(void);

check if the node is a ejson::Array

Return: true if the node is a ejson::Array

---

isObject ()

bool isObject(void);

check if the node is a ejson::Object

Return: true if the node is a ejson::Object

---

isString ()

bool isString(void);

check if the node is a ejson::String

Return: true if the node is a ejson::String

---

isNumber ()

bool isNumber(void);

check if the node is a ejson::Number

Return: true if the node is a ejson::Number

---

isBoolean ()

bool isBoolean(void);

check if the node is a ejson::Boolean

Return: true if the node is a ejson::Boolean

---

isNull ()

bool isNull(void);

check if the node is a ejson::Null

Return: true 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.

Parameter [input] [output]: _obj move all parameter in the selected element
Return: true if transfer is done corectly

---

duplicate ()

ejson::Value * duplicate(void);

Copy the curent node and all the child in the curent one.

Return: NULL in an error occured, the pointer on the element otherwise

---

addIndent ()

void addIndent(std::string & _data,
               size_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.

---

drawElementParsed ()

void drawElementParsed(char32_t _val,
                       const ejson::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.

---

checkString ()

bool checkString(char32_t _val);

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

Parameter [input]: _val Value to check the conformity.

---

checkNumber ()

bool checkNumber(char32_t _val);

check if an number -+.0123456789e).

Parameter [input]: _val Value to check the conformity.

---

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)

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.

---