libucl/include/ucl.h

116  * #ucl_object_t may have one of specified types, some types are compatible with each other and some are not.
134  * You can use one of these types to serialise #ucl_object_t by using ucl_object_emit().
241 } ucl_object_t;
263 UCL_EXTERN char* ucl_copy_key_trash (const ucl_object_t *obj);
270 UCL_EXTERN char* ucl_copy_value_trash (const ucl_object_t *obj);
276 UCL_EXTERN ucl_object_t* ucl_object_new (void) UCL_WARN_UNUSED_RESULT;
283 UCL_EXTERN ucl_object_t* ucl_object_typed_new (ucl_type_t type) UCL_WARN_UNUSED_RESULT;
291 UCL_EXTERN ucl_object_t* ucl_object_new_full (ucl_type_t type, unsigned priority)
301 UCL_EXTERN ucl_object_t* ucl_object_new_userdata (ucl_userdata_dtor dtor,
309 UCL_EXTERN ucl_object_t * ucl_object_copy (const ucl_object_t *other)
316 UCL_EXTERN ucl_type_t ucl_object_type (const ucl_object_t *obj);
340 UCL_EXTERN ucl_object_t * ucl_object_fromstring_common (const char *str, size_t len,
348 UCL_EXTERN ucl_object_t *ucl_object_fromstring (const char *str) UCL_WARN_UNUSED_RESULT;
356 UCL_EXTERN ucl_object_t *ucl_object_fromlstring (const char *str,
364 UCL_EXTERN ucl_object_t* ucl_object_fromint (int64_t iv) UCL_WARN_UNUSED_RESULT;
371 UCL_EXTERN ucl_object_t* ucl_object_fromdouble (double dv) UCL_WARN_UNUSED_RESULT;
378 UCL_EXTERN ucl_object_t* ucl_object_frombool (bool bv) UCL_WARN_UNUSED_RESULT;
389 UCL_EXTERN bool ucl_object_insert_key (ucl_object_t *top, ucl_object_t *elt,
402 UCL_EXTERN bool ucl_object_replace_key (ucl_object_t *top, ucl_object_t *elt,
412 UCL_EXTERN bool ucl_object_merge (ucl_object_t *top, ucl_object_t *elt, bool copy);
420 UCL_EXTERN bool ucl_object_delete_keyl (ucl_object_t *top,
428 UCL_EXTERN bool ucl_object_delete_key (ucl_object_t *top,
441 UCL_EXTERN ucl_object_t* ucl_object_pop_keyl (ucl_object_t *top, const char *key,
452 UCL_EXTERN ucl_object_t* ucl_object_pop_key (ucl_object_t *top, const char *key)
465 UCL_EXTERN bool ucl_object_insert_key_merged (ucl_object_t *top, ucl_object_t *elt,
474 UCL_EXTERN bool ucl_object_reserve (ucl_object_t *obj, size_t reserved);
482 UCL_EXTERN bool ucl_array_append (ucl_object_t *top,
483 		ucl_object_t *elt);
491 UCL_EXTERN bool ucl_array_prepend (ucl_object_t *top,
492 		ucl_object_t *elt);
501 UCL_EXTERN bool ucl_array_merge (ucl_object_t *top, ucl_object_t *elt,
512 UCL_EXTERN ucl_object_t* ucl_array_delete (ucl_object_t *top,
513 		ucl_object_t *elt);
520 UCL_EXTERN const ucl_object_t* ucl_array_head (const ucl_object_t *top);
527 UCL_EXTERN const ucl_object_t* ucl_array_tail (const ucl_object_t *top);
536 UCL_EXTERN ucl_object_t* ucl_array_pop_last (ucl_object_t *top);
545 UCL_EXTERN ucl_object_t* ucl_array_pop_first (ucl_object_t *top);
552 UCL_EXTERN unsigned int ucl_array_size (const ucl_object_t *top);
560 UCL_EXTERN const ucl_object_t* ucl_array_find_index (const ucl_object_t *top,
569 UCL_EXTERN unsigned int ucl_array_index_of (ucl_object_t *top,
570 		ucl_object_t *elt);
581 ucl_object_t *
582 ucl_array_replace_index (ucl_object_t *top, ucl_object_t *elt,
591 UCL_EXTERN ucl_object_t * ucl_elt_append (ucl_object_t *head,
592 		ucl_object_t *elt);
600 UCL_EXTERN bool ucl_object_todouble_safe (const ucl_object_t *obj, double *target);
607 UCL_EXTERN double ucl_object_todouble (const ucl_object_t *obj);
615 UCL_EXTERN bool ucl_object_toint_safe (const ucl_object_t *obj, int64_t *target);
622 UCL_EXTERN int64_t ucl_object_toint (const ucl_object_t *obj);
630 UCL_EXTERN bool ucl_object_toboolean_safe (const ucl_object_t *obj, bool *target);
637 UCL_EXTERN bool ucl_object_toboolean (const ucl_object_t *obj);
645 UCL_EXTERN bool ucl_object_tostring_safe (const ucl_object_t *obj, const char **target);
652 UCL_EXTERN const char* ucl_object_tostring (const ucl_object_t *obj);
659 UCL_EXTERN const char* ucl_object_tostring_forced (const ucl_object_t *obj);
669 UCL_EXTERN bool ucl_object_tolstring_safe (const ucl_object_t *obj,
677 UCL_EXTERN const char* ucl_object_tolstring (const ucl_object_t *obj, size_t *tlen);
685 UCL_EXTERN const ucl_object_t* ucl_object_lookup (const ucl_object_t *obj,
699 UCL_EXTERN const ucl_object_t* ucl_object_lookup_any (const ucl_object_t *obj,
710 UCL_EXTERN const ucl_object_t* ucl_object_lookup_len (const ucl_object_t *obj,
720 UCL_EXTERN const ucl_object_t *ucl_object_lookup_path (const ucl_object_t *obj,
731 UCL_EXTERN const ucl_object_t *ucl_object_lookup_path_char (const ucl_object_t *obj,
740 UCL_EXTERN const char* ucl_object_key (const ucl_object_t *obj);
748 UCL_EXTERN const char* ucl_object_keyl (const ucl_object_t *obj, size_t *len);
755 UCL_EXTERN ucl_object_t* ucl_object_ref (const ucl_object_t *obj);
761 UCL_DEPRECATED(UCL_EXTERN void ucl_object_free (ucl_object_t *obj));
767 UCL_EXTERN void ucl_object_unref (ucl_object_t *obj);
779 UCL_EXTERN int ucl_object_compare (const ucl_object_t *o1,
780 		const ucl_object_t *o2);
792 UCL_EXTERN int ucl_object_compare_qsort (const ucl_object_t **o1,
793 		const ucl_object_t **o2);
800 UCL_EXTERN void ucl_object_array_sort (ucl_object_t *ar,
801 		int (*cmp)(const ucl_object_t **o1, const ucl_object_t **o2));
813 UCL_EXTERN void ucl_object_sort_keys (ucl_object_t *obj,
821 UCL_EXTERN unsigned int ucl_object_get_priority (const ucl_object_t *obj);
828 UCL_EXTERN void ucl_object_set_priority (ucl_object_t *obj,
845 UCL_EXTERN const ucl_object_t* ucl_object_iterate_with_error (const ucl_object_t *obj,
856 UCL_EXTERN ucl_object_iter_t ucl_object_iterate_new (const ucl_object_t *obj)
873 		const ucl_object_t *obj);
882 UCL_EXTERN const ucl_object_t* ucl_object_iterate_safe (ucl_object_iter_t iter,
900 UCL_EXTERN const ucl_object_t* ucl_object_iterate_full (ucl_object_iter_t iter,
929 		const ucl_object_t *arguments,
943 		const ucl_object_t *arguments,
944 		const ucl_object_t *context,
1180 		ucl_object_t *paths);
1188 UCL_EXTERN ucl_object_t* ucl_parser_get_object (struct ucl_parser *parser);
1197 UCL_EXTERN ucl_object_t* ucl_parser_get_current_stack_object (struct ucl_parser *parser, unsigned int depth);
1259 UCL_EXTERN const ucl_object_t * ucl_parser_get_comments (struct ucl_parser *parser);
1265  * @return string comment enclosed in ucl_object_t
1267 UCL_EXTERN const ucl_object_t * ucl_comments_find (const ucl_object_t *comments,
1268 		const ucl_object_t *srch);
1277 UCL_EXTERN bool ucl_comments_move (ucl_object_t *comments,
1278 		const ucl_object_t *from, const ucl_object_t *to);
1286 UCL_EXTERN void ucl_comments_add (ucl_object_t *comments,
1287 		const ucl_object_t *obj, const char *comment);
1364 		const ucl_object_t *parent,
1365 		const ucl_object_t *args,
1411 		const ucl_object_t *obj, bool first, bool print_key);
1414 		const ucl_object_t *obj, bool print_key);
1417 		const ucl_object_t *obj);
1420 		const ucl_object_t *obj, bool print_key);
1422 		const ucl_object_t *obj);
1440 	const ucl_object_t *top;
1442 	const ucl_object_t *comments;
1452 UCL_EXTERN unsigned char *ucl_object_emit (const ucl_object_t *obj,
1463 UCL_EXTERN unsigned char *ucl_object_emit_len (const ucl_object_t *obj,
1475 UCL_EXTERN bool ucl_object_emit_full (const ucl_object_t *obj,
1478 		const ucl_object_t *comments);
1489 		const ucl_object_t *obj, enum ucl_emitter emit_type,
1498 		struct ucl_emitter_context *ctx, const ucl_object_t *obj);
1505 		struct ucl_emitter_context *ctx, const ucl_object_t *obj);
1579 	const ucl_object_t *obj;			/**< object where error occurred */
1590 UCL_EXTERN bool ucl_object_validate (const ucl_object_t *schema,
1591 		const ucl_object_t *obj, struct ucl_schema_error *err);
1602 UCL_EXTERN bool ucl_object_validate_root (const ucl_object_t *schema,
1603 		const ucl_object_t *obj,
1604 		const ucl_object_t *root,
1618 UCL_EXTERN bool ucl_object_validate_root_ext (const ucl_object_t *schema,
1619 		const ucl_object_t *obj,
1620 		const ucl_object_t *root,
1621 		ucl_object_t *ext_refs,