<!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/project/openscap/openscap-0.7.4/src/common/tsort.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.7.4 -->
<div id="top">
<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>
<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 class="header">
<div class="headertitle">
<div class="title">/home/pvrabec/project/openscap/openscap-0.7.4/src/common/tsort.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright 2010 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="l00023"></a>00023
<a name="l00024"></a>00024 <span class="comment">// topological sort</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include "list.h"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef OSCAP_TSORT_H_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define OSCAP_TSORT_H_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 OSCAP_HIDDEN_START;
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">// returns nodest with an edge from given node</span>
<a name="l00034"></a>00034 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a>* (*oscap_tsort_edge_func)(<span class="keywordtype">void</span> *node, <span class="keywordtype">void</span> *userdata);
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">/*</span>
<a name="l00037"></a>00037 <span class="comment"> * Topological sort.</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> * Performs a topological sort on a directed graph.</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * @a edge_func is supposed to return an oscap_list of nodes edges coming from the current node</span>
<a name="l00042"></a>00042 <span class="comment"> * (passed to it as an argument) are pointing to. It takes the node as a first argument</span>
<a name="l00043"></a>00043 <span class="comment"> * and a pointer passed as @a userdata as a second argument.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * The purpose of @a cmp_func is to compare nodes. If it is NULL raw pointer comparison</span>
<a name="l00046"></a>00046 <span class="comment"> * is used, which should be good enough in most cases.</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * Pointer @a output will be set to a list with result. If you want to just check whether</span>
<a name="l00049"></a>00049 <span class="comment"> * there is a topological order defined on the graph (i.e. it is an acyclic graph), pass NULL.</span>
<a name="l00050"></a>00050 <span class="comment"> * If the function manages to find a topological order of the nodes (returns true),</span>
<a name="l00051"></a>00051 <span class="comment"> * it is returned in this variable. Otherwise, it will contain an encountered loop.</span>
<a name="l00052"></a>00052 <span class="comment"> * You are responsible to free this list.</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * @param input set of nodes to sort</span>
<a name="l00055"></a>00055 <span class="comment"> * @param output this pointer will be set to the result of the algorithm</span>
<a name="l00056"></a>00056 <span class="comment"> * @param edge_func function to return target nodes of outgoing edges from the current one</span>
<a name="l00057"></a>00057 <span class="comment"> * @param cmp_func node compasrison function</span>
<a name="l00058"></a>00058 <span class="comment"> * @param userdata arbitrary data pointer to be forwarded to the edge_func</span>
<a name="l00059"></a>00059 <span class="comment"> * @returns whether the algorithm managed to topologically sort the graph</span>
<a name="l00060"></a>00060 <span class="comment"> * @retval true input was sorted, result is in the *output pointer</span>
<a name="l00061"></a>00061 <span class="comment"> * @retval false a loop was detected, *output points to the encountered loop</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <span class="keywordtype">bool</span> oscap_tsort(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *input, <span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> **output, oscap_tsort_edge_func edge_func, oscap_cmp_func cmp_func, <span class="keywordtype">void</span> *userdata);
<a name="l00064"></a>00064
<a name="l00065"></a>00065 OSCAP_HIDDEN_END;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="preprocessor">#endif // OSCAP_TSORT_H_</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
