| Current File : //usr/share/docs/openscap/html/oscap__source_8h_source.html |
<!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"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>Open SCAP Library: oscap_source.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="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">
$(document).ready(function() { init_search(); });
</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.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<li>
<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>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_94e7a0fbe7f8eaf7f05ee7b02c647e9f.html">source</a></li><li class="navelem"><a class="el" href="dir_3b5e47645bc5f60cc2ad86c266d5d404.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">oscap_source.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2014 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</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"> * Author:</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Šimon Lukašík</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef OSCAP_SOURCE_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define OSCAP_SOURCE_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifdef HAVE_CONFIG_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <config.h></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="oscap_8h.html">oscap.h</a>"</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">struct </span><a class="code" href="structoscap__source.html">oscap_source</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">struct </span><a class="code" href="structoscap__source.html">oscap_source</a> *oscap_source_new_from_file(<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structoscap__source.html#a76b9bd3e067a60fbe5510a96989f904a">filepath</a>);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">struct </span><a class="code" href="structoscap__source.html">oscap_source</a> *oscap_source_new_from_memory(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structoscap__source.html#a76b9bd3e067a60fbe5510a96989f904a">filepath</a>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">void</span> oscap_source_free(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <a class="code" href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a> <a class="code" href="structoscap__source.html#aa98424428d864394cfaec5207264b705">oscap_source_get_scap_type</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structoscap__source.html#aedc10bab5b32e7136578fd29fee95973">oscap_source_get_schema_version</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">int</span> <a class="code" href="structoscap__source.html#a429a425e7c1ba8b0f2bd3582512f5a6d">oscap_source_validate</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source, xml_reporter <a class="code" href="structreporter.html">reporter</a>, <span class="keywordtype">void</span> *user);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="keywordtype">int</span> <a class="code" href="structoscap__source.html#a26cb3dc5aef46c193875934a3c0ed047">oscap_source_validate_schematron</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source, <span class="keyword">const</span> <span class="keywordtype">char</span> *outfile);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structoscap__source.html#a4d4ee1bb74d4860d7a80b5413f76b951">oscap_source_readable_origin</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="keywordtype">int</span> <a class="code" href="structoscap__source.html#a4b62bdcf30b7e0b132daa25f352a4b36">oscap_source_save_as</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="keywordtype">int</span> oscap_source_get_raw_memory(<span class="keyword">struct</span> <a class="code" href="structoscap__source.html">oscap_source</a> *source, <span class="keywordtype">char</span> **buffer, <span class="keywordtype">size_t</span> *size);</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="structreporter_html"><div class="ttname"><a href="structreporter.html">reporter</a></div><div class="ttdef"><b>Definition:</b> reporter.c:31</div></div>
<div class="ttc" id="oscap_8h_html"><div class="ttname"><a href="oscap_8h.html">oscap.h</a></div><div class="ttdoc">General OpenScap functions and types. </div></div>
<div class="ttc" id="structoscap__source_html_a76b9bd3e067a60fbe5510a96989f904a"><div class="ttname"><a href="structoscap__source.html#a76b9bd3e067a60fbe5510a96989f904a">oscap_source::filepath</a></div><div class="ttdeci">char * filepath</div><div class="ttdoc">Filepath (if originated from file) </div><div class="ttdef"><b>Definition:</b> oscap_source.c:66</div></div>
<div class="ttc" id="structoscap__source_html_a4b62bdcf30b7e0b132daa25f352a4b36"><div class="ttname"><a href="structoscap__source.html#a4b62bdcf30b7e0b132daa25f352a4b36">oscap_source::oscap_source_save_as</a></div><div class="ttdeci">int oscap_source_save_as(struct oscap_source *source, const char *filename)</div><div class="ttdoc">Store the resource represented by oscap_source to the file. </div><div class="ttdef"><b>Definition:</b> oscap_source.c:327</div></div>
<div class="ttc" id="structoscap__source_html_a26cb3dc5aef46c193875934a3c0ed047"><div class="ttname"><a href="structoscap__source.html#a26cb3dc5aef46c193875934a3c0ed047">oscap_source::oscap_source_validate_schematron</a></div><div class="ttdeci">int oscap_source_validate_schematron(struct oscap_source *source, const char *outfile)</div><div class="ttdoc">Validate the SCAP document against schematron assertions. </div><div class="ttdef"><b>Definition:</b> oscap_source.c:272</div></div>
<div class="ttc" id="group__VALID_html_gac979f1141240cd8d0a762a2be9341965"><div class="ttname"><a href="group__VALID.html#gac979f1141240cd8d0a762a2be9341965">oscap_document_type_t</a></div><div class="ttdeci">enum oscap_document_type oscap_document_type_t</div><div class="ttdoc">SCAP document type identifiers. </div></div>
<div class="ttc" id="structoscap__source_html"><div class="ttname"><a href="structoscap__source.html">oscap_source</a></div><div class="ttdef"><b>Definition:</b> oscap_source.c:61</div></div>
<div class="ttc" id="structoscap__source_html_a429a425e7c1ba8b0f2bd3582512f5a6d"><div class="ttname"><a href="structoscap__source.html#a429a425e7c1ba8b0f2bd3582512f5a6d">oscap_source::oscap_source_validate</a></div><div class="ttdeci">int oscap_source_validate(struct oscap_source *source, xml_reporter reporter, void *user)</div><div class="ttdoc">Validate the SCAP document against particular XML schema definition. </div><div class="ttdef"><b>Definition:</b> oscap_source.c:252</div></div>
<div class="ttc" id="structoscap__source_html_a4d4ee1bb74d4860d7a80b5413f76b951"><div class="ttname"><a href="structoscap__source.html#a4d4ee1bb74d4860d7a80b5413f76b951">oscap_source::oscap_source_readable_origin</a></div><div class="ttdeci">const char * oscap_source_readable_origin(const struct oscap_source *source)</div><div class="ttdoc">Returns human readable description of oscap_source origin. </div><div class="ttdef"><b>Definition:</b> oscap_source.c:141</div></div>
<div class="ttc" id="structoscap__source_html_aa98424428d864394cfaec5207264b705"><div class="ttname"><a href="structoscap__source.html#aa98424428d864394cfaec5207264b705">oscap_source::oscap_source_get_scap_type</a></div><div class="ttdeci">oscap_document_type_t oscap_source_get_scap_type(struct oscap_source *source)</div><div class="ttdoc">Get SCAP document type of the given resource. </div><div class="ttdef"><b>Definition:</b> oscap_source.c:162</div></div>
<div class="ttc" id="structoscap__source_html_aedc10bab5b32e7136578fd29fee95973"><div class="ttname"><a href="structoscap__source.html#aedc10bab5b32e7136578fd29fee95973">oscap_source::oscap_source_get_schema_version</a></div><div class="ttdeci">const char * oscap_source_get_schema_version(struct oscap_source *source)</div><div class="ttdoc">Get the version of the schema for the particular document type. </div><div class="ttdef"><b>Definition:</b> oscap_source.c:278</div></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.9.1
</small></address>
</body>
</html>