jsonval.h

// Name:        jsonval.h
// Purpose:     the wxJSONValue class: it holds a JSON value
// Author:      Luciano Cattani
// Created:     2007/09/15
// Copyright:   (c) 2007 Luciano Cattani
// Licence:     wxWidgets licence
 
#ifndef WX_JSONVAL_H
#define WX_JSONVAL_H
 
// For compilers that support precompilation, includes "wx/wx.h".
#include <wx/wxprec.h>
 
// for all others, include the necessary headers (this file is usually all you
// need because it includes almost all "standard" wxWidgets headers)
#ifndef WX_PRECOMP
#include <wx/object.h>
#include <wx/hashmap.h>
#include <wx/dynarray.h>
#include <wx/arrstr.h>
#endif
 
#include "json_defs.h"
 
// forward declarations
class WXDLLIMPEXP_JSON wxJSONReader;
class WXDLLIMPEXP_JSON wxJSONRefData;
 
#if defined(wxJSON_USE_STL)
// if compiling on MinGW we use the STL-style declaration of wxWidget's
// container classes
class WXDLLIMPEXP_JSON wxJSONValue;
WX_DECLARE_OBJARRAY(wxJSONValue, wxJSONInternalArray);
WX_DECLARE_STRING_HASH_MAP(wxJSONValue, wxJSONInternalMap);
#else
class WXDLLIMPEXP_JSON wxJSONInternalMap;
class WXDLLIMPEXP_JSON wxJSONInternalArray;
#endif

enum wxJSONType {
  wxJSONTYPE_INVALID = 0, 
  wxJSONTYPE_NULL,        
  wxJSONTYPE_INT,         
  wxJSONTYPE_UINT,        
  wxJSONTYPE_DOUBLE,      
  wxJSONTYPE_STRING,      
  wxJSONTYPE_CSTRING,     
  wxJSONTYPE_BOOL,        
  wxJSONTYPE_ARRAY,       
  wxJSONTYPE_OBJECT,      
  wxJSONTYPE_LONG,        
  wxJSONTYPE_INT64,       
  wxJSONTYPE_ULONG,     
  wxJSONTYPE_UINT64,    
  wxJSONTYPE_SHORT,     
  wxJSONTYPE_USHORT,    
  wxJSONTYPE_MEMORYBUFF 
};
 
// the comment position: every value only has one comment position
// althrough comments may be splitted into several lines
enum {
  wxJSONVALUE_COMMENT_DEFAULT = 0,
  wxJSONVALUE_COMMENT_BEFORE,
  wxJSONVALUE_COMMENT_AFTER,
  wxJSONVALUE_COMMENT_INLINE,
};
 
/***********************************************************************
 
            class wxJSONValue
 
***********************************************************************/
 
// class WXDLLIMPEXP_JSON wxJSONValue : public wxObject
class WXDLLIMPEXP_JSON wxJSONValue {
  friend class wxJSONReader;
 
public:
  // ctors and dtor
  wxJSONValue();
  wxJSONValue(wxJSONType type);
  wxJSONValue(int i);
  wxJSONValue(unsigned int i);
  wxJSONValue(short i);
  wxJSONValue(unsigned short i);
  wxJSONValue(long int i);
  wxJSONValue(unsigned long int i);
#if defined(wxJSON_64BIT_INT)
  wxJSONValue(wxInt64 i);
  wxJSONValue(wxUint64 ui);
#endif
  wxJSONValue(bool b);
  wxJSONValue(double d);
  wxJSONValue(const wxChar* str);  // assume static ASCIIZ strings
  wxJSONValue(const wxString& str);
  wxJSONValue(const wxMemoryBuffer& buff);
  wxJSONValue(const void* buff, size_t len);
  wxJSONValue(const wxJSONValue& other);
  virtual ~wxJSONValue();
 
  // functions for retrieving the value type
  wxJSONType GetType() const;
  bool IsValid() const;
  bool IsNull() const;
  bool IsInt() const;
  bool IsUInt() const;
  bool IsShort() const;
  bool IsUShort() const;
  bool IsLong() const;
  bool IsULong() const;
#if defined(wxJSON_64BIT_INT)
  bool IsInt32() const;
  bool IsInt64() const;
  bool IsUInt32() const;
  bool IsUInt64() const;
#endif
  bool IsBool() const;
  bool IsDouble() const;
  bool IsString() const;
  bool IsCString() const;
  bool IsArray() const;
  bool IsObject() const;
  bool IsMemoryBuff() const;
 
