<!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>GNU CommonC++: ost::DirTree Class Reference</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.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_dir_tree.html">DirTree</a>
</div>
</div>
<div class="contents">
<h1>ost::DirTree Class Reference</h1><!-- doxytag: class="ost::DirTree" -->
<p>A generic class to walk a hierarchical directory structure.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="file_8h_source.html">file.h</a>></code></p>
<p><a href="classost_1_1_dir_tree-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#a7a88f36f4d26157b5ee8f55f1274c764">DirTree</a> (const char *prefix, unsigned maxdepth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a directory tree walk starting at the specified prefix. <a href="#a7a88f36f4d26157b5ee8f55f1274c764"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#ab80493eccf4b5547f2a259783c432992">DirTree</a> (unsigned maxdepth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an un-opened directory tree of a known maximum depth. <a href="#ab80493eccf4b5547f2a259783c432992"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#a12a08ba9122fb17f23ae8ff3850aac6a">~DirTree</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#ad675651afc2bf2f209c342f5b32ee3a5">open</a> (const char *prefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a directory tree path. <a href="#ad675651afc2bf2f209c342f5b32ee3a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#ad3bea5f9b8ef281b2ce95d2b0d7102ee">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the directory path. <a href="#ad3bea5f9b8ef281b2ce95d2b0d7102ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#a0005c2fa80454f86d3c69c0e312b4523">getPath</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the next full pathname from the directory walk. <a href="#a0005c2fa80454f86d3c69c0e312b4523"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#ad5a805f4ca629255e4c30307b63f1e5d">perform</a> (const char *prefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived <a class="el" href="classost_1_1_dir_tree.html" title="A generic class to walk a hierarchical directory structure.">DirTree</a> class performs it's primary operations through filter rather than externally by calling <a class="el" href="classost_1_1_dir_tree.html#a0005c2fa80454f86d3c69c0e312b4523" title="Extract the next full pathname from the directory walk.">getPath()</a>. <a href="#ad5a805f4ca629255e4c30307b63f1e5d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#a2950f4634b09423642edaa10fbfed51f">filter</a> (const char *file, struct stat *ino)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual method to filter results. <a href="#a2950f4634b09423642edaa10fbfed51f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A generic class to walk a hierarchical directory structure. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Directory tree walking. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7a88f36f4d26157b5ee8f55f1274c764"></a><!-- doxytag: member="ost::DirTree::DirTree" ref="a7a88f36f4d26157b5ee8f55f1274c764" args="(const char *prefix, unsigned maxdepth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::DirTree::DirTree </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>maxdepth</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a directory tree walk starting at the specified prefix. </p>
<p>A maximum subdirectory depth is also specified.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>to start walk. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxdepth</em> </td><td>subdirectory depth to examine. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab80493eccf4b5547f2a259783c432992"></a><!-- doxytag: member="ost::DirTree::DirTree" ref="ab80493eccf4b5547f2a259783c432992" args="(unsigned maxdepth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::DirTree::DirTree </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>maxdepth</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an un-opened directory tree of a known maximum depth. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>maxdepth</em> </td><td>subdirectory subdirectory depth. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a12a08ba9122fb17f23ae8ff3850aac6a"></a><!-- doxytag: member="ost::DirTree::~DirTree" ref="a12a08ba9122fb17f23ae8ff3850aac6a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::DirTree::~DirTree </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad3bea5f9b8ef281b2ce95d2b0d7102ee"></a><!-- doxytag: member="ost::DirTree::close" ref="ad3bea5f9b8ef281b2ce95d2b0d7102ee" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::DirTree::close </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the directory path. </p>
</div>
</div>
<a class="anchor" id="a2950f4634b09423642edaa10fbfed51f"></a><!-- doxytag: member="ost::DirTree::filter" ref="a2950f4634b09423642edaa10fbfed51f" args="(const char *file, struct stat *ino)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::DirTree::filter </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct stat * </td>
<td class="paramname"> <em>ino</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual method to filter results. </p>
<p>Virtual override methods should call baseclass method to assure . and .. names are stripped out.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if current filename is accepted. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>path to examine </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ino</em> </td><td>info of type, date, etc. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0005c2fa80454f86d3c69c0e312b4523"></a><!-- doxytag: member="ost::DirTree::getPath" ref="a0005c2fa80454f86d3c69c0e312b4523" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ost::DirTree::getPath </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract the next full pathname from the directory walk. </p>
<p>When returning directories, a '/' is appended. The returned string is a buffer of MAX_PATH size.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>path of next subdirectory entry or NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ad675651afc2bf2f209c342f5b32ee3a5"></a><!-- doxytag: member="ost::DirTree::open" ref="ad675651afc2bf2f209c342f5b32ee3a5" args="(const char *prefix)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::DirTree::open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a directory tree path. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>directory path to open. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad5a805f4ca629255e4c30307b63f1e5d"></a><!-- doxytag: member="ost::DirTree::perform" ref="ad5a805f4ca629255e4c30307b63f1e5d" args="(const char *prefix)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ost::DirTree::perform </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived <a class="el" href="classost_1_1_dir_tree.html" title="A generic class to walk a hierarchical directory structure.">DirTree</a> class performs it's primary operations through filter rather than externally by calling <a class="el" href="classost_1_1_dir_tree.html#a0005c2fa80454f86d3c69c0e312b4523" title="Extract the next full pathname from the directory walk.">getPath()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of files and directories examined. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>directory path to examine. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="file_8h_source.html">file.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
152
