setup.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_setup_api.h>
 
#include "core/analyze.h"
#include "core/version_def.h"
#include "format/format.h"
 
#include <stdbool.h>
 
typedef struct arena_t arena_t;
typedef struct io_t io_t;
typedef struct ap_t ap_t;
typedef struct vector_t vector_t;
typedef struct colour_pallete_t colour_pallete_t;
 
typedef struct cfg_group_t cfg_group_t;
typedef struct cfg_field_t cfg_field_t;
 
CT_BEGIN_API
 
 
typedef struct setup_options_t
{
    version_info_t version;
    cfg_group_t *root;
    ap_t *ap;
 
    struct {
        cfg_group_t *group;
 
        cfg_field_t *help;
 
        cfg_field_t *version;
    } general;
 
    struct {
        cfg_group_t *group;
 
        cfg_field_t *header;
 
        cfg_field_t *colour;
    } report;
 
    struct {
        cfg_group_t *group;
 
        cfg_field_t *verbose;
    } debug;
} setup_options_t;
 
typedef struct setup_init_t
{
    int argc;
    const char **argv;
 
    int exitcode;
 
    vector_t *posargs;
 
    const colour_pallete_t *pallete;
 
    heading_style_t heading;
} setup_init_t;
 
CT_SETUP_API void setup_default(arena_t *arena);
 
CT_SETUP_API setup_options_t setup_options(version_info_t info, cfg_group_t *root);
 
CT_SETUP_API setup_init_t setup_parse(int argc, const char **argv, setup_options_t setup);
 
 
CT_PUREFN
CT_SETUP_API bool setup_should_exit(IN_NOTNULL const setup_init_t *init);
 
CT_PUREFN
CT_SETUP_API int setup_exit_code(IN_NOTNULL const setup_init_t *init);
 
CT_SETUP_API int setup_exit_help(setup_options_t setup, IN_NOTNULL const setup_init_t *init);
 
 
CT_END_API