<!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.6"/> <title>createrepo_c library: Package parser API.</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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">createrepo_c library  <span id="projectnumber">0.7.4</span> </div> <div id="projectbrief">C library for metadata manipulation</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <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="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> <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><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('group__parsepkg.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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 class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Package parser API.</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga85c50ddb6e3b9b68b0699d5e62b17a78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parsepkg.html#ga85c50ddb6e3b9b68b0699d5e62b17a78">cr_package_parser_init</a> ()</td></tr> <tr class="separator:ga85c50ddb6e3b9b68b0699d5e62b17a78"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga60f630600d4e288250ff44343c335dab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parsepkg.html#ga60f630600d4e288250ff44343c335dab">cr_package_parser_cleanup</a> ()</td></tr> <tr class="separator:ga60f630600d4e288250ff44343c335dab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0cd31ef7af819a645c65d7fc7376cb3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcr___package.html">cr_Package</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parsepkg.html#ga0cd31ef7af819a645c65d7fc7376cb3a">cr_package_from_rpm_base</a> (const char *filename, int changelog_limit, <a class="el" href="group__parsehdr.html#ga6b208f9f479d6b8a1ab8a116641b8a85">cr_HeaderReadingFlags</a> flags, GError **err)</td></tr> <tr class="separator:ga0cd31ef7af819a645c65d7fc7376cb3a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa9f0d72bfc2bb71fc92a291d41160f3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcr___package.html">cr_Package</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parsepkg.html#gaa9f0d72bfc2bb71fc92a291d41160f3d">cr_package_from_rpm</a> (const char *filename, <a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> checksum_type, const char *location_href, const char *location_base, int changelog_limit, struct stat *stat_buf, <a class="el" href="group__parsehdr.html#ga6b208f9f479d6b8a1ab8a116641b8a85">cr_HeaderReadingFlags</a> flags, GError **err)</td></tr> <tr class="separator:gaa9f0d72bfc2bb71fc92a291d41160f3d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1d453c4690ab63705c0ef870c1166e71"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcr___xml_struct.html">cr_XmlStruct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parsepkg.html#ga1d453c4690ab63705c0ef870c1166e71">cr_xml_from_rpm</a> (const char *filename, <a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> checksum_type, const char *location_href, const char *location_base, int changelog_limit, struct stat *stat_buf, GError **err)</td></tr> <tr class="separator:ga1d453c4690ab63705c0ef870c1166e71"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="gaa9f0d72bfc2bb71fc92a291d41160f3d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structcr___package.html">cr_Package</a>* cr_package_from_rpm </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>filename</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> </td> <td class="paramname"><em>checksum_type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>location_href</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>location_base</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>changelog_limit</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct stat * </td> <td class="paramname"><em>stat_buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__parsehdr.html#ga6b208f9f479d6b8a1ab8a116641b8a85">cr_HeaderReadingFlags</a> </td> <td class="paramname"><em>flags</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GError ** </td> <td class="paramname"><em>err</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Generate a package object from a package file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">filename</td><td>filename </td></tr> <tr><td class="paramname">checksum_type</td><td>type of checksum to be used </td></tr> <tr><td class="paramname">location_href</td><td>package location inside repository </td></tr> <tr><td class="paramname">location_base</td><td>location (url) of repository </td></tr> <tr><td class="paramname">changelog_limit</td><td>number of changelog entries </td></tr> <tr><td class="paramname">stat_buf</td><td>struct stat of the filename (optional - could be NULL) </td></tr> <tr><td class="paramname">flags</td><td>Flags for header reading </td></tr> <tr><td class="paramname">err</td><td>GError ** </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structcr___package.html">cr_Package</a> or NULL on error </dd></dl> </div> </div> <a class="anchor" id="ga0cd31ef7af819a645c65d7fc7376cb3a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structcr___package.html">cr_Package</a>* cr_package_from_rpm_base </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>filename</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>changelog_limit</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__parsehdr.html#ga6b208f9f479d6b8a1ab8a116641b8a85">cr_HeaderReadingFlags</a> </td> <td class="paramname"><em>flags</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GError ** </td> <td class="paramname"><em>err</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Generate a package object from a package file. Some attributes like pkgId (checksum), checksum_type, time_file, location_href, location_base, rpm_header_start, rpm_header_end are not filled. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">filename</td><td>filename </td></tr> <tr><td class="paramname">changelog_limit</td><td>number of changelogs that will be loaded </td></tr> <tr><td class="paramname">flags</td><td>Flags for header reading </td></tr> <tr><td class="paramname">err</td><td>GError ** </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structcr___package.html">cr_Package</a> or NULL on error </dd></dl> </div> </div> <a class="anchor" id="ga60f630600d4e288250ff44343c335dab"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cr_package_parser_cleanup </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free global structures for package parsing. </p> </div> </div> <a class="anchor" id="ga85c50ddb6e3b9b68b0699d5e62b17a78"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cr_package_parser_init </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize global structures for package parsing. This function call rpmReadConfigFiles() and create global transaction set. This function should be called only once! This function is not thread safe! </p> </div> </div> <a class="anchor" id="ga1d453c4690ab63705c0ef870c1166e71"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structcr___xml_struct.html">cr_XmlStruct</a> cr_xml_from_rpm </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>filename</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> </td> <td class="paramname"><em>checksum_type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>location_href</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>location_base</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>changelog_limit</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct stat * </td> <td class="paramname"><em>stat_buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GError ** </td> <td class="paramname"><em>err</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Generate XML for the specified package. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">filename</td><td>rpm filename </td></tr> <tr><td class="paramname">checksum_type</td><td>type of checksum to be used </td></tr> <tr><td class="paramname">location_href</td><td>package location inside repository </td></tr> <tr><td class="paramname">location_base</td><td>location (url) of repository </td></tr> <tr><td class="paramname">changelog_limit</td><td>number of changelog entries </td></tr> <tr><td class="paramname">stat_buf</td><td>struct stat of the filename (optional - could be NULL) </td></tr> <tr><td class="paramname">err</td><td>GError ** </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>struct <a class="el" href="structcr___xml_struct.html">cr_XmlStruct</a> with primary, filelists and other xmls </dd></dl> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer">Generated on Tue Nov 11 2014 15:15:01 for createrepo_c library by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> </ul> </div> </body> </html>