C/C++ User's Journal STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model
Synesis Software InetSTL - where the Standard Template Library meets the Internet UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

/include/recls/cpp/filesearch.hpp

Go to the documentation of this file.
00001 /* 
00002  * File:        recls/cpp/filesearch.hpp
00003  *
00004  * Purpose:     recls C++ mapping - FileSearch class.
00005  *
00006  * Created:     18th August 2003
00007  * Updated:     15th March 2005
00008  *
00009  * Home:        http://recls.org/
00010  *
00011  * Copyright 2003-2005, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without 
00015  * modification, are permitted provided that the following conditions are met:
00016  *
00017  * - Redistributions of source code must retain the above copyright notice, this
00018  *   list of conditions and the following disclaimer. 
00019  * - Redistributions in binary form must reproduce the above copyright notice,
00020  *   this list of conditions and the following disclaimer in the documentation
00021  *   and/or other materials provided with the distribution.
00022  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
00023  *   any contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036  * POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * 
00039 
00040 
00041 #ifndef RECLS_INCL_RECLS_CPP_HPP_FILESEARCH
00042 #define RECLS_INCL_RECLS_CPP_HPP_FILESEARCH
00043 
00044 /* File version */
00045 #ifndef RECLS_DOCUMENTATION_SKIP_SECTION
00046 # define RECLS_VER_RECLS_CPP_HPP_FILESEARCH_MAJOR       2
00047 # define RECLS_VER_RECLS_CPP_HPP_FILESEARCH_MINOR       2
00048 # define RECLS_VER_RECLS_CPP_HPP_FILESEARCH_REVISION    1
00049 # define RECLS_VER_RECLS_CPP_HPP_FILESEARCH_EDIT        17
00050 #endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */
00051 
00056 /* 
00057  * Includes
00058  */
00059 
00060 #include <recls/cpp/recls.hpp>
00061 #include <recls/cpp/search.hpp>
00062 #include <recls_assert.h>
00063 
00064 /* 
00065  * Namespace
00066  */
00067 
00068 #if !defined(RECLS_NO_NAMESPACE)
00069 namespace recls
00070 {
00071 
00072 namespace cpp
00073 {
00074 #endif /* !RECLS_NO_NAMESPACE */
00075 
00076 /* 
00077  * Classes
00078  */
00079 
00083 class FileSearch
00084     : public Search
00085 {
00087 public:
00089     typedef recls_char_t    char_type;
00090     typedef FileSearch      class_type;
00092 
00095 public:
00101     FileSearch(char_type const *rootDir, char_type const *pattern, recls_uint32_t flags);
00103     ~FileSearch();
00105 
00108 public:
00109 #if defined(RECLS_DOCUMENTATION_SKIP_SECTION) || \
00110     (   RECLS_VER_MAJOR > 1 || \
00111         RECLS_VER_MINOR >= 6)
00118     static FileEntry Stat(char_type const *path, recls_uint32_t flags = RECLS_F_FILES | RECLS_F_DIRECTORIES | RECLS_F_DIRECTORY_PARTS);
00119 #endif /* recls 1.6.x */
00120 
00121 
00122 // Implementation
00123 private:
00124     static ctor_args_type CreateSearch_(char const *rootDir, char const *pattern, recls_uint32_t flags)
00125     {
00126         hrecls_t    hSrch;
00127         recls_rc_t  rc = Recls_Search(rootDir, pattern, flags, &hSrch);
00128 
00129         return Search::ctor_args_type(hSrch, rc);
00130     }
00131 
00132 // Not to be implemented
00133 private:
00134     FileSearch(class_type const &rhs);
00135     class_type &operator =(class_type const &rhs);
00136 };
00137 
00138 /* 
00139  * Implementation
00140  */
00141 
00142 inline FileSearch::FileSearch(FileSearch::char_type const *rootDir, FileSearch::char_type const *pattern, recls_uint32_t flags)
00143     : Search(CreateSearch_(rootDir, pattern, flags))
00144 {}
00145 
00146 inline FileSearch::~FileSearch()
00147 {}
00148 
00149 #if defined(RECLS_DOCUMENTATION_SKIP_SECTION) || \
00150     (   RECLS_VER_MAJOR > 1 || \
00151         RECLS_VER_MINOR >= 6)
00152 inline /* static */ FileEntry FileSearch::Stat(FileSearch::char_type const *path, recls_uint32_t flags /* = RECLS_F_FILES | RECLS_F_DIRECTORIES | RECLS_F_DIRECTORY_PARTS */)
00153 {
00154     recls_info_t    info;
00155     recls_rc_t      rc  =   Recls_Stat(path, flags, &info);
00156 
00157     return RECLS_SUCCEEDED(rc) ? make_entry_(info) : FileEntry();
00158 }
00159 #endif /* recls 1.6.x */
00160 
00161 /* 
00162  * Namespace
00163  */
00164 
00165 #if !defined(RECLS_NO_NAMESPACE)
00166 } /* namespace cpp */
00167 } /* namespace recls */
00168 #endif /* !RECLS_NO_NAMESPACE */
00169 
00170 /* 
00171 
00172 #endif /* !RECLS_INCL_RECLS_CPP_HPP_FILESEARCH */
00173 
00174 /* 

recls Library documentation Synesis Software Pty Ltd, 2001-2005