GDAL

- Main Page
- Related Pages
- Classes
- Files
- Download
- Issue Tracker

- File List
- File Members

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
45 CPL_C_START
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 {
77 Plain,
78 Spaced,
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 CPLJSONObject &operator=(CPLJSONObject &&other);
90
91 private:
92 explicit CPLJSONObject(const std::string &osName, JSONObjectH poJsonObject);
95 public:
96 // setters
97 void Add(const std::string &osName, const std::string &osValue);
98 void Add(const std::string &osName, const char *pszValue);
99 void Add(const std::string &osName, double dfValue);
100 void Add(const std::string &osName, int nValue);
101 void Add(const std::string &osName, GInt64 nValue);
102 void Add(const std::string &osName, const CPLJSONArray &oValue);
103 void Add(const std::string &osName, const CPLJSONObject &oValue);
104 void Add(const std::string &osName, bool bValue);
105 void AddNull(const std::string &osName);
106
107 void Set(const std::string &osName, const std::string &osValue);
108 void Set(const std::string &osName, const char *pszValue);
109 void Set(const std::string &osName, double dfValue);
110 void Set(const std::string &osName, int nValue);
111 void Set(const std::string &osName, GInt64 nValue);
112 void Set(const std::string &osName, bool bValue);
113 void SetNull(const std::string &osName);
114
116 JSONObjectH GetInternalHandle() const { return m_poJsonObject; }
119 // getters
120 std::string GetString(const std::string &osName, const std::string &osDefault = "") const;
121 double GetDouble(const std::string &osName, double dfDefault = 0.0) const;
122 int GetInteger(const std::string &osName, int nDefault = 0) const;
123 GInt64 GetLong(const std::string &osName, GInt64 nDefault = 0) const;
124 bool GetBool(const std::string &osName, bool bDefault = false) const;
125 std::string ToString(const std::string &osDefault = "") const;
126 double ToDouble(double dfDefault = 0.0) const;
127 int ToInteger(int nDefault = 0) const;
128 GInt64 ToLong(GInt64 nDefault = 0) const;
129 bool ToBool(bool bDefault = false) const;
130 CPLJSONArray ToArray() const;
131 std::string Format(enum PrettyFormat eFormat) const;
132
133 //
134 void Delete(const std::string &osName);
135 CPLJSONArray GetArray(const std::string &osName) const;
136 CPLJSONObject GetObj(const std::string &osName) const;
137 CPLJSONObject operator[](const std::string &osName) const;
138 enum Type GetType() const;
140 std::string GetName() const { return m_osKey; }
143 std::vector<CPLJSONObject> GetChildren() const;
144 bool IsValid() const;
145 void Deinit();
146
147 protected:
149 CPLJSONObject GetObjectByPath(const std::string &osPath, std::string &osName) const;
152 private:
153 JSONObjectH m_poJsonObject = nullptr;
154 std::string m_osKey{};
155 };
156
160 class CPL_DLL CPLJSONArray : public CPLJSONObject
161 {
162 friend class CPLJSONObject;
163 friend class CPLJSONDocument;
164 public:
166 CPLJSONArray();
167 explicit CPLJSONArray(const std::string &osName);
168 explicit CPLJSONArray(const CPLJSONObject &other);
169
170 private:
171 explicit CPLJSONArray(const std::string &osName, JSONObjectH poJsonObject);
173 public:
174 int Size() const;
175 void Add(const CPLJSONObject &oValue);
176 void Add(const std::string &osValue);
177 void Add(const char* pszValue);
178 void Add(double dfValue);
179 void Add(int nValue);
180 void Add(GInt64 nValue);
181 void Add(bool bValue);
182 CPLJSONObject operator[](int nIndex);
183 const CPLJSONObject operator[](int nIndex) const;
184 };
185
189 class CPL_DLL CPLJSONDocument
190 {
191 public:
193 CPLJSONDocument();
194 ~CPLJSONDocument();
195 CPLJSONDocument(const CPLJSONDocument &other);
196 CPLJSONDocument& operator=(const CPLJSONDocument &other);
199 bool Save(const std::string &osPath) const;
200 std::string SaveAsString() const;
201
202 CPLJSONObject GetRoot();
203 const CPLJSONObject GetRoot() const;
204 bool Load(const std::string &osPath);
205 bool LoadMemory(const std::string &osStr);
206 bool LoadMemory(const GByte *pabyData, int nLength = -1);
207 bool LoadChunks(const std::string &osPath, size_t nChunkSize = 16384,
208 GDALProgressFunc pfnProgress = nullptr,
209 void *pProgressArg = nullptr);
210 bool LoadUrl(const std::string &osUrl, char **papszOptions,
211 GDALProgressFunc pfnProgress = nullptr,
212 void *pProgressArg = nullptr);
213
214 private:
215 mutable JSONObjectH m_poRootJsonObject;
216 };
217
218 CPL_C_END
219
220 #endif // CPL_JSON_H_INCLUDED
CPLJSONObject::Add
void Add(const std::string &osName, const std::string &osValue)
Add new key - value pair to json object.
Definition: cpl_json.cpp:457
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
CPLJSONObject::PrettyFormat
PrettyFormat
Json object format to string options.
Definition: cpl_json.h:76
CPLJSONObject::Plain
No extra whitespace or formatting applied.
Definition: cpl_json.h:77
GByte
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
CPLJSONObject::Type
Type
Json object types.
Definition: cpl_json.h:61
CPLJSONObject::Spaced
Minimal whitespace inserted.
Definition: cpl_json.h:78
CPLJSONObject
The CPLJSONArray class holds JSON object from CPLJSONDocument.
Definition: cpl_json.h:53
CPLJSONObject::operator[]
CPLJSONObject operator[](const std::string &osName) const
Get value by key.
Definition: cpl_json.cpp:814
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
CPLJSONDocument
The CPLJSONDocument class Wrapper class around json-c library.
Definition: cpl_json.h:189
GInt64
GIntBig GInt64
Signed 64 bit integer type.
Definition: cpl_port.h:267
CPLJSONArray
The JSONArray class JSON array from JSONDocument.
Definition: cpl_json.h:160