iniparser/src/dictionary.c

Implements a dictionary for string variables. [詳細]

ソースコードを見る。

関数
static void *	mem_double (void *ptr, int size)
unsigned	dictionary_hash (char *key)
	Compute the hash key for a string.
dictionary *	dictionary_new (int size)
	Create a new dictionary object.
void	dictionary_del (dictionary *d)
	Delete a dictionary object
char *	dictionary_get (dictionary *d, char *key, char *def)
	Get a value from a dictionary.
char	dictionary_getchar (dictionary *d, char *key, char def)
	Get a value from a dictionary, as a char.
int	dictionary_getint (dictionary *d, char *key, int def)
	Get a value from a dictionary, as an int.
double	dictionary_getdouble (dictionary *d, char *key, double def)
	Get a value from a dictionary, as a double.
void	dictionary_set (dictionary *d, char *key, char *val)
	Set a value in a dictionary.
void	dictionary_unset (dictionary *d, char *key)
	Delete a key in a dictionary
void	dictionary_setint (dictionary *d, char *key, int val)
	Set a key in a dictionary, providing an int.
void	dictionary_setdouble (dictionary *d, char *key, double val)
	Set a key in a dictionary, providing a double.
void	dictionary_dump (dictionary *d, FILE *out)
	Dump a dictionary to an opened file pointer.
int	main (int argc, char *argv[])

---

説明

Implements a dictionary for string variables.

作者:

N. Devillard

日付:

Aug 2000

バージョン:

Revision

1.23

This module implements a simple dictionary object, i.e. a list of string/string associations. This object is useful to store e.g. informations retrieved from a configuration file (ini files).

dictionary.c で定義されています。

---

関数

static void* mem_double	(	void *	ptr,
		int	size
	)			[static]

dictionary.c の 51 行で定義されています。

{
    void    *   newptr ;
 
    newptr = calloc(2*size, 1);
    memcpy(newptr, ptr, size);
    free(ptr);
    return newptr ;
}

unsigned dictionary_hash

(

char *

key

)

Compute the hash key for a string.

引数:

key

Character string to use for key.

戻り値:

1 unsigned int on at least 32 bits.

This hash function has been taken from an Article in Dr Dobbs Journal. This is normally a collision-free function, distributing keys evenly. The key is stored anyway in the struct so that collision can be avoided by comparing the key itself in last resort.

dictionary.c の 79 行で定義されています。

参照先 len.

参照元 dictionary_get()・dictionary_set()・dictionary_unset().

{
        int                     len ;
        unsigned        hash ;
        int                     i ;

        len = strlen(key);
        for (hash=0, i=0 ; i<len ; i++) {
                hash += (unsigned)key[i] ;
                hash += (hash<<10);
                hash ^= (hash>>6) ;
        }
        hash += (hash <<3);
        hash ^= (hash >>11);
        hash += (hash <<15);
        return hash ;
}

dictionary* dictionary_new

(

int

size

)

Create a new dictionary object.

引数:

size

Optional initial size of the dictionary.

戻り値:

1 newly allocated dictionary objet.

This function allocates a new dictionary object of given size and returns it. If you do not know in advance (roughly) the number of entries in the dictionary, give size=0.

dictionary.c の 110 行で定義されています。

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

参照元 iniparser_load()・main().

{
        dictionary      *       d ;

        /* If no size was specified, allocate space for DICTMINSZ */
        if (size<DICTMINSZ) size=DICTMINSZ ;

        if (!(d = (dictionary *)calloc(1, sizeof(dictionary)))) {
                return NULL;
        }
        d->size = size ;
        d->val  = (char **)calloc(size, sizeof(char*));
        d->key  = (char **)calloc(size, sizeof(char*));
        d->hash = (unsigned int *)calloc(size, sizeof(unsigned));
        return d ;
}

void dictionary_del

(

dictionary *

d

)

Delete a dictionary object

引数:

d

dictionary object to deallocate.

戻り値:

void

Deallocate a dictionary object and all memory associated to it.

dictionary.c の 138 行で定義されています。

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

参照元 iniparser_freedict()・main().

{
        int             i ;

        if (d==NULL) return ;
        for (i=0 ; i<d->size ; i++) {
                if (d->key[i]!=NULL)
                        free(d->key[i]);
                if (d->val[i]!=NULL)
                        free(d->val[i]);
        }
        free(d->val);
        free(d->key);
        free(d->hash);
        free(d);
        return ;
}

char* dictionary_get	(	dictionary *	d,
		char *	key,
		char *	def
	)

Get a value from a dictionary.

引数:

	d	dictionary object to search.
	key	Key to look for in the dictionary.
	def	Default value to return if key not found.

戻り値:

1 pointer to internally allocated character string.

This function locates a key in a dictionary and returns a pointer to its value, or the passed 'def' pointer if no such key can be found in dictionary. The returned character pointer points to data internal to the dictionary object, you should not try to free it or modify it.

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

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

