<!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: /home/pvrabec/openscap/openscap-0.5.7/src/common/public/oscap.h Source File</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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>/home/pvrabec/openscap/openscap-0.5.7/src/common/public/oscap.h</h1><a href="oscap_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright 2009 Red Hat Inc., Durham, North Carolina.</span>
<a name="l00003"></a>00003 <span class="comment"> * All Rights Reserved.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00007"></a>00007 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This library is distributed in the hope that it will be useful, </span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00016"></a>00016 <span class="comment"> * License along with this library; if not, write to the Free Software </span>
<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * Authors:</span>
<a name="l00020"></a>00020 <span class="comment"> * Lukas Kuklinek <lkuklinek@redhat.com></span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00032"></a>00032 <span class="preprocessor">#ifndef OSCAP_H_</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define OSCAP_H_</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#include <stdbool.h></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <wchar.h></span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="text_8h.html" title="Multilingual text processing interface.">text.h</a>"</span>
<a name="l00038"></a>00038
<a name="l00060"></a><a class="code" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c">00060</a> <span class="preprocessor">#define OSCAP_FOREACH_GENERIC(itype, vtype, val, init_val, code) \</span>
<a name="l00061"></a>00061 <span class="preprocessor"> { \</span>
<a name="l00062"></a>00062 <span class="preprocessor"> struct itype##_iterator *val##_iter = (init_val); \</span>
<a name="l00063"></a>00063 <span class="preprocessor"> vtype val; \</span>
<a name="l00064"></a>00064 <span class="preprocessor"> while (itype##_iterator_has_more(val##_iter)) { \</span>
<a name="l00065"></a>00065 <span class="preprocessor"> val = itype##_iterator_next(val##_iter); \</span>
<a name="l00066"></a>00066 <span class="preprocessor"> code \</span>
<a name="l00067"></a>00067 <span class="preprocessor"> } \</span>
<a name="l00068"></a>00068 <span class="preprocessor"> itype##_iterator_free(val##_iter); \</span>
<a name="l00069"></a>00069 <span class="preprocessor"> }</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span>
<a name="l00079"></a><a class="code" href="group__ITER.html#ga252a13d8be22bb101a8732987eb4e828">00079</a> <span class="preprocessor">#define OSCAP_FOREACH(type, val, init_val, code) \</span>
<a name="l00080"></a>00080 <span class="preprocessor"> OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span>
<a name="l00089"></a><a class="code" href="group__ITER.html#gafdd9cc9b1ae693c07dd4ff9727cfb019">00089</a> <span class="preprocessor">#define OSCAP_FOREACH_STR(val, init_val, code) \</span>
<a name="l00090"></a>00090 <span class="preprocessor"> OSCAP_FOREACH_GENERIC(oscap_string, const char *, val, init_val, code)</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span>
<a name="l00107"></a>00107 <span class="keyword">struct </span><a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a>;
<a name="l00108"></a>00108
<a name="l00110"></a>00110 <span class="keyword">struct </span><a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *<a class="code" href="group__XMLMETA.html#gab2d06ae1c18bbb3a14def7e7d13100d5">xml_metadata_new</a>(<span class="keywordtype">void</span>);
<a name="l00111"></a>00111
<a name="l00113"></a>00113 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__XMLMETA.html#ga399dc2ee22ae6b8d44368c33627b1b08">xml_metadata_get_nspace</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml);
<a name="l00115"></a>00115 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__XMLMETA.html#ga1b1a25ec735fda316de16fb5e5097dbb">xml_metadata_get_lang</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml);
<a name="l00117"></a>00117 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__XMLMETA.html#gaf1f7d35b8d46c047025e9ca31f216974">xml_metadata_get_URI</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml);
<a name="l00118"></a>00118
<a name="l00120"></a>00120 <span class="keywordtype">bool</span> <a class="code" href="group__XMLMETA.html#ga27cd10ad09fa92901d641147f2cace1f">xml_metadata_set_nspace</a>(<span class="keyword">struct</span> <a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml, <span class="keyword">const</span> <span class="keywordtype">char</span> *new_namespace);
<a name="l00122"></a>00122 <span class="keywordtype">bool</span> <a class="code" href="group__XMLMETA.html#gaf4655bb8c0494d6893df1e22f1e2501e">xml_metadata_set_lang</a>(<span class="keyword">struct</span> <a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml, <span class="keyword">const</span> <span class="keywordtype">char</span> *new_lang);
<a name="l00124"></a>00124 <span class="keywordtype">bool</span> <a class="code" href="group__XMLMETA.html#ga2d67981d79eef99f3018bf67fc7fdcb7">xml_metadata_set_URI</a>(<span class="keyword">struct</span> <a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml, <span class="keyword">const</span> <span class="keywordtype">char</span> *new_uri);
<a name="l00125"></a>00125
<a name="l00127"></a>00127 <span class="keywordtype">void</span> <a class="code" href="group__XMLMETA.html#gabcfe5c811a7a43766c694650b386b964">xml_metadata_free</a>(<span class="keyword">struct</span> <a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml);
<a name="l00128"></a>00128
<a name="l00129"></a>00129
<a name="l00130"></a>00130
<a name="l00136"></a>00136 <span class="keyword">struct </span><a class="code" href="structxml__metadata__iterator.html" title="Iterator over XML metadata.">xml_metadata_iterator</a>;
<a name="l00140"></a>00140 <span class="keyword">struct </span><a class="code" href="structxml__metadata.html" title="XML Metadata.">xml_metadata</a> *xml_metadata_iterator_next(<span class="keyword">struct</span> <a class="code" href="structxml__metadata__iterator.html" title="Iterator over XML metadata.">xml_metadata_iterator</a> *it);
<a name="l00144"></a>00144 <span class="keywordtype">bool</span> xml_metadata_iterator_has_more(<span class="keyword">struct</span> <a class="code" href="structxml__metadata__iterator.html" title="Iterator over XML metadata.">xml_metadata_iterator</a> *it);
<a name="l00148"></a>00148 <span class="keywordtype">void</span> xml_metadata_iterator_free(<span class="keyword">struct</span> <a class="code" href="structxml__metadata__iterator.html" title="Iterator over XML metadata.">xml_metadata_iterator</a> *it);
<a name="l00149"></a>00149
<a name="l00153"></a>00153 <span class="keywordtype">void</span> xml_metadata_iterator_remove(<span class="keyword">struct</span> <a class="code" href="structxml__metadata__iterator.html" title="Iterator over XML metadata.">xml_metadata_iterator</a> *it);
<a name="l00154"></a>00154
<a name="l00170"></a>00170 <span class="keyword">struct </span><a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a>;
<a name="l00172"></a>00172 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__STRINGS.html#gabb5dc748268808d8ba0b0ea839391370">oscap_string_iterator_next</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a> *it);
<a name="l00174"></a>00174 <span class="keywordtype">bool</span> <a class="code" href="group__STRINGS.html#gaa2b95bf57e6b0012180cd50b9b2e154d">oscap_string_iterator_has_more</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a> *it);
<a name="l00176"></a>00176 <span class="keywordtype">void</span> <a class="code" href="group__STRINGS.html#ga7d4ac0384a612d7cdff94f6ca114ade1">oscap_string_iterator_free</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a> *it);
<a name="l00178"></a>00178 <span class="keywordtype">void</span> <a class="code" href="group__STRINGS.html#ga101fdba5fc12d17344b6fa58c6e28e2f">oscap_string_iterator_remove</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a> *it);
<a name="l00179"></a>00179
<a name="l00184"></a>00184 <span class="keyword">struct </span><a class="code" href="structoscap__title.html" title="Title of an OpenScap element.">oscap_title</a>;
<a name="l00185"></a>00185
<a name="l00190"></a>00190 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__STRINGS.html#ga496cfac948796026501cdd902c72873d" title="Get oscap title content.">oscap_title_get_content</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__title.html" title="Title of an OpenScap element.">oscap_title</a> *title);
<a name="l00191"></a>00191
<a name="l00196"></a>00196 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__STRINGS.html#gaaed8a56b02bd9836bd762c0714891403" title="Get oscap title language.">oscap_title_get_language</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__title.html" title="Title of an OpenScap element.">oscap_title</a> *title);
<a name="l00197"></a>00197
<a name="l00202"></a>00202 <span class="keywordtype">bool</span> <a class="code" href="group__STRINGS.html#gaa0460513b8149fb8aa7c887bab4b45d0" title="Set oscap title content.">oscap_title_set_content</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__title.html" title="Title of an OpenScap element.">oscap_title</a> *title, <span class="keyword">const</span> <span class="keywordtype">char</span> *new_content);
<a name="l00203"></a>00203
<a name="l00209"></a>00209 <span class="keyword">struct </span><a class="code" href="structoscap__title__iterator.html" title="Iterator over an array of oscap_title elements.">oscap_title_iterator</a>;
<a name="l00211"></a>00211 <span class="keyword">struct </span><a class="code" href="structoscap__title.html" title="Title of an OpenScap element.">oscap_title</a> *<a class="code" href="group__STRINGS.html#gac670e04dad389fad7247518e20c91863">oscap_title_iterator_next</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__title__iterator.html" title="Iterator over an array of oscap_title elements.">oscap_title_iterator</a> *it);
<a name="l00213"></a>00213 <span class="keywordtype">void</span> <a class="code" href="group__STRINGS.html#gaa435255b8c155087fe838b8f24d6030e">oscap_title_iterator_free</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__title__iterator.html" title="Iterator over an array of oscap_title elements.">oscap_title_iterator</a> *it);
<a name="l00215"></a>00215 <span class="keywordtype">bool</span> <a class="code" href="group__STRINGS.html#ga856df9e15ffb52b33ed4a75d67ece468">oscap_title_iterator_has_more</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__title__iterator.html" title="Iterator over an array of oscap_title elements.">oscap_title_iterator</a> *it);
<a name="l00217"></a>00217 <span class="keywordtype">void</span> <a class="code" href="group__STRINGS.html#ga462dbf9096989e01a7abffadc4d6e980">oscap_title_iterator_remove</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__title__iterator.html" title="Iterator over an array of oscap_title elements.">oscap_title_iterator</a> *it);
<a name="l00218"></a>00218
<a name="l00228"></a>00228 <span class="keywordtype">void</span> <a class="code" href="group__COMMON.html#gad47f11d32a4245a127c078d52269312c" title="Release library internal caches.">oscap_cleanup</a>(<span class="keywordtype">void</span>);
<a name="l00229"></a>00229
<a name="l00230"></a>00230
<a name="l00240"></a>00240 <span class="keyword">struct </span><a class="code" href="structoscap__export__target.html">oscap_export_target</a>;
<a name="l00244"></a>00244 <span class="keyword">struct </span><a class="code" href="structoscap__import__source.html">oscap_import_source</a>;
<a name="l00245"></a>00245
<a name="l00249"></a><a class="code" href="group__IMPORTEXPORT.html#ga50294146d55fca89257224182d1f54b4">00249</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00250"></a>00250 OSCAP_STREAM_UNKNOWN = 0,
<a name="l00251"></a>00251 OSCAP_STREAM_FILE = 1,
<a name="l00252"></a>00252 OSCAP_STREAM_URL = 2,
<a name="l00253"></a>00253 } <a class="code" href="group__IMPORTEXPORT.html#ga50294146d55fca89257224182d1f54b4" title="Stream type.">oscap_stream_type_t</a>;
<a name="l00254"></a>00254
<a name="l00259"></a>00259 <a class="code" href="group__IMPORTEXPORT.html#ga50294146d55fca89257224182d1f54b4" title="Stream type.">oscap_stream_type_t</a> <a class="code" href="group__IMPORTEXPORT.html#gab66c2346434d1ec81a06f0e1b7f27b55" title="Get type of this import source.">oscap_import_source_get_type</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__import__source.html">oscap_import_source</a> *item);
<a name="l00260"></a>00260
<a name="l00265"></a>00265 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__IMPORTEXPORT.html#ga4e5728f8d50e9562c7802e93e477e5fc" title="Get name of this import source.">oscap_import_source_get_name</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__import__source.html">oscap_import_source</a> *item);
<a name="l00266"></a>00266
<a name="l00271"></a>00271 <a class="code" href="group__IMPORTEXPORT.html#ga50294146d55fca89257224182d1f54b4" title="Stream type.">oscap_stream_type_t</a> <a class="code" href="group__IMPORTEXPORT.html#ga6817ae8f6e228d4ceae1e9880d47ac10" title="Get type of this export target.">oscap_export_target_get_type</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__export__target.html">oscap_export_target</a> *item);
<a name="l00272"></a>00272
<a name="l00277"></a>00277 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__IMPORTEXPORT.html#ga625c9b2ead8e54faca039900941646c6" title="Get name of this export target.">oscap_export_target_get_name</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__export__target.html">oscap_export_target</a> *item);
<a name="l00278"></a>00278
<a name="l00283"></a>00283 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__IMPORTEXPORT.html#gad51819649d0cef2fd0daacea292ab1e9" title="Get encoding for this export target.">oscap_export_target_get_encoding</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__export__target.html">oscap_export_target</a> *item);
<a name="l00284"></a>00284
<a name="l00289"></a>00289 <span class="keywordtype">int</span> <a class="code" href="group__IMPORTEXPORT.html#ga133eb7c6e726e5d7414cb8d1b7dd27cd" title="Get indentation for this export target.">oscap_export_target_get_indent</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__export__target.html">oscap_export_target</a> *item);
<a name="l00290"></a>00290
<a name="l00295"></a>00295 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__IMPORTEXPORT.html#ga40e7960a850ff299850b10b5d289f51c" title="Get indentation string for this export target.">oscap_export_target_get_indent_string</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__export__target.html">oscap_export_target</a> *item);
<a name="l00296"></a>00296
<a name="l00301"></a>00301 <span class="keyword">struct </span><a class="code" href="structoscap__import__source.html">oscap_import_source</a> *<a class="code" href="group__IMPORTEXPORT.html#gaaf2e67c62f398583940fae9f5ca1bc79" title="Function returns new import source structure, or NULL if an error occurred.">oscap_import_source_new_file</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keyword">const</span> <span class="keywordtype">char</span> *encoding);
<a name="l00302"></a>00302
<a name="l00307"></a>00307 <span class="keyword">struct </span><a class="code" href="structoscap__import__source.html">oscap_import_source</a> *<a class="code" href="group__IMPORTEXPORT.html#ga33168f86d59307859fa59c50ee9a3676" title="Function returns new import source structure, or NULL if an error occurred.">oscap_import_source_new_URL</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *encoding);
<a name="l00308"></a>00308
<a name="l00313"></a>00313 <span class="keywordtype">void</span> <a class="code" href="group__IMPORTEXPORT.html#ga9f2f848bbed3681796f125bc5f6aa970" title="Destroy this import source structure.">oscap_import_source_free</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__import__source.html">oscap_import_source</a> *target);
<a name="l00314"></a>00314
<a name="l00319"></a>00319 <span class="keyword">struct </span><a class="code" href="structoscap__export__target.html">oscap_export_target</a> *<a class="code" href="group__IMPORTEXPORT.html#gae9c7e1964f8fafae14467d2d8bc826b8" title="Function returns new export target structure, or NULL if an error occurred.">oscap_export_target_new_file</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keyword">const</span> <span class="keywordtype">char</span> *encoding);
<a name="l00320"></a>00320
<a name="l00325"></a>00325 <span class="keyword">struct </span><a class="code" href="structoscap__export__target.html">oscap_export_target</a> *<a class="code" href="group__IMPORTEXPORT.html#ga3db3d64d3c2a46b9adac63cc9f4eb0d2" title="Function returns new export target structure, or NULL if an error occurred.">oscap_export_target_new_URL</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *encoding);
<a name="l00326"></a>00326
<a name="l00331"></a>00331 <span class="keywordtype">void</span> <a class="code" href="group__IMPORTEXPORT.html#ga53f6362ae846f596ca3160d21fe293c5" title="Destroy this export target structure.">oscap_export_target_free</a>(<span class="keyword">struct</span> <a class="code" href="structoscap__export__target.html">oscap_export_target</a> *target);
<a name="l00332"></a>00332
<a name="l00335"></a>00335 <span class="preprocessor">#endif</span>
</pre></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>
