iniparser.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "iniparser.h"

Include dependency graph for iniparser.c:

Go to the source code of this file.

Defines

#define ASCIILINESZ   1024
#define ASCIILINESZ   1024
#define DICT_INVALID_KEY   ((char*)-1)
#define DICTMINSZ   128
#define INI_INVALID_KEY   ((char*)-1)
#define MAXVALSZ   1024
 Remove blanks at the beginning and the end of a string.

Functions

static void dictionary_del (dictionary *d)
 Delete a dictionary object.
static void dictionary_dump (dictionary *d, FILE *f)
 Dump a dictionary to an opened file pointer.
static char * dictionary_get (dictionary *d, char *key, char *def)
 Get a value from a dictionary.
static unsigned dictionary_hash (char *key)
 Compute the hash key for a string.
static dictionary * dictionary_new (int size)
 Create a new dictionary object.
static void dictionary_set (dictionary *d, char *key, char *val)
 Set a value in a dictionary.
static void dictionary_unset (dictionary *d, char *key)
 Delete a key in a dictionary.
static void iniparser_add_entry (dictionary *d, char *sec, char *key, char *val)
void iniparser_dump (dictionary *d, FILE *f)
 Dump a dictionary to an opened file pointer.
void iniparser_dump_ini (dictionary *d, FILE *f)
 Save a dictionary to a loadable ini file.
int iniparser_find_entry (dictionary *ini, char *entry)
 Finds out if a given entry exists in a dictionary.
void iniparser_free (dictionary *d)
 Free all memory associated to an ini dictionary.
int iniparser_getboolean (dictionary *d, char *key, int notfound)
 Get the string associated to a key, convert to a boolean.
double iniparser_getdouble (dictionary *d, char *key, double notfound)
 Get the string associated to a key, convert to a double.
int iniparser_getint (dictionary *d, char *key, int notfound)
 Get the string associated to a key, convert to an int.
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.
char * iniparser_getstr (dictionary *d, char *key)
 Get the string associated to a key, return NULL if not found.
char * iniparser_getstring (dictionary *d, char *key, char *def)
 Get the string associated to a key.
dictionary * iniparser_new (char *ininame)
 Parse an ini file and return an allocated dictionary object.
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.
static void * mem_double (void *ptr, int size)
static char * strcrop (char *s)
 Remove blanks at the end of a string.
static char * strlwc (char *s)
 Convert a string to lowercase.
static char * strskp (char *s)
 Convert a string to uppercase.

Define Documentation

#define ASCIILINESZ   1024

Definition at line 550 of file iniparser.c.

#define ASCIILINESZ   1024

Definition at line 550 of file iniparser.c.

Referenced by iniparser_add_entry(), iniparser_dump_ini(), iniparser_new(), strcrop(), and strlwc().

#define DICT_INVALID_KEY   ((char*)-1)

Invalid key token

Definition at line 244 of file iniparser.c.

#define DICTMINSZ   128

Minimal allocated number of entries in a dictionary

Definition at line 241 of file iniparser.c.

Referenced by dictionary_new().

#define INI_INVALID_KEY   ((char*)-1)

Definition at line 551 of file iniparser.c.

Referenced by iniparser_find_entry(), iniparser_getboolean(), iniparser_getdouble(), and iniparser_getint().

#define MAXVALSZ   1024

Remove blanks at the beginning and the end of a string.

Parameters:
s String to parse.
Returns:
ptr to statically allocated string.
This function returns a pointer to a statically allocated string, which is identical to the input string, except that all blank characters at the end and the beg. of the string have been removed. Do not free or modify the returned string! Since the returned string is statically allocated, it will be modified at each function call (not re-entrant). Maximum value size for integers and doubles.

Definition at line 238 of file iniparser.c.

Function Documentation

static void dictionary_del ( dictionary *  d  )  [static]

Delete a dictionary object.

Parameters:
d dictionary object to deallocate.
Returns:
void
Deallocate a dictionary object and all memory associated to it.

Definition at line 336 of file iniparser.c.

References _dictionary_::hash, _dictionary_::key, NULL, _dictionary_::size, and _dictionary_::val.

Referenced by iniparser_free().

static void dictionary_dump ( dictionary *  d,
FILE *  f 
) [static]

Dump a dictionary to an opened file pointer.

Parameters:
d Dictionary to dump
f Opened file pointer.
Returns:
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.

Definition at line 529 of file iniparser.c.

