<!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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="contents">
<h1>Iterators & collections<br/>
<small>
[<a class="el" href="group__COMMON.html">COMMON</a>]</small>
</h1>
<p>OpenScap iterators concept.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>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>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>OpenScap 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="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">type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">code </td>
<td class="paramname"></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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>type of array elements (w/o the struct keyword) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>name of an variable the member will be sequentially stored in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>init_val</em> </td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </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">itype, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vtype, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">code </td>
<td class="paramname"></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>. </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">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">code </td>
<td class="paramname"></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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>name of an variable the string will be sequentially stored in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>init_val</em> </td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </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 size="1"/><address style="text-align: right;"><small>Generated on 26 Feb 2010 for Open SCAP Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
