class: ejson::Document

Description:

Constructor and Destructor:

+                                Document                    (void );
+ virtual                        ~Document                   (void );

Synopsis:

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

Object Hierarchy:

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

Detail:

+  Document (void );

+ virtual  ~Document (void );

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

Parameter [input]:	_data	Data to parse
Return:		false : An error occured<br/>true : Parsing is OK

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

Parameter [output]:	_data	Data where the xml is stored
Return:		false : An error occured<br/>true : Parsing is OK

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

Parameter [input]:	_file	Filename of the xml (compatible with etk FSNode naming)
Return:		false : An error occured<br/>true : Parsing is OK

+ bool store (const std::string & _file);

Parameter [input]:	_file	Filename of the xml (compatible with etk FSNode naming)
Return:		false : An error occured<br/>true : Parsing is OK

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

+ virtual enum nodeType getType (void ) const;

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

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.

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

Parameter [input] [output]:	_data	string where to add the elements
Parameter [input]:	current	indentation of the file
Return:		false if an error occured.

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

Return:

pointer on the class or NULL.

toDocument

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

Return:

pointer on the class or NULL.