ini.h File Reference

#include <stdio.h>

Go to the source code of this file.

Macros
#define	INI_HANDLER_LINENO   0
#define	INI_ALLOW_MULTILINE   1
#define	INI_ALLOW_BOM   1
#define	INI_START_COMMENT_PREFIXES   ";#"
#define	INI_ALLOW_INLINE_COMMENTS   1
#define	INI_INLINE_COMMENT_PREFIXES   ";"
#define	INI_USE_STACK   1
#define	INI_MAX_LINE   200
#define	INI_ALLOW_REALLOC   0
#define	INI_INITIAL_ALLOC   200
#define	INI_STOP_ON_FIRST_ERROR   0
#define	INI_CALL_HANDLER_ON_NEW_SECTION   0
#define	INI_ALLOW_NO_VALUE   0

Typedefs
typedef int(*	ini_handler) (void *user, const char *section, const char *name, const char *value)
typedef char *(*	ini_reader) (char *str, int num, void *stream)

Functions
int	ini_parse (const char *filename, ini_handler handler, void *user)
int	ini_parse_file (FILE *file, ini_handler handler, void *user)
int	ini_parse_stream (ini_reader reader, void *stream, ini_handler handler, void *user)
int	ini_parse_string (const char *string, ini_handler handler, void *user)

Macro Definition Documentation

INI_HANDLER_LINENO

#define INI_HANDLER_LINENO   0

INI_ALLOW_MULTILINE

#define INI_ALLOW_MULTILINE   1

INI_ALLOW_BOM

#define INI_ALLOW_BOM   1

INI_START_COMMENT_PREFIXES

#define INI_START_COMMENT_PREFIXES   ";#"

INI_ALLOW_INLINE_COMMENTS

#define INI_ALLOW_INLINE_COMMENTS   1

INI_INLINE_COMMENT_PREFIXES

#define INI_INLINE_COMMENT_PREFIXES   ";"

INI_USE_STACK

#define INI_USE_STACK   1

INI_MAX_LINE

#define INI_MAX_LINE   200

INI_ALLOW_REALLOC

#define INI_ALLOW_REALLOC   0

INI_INITIAL_ALLOC

#define INI_INITIAL_ALLOC   200

INI_STOP_ON_FIRST_ERROR

#define INI_STOP_ON_FIRST_ERROR   0

INI_CALL_HANDLER_ON_NEW_SECTION

#define INI_CALL_HANDLER_ON_NEW_SECTION   0

INI_ALLOW_NO_VALUE

#define INI_ALLOW_NO_VALUE   0

Typedef Documentation

ini_handler

typedef int(* ini_handler) (void *user, const char *section, const char *name, const char *value)

ini_reader

typedef char*(* ini_reader) (char *str, int num, void *stream)

Function Documentation

ini_parse()

int ini_parse	(	const char *	filename,
		ini_handler	handler,
		void *	user
	)

{
    FILE* file;
    int error;
 
    file = fopen(filename, "r");
    if (!file)
        return -1;
    error = ini_parse_file(file, handler, user);
    fclose(file);
    return error;
}

Here is the call graph for this function:

ini_parse_file()

int ini_parse_file	(	FILE *	file,
		ini_handler	handler,
		void *	user
	)

