vpp/vpp-api/json_format.h

   1 /*
   2  *------------------------------------------------------------------
   3  * json_format.h
   4  *
   5  * Copyright (c) 2015 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #ifndef __JSON_FORMAT_H__
  21 #define __JSON_FORMAT_H__
  22
  23 #include <vppinfra/clib.h>
  24 #include <vppinfra/format.h>
  25 #include <netinet/ip.h>
  26
  27 /* JSON value type */
  28 typedef enum
  29 {
  30   VAT_JSON_NONE,
  31   VAT_JSON_OBJECT,
  32   VAT_JSON_ARRAY,
  33   VAT_JSON_STRING,
  34   VAT_JSON_REAL,
  35   VAT_JSON_UINT,
  36   VAT_JSON_INT,
  37   VAT_JSON_IPV4,
  38   VAT_JSON_IPV6,
  39   VAT_JSON_MAX
  40 } vat_json_val_type_t;
  41
  42 typedef struct vat_json_node_s vat_json_node_t;
  43 typedef struct vat_json_pair_s vat_json_pair_t;
  44
  45 /* JSON object structure */
  46 struct vat_json_node_s
  47 {
  48   vat_json_val_type_t type;
  49   union
  50   {
  51     vat_json_pair_t *pairs;
  52     vat_json_node_t *array;
  53     u8 *string;
  54     struct in_addr ip4;
  55     struct in6_addr ip6;
  56     u64 uint;
  57     i64 sint;
  58     f64 real;
  59   };
  60 };
  61
  62 struct vat_json_pair_s
  63 {
  64   const char *name;
  65   vat_json_node_t value;
  66 };
  67
  68 void vat_json_print (FILE * ofp, vat_json_node_t * node);
  69 void vat_json_free (vat_json_node_t * node);
  70
  71 static_always_inline void
  72 vat_json_init_object (vat_json_node_t * json)
  73 {
  74   json->type = VAT_JSON_OBJECT;
  75   json->pairs = NULL;
  76 }
  77
  78 static_always_inline void
  79 vat_json_init_array (vat_json_node_t * json)
  80 {
  81   json->type = VAT_JSON_ARRAY;
  82   json->array = NULL;
  83 }
  84
  85 static_always_inline void
  86 vat_json_set_string (vat_json_node_t * json, u8 * str)
  87 {
  88   json->type = VAT_JSON_STRING;
  89   json->string = str;
  90 }
  91
  92 static_always_inline void
  93 vat_json_set_string_copy (vat_json_node_t * json, const u8 * str)
  94 {
  95   u8 *ns = NULL;
  96   vec_validate (ns, strlen ((const char *) str));
  97   strcpy ((char *) ns, (const char *) str);
  98   vec_add1 (ns, '\0');
  99   vat_json_set_string (json, ns);
 100 }
 101
 102 static_always_inline void
 103 vat_json_set_int (vat_json_node_t * json, i64 num)
 104 {
 105   json->type = VAT_JSON_INT;
 106   json->sint = num;
 107 }
 108
 109 static_always_inline void
 110 vat_json_set_uint (vat_json_node_t * json, u64 num)
 111 {
 112   json->type = VAT_JSON_UINT;
 113   json->uint = num;
 114 }
 115
 116 static_always_inline void
 117 vat_json_set_real (vat_json_node_t * json, f64 real)
 118 {
 119   json->type = VAT_JSON_REAL;
 120   json->real = real;
 121 }
 122
 123 static_always_inline void
 124 vat_json_set_ip4 (vat_json_node_t * json, struct in_addr ip4)
 125 {
 126   json->type = VAT_JSON_IPV4;
 127   json->ip4 = ip4;
 128 }
 129
 130 static_always_inline void
 131 vat_json_set_ip6 (vat_json_node_t * json, struct in6_addr ip6)
 132 {
 133   json->type = VAT_JSON_IPV6;
 134   json->ip6 = ip6;
 135 }
 136
 137 static_always_inline vat_json_node_t *
 138 vat_json_object_add (vat_json_node_t * json, const char *name)
 139 {
 140   ASSERT (VAT_JSON_OBJECT == json->type);
 141   uword pos = vec_len (json->pairs);
 142   vec_validate (json->pairs, pos);
 143   json->pairs[pos].name = name;
 144   return &json->pairs[pos].value;
 145 }
 146
 147 static_always_inline vat_json_node_t *
 148 vat_json_array_add (vat_json_node_t * json)
 149 {
 150   ASSERT (VAT_JSON_ARRAY == json->type);
 151   uword pos = vec_len (json->array);
 152   vec_validate (json->array, pos);
 153   return &json->array[pos];
 154 }
 155
 156 static_always_inline vat_json_node_t *
 157 vat_json_object_add_list (vat_json_node_t * json, const char *name)
 158 {
 159   vat_json_node_t *array_node = vat_json_object_add (json, name);
 160   vat_json_init_array (array_node);
 161   return array_node;
 162 }
 163
 164 static_always_inline void
 165 vat_json_object_add_string_copy (vat_json_node_t * json,
 166                                  const char *name, u8 * str)
 167 {
 168   vat_json_set_string_copy (vat_json_object_add (json, name), str);
 169 }
 170
 171 static_always_inline void
 172 vat_json_object_add_uint (vat_json_node_t * json,
 173                           const char *name, u64 number)
 174 {
 175   vat_json_set_uint (vat_json_object_add (json, name), number);
 176 }
 177
 178 static_always_inline void
 179 vat_json_object_add_int (vat_json_node_t * json, const char *name, i64 number)
 180 {
 181   vat_json_set_int (vat_json_object_add (json, name), number);
 182 }
 183
 184 static_always_inline void
 185 vat_json_object_add_real (vat_json_node_t * json, const char *name, f64 real)
 186 {
 187   vat_json_set_real (vat_json_object_add (json, name), real);
 188 }
 189
 190 static_always_inline void
 191 vat_json_object_add_ip4 (vat_json_node_t * json,
 192                          const char *name, struct in_addr ip4)
 193 {
 194   vat_json_set_ip4 (vat_json_object_add (json, name), ip4);
 195 }
 196
 197 static_always_inline void
 198 vat_json_object_add_ip6 (vat_json_node_t * json,
 199                          const char *name, struct in6_addr ip6)
 200 {
 201   vat_json_set_ip6 (vat_json_object_add (json, name), ip6);
 202 }
 203
 204 static_always_inline void
 205 vat_json_array_add_int (vat_json_node_t * json, i64 number)
 206 {
 207   vat_json_set_int (vat_json_array_add (json), number);
 208 }
 209
 210 static_always_inline void
 211 vat_json_array_add_uint (vat_json_node_t * json, u64 number)
 212 {
 213   vat_json_set_uint (vat_json_array_add (json), number);
 214 }
 215
 216 static_always_inline void
 217 vat_json_object_add_bytes (vat_json_node_t * json,
 218                            const char *name, u8 * array, uword size)
 219 {
 220   ASSERT (VAT_JSON_OBJECT == json->type);
 221   vat_json_node_t *json_array = vat_json_object_add (json, name);
 222   vat_json_init_array (json_array);
 223   int i;
 224   for (i = 0; i < size; i++)
 225     {
 226       vat_json_array_add_uint (json_array, array[i]);
 227     }
 228 }
 229
 230 static_always_inline vat_json_node_t *
 231 vat_json_object_get_element (vat_json_node_t * json, const char *name)
 232 {
 233   int i = 0;
 234
 235   ASSERT (VAT_JSON_OBJECT == json->type);
 236   for (i = 0; i < vec_len (json->pairs); i++)
 237     {
 238       if (0 == strcmp (json->pairs[i].name, name))
 239         {
 240           return &json->pairs[i].value;
 241         }
 242     }
 243   return NULL;
 244 }
 245
 246 #endif /* __JSON_FORMAT_H__ */
 247
 248 /*
 249  * fd.io coding-style-patch-verification: ON
 250  *
 251  * Local Variables:
 252  * eval: (c-set-style "gnu")
 253  * End:
 254  */