confini.h

Go to the documentation of this file.

/*  -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4 -*-  */
 
#ifndef __CONFINI_H__
#define __CONFINI_H__
 
 
 
#include <stdio.h>
#include <stdbool.h>
#include <stdint.h>
 
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
/*  PRIVATE (HEADER-SCOPED) MACROS  */
 
 
#ifdef _LIBCONFINI_NOCCWARN_
#define _LIBCONFINI_DO_PRAGMA_(PBODY)
#define _LIBCONFINI_WARNING_(MSG)
#elif defined(_MSC_VER)
#define _LIBCONFINI_DO_PRAGMA_(PBODY) __pragma(PBODY)
#define _LIBCONFINI_WARNING_(MSG) _LIBCONFINI_DO_PRAGMA_(message("*WARNING*: " MSG))
#else
#define _LIBCONFINI_DO_PRAGMA_(PBODY) _Pragma(#PBODY)
#define _LIBCONFINI_WARNING_(MSG) _LIBCONFINI_DO_PRAGMA_(GCC warning #MSG)
#endif
 
#define __INIFORMAT_TABLE_CB_FIELDS__(NAME, OFFSET, SIZE, DEFVAL) \
    unsigned char NAME:SIZE;
#define __INIFORMAT_TABLE_CB_DEFAULT__(NAME, OFFSET, SIZE, DEFVAL) DEFVAL,
#define __INIFORMAT_TABLE_CB_ZERO__(NAME, OFFSET, SIZE, DEFVAL) 0,
#define _LIBCONFINI_INIFORMAT_TYPE_ \
    struct IniFormat { INIFORMAT_TABLE_AS(__INIFORMAT_TABLE_CB_FIELDS__) }
#define _LIBCONFINI_DEFAULT_FORMAT_ \
    { INIFORMAT_TABLE_AS(__INIFORMAT_TABLE_CB_DEFAULT__) }
#define _LIBCONFINI_UNIXLIKE_FORMAT_ \
    { INIFORMAT_TABLE_AS(__INIFORMAT_TABLE_CB_ZERO__) }
 
 
 
/*  PUBLIC MACROS  */
 
 
/*
    NOTE: The following table and the order of its rows **define** (and link
    together) both the #IniFormat and #IniFormatNum data types declared in this
    header
*/
#define INIFORMAT_TABLE_AS(_____)                /*  IniFormat table  *\
 
       NAME                      BIT  SIZE DEFAULT
                                                                     */\
_____( delimiter_symbol,         0,   7,   INI_EQUALS                ) \
_____( case_sensitive,           7,   1,   false                     )/*
                                                                     */\
_____( semicolon_marker,         8,   2,   INI_DISABLED_OR_COMMENT   ) \
_____( hash_marker,              10,  2,   INI_DISABLED_OR_COMMENT   ) \
_____( section_paths,            12,  2,   INI_ABSOLUTE_AND_RELATIVE ) \
_____( multiline_nodes,          14,  2,   INI_MULTILINE_EVERYWHERE  )/*
                                                                     */\
_____( no_single_quotes,         16,  1,   false                     ) \
_____( no_double_quotes,         17,  1,   false                     ) \
_____( no_spaces_in_names,       18,  1,   false                     ) \
_____( implicit_is_not_empty,    19,  1,   false                     ) \
_____( do_not_collapse_values,   20,  1,   false                     ) \
_____( preserve_empty_quotes,    21,  1,   false                     ) \
_____( disabled_after_space,     22,  1,   false                     ) \
_____( disabled_can_be_implicit, 23,  1,   false                     )
 
 
 
#define INIFORMAT_HAS_NO_ESC(FORMAT) \
    (FORMAT.multiline_nodes == INI_NO_MULTILINE && \
    FORMAT.no_double_quotes && FORMAT.no_single_quotes)
 
 
#define INI_IS_IMPLICIT_SUBSTR(CHAR_PTR) \
    (CHAR_PTR >= INI_GLOBAL_IMPLICIT_VALUE && CHAR_PTR <= \
    INI_GLOBAL_IMPLICIT_VALUE + INI_GLOBAL_IMPLICIT_V_LEN)
 
 
 
