Files
config-parser/doc/html/file_8c_source.html
2025-05-20 16:15:21 +02:00

191 lines
16 KiB
HTML

<!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>My Project: file.c 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">My Project
</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('file_8c_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">file.c</div></div>
</div><!--header-->
<div class="contents">
<a href="file_8c.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &quot;<a class="code" href="file_8h.html">file.h</a>&quot;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">/*</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Here we load a file and write the file as string to a memory address:</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Input:</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * char* fname: the name of the file to open</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * int cbSize: the size of the strContent</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * Output:</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * char **strContent: a pointer to a address where you have to allocate enougth memory to store the whole file</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * int neededSize: this returns the needed size of the buffer strContent</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Note:</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * to get the size define strContent as NULL, then the needed size will return the needed buffersize</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> */</span></div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="}">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="file_8c.html#a415337a87938760b49ba4c0d74ab6c6a"> 17</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="file_8c.html#a415337a87938760b49ba4c0d74ab6c6a">getFile</a>(<span class="keywordtype">char</span> *fname, <span class="keywordtype">char</span> **strContent,<span class="keywordtype">int</span> cbSize,<span class="keywordtype">long</span> *neededSize)</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"> 19</span> FILE *hfile = fopen(fname,<span class="stringliteral">&quot;r&quot;</span>);</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordtype">long</span> file_size=0;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">int</span> ret=0;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">if</span>(hfile == NULL)</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="keywordflow">return</span> <a class="code hl_define" href="file_8h.html#a44d189cf44f6ef2cb48c2f22c7824469">FILE_ERROR_OPEN</a>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</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> printf(<span class="stringliteral">&quot;file openend:%s&quot;</span>,fname);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> fseek(hfile,0,SEEK_END);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> file_size = ftell(hfile);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordflow">if</span>(strContent == NULL) <span class="comment">//we must determine the size and return to neededSize</span></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"> 32</span> *neededSize = file_size+1;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> fclose(hfile);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">return</span> <a class="code hl_define" href="config_8h.html#a258bb72419ef143530a2f8f55e7d57af">NO_ERROR</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</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> <span class="keywordflow">if</span>(cbSize &lt; file_size)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> *neededSize = file_size+1; <span class="comment">//null terminator</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> fclose(hfile);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">return</span> <a class="code hl_define" href="file_8h.html#a12f43bc1d8b150bb55c18877bbe612ac">FILE_ERROR_STRCONTENT_TO_SMALL</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</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> fseek(hfile,0,SEEK_SET);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> ret=fread(*strContent,file_size,1,hfile);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">if</span>(ret != 1)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> printf(<span class="stringliteral">&quot;Reading error read and should read missmatch\nnumber written elements:%d\n&quot;</span>,</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> ret);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> fclose(hfile);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">return</span> <a class="code hl_define" href="file_8h.html#aa161b7390609303815b39df4a4850cfc">FILE_ERROR_READ_MISMATCH</a>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> }</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">//buffer end-1 = \0</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="comment">//buffer end-2 = \n</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">//buffer end-3 = last character</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> printf(<span class="stringliteral">&quot;strcontent: %ld, [%c]\n&quot;</span>,*neededSize,*(*strContent+ *neededSize-3));</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> *(*strContent + *neededSize -1) =<span class="charliteral">&#39;\0&#39;</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> printf(<span class="stringliteral">&quot;after zero assign: %ld, %s\n&quot;</span>,*neededSize,(*strContent+ *neededSize-1));</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="comment">//printf(&quot;content:%s&quot;,*strContent);</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> fclose(hfile); </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> <a class="code hl_define" href="config_8h.html#a258bb72419ef143530a2f8f55e7d57af">NO_ERROR</a>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>}</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="ttc" id="aconfig_8h_html_a258bb72419ef143530a2f8f55e7d57af"><div class="ttname"><a href="config_8h.html#a258bb72419ef143530a2f8f55e7d57af">NO_ERROR</a></div><div class="ttdeci">#define NO_ERROR</div><div class="ttdef"><b>Definition</b> <a href="config_8h_source.html#l00005">config.h:5</a></div></div>
<div class="ttc" id="afile_8c_html_a415337a87938760b49ba4c0d74ab6c6a"><div class="ttname"><a href="file_8c.html#a415337a87938760b49ba4c0d74ab6c6a">getFile</a></div><div class="ttdeci">int getFile(char *fname, char **strContent, int cbSize, long *neededSize)</div><div class="ttdef"><b>Definition</b> <a href="#l00017">file.c:17</a></div></div>
<div class="ttc" id="afile_8h_html"><div class="ttname"><a href="file_8h.html">file.h</a></div></div>
<div class="ttc" id="afile_8h_html_a12f43bc1d8b150bb55c18877bbe612ac"><div class="ttname"><a href="file_8h.html#a12f43bc1d8b150bb55c18877bbe612ac">FILE_ERROR_STRCONTENT_TO_SMALL</a></div><div class="ttdeci">#define FILE_ERROR_STRCONTENT_TO_SMALL</div><div class="ttdef"><b>Definition</b> <a href="file_8h_source.html#l00005">file.h:5</a></div></div>
<div class="ttc" id="afile_8h_html_a44d189cf44f6ef2cb48c2f22c7824469"><div class="ttname"><a href="file_8h.html#a44d189cf44f6ef2cb48c2f22c7824469">FILE_ERROR_OPEN</a></div><div class="ttdeci">#define FILE_ERROR_OPEN</div><div class="ttdef"><b>Definition</b> <a href="file_8h_source.html#l00004">file.h:4</a></div></div>
<div class="ttc" id="afile_8h_html_aa161b7390609303815b39df4a4850cfc"><div class="ttname"><a href="file_8h.html#aa161b7390609303815b39df4a4850cfc">FILE_ERROR_READ_MISMATCH</a></div><div class="ttdeci">#define FILE_ERROR_READ_MISMATCH</div><div class="ttdef"><b>Definition</b> <a href="file_8h_source.html#l00006">file.h:6</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="file_8c.html">file.c</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>