References _dictionary_::key, NULL, _dictionary_::size, and _dictionary_::val.

Referenced by iniparser_dump().

static char* dictionary_get ( dictionary *  d,
char *  key,
char *  def 
) [static]

Get a value from a dictionary.

Parameters:
d dictionary object to search.
key Key to look for in the dictionary.
def Default value to return if key not found.
Returns:
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.

Definition at line 371 of file iniparser.c.

References dictionary_hash(), _dictionary_::hash, hash, _dictionary_::key, NULL, _dictionary_::size, and _dictionary_::val.

Referenced by iniparser_getstring().

static unsigned dictionary_hash ( char *  key  )  [static]

Compute the hash key for a string.

Parameters:
key Character string to use for key.
Returns:
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.

Definition at line 278 of file iniparser.c.

References hash, and len.

Referenced by dictionary_get(), dictionary_set(), and dictionary_unset().

static dictionary* dictionary_new ( int  size  )  [static]

Create a new dictionary object.

Parameters:
size Optional initial size of the dictionary.
Returns:
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.

Definition at line 309 of file iniparser.c.

References DICTMINSZ, _dictionary_::hash, _dictionary_::key, _dictionary_::size, and _dictionary_::val.

Referenced by iniparser_new().

static void dictionary_set ( dictionary *  d,
char *  key,
char *  val 
) [static]

Set a value in a dictionary.

Parameters:
d dictionary object to modify.
key Key to modify or add.
val Value to add.
Returns:
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.

Definition at line 417 of file iniparser.c.

References dictionary_hash(), _dictionary_::hash, hash, _dictionary_::key, mem_double(), _dictionary_::n, NULL, _dictionary_::size, and _dictionary_::val.

Referenced by iniparser_add_entry(), and iniparser_setstr().

static void dictionary_unset ( dictionary *  d,
char *  key 
) [static]

Delete a key in a dictionary.

Parameters:
d dictionary object to modify.
key Key to remove.
Returns:
void
This function deletes a key in a dictionary. Nothing is done if the key cannot be found.

Definition at line 482 of file iniparser.c.

References dictionary_hash(), _dictionary_::hash, hash, _dictionary_::key, _dictionary_::n, NULL, _dictionary_::size, and _dictionary_::val.

Referenced by iniparser_unset().

static void iniparser_add_entry ( dictionary *  d,
char *  sec,
char *  key,
char *  val 
) [static]

Definition at line 554 of file iniparser.c.

References ASCIILINESZ, dictionary_set(), and NULL.

Referenced by iniparser_new().

void iniparser_dump ( dictionary *  d,
FILE *  f 
)

Dump a dictionary to an opened file pointer.

Parameters:
d Dictionary to dump.
f Opened file pointer to dump to.
Returns:
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.

Definition at line 663 of file iniparser.c.

References dictionary_dump().

void iniparser_dump_ini ( dictionary *  d,
FILE *  f 
)

Save a dictionary to a loadable ini file.

Parameters:
d Dictionary to dump
f Opened file pointer to dump to
Returns:
void
This function dumps a given dictionary into a loadable ini file. It is Ok to specify stderr or stdout as output files.

Definition at line 681 of file iniparser.c.

References ASCIILINESZ, iniparser_getnsec(), iniparser_getsecname(), _dictionary_::key, NULL, _dictionary_::size, and _dictionary_::val.

int iniparser_find_entry ( dictionary *  ini,
char *  entry 
)

Finds out if a given entry exists in a dictionary.

Parameters:
ini Dictionary to search
entry Name of the entry to look for
Returns:
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.

Definition at line 886 of file iniparser.c.

References INI_INVALID_KEY, and iniparser_getstring().

Referenced by mod_init().

void iniparser_free ( dictionary *  d  ) 

Free all memory associated to an ini dictionary.

Parameters:
d Dictionary to free
Returns:
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.

Definition at line 1018 of file iniparser.c.

References dictionary_del().

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

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

Parameters:
d Dictionary to search
key Key string to look for
notfound Value to return in case of error
Returns:
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.

Definition at line 855 of file iniparser.c.

References INI_INVALID_KEY, and iniparser_getstring().

Referenced by add_ld_session().

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

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

Parameters:
d Dictionary to search
key Key string to look for
notfound Value to return in case of error
Returns:
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.

Definition at line 812 of file iniparser.c.

References INI_INVALID_KEY, and iniparser_getstring().

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

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

