Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for default values #212

Merged
merged 8 commits into from
May 29, 2023
Merged

Add support for default values #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fc7aae3
Load: Mapping validation: Check field set before optional
tlsa May 17, 2023
1e53439
Load: Mapping validation: Use flag check helper
tlsa May 17, 2023
8d354b2
Load: Mapping validation: Simplify field indexing
tlsa May 28, 2023
d159cfe
API: Load: Add support for default values
tlsa May 28, 2023
d0e0734
Test: Load: Add tests for use of default values
tlsa May 28, 2023
15ff005
Test: Load: Add test for optional ignored value
tlsa May 28, 2023
54be5e3
Test: Errors: Add default values to OOM test
tlsa May 28, 2023
95afbb8
Test: Errors: Add bad schema tests for default values
tlsa May 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 102 additions & 4 deletions include/cyaml/cyaml.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ extern "C"
#include <stdarg.h>
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

/**
* CYAML library version string.
Expand Down Expand Up @@ -382,6 +383,50 @@ typedef struct cyaml_schema_value {
uint32_t data_size;
/** Anonymous union containing type-specific attributes. */
union {
/** \ref CYAML_INT type-specific schema data. */
struct {
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*/
int64_t missing;
} integer;
/** \ref CYAML_UINT type-specific schema data. */
struct {
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*/
uint64_t missing;
} unsigned_integer;
/** \ref CYAML_BOOL type-specific schema data. */
struct {
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*/
bool missing;
} boolean;
/** \ref CYAML_FLOAT type-specific schema data. */
struct {
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*/
double missing;
} floating_point;
/** \ref CYAML_STRING type-specific schema data. */
struct {
/**
Expand All @@ -398,6 +443,17 @@ typedef struct cyaml_schema_value {
* must be no more than `data_size - 1`.
*/
uint32_t max;
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*
* \note This is may be NULL, if no default sequence is
* wanted for a missing field in the YAML.
*/
const char *missing;
} string;
/** \ref CYAML_MAPPING type-specific schema data. */
struct {
Expand All @@ -409,13 +465,32 @@ typedef struct cyaml_schema_value {
* and \ref CYAML_FIELD_END for more info.
*/
const struct cyaml_schema_field *fields;
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*
* \note This is may be NULL, if no default sequence is
* wanted for a missing field in the YAML.
*/
const void *missing;
} mapping;
/** \ref CYAML_BITFIELD type-specific schema data. */
struct {
/** Array of bit definitions for the bit field. */
const struct cyaml_bitdef *bitdefs;
/** Entry count for bitdefs array. */
uint32_t count;
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*/
uint64_t missing;
} bitfield;
/**
* \ref CYAML_SEQUENCE and \ref CYAML_SEQUENCE_FIXED
Expand Down Expand Up @@ -447,6 +522,21 @@ typedef struct cyaml_schema_value {
* CYAML_SEQUENCE_FIXED.
*/
uint32_t max;
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*
* \note This is may be NULL, if no default sequence is
* wanted for a missing field in the YAML.
*/
const void *missing;
/**
* Number of entries in missing array.
*/
uint32_t missing_count;
} sequence;
/**
* \ref CYAML_ENUM and \ref CYAML_FLAGS type-specific schema
Expand All @@ -457,6 +547,14 @@ typedef struct cyaml_schema_value {
const cyaml_strval_t *strings;
/** Entry count for strings array. */
uint32_t count;
/**
* Value to use for missing YAML field.
*
* This is only used when the value is used for a
* mapping field with the \ref CYAML_FLAG_OPTIONAL flag
* set.
*/
int64_t missing;
} enumeration;
};
} cyaml_schema_value_t;
Expand Down Expand Up @@ -640,17 +738,17 @@ typedef enum cyaml_err {
((_flags) & (~CYAML_FLAG_POINTER))

/** Type to \ref cyaml_schema_value union member for INT. */
#define CYAML__UNION_MEMBER_INT .enumeration
#define CYAML__UNION_MEMBER_INT .integer
/** Type to \ref cyaml_schema_value union member for UINT. */
#define CYAML__UNION_MEMBER_UINT .enumeration
#define CYAML__UNION_MEMBER_UINT .unsigned_integer
/** Type to \ref cyaml_schema_value union member for BOOL. */
#define CYAML__UNION_MEMBER_BOOL .enumeration
#define CYAML__UNION_MEMBER_BOOL .boolean
/** Type to \ref cyaml_schema_value union member for ENUM. */
#define CYAML__UNION_MEMBER_ENUM .enumeration
/** Type to \ref cyaml_schema_value union member for FLAGS. */
#define CYAML__UNION_MEMBER_FLAGS .enumeration
/** Type to \ref cyaml_schema_value union member for FLOAT. */
#define CYAML__UNION_MEMBER_FLOAT .enumeration
#define CYAML__UNION_MEMBER_FLOAT .floating_point
/** Type to \ref cyaml_schema_value union member for STRING. */
#define CYAML__UNION_MEMBER_STRING .string
/** Type to \ref cyaml_schema_value union member for MAPPING. */
Expand Down
Loading