Bitcoin ABC  0.28.12
P2P Digital Currency
univalue.h
Go to the documentation of this file.
1 // Copyright 2014 BitPay Inc.
2 // Copyright 2015 Bitcoin Core Developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or https://opensource.org/licenses/mit-license.php.
5 
6 #ifndef __UNIVALUE_H__
7 #define __UNIVALUE_H__
8 
9 #include <stdint.h>
10 #include <string.h>
11 
12 #include <string>
13 #include <vector>
14 #include <map>
15 #include <cassert>
16 
17 #include <utility> // std::pair
18 
19 namespace {
20  struct UniValueStreamWriter;
21 }
22 
23 class UniValue {
24  friend struct ::UniValueStreamWriter;
25 
26 public:
27  enum VType { VNULL, VOBJ, VARR, VSTR, VNUM, VBOOL, };
28 
29  UniValue() : typ(VNULL) {}
30  UniValue(UniValue::VType type, const std::string& value = std::string()) : typ(type), val(value) {}
31  UniValue(uint64_t val_) {
32  setInt(val_);
33  }
34  UniValue(int64_t val_) {
35  setInt(val_);
36  }
37  UniValue(bool val_) {
38  setBool(val_);
39  }
40  UniValue(int val_) {
41  setInt(val_);
42  }
43  UniValue(double val_) {
44  setFloat(val_);
45  }
46  UniValue(const std::string& val_) {
47  setStr(val_);
48  }
49  UniValue(const char *val_) {
50  std::string s(val_);
51  setStr(s);
52  }
53 
54  void clear();
55  void reserve(size_t n) {
56  if (typ == VOBJ || typ == VARR) {
57  if (typ == VOBJ)
58  keys.reserve(n);
59  values.reserve(n);
60  } else if (typ != VNULL) {
61  val.reserve(n);
62  }
63  }
64 
65  bool setNull();
66  bool setBool(bool val);
67  bool setNumStr(const std::string& val);
68  bool setInt(uint64_t val);
69  bool setInt(int64_t val);
70  bool setInt(int val_) { return setInt((int64_t)val_); }
71  bool setFloat(double val);
72  bool setStr(const std::string& val);
73  bool setArray();
74  bool setObject();
75 
76  enum VType getType() const { return typ; }
77  const std::string& getValStr() const { return val; }
78  bool empty() const { return (values.size() == 0); }
79 
80  size_t size() const { return values.size(); }
81 
82  bool getBool() const { return isTrue(); }
83  void getObjMap(std::map<std::string,UniValue>& kv) const;
84  bool checkObject(const std::map<std::string,UniValue::VType>& memberTypes) const;
85  const UniValue& operator[](const std::string& key) const;
86  const UniValue& operator[](size_t index) const;
87  bool exists(const std::string& key) const { size_t i; return findKey(key, i); }
88 
89  bool isNull() const { return (typ == VNULL); }
90  bool isTrue() const { return (typ == VBOOL) && (val == "1"); }
91  bool isFalse() const { return (typ == VBOOL) && (val != "1"); }
92  bool isBool() const { return (typ == VBOOL); }
93  bool isStr() const { return (typ == VSTR); }
94  bool isNum() const { return (typ == VNUM); }
95  bool isArray() const { return (typ == VARR); }
96  bool isObject() const { return (typ == VOBJ); }
97 
98  bool push_back(const UniValue& val);
99  bool push_backV(const std::vector<UniValue>& vec);
100 
101  void __pushKV(const std::string& key, const UniValue& val);
102  bool pushKV(const std::string& key, const UniValue& val);
103  bool pushKVs(const UniValue& obj);
104 
105  std::string write(unsigned int prettyIndent = 0,
106  unsigned int indentLevel = 0) const;
107 
108  bool read(const char *raw, size_t len);
109  bool read(const char *raw) { return read(raw, strlen(raw)); }
110  bool read(const std::string& rawStr) {
111  return read(rawStr.data(), rawStr.size());
112  }
113 
114 private:
116  std::string val; // numbers are stored as C++ strings
117  std::vector<std::string> keys;
118  std::vector<UniValue> values;
119 
120  bool findKey(const std::string& key, size_t& retIdx) const;
121 
122 public:
123  // Strict type-specific getters, these throw std::runtime_error if the
124  // value is of unexpected type
125  const std::vector<std::string>& getKeys() const;
126  const std::vector<UniValue>& getValues() const;
127  bool get_bool() const;
128  const std::string& get_str() const;
129  int get_int() const;
130  int64_t get_int64() const;
131  double get_real() const;
132  const UniValue& get_obj() const;
133  const UniValue& get_array() const;
134 
135  enum VType type() const { return getType(); }
136 
137  bool push_back(std::pair<std::string,UniValue> pear) {
138  return pushKV(pear.first, pear.second);
139  }
140 
141  const UniValue& find_value(std::string_view key) const;
142 };
143 
144 //
145 // The following were added for compatibility with json_spirit.
146 // Most duplicate other methods, and should be removed.
147 //
148 static inline std::pair<std::string,UniValue> Pair(const char *cKey, const char *cVal)
149 {
150  std::string key(cKey);
151  UniValue uVal(cVal);
152  return std::make_pair(key, uVal);
153 }
154 
155 static inline std::pair<std::string,UniValue> Pair(const char *cKey, std::string strVal)
156 {
157  std::string key(cKey);
158  UniValue uVal(strVal);
159  return std::make_pair(key, uVal);
160 }
161 
162 static inline std::pair<std::string,UniValue> Pair(const char *cKey, uint64_t u64Val)
163 {
164  std::string key(cKey);
165  UniValue uVal(u64Val);
166  return std::make_pair(key, uVal);
167 }
168 
169 static inline std::pair<std::string,UniValue> Pair(const char *cKey, int64_t i64Val)
170 {
171  std::string key(cKey);
172  UniValue uVal(i64Val);
173  return std::make_pair(key, uVal);
174 }
175 
176 static inline std::pair<std::string,UniValue> Pair(const char *cKey, bool iVal)
177 {
178  std::string key(cKey);
179  UniValue uVal(iVal);
180  return std::make_pair(key, uVal);
181 }
182 
183 static inline std::pair<std::string,UniValue> Pair(const char *cKey, int iVal)
184 {
185  std::string key(cKey);
186  UniValue uVal(iVal);
187  return std::make_pair(key, uVal);
188 }
189 
190 static inline std::pair<std::string,UniValue> Pair(const char *cKey, double dVal)
191 {
192  std::string key(cKey);
193  UniValue uVal(dVal);
194  return std::make_pair(key, uVal);
195 }
196 
197 static inline std::pair<std::string,UniValue> Pair(const char *cKey, const UniValue& uVal)
198 {
199  std::string key(cKey);
200  return std::make_pair(key, uVal);
201 }
202 
203 static inline std::pair<std::string,UniValue> Pair(std::string key, const UniValue& uVal)
204 {
205  return std::make_pair(key, uVal);
206 }
207 
209  JTOK_ERR = -1,
210  JTOK_NONE = 0, // eof
222 };
223 
224 extern enum jtokentype getJsonToken(std::string& tokenVal,
225  unsigned int& consumed, const char *raw, const char *end);
226 extern const char *uvTypeName(UniValue::VType t);
227 
228 static inline bool jsonTokenIsValue(enum jtokentype jtt)
229 {
230  switch (jtt) {
231  case JTOK_KW_NULL:
232  case JTOK_KW_TRUE:
233  case JTOK_KW_FALSE:
234  case JTOK_NUMBER:
235  case JTOK_STRING:
236  return true;
237 
238  default:
239  return false;
240  }
241 
242  // not reached
243 }
244 
245 static inline bool json_isspace(int ch)
246 {
247  switch (ch) {
248  case 0x20:
249  case 0x09:
250  case 0x0a:
251  case 0x0d:
252  return true;
253 
254  default:
255  return false;
256  }
257 
258  // not reached
259 }
260 
261 extern const UniValue NullUniValue;
262 
263 #endif // __UNIVALUE_H__
bool setArray()
Definition: univalue.cpp:94
UniValue::VType typ
Definition: univalue.h:115
bool setNumStr(const std::string &val)
Definition: univalue.cpp:46
UniValue(UniValue::VType type, const std::string &value=std::string())
Definition: univalue.h:30
const std::string & get_str() const
bool setObject()
Definition: univalue.cpp:101
bool checkObject(const std::map< std::string, UniValue::VType > &memberTypes) const
Definition: univalue.cpp:179
UniValue(uint64_t val_)
Definition: univalue.h:31
UniValue(bool val_)
Definition: univalue.h:37
bool isTrue() const
Definition: univalue.h:90
bool isArray() const
Definition: univalue.h:95
const UniValue & find_value(std::string_view key) const
Definition: univalue.cpp:234
UniValue(const char *val_)
Definition: univalue.h:49
enum VType getType() const
Definition: univalue.h:76
bool push_back(std::pair< std::string, UniValue > pear)
Definition: univalue.h:137
@ VNULL
Definition: univalue.h:27
@ VOBJ
Definition: univalue.h:27
@ VSTR
Definition: univalue.h:27
@ VARR
Definition: univalue.h:27
@ VNUM
Definition: univalue.h:27
@ VBOOL
Definition: univalue.h:27
int64_t get_int64() const
std::string write(unsigned int prettyIndent=0, unsigned int indentLevel=0) const
bool isNull() const
Definition: univalue.h:89
bool setInt(int val_)
Definition: univalue.h:70
void clear()
Definition: univalue.cpp:15
const UniValue & get_obj() const
const std::string & getValStr() const
Definition: univalue.h:77
void __pushKV(const std::string &key, const UniValue &val)
Definition: univalue.cpp:127
size_t size() const
Definition: univalue.h:80
enum VType type() const
Definition: univalue.h:135
const std::vector< UniValue > & getValues() const
const std::vector< std::string > & getKeys() const
bool empty() const
Definition: univalue.h:78
UniValue(double val_)
Definition: univalue.h:43
std::vector< UniValue > values
Definition: univalue.h:118
bool read(const char *raw)
Definition: univalue.h:109
std::vector< std::string > keys
Definition: univalue.h:117
bool findKey(const std::string &key, size_t &retIdx) const
Definition: univalue.cpp:167
UniValue(int64_t val_)
Definition: univalue.h:34
bool pushKVs(const UniValue &obj)
Definition: univalue.cpp:146
bool isStr() const
Definition: univalue.h:93
bool push_back(const UniValue &val)
Definition: univalue.cpp:108
bool setNull()
Definition: univalue.cpp:23
bool isBool() const
Definition: univalue.h:92
const UniValue & operator[](const std::string &key) const
Definition: univalue.cpp:197
bool setInt(uint64_t val)
Definition: univalue.cpp:57
UniValue()
Definition: univalue.h:29
const UniValue & get_array() const
bool exists(const std::string &key) const
Definition: univalue.h:87
std::string val
Definition: univalue.h:116
void reserve(size_t n)
Definition: univalue.h:55
bool pushKV(const std::string &key, const UniValue &val)
Definition: univalue.cpp:133
bool setStr(const std::string &val)
Definition: univalue.cpp:86
bool isNum() const
Definition: univalue.h:94
bool getBool() const
Definition: univalue.h:82
bool push_backV(const std::vector< UniValue > &vec)
Definition: univalue.cpp:117
void getObjMap(std::map< std::string, UniValue > &kv) const
Definition: univalue.cpp:157
UniValue(int val_)
Definition: univalue.h:40
double get_real() const
bool isFalse() const
Definition: univalue.h:91
bool get_bool() const
bool read(const std::string &rawStr)
Definition: univalue.h:110
UniValue(const std::string &val_)
Definition: univalue.h:46
bool read(const char *raw, size_t len)
bool isObject() const
Definition: univalue.h:96
int get_int() const
bool setFloat(double val)
Definition: univalue.cpp:75
bool setBool(bool val)
Definition: univalue.cpp:29
enum jtokentype getJsonToken(std::string &tokenVal, unsigned int &consumed, const char *raw, const char *end)
static bool jsonTokenIsValue(enum jtokentype jtt)
Definition: univalue.h:228
static bool json_isspace(int ch)
Definition: univalue.h:245
jtokentype
Definition: univalue.h:208
@ JTOK_OBJ_CLOSE
Definition: univalue.h:212
@ JTOK_STRING
Definition: univalue.h:221
@ JTOK_COLON
Definition: univalue.h:215
@ JTOK_OBJ_OPEN
Definition: univalue.h:211
@ JTOK_NUMBER
Definition: univalue.h:220
@ JTOK_KW_NULL
Definition: univalue.h:217
@ JTOK_COMMA
Definition: univalue.h:216
@ JTOK_ARR_CLOSE
Definition: univalue.h:214
@ JTOK_KW_TRUE
Definition: univalue.h:218
@ JTOK_ARR_OPEN
Definition: univalue.h:213
@ JTOK_KW_FALSE
Definition: univalue.h:219
@ JTOK_ERR
Definition: univalue.h:209
@ JTOK_NONE
Definition: univalue.h:210
static std::pair< std::string, UniValue > Pair(const char *cKey, const char *cVal)
Definition: univalue.h:148
const char * uvTypeName(UniValue::VType t)
Definition: univalue.cpp:219
const UniValue NullUniValue
Definition: univalue.cpp:13