Parameters:
d Dictionary to search
key Key string to look for
notfound Value to return in case of error
Returns:
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.

Definition at line 789 of file iniparser.c.

References INI_INVALID_KEY, and iniparser_getstring().

Referenced by add_ld_session().

int iniparser_getnsec ( dictionary *  d  ) 

Get number of sections in a dictionary.

Parameters:
d Dictionary to examine
Returns:
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.

Definition at line 594 of file iniparser.c.

References _dictionary_::key, NULL, and _dictionary_::size.

Referenced by child_init(), iniparser_dump_ini(), and mod_init().

char* iniparser_getsecname ( dictionary *  d,
int  n 
)

Get name for section n in a dictionary.

Parameters:
d Dictionary to examine
n Section number (from 0 to nsec-1).
Returns:
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.

Definition at line 627 of file iniparser.c.

References _dictionary_::key, NULL, and _dictionary_::size.

Referenced by child_init(), iniparser_dump_ini(), and mod_init().

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

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

Parameters:
d Dictionary to search
key Key string to look for
Returns:
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.

Definition at line 739 of file iniparser.c.

References iniparser_getstring(), and NULL.

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

Get the string associated to a key.

Parameters:
d Dictionary to search
key Key string to look for
def Default value to return if key not found.
Returns:
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.

Definition at line 760 of file iniparser.c.

References dictionary_get(), NULL, and strlwc().

Referenced by add_ld_session(), iniparser_find_entry(), iniparser_getboolean(), iniparser_getdouble(), iniparser_getint(), and iniparser_getstr().

dictionary* iniparser_new ( char *  ininame  ) 

Parse an ini file and return an allocated dictionary object.

Parameters:
ininame Name of the ini file to read.
Returns:
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_free().

Definition at line 951 of file iniparser.c.

References ASCIILINESZ, dictionary_new(), iniparser_add_entry(), NULL, strcrop(), strlwc(), and strskp().

Referenced by mod_init().

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

Set an entry in a dictionary.

Parameters:
ini Dictionary to modify.
entry Entry to modify (entry name)
val New value to associate to the entry.
Returns:
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.

Definition at line 914 of file iniparser.c.

References dictionary_set(), and strlwc().

void iniparser_unset ( dictionary *  ini,
char *  entry 
)

Delete an entry in a dictionary.

Parameters:
ini Dictionary to modify
entry Entry to delete (entry name)
Returns:
void
If the given entry can be found, it is deleted from the dictionary.

Definition at line 930 of file iniparser.c.

References dictionary_unset(), and strlwc().

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

Definition at line 250 of file iniparser.c.

Referenced by dictionary_set().

static char* strcrop ( char *  s  )  [static]

Remove blanks at the end of a string.

Parameters:
s String to parse.
Returns:
ptr to statically allocated string.
This function returns a pointer to a statically allocated string, which is identical to the input string, except that all blank characters at the end of the string have been removed. Do not free or modify the returned string! Since the returned string is statically allocated, it will be modified at each function call (not re-entrant).

Definition at line 178 of file iniparser.c.

References ASCIILINESZ, and NULL.

Referenced by iniparser_new().

static char* strlwc ( char *  s  )  [static]

Convert a string to lowercase.

Parameters:
s String to convert.
Returns:
ptr to statically allocated string.
This function returns a pointer to a statically allocated string containing a lowercased version of the input string. Do not free or modify the returned string! Since the returned string is statically allocated, it will be modified at each function call (not re-entrant).

Definition at line 91 of file iniparser.c.

References ASCIILINESZ, and NULL.

Referenced by iniparser_getstring(), iniparser_new(), iniparser_setstr(), and iniparser_unset().

static char* strskp ( char *  s  )  [static]

Convert a string to uppercase.

Parameters:
s String to convert.
Returns:
ptr to statically allocated string.
This function returns a pointer to a statically allocated string containing an uppercased version of the input string. Do not free or modify the returned string! Since the returned string is statically allocated, it will be modified at each function call (not re-entrant). Skip blanks until the first non-blank character.
Parameters:
s String to parse.
Returns:
Pointer to char inside given string.
This function returns a pointer to the first non-blank character in the given string.

Definition at line 153 of file iniparser.c.

References NULL.

Referenced by iniparser_new().

Generated on Wed May 23 08:01:16 2012 for Kamailio - The Open Source SIP Server by  doxygen 1.5.6