GDAL
cpl_json.h
Go to the documentation of this file.
1 /******************************************************************************
2  * Project: Common Portability Library
3  * Purpose: Function wrapper for libjson-c access.
4  * Author: Dmitry Baryshnikov, dmitry.baryshnikov@nextgis.com
5  *
6  ******************************************************************************
7  * Copyright (c) 2017-2018 NextGIS, <info@nextgis.com>
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be included
17  * in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25  * DEALINGS IN THE SOFTWARE.
26  ****************************************************************************/
27 
28 #ifndef CPL_JSON_H_INCLUDED
29 #define CPL_JSON_H_INCLUDED
30 
31 #include "cpl_progress.h"
32 
33 #include <string>
34 #include <vector>
35 
43 typedef void *JSONObjectH;
44 
46 
47 class CPLJSONArray;
53 class CPL_DLL CPLJSONObject
54 {
55  friend class CPLJSONArray;
56  friend class CPLJSONDocument;
57 public:
61  enum Type {
62  Unknown,
63  Null,
64  Object,
65  Array,
66  Boolean,
67  String,
68  Integer,
69  Long,
70  Double
71  };
72 
76  enum PrettyFormat {
79  Pretty
80  };
81 
82 public:
84  CPLJSONObject();
85  explicit CPLJSONObject(const std::string &osName, const CPLJSONObject &oParent);
86  ~CPLJSONObject();
87  CPLJSONObject(const CPLJSONObject &other);
88  CPLJSONObject &operator=(const CPLJSONObject &other);
89 
90 private:
91  explicit CPLJSONObject(const std::string &osName, JSONObjectH poJsonObject);
94 public:
95  // setters
96  void Add(const std::string &osName, const std::string &osValue);
97  void Add(const std::string &osName, const char *pszValue);
98  void Add(const std::string &osName, double dfValue);
99  void Add(const std::string &osName, int nValue);
100  void Add(const std::string &osName, GInt64 nValue);
101  void Add(const std::string &osName, const CPLJSONArray &oValue);
102  void Add(const std::string &osName, const CPLJSONObject &oValue);
103  void Add(const std::string &osName, bool bValue);
104  void AddNull(const std::string &osName);
105 
106  void Set(const std::string &osName, const std::string &osValue);
107  void Set(const std::string &osName, const char *pszValue);
108  void Set(const std::string &osName, double dfValue);
109  void Set(const std::string &osName, int nValue);
110  void Set(const std::string &osName, GInt64 nValue);
111  void Set(const std::string &osName, bool bValue);
112  void SetNull(const std::string &osName);
113 
115  JSONObjectH GetInternalHandle() const { return m_poJsonObject; }
118  // getters
119  std::string GetString(const std::string &osName, const std::string &osDefault = "") const;
120  double GetDouble(const std::string &osName, double dfDefault = 0.0) const;
121  int GetInteger(const std::string &osName, int nDefault = 0) const;
122  GInt64 GetLong(const std::string &osName, GInt64 nDefault = 0) const;
123  bool GetBool(const std::string &osName, bool bDefault = false) const;
124  std::string ToString(const std::string &osDefault = "") const;
125  double ToDouble(double dfDefault = 0.0) const;
126  int ToInteger(int nDefault = 0) const;
127  GInt64 ToLong(GInt64 nDefault = 0) const;
128  bool ToBool(bool bDefault = false) const;
129  CPLJSONArray ToArray() const;
130  std::string Format(enum PrettyFormat eFormat) const;
131 
132  //
133  void Delete(const std::string &osName);
134  CPLJSONArray GetArray(const std::string &osName) const;
135  CPLJSONObject GetObj(const std::string &osName) const;
136  CPLJSONObject operator[](const std::string &osName) const;
137  enum Type GetType() const;
139  std::string GetName() const { return m_osKey; }
142  std::vector<CPLJSONObject> GetChildren() const;
143  bool IsValid() const;
144  void Deinit();
145 
146 protected:
148  CPLJSONObject GetObjectByPath(const std::string &osPath, std::string &osName) const;
151 private:
152  JSONObjectH m_poJsonObject = nullptr;
153  std::string m_osKey{};
154 };
155 
159 class CPL_DLL CPLJSONArray : public CPLJSONObject
160 {
161  friend class CPLJSONObject;
162  friend class CPLJSONDocument;
163 public:
165  CPLJSONArray();
166  explicit CPLJSONArray(const std::string &osName);
167  explicit CPLJSONArray(const CPLJSONObject &other);
168 
169 private:
170  explicit CPLJSONArray(const std::string &osName, JSONObjectH poJsonObject);
172 public:
173  int Size() const;
174  void Add(const CPLJSONObject &oValue);
175  void Add(const std::string &osValue);
176  void Add(const char* pszValue);
177  void Add(double dfValue);
178  void Add(int nValue);
179  void Add(GInt64 nValue);
180  void Add(bool bValue);
181  CPLJSONObject operator[](int nIndex);
182  const CPLJSONObject operator[](int nIndex) const;
183 };
184 
188 class CPL_DLL CPLJSONDocument
189 {
190 public:
192  CPLJSONDocument();
193  ~CPLJSONDocument();
194  CPLJSONDocument(const CPLJSONDocument &other);
195  CPLJSONDocument& operator=(const CPLJSONDocument &other);
198  bool Save(const std::string &osPath);
199  std::string SaveAsString();
200 
201  CPLJSONObject GetRoot();
202  bool Load(const std::string &osPath);
203  bool LoadMemory(const std::string &osStr);
204  bool LoadMemory(const GByte *pabyData, int nLength = -1);
205  bool LoadChunks(const std::string &osPath, size_t nChunkSize = 16384,
206  GDALProgressFunc pfnProgress = nullptr,
207  void *pProgressArg = nullptr);
208  bool LoadUrl(const std::string &osUrl, char **papszOptions,
209  GDALProgressFunc pfnProgress = nullptr,
210  void *pProgressArg = nullptr);
211 
212 private:
213  JSONObjectH m_poRootJsonObject;
214 };
215 
216 CPL_C_END
217 
218 #endif // CPL_JSON_H_INCLUDED
void Add(const std::string &osName, const std::string &osValue)
Add new key - value pair to json object.
Definition: cpl_json.cpp:435
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
PrettyFormat
Json object format to string options.
Definition: cpl_json.h:76
No extra whitespace or formatting applied.
Definition: cpl_json.h:77
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
Type
Json object types.
Definition: cpl_json.h:61
Minimal whitespace inserted.
Definition: cpl_json.h:78
The CPLJSONArray class holds JSON object from CPLJSONDocument.
Definition: cpl_json.h:53
CPLJSONObject operator[](const std::string &osName) const
Get value by key.
Definition: cpl_json.cpp:774
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
The CPLJSONDocument class Wrapper class around json-c library.
Definition: cpl_json.h:188
GIntBig GInt64
Signed 64 bit integer type.
Definition: cpl_port.h:267
The JSONArray class JSON array from JSONDocument.
Definition: cpl_json.h:159

Generated for GDAL by doxygen 1.8.8.