iniparser/src/iniparser.h

Parser for ini files. [詳細]

ソースコードを見る。

関数
int	iniparser_getnsec (dictionary *d)
	Get number of sections in a dictionary
char *	iniparser_getsecname (dictionary *d, int n)
	Get name for section n in a dictionary.
void	iniparser_dump_ini (dictionary *d, FILE *f)
	Save a dictionary to a loadable ini file
void	iniparser_dump (dictionary *d, FILE *f)
	Dump a dictionary to an opened file pointer.
char *	iniparser_getstr (dictionary *d, const char *key)
	Get the string associated to a key, return NULL if not found
char *	iniparser_getstring (dictionary *d, const char *key, char *def)
	Get the string associated to a key
int	iniparser_getint (dictionary *d, const char *key, int notfound)
	Get the string associated to a key, convert to an int
double	iniparser_getdouble (dictionary *d, char *key, double notfound)
	Get the string associated to a key, convert to a double
int	iniparser_getboolean (dictionary *d, const char *key, int notfound)
	Get the string associated to a key, convert to a boolean
int	iniparser_setstr (dictionary *ini, char *entry, char *val)
	Set an entry in a dictionary.
void	iniparser_unset (dictionary *ini, char *entry)
	Delete an entry in a dictionary
int	iniparser_find_entry (dictionary *ini, char *entry)
	Finds out if a given entry exists in a dictionary
dictionary *	iniparser_load (const char *ininame)
	Parse an ini file and return an allocated dictionary object
void	iniparser_freedict (dictionary *d)
	Free all memory associated to an ini dictionary

---

説明

Parser for ini files.

作者:

N. Devillard

日付:

Mar 2000

バージョン:

Revision

1.20

iniparser.h で定義されています。

---

関数

int iniparser_getnsec

(

dictionary *

d

)

Get number of sections in a dictionary

引数:

d

Dictionary to examine

戻り値:

int Number of sections found in dictionary

This function returns the number of sections found in a dictionary. The test to recognize sections is done on the string stored in the dictionary: a section name is given as "section" whereas a key is stored as "section:key", thus the test looks for entries that do not contain a colon.

This clearly fails in the case a section name contains a colon, but this should simply be avoided.

This function returns -1 in case of error.

iniparser.c の 74 行で定義されています。

参照先 _dictionary_::key・_dictionary_::size.

参照元 iniparser_dump_ini().

{
    int i ;
    int nsec ;

    if (d==NULL) return -1 ;
    nsec=0 ;
    for (i=0 ; i<d->size ; i++) {
        if (d->key[i]==NULL)
            continue ;
        if (strchr(d->key[i], ':')==NULL) {
            nsec ++ ;
        }
    }
    return nsec ;
}

char* iniparser_getsecname	(	dictionary *	d,
		int	n
	)

Get name for section n in a dictionary.

引数:

	d	Dictionary to examine
	n	Section number (from 0 to nsec-1).

戻り値:

Pointer to char string

This function locates the n-th section in a dictionary and returns its name as a pointer to a string statically allocated inside the dictionary. Do not free or modify the returned string!

This function returns NULL in case of error.

iniparser.c の 107 行で定義されています。

参照先 _dictionary_::key・_dictionary_::size.

参照元 iniparser_dump_ini().

{
    int i ;
    int foundsec ;

    if (d==NULL || n<0) return NULL ;
    foundsec=0 ;
    for (i=0 ; i<d->size ; i++) {
        if (d->key[i]==NULL)
            continue ;
        if (strchr(d->key[i], ':')==NULL) {
            foundsec++ ;
            if (foundsec>n)
                break ;
        }
    }
    if (foundsec<=n) {
        return NULL ;
    }
    return d->key[i] ;
}

void iniparser_dump_ini	(	dictionary *	d,
		FILE *	f
	)

Save a dictionary to a loadable ini file

引数:

	d	Dictionary to dump
	f	Opened file pointer to dump to

戻り値:

void

