/*
 * Copyright (c) 2020 YuQing <384681@qq.com>
 *
 * This program is free software: you can use, redistribute, and/or modify
 * it under the terms of the Lesser GNU General Public License, version 3
 * or later ("LGPL"), as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * You should have received a copy of the Lesser GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

//ini_file_reader.h
#ifndef INI_FILE_READER_H
#define INI_FILE_READER_H

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "common_define.h"
#include "hash.h"

#define FAST_INI_ITEM_NAME_LEN		63
#define FAST_INI_ITEM_VALUE_LEN		255
#define FAST_INI_ITEM_NAME_SIZE		(FAST_INI_ITEM_NAME_LEN + 1)
#define FAST_INI_ITEM_VALUE_SIZE    (FAST_INI_ITEM_VALUE_LEN + 1)

#define FAST_INI_ANNOTATION_WITHOUT_BUILTIN 0
#define FAST_INI_ANNOTATION_DISABLE         1
#define FAST_INI_ANNOTATION_WITH_BUILTIN    2
#define FAST_INI_ANNOTATION_NONE  FAST_INI_ANNOTATION_DISABLE

#define FAST_INI_FLAGS_NONE                         0
#define FAST_INI_FLAGS_SHELL_EXECUTE                1
#define FAST_INI_FLAGS_DISABLE_SAME_SECTION_MERGE   2

typedef bool (*IniSectionNameFilterFunc)(const char *section_name,
        const int name_len, void *args);

#define FAST_INI_SET_FULL_CTX_EX(ctx, config_file, sname, ini_context) \
    do { \
        ctx.filename = config_file; \
        ctx.section_name = sname;   \
        ctx.context = ini_context;  \
    } while (0)

#define FAST_INI_SET_FULL_CTX(ctx, config_file, sname) \
    FAST_INI_SET_FULL_CTX_EX(ctx, config_file, sname, NULL)

typedef struct ini_item
{
	char name[FAST_INI_ITEM_NAME_SIZE];
	char value[FAST_INI_ITEM_VALUE_SIZE];
} IniItem;

typedef struct ini_section
{
	IniItem *items;
	int count;  //item count
	int alloc;
} IniSection;

typedef struct ini_section_info
{
    char section_name[FAST_INI_ITEM_NAME_SIZE];
    IniSection *pSection;
} IniSectionInfo;

typedef struct ini_context
{
	IniSection global;
	HashArray sections;  //key is session name, and value is IniSection
	IniSection *current_section; //for load from ini file
	char config_path[MAX_PATH_SIZE];  //save the config filepath
    char annotation_type;
    char flags;
} IniContext;

typedef struct ini_full_context
{
    const char *filename;
    const char *section_name;
    IniContext *context;
} IniFullContext;

typedef struct ini_annotation_entry {
    char *func_name;
    void *arg;
    void *dlhandle;

    int (*func_init) (struct ini_annotation_entry *annotation);
    void (*func_destroy) (struct ini_annotation_entry *annotation);
    int (*func_get) (IniContext *context,
            struct ini_annotation_entry *annotation,
            const IniItem *item,
            char **pOutValue, int max_values);

    void (*func_free) (struct ini_annotation_entry *annotation,
            char **values, const int count);

    bool inited;
} AnnotationEntry;

#ifdef __cplusplus
extern "C" {
#endif

#define FAST_INI_STRING_IS_TRUE(pValue)  \
    (strcasecmp(pValue, "true") == 0 || \
     strcasecmp(pValue, "yes") == 0 ||  \
     strcasecmp(pValue, "on") == 0 ||   \
     strcmp(pValue, "1") == 0)

#define iniGetStrValue(szSectionName, szItemName, pContext) \
    iniGetStrValueEx(szSectionName, szItemName, pContext, false)

#define iniGetCharValue(szSectionName, szItemName, pContext, cDefaultValue) \
    iniGetCharValueEx(szSectionName, szItemName, \
            pContext, cDefaultValue, false)

#define iniGetIntValue(szSectionName, szItemName, pContext, nDefaultValue) \
    iniGetIntValueEx(szSectionName, szItemName, \
            pContext, nDefaultValue, false)

#define iniGetInt64Value(szSectionName, szItemName, pContext, nDefaultValue) \
    iniGetInt64ValueEx(szSectionName, szItemName, \
            pContext, nDefaultValue, false)

#define iniGetDoubleValue(szSectionName, szItemName, pContext, dbDefaultValue) \
    iniGetDoubleValueEx(szSectionName, szItemName, \
            pContext, dbDefaultValue, false)

#define iniGetBoolValue(szSectionName, szItemName, pContext, bDefaultValue) \
    iniGetBoolValueEx(szSectionName, szItemName, \
            pContext, bDefaultValue, false)

#define iniGetPercentValue(ini_ctx, item_name, item_value, default_value) \
    iniGetPercentValueEx(ini_ctx, item_name, item_value, default_value, false)

#define iniGetByteValue(szSectionName, szItemName, pContext, nDefaultValue) \
    iniGetByteValueEx(szSectionName, szItemName, \
            pContext, nDefaultValue, 1, false)

#define iniGetIntCorrectValue(ini_ctx, item_name, \
        default_value, min_value, max_value)    \
    iniGetIntCorrectValueEx(ini_ctx, item_name, \
        default_value, min_value, max_value, false)

#define iniGetInt64CorrectValue(ini_ctx, item_name, \
        default_value, min_value, max_value)      \
    iniGetInt64CorrectValueEx(ini_ctx, item_name, \
        default_value, min_value, max_value, false)

#define iniGetByteCorrectValue(ini_ctx, item_name, \
        default_value, min_value, max_value)     \
    iniGetByteCorrectValueEx(ini_ctx, item_name, \
            default_value, 1, min_value, max_value, false)

#define iniGetDoubleCorrectValue(ini_ctx, item_name, \
        default_value, min_value, max_value)       \
    iniGetDoubleCorrectValueEx(ini_ctx, item_name, \
            default_value, 1, min_value, max_value, false)

#define iniGetPercentCorrectValue(ini_ctx, item_name,    \
        item_value, default_value, min_value, max_value) \
    iniGetPercentCorrectValueEx(ini_ctx, item_name, item_value, \
        default_value, min_value, max_value, false)

int iniSetAnnotationCallBack(AnnotationEntry *annotations, int count);
void iniDestroyAnnotationCallBack();

void iniAnnotationFreeValues(struct ini_annotation_entry *annotation,
        char **values, const int count);

/** load ini items from file
 *  parameters:
 *           szFilename: the filename, can be an URL
 *           pContext: the ini context
 *  return: error no, 0 for success, != 0 fail
*/
int iniLoadFromFile(const char *szFilename, IniContext *pContext);

/** load ini items from file with flags
 *  parameters:
 *           szFilename: the filename, can be an URL
 *           pContext: the ini context
 *           flags: the flags
 *  return: error no, 0 for success, != 0 fail
*/
int iniLoadFromFile1(const char *szFilename,
        IniContext *pContext, const char flags);

/** load ini items from file
 *  parameters:
 *           szFilename: the filename, can be an URL
 *           pContext: the ini context
 *           annotation_type: the annotation type
 *           annotations: the annotations, can be NULL
 *           count: the annotation count
 *           flags: the flags
 *  return: error no, 0 for success, != 0 fail
*/
int iniLoadFromFileEx(const char *szFilename, IniContext *pContext,
    const char annotation_type, AnnotationEntry *annotations, const int count,
    const char flags);

/** load ini items from string buffer
 *  parameters:
 *           content: the string buffer to parse
 *           pContext: the ini context
 *  return: error no, 0 for success, != 0 fail
*/
int iniLoadFromBuffer(char *content, IniContext *pContext);

/** load ini items from string buffer
 *  parameters:
 *           content: the string buffer to parse
 *           pContext: the ini context
 *           annotation_type: the annotation type
 *           annotations: the annotations, can be NULL
 *           count: the annotation count
 *           flags: the flags
 *  return: error no, 0 for success, != 0 fail
*/
int iniLoadFromBufferEx(char *content, IniContext *pContext,
    const char annotation_type, AnnotationEntry *annotations, const int count,
    const char flags);

/** load ini items from string buffer with flags
 *  parameters:
 *           content: the string buffer to parse
 *           pContext: the ini context
 *           flags: the flags
 *  return: error no, 0 for success, != 0 fail
*/
int iniLoadFromBuffer1(char *content, IniContext *pContext, const char flags);

/** free ini context
 *  parameters:
 *           pContext: the ini context
 *  return: none
*/
void iniFreeContext(IniContext *pContext);

/** get item string value
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: item value, return NULL when the item not exist
*/
char *iniGetStrValueEx(const char *szSectionName, const char *szItemName,
		IniContext *pContext, const bool bRetryGlobal);

/** get the first charactor
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           cDefaultValue: the default value
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: item value, return default value when the item not exist
*/
char iniGetCharValueEx(const char *szSectionName, const char *szItemName,
        IniContext *pContext, const char cDefaultValue,
        const bool bRetryGlobal);

/** get item string value
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           szValues:   string array to store the values
 *           max_values: max string array elements
 *  return: item value count
*/
int iniGetValues(const char *szSectionName, const char *szItemName, \
		IniContext *pContext, char **szValues, const int max_values);

