lib/json.h

   1 /* json-c wrapper
   2  * Copyright (C) 2015 Cumulus Networks, Inc.
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _QUAGGA_JSON_H
  22 #define _QUAGGA_JSON_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 #include "command.h"
  29 #include "printfrr.h"
  30 #include <json-c/json.h>
  31
  32 /*
  33  * FRR style JSON iteration.
  34  * Usage: JSON_FOREACH(...) { ... }
  35  */
  36 #define JSON_FOREACH(jo, joi, join)                                            \
  37         /* struct json_object *jo; */                                          \
  38         /* struct json_object_iterator joi; */                                 \
  39         /* struct json_object_iterator join; */                                \
  40         for ((joi) = json_object_iter_begin((jo)),                             \
  41             (join) = json_object_iter_end((jo));                               \
  42              json_object_iter_equal(&(joi), &(join)) == 0;                     \
  43              json_object_iter_next(&(joi)))
  44
  45 extern bool use_json(const int argc, struct cmd_token *argv[]);
  46 extern void json_object_string_add(struct json_object *obj, const char *key,
  47                                    const char *s);
  48 extern void json_object_int_add(struct json_object *obj, const char *key,
  49                                 int64_t i);
  50 void json_object_boolean_add(struct json_object *obj, const char *key,
  51                              bool val);
  52
  53 extern void json_object_double_add(struct json_object *obj, const char *key,
  54                                    double i);
  55 extern void json_object_boolean_false_add(struct json_object *obj,
  56                                           const char *key);
  57 extern void json_object_boolean_true_add(struct json_object *obj,
  58                                          const char *key);
  59 extern struct json_object *json_object_lock(struct json_object *obj);
  60 extern void json_object_free(struct json_object *obj);
  61 extern void json_array_string_add(json_object *json, const char *str);
  62
  63 /* printfrr => json helpers */
  64
  65 PRINTFRR(3, 0)
  66 extern void json_object_string_addv(struct json_object *obj, const char *key,
  67                                     const char *fmt, va_list args);
  68 PRINTFRR(3, 4)
  69 static inline void json_object_string_addf(struct json_object *obj,
  70                                            const char *key, const char *fmt,
  71                                            ...)
  72 {
  73         va_list args;
  74
  75         va_start(args, fmt);
  76         json_object_string_addv(obj, key, fmt, args);
  77         va_end(args);
  78 }
  79
  80 PRINTFRR(2, 0)
  81 extern void json_array_string_addv(json_object *json, const char *fmt,
  82                                    va_list args);
  83 PRINTFRR(2, 3)
  84 static inline void json_array_string_addf(struct json_object *obj,
  85                                           const char *fmt, ...)
  86 {
  87         va_list args;
  88
  89         va_start(args, fmt);
  90         json_array_string_addv(obj, fmt, args);
  91         va_end(args);
  92 }
  93
  94 PRINTFRR(1, 0)
  95 extern struct json_object *json_object_new_stringv(const char *fmt,
  96                                                    va_list args);
  97 PRINTFRR(1, 2)
  98 static inline struct json_object *json_object_new_stringf(const char *fmt, ...)
  99 {
 100         struct json_object *ret;
 101         va_list args;
 102
 103         va_start(args, fmt);
 104         ret = json_object_new_stringv(fmt, args);
 105         va_end(args);
 106
 107         return ret;
 108 }
 109
 110 #define JSON_STR "JavaScript Object Notation\n"
 111
 112 /* NOTE: json-c lib has following commit 316da85 which
 113  * handles escape of forward slash.
 114  * This allows prefix  "20.0.14.0\/24":{
 115  * to  "20.0.14.0/24":{ some platforms do not have
 116  * latest copy of json-c where defining below macro.
 117  */
 118
 119 #ifndef JSON_C_TO_STRING_NOSLASHESCAPE
 120
 121 /**
 122   * Don't escape forward slashes.
 123   */
 124 #define JSON_C_TO_STRING_NOSLASHESCAPE (1<<4)
 125 #endif
 126
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif /* _QUAGGA_JSON_H */