This function dumps a given dictionary into a loadable ini file. It is Ok to specify stderr or stdout as output files.

iniparser.c の 172 行で定義されています。

参照先 fprintf()・iniparser_getnsec()・iniparser_getsecname()・_dictionary_::key・_dictionary_::size・sprintf()・_dictionary_::val.

{
    int     i, j ;
    char    keym[ASCIILINESZ+1];
    int     nsec ;
    char *  secname ;
    int     seclen ;

    if (d==NULL || f==NULL) return ;

    nsec = iniparser_getnsec(d);
    if (nsec<1) {
        /* No section in file: dump all keys as they are */
        for (i=0 ; i<d->size ; i++) {
            if (d->key[i]==NULL)
                continue ;
            fprintf(f, "%s = %s\n", d->key[i], d->val[i]);
        }
        return ;
    }
    for (i=0 ; i<nsec ; i++) {
        secname = iniparser_getsecname(d, i) ;
        seclen  = (int)strlen(secname);
        fprintf(f, "\n[%s]\n", secname);
        sprintf(keym, "%s:", secname);
        for (j=0 ; j<d->size ; j++) {
            if (d->key[j]==NULL)
                continue ;
            if (!strncmp(d->key[j], keym, seclen+1)) {
                fprintf(f,
                        "%-30s = %s\n",
                        d->key[j]+seclen+1,
                        d->val[j] ? d->val[j] : "");
            }
        }
    }
    fprintf(f, "\n");
    return ;
}

void iniparser_dump	(	dictionary *	d,
		FILE *	f
	)

Dump a dictionary to an opened file pointer.

引数:

	d	Dictionary to dump.
	f	Opened file pointer to dump to.

戻り値:

void

This function prints out the contents of a dictionary, one element by line, onto the provided file pointer. It is OK to specify stderr or stdout as output files. This function is meant for debugging purposes mostly.

iniparser.c の 143 行で定義されています。

参照先 fprintf()・_dictionary_::key・_dictionary_::size・_dictionary_::val.

参照元 parse_ini_file().

{
    int     i ;

    if (d==NULL || f==NULL) return ;
    for (i=0 ; i<d->size ; i++) {
        if (d->key[i]==NULL)
            continue ;
        if (d->val[i]!=NULL) {
            fprintf(f, "[%s]=[%s]\n", d->key[i], d->val[i]);
        } else {
            fprintf(f, "[%s]=UNDEF\n", d->key[i]);
        }
    }
    return ;
}

char* iniparser_getstr	(	dictionary *	d,
		const char *	key
	)

Get the string associated to a key, return NULL if not found

引数:

	d	Dictionary to search
	key	Key string to look for

戻り値:

pointer to statically allocated character string, or NULL.

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, NULL is returned. The returned char pointer is pointing to a string allocated in the dictionary, do not free or modify it.

This function is only provided for backwards compatibility with previous versions of iniparser. It is recommended to use iniparser_getstring() instead.

iniparser.c の 233 行で定義されています。

参照先 iniparser_getstring().

参照元 _pam_parse()・get_conf_item_string()・parse_ini_file().

{
    return iniparser_getstring(d, key, NULL);
}

char* iniparser_getstring	(	dictionary *	d,
		const char *	key,
		char *	def
	)

Get the string associated to a key

引数:

	d	Dictionary to search
	key	Key string to look for
	def	Default value to return if key not found.

戻り値:

pointer to statically allocated character string

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the pointer passed as 'def' is returned. The returned char pointer is pointing to a string allocated in the dictionary, do not free or modify it.

iniparser.c の 254 行で定義されています。

参照先 dictionary_get()・strdup()・strlwc().

参照元 iniparser_find_entry()・iniparser_getboolean()・iniparser_getdouble()・iniparser_getint()・iniparser_getstr()・parse_gpt_ini()・parse_gpttmpl().

