Go to the documentation of this file.
28 #ifndef CPL_JSON_H_INCLUDED
29 #define CPL_JSON_H_INCLUDED
31 #include "cpl_progress.h"
43 typedef void *JSONObjectH;
93 explicit CPLJSONObject(
const std::string &osName, JSONObjectH poJsonObject);
98 void Add(
const std::string &osName,
const std::string &osValue);
99 void Add(
const std::string &osName,
const char *pszValue);
100 void Add(
const std::string &osName,
double dfValue);
101 void Add(
const std::string &osName,
int nValue);
102 void Add(
const std::string &osName,
GInt64 nValue);
103 void Add(
const std::string &osName,
const CPLJSONArray &oValue);
104 void Add(
const std::string &osName,
const CPLJSONObject &oValue);
105 void AddNoSplitName(
const std::string &osName,
const CPLJSONObject &oValue);
106 void Add(
const std::string &osName,
bool bValue);
107 void AddNull(
const std::string &osName);
109 void Set(
const std::string &osName,
const std::string &osValue);
110 void Set(
const std::string &osName,
const char *pszValue);
111 void Set(
const std::string &osName,
double dfValue);
112 void Set(
const std::string &osName,
int nValue);
113 void Set(
const std::string &osName,
GInt64 nValue);
114 void Set(
const std::string &osName,
bool bValue);
115 void SetNull(
const std::string &osName);
118 JSONObjectH GetInternalHandle()
const {
return m_poJsonObject; }
122 std::string GetString(
const std::string &osName,
const std::string &osDefault =
"")
const;
123 double GetDouble(
const std::string &osName,
double dfDefault = 0.0)
const;
124 int GetInteger(
const std::string &osName,
int nDefault = 0)
const;
125 GInt64 GetLong(
const std::string &osName,
GInt64 nDefault = 0)
const;
126 bool GetBool(
const std::string &osName,
bool bDefault =
false)
const;
127 std::string ToString(
const std::string &osDefault =
"")
const;
128 double ToDouble(
double dfDefault = 0.0)
const;
129 int ToInteger(
int nDefault = 0)
const;
131 bool ToBool(
bool bDefault =
false)
const;
133 std::string Format(PrettyFormat eFormat)
const;
136 void Delete(
const std::string &osName);
137 void DeleteNoSplitName(
const std::string &osName);
141 Type GetType()
const;
143 std::string GetName()
const {
return m_osKey; }
146 std::vector<CPLJSONObject> GetChildren()
const;
147 bool IsValid()
const;
152 CPLJSONObject GetObjectByPath(
const std::string &osPath, std::string &osName)
const;
156 JSONObjectH m_poJsonObject =
nullptr;
157 std::string m_osKey{};
174 explicit CPLJSONArray(
const std::string &osName, JSONObjectH poJsonObject);
176 class CPL_DLL ConstIterator
183 ConstIterator(
const CPLJSONArray& oSelf,
bool bStart): m_oSelf(oSelf), m_nIdx(bStart ? 0 : oSelf.
Size()) {}
184 ~ConstIterator() =
default;
185 CPLJSONObject& operator*()
const { m_oObj = m_oSelf[m_nIdx];
return m_oObj; }
186 ConstIterator& operator++() { m_nIdx ++;
return *
this; }
187 bool operator==(
const ConstIterator& it)
const {
return m_nIdx == it.m_nIdx; }
188 bool operator!=(
const ConstIterator& it)
const {
return m_nIdx != it.m_nIdx; }
195 void Add(
const std::string &osValue);
196 void Add(
const char* pszValue);
197 void Add(
double dfValue);
198 void Add(
int nValue);
200 void Add(
bool bValue);
205 ConstIterator
begin()
const {
return ConstIterator(*
this,
true); }
207 ConstIterator
end()
const {
return ConstIterator(*
this,
false); }
225 bool Save(
const std::string &osPath)
const;
226 std::string SaveAsString()
const;
231 bool Load(
const std::string &osPath);
232 bool LoadMemory(
const std::string &osStr);
233 bool LoadMemory(
const GByte *pabyData,
int nLength = -1);
234 bool LoadChunks(
const std::string &osPath,
size_t nChunkSize = 16384,
235 GDALProgressFunc pfnProgress =
nullptr,
236 void *pProgressArg =
nullptr);
237 bool LoadUrl(
const std::string &osUrl,
const char*
const* papszOptions,
238 GDALProgressFunc pfnProgress =
nullptr,
239 void *pProgressArg =
nullptr);
242 mutable JSONObjectH m_poRootJsonObject;
247 #endif // CPL_JSON_H_INCLUDED
The JSONArray class JSON array from JSONDocument.
Definition: cpl_json.h:163
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:203
GIntBig GInt64
Signed 64 bit integer type.
Definition: cpl_port.h:249
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:304
PrettyFormat
Json object format to string options.
Definition: cpl_json.h:76
The CPLJSONArray class holds JSON object from CPLJSONDocument.
Definition: cpl_json.h:53
ConstIterator end() const
Iterator to after last element.
Definition: cpl_json.h:207
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:306
Type
Json object types.
Definition: cpl_json.h:61
int Size() const
Get array size.
Definition: cpl_json.cpp:1319
ConstIterator begin() const
Iterator to first element.
Definition: cpl_json.h:205
The CPLJSONDocument class Wrapper class around json-c library.
Definition: cpl_json.h:213