<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::DirTree Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_dir_tree.html">DirTree</a></div>
<h1>ost::DirTree Class Reference</h1><!-- doxytag: class="ost::DirTree" -->A generic class to walk a hierarchical directory structure.Directory tree walking.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="file_8h-source.html">file.h</a>></code>
<p>
<a href="classost_1_1_dir_tree-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#7a88f36f4d26157b5ee8f55f1274c764">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="#7a88f36f4d26157b5ee8f55f1274c764"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#b80493eccf4b5547f2a259783c432992">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="#b80493eccf4b5547f2a259783c432992"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#12a08ba9122fb17f23ae8ff3850aac6a">~DirTree</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#d675651afc2bf2f209c342f5b32ee3a5">open</a> (const char *prefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a directory tree path. <a href="#d675651afc2bf2f209c342f5b32ee3a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#d3bea5f9b8ef281b2ce95d2b0d7102ee">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the directory path. <a href="#d3bea5f9b8ef281b2ce95d2b0d7102ee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#0005c2fa80454f86d3c69c0e312b4523">getPath</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the next full pathname from the directory walk. <a href="#0005c2fa80454f86d3c69c0e312b4523"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#d5a805f4ca629255e4c30307b63f1e5d">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">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#0005c2fa80454f86d3c69c0e312b4523">getPath()</a>. <a href="#d5a805f4ca629255e4c30307b63f1e5d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir_tree.html#2950f4634b09423642edaa10fbfed51f">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="#2950f4634b09423642edaa10fbfed51f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A generic class to walk a hierarchical directory structure.Directory tree walking.
<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7a88f36f4d26157b5ee8f55f1274c764"></a><!-- doxytag: member="ost::DirTree::DirTree" ref="7a88f36f4d26157b5ee8f55f1274c764" args="(const char *prefix, unsigned maxdepth)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::DirTree::DirTree </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>prefix</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>maxdepth</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct a directory tree walk starting at the specified prefix.
<p>
A maximum subdirectory depth is also specified.<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="b80493eccf4b5547f2a259783c432992"></a><!-- doxytag: member="ost::DirTree::DirTree" ref="b80493eccf4b5547f2a259783c432992" args="(unsigned maxdepth)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::DirTree::DirTree </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned </td>
<td class="mdname1" valign="top" nowrap> <em>maxdepth</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct an un-opened directory tree of a known maximum depth.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="12a08ba9122fb17f23ae8ff3850aac6a"></a><!-- doxytag: member="ost::DirTree::~DirTree" ref="12a08ba9122fb17f23ae8ff3850aac6a" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::DirTree::~DirTree </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d3bea5f9b8ef281b2ce95d2b0d7102ee"></a><!-- doxytag: member="ost::DirTree::close" ref="d3bea5f9b8ef281b2ce95d2b0d7102ee" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::DirTree::close </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Close the directory path.
<p>
</td>
</tr>
</table>
<a class="anchor" name="2950f4634b09423642edaa10fbfed51f"></a><!-- doxytag: member="ost::DirTree::filter" ref="2950f4634b09423642edaa10fbfed51f" args="(const char *file, struct stat *ino)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool ost::DirTree::filter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>file</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>struct stat * </td>
<td class="mdname" nowrap> <em>ino</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Virtual method to filter results.
<p>
Virtual override methods should call baseclass method to assure . and .. names are stripped out.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if current filename is accepted. </dd></dl>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="0005c2fa80454f86d3c69c0e312b4523"></a><!-- doxytag: member="ost::DirTree::getPath" ref="0005c2fa80454f86d3c69c0e312b4523" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">char* ost::DirTree::getPath </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Extract the next full pathname from the directory walk.
<p>
When returning directories, a '/' is appended. The returned string is a buffer of MAX_PATH size.<p>
<dl compact><dt><b>Returns:</b></dt><dd>path of next subdirectory entry or NULL. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="d675651afc2bf2f209c342f5b32ee3a5"></a><!-- doxytag: member="ost::DirTree::open" ref="d675651afc2bf2f209c342f5b32ee3a5" args="(const char *prefix)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::DirTree::open </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>prefix</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Open a directory tree path.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="d5a805f4ca629255e4c30307b63f1e5d"></a><!-- doxytag: member="ost::DirTree::perform" ref="d5a805f4ca629255e4c30307b63f1e5d" args="(const char *prefix)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">unsigned ost::DirTree::perform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>prefix</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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">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#0005c2fa80454f86d3c69c0e312b4523">getPath()</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of files and directories examined. </dd></dl>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