{
    char * lc_key ;
    char * sval ;

    if (d==NULL || key==NULL)
        return def ;

    if (!(lc_key = strdup(strlwc(key)))) {
            return NULL;
    }
    sval = dictionary_get(d, lc_key, def);
    free(lc_key);
    return sval ;
}

int iniparser_getint	(	dictionary *	d,
		const char *	key,
		int	notfound
	)

Get the string associated to a key, convert to an int

引数:

	d	Dictionary to search
	key	Key string to look for
	notfound	Value to return in case of error

戻り値:

integer

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.

iniparser.c の 285 行で定義されています。

参照先 iniparser_getstring().

参照元 parse_gpt_ini()・parse_gpttmpl()・parse_gpttmpl_kerberos_policy()・parse_gpttmpl_system_access()・parse_ini_file().

{
    char    *   str ;

    str = iniparser_getstring(d, key, INI_INVALID_KEY);
    if (str==INI_INVALID_KEY) return notfound ;
    return atoi(str);
}

double iniparser_getdouble	(	dictionary *	d,
		char *	key,
		double	notfound
	)

Get the string associated to a key, convert to a double

引数:

	d	Dictionary to search
	key	Key string to look for
	notfound	Value to return in case of error

戻り値:

double

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.

iniparser.c の 308 行で定義されています。

参照先 iniparser_getstring().

参照元 parse_ini_file().

{
    char    *   str ;

    str = iniparser_getstring(d, key, INI_INVALID_KEY);
    if (str==INI_INVALID_KEY) return notfound ;
    return atof(str);
}

int iniparser_getboolean	(	dictionary *	d,
		const char *	key,
		int	notfound
	)

Get the string associated to a key, convert to a boolean

引数:

	d	Dictionary to search
	key	Key string to look for
	notfound	Value to return in case of error

戻り値:

integer

This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.

A true boolean is found if one of the following is matched:

• A string starting with 'y'
• A string starting with 'Y'
• A string starting with 't'
• A string starting with 'T'
• A string starting with '1'

A false boolean is found if one of the following is matched:

• A string starting with 'n'
• A string starting with 'N'
• A string starting with 'f'
• A string starting with 'F'
• A string starting with '0'

The notfound value returned if no boolean is identified, does not necessarily have to be 0 or 1.

iniparser.c の 351 行で定義されています。

参照先 c・iniparser_getstring().

参照元 _pam_parse()・parse_gpttmpl()・parse_gpttmpl_kerberos_policy()・parse_gpttmpl_system_access()・parse_ini_file().

{
    char    *   c ;
    int         ret ;

    c = iniparser_getstring(d, key, INI_INVALID_KEY);
    if (c==INI_INVALID_KEY) return notfound ;
    if (c[0]=='y' || c[0]=='Y' || c[0]=='1' || c[0]=='t' || c[0]=='T') {
        ret = 1 ;
    } else if (c[0]=='n' || c[0]=='N' || c[0]=='0' || c[0]=='f' || c[0]=='F') {
        ret = 0 ;
    } else {
        ret = notfound ;
    }
    return ret;
}

int iniparser_setstr	(	dictionary *	ini,
		char *	entry,
		char *	val
	)

Set an entry in a dictionary.

引数:

	ini	Dictionary to modify.
	entry	Entry to modify (entry name)
	val	New value to associate to the entry.

戻り値:

int 0 if Ok, -1 otherwise.

If the given entry can be found in the dictionary, it is modified to contain the provided value. If it cannot be found, -1 is returned. It is Ok to set val to NULL.

iniparser.c の 410 行で定義されています。

参照先 dictionary_set()・strlwc().

{
    dictionary_set(ini, strlwc(entry), val);
    return 0 ;
}

void iniparser_unset	(	dictionary *	ini,
		char *	entry
	)

Delete an entry in a dictionary

引数:

	ini	Dictionary to modify
	entry	Entry to delete (entry name)

戻り値:

void

If the given entry can be found, it is deleted from the dictionary.

iniparser.c の 426 行で定義されています。

参照先 dictionary_unset()・strlwc().

