<!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>Open SCAP Library: Iterators & collections</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.4 --> <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">Open SCAP Library</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="pages.html"><span>Related Pages</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><a href="files.html"><span>Files</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#define-members">Defines</a> </div> <div class="headertitle"> <div class="title">Iterators & collections</div> </div> <div class="ingroups"><a class="el" href="group__COMMON.html">Common</a></div></div> <div class="contents"> <p>Iterators concept. <a href="#details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c">OSCAP_FOREACH_GENERIC</a>(itype, vtype, val, init_val, code)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#gaea98dedf8ff9418609496bb11ff8c66c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga252a13d8be22bb101a8732987eb4e828">OSCAP_FOREACH</a>(type, val, init_val, code)   OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#ga252a13d8be22bb101a8732987eb4e828"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gafdd9cc9b1ae693c07dd4ff9727cfb019">OSCAP_FOREACH_STR</a>(val, init_val, code)   OSCAP_FOREACH_GENERIC(oscap_string, const char *, val, init_val, code)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array of strings, given an iterator. <a href="#gafdd9cc9b1ae693c07dd4ff9727cfb019"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69">OSCAP_FOR_GENERIC</a>(itype, vtype, val, init_val)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#gae94ba5c82c04c4119b11bbf8be56ed69"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga4531eed65f8744afef6718920525395c">OSCAP_FOR</a>(type, val, init_val)   OSCAP_FOR_GENERIC(type, struct type *, val, init_val)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#ga4531eed65f8744afef6718920525395c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga9f9c24f232e5ad2aeeeed602b7b0008c">OSCAP_FOR_STR</a>(val, init_val)   OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array of strings, given an iterator. <a href="#ga9f9c24f232e5ad2aeeeed602b7b0008c"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <p>Iterators concept. </p> <p>Any iterator name takes a form of <code>struct OBJECT_iterator</code>, where <code>OBJECT</code> is a name of particular datatype the iterator iterates over.</p> <p>Each iterator type defines several manipulation functions, namely:</p> <ul> <li><code>OBJECT_iterator_has_more</code> - returns true if there is anything left to iterate over</li> <li><code>OBJECT_iterator_next</code> - returns next item in the collection</li> <li><code>OBJECT_iterator_free</code> - destroys the iterator</li> </ul> <p>You can also use <a class="el" href="group__ITER.html#ga252a13d8be22bb101a8732987eb4e828">OSCAP_FOREACH</a> convience macro. </p> <hr/><h2>Define Documentation</h2> <a class="anchor" id="ga4531eed65f8744afef6718920525395c"></a><!-- doxytag: member="oscap.h::OSCAP_FOR" ref="ga4531eed65f8744afef6718920525395c" args="(type, val, init_val)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_FOR</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">type, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">init_val </td> </tr> <tr> <td></td> <td>)</td> <td></td><td>   OSCAP_FOR_GENERIC(type, struct type *, val, init_val)</td> </tr> </table> </div> <div class="memdoc"> <p>Iterate over an array, given an iterator. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">type</td><td>type of array elements (w/o the struct keyword) </td></tr> <tr><td class="paramname">val</td><td>name of an variable the member will be sequentially stored in </td></tr> <tr><td class="paramname">init_val</td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69" title="Iterate over an array, given an iterator.">OSCAP_FOR_GENERIC</a> </dd></dl> </div> </div> <a class="anchor" id="gae94ba5c82c04c4119b11bbf8be56ed69"></a><!-- doxytag: member="oscap.h::OSCAP_FOR_GENERIC" ref="gae94ba5c82c04c4119b11bbf8be56ed69" args="(itype, vtype, val, init_val)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_FOR_GENERIC</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">itype, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">vtype, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">init_val </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <b>Value:</b><div class="fragment"><pre class="fragment">vtype val = NULL; <span class="keyword">struct </span>itype##_iterator *val##_iter = (init_val); \ <span class="keywordflow">while</span> (itype##_iterator_has_more(val##_iter) \ ? (val = itype##_iterator_next(val##_iter), <span class="keyword">true</span>) \ : (itype##_iterator_free(val##_iter), val##_iter = NULL, <span class="keyword">false</span>)) </pre></div> <p>Iterate over an array, given an iterator. </p> <p>It is generally not safe to use break, return or goto inside the loop (iterator wouldn't be properly freed otherwise). Two variables, named VAL and VAL_iter (substitute VAL for actual macro argument) will be added to current variable scope. You can free the iterator explicitly after previous unusual escape from the loop (e.g. using break). </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">val</td><td>name of an variable the string will be sequentially stored in </td></tr> <tr><td class="paramname">init_val</td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr> <tr><td class="paramname">code</td><td>code to be executed for each string the iterator hits </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga9f9c24f232e5ad2aeeeed602b7b0008c"></a><!-- doxytag: member="oscap.h::OSCAP_FOR_STR" ref="ga9f9c24f232e5ad2aeeeed602b7b0008c" args="(val, init_val)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_FOR_STR</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">init_val </td> </tr> <tr> <td></td> <td>)</td> <td></td><td>   OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)</td> </tr> </table> </div> <div class="memdoc"> <p>Iterate over an array of strings, given an iterator. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">val</td><td>name of an variable the member will be sequentially stored in </td></tr> <tr><td class="paramname">init_val</td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69" title="Iterate over an array, given an iterator.">OSCAP_FOR_GENERIC</a> </dd></dl> </div> </div> <a class="anchor" id="ga252a13d8be22bb101a8732987eb4e828"></a><!-- doxytag: member="oscap.h::OSCAP_FOREACH" ref="ga252a13d8be22bb101a8732987eb4e828" args="(type, val, init_val, code)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_FOREACH</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">type, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">init_val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">code </td> </tr> <tr> <td></td> <td>)</td> <td></td><td>   OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)</td> </tr> </table> </div> <div class="memdoc"> <p>Iterate over an array, given an iterator. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">type</td><td>type of array elements (w/o the struct keyword) </td></tr> <tr><td class="paramname">val</td><td>name of an variable the member will be sequentially stored in </td></tr> <tr><td class="paramname">init_val</td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr> <tr><td class="paramname">code</td><td>code to be executed for each element the iterator hits </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c" title="Iterate over an array, given an iterator.">OSCAP_FOREACH_GENERIC</a> </dd></dl> </div> </div> <a class="anchor" id="gaea98dedf8ff9418609496bb11ff8c66c"></a><!-- doxytag: member="oscap.h::OSCAP_FOREACH_GENERIC" ref="gaea98dedf8ff9418609496bb11ff8c66c" args="(itype, vtype, val, init_val, code)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_FOREACH_GENERIC</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">itype, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">vtype, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">init_val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">code </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <b>Value:</b><div class="fragment"><pre class="fragment">{ \ <span class="keyword">struct </span>itype##_iterator *val##_iter = (init_val); \ vtype val; \ <span class="keywordflow">while</span> (itype##_iterator_has_more(val##_iter)) { \ val = itype##_iterator_next(val##_iter); \ code \ } \ itype##_iterator_free(val##_iter); \ } </pre></div> <p>Iterate over an array, given an iterator. </p> <p>Execute <em>code</em> for each array member stored in <em>val</em>. It is NOT safe to use return or goto inside of the <em>code</em>, the iterator would not be freed properly. </p> </div> </div> <a class="anchor" id="gafdd9cc9b1ae693c07dd4ff9727cfb019"></a><!-- doxytag: member="oscap.h::OSCAP_FOREACH_STR" ref="gafdd9cc9b1ae693c07dd4ff9727cfb019" args="(val, init_val, code)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_FOREACH_STR</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">init_val, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">code </td> </tr> <tr> <td></td> <td>)</td> <td></td><td>   OSCAP_FOREACH_GENERIC(oscap_string, const char *, val, init_val, code)</td> </tr> </table> </div> <div class="memdoc"> <p>Iterate over an array of strings, given an iterator. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">val</td><td>name of an variable the string will be sequentially stored in </td></tr> <tr><td class="paramname">init_val</td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr> <tr><td class="paramname">code</td><td>code to be executed for each string the iterator hits </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c" title="Iterate over an array, given an iterator.">OSCAP_FOREACH_GENERIC</a> </dd></dl> </div> </div> </div> <hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library 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>