env.h

Go to the documentation of this file.

#pragma once
#include "io.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

// TYPES

typedef enum {
  sys_env_signal_none = 0,  
  sys_env_signal_term = 1u, 
  sys_env_signal_int = 2u,  
  sys_env_signal_quit = 4u, 
} sys_env_signal_t;

typedef void (*sys_env_signal_callback_t)(sys_env_signal_t signal);

typedef enum {
  sys_env_arg_type_bool = 1,   
  sys_env_arg_type_string = 2, 
  sys_env_arg_type_int = 3,    
  sys_env_arg_type_uint = 4,   
  sys_env_arg_type_float = 5,  
} sys_env_arg_type_t;

typedef struct sys_env_arg_flag_t {
  const char *long_name;   
  const char *short_name;  
  sys_env_arg_type_t type; 
  const char *value;       
} sys_env_arg_flag_t;

#ifndef SYS_ENV_ARG_CAPACITY
#define SYS_ENV_ARG_CAPACITY 16
#endif

typedef struct sys_env_arg_t sys_env_arg_t;

// METHODS

bool sys_env_signalhandler(sys_env_signal_t mask,
                           sys_env_signal_callback_t callback);

const char *sys_env_serial(void);

const char *sys_env_name(void);

const char *sys_env_system(void);

const char *sys_env_version(void);

void sys_env_set_args(int argc, char *argv[]);

sys_env_arg_t *sys_env_arg_parse(sys_env_arg_flag_t *flags);

size_t sys_env_arg_count(sys_env_arg_t *args);

const char *sys_env_arg_string(sys_env_arg_t *args, size_t index);

bool sys_env_arg_usage(sys_env_arg_flag_t *flags, sys_iostream_t *stream);

bool sys_env_arg_parse_bool(sys_env_arg_t *args, const char *name, bool *value);

bool sys_env_arg_parse_int32(sys_env_arg_t *args, const char *name,
                             int32_t *value);

bool sys_env_arg_parse_uint32(sys_env_arg_t *args, const char *name,
                              uint32_t *value);

bool sys_env_arg_parse_int64(sys_env_arg_t *args, const char *name,
                             int64_t *value);

bool sys_env_arg_parse_uint64(sys_env_arg_t *args, const char *name,
                              uint64_t *value);

bool sys_env_arg_parse_float32(sys_env_arg_t *args, const char *name,
                               float *value);

bool sys_env_arg_parse_float64(sys_env_arg_t *args, const char *name,
                               double *value);

size_t sys_env_arg_parse_string(sys_env_arg_t *args, const char *name,
                                char *value, size_t cap);

#ifdef __cplusplus
}
#endif