yaml.h File Reference

YAML utils. More...

#include <gtk/gtk.h>
#include <cyaml/cyaml.h>

Include dependency graph for yaml.h:

Go to the source code of this file.

Macros
#define	YAML_FIELD_IGNORE_OPT(key)   CYAML_FIELD_IGNORE (key, CYAML_FLAG_OPTIONAL)
	Ignores a key and doesn't require it to be present either.
#define	YAML_FIELD_MAPPING_EMBEDDED(owner, member, schema)    CYAML_FIELD_MAPPING (#member, CYAML_FLAG_DEFAULT, owner, member, schema)
	Mapping embedded inside the struct.
#define	YAML_FIELD_MAPPING_PTR(owner, member, schema)    CYAML_FIELD_MAPPING_PTR (#member, CYAML_FLAG_POINTER, owner, member, schema)
	Mapping pointer to a struct.
#define	YAML_FIELD_MAPPING_PTR_OPTIONAL(owner, member, schema)
	Mapping pointer to a struct.
#define	YAML_FIELD_FIXED_SIZE_PTR_ARRAY_VAR_COUNT(owner, member, schema)
	Fixed-width array of pointers with variable count.
#define	YAML_FIELD_FIXED_SIZE_PTR_ARRAY(owner, member, schema, size)
	Fixed-width array of pointers with fixed count.
#define	YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT(owner, member, schema)
	Dynamic-width (reallocated) array of pointers with variable count.
#define	YAML_FIELD_DYN_FIXED_SIZE_PTR_ARRAY(owner, member, schema, fixed_size)
	Dynamic (allocated) array of pointers with fixed count.
#define	YAML_FIELD_DYN_ARRAY_VAR_COUNT(owner, member, schema)
	Dynamic-width (reallocated) array of structs with variable count.
#define	YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT_OPT(owner, member, schema)    YAML_FIELD_DYN_ARRAY_VAR_COUNT (owner, member, schema)
	Dynamic-width (reallocated) array of pointers with variable count, nullable.
#define	YAML_FIELD_DYN_FIXED_SIZE_PTR_ARRAY_OPT(owner, member, schema, fixed_size)
	Dynamic (allocated) array of pointers with fixed count.
#define	YAML_FIELD_DYN_ARRAY_VAR_COUNT_PRIMITIVES(owner, member, schema)    YAML_FIELD_DYN_ARRAY_VAR_COUNT (owner, member, schema)
	Dynamic-width (reallocated) array of primitives with variable count.
#define	YAML_FIELD_SEQUENCE_FIXED(owner, member, schema, size)
	Fixed sequence of pointers.
#define	YAML_FIELD_INT(owner, member)    CYAML_FIELD_INT (#member, CYAML_FLAG_DEFAULT, owner, member)
#define	YAML_FIELD_INT_OPT(owner, member)    CYAML_FIELD_INT (#member, CYAML_FLAG_OPTIONAL, owner, member)
#define	YAML_FIELD_UINT(owner, member)    CYAML_FIELD_UINT (#member, CYAML_FLAG_DEFAULT, owner, member)
#define	YAML_FIELD_FLOAT(owner, member)    CYAML_FIELD_FLOAT (#member, CYAML_FLAG_DEFAULT, owner, member)
#define	YAML_FIELD_STRING_PTR(owner, member)
#define	YAML_FIELD_STRING_PTR_OPTIONAL(owner, member)
#define	YAML_FIELD_ENUM(owner, member, strings)
#define	YAML_FIELD_BITFIELD(owner, member, bitvals)
#define	YAML_VALUE_PTR(cc, fields_schema)    CYAML_VALUE_MAPPING (CYAML_FLAG_POINTER, cc, fields_schema)
	Schema to be used as a pointer.
#define	YAML_VALUE_PTR_NULLABLE(cc, fields_schema)    CYAML_VALUE_MAPPING (CYAML_FLAG_POINTER_NULL_STR, cc, fields_schema)
	Schema to be used as a pointer that can be NULL.
#define	YAML_VALUE_DEFAULT(cc, fields_schema)    CYAML_VALUE_MAPPING (CYAML_FLAG_DEFAULT, cc, fields_schema)
	Schema to be used for arrays of structs directly (not as pointers).
#define	YAML_BITVAL(_name, _offset)

Enumerations
enum	YamlDummyEnum { YAML_DUMMY_ENUM1 }

Functions
char *	yaml_serialize (void *data, const cyaml_schema_value_t *schema, GError **error)
	Serializes to YAML.
void *	yaml_deserialize (const char *yaml, const cyaml_schema_value_t *schema, GError **error)
NONNULL void	yaml_print (void *data, const cyaml_schema_value_t *schema)
void	yaml_cyaml_log_func (cyaml_log_t level, void *ctxt, const char *format, va_list args)
	Custom logging function for libcyaml.
void	yaml_set_log_level (cyaml_log_t level)
void	yaml_get_cyaml_config (cyaml_config_t *cyaml_config)

Detailed Description

YAML utils.

Definition in file yaml.h.