<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Open SCAP Library: scap_ds.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>
<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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open SCAP Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2602f4ddeed24e12bf976085a65cde76.html">DS</a></li><li class="navelem"><a class="el" href="dir_ba867982a4d200e2de341b2bac236905.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">scap_ds.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="scap__ds_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Copyright 2012 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * This library is distributed in the hope that it will be useful, </span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * License along with this library; if not, write to the Free Software </span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Authors:</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * Martin Preisler <mpreisle@redhat.com></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef OPENSCAP_DS_H</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#define OPENSCAP_DS_H</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="oscap_8h.html" title="General OpenScap functions and types.">oscap.h</a>"</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">int</span> <a class="code" href="group__DS.html#gac1c9f21670e515b210713a0130e4d25d" title="takes given source data stream and decomposes it into separate files">ds_sds_decompose</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* input_file, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">id</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* xccdf_id,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* target_dir, <span class="keyword">const</span> <span class="keywordtype">char</span>* target_filename);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">int</span> <a class="code" href="group__DS.html#ga91b8af7a5474710bc420ddf930592622" title="same as ds_sds_decompose but works with other components than just XCCDFs">ds_sds_decompose_custom</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* input_file, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">id</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* target_dir,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* container_name, <span class="keyword">const</span> <span class="keywordtype">char</span>* component_id, <span class="keyword">const</span> <span class="keywordtype">char</span>* target_filename);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">int</span> <a class="code" href="group__DS.html#ga958fcec57e9e60682d5ff9c52912a724" title="takes given xccdf file and constructs a source datastream">ds_sds_compose_from_xccdf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* xccdf_file, <span class="keyword">const</span> <span class="keywordtype">char</span>* target_datastream);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">int</span> <a class="code" href="group__DS.html#ga601587bd53df79981bcb3c079a9f2519" title="append a new given component to the existing source datastream">ds_sds_compose_add_component</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *target_datastream, <span class="keyword">const</span> <span class="keywordtype">char</span> *datastream_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *new_component, <span class="keywordtype">bool</span> extended);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="keywordtype">int</span> <a class="code" href="group__DS.html#ga31bf69e775dee7bb0dc55bc533cc8e7b" title="takes given source data stream and XCCDF result file and makes a result data stream">ds_rds_create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* sds_file, <span class="keyword">const</span> <span class="keywordtype">char</span>* xccdf_result_file,</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>** oval_result_files, <span class="keyword">const</span> <span class="keywordtype">char</span>* target_file);</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keyword">struct </span><a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>;</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="keyword">struct </span><a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* <a class="code" href="group__DS.html#gaa61e25f2897a84bd5f73ac83bad81f35">ds_stream_index_new</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="keywordtype">void</span> <a class="code" href="group__DS.html#ga3527d9341e1c22a3257d6452011e0ff3">ds_stream_index_free</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__DS.html#ga21b2c036fcd648fb60afe2eae7fbe6fe" title="Gets ID of the <data-stream> element the index represents.">ds_stream_index_get_id</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__DS.html#ga60ff80c354d57880c322fd29b1a2cad3" title="Timestamp of creation OR modification of the <data-stream> element the index represents.">ds_stream_index_get_timestamp</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__DS.html#ga552a53be748e1a6ab64f62197c9a49cf" title="scap-version of the the <data-stream> element the index represents.">ds_stream_index_get_version</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="keyword">struct </span><a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a>* <a class="code" href="group__DS.html#gaa89d4716719b92c9be602789c0ab6246" title="Retrieves iterator over all components inside the <checks> element.">ds_stream_index_get_checks</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="keyword">struct </span><a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a>* <a class="code" href="group__DS.html#ga80fdc9afd11a6caa8fef301339090133" title="Retrieves iterator over all components inside the <checklists> element.">ds_stream_index_get_checklists</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="keyword">struct </span><a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a>* <a class="code" href="group__DS.html#gaec7115cb582ba2ac73634a34a9a843cd" title="Retrieves iterator over all components inside the <dictionaries> element.">ds_stream_index_get_dictionaries</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="keyword">struct </span><a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a>* <a class="code" href="group__DS.html#ga698025169a01226da062ac880f03b318" title="Retrieves iterator over all components inside the <extended-components> element.">ds_stream_index_get_extended_components</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* s);</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="keyword">struct </span><a class="code" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a>;</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="keyword">struct </span><a class="code" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a>* <a class="code" href="group__DS.html#ga0f61041d3e043f120d4c9ca7bb9943e9">ds_sds_index_new</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="keywordtype">void</span> <a class="code" href="group__DS.html#gaf9892255b4eebb1b0db65f6c1a988367">ds_sds_index_free</a>(<span class="keyword">struct</span> <a class="code" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a>* s);</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="keyword">struct </span><a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a>* <a class="code" href="group__DS.html#ga4a82a376e095479ecab0d2a421d38e47" title="retrieves a stream index by data-stream ID">ds_sds_index_get_stream</a>(<span class="keyword">struct</span> <a class="code" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a>* s, <span class="keyword">const</span> <span class="keywordtype">char</span>* stream_id);</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="keyword">struct </span><a class="code" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a>* <a class="code" href="group__DS.html#ga515b5d593a00f05bff7576107cc3ded3" title="retrieves all streams indexed inside this structure">ds_sds_index_get_streams</a>(<span class="keyword">struct</span> <a class="code" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a>* s);</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="keyword">struct </span><a class="code" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a> *<a class="code" href="group__DS.html#gaa6de056f9e4eeb1bd0a064954b7a5ee8" title="imports given source datastream and indexes it">ds_sds_index_import</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* file);</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="keywordtype">int</span> <a class="code" href="group__DS.html#ga9ae8ef1864feec0a5fbba8b8d8be3dd1" title="chooses datastream and checklist id combination given the IDs">ds_sds_index_select_checklist</a>(<span class="keyword">struct</span> <a class="code" href="structds__sds__index.html" title="Represents <data-stream-collection> element - the root element of each source datastream.">ds_sds_index</a>* s,</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>** datastream_id, <span class="keyword">const</span> <span class="keywordtype">char</span>** component_id);</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="keyword">struct </span><a class="code" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a>;</div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="keyword">struct </span><a class="code" href="structds__stream__index.html" title="Contains information about one particular "<data-stream>" element in the datastream collection (also ...">ds_stream_index</a> *<a class="code" href="group__DS.html#ga86d6f16dbc87d982027adc3544d67114">ds_stream_index_iterator_next</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> *it);</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="keywordtype">bool</span> <a class="code" href="group__DS.html#ga25530912cfceaef0c7cc9e834ce85f09">ds_stream_index_iterator_has_more</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> *it);</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="keywordtype">void</span> <a class="code" href="group__DS.html#gab875fcb954ad3a869539e498c1a50fdc">ds_stream_index_iterator_free</a>(<span class="keyword">struct</span> <a class="code" href="structds__stream__index__iterator.html">ds_stream_index_iterator</a> *it);</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">/************************************************************/</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
