2 This file is part of GNUnet
3 Copyright (C) 2014-2017 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @brief functions to parse JSON snippets
21 * @author Florian Dold
22 * @author Benedikt Mueller
23 * @author Christian Grothoff
26 #include "gnunet_json_lib.h"
30 * Navigate and parse data in a JSON tree. Tries to parse the @a root
31 * to find all of the values given in the @a spec. If one of the
32 * entries in @a spec cannot be found or parsed, the name of the JSON
33 * field is returned in @a error_json_name, and the offset of the
34 * entry in @a spec is returned in @a error_line.
36 * @param root the JSON node to start the navigation at.
37 * @param spec parse specification array
38 * @param[out] error_json_name which JSON field was problematic
39 * @param[out] which index into @a spec did we encounter an error
40 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
43 GNUNET_JSON_parse (const json_t *root,
44 struct GNUNET_JSON_Specification *spec,
45 const char **error_json_name,
46 unsigned int *error_line)
53 for (i=0;NULL != spec[i].parser;i++)
55 if (NULL == spec[i].field)
56 pos = (json_t *) root;
58 pos = json_object_get (root,
62 spec[i].parser (spec[i].cls,
66 if (NULL != error_json_name)
67 *error_json_name = spec[i].field;
68 if (NULL != error_line)
70 GNUNET_JSON_parse_free (spec);
74 return GNUNET_OK; /* all OK! */
79 * Frees all elements allocated during a #GNUNET_JSON_parse()
82 * @param spec specification of the parse operation
85 GNUNET_JSON_parse_free (struct GNUNET_JSON_Specification *spec)
87 for (unsigned int i=0;NULL != spec[i].parser;i++)
88 if (NULL != spec[i].cleaner)
89 spec[i].cleaner (spec[i].cls,
95 * Set an option with a JSON value from the command line.
96 * A pointer to this function should be passed as part of the
97 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
100 * @param ctx command line processing context
101 * @param scls additional closure (will point to the 'json_t *')
102 * @param option name of the option
103 * @param value actual value of the option as a string.
104 * @return #GNUNET_OK if parsing the value worked
107 set_json (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
112 json_t **json = scls;
115 *json = json_loads (value,
116 JSON_REJECT_DUPLICATES,
121 _("Failed to parse JSON in option `%s': %s (%s)\n"),
125 return GNUNET_SYSERR;
132 * Allow user to specify a JSON input value.
134 * @param shortName short name of the option
135 * @param name long name of the option
136 * @param argumentHelp help text for the option argument
137 * @param description long help text for the option
138 * @param[out] val set to the JSON specified at the command line
140 struct GNUNET_GETOPT_CommandLineOption
141 GNUNET_JSON_getopt (char shortName,
143 const char *argumentHelp,
144 const char *description,
147 struct GNUNET_GETOPT_CommandLineOption clo = {
148 .shortName = shortName,
150 .argumentHelp = argumentHelp,
151 .description = description,
152 .require_argument = 1,
153 .processor = &set_json,
154 .scls = (void *) json