cfg_parser.h

Go to the documentation of this file.

/*
 * $Id$
 * Standalone Configuration File Parser
 *
 * Copyright (C) 2008 iptelorg GmbH
 * Written by Jan Janak <jan@iptel.org>
 *
 * This file is part of SER, a free SIP server.
 *
 * SER is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * SER 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.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc., 
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _CFG_PARSER_H
#define _CFG_PARSER_H

#include "str.h"
#include <stdio.h>

#define MAX_TOKEN_LEN 512 
typedef enum cfg_flags {

        CFG_EXTENDED_ALPHA = (1 << 0),

        CFG_CASE_SENSITIVE = (1 << 1), 

        CFG_DEFAULT = (1 << 2),


        CFG_PREFIX = (1 << 3),

        CFG_STR_PKGMEM = (1 << 4),

        CFG_STR_SHMMEM = (1 << 5),

        CFG_STR_MALLOC = (1 << 6),

        CFG_STR_STATIC = (1 << 7),

} cfg_flags_t;


enum cfg_token_type {
        CFG_TOKEN_EOF    = -1,
        CFG_TOKEN_ALPHA  = -2,
        CFG_TOKEN_STRING = -3
};


typedef struct cfg_token {
        char buf [MAX_TOKEN_LEN];
        int type;  
        str val;   
        struct {   
                int line; 
                int col;  
        } start, end;
} cfg_token_t;


struct cfg_parser;

typedef int (*cfg_func_f)(void* param, struct cfg_parser* st,
                                                  unsigned int flags);


typedef struct cfg_option {
        char* name;    
        unsigned int flags;
        void* param;   
        int val;       
        cfg_func_f f;  
} cfg_option_t;


typedef struct cfg_parser {
        FILE* f;                 
        char* file;              
        int line;                
        int col;                 
        struct cfg_option* options; 
        struct {
                cfg_func_f parser;   
                void* param;         
        } section;
        struct cfg_token* cur_opt; 
} cfg_parser_t;


extern struct cfg_option cfg_bool_values[];

struct cfg_parser* cfg_parser_init(str* basedir, str* filename);

void cfg_section_parser(struct cfg_parser* st, cfg_func_f parser, void* param);

void cfg_set_options(struct cfg_parser* st, struct cfg_option* options);

int sr_cfg_parse(struct cfg_parser* st);

void cfg_parser_close(struct cfg_parser* st);

struct cfg_option* cfg_lookup_token(struct cfg_option* options, str* token);

int cfg_get_token(struct cfg_token* token, struct cfg_parser* st, unsigned int flags);

/* Commonly needed parser functions */

int cfg_eat_equal(struct cfg_parser* st, unsigned int flags);

int cfg_eat_eol(struct cfg_parser* st, unsigned int flags);

int cfg_parse_section(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_str_opt(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_str(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_enum_opt(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_enum(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_int_opt(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_int(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_bool_opt(void* param, struct cfg_parser* st, unsigned int flags);

int cfg_parse_bool(void* param, struct cfg_parser* st, unsigned int flags);

#endif /* _CFG_PARSER_H */