{
    return ini_parse_stream((ini_reader)fgets, file, handler, user);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ini_parse_stream()

int ini_parse_stream	(	ini_reader	reader,
		void *	stream,
		ini_handler	handler,
		void *	user
	)

{
    /* Uses a fair bit of stack (use heap instead if you need to) */
#if INI_USE_STACK
    char line[INI_MAX_LINE];
    int max_line = INI_MAX_LINE;
#else
    char* line;
    size_t max_line = INI_INITIAL_ALLOC;
#endif
#if INI_ALLOW_REALLOC && !INI_USE_STACK
    char* new_line;
    size_t offset;
#endif
    char section[MAX_SECTION] = "";
    char prev_name[MAX_NAME] = "";
 
    char* start;
    char* end;
    char* name;
    char* value;
    int lineno = 0;
    int error = 0;
 
#if !INI_USE_STACK
    line = (char*)malloc(INI_INITIAL_ALLOC);
    if (!line) {
        return -2;
    }
#endif
 
#if INI_HANDLER_LINENO
#define HANDLER(u, s, n, v) handler(u, s, n, v, lineno)
#else
#define HANDLER(u, s, n, v) handler(u, s, n, v)
#endif
 
    /* Scan through stream line by line */
    while (reader(line, (int)max_line, stream) != NULL) {
#if INI_ALLOW_REALLOC && !INI_USE_STACK
        offset = strlen(line);
        while (offset == max_line - 1 && line[offset - 1] != '\n') {
            max_line *= 2;
            if (max_line > INI_MAX_LINE)
                max_line = INI_MAX_LINE;
            new_line = realloc(line, max_line);
            if (!new_line) {
                free(line);
                return -2;
            }
            line = new_line;
            if (reader(line + offset, (int)(max_line - offset), stream) == NULL)
                break;
            if (max_line >= INI_MAX_LINE)
                break;
            offset += strlen(line + offset);
        }
#endif
 
        lineno++;
 
        start = line;
#if INI_ALLOW_BOM
        if (lineno == 1 && (unsigned char)start[0] == 0xEF &&
                           (unsigned char)start[1] == 0xBB &&
                           (unsigned char)start[2] == 0xBF) {
            start += 3;
        }
#endif
        start = lskip(rstrip(start));
 
        if (strchr(INI_START_COMMENT_PREFIXES, *start)) {
            /* Start-of-line comment */
        }
#if INI_ALLOW_MULTILINE
        else if (*prev_name && *start && start > line) {
            /* Non-blank line with leading whitespace, treat as continuation
               of previous name's value (as per Python configparser). */
            if (!HANDLER(user, section, prev_name, start) && !error)
                error = lineno;
        }
#endif
        else if (*start == '[') {
            /* A "[section]" line */
            end = find_chars_or_comment(start + 1, "]");
            if (*end == ']') {
                *end = '\0';
                strncpy0(section, start + 1, sizeof(section));
                *prev_name = '\0';
#if INI_CALL_HANDLER_ON_NEW_SECTION
                if (!HANDLER(user, section, NULL, NULL) && !error)
                    error = lineno;
#endif
            }
            else if (!error) {
                /* No ']' found on section line */
                error = lineno;
            }
        }
        else if (*start) {
            /* Not a comment, must be a name[=:]value pair */
            end = find_chars_or_comment(start, "=:");
            if (*end == '=' || *end == ':') {
                *end = '\0';
                name = rstrip(start);
                value = end + 1;
#if INI_ALLOW_INLINE_COMMENTS
                end = find_chars_or_comment(value, NULL);
                if (*end)
                    *end = '\0';
#endif
                value = lskip(value);
                rstrip(value);
 
                /* Valid name[=:]value pair found, call handler */
                strncpy0(prev_name, name, sizeof(prev_name));
                if (!HANDLER(user, section, name, value) && !error)
                    error = lineno;
            }
            else if (!error) {
                /* No '=' or ':' found on name[=:]value line */
#if INI_ALLOW_NO_VALUE
                *end = '\0';
                name = rstrip(start);
                if (!HANDLER(user, section, name, NULL) && !error)
                    error = lineno;
#else
                error = lineno;
#endif
            }
        }
 
#if INI_STOP_ON_FIRST_ERROR
        if (error)
            break;
#endif
    }
 
#if !INI_USE_STACK
    free(line);
#endif
 
    return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ini_parse_string()

int ini_parse_string	(	const char *	string,
		ini_handler	handler,
		void *	user
	)

                                                                          {
    ini_parse_string_ctx ctx;
 
    ctx.ptr = string;
    ctx.num_left = strlen(string);
    return ini_parse_stream((ini_reader)ini_reader_string, &ctx, handler,
                            user);
}

Here is the call graph for this function:

Here is the caller graph for this function: