1 /* Copyright (c) 2013, Vsevolod Stakhov
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 * * Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 * * Redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution.
12 * THIS SOFTWARE IS PROVIDED ''AS IS'' AND ANY
13 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15 * DISCLAIMED. IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY
16 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
17 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
19 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 #ifndef UCL_INTERNAL_H_
25 #define UCL_INTERNAL_H_
30 /* Help embedded builds */
31 #define HAVE_SYS_TYPES_H
32 #define HAVE_SYS_MMAN_H
33 #define HAVE_SYS_STAT_H
34 #define HAVE_SYS_PARAM_H
45 #define HAVE_STDBOOL_H
53 #ifdef HAVE_SYS_TYPES_H
54 #include <sys/types.h>
57 #ifdef HAVE_SYS_MMAN_H
59 # include <sys/mman.h>
62 #ifdef HAVE_SYS_STAT_H
65 #ifdef HAVE_SYS_PARAM_H
66 #include <sys/param.h>
101 #include <openssl/evp.h>
105 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
109 * @file rcl_internal.h
110 * Internal structures and functions of UCL library
113 #define UCL_MAX_RECURSION 16
114 #define UCL_TRASH_KEY 0
115 #define UCL_TRASH_VALUE 1
117 enum ucl_parser_state {
123 UCL_STATE_AFTER_VALUE,
124 UCL_STATE_ARRAY_VALUE,
127 UCL_STATE_MACRO_NAME,
132 enum ucl_character_type {
133 UCL_CHARACTER_DENIED = (1 << 0),
134 UCL_CHARACTER_KEY = (1 << 1),
135 UCL_CHARACTER_KEY_START = (1 << 2),
136 UCL_CHARACTER_WHITESPACE = (1 << 3),
137 UCL_CHARACTER_WHITESPACE_UNSAFE = (1 << 4),
138 UCL_CHARACTER_VALUE_END = (1 << 5),
139 UCL_CHARACTER_VALUE_STR = (1 << 6),
140 UCL_CHARACTER_VALUE_DIGIT = (1 << 7),
141 UCL_CHARACTER_VALUE_DIGIT_START = (1 << 8),
142 UCL_CHARACTER_ESCAPE = (1 << 9),
143 UCL_CHARACTER_KEY_SEP = (1 << 10),
144 UCL_CHARACTER_JSON_UNSAFE = (1 << 11),
145 UCL_CHARACTER_UCL_UNSAFE = (1 << 12)
151 ucl_macro_handler handler;
152 ucl_context_macro_handler context_handler;
161 struct ucl_stack *next;
166 const unsigned char *begin;
167 const unsigned char *end;
168 const unsigned char *pos;
173 enum ucl_duplicate_strategy strategy;
174 enum ucl_parse_type parse_type;
175 struct ucl_chunk *next;
181 struct ucl_pubkey *next;
185 struct ucl_pubkey *next;
189 struct ucl_variable {
194 struct ucl_variable *prev, *next;
198 enum ucl_parser_state state;
199 enum ucl_parser_state prev_state;
200 unsigned int recursion;
202 unsigned default_priority;
204 ucl_object_t *top_obj;
205 ucl_object_t *cur_obj;
206 ucl_object_t *trash_objs;
207 ucl_object_t *includepaths;
209 struct ucl_macro *macroes;
210 struct ucl_stack *stack;
211 struct ucl_chunk *chunks;
212 struct ucl_pubkey *keys;
213 struct ucl_variable *variables;
214 ucl_variable_handler var_handler;
216 ucl_object_t *comments;
217 ucl_object_t *last_comment;
221 struct ucl_object_userdata {
223 ucl_userdata_dtor dtor;
224 ucl_userdata_emitter emitter;
228 * Unescape json string inplace
231 size_t ucl_unescape_json_string (char *str, size_t len);
234 * Handle include macro
235 * @param data include data
236 * @param len length of data
237 * @param args UCL object representing arguments to the macro
238 * @param ud user data
241 bool ucl_include_handler (const unsigned char *data, size_t len,
242 const ucl_object_t *args, void* ud);
245 * Handle tryinclude macro
246 * @param data include data
247 * @param len length of data
248 * @param args UCL object representing arguments to the macro
249 * @param ud user data
252 bool ucl_try_include_handler (const unsigned char *data, size_t len,
253 const ucl_object_t *args, void* ud);
256 * Handle includes macro
257 * @param data include data
258 * @param len length of data
259 * @param args UCL object representing arguments to the macro
260 * @param ud user data
263 bool ucl_includes_handler (const unsigned char *data, size_t len,
264 const ucl_object_t *args, void* ud);
267 * Handle priority macro
268 * @param data include data
269 * @param len length of data
270 * @param args UCL object representing arguments to the macro
271 * @param ud user data
274 bool ucl_priority_handler (const unsigned char *data, size_t len,
275 const ucl_object_t *args, void* ud);
279 * @param data include data
280 * @param len length of data
281 * @param args UCL object representing arguments to the macro
282 * @param ud user data
285 bool ucl_load_handler (const unsigned char *data, size_t len,
286 const ucl_object_t *args, void* ud);
288 * Handle inherit macro
289 * @param data include data
290 * @param len length of data
291 * @param args UCL object representing arguments to the macro
292 * @param ctx the current context object
293 * @param ud user data
296 bool ucl_inherit_handler (const unsigned char *data, size_t len,
297 const ucl_object_t *args, const ucl_object_t *ctx, void* ud);
299 size_t ucl_strlcpy (char *dst, const char *src, size_t siz);
300 size_t ucl_strlcpy_unsafe (char *dst, const char *src, size_t siz);
301 size_t ucl_strlcpy_tolower (char *dst, const char *src, size_t siz);
303 char *ucl_strnstr (const char *s, const char *find, int len);
304 char *ucl_strncasestr (const char *s, const char *find, int len);
308 ucl_create_err (UT_string **err, const char *fmt, ...)
309 __attribute__ (( format( printf, 2, 3) ));
312 #undef UCL_FATAL_ERRORS
315 ucl_create_err (UT_string **err, const char *fmt, ...)
321 utstring_printf_va (*err, fmt, ap);
325 #ifdef UCL_FATAL_ERRORS
331 * Check whether a given string contains a boolean value
332 * @param obj object to set
333 * @param start start of a string
334 * @param len length of a string
335 * @return true if a string is a boolean value
338 ucl_maybe_parse_boolean (ucl_object_t *obj, const unsigned char *start, size_t len)
340 const char *p = (const char *)start;
341 bool ret = false, val = false;
344 if ((p[0] == 'f' || p[0] == 'F') && strncasecmp (p, "false", 5) == 0) {
350 if ((p[0] == 't' || p[0] == 'T') && strncasecmp (p, "true", 4) == 0) {
356 if ((p[0] == 'y' || p[0] == 'Y') && strncasecmp (p, "yes", 3) == 0) {
360 else if ((p[0] == 'o' || p[0] == 'O') && strncasecmp (p, "off", 3) == 0) {
366 if ((p[0] == 'n' || p[0] == 'N') && strncasecmp (p, "no", 2) == 0) {
370 else if ((p[0] == 'o' || p[0] == 'O') && strncasecmp (p, "on", 2) == 0) {
376 if (ret && obj != NULL) {
377 obj->type = UCL_BOOLEAN;
385 * Check numeric string
386 * @param obj object to set if a string is numeric
387 * @param start start of string
388 * @param end end of string
389 * @param pos position where parsing has stopped
390 * @param allow_double allow parsing of floating point values
391 * @return 0 if string is numeric and error code (EINVAL or ERANGE) in case of conversion error
393 int ucl_maybe_parse_number (ucl_object_t *obj,
394 const char *start, const char *end, const char **pos,
395 bool allow_double, bool number_bytes, bool allow_time);
398 static inline const ucl_object_t *
399 ucl_hash_search_obj (ucl_hash_t* hashlin, ucl_object_t *obj)
401 return (const ucl_object_t *)ucl_hash_search (hashlin, obj->key, obj->keylen);
404 static inline ucl_hash_t * ucl_hash_insert_object (ucl_hash_t *hashlin,
405 const ucl_object_t *obj,
406 bool ignore_case) UCL_WARN_UNUSED_RESULT;
408 static inline ucl_hash_t *
409 ucl_hash_insert_object (ucl_hash_t *hashlin,
410 const ucl_object_t *obj,
413 if (hashlin == NULL) {
414 hashlin = ucl_hash_create (ignore_case);
416 ucl_hash_insert (hashlin, obj, obj->key, obj->keylen);
422 * Get standard emitter context for a specified emit_type
423 * @param emit_type type of emitter
424 * @return context or NULL if input is invalid
426 const struct ucl_emitter_context *
427 ucl_emit_get_standard_context (enum ucl_emitter emit_type);
430 * Serialize string as JSON string
431 * @param str string to emit
432 * @param buf target buffer
434 void ucl_elt_string_write_json (const char *str, size_t size,
435 struct ucl_emitter_context *ctx);
438 * Write multiline string using `EOD` as string terminator
443 void ucl_elt_string_write_multiline (const char *str, size_t size,
444 struct ucl_emitter_context *ctx);
447 * Emit a single object to string
451 unsigned char * ucl_object_emit_single_json (const ucl_object_t *obj);
454 * Check whether a specified string is long and should be likely printed in
459 bool ucl_maybe_long_string (const ucl_object_t *obj);
462 * Print integer to the msgpack output
466 void ucl_emitter_print_int_msgpack (struct ucl_emitter_context *ctx,
469 * Print integer to the msgpack output
473 void ucl_emitter_print_double_msgpack (struct ucl_emitter_context *ctx,
476 * Print double to the msgpack output
480 void ucl_emitter_print_bool_msgpack (struct ucl_emitter_context *ctx,
483 * Print string to the msgpack output
488 void ucl_emitter_print_string_msgpack (struct ucl_emitter_context *ctx,
489 const char *s, size_t len);
492 * Print binary string to the msgpack output
497 void ucl_emitter_print_binary_string_msgpack (struct ucl_emitter_context *ctx,
498 const char *s, size_t len);
501 * Print array preamble for msgpack
505 void ucl_emitter_print_array_msgpack (struct ucl_emitter_context *ctx,
509 * Print object preamble for msgpack
513 void ucl_emitter_print_object_msgpack (struct ucl_emitter_context *ctx,
516 * Print NULL to the msgpack output
519 void ucl_emitter_print_null_msgpack (struct ucl_emitter_context *ctx);
521 * Print object's key if needed to the msgpack output
526 void ucl_emitter_print_key_msgpack (bool print_key,
527 struct ucl_emitter_context *ctx,
528 const ucl_object_t *obj);
531 * Fetch URL into a buffer
532 * @param url url to fetch
533 * @param buf pointer to buffer (must be freed by callee)
534 * @param buflen pointer to buffer length
535 * @param err pointer to error argument
536 * @param must_exist fail if cannot find a url
538 bool ucl_fetch_url (const unsigned char *url,
545 * Fetch a file and save results to the memory buffer
546 * @param filename filename to fetch
547 * @param len length of filename
548 * @param buf target buffer
549 * @param buflen target length
552 bool ucl_fetch_file (const unsigned char *filename,
559 * Add new element to an object using the current merge strategy and priority
564 bool ucl_parser_process_object_element (struct ucl_parser *parser,
568 * Parse msgpack chunk
572 bool ucl_parse_msgpack (struct ucl_parser *parser);
574 bool ucl_parse_csexp (struct ucl_parser *parser);
576 #endif /* UCL_INTERNAL_H_ */