  // function for retireving the value as ...
  int AsInt() const;
  unsigned int AsUInt() const;
  short AsShort() const;
  unsigned short AsUShort() const;
  long int AsLong() const;
  unsigned long AsULong() const;
  bool AsInt(int& i) const;
  bool AsUInt(unsigned int& ui) const;
  bool AsShort(short int& s) const;
  bool AsUShort(unsigned short& us) const;
  bool AsLong(long int& l) const;
  bool AsULong(unsigned long& ul) const;
#if defined(wxJSON_64BIT_INT)
  wxInt32 AsInt32() const;
  wxUint32 AsUInt32() const;
  wxInt64 AsInt64() const;
  wxUint64 AsUInt64() const;
  bool AsInt32(wxInt32& i32) const;
  bool AsUInt32(wxUint32& ui32) const;
  bool AsInt64(wxInt64& i64) const;
  bool AsUInt64(wxUint64& ui64) const;
#endif
  bool AsBool() const;
  double AsDouble() const;
  wxString AsString() const;
  const wxChar* AsCString() const;
  bool AsBool(bool& b) const;
  bool AsDouble(double& d) const;
  bool AsString(wxString& str) const;
  bool AsCString(wxChar* ch) const;
  wxMemoryBuffer AsMemoryBuff() const;
  bool AsMemoryBuff(wxMemoryBuffer& buff) const;
 
  const wxJSONInternalMap* AsMap() const;
  const wxJSONInternalArray* AsArray() const;
 
  // get members names, size and other info
  bool HasMember(unsigned index) const;
  bool HasMember(const wxString& key) const;
  int Size() const;
  wxArrayString GetMemberNames() const;
 
  // appending items, resizing and deleting items
  wxJSONValue& Append(const wxJSONValue& value);
  wxJSONValue& Append(bool b);
  wxJSONValue& Append(int i);
  wxJSONValue& Append(unsigned int ui);
  wxJSONValue& Append(short int i);
  wxJSONValue& Append(unsigned short int ui);
  wxJSONValue& Append(long int l);
  wxJSONValue& Append(unsigned long int ul);
#if defined(wxJSON_64BIT_INT)
  wxJSONValue& Append(wxInt64 i);
  wxJSONValue& Append(wxUint64 ui);
#endif
  wxJSONValue& Append(double d);
  wxJSONValue& Append(const wxChar* str);
  wxJSONValue& Append(const wxString& str);
  wxJSONValue& Append(const wxMemoryBuffer& buff);
  wxJSONValue& Append(const void* buff, size_t len);
  bool Remove(int index);
  bool Remove(const wxString& key);
  void Clear();
  bool Cat(const wxChar* str);
  bool Cat(const wxString& str);
  bool Cat(const wxMemoryBuffer& buff);
 
  // retrieve an item
  wxJSONValue& Item(unsigned index);
  wxJSONValue& Item(const wxString& key);
  wxJSONValue ItemAt(unsigned index) const;
  wxJSONValue ItemAt(const wxString& key) const;
 
  wxJSONValue& operator[](unsigned index);
  wxJSONValue& operator[](const wxString& key);
 
  wxJSONValue& operator=(int i);
  wxJSONValue& operator=(unsigned int ui);
  wxJSONValue& operator=(short int i);
  wxJSONValue& operator=(unsigned short int ui);
  wxJSONValue& operator=(long int l);
  wxJSONValue& operator=(unsigned long int ul);
#if defined(wxJSON_64BIT_INT)
  wxJSONValue& operator=(wxInt64 i);
  wxJSONValue& operator=(wxUint64 ui);
#endif
  wxJSONValue& operator=(bool b);
  wxJSONValue& operator=(double d);
  wxJSONValue& operator=(const wxChar* str);
  wxJSONValue& operator=(const wxString& str);
  wxJSONValue& operator=(const wxMemoryBuffer& buff);
  // wxJSONValue& operator = ( const void* buff, size_t len ); cannot be
  // declared
  wxJSONValue& operator=(const wxJSONValue& value);
 
  // get the value or a default value
  wxJSONValue Get(const wxString& key, const wxJSONValue& defaultValue) const;
 
  // comparison function
  bool IsSameAs(const wxJSONValue& other) const;
 