/*  PUBLIC TYPEDEFS  */
 
 
typedef _LIBCONFINI_INIFORMAT_TYPE_ IniFormat;
 
 
typedef struct IniStatistics {
    const IniFormat format;
    const size_t bytes;
    const size_t members;
} IniStatistics;
 
 
typedef struct IniDispatch {
    const IniFormat format;
    uint_least8_t type;
    char * data;
    char * value;
    const char * append_to;
    size_t d_len;
    size_t v_len;
    size_t at_len;
    size_t dispatch_id;
} IniDispatch;
 
 
typedef uint_least32_t IniFormatNum;
 
 
typedef int (* IniStatsHandler) (
    IniStatistics * statistics,
    void * user_data
);
 
 
typedef int (* IniDispHandler) (
    IniDispatch * dispatch,
    void * user_data
);
 
 
typedef int (* IniStrHandler) (
    char * ini_string,
    size_t string_length,
    size_t string_num,
    IniFormat format,
    void * user_data
);
 
 
typedef int (* IniSubstrHandler) (
    const char * ini_string,
    size_t fragm_offset,
    size_t fragm_length,
    size_t fragm_num,
    IniFormat format,
    void * user_data
);
 
 
 
/*  PUBLIC FUNCTIONS  */
 
 
extern int strip_ini_cache (
    register char * const ini_source,
    const size_t ini_length,
    const IniFormat format,
    const IniStatsHandler f_init,
    const IniDispHandler f_foreach,
    void * const user_data
);
 
 
extern int load_ini_file (
    FILE * const ini_file,
    const IniFormat format,
    const IniStatsHandler f_init,
    const IniDispHandler f_foreach,
    void * const user_data
);
 
 
extern int load_ini_path (
    const char * const path,
    const IniFormat format,
    const IniStatsHandler f_init,
    const IniDispHandler f_foreach,
    void * const user_data
);
 
 
extern bool ini_string_match_ss (
    const char * const simple_string_a,
    const char * const simple_string_b,
    const IniFormat format
);
 
 
extern bool ini_string_match_si (
    const char * const simple_string,
    const char * const ini_string,
    const IniFormat format
);
 
 
extern bool ini_string_match_ii (
    const char * const ini_string_a,
    const char * const ini_string_b,
    const IniFormat format
);
 
 
extern bool ini_array_match (
    const char * const ini_string_a,
    const char * const ini_string_b,
    const char delimiter,
    const IniFormat format
);
 
 
extern size_t ini_unquote (
    char * const ini_string,
    const IniFormat format
);
 
 
extern size_t ini_string_parse (
    char * const ini_string,
    const IniFormat format
);
 
 
extern size_t ini_array_get_length (
    const char * const ini_string,
    const char delimiter,
    const IniFormat format
);
 
 
extern int ini_array_foreach (
    const char * const ini_string,
    const char delimiter,
    const IniFormat format,
    const IniSubstrHandler f_foreach,
    void * const user_data
);
 
 
extern size_t ini_array_shift (
    const char ** const ini_strptr,
    const char delimiter,
    const IniFormat format
);
 
 
extern size_t ini_array_collapse (
    char * const ini_string,
    const char delimiter,
    const IniFormat format
);
 
 
extern char * ini_array_break (
    char * const ini_string,
    const char delimiter,
    const IniFormat format
);
 
 
extern char * ini_array_release (
    char ** const ini_strptr,
    const char delimiter,
    const IniFormat format
);
 
 
extern int ini_array_split (
    char * const ini_string,
    const char delimiter,
    const IniFormat format,
    const IniStrHandler f_foreach,
    void * const user_data
);
 
 
extern void ini_global_set_lowercase_mode (
    const bool lowercase
);
#define __ini_global_set_lowercase_mode \
    _LIBCONFINI_WARNING_("deprecated function `ini_global_set_lowercase_mode()`") \
    ini_global_set_lowercase_mode
 
 
extern void ini_global_set_implicit_value (
    char * const implicit_value,
    const size_t implicit_v_len
);
 
 
extern IniFormatNum ini_fton (
    const IniFormat format
);
 
 
extern IniFormat ini_ntof (
    const IniFormatNum format_id
);
 
 
extern int ini_get_bool (
    const char * const simple_string,
    const int when_fail
);
 
 
extern int ini_get_bool_i (
    const char * const ini_string,
    const int when_fail,
    const IniFormat format
);
 
 
 
