# SPL Module Reference: format_ini

load "format_ini";

    A simple INI file parser/dumper module

    This module implements simple INI file parser and dumper functions.

function format_ini_parse(inidata);
function format_ini_dump(initree);

function format_ini_parse(inidata);

    This function expects the content of a INI file (inidata) and returns a two
    dimentional hash structure with the INI section names as 1st index and the
    INI variable name as 2nd index (initree).

    The INI file format as understood by this implementation:

    	[foobar]
    		the following entries are in the "foobar" section.

    	key = value
    		set variable "key" to "value"

    - everything else (including lines starting with ';' or '#' are ignored).
    - section names and variable names are limited to the regex /[a-z0-9_]+/.
    - variables declared before the first section declaration are
      defined in the "" section.
    - whitespaces are ignored.

    There is no mechanism for reporting parser errors (parser errors are not
    possible because all lines not recognised as section or variable declaration
    are ignored).

function format_ini_dump(initree);

    This function expects a data structure such as returned by
    format_ini_parse() as parameter and returns the inidata.

Generated by SPLDOC. | http://www.clifford.at/spl/