ccppi/config-parser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a05c9ce786682190bd37383bcb02c1a192bae53f
config-parser/doc/html/config_8h_source.html
jonathan santis a05c9ce786 update doc
2025-05-21 09:46:06 +02:00

175 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>config-parser: config.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">config-parser
</div>
<div id="projectbrief">a simple ini parser written in C</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('config_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">config.h</div></div>
</div><!--header-->
<div class="contents">
<a href="config_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"><a class="line" href="config_8h.html#ac1a724419200e9f961dc787950aecd2b"> 1</a></span><span class="preprocessor">#define NO_SECTION 0</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"><a class="line" href="config_8h.html#a02f5a0519bc0372946e64d593c0c58ce"> 2</a></span><span class="preprocessor">#define FOUND_SECTION 10</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"><a class="line" href="config_8h.html#abc212059095802b47f10a6a49fd45abc"> 3</a></span><span class="preprocessor">#define ERROR_STR 1001</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"><a class="line" href="config_8h.html#a39de51bdb6918a63eac8b1bb474e2b84"> 4</a></span><span class="preprocessor">#define ERROR_MAX_LEN 2</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"><a class="line" href="config_8h.html#a258bb72419ef143530a2f8f55e7d57af"> 5</a></span><span class="preprocessor">#define NO_ERROR 0</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">//ERROR DELIMITER</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"><a class="line" href="config_8h.html#a0000658c96c7c74c0904aafe03429a7d"> 7</a></span><span class="preprocessor">#define ERROR_DELIMITER_NOT_FOUND 40</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">//State Machine</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="config_8h.html#a07c5dd6a63f85102afff94734b066db6"> 11</a></span><span class="preprocessor">#define ST_INIT 0</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="config_8h.html#a4aa0fcd1d1c19c873711c0dbdf590f51"> 12</a></span><span class="preprocessor">#define ST_FOUND_LEFT_DELIMITER 1</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="config_8h.html#a109ad3408cd20ac98f7063ad33ee151c"> 13</a></span><span class="preprocessor">#define ST_FOUND_RIGHT_DELIMITER 2</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="config_8h.html#aea1c2232d9f2837fbb565f13e5d7e8ea"> 14</a></span><span class="preprocessor">#define ST_ERROR_NOT_FOUND_RIGHT_DELIMITER 3</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="config_8h.html#afae21c34cd1bfa910d95db50f151c81c"> 15</a></span><span class="preprocessor">#define ST_ERROR_NOT_FOUND_LEFT_DELIMITER 4</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="config_8h.html#a50f0255611b79622dbca5cf9c27b7f43"> 16</a></span><span class="preprocessor">#define ST_FOUND_SECTION 5</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="config_8h.html#a71a276bab1ecc5d309fe1593a1640d5d"> 17</a></span><span class="preprocessor">#define ST_SKIP_READ 6</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="config_8h.html#a587e636e48ca212f7c964a93ae005e03"> 19</a></span><span class="preprocessor">#define ST_FINISH 20</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">//state machine ERROR</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="config_8h.html#ad89f5843f6a9cdc6a61d5af4734cd75d"> 22</a></span><span class="preprocessor">#define ST_ERROR_GETSTRATPOS 30</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">//LIMITS</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="config_8h.html#aa454692b60895f7025f12b1e0065acea"> 25</a></span><span class="preprocessor">#define MAX_LEN_SECTIONNAME 128</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">//error parseConfig</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="config_8h.html#ae0f18393ca3f7c151a4e58ae35b119f7"> 28</a></span><span class="preprocessor">#define ERR_PARSECONFIG_UNKNOWN 201</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structconfigEntry.html"> 30</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structconfigEntry.html">configEntry</a></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structconfigEntry.html#ad610b2d30e2432b3cb5f0d0e397f2043"> 32</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structconfigEntry.html#ad610b2d30e2432b3cb5f0d0e397f2043">sectionName</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structconfigEntry.html#a6b96fdfa727658a18ab5a03d5e5a4572"> 33</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structconfigEntry.html#a6b96fdfa727658a18ab5a03d5e5a4572">keyName</a>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structconfigEntry.html#a221f7ca4b687e6cfce063e332330d635"> 34</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structconfigEntry.html#a221f7ca4b687e6cfce063e332330d635">keyValue</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>};</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="config_8h.html#acbd35a1e4b5f0eea312f8cb64f898d4b"> 38</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="config_8h.html#acbd35a1e4b5f0eea312f8cb64f898d4b">loadConfig</a>(<span class="keywordtype">char</span> *file, <span class="keywordtype">char</span> **str_entry,<span class="keywordtype">char</span> **host,<span class="keywordtype">int</span> *intervall,<span class="keywordtype">int</span> size);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keywordtype">int</span> <a class="code hl_function" href="config_8h.html#aae86bc3f3ebba4d6aba3ca1392c0126a">checkSection</a>(<span class="keywordtype">char</span> *str,<span class="keywordtype">char</span> delimiterLeft,<span class="keywordtype">char</span> delimiterRight,<span class="keywordtype">char</span> **sectionName);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keywordtype">int</span> <a class="code hl_function" href="config_8h.html#a699e504c1ab9ceffb828dbf365a5e374">getStrAtPos</a>(<span class="keywordtype">char</span> *str,<span class="keywordtype">int</span> fromPos,<span class="keywordtype">int</span> toPos, <span class="keywordtype">char</span> **name,<span class="keywordtype">int</span> sizeName);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keywordtype">int</span> <a class="code hl_function" href="config_8h.html#ab0b547ee554d9b305adc1b2ad85080a3">getNameValuePair</a>(<span class="keywordtype">char</span> *str,<span class="keywordtype">char</span> leftDelimiterPos,<span class="keywordtype">char</span> rightDelimiterPos,<span class="keywordtype">char</span> **name,<span class="keywordtype">char</span> **value,<span class="keywordtype">int</span> sizeName,<span class="keywordtype">int</span> sizeValue);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keywordtype">int</span> <a class="code hl_function" href="config_8h.html#aa8a964c95239ab762c37713f5f53a583">parseConfig</a>(<span class="keywordtype">char</span> *buffer,<span class="keyword">struct</span> <a class="code hl_struct" href="structconfigEntry.html">configEntry</a> **entry,<span class="keywordtype">int</span> configSize,<span class="keywordtype">int</span> *returnedCount);</div>
<div class="ttc" id="aconfig_8h_html_a699e504c1ab9ceffb828dbf365a5e374"><div class="ttname"><a href="config_8h.html#a699e504c1ab9ceffb828dbf365a5e374">getStrAtPos</a></div><div class="ttdeci">int getStrAtPos(char *str, int fromPos, int toPos, char **name, int sizeName)</div><div class="ttdoc">Here we get / cut from fromPos to toPos and write it to an address.</div><div class="ttdef"><b>Definition</b> <a href="config_8c_source.html#l00098">config.c:98</a></div></div>
<div class="ttc" id="aconfig_8h_html_aa8a964c95239ab762c37713f5f53a583"><div class="ttname"><a href="config_8h.html#aa8a964c95239ab762c37713f5f53a583">parseConfig</a></div><div class="ttdeci">int parseConfig(char *buffer, struct configEntry **entry, int configSize, int *returnedCount)</div><div class="ttdef"><b>Definition</b> <a href="config_8c_source.html#l00215">config.c:215</a></div></div>
<div class="ttc" id="aconfig_8h_html_aae86bc3f3ebba4d6aba3ca1392c0126a"><div class="ttname"><a href="config_8h.html#aae86bc3f3ebba4d6aba3ca1392c0126a">checkSection</a></div><div class="ttdeci">int checkSection(char *str, char delimiterLeft, char delimiterRight, char **sectionName)</div><div class="ttdoc">Here we check if the given string contains a section for example [SECTIONName] here delimiterLeft is ...</div><div class="ttdef"><b>Definition</b> <a href="config_8c_source.html#l00024">config.c:24</a></div></div>
<div class="ttc" id="aconfig_8h_html_ab0b547ee554d9b305adc1b2ad85080a3"><div class="ttname"><a href="config_8h.html#ab0b547ee554d9b305adc1b2ad85080a3">getNameValuePair</a></div><div class="ttdeci">int getNameValuePair(char *str, char leftDelimiterPos, char rightDelimiterPos, char **name, char **value, int sizeName, int sizeValue)</div><div class="ttdoc">Input:</div><div class="ttdef"><b>Definition</b> <a href="config_8c_source.html#l00151">config.c:151</a></div></div>
<div class="ttc" id="aconfig_8h_html_acbd35a1e4b5f0eea312f8cb64f898d4b"><div class="ttname"><a href="config_8h.html#acbd35a1e4b5f0eea312f8cb64f898d4b">loadConfig</a></div><div class="ttdeci">int loadConfig(char *file, char **str_entry, char **host, int *intervall, int size)</div></div>
<div class="ttc" id="astructconfigEntry_html"><div class="ttname"><a href="structconfigEntry.html">configEntry</a></div><div class="ttdef"><b>Definition</b> <a href="#l00030">config.h:31</a></div></div>
<div class="ttc" id="astructconfigEntry_html_a221f7ca4b687e6cfce063e332330d635"><div class="ttname"><a href="structconfigEntry.html#a221f7ca4b687e6cfce063e332330d635">configEntry::keyValue</a></div><div class="ttdeci">char * keyValue</div><div class="ttdef"><b>Definition</b> <a href="#l00034">config.h:34</a></div></div>
<div class="ttc" id="astructconfigEntry_html_a6b96fdfa727658a18ab5a03d5e5a4572"><div class="ttname"><a href="structconfigEntry.html#a6b96fdfa727658a18ab5a03d5e5a4572">configEntry::keyName</a></div><div class="ttdeci">char * keyName</div><div class="ttdef"><b>Definition</b> <a href="#l00033">config.h:33</a></div></div>
<div class="ttc" id="astructconfigEntry_html_ad610b2d30e2432b3cb5f0d0e397f2043"><div class="ttname"><a href="structconfigEntry.html#ad610b2d30e2432b3cb5f0d0e397f2043">configEntry::sectionName</a></div><div class="ttdeci">char * sectionName</div><div class="ttdef"><b>Definition</b> <a href="#l00032">config.h:32</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="config_8h.html">config.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink