diff options
| author | Günther Deschner <gd@samba.org> | 2006-04-11 14:34:40 +0000 |
|---|---|---|
| committer | Gerald (Jerry) Carter <jerry@samba.org> | 2007-10-10 11:15:58 -0500 |
| commit | f340b2fa367d7a888c0dc24ff57f2aed7e9c88bb (patch) | |
| tree | 84149b4ff19bd0119057cce6834a60f1a0d33879 /source3/iniparser/html | |
| parent | 262ffd9750f58f2c5f2268932b45c4d7b05a5fca (diff) | |
| download | samba-f340b2fa367d7a888c0dc24ff57f2aed7e9c88bb.tar.gz samba-f340b2fa367d7a888c0dc24ff57f2aed7e9c88bb.tar.bz2 samba-f340b2fa367d7a888c0dc24ff57f2aed7e9c88bb.zip | |
r15037: Adding iniParser (http://ndevilla.free.fr/iniparser/), a free inifile
parsing library under the MIT licence.
This is required to have a configuration ini-file for pam_winbind
without using loadparm in the next step.
Guenther
(This used to be commit 6658e0a9886ee5a361361bc9b26c136ec91aea72)
Diffstat (limited to 'source3/iniparser/html')
| -rw-r--r-- | source3/iniparser/html/dir_000000.html | 27 | ||||
| -rw-r--r-- | source3/iniparser/html/dirs.html | 19 | ||||
| -rw-r--r-- | source3/iniparser/html/doxygen.css | 309 | ||||
| -rw-r--r-- | source3/iniparser/html/doxygen.png | bin | 0 -> 1281 bytes | |||
| -rw-r--r-- | source3/iniparser/html/globals_func.html | 35 | ||||
| -rw-r--r-- | source3/iniparser/html/index.html | 148 | ||||
| -rw-r--r-- | source3/iniparser/html/iniparser_8h.html | 737 | ||||
| -rw-r--r-- | source3/iniparser/html/iniparser_8main.html | 19 |
8 files changed, 1294 insertions, 0 deletions
diff --git a/source3/iniparser/html/dir_000000.html b/source3/iniparser/html/dir_000000.html new file mode 100644 index 0000000000..9e4da6fc68 --- /dev/null +++ b/source3/iniparser/html/dir_000000.html @@ -0,0 +1,27 @@ +<html> +<head> + <meta name="author" content="ndevilla@free.fr"> + <meta name="keywords" content="ini file, config file, parser, C library"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +<title>iniparser 2.x</title> +</head> + +<body text="#000000" bgcolor="#ffffff"> + + + +<!-- Generated by Doxygen 1.4.4 --> +<div class="nav"> +<a class="el" href="dir_000000.html">src</a></div> +<h1>src Directory Reference</h1><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Files</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html">iniparser.h</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parser for ini files. <br></td></tr> + +<p> +</table> + +</body> +</html> diff --git a/source3/iniparser/html/dirs.html b/source3/iniparser/html/dirs.html new file mode 100644 index 0000000000..1671bd26b1 --- /dev/null +++ b/source3/iniparser/html/dirs.html @@ -0,0 +1,19 @@ +<html> +<head> + <meta name="author" content="ndevilla@free.fr"> + <meta name="keywords" content="ini file, config file, parser, C library"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +<title>iniparser 2.x</title> +</head> + +<body text="#000000" bgcolor="#ffffff"> + + + +<!-- Generated by Doxygen 1.4.4 --> +<h1>iniparser Directories</h1>This directory hierarchy is sorted roughly, but not completely, alphabetically:<ul> +<li><a class="el" href="dir_000000.html">src</a> +</ul> + +</body> +</html> diff --git a/source3/iniparser/html/doxygen.css b/source3/iniparser/html/doxygen.css new file mode 100644 index 0000000000..decae9e394 --- /dev/null +++ b/source3/iniparser/html/doxygen.css @@ -0,0 +1,309 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { font-weight: bold } +DIV.qindex { + width: 100%; + background-color: #eeeeff; + border: 1px solid #b0b0b0; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.nav { + width: 100%; + background-color: #eeeeff; + border: 1px solid #b0b0b0; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #eeeeff; + border: 1px solid #b0b0b0; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff } +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code:link { text-decoration: none; font-weight: normal; color: #0000FF} +A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF} +A.codeRef:link { font-weight: normal; color: #0000FF} +A.codeRef:visited { font-weight: normal; color: #0000FF} +A:hover { text-decoration: none; background-color: #f2f2ff } +DL.el { margin-left: -1cm } +.fragment { + font-family: Fixed, monospace; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #F4F4FB; font-weight: bold; } +TD.mdPrefix { + background-color: #F4F4FB; + color: #606060; + font-size: 80%; +} +TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; } +TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% } +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #eeeeff; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #eeeeff; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { text-align: center; } +IMG.formulaDsp { } +IMG.formulaInl { vertical-align: middle; } +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +.mdTable { + border: 1px solid #868686; + background-color: #F4F4FB; +} +.mdRow { + padding: 8px 10px; +} +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #eeeeff; +} +TD.tiny { font-size: 75%; +} +a { + color: #252E78; +} +a:visited { + color: #3D2185; +} +.dirtab { padding: 4px; + border-collapse: collapse; + border: 1px solid #b0b0b0; +} +TH.dirtab { background: #eeeeff; + font-weight: bold; +} +HR { height: 1px; + border: none; + border-top: 1px solid black; +} diff --git a/source3/iniparser/html/doxygen.png b/source3/iniparser/html/doxygen.png Binary files differnew file mode 100644 index 0000000000..f0a274bbaf --- /dev/null +++ b/source3/iniparser/html/doxygen.png diff --git a/source3/iniparser/html/globals_func.html b/source3/iniparser/html/globals_func.html new file mode 100644 index 0000000000..3e398005f5 --- /dev/null +++ b/source3/iniparser/html/globals_func.html @@ -0,0 +1,35 @@ +<html> +<head> + <meta name="author" content="ndevilla@free.fr"> + <meta name="keywords" content="ini file, config file, parser, C library"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +<title>iniparser 2.x</title> +</head> + +<body text="#000000" bgcolor="#ffffff"> + + + +<!-- Generated by Doxygen 1.4.4 --> +<div class="qindex"><a class="qindex" href="globals.html">All</a> | <a class="qindexHL" href="globals_func.html">Functions</a></div> + +<p> +<ul> +<li>iniparser_dump() +: <a class="el" href="iniparser_8h.html#a3">iniparser.h</a><li>iniparser_dump_ini() +: <a class="el" href="iniparser_8h.html#a2">iniparser.h</a><li>iniparser_find_entry() +: <a class="el" href="iniparser_8h.html#a11">iniparser.h</a><li>iniparser_freedict() +: <a class="el" href="iniparser_8h.html#a13">iniparser.h</a><li>iniparser_getboolean() +: <a class="el" href="iniparser_8h.html#a8">iniparser.h</a><li>iniparser_getdouble() +: <a class="el" href="iniparser_8h.html#a7">iniparser.h</a><li>iniparser_getint() +: <a class="el" href="iniparser_8h.html#a6">iniparser.h</a><li>iniparser_getnsec() +: <a class="el" href="iniparser_8h.html#a0">iniparser.h</a><li>iniparser_getsecname() +: <a class="el" href="iniparser_8h.html#a1">iniparser.h</a><li>iniparser_getstr() +: <a class="el" href="iniparser_8h.html#a4">iniparser.h</a><li>iniparser_getstring() +: <a class="el" href="iniparser_8h.html#a5">iniparser.h</a><li>iniparser_load() +: <a class="el" href="iniparser_8h.html#a12">iniparser.h</a><li>iniparser_setstr() +: <a class="el" href="iniparser_8h.html#a9">iniparser.h</a><li>iniparser_unset() +: <a class="el" href="iniparser_8h.html#a10">iniparser.h</a></ul> + +</body> +</html> diff --git a/source3/iniparser/html/index.html b/source3/iniparser/html/index.html new file mode 100644 index 0000000000..e0ca48b872 --- /dev/null +++ b/source3/iniparser/html/index.html @@ -0,0 +1,148 @@ +<html> +<head> + <meta name="author" content="ndevilla@free.fr"> + <meta name="keywords" content="ini file, config file, parser, C library"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +<title>iniparser 2.x</title> +</head> + +<body text="#000000" bgcolor="#ffffff"> + + + +<!-- Generated by Doxygen 1.4.4 --> +<h1>iniparser documentation </h1> +<p> +<h3 align="center">2.x </h3><hr> +<h2><a class="anchor" name="welcome"> +Introduction</a></h2> +iniParser is a simple C library offering ini file parsing services. The library is pretty small (less than 1500 lines of C) and robust, and does not depend on any other external library to compile. It is written in ANSI C and should compile anywhere without difficulty.<p> +<hr> +<h2><a class="anchor" name="inidef"> +What is an ini file?</a></h2> +An ini file is an ASCII file describing simple parameters (character strings, integers, floating-point values or booleans) in an explicit format, easy to use and modify for users.<p> +An ini file is segmented into Sections, declared by the following syntax:<p> +<div class="fragment"><pre class="fragment"> [Section Name] + </pre></div><p> +i.e. the section name enclosed in square brackets, alone on a line. Sections names are allowed to contain any character but square brackets or linefeeds. Slashes (/) are also reserved for hierarchical sections (see below).<p> +In any section are zero or more variables, declared with the following syntax:<p> +<div class="fragment"><pre class="fragment"> Key = value ; comment + </pre></div><p> +The key is any string (possibly containing blanks). The value is any character on the right side of the equal sign. Values can be given enclosed with quotes. If no quotes are present, the value is understood as containing all characters between the first and the last non-blank characters. The following declarations are identical:<p> +<div class="fragment"><pre class="fragment"> Hello = "this is a long string value" ; comment + Hello = this is a long string value ; comment + </pre></div><p> +The semicolon and comment at the end of the line are optional. If there is a comment, it starts from the first character after the semicolon up to the end of the line.<p> +Comments in an ini file are:<p> +<ul> +<li>Lines starting with a hash sign</li><li>Blank lines (only blanks or tabs)</li><li>Comments given on value lines after the semicolon (if present)</li></ul> +<p> +<hr> +<h2><a class="anchor" name="install"> +Compiling/installing the library</a></h2> +Edit the Makefile to indicate the C compiler you want to use, the options to provide to compile ANSI C, and possibly the options to pass to the <code>ar</code> program on your machine to build a library (.a) from a set of object (.o) files.<p> +Defaults are set for the gcc compiler and the standard ar library builder.<p> +Type 'make', that should do it.<p> +To use the library in your programs, add the following line on top of your module:<p> +<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include "<a class="code" href="iniparser_8h.html">iniparser.h</a>"</span> +</pre></div><p> +And link your program with the iniparser library by adding <code>-liniparser</code>.a to the compile line.<p> +See the file test/initest.c for an example.<p> +<hr> +<h2><a class="anchor" name="reference"> +Library reference</a></h2> +The library is completely documented in its header file. On-line documentation has been generated and can be consulted here:<p> +<ul> +<li><a class="el" href="iniparser_8h.html">iniparser.h</a></li></ul> +<p> +<hr> +<h2><a class="anchor" name="usage"> +Using the parser</a></h2> +Comments are discarded by the parser. Then sections are identified, and in each section a new entry is created for every keyword found. The keywords are stored with the following syntax:<p> +<div class="fragment"><pre class="fragment"> [Section] + Keyword = value ; comment + </pre></div><p> +is converted to the following key pair:<p> +<div class="fragment"><pre class="fragment"> ("section:keyword", "value") + </pre></div><p> +This means that if you want to retrieve the value that was stored in the section called <code>Pizza</code>, in the keyword <code>Cheese</code>, you would make a request to the dictionary for <code>"pizza:cheese"</code>. All section and keyword names are converted to lowercase before storage in the structure. The value side is conserved as it has been parsed, though.<p> +Section names are also stored in the structure. They are stored using as key the section name, and a NULL associated value. They can be queried through <a class="el" href="iniparser_8h.html#a11">iniparser_find_entry()</a>.<p> +To launch the parser, simply use the function called <a class="el" href="iniparser_8h.html#a12">iniparser_load()</a>, which takes an input file name and returns a newly allocated <em>dictionary</em> structure. This latter object should remain opaque to the user and only accessed through the following accessor functions:<p> +<ul> +<li><a class="el" href="iniparser_8h.html#a4">iniparser_getstr()</a></li><li><a class="el" href="iniparser_8h.html#a6">iniparser_getint()</a></li><li><a class="el" href="iniparser_8h.html#a7">iniparser_getdouble()</a></li><li><a class="el" href="iniparser_8h.html#a8">iniparser_getboolean()</a></li></ul> +<p> +Finally, discard this structure using <a class="el" href="iniparser_8h.html#a13">iniparser_freedict()</a>.<p> +All values parsed from the ini file are stored as strings. The getint, getdouble and getboolean accessors are just converting these strings to the requested type on the fly, but you could basically perform this conversion by yourself after having called the getstr accessor.<p> +Notice that the <a class="el" href="iniparser_8h.html#a8">iniparser_getboolean()</a> function will return an integer (0 or 1), trying to make sense of what was found in the file. Strings starting with "y", "Y", "t", "T" or "1" are considered true values (return 1), strings starting with "n", "N", "f", "F", "0" are considered false (return 0). This allows flexible handling of boolean answers.<p> +If you want to add extra information into the structure that was not present in the ini file, you can use <a class="el" href="iniparser_8h.html#a9">iniparser_setstr()</a> to insert a string.<p> +<hr> +<h2><a class="anchor" name="implementation"> +A word about the implementation</a></h2> +The dictionary structure is a pretty simple dictionary implementation which might find some uses in other applications. If you are curious, look into the source.<p> +<hr> +<h2><a class="anchor" name="hierarchical"> +Hierarchical ini files</a></h2> +ini files are nice to present informations to the user in a readable format, but lack a very useful feature: the possibility of organizing data in a hierarchical (tree-like) fashion. The following convention can be used to make ini files obtain this second dimension:<p> +A section depends on another section if it contains its name as a prefix, separated by slashes (/). For example: we have 2 main sections in the ini file. The first one is called <code>Pizza</code> and has two child subsections called <code>Cheese</code> and <code>Ham</code>. The second main section in the ini file is called <code>Wine</code> and has two child subsections called <code>Year</code> and <code>Grape</code>. As a tree, this could appear as:<p> +<div class="fragment"><pre class="fragment"> | + +-- Pizza + | +-- Cheese + | +-- Ham + +-- Wine + +--- Year + +--- Grape + </pre></div><p> +In an ini file, that would be converted to:<p> +<div class="fragment"><pre class="fragment"> [Pizza] + + [Pizza/Cheese] + Name = Gorgonzola ; + Origin = Italy ; + + [Pizza/Ham] + Name = Parma ; + Origin = Italy ; + + [Wine] + + [Wine/Year] + Value = 1998 ; + + [Wine/Grape] + Name = Cabernet Sauvignon ; + Origin = Chile ; + </pre></div><p> +This proposal is actually more related to the way people write ini files, more than the parser presented here. But it is certainly a useful way of making tree-like data declarations without going through painful formats like XML.<p> +Accessing the above tree would give something like (error checking removed for clarity sake):<p> +<div class="fragment"><pre class="fragment"> dictionary * d ; + + d = <a class="code" href="iniparser_8h.html#a12">iniparser_load</a>(<span class="stringliteral">"example.ini"</span>); + + printf(<span class="stringliteral">"cheese name is %s\n"</span>, <a class="code" href="iniparser_8h.html#a4">iniparser_getstr</a>(d, <span class="stringliteral">"pizza/cheese:name"</span>)); + printf(<span class="stringliteral">"grape name is %s\n"</span>, <a class="code" href="iniparser_8h.html#a4">iniparser_getstr</a>(d, <span class="stringliteral">"wine/grape:name"</span>)); + + <a class="code" href="iniparser_8h.html#a13">iniparser_freedict</a>(d); +</pre></div><p> +The whole ini file above is represented in the dictionary as the following list of pairs:<p> +<div class="fragment"><pre class="fragment"> key value + + "pizza" NULL + "pizza/cheese" NULL + "pizza/cheese:name" "Gorgonzola" + "pizza/cheese:origin" "Italy" + "pizza/ham" NULL + "pizza/ham:name" "Parma" + "pizza/ham:origin" "Italy" + "wine" NULL + "wine/year" NULL + "wine/year:value" "1998" + "wine/grape" NULL + "wine/grape:name" "Cabernet Sauvignon" + "wine/grape:origin" "Chile" + </pre></div><p> +<hr> +<h2><a class="anchor" name="authors"> +Authors</a></h2> +Nicolas Devillard (ndevilla AT free DOT fr). +</body> +</html> diff --git a/source3/iniparser/html/iniparser_8h.html b/source3/iniparser/html/iniparser_8h.html new file mode 100644 index 0000000000..3f0534f31e --- /dev/null +++ b/source3/iniparser/html/iniparser_8h.html @@ -0,0 +1,737 @@ +<html> +<head> + <meta name="author" content="ndevilla@free.fr"> + <meta name="keywords" content="ini file, config file, parser, C library"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +<title>iniparser 2.x</title> +</head> + +<body text="#000000" bgcolor="#ffffff"> + + + +<!-- Generated by Doxygen 1.4.4 --> +<div class="nav"> +<a class="el" href="dir_000000.html">src</a></div> +<h1>iniparser.h File Reference</h1>Parser for ini files. <a href="#_details">More...</a> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a0">iniparser_getnsec</a> (dictionary *d)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of sections in a dictionary. <a href="#a0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a1">iniparser_getsecname</a> (dictionary *d, int n)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get name for section n in a dictionary. <a href="#a1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a2">iniparser_dump_ini</a> (dictionary *d, FILE *f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a dictionary to a loadable ini file. <a href="#a2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a3">iniparser_dump</a> (dictionary *d, FILE *f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Dump a dictionary to an opened file pointer. <a href="#a3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a4">iniparser_getstr</a> (dictionary *d, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, return NULL if not found. <a href="#a4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a5">iniparser_getstring</a> (dictionary *d, char *key, char *def)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key. <a href="#a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a6">iniparser_getint</a> (dictionary *d, char *key, int notfound)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, convert to an int. <a href="#a6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a7">iniparser_getdouble</a> (dictionary *d, char *key, double notfound)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, convert to a double. <a href="#a7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a8">iniparser_getboolean</a> (dictionary *d, char *key, int notfound)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string associated to a key, convert to a boolean. <a href="#a8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a9">iniparser_setstr</a> (dictionary *ini, char *entry, char *val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an entry in a dictionary. <a href="#a9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a10">iniparser_unset</a> (dictionary *ini, char *entry)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete an entry in a dictionary. <a href="#a10"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a11">iniparser_find_entry</a> (dictionary *ini, char *entry)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds out if a given entry exists in a dictionary. <a href="#a11"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">dictionary * </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a12">iniparser_load</a> (char *ininame)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an ini file and return an allocated dictionary object. <a href="#a12"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iniparser_8h.html#a13">iniparser_freedict</a> (dictionary *d)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free all memory associated to an ini dictionary. <a href="#a13"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Parser for ini files. +<p> +<dl compact><dt><b>Author:</b></dt><dd>N. Devillard </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>Mar 2000 </dd></dl> +<dl compact><dt><b>Version:</b></dt><dd><dl compact><dt><b>Revision</b></dt><dd>1.20 </dd></dl> +</dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a3"></a><!-- doxytag: member="iniparser.h::iniparser_dump" ref="a3" args="(dictionary *d, FILE *f)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void iniparser_dump </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>FILE * </td> + <td class="mdname" nowrap> <em>f</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Dump a dictionary to an opened file pointer. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to dump. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>Opened file pointer to dump to. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl> +This function prints out the contents of a dictionary, one element by line, onto the provided file pointer. It is OK to specify <code>stderr</code> or <code>stdout</code> as output files. This function is meant for debugging purposes mostly. </td> + </tr> +</table> +<a class="anchor" name="a2"></a><!-- doxytag: member="iniparser.h::iniparser_dump_ini" ref="a2" args="(dictionary *d, FILE *f)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void iniparser_dump_ini </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>FILE * </td> + <td class="mdname" nowrap> <em>f</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Save a dictionary to a loadable ini file. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to dump </td></tr> + <tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>Opened file pointer to dump to </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl> +This function dumps a given dictionary into a loadable ini file. It is Ok to specify <code>stderr</code> or <code>stdout</code> as output files. </td> + </tr> +</table> +<a class="anchor" name="a11"></a><!-- doxytag: member="iniparser.h::iniparser_find_entry" ref="a11" args="(dictionary *ini, char *entry)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int iniparser_find_entry </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>ini</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>entry</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Finds out if a given entry exists in a dictionary. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ini</em> </td><td>Dictionary to search </td></tr> + <tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>Name of the entry to look for </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>integer 1 if entry exists, 0 otherwise</dd></dl> +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. </td> + </tr> +</table> +<a class="anchor" name="a13"></a><!-- doxytag: member="iniparser.h::iniparser_freedict" ref="a13" args="(dictionary *d)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void iniparser_freedict </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname1" valign="top" nowrap> <em>d</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Free all memory associated to an ini dictionary. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to free </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl> +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. </td> + </tr> +</table> +<a class="anchor" name="a8"></a><!-- doxytag: member="iniparser.h::iniparser_getboolean" ref="a8" args="(dictionary *d, char *key, int notfound)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int iniparser_getboolean </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>key</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>notfound</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the string associated to a key, convert to a boolean. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr> + <tr><td valign="top"></td><td valign="top"><em>notfound</em> </td><td>Value to return in case of error </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>integer</dd></dl> +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.<p> +A true boolean is found if one of the following is matched:<p> +<ul> +<li>A string starting with 'y'</li><li>A string starting with 'Y'</li><li>A string starting with 't'</li><li>A string starting with 'T'</li><li>A string starting with '1'</li></ul> +<p> +A false boolean is found if one of the following is matched:<p> +<ul> +<li>A string starting with 'n'</li><li>A string starting with 'N'</li><li>A string starting with 'f'</li><li>A string starting with 'F'</li><li>A string starting with '0'</li></ul> +<p> +The notfound value returned if no boolean is identified, does not necessarily have to be 0 or 1. </td> + </tr> +</table> +<a class="anchor" name="a7"></a><!-- doxytag: member="iniparser.h::iniparser_getdouble" ref="a7" args="(dictionary *d, char *key, double notfound)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">double iniparser_getdouble </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>key</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>double </td> + <td class="mdname" nowrap> <em>notfound</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the string associated to a key, convert to a double. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr> + <tr><td valign="top"></td><td valign="top"><em>notfound</em> </td><td>Value to return in case of error </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>double</dd></dl> +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. </td> + </tr> +</table> +<a class="anchor" name="a6"></a><!-- doxytag: member="iniparser.h::iniparser_getint" ref="a6" args="(dictionary *d, char *key, int notfound)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int iniparser_getint </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>key</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>notfound</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the string associated to a key, convert to an int. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr> + <tr><td valign="top"></td><td valign="top"><em>notfound</em> </td><td>Value to return in case of error </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>integer</dd></dl> +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. </td> + </tr> +</table> +<a class="anchor" name="a0"></a><!-- doxytag: member="iniparser.h::iniparser_getnsec" ref="a0" args="(dictionary *d)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int iniparser_getnsec </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname1" valign="top" nowrap> <em>d</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get number of sections in a dictionary. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to examine </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>int Number of sections found in dictionary</dd></dl> +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.<p> +This clearly fails in the case a section name contains a colon, but this should simply be avoided.<p> +This function returns -1 in case of error. </td> + </tr> +</table> +<a class="anchor" name="a1"></a><!-- doxytag: member="iniparser.h::iniparser_getsecname" ref="a1" args="(dictionary *d, int n)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">char* iniparser_getsecname </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>n</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get name for section n in a dictionary. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to examine </td></tr> + <tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>Section number (from 0 to nsec-1). </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>Pointer to char string</dd></dl> +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!<p> +This function returns NULL in case of error. </td> + </tr> +</table> +<a class="anchor" name="a4"></a><!-- doxytag: member="iniparser.h::iniparser_getstr" ref="a4" args="(dictionary *d, char *key)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">char* iniparser_getstr </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>key</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the string associated to a key, return NULL if not found. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>pointer to statically allocated character string, or NULL.</dd></dl> +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.<p> +This function is only provided for backwards compatibility with previous versions of iniparser. It is recommended to use <a class="el" href="iniparser_8h.html#a5">iniparser_getstring()</a> instead. </td> + </tr> +</table> +<a class="anchor" name="a5"></a><!-- doxytag: member="iniparser.h::iniparser_getstring" ref="a5" args="(dictionary *d, char *key, char *def)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">char* iniparser_getstring </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>key</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>def</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the string associated to a key. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Dictionary to search </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Key string to look for </td></tr> + <tr><td valign="top"></td><td valign="top"><em>def</em> </td><td>Default value to return if key not found. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>pointer to statically allocated character string</dd></dl> +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. </td> + </tr> +</table> +<a class="anchor" name="a12"></a><!-- doxytag: member="iniparser.h::iniparser_load" ref="a12" args="(char *ininame)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">dictionary* iniparser_load </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char * </td> + <td class="mdname1" valign="top" nowrap> <em>ininame</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Parse an ini file and return an allocated dictionary object. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ininame</em> </td><td>Name of the ini file to read. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>Pointer to newly allocated dictionary</dd></dl> +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.<p> +The returned dictionary must be freed using <a class="el" href="iniparser_8h.html#a13">iniparser_freedict()</a>. </td> + </tr> +</table> +<a class="anchor" name="a9"></a><!-- doxytag: member="iniparser.h::iniparser_setstr" ref="a9" args="(dictionary *ini, char *entry, char *val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int iniparser_setstr </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>ini</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>entry</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set an entry in a dictionary. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ini</em> </td><td>Dictionary to modify. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>Entry to modify (entry name) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>New value to associate to the entry. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>int 0 if Ok, -1 otherwise.</dd></dl> +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. </td> + </tr> +</table> +<a class="anchor" name="a10"></a><!-- doxytag: member="iniparser.h::iniparser_unset" ref="a10" args="(dictionary *ini, char *entry)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void iniparser_unset </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">dictionary * </td> + <td class="mdname" nowrap> <em>ini</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>entry</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Delete an entry in a dictionary. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ini</em> </td><td>Dictionary to modify </td></tr> + <tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>Entry to delete (entry name) </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl> +If the given entry can be found, it is deleted from the dictionary. </td> + </tr> +</table> + +</body> +</html> diff --git a/source3/iniparser/html/iniparser_8main.html b/source3/iniparser/html/iniparser_8main.html new file mode 100644 index 0000000000..38a963bbc7 --- /dev/null +++ b/source3/iniparser/html/iniparser_8main.html @@ -0,0 +1,19 @@ +<html> +<head> + <meta name="author" content="ndevilla@free.fr"> + <meta name="keywords" content="ini file, config file, parser, C library"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +<title>iniparser 2.x</title> +</head> + +<body text="#000000" bgcolor="#ffffff"> + + + +<!-- Generated by Doxygen 1.4.4 --> +<h1>iniparser.main File Reference</h1><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +</table> + +</body> +</html> |