/** get item int value (32 bits)
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           nDefaultValue: the default value
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: item value, return nDefaultValue when the item not exist
*/
int iniGetIntValueEx(const char *szSectionName,
        const char *szItemName, IniContext *pContext,
        const int nDefaultValue, const bool bRetryGlobal);

/** check and correct int value
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           nValue: the item value
 *           nMinValue: the min value to check (including)
 *           nMaxValue: the max value to check (including)
 *  return: corrected value
*/
int64_t iniCheckAndCorrectIntValue(IniFullContext *pIniContext,
        const char *szItemName, const int64_t nValue,
        const int64_t nMinValue, const int64_t nMaxValue);

/** check and correct double value
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           dValue: the item value
 *           dMinValue: the min value to check (including)
 *           dMaxValue: the max value to check (including)
 *  return: corrected value
*/
double iniCheckAndCorrectDoubleValue(IniFullContext *pIniContext,
        const char *szItemName, const double dValue,
        const double dMinValue, const double dMaxValue);

/** check and correct double value (show as percentage)
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           dValue: the item value
 *           dMinValue: the min value to check (including)
 *           dMaxValue: the max value to check (including)
 *  return: corrected value
*/
double iniCheckAndCorrectPercentValue(IniFullContext *pIniContext,
        const char *szItemName, const double dValue,
        const double dMinValue, const double dMaxValue);

/** get item correct value (32 bits integer)
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           nDefaultValue: the default value
 *           nMinValue: the min value to check (including)
 *           nMaxValue: the max value to check (including)
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: item value, return nDefaultValue when the item not exist
*/
int iniGetIntCorrectValueEx(IniFullContext *pIniContext,
        const char *szItemName, const int nDefaultValue,
        const int nMinValue, const int nMaxValue, const bool bRetryGlobal);

/** get item string value array
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           nTargetCount: store the item value count
 *  return: item value array, return NULL when the item not exist
*/
IniItem *iniGetValuesEx(const char *szSectionName, const char *szItemName,
		IniContext *pContext, int *nTargetCount);

/** get item value (64 bits integer)
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           nDefaultValue: the default value
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: int64 value, return nDefaultValue when the item not exist
*/
int64_t iniGetInt64ValueEx(const char *szSectionName,
        const char *szItemName, IniContext *pContext,
        const int64_t nDefaultValue, const bool bRetryGlobal);

/** get item correct value (64 bits integer)
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           nDefaultValue: the default value
 *           nMinValue: the min value to check (including)
 *           nMaxValue: the max value to check (including)
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: int64 value, return nDefaultValue when the item not exist
*/
int64_t iniGetInt64CorrectValueEx(IniFullContext *pIniContext,
        const char *szItemName, const int64_t nDefaultValue,
        const int64_t nMinValue, const int64_t nMaxValue,
        const bool bRetryGlobal);

/** get item byte value (64 bits integer)
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           nDefaultValue: the default value
 *           nDefaultUnitBytes: the default byte unit, such as 1 for byte, 1024 for KB
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: int64 value, return nDefaultValue when the item not exist
*/
int64_t iniGetByteValueEx(const char *szSectionName,
        const char *szItemName, IniContext *pContext,
        const int64_t nDefaultValue, const int nDefaultUnitBytes,
        const bool bRetryGlobal);

/** get item correct byte value (64 bits integer)
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           nDefaultValue: the default value
 *           nDefaultUnitBytes: the default byte unit, such as 1 for byte, 1024 for KB
 *           nMinValue: the min value to check (including)
 *           nMaxValue: the max value to check (including)
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: int64 value, return nDefaultValue when the item not exist
*/
int64_t iniGetByteCorrectValueEx(IniFullContext *pIniContext,
        const char *szItemName, const int64_t nDefaultValue,
        const int nDefaultUnitBytes, const int64_t nMinValue,
        const int64_t nMaxValue, const bool bRetryGlobal);

/** get item boolean value
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           bDefaultValue: the default value
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: item boolean value, return bDefaultValue when the item not exist
*/
bool iniGetBoolValueEx(const char *szSectionName,
        const char *szItemName, IniContext *pContext,
        const bool bDefaultValue, const bool bRetryGlobal);

/** get item double value
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           dbDefaultValue: the default value
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: item value, return dbDefaultValue when the item not exist
*/
double iniGetDoubleValueEx(const char *szSectionName,
        const char *szItemName, IniContext *pContext,
        const double dbDefaultValue, const bool bRetryGlobal);

/** get item correct double value
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           dbDefaultValue: the default value
 *           dbMinValue: the min value to check (including)
 *           dbMaxValue: the max value to check (including)
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: double value, return dbDefaultValue when the item not exist
*/
double iniGetDoubleCorrectValueEx(IniFullContext *pIniContext,
        const char *szItemName, const double dbDefaultValue,
        const double dbMinValue, const double dbMaxValue,
        const bool bRetryGlobal);

/** get item percent double value
 *  parameters:
 *           ini_ctx: the full context
 *           item_name: the item name
 *           item_value: store the item value
 *           default_value: the default value
 *           retry_global: if fetch from global section when the item not exist
 *  return: error no, 0 for success, != 0 for fail
*/
int iniGetPercentValueEx(IniFullContext *ini_ctx,
        const char *item_name, double *item_value,
        const double default_value, const bool retry_global);

/** get item correct double value (show as percentage)
 *  parameters:
 *           pIniContext: the full ini context
 *           szItemName:  the item name
 *           dbItemValue: store the item value
 *           dbDefaultValue: the default value
 *           dbMinValue: the min value to check (including)
 *           dbMaxValue: the max value to check (including)
 *           bRetryGlobal: if fetch from global section when the item not exist
 *  return: error no, 0 for success, != 0 for fail
*/
int iniGetPercentCorrectValueEx(IniFullContext *pIniContext,
        const char *szItemName, double *dbItemValue,
        const double dbDefaultValue, const double dbMinValue,
        const double dbMaxValue, const bool bRetryGlobal);

/** print all items
 *  parameters:
 *           pContext:   the ini context
 *  return: none
*/
void iniPrintItems(IniContext *pContext);

/** return the path of config filename
 *  parameters:
 *           pContext:   the ini context
 *  return: the config path
*/
static inline const char *iniGetConfigPath(IniContext *pContext)
{
	return pContext->config_path;
}

/** return the section names
 *  parameters:
 *           pContext:   the ini context
 *           sections:   the section array
 *           max_size:   the max size of sections
 *           nCount:     return the section count
 *  return: errno, 0 for success, != 0 for fail
*/
int iniGetSectionNames(IniContext *pContext, IniSectionInfo *sections,
        const int max_size, int *nCount);

/** return the section names
 *  parameters:
 *           pContext:   the ini context
 *           prefix:     the prefix of section name
 *           sections:   the section array
 *           max_size:   the max size of sections
 *           nCount:     return the section count
 *  return: errno, 0 for success, != 0 for fail
*/
int iniGetSectionNamesByPrefix(IniContext *pContext, const char *szPrefix,
        IniSectionInfo *sections, const int max_size, int *nCount);

/** return the section names
 *  parameters:
 *           pContext:    the ini context
 *           filter_func: the section name filter function
 *           args:        the extra data pointer
 *           sections:    the section array
 *           max_size:    the max size of sections
 *           nCount:      return the section count
 *  return: errno, 0 for success, != 0 for fail
*/
int iniGetSectionNamesEx(IniContext *pContext, IniSectionNameFilterFunc
        filter_func, void *args, IniSectionInfo *sections,
        const int max_size, int *nCount);

/** get matched section count
 *  parameters:
 *           pContext:    the ini context
 *           filter_func: the section name filter function
 *           args:        the extra data pointer
 *  return: matched section count
*/
int iniGetSectionCountEx(IniContext *pContext, IniSectionNameFilterFunc
        filter_func, void *args);

/** get matched section count
 *  parameters:
 *           pContext:    the ini context
 *           prefix:     the prefix of section name
 *  return: matched section count
*/
int iniGetSectionCountByPrefix(IniContext *pContext, const char *szPrefix);

/** get section count
 *  parameters:
 *           pContext:    the ini context
 *  return: section count
*/
static inline int iniGetSectionCount(IniContext *pContext)
{
    return pContext->sections.item_count;
}

/** return the items of global section
 *  parameters:
 *           pContext:   the ini context
 *           nCount:     return the item count
 *  return: the global items
*/
static inline IniItem *iniGetGlobalItems(IniContext *pContext, int *nCount)
{
    *nCount = pContext->global.count;
    return pContext->global.items;
}

/** return the section items
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           pContext:   the ini context
 *           nCount:     return the item count
 *  return: the section items, NULL for not exist
*/
IniItem *iniGetSectionItems(const char *szSectionName, IniContext *pContext,
        int *nCount);

/** get item string value
 *  parameters:
 *           szSectionName: the section name, NULL or empty string for
 *                          global section
 *           szItemName: the item name
 *           pContext:   the ini context
 *           nMinLength: the min value length
 *  return: item value, return NULL when the item not exist
*/
char *iniGetRequiredStrValueEx(const char *szSectionName, const char *szItemName,
		IniContext *pContext, const int nMinLength);

static inline char *iniGetRequiredStrValue(const char *szSectionName,
        const char *szItemName, IniContext *pContext)
{
    const int nMinLength = 1;
    return iniGetRequiredStrValueEx(szSectionName, szItemName, pContext, nMinLength);
}

#ifdef __cplusplus
}
#endif

#endif