config.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_config_api.h>
 
#include "core/analyze.h"
#include "core/compiler.h"
 
#include <stdbool.h>
#include <stddef.h>
#include <limits.h>
 
CT_BEGIN_API
 
typedef struct arena_t arena_t;
typedef struct typevec_t typevec_t;
typedef struct vector_t vector_t;
 
 
typedef enum cfg_type_t
{
#define CFG_TYPE(id, name) id,
#include "config.inc"
 
    eConfigCount
} cfg_type_t;
 
typedef struct cfg_field_t cfg_field_t;
typedef struct cfg_group_t cfg_group_t;
 
typedef enum arg_style_t
{
#define CFG_ARG(id, name, prefix) id,
#include "config.inc"
    eArgCount
} arg_style_t;
 
typedef struct cfg_arg_t
{
    arg_style_t style;
    const char *arg;
} cfg_arg_t;
 
// short args are turned into dos args when needed
// long args are discarded on windows
// dos args are discarded on unix
 
#define CT_ARG_SHORT(name) { .style = eArgShort, .arg = (name) }
#define CT_ARG_LONG(name) { .style = eArgLong, .arg = (name) }
#define CT_ARG_DOS(name) { .style = eArgDOS, .arg = (name) }
#define CT_ARGS(it) { .args = (it), .count = sizeof(it) / sizeof(cfg_arg_t) }
 
typedef struct cfg_arg_array_t
{
    const cfg_arg_t *args;
    size_t count;
} cfg_arg_array_t;
 
typedef struct cfg_info_t
{
    STA_FIELD_STRING const char *name;
 
    STA_FIELD_STRING const char *brief;
 
    cfg_arg_array_t args;
} cfg_info_t;
 
typedef struct cfg_int_t
{
    STA_FIELD_RANGE(min, max) int initial;
 
    STA_FIELD_RANGE(INT_MIN, max) int min;
 
    STA_FIELD_RANGE(min, INT_MAX) int max;
} cfg_int_t;
 
typedef struct cfg_choice_t
{
    STA_FIELD_STRING const char *text;
 
    size_t value;
} cfg_choice_t;
 
typedef struct cfg_enum_t
{
    STA_FIELD_SIZE(count) const cfg_choice_t *options;
 
    size_t count;
 
    size_t initial;
} cfg_enum_t;
 
CT_CONFIG_API cfg_group_t *config_root(IN_NOTNULL const cfg_info_t *info, IN_NOTNULL arena_t *arena);
 
 
CT_CONFIG_API cfg_group_t *config_group(IN_NOTNULL cfg_group_t *group, IN_NOTNULL const cfg_info_t *info);
 
CT_CONFIG_API cfg_field_t *config_int(IN_NOTNULL cfg_group_t *group, IN_NOTNULL const cfg_info_t *info, cfg_int_t cfg);
 
CT_CONFIG_API cfg_field_t *config_bool(IN_NOTNULL cfg_group_t *group, IN_NOTNULL const cfg_info_t *info, bool initial);
 
CT_CONFIG_API cfg_field_t *config_string(IN_NOTNULL cfg_group_t *group, IN_NOTNULL const cfg_info_t *info, const char *initial);
 
CT_CONFIG_API cfg_field_t *config_vector(IN_NOTNULL cfg_group_t *group, IN_NOTNULL const cfg_info_t *info, vector_t *initial);
 
CT_CONFIG_API cfg_field_t *config_enum(IN_NOTNULL cfg_group_t *group, IN_NOTNULL const cfg_info_t *info, cfg_enum_t cfg);
 
CT_CONFIG_API cfg_field_t *config_flags(IN_NOTNULL cfg_group_t *group, IN_NOTNULL const cfg_info_t *info, cfg_enum_t cfg);
 
 
 
CT_PUREFN
CT_CONFIG_API cfg_type_t cfg_get_type(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN RET_NOTNULL
CT_CONFIG_API const cfg_info_t *cfg_get_info(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN RET_NOTNULL
CT_CONFIG_API const cfg_info_t *cfg_group_info(IN_NOTNULL const cfg_group_t *config);
 
CT_PUREFN RET_NOTNULL
CT_CONFIG_API const cfg_int_t *cfg_int_info(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API bool cfg_bool_info(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API const char *cfg_string_info(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API const vector_t *cfg_vector_info(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN RET_NOTNULL
CT_CONFIG_API const cfg_enum_t *cfg_enum_info(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN RET_NOTNULL
CT_CONFIG_API const cfg_enum_t *cfg_flags_info(IN_NOTNULL const cfg_field_t *field);
 
CT_CONSTFN RET_NOTNULL
CT_CONFIG_API const char *cfg_type_string(IN_DOMAIN(<, eConfigCount) cfg_type_t type);
 
CT_CONSTFN RET_NOTNULL
CT_CONFIG_API const char *cfg_arg_string(IN_DOMAIN(<, eArgCount) arg_style_t style);
 
CT_CONSTFN RET_NOTNULL
CT_CONFIG_API const char *cfg_arg_prefix(IN_DOMAIN(<, eArgCount) arg_style_t style);
 
CT_PUREFN RET_NOTNULL
CT_CONFIG_API typevec_t *cfg_get_groups(IN_NOTNULL const cfg_group_t *config);
 
CT_PUREFN RET_NOTNULL
CT_CONFIG_API vector_t *cfg_get_fields(IN_NOTNULL const cfg_group_t *config);
 
 
 
CT_PUREFN
CT_CONFIG_API int cfg_int_value(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API bool cfg_bool_value(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API const char *cfg_string_value(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API vector_t *cfg_vector_value(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API size_t cfg_enum_value(IN_NOTNULL const cfg_field_t *field);
 
CT_PUREFN
CT_CONFIG_API size_t cfg_flags_value(IN_NOTNULL const cfg_field_t *field);
 
 
 
CT_NODISCARD
CT_CONFIG_API bool cfg_set_int(IN_NOTNULL cfg_field_t *field, int value);
 
CT_CONFIG_API void cfg_set_bool(IN_NOTNULL cfg_field_t *field, bool value);
 
CT_CONFIG_API void cfg_set_string(IN_NOTNULL cfg_field_t *field, char *value);
 
CT_CONFIG_API void cfg_vector_push(IN_NOTNULL cfg_field_t *field, char *value);
 
CT_CONFIG_API bool cfg_set_enum(IN_NOTNULL cfg_field_t *field, const char *choice);
 
CT_CONFIG_API void cfg_set_enum_value(IN_NOTNULL cfg_field_t *field, size_t value);
 
CT_NODISCARD
CT_CONFIG_API bool cfg_set_flag(IN_NOTNULL cfg_field_t *field, const char *choice, bool set);
 
CT_CONFIG_API void cfg_set_flag_value(IN_NOTNULL cfg_field_t *field, size_t value);
 
 
 
CT_END_API