<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libini_config: ini_comment.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libini_config <span id="projectnumber">0.1.3</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="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.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <div class="title">ini_comment.h</div> </div> </div> <div class="contents"> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> INI LIBRARY</span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment"> Header file for comment object.</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> Copyright (C) Dmitri Pal <dpal@redhat.com> 2010</span> <a name="l00007"></a>00007 <span class="comment"></span> <a name="l00008"></a>00008 <span class="comment"> INI Library is free software: you can redistribute it and/or modify</span> <a name="l00009"></a>00009 <span class="comment"> it under the terms of the GNU Lesser General Public License as published by</span> <a name="l00010"></a>00010 <span class="comment"> the Free Software Foundation, either version 3 of the License, or</span> <a name="l00011"></a>00011 <span class="comment"> (at your option) any later version.</span> <a name="l00012"></a>00012 <span class="comment"></span> <a name="l00013"></a>00013 <span class="comment"> INI Library is distributed in the hope that it will be useful,</span> <a name="l00014"></a>00014 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00015"></a>00015 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00016"></a>00016 <span class="comment"> GNU Lesser General Public License for more details.</span> <a name="l00017"></a>00017 <span class="comment"></span> <a name="l00018"></a>00018 <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span> <a name="l00019"></a>00019 <span class="comment"> along with INI Library. If not, see <http://www.gnu.org/licenses/>.</span> <a name="l00020"></a>00020 <span class="comment">*/</span> <a name="l00021"></a>00021 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef INI_COMMENT_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INI_COMMENT_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <stdint.h></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <stdio.h></span> <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="preprocessor">#ifndef EOK</span> <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define EOK 0</span> <a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00031"></a>00031 <span class="preprocessor"></span> <a name="l00032"></a>00032 <span class="keyword">struct </span>ini_comment; <a name="l00033"></a>00033 <a name="l00037"></a>00037 <span class="keywordtype">int</span> ini_comment_create(<span class="keyword">struct</span> ini_comment **ic); <a name="l00038"></a>00038 <a name="l00042"></a>00042 <span class="keywordtype">void</span> ini_comment_destroy(<span class="keyword">struct</span> ini_comment *ic); <a name="l00043"></a>00043 <a name="l00048"></a>00048 <span class="keywordtype">int</span> ini_comment_build(<span class="keyword">struct</span> ini_comment *ic, <a name="l00049"></a>00049 <span class="keyword">const</span> <span class="keywordtype">char</span> *line); <a name="l00050"></a>00050 <a name="l00063"></a>00063 <span class="keywordtype">int</span> ini_comment_insert(<span class="keyword">struct</span> ini_comment *ic, <a name="l00064"></a>00064 uint32_t idx, <a name="l00065"></a>00065 <span class="keyword">const</span> <span class="keywordtype">char</span> *line); <a name="l00066"></a>00066 <a name="l00067"></a>00067 <span class="comment">/* Modify comment by appending a line. */</span> <a name="l00068"></a>00068 <span class="keywordtype">int</span> ini_comment_append(<span class="keyword">struct</span> ini_comment *ic, <a name="l00069"></a>00069 <span class="keyword">const</span> <span class="keywordtype">char</span> *line); <a name="l00070"></a>00070 <a name="l00071"></a>00071 <span class="comment">/* Remove line from the comment.*/</span> <a name="l00072"></a>00072 <span class="keywordtype">int</span> ini_comment_remove(<span class="keyword">struct</span> ini_comment *ic, <a name="l00073"></a>00073 uint32_t idx); <a name="l00074"></a>00074 <a name="l00075"></a>00075 <span class="comment">/* Clear line in the comment. Line is replaced with an empty line */</span> <a name="l00076"></a>00076 <span class="keywordtype">int</span> ini_comment_clear(<span class="keyword">struct</span> ini_comment *ic, <a name="l00077"></a>00077 uint32_t idx); <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="comment">/* Replace a line in the comment */</span> <a name="l00080"></a>00080 <span class="keywordtype">int</span> ini_comment_replace(<span class="keyword">struct</span> ini_comment *ic, <a name="l00081"></a>00081 uint32_t idx, <a name="l00082"></a>00082 <span class="keyword">const</span> <span class="keywordtype">char</span> *line); <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="comment">/* Reset the comment - clean all lines.*/</span> <a name="l00085"></a>00085 <span class="keywordtype">int</span> ini_comment_reset(<span class="keyword">struct</span> ini_comment *ic); <a name="l00086"></a>00086 <a name="l00087"></a>00087 <span class="comment">/* Get number of lines */</span> <a name="l00088"></a>00088 <span class="keywordtype">int</span> ini_comment_get_numlines(<span class="keyword">struct</span> ini_comment *ic, <a name="l00089"></a>00089 uint32_t *num); <a name="l00090"></a>00090 <a name="l00091"></a>00091 <span class="comment">/* Get line */</span> <a name="l00092"></a>00092 <span class="keywordtype">int</span> ini_comment_get_line(<span class="keyword">struct</span> ini_comment *ic, <a name="l00093"></a>00093 uint32_t idx, <a name="l00094"></a>00094 <span class="keywordtype">char</span> **line); <a name="l00095"></a>00095 <a name="l00096"></a>00096 <span class="comment">/* Swap lines */</span> <a name="l00097"></a>00097 <span class="keywordtype">int</span> ini_comment_swap(<span class="keyword">struct</span> ini_comment *ic, <a name="l00098"></a>00098 uint32_t idx1, <a name="l00099"></a>00099 uint32_t idx2); <a name="l00100"></a>00100 <a name="l00101"></a>00101 <a name="l00102"></a>00102 <span class="comment">/* Internal function to print comment */</span> <a name="l00103"></a>00103 <span class="keywordtype">void</span> ini_comment_print(<span class="keyword">struct</span> ini_comment *ic, FILE *file); <a name="l00104"></a>00104 <a name="l00105"></a>00105 <a name="l00106"></a>00106 <span class="preprocessor">#endif</span> </pre></div></div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Thu Sep 15 2011 for libini_config by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>