dali-toolkit/public-api/builder/json-parser.h

   1 #ifndef __DALI_JSON_PARSER_H__
   2 #define __DALI_JSON_PARSER_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.0 (the License);
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //     http://floralicense.org/license/
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an AS IS BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19
  20 #include <string>
  21 #include <vector>
  22 #include <list>
  23 #include <ostream>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/public-api/builder/tree-node.h>
  27 #include <dali/public-api/object/base-handle.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class JsonParser;
  38 }
  39
  40 /*
  41  * Parses JSON
  42  */
  43 class JsonParser : public BaseHandle
  44 {
  45 public:
  46
  47   /*
  48    * Create new parser
  49    * @return JsonParser
  50    */
  51   static JsonParser New();
  52
  53   /*
  54    * Create new parser from the given tree
  55    * This method will deep copy the given tree.
  56    * @return JsonParser
  57    */
  58   static JsonParser New(const TreeNode& tree);
  59
  60   /*
  61    * Create empty handle
  62    */
  63   JsonParser();
  64
  65   /*
  66    * virtual Destructor
  67    */
  68   virtual ~JsonParser();
  69
  70   /**
  71    * Downcast an Object handle to JsonParser if it is a JsonParser.
  72    * @param[in] handle Handle to an object
  73    * @return A handle to a JsonParser or an uninitialized handle
  74    */
  75   static JsonParser DownCast( BaseHandle handle );
  76
  77   /*
  78    * Parse the source and construct a node tree.
  79    * Subsequent calls to this function will merge the trees.
  80    * @param source The json source to parse
  81    * @return zero if parsed okay, otherwise an error.
  82    */
  83   int Parse(const std::string& source);
  84
  85   /*
  86    * Optimize memory usage by packing strings
  87    */
  88   void Pack(void);
  89
  90   /*
  91    * Get the tree root node
  92    */
  93   const TreeNode* GetRoot() const;
  94
  95   /*
  96    * Get the parser error flag
  97    * @return true if there was a parse error
  98    */
  99   bool ParseError() const;
 100
 101   /*
 102    * Get the last error position
 103    * @return The character position of the most recent Parse() error
 104    */
 105   int GetErrorPosition() const;
 106
 107   /*
 108    * Get the last error description
 109    * @return A string description of the error
 110    */
 111   std::string GetErrorDescription() const;
 112
 113   /*
 114    * Get the last error line number
 115    * @return the line number of the most recent Parse() error.
 116    */
 117   int GetErrorLineNumber() const;
 118
 119   /*
 120    * Get the last error line number
 121    * @return the line number of the most recent Parse() error.
 122    */
 123   int GetErrorColumn() const;
 124
 125   /*
 126    * Write to output stream with optional indent
 127    * @param output The stream to write to
 128    * @param indent The indent to use
 129    */
 130   void Write(std::ostream& output, int indent) const;
 131
 132 public: // Not intended for application developers
 133
 134   /**
 135    * This constructor is used by Dali New() methods
 136    * @param [in] parser A pointer to a newly allocated Dali resource
 137    */
 138   explicit DALI_INTERNAL JsonParser(Internal::JsonParser* parser);
 139 };
 140
 141 } // namespace Toolkit
 142
 143 } // namespace Dali
 144
 145
 146 #endif // __DALI_JSON_PARSER_H__