参照元 dictionary_getchar()・dictionary_getdouble()・dictionary_getint()・iniparser_getstring()・main().

{
        unsigned        hash ;
        int                     i ;

        hash = dictionary_hash(key);
        for (i=0 ; i<d->size ; i++) {
        if (d->key==NULL)
            continue ;
        /* Compare hash */
                if (hash==d->hash[i]) {
            /* Compare string, to avoid hash collisions */
            if (!strcmp(key, d->key[i])) {
                                return d->val[i] ;
                        }
                }
        }
        return def ;
}

char dictionary_getchar	(	dictionary *	d,
		char *	key,
		char	def
	)

Get a value from a dictionary, as a char.

引数:

	d	dictionary object to search.
	key	Key to look for in the dictionary.
	def	Default value for the key if not found.

戻り値:

char

This function locates a key in a dictionary using dictionary_get, and returns the first char of the found string.

dictionary.c の 204 行で定義されています。

参照先 dictionary_get().

{
        char * v ;

        if ((v=dictionary_get(d,key,DICT_INVALID_KEY))==DICT_INVALID_KEY) {
                return def ;
        } else {
                return v[0] ;
        }
}

int dictionary_getint	(	dictionary *	d,
		char *	key,
		int	def
	)

Get a value from a dictionary, as an int.

引数:

	d	dictionary object to search.
	key	Key to look for in the dictionary.
	def	Default value for the key if not found.

戻り値:

int

This function locates a key in a dictionary using dictionary_get, and applies atoi on it to return an int. If the value cannot be found in the dictionary, the default is returned.

dictionary.c の 229 行で定義されています。

参照先 dictionary_get().

{
        char * v ;

        if ((v=dictionary_get(d,key,DICT_INVALID_KEY))==DICT_INVALID_KEY) {
                return def ;
        } else {
                return atoi(v);
        }
}

double dictionary_getdouble	(	dictionary *	d,
		char *	key,
		double	def
	)

Get a value from a dictionary, as a double.

引数:

	d	dictionary object to search.
	key	Key to look for in the dictionary.
	def	Default value for the key if not found.

戻り値:

double

This function locates a key in a dictionary using dictionary_get, and applies atof on it to return a double. If the value cannot be found in the dictionary, the default is returned.

dictionary.c の 253 行で定義されています。

参照先 dictionary_get().

{
        char * v ;

        if ((v=dictionary_get(d,key,DICT_INVALID_KEY))==DICT_INVALID_KEY) {
                return def ;
        } else {
                return atof(v);
        }
}

void dictionary_set	(	dictionary *	d,
		char *	key,
		char *	val
	)

Set a value in a dictionary.

引数:

	d	dictionary object to modify.
	key	Key to modify or add.
	val	Value to add.

戻り値:

void

If the given key is found in the dictionary, the associated value is replaced by the provided one. If the key cannot be found in the dictionary, it is added to it.

It is Ok to provide a NULL value for val, but NULL values for the dictionary or the key are considered as errors: the function will return immediately in such a case.

Notice that if you dictionary_set a variable to NULL, a call to dictionary_get will return a NULL value: the variable will be found, and its value (NULL) is returned. In other words, setting the variable content to NULL is equivalent to deleting the variable from the dictionary. It is not possible (in this implementation) to have a key in the dictionary without value.

dictionary.c の 290 行で定義されています。

参照先 dictionary_hash()・_dictionary_::hash・_dictionary_::key・_dictionary_::n・_dictionary_::size・strdup()・_dictionary_::val.

参照元 dictionary_setdouble()・dictionary_setint()・iniparser_add_entry()・iniparser_setstr()・main().

{
        int                     i ;
        unsigned        hash ;

        if (d==NULL || key==NULL) return ;
        
        /* Compute hash for this key */
        hash = dictionary_hash(key) ;
        /* Find if value is already in blackboard */
        if (d->n>0) {
                for (i=0 ; i<d->size ; i++) {
            if (d->key[i]==NULL)
                continue ;
                        if (hash==d->hash[i]) { /* Same hash value */
                                if (!strcmp(key, d->key[i])) {   /* Same key */
                                        /* Found a value: modify and return */
                                        if (d->val[i]!=NULL)
                                                free(d->val[i]);
                    d->val[i] = val ? strdup(val) : NULL ;
                    /* Value has been modified: return */
                                        return ;
                                }
                        }
                }
        }
        /* Add a new value */
        /* See if dictionary needs to grow */
        if (d->n==d->size) {

                /* Reached maximum size: reallocate blackboard */
                d->val  = (char **)mem_double(d->val,  d->size * sizeof(char*)) ;
                d->key  = (char **)mem_double(d->key,  d->size * sizeof(char*)) ;
                d->hash = (unsigned int *)mem_double(d->hash, d->size * sizeof(unsigned)) ;

                /* Double size */
                d->size *= 2 ;
        }

    /* Insert key in the first empty slot */
    for (i=0 ; i<d->size ; i++) {
        if (d->key[i]==NULL) {
            /* Add key here */
            break ;
        }
    }
        /* Copy key */
        d->key[i]  = strdup(key);
    d->val[i]  = val ? strdup(val) : NULL ;
        d->hash[i] = hash;
        d->n ++ ;
        return ;
}

void dictionary_unset	(	dictionary *	d,
		char *	key
	)

Delete a key in a dictionary

引数:

	d	dictionary object to modify.
	key	Key to remove.

戻り値:

void

This function deletes a key in a dictionary. Nothing is done if the key cannot be found.

dictionary.c の 355 行で定義されています。

参照先 dictionary_hash()・_dictionary_::hash・_dictionary_::key・_dictionary_::size.

参照元 iniparser_unset()・main().

{
        unsigned        hash ;
        int                     i ;

        if (key == NULL) {
                return;
        }

        hash = dictionary_hash(key);
        for (i=0 ; i<d->size ; i++) {
        if (d->key[i]==NULL)
            continue ;
        /* Compare hash */
                if (hash==d->hash[i]) {
            /* Compare string, to avoid hash collisions */
            if (!strcmp(key, d->key[i])) {
                /* Found key */
                break ;
                        }
                }
        }
    if (i>=d->size)
        /* Key not found */
        return ;

    free(d->key[i]);
    d->key[i] = NULL ;
    if (d->val[i]!=NULL) {
        free(d->val[i]);
        d->val[i] = NULL ;
    }
    d->hash[i] = 0 ;
    d->n -- ;
    return ;
}

void dictionary_setint	(	dictionary *	d,
		char *	key,
		int	val
	)

Set a key in a dictionary, providing an int.

引数:

	d	Dictionary to update.
	key	Key to modify or add
	val	Integer value to store (will be stored as a string).

戻り値:

void

This helper function calls dictionary_set() with the provided integer converted to a string using d.

dictionary.c の 407 行で定義されています。

参照先 dictionary_set()・sprintf().

{
        char    sval[MAXVALSZ];
        sprintf(sval, "%d", val);
        dictionary_set(d, key, sval);
}

void dictionary_setdouble	(	dictionary *	d,
		char *	key,
		double	val
	)

Set a key in a dictionary, providing a double.

引数:

	d	Dictionary to update.
	key	Key to modify or add
	val	Double value to store (will be stored as a string).

戻り値:

void

This helper function calls dictionary_set() with the provided double converted to a string using g.

dictionary.c の 429 行で定義されています。

参照先 dictionary_set()・sprintf().

{
        char    sval[MAXVALSZ];
        sprintf(sval, "%g", val);
        dictionary_set(d, key, sval);
}

void dictionary_dump	(	dictionary *	d,
		FILE *	out
	)

Dump a dictionary to an opened file pointer.

引数:

	d	Dictionary to dump
	f	Opened file pointer.

戻り値:

void

Dumps a dictionary onto an opened file pointer. Key pairs are printed out as [Key]=[Value], one per line. It is Ok to provide stdout or stderr as output file pointers.

dictionary.c の 451 行で定義されています。

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

{
        int             i ;

        if (d==NULL || out==NULL) return ;
        if (d->n<1) {
                fprintf(out, "empty dictionary\n");
                return ;
        }
        for (i=0 ; i<d->size ; i++) {
        if (d->key[i]) {
            fprintf(out, "%20s\t[%s]\n",
                    d->key[i],
                    d->val[i] ? d->val[i] : "UNDEF");
        }
        }
        return ;
}

int main	(	int	argc,
		char *	argv[]
	)

dictionary.c の 475 行で定義されています。

参照先 dictionary_del()・dictionary_get()・dictionary_new()・dictionary_set()・dictionary_unset()・_dictionary_::n・printf()・sprintf().

{
        dictionary      *       d ;
        char    *       val ;
        int                     i ;
        char            cval[90] ;

        /* allocate blackboard */
        printf("allocating...\n");
        d = dictionary_new(0);
        
        /* Set values in blackboard */
        printf("setting %d values...\n", NVALS);
        for (i=0 ; i<NVALS ; i++) {
                sprintf(cval, "%04d", i);
                dictionary_set(d, cval, "salut");
        }
        printf("getting %d values...\n", NVALS);
        for (i=0 ; i<NVALS ; i++) {
                sprintf(cval, "%04d", i);
                val = dictionary_get(d, cval, DICT_INVALID_KEY);
                if (val==DICT_INVALID_KEY) {
                        printf("cannot get value for key [%s]\n", cval);
                }
        }
    printf("unsetting %d values...\n", NVALS);
        for (i=0 ; i<NVALS ; i++) {
                sprintf(cval, "%04d", i);
                dictionary_unset(d, cval);
        }
    if (d->n != 0) {
        printf("error deleting values\n");
    }

        printf("deallocating...\n");
        dictionary_del(d);
        return 0 ;
}

---