{
    dictionary_unset(ini, strlwc(entry));
}

int iniparser_find_entry	(	dictionary *	ini,
		char *	entry
	)

Finds out if a given entry exists in a dictionary

引数:

	ini	Dictionary to search
	entry	Name of the entry to look for

戻り値:

integer 1 if entry exists, 0 otherwise

Finds out if a given entry exists in the dictionary. Since sections are stored as keys with NULL associated values, this is the only way of querying for the presence of sections in a dictionary.

iniparser.c の 382 行で定義されています。

参照先 iniparser_getstring().

{
    int found=0 ;
    if (iniparser_getstring(ini, entry, INI_INVALID_KEY)!=INI_INVALID_KEY) {
        found = 1 ;
    }
    return found ;
}

dictionary* iniparser_load

(

const char *

ininame

)

Parse an ini file and return an allocated dictionary object

引数:

ininame

Name of the ini file to read.

戻り値:

Pointer to newly allocated dictionary

This is the parser for ini files. This function is called, providing the name of the file to be read. It returns a dictionary object that should not be accessed directly, but through accessor functions instead.

The returned dictionary must be freed using iniparser_freedict().

iniparser.c の 447 行で定義されています。

参照先 dictionary_new()・iniparser_add_entry()・strcrop()・strlwc()・strskp().

参照元 _pam_parse()・parse_gpt_ini()・parse_gpttmpl_kerberos_policy()・parse_gpttmpl_system_access()・parse_ini_file().

{
    dictionary  *   d ;
    char        lin[ASCIILINESZ+1];
    char        sec[ASCIILINESZ+1];
    char        key[ASCIILINESZ+1];
    char        val[ASCIILINESZ+1];
    char    *   where ;
    FILE    *   ini ;
    int         lineno ;

    if ((ini=fopen(ininame, "r"))==NULL) {
        return NULL ;
    }

    sec[0]=0;

    /*
     * Initialize a new dictionary entry
     */
    if (!(d = dictionary_new(0))) {
            fclose(ini);
            return NULL;
    }
    lineno = 0 ;
    while (fgets(lin, ASCIILINESZ, ini)!=NULL) {
        lineno++ ;
        where = strskp(lin); /* Skip leading spaces */
        if (*where==';' || *where=='#' || *where==0)
            continue ; /* Comment lines */
        else {
            if (sscanf(where, "[%[^]]", sec)==1) {
                /* Valid section name */
                strcpy(sec, strlwc(sec));
                iniparser_add_entry(d, sec, NULL, NULL);
            } else if (sscanf (where, "%[^=] = \"%[^\"]\"", key, val) == 2
                   ||  sscanf (where, "%[^=] = '%[^\']'",   key, val) == 2
                   ||  sscanf (where, "%[^=] = %[^;#]",     key, val) == 2) {
                strcpy(key, strlwc(strcrop(key)));
                /*
                 * sscanf cannot handle "" or '' as empty value,
                 * this is done here
                 */
                if (!strcmp(val, "\"\"") || !strcmp(val, "''")) {
                    val[0] = (char)0;
                } else {
                    strcpy(val, strcrop(val));
                }
                iniparser_add_entry(d, sec, key, val);
            }
        }
    }
    fclose(ini);
    return d ;
}

void iniparser_freedict

(

dictionary *

d

)

Free all memory associated to an ini dictionary

引数:

d

Dictionary to free

戻り値:

void

Free all memory associated to an ini dictionary. It is mandatory to call this function before the dictionary object gets out of the current context.

iniparser.c の 517 行で定義されています。

参照先 dictionary_del().

参照元 _pam_parse()・pam_sm_acct_mgmt()・pam_sm_authenticate()・pam_sm_chauthtok()・pam_sm_close_session()・pam_sm_open_session()・pam_sm_setcred()・parse_gpt_ini()・parse_gpttmpl_kerberos_policy()・parse_gpttmpl_system_access()・parse_ini_file().

{
    dictionary_del(d);
}

---