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>
98 #include <openssl/evp.h>
102 #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
106 * @file rcl_internal.h
107 * Internal structures and functions of UCL library
110 #define UCL_MAX_RECURSION 16
111 #define UCL_TRASH_KEY 0
112 #define UCL_TRASH_VALUE 1
114 enum ucl_parser_state {
120 UCL_STATE_AFTER_VALUE,
121 UCL_STATE_ARRAY_VALUE,
124 UCL_STATE_MACRO_NAME,
129 enum ucl_character_type {
130 UCL_CHARACTER_DENIED = 0,
131 UCL_CHARACTER_KEY = 1,
132 UCL_CHARACTER_KEY_START = 1 << 1,
133 UCL_CHARACTER_WHITESPACE = 1 << 2,
134 UCL_CHARACTER_WHITESPACE_UNSAFE = 1 << 3,
135 UCL_CHARACTER_VALUE_END = 1 << 4,
136 UCL_CHARACTER_VALUE_STR = 1 << 5,
137 UCL_CHARACTER_VALUE_DIGIT = 1 << 6,
138 UCL_CHARACTER_VALUE_DIGIT_START = 1 << 7,
139 UCL_CHARACTER_ESCAPE = 1 << 8,
140 UCL_CHARACTER_KEY_SEP = 1 << 9,
141 UCL_CHARACTER_JSON_UNSAFE = 1 << 10,
142 UCL_CHARACTER_UCL_UNSAFE = 1 << 11
148 ucl_macro_handler handler;
149 ucl_context_macro_handler context_handler;
158 struct ucl_stack *next;
163 const unsigned char *begin;
164 const unsigned char *end;
165 const unsigned char *pos;
170 enum ucl_duplicate_strategy strategy;
171 enum ucl_parse_type parse_type;
172 struct ucl_chunk *next;
178 struct ucl_pubkey *next;
182 struct ucl_pubkey *next;
186 struct ucl_variable {
191 struct ucl_variable *prev, *next;
195 enum ucl_parser_state state;
196 enum ucl_parser_state prev_state;
197 unsigned int recursion;
199 unsigned default_priority;
201 ucl_object_t *top_obj;
202 ucl_object_t *cur_obj;
203 ucl_object_t *trash_objs;
204 ucl_object_t *includepaths;
206 struct ucl_macro *macroes;
207 struct ucl_stack *stack;
208 struct ucl_chunk *chunks;
209 struct ucl_pubkey *keys;
210 struct ucl_variable *variables;
211 ucl_variable_handler var_handler;
213 ucl_object_t *comments;
214 ucl_object_t *last_comment;
218 struct ucl_object_userdata {
220 ucl_userdata_dtor dtor;
221 ucl_userdata_emitter emitter;
225 * Unescape json string inplace
228 size_t ucl_unescape_json_string (char *str, size_t len);
231 * Handle include macro
232 * @param data include data
233 * @param len length of data
234 * @param args UCL object representing arguments to the macro
235 * @param ud user data
238 bool ucl_include_handler (const unsigned char *data, size_t len,
239 const ucl_object_t *args, void* ud);
242 * Handle tryinclude macro
243 * @param data include data
244 * @param len length of data
245 * @param args UCL object representing arguments to the macro
246 * @param ud user data
249 bool ucl_try_include_handler (const unsigned char *data, size_t len,
250 const ucl_object_t *args, void* ud);
253 * Handle includes macro
254 * @param data include data
255 * @param len length of data
256 * @param args UCL object representing arguments to the macro
257 * @param ud user data
260 bool ucl_includes_handler (const unsigned char *data, size_t len,
261 const ucl_object_t *args, void* ud);
264 * Handle priority macro
265 * @param data include data
266 * @param len length of data
267 * @param args UCL object representing arguments to the macro
268 * @param ud user data
271 bool ucl_priority_handler (const unsigned char *data, size_t len,
272 const ucl_object_t *args, void* ud);
276 * @param data include data
277 * @param len length of data
278 * @param args UCL object representing arguments to the macro
279 * @param ud user data
282 bool ucl_load_handler (const unsigned char *data, size_t len,
283 const ucl_object_t *args, void* ud);
285 * Handle inherit macro
286 * @param data include data
287 * @param len length of data
288 * @param args UCL object representing arguments to the macro
289 * @param ctx the current context object
290 * @param ud user data
293 bool ucl_inherit_handler (const unsigned char *data, size_t len,
294 const ucl_object_t *args, const ucl_object_t *ctx, void* ud);
296 size_t ucl_strlcpy (char *dst, const char *src, size_t siz);
297 size_t ucl_strlcpy_unsafe (char *dst, const char *src, size_t siz);
298 size_t ucl_strlcpy_tolower (char *dst, const char *src, size_t siz);
300 char *ucl_strnstr (const char *s, const char *find, int len);
301 char *ucl_strncasestr (const char *s, const char *find, int len);
305 ucl_create_err (UT_string **err, const char *fmt, ...)
306 __attribute__ (( format( printf, 2, 3) ));
309 #undef UCL_FATAL_ERRORS
312 ucl_create_err (UT_string **err, const char *fmt, ...)
318 utstring_printf_va (*err, fmt, ap);
322 #ifdef UCL_FATAL_ERRORS
328 * Check whether a given string contains a boolean value
329 * @param obj object to set
330 * @param start start of a string
331 * @param len length of a string
332 * @return true if a string is a boolean value
335 ucl_maybe_parse_boolean (ucl_object_t *obj, const unsigned char *start, size_t len)
337 const char *p = (const char *)start;
338 bool ret = false, val = false;
341 if ((p[0] == 'f' || p[0] == 'F') && strncasecmp (p, "false", 5) == 0) {
347 if ((p[0] == 't' || p[0] == 'T') && strncasecmp (p, "true", 4) == 0) {
353 if ((p[0] == 'y' || p[0] == 'Y') && strncasecmp (p, "yes", 3) == 0) {
357 else if ((p[0] == 'o' || p[0] == 'O') && strncasecmp (p, "off", 3) == 0) {
363 if ((p[0] == 'n' || p[0] == 'N') && strncasecmp (p, "no", 2) == 0) {
367 else if ((p[0] == 'o' || p[0] == 'O') && strncasecmp (p, "on", 2) == 0) {
373 if (ret && obj != NULL) {
374 obj->type = UCL_BOOLEAN;
382 * Check numeric string
383 * @param obj object to set if a string is numeric
384 * @param start start of string
385 * @param end end of string
386 * @param pos position where parsing has stopped
387 * @param allow_double allow parsing of floating point values
388 * @return 0 if string is numeric and error code (EINVAL or ERANGE) in case of conversion error
390 int ucl_maybe_parse_number (ucl_object_t *obj,
391 const char *start, const char *end, const char **pos,
392 bool allow_double, bool number_bytes, bool allow_time);
395 static inline const ucl_object_t *
396 ucl_hash_search_obj (ucl_hash_t* hashlin, ucl_object_t *obj)
398 return (const ucl_object_t *)ucl_hash_search (hashlin, obj->key, obj->keylen);
401 static inline ucl_hash_t * ucl_hash_insert_object (ucl_hash_t *hashlin,
402 const ucl_object_t *obj,
403 bool ignore_case) UCL_WARN_UNUSED_RESULT;
405 static inline ucl_hash_t *
406 ucl_hash_insert_object (ucl_hash_t *hashlin,
407 const ucl_object_t *obj,
410 if (hashlin == NULL) {
411 hashlin = ucl_hash_create (ignore_case);
413 ucl_hash_insert (hashlin, obj, obj->key, obj->keylen);
419 * Get standard emitter context for a specified emit_type
420 * @param emit_type type of emitter
421 * @return context or NULL if input is invalid
423 const struct ucl_emitter_context *
424 ucl_emit_get_standard_context (enum ucl_emitter emit_type);
427 * Serialize string as JSON string
428 * @param str string to emit
429 * @param buf target buffer
431 void ucl_elt_string_write_json (const char *str, size_t size,
432 struct ucl_emitter_context *ctx);
435 * Write multiline string using `EOD` as string terminator
440 void ucl_elt_string_write_multiline (const char *str, size_t size,
441 struct ucl_emitter_context *ctx);
444 * Emit a single object to string
448 unsigned char * ucl_object_emit_single_json (const ucl_object_t *obj);
451 * Check whether a specified string is long and should be likely printed in
456 bool ucl_maybe_long_string (const ucl_object_t *obj);
459 * Print integer to the msgpack output
463 void ucl_emitter_print_int_msgpack (struct ucl_emitter_context *ctx,
466 * Print integer to the msgpack output
470 void ucl_emitter_print_double_msgpack (struct ucl_emitter_context *ctx,
473 * Print double to the msgpack output
477 void ucl_emitter_print_bool_msgpack (struct ucl_emitter_context *ctx,
480 * Print string to the msgpack output
485 void ucl_emitter_print_string_msgpack (struct ucl_emitter_context *ctx,
486 const char *s, size_t len);
489 * Print binary string to the msgpack output
494 void ucl_emitter_print_binary_string_msgpack (struct ucl_emitter_context *ctx,
495 const char *s, size_t len);
498 * Print array preamble for msgpack
502 void ucl_emitter_print_array_msgpack (struct ucl_emitter_context *ctx,
506 * Print object preamble for msgpack
510 void ucl_emitter_print_object_msgpack (struct ucl_emitter_context *ctx,
513 * Print NULL to the msgpack output
516 void ucl_emitter_print_null_msgpack (struct ucl_emitter_context *ctx);
518 * Print object's key if needed to the msgpack output
523 void ucl_emitter_print_key_msgpack (bool print_key,
524 struct ucl_emitter_context *ctx,
525 const ucl_object_t *obj);
528 * Fetch URL into a buffer
529 * @param url url to fetch
530 * @param buf pointer to buffer (must be freed by callee)
531 * @param buflen pointer to buffer length
532 * @param err pointer to error argument
533 * @param must_exist fail if cannot find a url
535 bool ucl_fetch_url (const unsigned char *url,
542 * Fetch a file and save results to the memory buffer
543 * @param filename filename to fetch
544 * @param len length of filename
545 * @param buf target buffer
546 * @param buflen target length
549 bool ucl_fetch_file (const unsigned char *filename,
556 * Add new element to an object using the current merge strategy and priority
561 bool ucl_parser_process_object_element (struct ucl_parser *parser,
565 * Parse msgpack chunk
569 bool ucl_parse_msgpack (struct ucl_parser *parser);
571 #endif /* UCL_INTERNAL_H_ */