OpenCPN Partial API docs
Loading...
Searching...
No Matches
jsonval.h
1
2// Name: jsonval.h
3// Purpose: the wxJSONValue class: it holds a JSON value
4// Author: Luciano Cattani
5// Created: 2007/09/15
6// RCS-ID: $Id: jsonval.h,v 1.4 2008/01/10 21:27:15 luccat Exp $
7// Copyright: (c) 2007 Luciano Cattani
8// Licence: wxWidgets licence
10
11#if !defined(_WX_JSONVAL_H)
12#define _WX_JSONVAL_H
13
14// For compilers that support precompilation, includes "wx/wx.h".
15#include "wx/wxprec.h"
16
17#ifdef __BORLANDC__
18#pragma hdrstop
19#endif
20
21// for all others, include the necessary headers (this file is usually all you
22// need because it includes almost all "standard" wxWidgets headers)
23#ifndef WX_PRECOMP
24#include <wx/object.h>
25#include <wx/hashmap.h>
26#include <wx/dynarray.h>
27#include <wx/arrstr.h>
28#endif
29
30#include "json_defs.h"
31
32// forward declarations
33class WXDLLIMPEXP_JSON wxJSONReader;
34class WXDLLIMPEXP_JSON wxJSONRefData;
35
36#if defined(wxJSON_USE_STL)
37// if compiling on MinGW we use the STL-style declaration of wxWidget's
38// container classes
39class WXDLLIMPEXP_JSON wxJSONValue;
40WX_DECLARE_OBJARRAY(wxJSONValue, wxJSONInternalArray);
41WX_DECLARE_STRING_HASH_MAP(wxJSONValue, wxJSONInternalMap);
42#else
43class WXDLLIMPEXP_JSON wxJSONInternalMap;
44class WXDLLIMPEXP_JSON wxJSONInternalArray;
45#endif
46
48enum wxJSONType {
49 wxJSONTYPE_INVALID = 0,
50 wxJSONTYPE_NULL,
51 wxJSONTYPE_INT,
52 wxJSONTYPE_UINT,
53 wxJSONTYPE_DOUBLE,
54 wxJSONTYPE_STRING,
55 wxJSONTYPE_CSTRING,
56 wxJSONTYPE_BOOL,
57 wxJSONTYPE_ARRAY,
58 wxJSONTYPE_OBJECT,
59 wxJSONTYPE_LONG,
60 wxJSONTYPE_INT64,
61 wxJSONTYPE_ULONG,
62 wxJSONTYPE_UINT64,
63 wxJSONTYPE_SHORT,
64 wxJSONTYPE_USHORT,
65 wxJSONTYPE_MEMORYBUFF
66};
67
68// the comment position: every value only has one comment position
69// althrough comments may be splitted into several lines
70enum {
71 wxJSONVALUE_COMMENT_DEFAULT = 0,
72 wxJSONVALUE_COMMENT_BEFORE,
73 wxJSONVALUE_COMMENT_AFTER,
74 wxJSONVALUE_COMMENT_INLINE,
75};
76
77/***********************************************************************
78
79 class wxJSONValue
80
81***********************************************************************/
82
83// class WXDLLIMPEXP_JSON wxJSONValue : public wxObject
84class WXDLLIMPEXP_JSON wxJSONValue {
85 friend class wxJSONReader;
86
87public:
88 // ctors and dtor
89 wxJSONValue();
90 wxJSONValue(wxJSONType type);
91 wxJSONValue(int i);
92 wxJSONValue(unsigned int i);
93 wxJSONValue(short i);
94 wxJSONValue(unsigned short i);
95 wxJSONValue(long int i);
96 wxJSONValue(unsigned long int i);
97#if defined(wxJSON_64BIT_INT)
98 wxJSONValue(wxInt64 i);
99 wxJSONValue(wxUint64 ui);
100#endif
101 wxJSONValue(bool b);
102 wxJSONValue(double d);
103 wxJSONValue(const wxChar* str); // assume static ASCIIZ strings
104 wxJSONValue(const wxString& str);
105 wxJSONValue(const wxMemoryBuffer& buff);
106 wxJSONValue(const void* buff, size_t len);
107 wxJSONValue(const wxJSONValue& other);
108 virtual ~wxJSONValue();
109
110 // functions for retrieving the value type
111 wxJSONType GetType() const;
112 bool IsValid() const;
113 bool IsNull() const;
114 bool IsInt() const;
115 bool IsUInt() const;
116 bool IsShort() const;
117 bool IsUShort() const;
118 bool IsLong() const;
119 bool IsULong() const;
120#if defined(wxJSON_64BIT_INT)
121 bool IsInt32() const;
122 bool IsInt64() const;
123 bool IsUInt32() const;
124 bool IsUInt64() const;
125#endif
126 bool IsBool() const;
127 bool IsDouble() const;
128 bool IsString() const;
129 bool IsCString() const;
130 bool IsArray() const;
131 bool IsObject() const;
132 bool IsMemoryBuff() const;
133
134 // function for retireving the value as ...
135 int AsInt() const;
136 unsigned int AsUInt() const;
137 short AsShort() const;
138 unsigned short AsUShort() const;
139 long int AsLong() const;
140 unsigned long AsULong() const;
141 bool AsInt(int& i) const;
142 bool AsUInt(unsigned int& ui) const;
143 bool AsShort(short int& s) const;
144 bool AsUShort(unsigned short& us) const;
145 bool AsLong(long int& l) const;
146 bool AsULong(unsigned long& ul) const;
147#if defined(wxJSON_64BIT_INT)
148 wxInt32 AsInt32() const;
149 wxUint32 AsUInt32() const;
150 wxInt64 AsInt64() const;
151 wxUint64 AsUInt64() const;
152 bool AsInt32(wxInt32& i32) const;
153 bool AsUInt32(wxUint32& ui32) const;
154 bool AsInt64(wxInt64& i64) const;
155 bool AsUInt64(wxUint64& ui64) const;
156#endif
157 bool AsBool() const;
158 double AsDouble() const;
159 wxString AsString() const;
160 const wxChar* AsCString() const;
161 bool AsBool(bool& b) const;
162 bool AsDouble(double& d) const;
163 bool AsString(wxString& str) const;
164 bool AsCString(wxChar* ch) const;
165 wxMemoryBuffer AsMemoryBuff() const;
166 bool AsMemoryBuff(wxMemoryBuffer& buff) const;
167
168 const wxJSONInternalMap* AsMap() const;
169 const wxJSONInternalArray* AsArray() const;
170
171 // get members names, size and other info
172 bool HasMember(unsigned index) const;
173 bool HasMember(const wxString& key) const;
174 int Size() const;
175 wxArrayString GetMemberNames() const;
176
177 // appending items, resizing and deleting items
178 wxJSONValue& Append(const wxJSONValue& value);
179 wxJSONValue& Append(bool b);
180 wxJSONValue& Append(int i);
181 wxJSONValue& Append(unsigned int ui);
182 wxJSONValue& Append(short int i);
183 wxJSONValue& Append(unsigned short int ui);
184 wxJSONValue& Append(long int l);
185 wxJSONValue& Append(unsigned long int ul);
186#if defined(wxJSON_64BIT_INT)
187 wxJSONValue& Append(wxInt64 i);
188 wxJSONValue& Append(wxUint64 ui);
189#endif
190 wxJSONValue& Append(double d);
191 wxJSONValue& Append(const wxChar* str);
192 wxJSONValue& Append(const wxString& str);
193 wxJSONValue& Append(const wxMemoryBuffer& buff);
194 wxJSONValue& Append(const void* buff, size_t len);
195 bool Remove(int index);
196 bool Remove(const wxString& key);
197 void Clear();
198 bool Cat(const wxChar* str);
199 bool Cat(const wxString& str);
200 bool Cat(const wxMemoryBuffer& buff);
201
202 // retrieve an item
203 wxJSONValue& Item(unsigned index);
204 wxJSONValue& Item(const wxString& key);
205 wxJSONValue ItemAt(unsigned index) const;
206 wxJSONValue ItemAt(const wxString& key) const;
207
208 wxJSONValue& operator[](unsigned index);
209 wxJSONValue& operator[](const wxString& key);
210
211 wxJSONValue& operator=(int i);
212 wxJSONValue& operator=(unsigned int ui);
213 wxJSONValue& operator=(short int i);
214 wxJSONValue& operator=(unsigned short int ui);
215 wxJSONValue& operator=(long int l);
216 wxJSONValue& operator=(unsigned long int ul);
217#if defined(wxJSON_64BIT_INT)
218 wxJSONValue& operator=(wxInt64 i);
219 wxJSONValue& operator=(wxUint64 ui);
220#endif
221 wxJSONValue& operator=(bool b);
222 wxJSONValue& operator=(double d);
223 wxJSONValue& operator=(const wxChar* str);
224 wxJSONValue& operator=(const wxString& str);
225 wxJSONValue& operator=(const wxMemoryBuffer& buff);
226 // wxJSONValue& operator = ( const void* buff, size_t len ); cannot be
227 // declared
228 wxJSONValue& operator=(const wxJSONValue& value);
229
230 // get the value or a default value
231 wxJSONValue Get(const wxString& key, const wxJSONValue& defaultValue) const;
232
233 // comparison function
234 bool IsSameAs(const wxJSONValue& other) const;
235
236 // comment-related functions
237 int AddComment(const wxString& str,
238 int position = wxJSONVALUE_COMMENT_DEFAULT);
239 int AddComment(const wxArrayString& comments,
240 int position = wxJSONVALUE_COMMENT_DEFAULT);
241 wxString GetComment(int idx = -1) const;
242 int GetCommentPos() const;
243 int GetCommentCount() const;
244 void ClearComments();
245 const wxArrayString& GetCommentArray() const;
246
247 // debugging functions
248 wxString GetInfo() const;
249 wxString Dump(bool deep = false, int mode = 0) const;
250
251 // misc functions
252 wxJSONRefData* GetRefData() const;
253 wxJSONRefData* SetType(wxJSONType type);
254 int GetLineNo() const;
255 void SetLineNo(int num);
256
257 // public static functions: mainly used for debugging
258 static wxString TypeToString(wxJSONType type);
259 static wxString MemoryBuffToString(const wxMemoryBuffer& buff,
260 size_t len = -1);
261 static wxString MemoryBuffToString(const void* buff, size_t len,
262 size_t actualLen = -1);
263 static int CompareMemoryBuff(const wxMemoryBuffer& buff1,
264 const wxMemoryBuffer& buff2);
265 static int CompareMemoryBuff(const wxMemoryBuffer& buff1, const void* buff2);
266 static wxMemoryBuffer ArrayToMemoryBuff(const wxJSONValue& value);
267
268protected:
269 wxJSONValue* Find(unsigned index) const;
270 wxJSONValue* Find(const wxString& key) const;
271 void DeepCopy(const wxJSONValue& other);
272
273 wxJSONRefData* Init(wxJSONType type);
274 wxJSONRefData* COW();
275
276 // overidden from wxObject
277 virtual wxJSONRefData* CloneRefData(const wxJSONRefData* data) const;
278 virtual wxJSONRefData* CreateRefData() const;
279
280 void SetRefData(wxJSONRefData* data);
281 void Ref(const wxJSONValue& clone);
282 void UnRef();
283 void UnShare();
284 void AllocExclusive();
285
287 wxJSONRefData* m_refData;
288
289 // used for debugging purposes: only in debug builds.
290#if defined(WXJSON_USE_VALUE_COUNTER)
291 int m_progr;
292 static int sm_progr;
293#endif
294};
295
296#if !defined(wxJSON_USE_STL)
297// if using wxWidget's implementation of container classes we declare
298// the OBJARRAY are HASH_MAP _after_ the wxJSONValue is fully known
299WX_DECLARE_OBJARRAY(wxJSONValue, wxJSONInternalArray);
300WX_DECLARE_STRING_HASH_MAP(wxJSONValue, wxJSONInternalMap);
301#endif
302
303/***********************************************************************
304
305 class wxJSONRefData
306
307***********************************************************************/
308
310
320union wxJSONValueHolder {
321 int m_valInt;
322 unsigned int m_valUInt;
323 short int m_valShort;
324 unsigned short m_valUShort;
325 long int m_valLong;
326 unsigned long m_valULong;
327 double m_valDouble;
328 const wxChar* m_valCString;
329 bool m_valBool;
330#if defined(wxJSON_64BIT_INT)
331 wxInt64 m_valInt64;
332 wxUint64 m_valUInt64;
333#endif
334};
335
336//
337// access to the (unsigned) integer value is done through
338// the VAL_INT macro which expands to the 'long' integer
339// data member of the 'long long' integer if 64-bits integer
340// support is enabled
341#if defined(wxJSON_64BIT_INT)
342#define VAL_INT m_valInt64
343#define VAL_UINT m_valUInt64
344#else
345#define VAL_INT m_valLong
346#define VAL_UINT m_valULong
347#endif
348
349// class WXDLLIMPEXP_JSON wxJSONRefData : public wxObjectRefData
350class WXDLLIMPEXP_JSON wxJSONRefData {
351 // friend class wxJSONReader;
352 friend class wxJSONValue;
353 friend class wxJSONWriter;
354
355public:
356 wxJSONRefData();
357 virtual ~wxJSONRefData();
358
359 int GetRefCount() const;
360
361 // there is no need to define copy ctor
362
364 int m_refCount;
365
367 wxJSONType m_type;
368
370
376 wxJSONValueHolder m_value;
377
379 wxString m_valString;
380
382 wxJSONInternalArray m_valArray;
383
385 wxJSONInternalMap m_valMap;
386
388
394 int m_commentPos;
395
397 wxArrayString m_comments;
398
400
407 int m_lineNo;
408
410
415 wxMemoryBuffer* m_memBuff;
416
417 // used for debugging purposes: only in debug builds.
418#if defined(WXJSON_USE_VALUE_COUNTER)
419 int m_progr;
420 static int sm_progr;
421#endif
422};
423
424#endif // not defined _WX_JSONVAL_H
wxJSONReader
The JSON parser.
Definition jsonreader.h:50
wxJSONRefData
The reference counted JSON value data (internal use).
Definition jsonval.h:350
wxJSONRefData::m_memBuff
wxMemoryBuffer * m_memBuff
The pointer to the memory buffer object.
Definition jsonval.h:415
wxJSONRefData::m_valMap
wxJSONInternalMap m_valMap
The JSON object value.
Definition jsonval.h:385
wxJSONRefData::m_commentPos
int m_commentPos
The position of the comment line(s), if any.
Definition jsonval.h:394
wxJSONRefData::m_refCount
int m_refCount
the references count
Definition jsonval.h:364
wxJSONRefData::m_valArray
wxJSONInternalArray m_valArray
The JSON array value.
Definition jsonval.h:382
wxJSONRefData::m_type
wxJSONType m_type
The actual type of the value held by this object.
Definition jsonval.h:367
wxJSONRefData::m_lineNo
int m_lineNo
The line number when this value was read.
Definition jsonval.h:407
wxJSONRefData::m_valString
wxString m_valString
The JSON string value.
Definition jsonval.h:379
wxJSONRefData::m_value
wxJSONValueHolder m_value
The JSON value held by this object.
Definition jsonval.h:376
wxJSONRefData::m_comments
wxArrayString m_comments
The array of comment lines; may be empty.
Definition jsonval.h:397
wxJSONValue
The JSON value class implementation.
Definition jsonval.h:84
wxJSONValue::m_refData
wxJSONRefData * m_refData
the referenced data
Definition jsonval.h:287
wxJSONWriter
The JSON document writer.
Definition jsonwriter.h:50
wxJSONValueHolder
The actual value held by the wxJSONValue class (internal use)
Definition jsonval.h:320