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;
91 explicit CPLJSONObject(
const std::string &osName, JSONObjectH poJsonObject);
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);
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);
115 JSONObjectH GetInternalHandle()
const {
return m_poJsonObject; }
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;
128 bool ToBool(
bool bDefault =
false)
const;
130 std::string Format(
enum PrettyFormat eFormat)
const;
133 void Delete(
const std::string &osName);
137 enum Type GetType()
const;
139 std::string GetName()
const {
return m_osKey; }
142 std::vector<CPLJSONObject> GetChildren()
const;
143 bool IsValid()
const;
148 CPLJSONObject GetObjectByPath(
const std::string &osPath, std::string &osName)
const;
152 JSONObjectH m_poJsonObject =
nullptr;
153 std::string m_osKey{};
170 explicit CPLJSONArray(
const std::string &osName, JSONObjectH poJsonObject);
175 void Add(
const std::string &osValue);
176 void Add(
const char* pszValue);
177 void Add(
double dfValue);
178 void Add(
int nValue);
180 void Add(
bool bValue);
198 bool Save(
const std::string &osPath);
199 std::string SaveAsString();
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);
213 JSONObjectH m_poRootJsonObject;
218 #endif // CPL_JSON_H_INCLUDED
bool ToBool(bool bDefault=false) const
Definition: cpl_json.cpp:966
The JSONArray class JSON array from JSONDocument.
Definition: cpl_json.h:160
bool LoadChunks(const std::string &osPath, size_t nChunkSize=16384, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Definition: cpl_json.cpp:217
int GetInteger(const std::string &osName, int nDefault=0) const
Definition: cpl_json.cpp:865
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Definition: cpl_string.cpp:836
unsigned char GByte
Definition: cpl_port.h:215
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1690
double ToDouble(double dfDefault=0.0) const
Definition: cpl_json.cpp:849
bool LoadMemory(const std::string &osStr)
Definition: cpl_json.cpp:199
void CPLHTTPDestroyResult(CPLHTTPResult *psResult)
Clean the memory associated with the return value of CPLHTTPFetch()
Definition: cpl_http.cpp:2080
void Add(const CPLJSONObject &oValue)
Definition: cpl_json.cpp:1178
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:439
@ Plain
No extra whitespace or formatting applied.
Definition: cpl_json.h:77
void Deinit()
Definition: cpl_json.cpp:1122
const char * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Definition: cpl_string.cpp:1646
CPLJSONObject operator[](int nIndex)
Definition: cpl_json.cpp:1272
bool Load(const std::string &osPath)
Definition: cpl_json.cpp:143
CPLJSONArray ToArray() const
Definition: cpl_json.cpp:980
GIntBig GInt64
Definition: cpl_port.h:267
@ Spaced
Minimal whitespace inserted.
Definition: cpl_json.h:78
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1804
#define CPLE_NoWriteAccess
Definition: cpl_error.h:113
std::string GetString(const std::string &osName, const std::string &osDefault="") const
Definition: cpl_json.cpp:800
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:1472
GInt64 ToLong(GInt64 nDefault=0) const
Definition: cpl_json.cpp:907
std::string ToString(const std::string &osDefault="") const
Definition: cpl_json.cpp:814
CPLHTTPResult * CPLHTTPFetchEx(const char *pszURL, CSLConstList papszOptions, GDALProgressFunc pfnProgress, void *pProgressArg, CPLHTTPFetchWriteFunc pfnWrite, void *pWriteArg)
Definition: cpl_http.cpp:664
void Set(const std::string &osName, const std::string &osValue)
Definition: cpl_json.cpp:629
@ Pretty
Formatted output.
Definition: cpl_json.h:79
#define CPL_C_START
Definition: cpl_port.h:337
PrettyFormat
Definition: cpl_json.h:76
std::string Format(enum PrettyFormat eFormat) const
Definition: cpl_json.cpp:995
The CPLJSONArray class holds JSON object from CPLJSONDocument.
Definition: cpl_json.h:54
Definition: cpl_http.h:66
std::string SaveAsString()
Definition: cpl_json.cpp:107
#define CPL_C_END
Definition: cpl_port.h:339
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:737
void * CPLMalloc(size_t)
Definition: cpl_conv.cpp:168
Type
Definition: cpl_json.h:61
bool GetBool(const std::string &osName, bool bDefault=false) const
Definition: cpl_json.cpp:923
int ToInteger(int nDefault=0) const
Definition: cpl_json.cpp:878
CPLJSONArray GetArray(const std::string &osName) const
Definition: cpl_json.cpp:721
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:977
void Add(const std::string &osName, const std::string &osValue)
Definition: cpl_json.cpp:431
int Size() const
Definition: cpl_json.cpp:1165
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Definition: cpl_error.cpp:308
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:140
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:827
GInt64 GetLong(const std::string &osName, GInt64 nDefault=0) const
Definition: cpl_json.cpp:894
#define CPLE_NotSupported
Definition: cpl_error.h:109
CPLJSONObject GetObj(const std::string &osName) const
Definition: cpl_json.cpp:747
CPLJSONObject GetRoot()
Definition: cpl_json.cpp:119
char * pszErrBuf
Definition: cpl_http.h:74
CPLJSONObject operator[](const std::string &osName) const
Definition: cpl_json.cpp:770
int nStatus
Definition: cpl_http.h:68
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:194
The CPLJSONDocument class Wrapper class around json-c library.
Definition: cpl_json.h:189
std::vector< CPLJSONObject > GetChildren() const
Get json object children.
Definition: cpl_json.cpp:939
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:997
bool LoadUrl(const std::string &osUrl, char **papszOptions, GDALProgressFunc pfnProgress=nullptr, void *pProgressArg=nullptr)
Definition: cpl_json.cpp:329
bool Save(const std::string &osPath)
Definition: cpl_json.cpp:82
enum Type GetType() const
Definition: cpl_json.cpp:1081
void Delete(const std::string &osName)
Definition: cpl_json.cpp:781
void SetNull(const std::string &osName)
Definition: cpl_json.cpp:708
bool IsValid() const
Definition: cpl_json.cpp:1111
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:2044
#define CPLE_FileIO
Definition: cpl_error.h:103
void AddNull(const std::string &osName)
Definition: cpl_json.cpp:609
#define CPLFree
Definition: cpl_conv.h:81
FILE VSILFILE
Definition: cpl_vsi.h:156
double GetDouble(const std::string &osName, double dfDefault=0.0) const
Definition: cpl_json.cpp:836
#define CPLE_AppDefined
Definition: cpl_error.h:99
unsigned int GUInt32
Definition: cpl_port.h:207
Generated for GDAL by
1.8.20.