/*  PUBLIC LINKS  */
 
 
extern int (* const ini_get_int) (
    const char * ini_string
);
 
 
extern long int (* const ini_get_lint) (
    const char * ini_string
);
 
 
extern long long int (* const ini_get_llint) (
    const char * ini_string
);
 
 
extern double (* const ini_get_double) (
    const char * ini_string
);
 
 
/*
    Legacy support -- please **do not use these functions**!
*/
extern double (* const ini_get_float) (const char * ini_string);
 
#define __ini_get_float \
    _LIBCONFINI_WARNING_("function `ini_get_float()` is deprecated for parsing a `double` data type; use `ini_get_double()` instead") \
    ini_get_double
 
 
 
/*  PUBLIC CONSTANTS AND VARIABLES  */
 
 
#define CONFINI_ERROR 252
 
 
enum ConfiniInterruptNo {
    CONFINI_SUCCESS = 0,    
    CONFINI_IINTR = 1,      
    CONFINI_FEINTR = 2,     
    CONFINI_ENOENT = 4,     
    CONFINI_ENOMEM = 5,     
    CONFINI_EIO = 6,        
    CONFINI_EOOR = 7,       
    CONFINI_EBADF = 8,      
    CONFINI_EFBIG = 9,      
    CONFINI_EROADDR = 10    
};
 
 
#define INI_DISABLED_FLAG 4
 
 
enum IniNodeType {
    INI_UNKNOWN = 0,            
    INI_VALUE = 1,              
    INI_KEY = 2,                
    INI_SECTION = 3,            
    INI_COMMENT = 4,            
    INI_INLINE_COMMENT = 5,     
    INI_DISABLED_KEY = 6,       
    INI_DISABLED_SECTION = 7    
};
 
 
enum IniDelimiters {
    INI_ANY_SPACE = 0,  
    INI_EQUALS = '=',   
    INI_COLON = ':',    
    INI_DOT = '.',      
    INI_COMMA = ','     
};
 
 
enum IniCommentMarker {
    INI_DISABLED_OR_COMMENT = 0,    
    INI_ONLY_COMMENT = 1,           
    INI_IGNORE = 2,                 
    INI_IS_NOT_A_MARKER = 3         
};
 
 
enum IniSectionPaths {
    INI_ABSOLUTE_AND_RELATIVE = 0,  
    INI_ABSOLUTE_ONLY = 1,          
    INI_ONE_LEVEL_ONLY = 2,         
    INI_NO_SECTIONS = 3             
};
 
 
enum IniMultiline {
    INI_MULTILINE_EVERYWHERE = 0,       
    INI_BUT_COMMENTS = 1,               
    INI_BUT_DISABLED_AND_COMMENTS = 2,  
    INI_NO_MULTILINE = 3                
};
 
 
static const IniFormat INI_DEFAULT_FORMAT = { INI_EQUALS, false, INI_DISABLED_OR_COMMENT, INI_DISABLED_OR_COMMENT, INI_ABSOLUTE_AND_RELATIVE, INI_MULTILINE_EVERYWHERE, false, false, false, false, false, false, false, false };
 
 
/*  All fields are set to `0` here.  */
static const IniFormat INI_UNIXLIKE_FORMAT = { INI_ANY_SPACE, false, INI_DISABLED_OR_COMMENT, INI_DISABLED_OR_COMMENT, INI_ABSOLUTE_AND_RELATIVE, INI_MULTILINE_EVERYWHERE, false, false, false, false, false, false, false, false };
 
 
extern bool INI_GLOBAL_LOWERCASE_MODE;
#define __INI_GLOBAL_LOWERCASE_MODE \
    _LIBCONFINI_WARNING_("global variable `INI_GLOBAL_LOWERCASE_MODE` is deprecated") \
    INI_GLOBAL_LOWERCASE_MODE
 
 
extern char * INI_GLOBAL_IMPLICIT_VALUE;
 
 
extern size_t INI_GLOBAL_IMPLICIT_V_LEN;
 
 
 
/*  CLEAN THE PRIVATE ENVIRONMENT  */
 
 
#undef _LIBCONFINI_UNIXLIKE_FORMAT_
#undef _LIBCONFINI_DEFAULT_FORMAT_
#undef _LIBCONFINI_INIFORMAT_TYPE_
#undef __INIFORMAT_TABLE_CB_ZERO__
#undef __INIFORMAT_TABLE_CB_DEFAULT__
#undef __INIFORMAT_TABLE_CB_FIELDS__
 
 
 
/*  END OF `__CONFINI_H__`  */
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif
 
 
/*  EOF  */