  // comment-related functions
  int AddComment(const wxString& str,
                 int position = wxJSONVALUE_COMMENT_DEFAULT);
  int AddComment(const wxArrayString& comments,
                 int position = wxJSONVALUE_COMMENT_DEFAULT);
  wxString GetComment(int idx = -1) const;
  int GetCommentPos() const;
  int GetCommentCount() const;
  void ClearComments();
  const wxArrayString& GetCommentArray() const;
 
  // debugging functions
  wxString GetInfo() const;
  wxString Dump(bool deep = false, int mode = 0) const;
 
  // misc functions
  wxJSONRefData* GetRefData() const;
  wxJSONRefData* SetType(wxJSONType type);
  int GetLineNo() const;
  void SetLineNo(int num);
 
  // public static functions: mainly used for debugging
  static wxString TypeToString(wxJSONType type);
  static wxString MemoryBuffToString(const wxMemoryBuffer& buff,
                                     size_t len = -1);
  static wxString MemoryBuffToString(const void* buff, size_t len,
                                     size_t actualLen = -1);
  static int CompareMemoryBuff(const wxMemoryBuffer& buff1,
                               const wxMemoryBuffer& buff2);
  static int CompareMemoryBuff(const wxMemoryBuffer& buff1, const void* buff2);
  static wxMemoryBuffer ArrayToMemoryBuff(const wxJSONValue& value);
 
protected:
  wxJSONValue* Find(unsigned index) const;
  wxJSONValue* Find(const wxString& key) const;
  void DeepCopy(const wxJSONValue& other);
 
  wxJSONRefData* Init(wxJSONType type);
  wxJSONRefData* COW();
 
  // overidden from wxObject
  virtual wxJSONRefData* CloneRefData(const wxJSONRefData* data) const;
  virtual wxJSONRefData* CreateRefData() const;
 
  void SetRefData(wxJSONRefData* data);
  void Ref(const wxJSONValue& clone);
  void UnRef();
  void UnShare();
  void AllocExclusive();

  wxJSONRefData* m_refData;
 
  // used for debugging purposes: only in debug builds.
#if defined(WXJSON_USE_VALUE_COUNTER)
  int m_progr;
  static int sm_progr;
#endif
};
 
#if !defined(wxJSON_USE_STL)
// if using wxWidget's implementation of container classes we declare
// the OBJARRAY are HASH_MAP _after_ the wxJSONValue is fully known
WX_DECLARE_OBJARRAY(wxJSONValue, wxJSONInternalArray);
WX_DECLARE_STRING_HASH_MAP(wxJSONValue, wxJSONInternalMap);
#endif
 
/***********************************************************************
 
            class wxJSONRefData
 
***********************************************************************/


union wxJSONValueHolder {
  int m_valInt;
  unsigned int m_valUInt;
  short int m_valShort;
  unsigned short m_valUShort;
  long int m_valLong;
  unsigned long m_valULong;
  double m_valDouble;
  const wxChar* m_valCString;
  bool m_valBool;
#if defined(wxJSON_64BIT_INT)
  wxInt64 m_valInt64;
  wxUint64 m_valUInt64;
#endif
};
 
//
// access to the (unsigned) integer value is done through
// the VAL_INT macro which expands to the 'long' integer
// data member of the 'long long' integer if 64-bits integer
// support is enabled
#if defined(wxJSON_64BIT_INT)
#define VAL_INT m_valInt64
#define VAL_UINT m_valUInt64
#else
#define VAL_INT m_valLong
#define VAL_UINT m_valULong
#endif
 
// class WXDLLIMPEXP_JSON wxJSONRefData : public wxObjectRefData
class WXDLLIMPEXP_JSON wxJSONRefData {
  // friend class wxJSONReader;
  friend class wxJSONValue;
  friend class wxJSONWriter;
 
public:
  wxJSONRefData();
  virtual ~wxJSONRefData();
 
  int GetRefCount() const;
 
  // there is no need to define copy ctor

  int m_refCount;

  wxJSONType m_type;


  wxJSONValueHolder m_value;

  wxString m_valString;

  wxJSONInternalArray m_valArray;

  wxJSONInternalMap m_valMap;


  int m_commentPos;

  wxArrayString m_comments;


  int m_lineNo;


  wxMemoryBuffer* m_memBuff;
 
  // used for debugging purposes: only in debug builds.
#if defined(WXJSON_USE_VALUE_COUNTER)
  int m_progr;
  static int sm_progr;
#endif
};
 
#endif  // WX_JSONVAL_H