Poster of Linux kernelThe best gift for a Linux geek
ost::DirTree

ost::DirTree

Section: C Library Functions (3) Updated: 16 Feb 2010
Local index Up
 

NAME

ost::DirTree -

A generic class to walk a hierarchical directory structure.

 

SYNOPSIS


#include <file.h>  

Public Member Functions


DirTree (const char *prefix, unsigned maxdepth)
Construct a directory tree walk starting at the specified prefix.
DirTree (unsigned maxdepth)
Construct an un-opened directory tree of a known maximum depth.
virtual ~DirTree ()

void open (const char *prefix)
Open a directory tree path.
void close (void)
Close the directory path.
char * getPath (void)
Extract the next full pathname from the directory walk.
unsigned perform (const char *prefix)
This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived DirTree class performs it's primary operations through filter rather than externally by calling getPath().  

Protected Member Functions


virtual bool filter (const char *file, struct stat *ino)
Virtual method to filter results.  

Detailed Description

A generic class to walk a hierarchical directory structure.

Author:

David Sugar <dyfet@ostel.com> Directory tree walking.

 

Constructor & Destructor Documentation

 

ost::DirTree::DirTree (const char * prefix, unsigned maxdepth)

Construct a directory tree walk starting at the specified prefix. A maximum subdirectory depth is also specified.

Parameters:

prefix to start walk.
maxdepth subdirectory depth to examine.

 

ost::DirTree::DirTree (unsigned maxdepth)

Construct an un-opened directory tree of a known maximum depth. Parameters:

maxdepth subdirectory subdirectory depth.

 

virtual ost::DirTree::~DirTree () [virtual]

 

Member Function Documentation

 

void ost::DirTree::close (void)

Close the directory path.  

virtual bool ost::DirTree::filter (const char * file, struct stat * ino) [protected, virtual]

Virtual method to filter results. Virtual override methods should call baseclass method to assure . and .. names are stripped out.

Returns:

true if current filename is accepted.

Parameters:

file path to examine
ino info of type, date, etc.

 

char* ost::DirTree::getPath (void)

Extract the next full pathname from the directory walk. When returning directories, a '/' is appended. The returned string is a buffer of MAX_PATH size.

Returns:

path of next subdirectory entry or NULL.

 

void ost::DirTree::open (const char * prefix)

Open a directory tree path. Parameters:

prefix directory path to open.

 

unsigned ost::DirTree::perform (const char * prefix)

This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived DirTree class performs it's primary operations through filter rather than externally by calling getPath(). Returns:

number of files and directories examined.

Parameters:

prefix directory path to examine.

 

Author

Generated automatically by Doxygen for GNU CommonC++ from the source code.


 

Index

NAME
SYNOPSIS
Public Member Functions
Protected Member Functions
Detailed Description
Constructor & Destructor Documentation
ost::DirTree::DirTree (const char * prefix, unsigned maxdepth)
ost::DirTree::DirTree (unsigned maxdepth)
virtual ost::DirTree::~DirTree () [virtual]
Member Function Documentation
void ost::DirTree::close (void)
virtual bool ost::DirTree::filter (const char * file, struct stat * ino) [protected, virtual]
char* ost::DirTree::getPath (void)
void ost::DirTree::open (const char * prefix)
unsigned ost::DirTree::perform (const char * prefix)
Author

This document was created by man2html, using the manual pages.
Time: 21:51:50 GMT, April 16, 2011