123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666 |
- /* Copyright (c) 2013, Vsevolod Stakhov
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED ''AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
- #ifndef UCL_INTERNAL_H_
- #define UCL_INTERNAL_H_
-
- #ifdef HAVE_CONFIG_H
- #include "config.h"
- #else
- /* Help embedded builds */
- #define HAVE_SYS_TYPES_H
- #define HAVE_SYS_MMAN_H
- #define HAVE_SYS_STAT_H
- #define HAVE_SYS_PARAM_H
- #define HAVE_LIMITS_H
- #define HAVE_FCNTL_H
- #define HAVE_ERRNO_H
- #define HAVE_UNISTD_H
- #define HAVE_CTYPE_H
- #define HAVE_STDIO_H
- #define HAVE_STRING_H
- #define HAVE_FLOAT_H
- #define HAVE_LIBGEN_H
- #define HAVE_MATH_H
- #define HAVE_STDBOOL_H
- #define HAVE_STDINT_H
- #define HAVE_STDARG_H
- #ifndef _WIN32
- # define HAVE_REGEX_H
- #endif
- #endif
-
- #ifdef HAVE_SYS_TYPES_H
- #include <sys/types.h>
- #endif
-
- #ifdef HAVE_SYS_MMAN_H
- # ifndef _WIN32
- # include <sys/mman.h>
- # endif
- #endif
- #ifdef HAVE_SYS_STAT_H
- #include <sys/stat.h>
- #endif
- #ifdef HAVE_SYS_PARAM_H
- # ifndef _WIN32
- # include <sys/param.h>
- # endif
- #endif
-
- #ifdef HAVE_LIMITS_H
- #include <limits.h>
- #endif
- #ifdef HAVE_FCNTL_H
- #include <fcntl.h>
- #endif
- #ifdef HAVE_ERRNO_H
- #include <errno.h>
- #endif
- #ifdef HAVE_UNISTD_H
- # ifndef _WIN32
- # include <unistd.h>
- # endif
- #endif
- #ifdef HAVE_CTYPE_H
- #include <ctype.h>
- #endif
- #ifdef HAVE_STDIO_H
- #include <stdio.h>
- #endif
- #ifdef HAVE_STRING_H
- #include <string.h>
- #endif
- #ifdef HAVE_STRINGS_H
- #include <strings.h>
- #endif
-
- #if defined(_MSC_VER)
- /* Windows hacks */
- #include <BaseTsd.h>
- typedef SSIZE_T ssize_t;
- #define strdup _strdup
- #define snprintf _snprintf
- #define vsnprintf _vsnprintf
- #define strcasecmp _stricmp
- #define strncasecmp _strnicmp
- #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
- #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
- #if _MSC_VER >= 1900
- #include <../ucrt/stdlib.h>
- #else
- #include <../include/stdlib.h>
- #endif
- #ifndef PATH_MAX
- #define PATH_MAX _MAX_PATH
- #endif
-
- /* Dirname, basename implementations */
-
-
- #endif
-
- #include "utlist.h"
- #include "utstring.h"
- #include "uthash.h"
- #include "ucl.h"
- #include "ucl_hash.h"
-
- #ifdef HAVE_OPENSSL
- #include <openssl/evp.h>
- #endif
-
- #ifndef __DECONST
- #define __DECONST(type, var) ((type)(uintptr_t)(const void *)(var))
- #endif
-
- /**
- * @file rcl_internal.h
- * Internal structures and functions of UCL library
- */
-
- #define UCL_MAX_RECURSION 16
- #define UCL_TRASH_KEY 0
- #define UCL_TRASH_VALUE 1
-
- enum ucl_parser_state {
- UCL_STATE_INIT = 0,
- UCL_STATE_OBJECT,
- UCL_STATE_ARRAY,
- UCL_STATE_KEY,
- UCL_STATE_KEY_OBRACE,
- UCL_STATE_VALUE,
- UCL_STATE_AFTER_VALUE,
- UCL_STATE_ARRAY_VALUE,
- UCL_STATE_SCOMMENT,
- UCL_STATE_MCOMMENT,
- UCL_STATE_MACRO_NAME,
- UCL_STATE_MACRO,
- UCL_STATE_ERROR
- };
-
- enum ucl_character_type {
- UCL_CHARACTER_DENIED = (1 << 0),
- UCL_CHARACTER_KEY = (1 << 1),
- UCL_CHARACTER_KEY_START = (1 << 2),
- UCL_CHARACTER_WHITESPACE = (1 << 3),
- UCL_CHARACTER_WHITESPACE_UNSAFE = (1 << 4),
- UCL_CHARACTER_VALUE_END = (1 << 5),
- UCL_CHARACTER_VALUE_STR = (1 << 6),
- UCL_CHARACTER_VALUE_DIGIT = (1 << 7),
- UCL_CHARACTER_VALUE_DIGIT_START = (1 << 8),
- UCL_CHARACTER_ESCAPE = (1 << 9),
- UCL_CHARACTER_KEY_SEP = (1 << 10),
- UCL_CHARACTER_JSON_UNSAFE = (1 << 11),
- UCL_CHARACTER_UCL_UNSAFE = (1 << 12)
- };
-
- struct ucl_macro {
- char *name;
- union _ucl_macro {
- ucl_macro_handler handler;
- ucl_context_macro_handler context_handler;
- } h;
- void* ud;
- bool is_context;
- UT_hash_handle hh;
- };
-
- enum ucl_stack_flags {
- UCL_STACK_HAS_OBRACE = (1u << 0),
- UCL_STACK_MAX = (1u << 1),
- };
-
- struct ucl_stack {
- ucl_object_t *obj;
- struct ucl_stack *next;
- union {
- struct {
- uint16_t level;
- uint16_t flags;
- uint32_t line;
- } params;
- uint64_t len;
- } e;
- struct ucl_chunk *chunk;
- };
-
- struct ucl_parser_special_handler_chain {
- unsigned char *begin;
- size_t len;
- struct ucl_parser_special_handler *special_handler;
- struct ucl_parser_special_handler_chain *next;
- };
-
- struct ucl_chunk {
- const unsigned char *begin;
- const unsigned char *end;
- const unsigned char *pos;
- char *fname;
- size_t remain;
- unsigned int line;
- unsigned int column;
- unsigned priority;
- enum ucl_duplicate_strategy strategy;
- enum ucl_parse_type parse_type;
- struct ucl_parser_special_handler_chain *special_handlers;
- struct ucl_chunk *next;
- };
-
- #ifdef HAVE_OPENSSL
- struct ucl_pubkey {
- EVP_PKEY *key;
- struct ucl_pubkey *next;
- };
- #else
- struct ucl_pubkey {
- struct ucl_pubkey *next;
- };
- #endif
-
- struct ucl_variable {
- char *var;
- char *value;
- size_t var_len;
- size_t value_len;
- struct ucl_variable *prev, *next;
- };
-
- struct ucl_parser {
- enum ucl_parser_state state;
- enum ucl_parser_state prev_state;
- unsigned int recursion;
- int flags;
- unsigned default_priority;
- int err_code;
- ucl_object_t *top_obj;
- ucl_object_t *cur_obj;
- ucl_object_t *trash_objs;
- ucl_object_t *includepaths;
- char *cur_file;
- struct ucl_macro *macroes;
- struct ucl_stack *stack;
- struct ucl_chunk *chunks;
- struct ucl_pubkey *keys;
- struct ucl_parser_special_handler *special_handlers;
- ucl_include_trace_func_t *include_trace_func;
- void *include_trace_ud;
- struct ucl_variable *variables;
- ucl_variable_handler var_handler;
- void *var_data;
- ucl_object_t *comments;
- ucl_object_t *last_comment;
- UT_string *err;
- };
-
- struct ucl_object_userdata {
- ucl_object_t obj;
- ucl_userdata_dtor dtor;
- ucl_userdata_emitter emitter;
- };
-
- /**
- * Unescape json string inplace
- * @param str
- */
- size_t ucl_unescape_json_string (char *str, size_t len);
-
-
- /**
- * Unescape single quoted string inplace
- * @param str
- */
- size_t ucl_unescape_squoted_string (char *str, size_t len);
-
- /**
- * Handle include macro
- * @param data include data
- * @param len length of data
- * @param args UCL object representing arguments to the macro
- * @param ud user data
- * @return
- */
- bool ucl_include_handler (const unsigned char *data, size_t len,
- const ucl_object_t *args, void* ud);
-
- /**
- * Handle tryinclude macro
- * @param data include data
- * @param len length of data
- * @param args UCL object representing arguments to the macro
- * @param ud user data
- * @return
- */
- bool ucl_try_include_handler (const unsigned char *data, size_t len,
- const ucl_object_t *args, void* ud);
-
- /**
- * Handle includes macro
- * @param data include data
- * @param len length of data
- * @param args UCL object representing arguments to the macro
- * @param ud user data
- * @return
- */
- bool ucl_includes_handler (const unsigned char *data, size_t len,
- const ucl_object_t *args, void* ud);
-
- /**
- * Handle priority macro
- * @param data include data
- * @param len length of data
- * @param args UCL object representing arguments to the macro
- * @param ud user data
- * @return
- */
- bool ucl_priority_handler (const unsigned char *data, size_t len,
- const ucl_object_t *args, void* ud);
-
- /**
- * Handle load macro
- * @param data include data
- * @param len length of data
- * @param args UCL object representing arguments to the macro
- * @param ud user data
- * @return
- */
- bool ucl_load_handler (const unsigned char *data, size_t len,
- const ucl_object_t *args, void* ud);
- /**
- * Handle inherit macro
- * @param data include data
- * @param len length of data
- * @param args UCL object representing arguments to the macro
- * @param ctx the current context object
- * @param ud user data
- * @return
- */
- bool ucl_inherit_handler (const unsigned char *data, size_t len,
- const ucl_object_t *args, const ucl_object_t *ctx, void* ud);
-
- size_t ucl_strlcpy (char *dst, const char *src, size_t siz);
- size_t ucl_strlcpy_unsafe (char *dst, const char *src, size_t siz);
- size_t ucl_strlcpy_tolower (char *dst, const char *src, size_t siz);
-
- char *ucl_strnstr (const char *s, const char *find, int len);
- char *ucl_strncasestr (const char *s, const char *find, int len);
-
- #ifdef __GNUC__
- static inline void
- ucl_create_err (UT_string **err, const char *fmt, ...)
- __attribute__ (( format( printf, 2, 3) ));
- #endif
-
- #undef UCL_FATAL_ERRORS
-
- static inline void
- ucl_create_err (UT_string **err, const char *fmt, ...)
- {
- if (*err == NULL) {
- utstring_new (*err);
- va_list ap;
- va_start (ap, fmt);
- utstring_printf_va (*err, fmt, ap);
- va_end (ap);
- }
-
- #ifdef UCL_FATAL_ERRORS
- assert (0);
- #endif
- }
-
- /**
- * Check whether a given string contains a boolean value
- * @param obj object to set
- * @param start start of a string
- * @param len length of a string
- * @return true if a string is a boolean value
- */
- static inline bool
- ucl_maybe_parse_boolean (ucl_object_t *obj, const unsigned char *start, size_t len)
- {
- const char *p = (const char *)start;
- bool ret = false, val = false;
-
- if (len == 5) {
- if ((p[0] == 'f' || p[0] == 'F') && strncasecmp (p, "false", 5) == 0) {
- ret = true;
- val = false;
- }
- }
- else if (len == 4) {
- if ((p[0] == 't' || p[0] == 'T') && strncasecmp (p, "true", 4) == 0) {
- ret = true;
- val = true;
- }
- }
- else if (len == 3) {
- if ((p[0] == 'y' || p[0] == 'Y') && strncasecmp (p, "yes", 3) == 0) {
- ret = true;
- val = true;
- }
- else if ((p[0] == 'o' || p[0] == 'O') && strncasecmp (p, "off", 3) == 0) {
- ret = true;
- val = false;
- }
- }
- else if (len == 2) {
- if ((p[0] == 'n' || p[0] == 'N') && strncasecmp (p, "no", 2) == 0) {
- ret = true;
- val = false;
- }
- else if ((p[0] == 'o' || p[0] == 'O') && strncasecmp (p, "on", 2) == 0) {
- ret = true;
- val = true;
- }
- }
-
- if (ret && obj != NULL) {
- obj->type = UCL_BOOLEAN;
- obj->value.iv = val;
- }
-
- return ret;
- }
-
- /**
- * Check numeric string
- * @param obj object to set if a string is numeric
- * @param start start of string
- * @param end end of string
- * @param pos position where parsing has stopped
- * @param allow_double allow parsing of floating point values
- * @return 0 if string is numeric and error code (EINVAL or ERANGE) in case of conversion error
- */
- int ucl_maybe_parse_number (ucl_object_t *obj,
- const char *start, const char *end, const char **pos,
- bool allow_double, bool number_bytes, bool allow_time);
-
-
- static inline const ucl_object_t *
- ucl_hash_search_obj (ucl_hash_t* hashlin, ucl_object_t *obj)
- {
- return (const ucl_object_t *)ucl_hash_search (hashlin, obj->key, obj->keylen);
- }
-
- static inline ucl_hash_t * ucl_hash_insert_object (ucl_hash_t *hashlin,
- const ucl_object_t *obj,
- bool ignore_case) UCL_WARN_UNUSED_RESULT;
-
- static inline ucl_hash_t *
- ucl_hash_insert_object (ucl_hash_t *hashlin,
- const ucl_object_t *obj,
- bool ignore_case)
- {
- ucl_hash_t *nhp;
-
- if (hashlin == NULL) {
- nhp = ucl_hash_create (ignore_case);
- if (nhp == NULL) {
- return NULL;
- }
- } else {
- nhp = hashlin;
- }
- if (!ucl_hash_insert (nhp, obj, obj->key, obj->keylen)) {
- if (nhp != hashlin) {
- ucl_hash_destroy(nhp, NULL);
- }
- return NULL;
- }
-
- return nhp;
- }
-
- /**
- * Get standard emitter context for a specified emit_type
- * @param emit_type type of emitter
- * @return context or NULL if input is invalid
- */
- const struct ucl_emitter_context *
- ucl_emit_get_standard_context (enum ucl_emitter emit_type);
-
- /**
- * Serialize string as JSON string
- * @param str string to emit
- * @param buf target buffer
- */
- void ucl_elt_string_write_json (const char *str, size_t size,
- struct ucl_emitter_context *ctx);
-
-
- /**
- * Serialize string as single quoted string
- * @param str string to emit
- * @param buf target buffer
- */
- void
- ucl_elt_string_write_squoted (const char *str, size_t size,
- struct ucl_emitter_context *ctx);
-
- /**
- * Write multiline string using `EOD` as string terminator
- * @param str
- * @param size
- * @param ctx
- */
- void ucl_elt_string_write_multiline (const char *str, size_t size,
- struct ucl_emitter_context *ctx);
-
- /**
- * Emit a single object to string
- * @param obj
- * @return
- */
- unsigned char * ucl_object_emit_single_json (const ucl_object_t *obj);
-
- /**
- * Check whether a specified string is long and should be likely printed in
- * multiline mode
- * @param obj
- * @return
- */
- bool ucl_maybe_long_string (const ucl_object_t *obj);
-
- /**
- * Print integer to the msgpack output
- * @param ctx
- * @param val
- */
- void ucl_emitter_print_int_msgpack (struct ucl_emitter_context *ctx,
- int64_t val);
- /**
- * Print integer to the msgpack output
- * @param ctx
- * @param val
- */
- void ucl_emitter_print_double_msgpack (struct ucl_emitter_context *ctx,
- double val);
- /**
- * Print double to the msgpack output
- * @param ctx
- * @param val
- */
- void ucl_emitter_print_bool_msgpack (struct ucl_emitter_context *ctx,
- bool val);
- /**
- * Print string to the msgpack output
- * @param ctx
- * @param s
- * @param len
- */
- void ucl_emitter_print_string_msgpack (struct ucl_emitter_context *ctx,
- const char *s, size_t len);
-
- /**
- * Print binary string to the msgpack output
- * @param ctx
- * @param s
- * @param len
- */
- void ucl_emitter_print_binary_string_msgpack (struct ucl_emitter_context *ctx,
- const char *s, size_t len);
-
- /**
- * Print array preamble for msgpack
- * @param ctx
- * @param len
- */
- void ucl_emitter_print_array_msgpack (struct ucl_emitter_context *ctx,
- size_t len);
-
- /**
- * Print object preamble for msgpack
- * @param ctx
- * @param len
- */
- void ucl_emitter_print_object_msgpack (struct ucl_emitter_context *ctx,
- size_t len);
- /**
- * Print NULL to the msgpack output
- * @param ctx
- */
- void ucl_emitter_print_null_msgpack (struct ucl_emitter_context *ctx);
- /**
- * Print object's key if needed to the msgpack output
- * @param print_key
- * @param ctx
- * @param obj
- */
- void ucl_emitter_print_key_msgpack (bool print_key,
- struct ucl_emitter_context *ctx,
- const ucl_object_t *obj);
-
- /**
- * Fetch URL into a buffer
- * @param url url to fetch
- * @param buf pointer to buffer (must be freed by callee)
- * @param buflen pointer to buffer length
- * @param err pointer to error argument
- * @param must_exist fail if cannot find a url
- */
- bool ucl_fetch_url (const unsigned char *url,
- unsigned char **buf,
- size_t *buflen,
- UT_string **err,
- bool must_exist);
-
- /**
- * Fetch a file and save results to the memory buffer
- * @param filename filename to fetch
- * @param len length of filename
- * @param buf target buffer
- * @param buflen target length
- * @return
- */
- bool ucl_fetch_file (const unsigned char *filename,
- unsigned char **buf,
- size_t *buflen,
- UT_string **err,
- bool must_exist);
-
- /**
- * Add new element to an object using the current merge strategy and priority
- * @param parser
- * @param nobj
- * @return
- */
- bool ucl_parser_process_object_element (struct ucl_parser *parser,
- ucl_object_t *nobj);
-
- /**
- * Parse msgpack chunk
- * @param parser
- * @return
- */
- bool ucl_parse_msgpack (struct ucl_parser *parser);
-
- bool ucl_parse_csexp (struct ucl_parser *parser);
-
- /**
- * Free ucl chunk
- * @param chunk
- */
- void ucl_chunk_free (struct ucl_chunk *chunk);
-
- #endif /* UCL_INTERNAL_H_ */
|