![]() |
![]() |
![]() |
![]() |
||||
![]() |
![]() |
![]() |
![]() |
||||
|
00001 /* ///////////////////////////////////////////////////////////////////////////// 00002 * File: ReclsSearch.hpp 00003 * 00004 * Purpose: Definition of the ReclsSearch and ReclsSearchDirectoryNode classes. 00005 * 00006 * Created: 15th August 2003 00007 * Updated: 5th October 2006 00008 * 00009 * Home: http://recls.org/ 00010 * 00011 * Copyright (c) 2003-2006, 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_HPP_RECLS_SEARCH 00042 #define RECLS_INCL_HPP_RECLS_SEARCH 00043 00044 /* File version */ 00045 #ifndef RECLS_DOCUMENTATION_SKIP_SECTION 00046 # define RECLS_VER_HPP_RECLS_SEARCH_MAJOR 4 00047 # define RECLS_VER_HPP_RECLS_SEARCH_MINOR 0 00048 # define RECLS_VER_HPP_RECLS_SEARCH_REVISION 1 00049 # define RECLS_VER_HPP_RECLS_SEARCH_EDIT 38 00050 #endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */ 00051 00055 /* ///////////////////////////////////////////////////////////////////////////// 00056 * Includes 00057 */ 00058 00059 #ifndef __cplusplus 00060 # error This file can only be included in C++ compilation units 00061 #endif /* __cplusplus */ 00062 00063 #include <recls/recls.h> 00064 00065 /* ///////////////////////////////////////////////////////////////////////////// 00066 * Compiler / language features 00067 * 00068 * Note: these should be moved out to the compiler-specific files later 00069 */ 00070 00071 #if defined(RECLS_COMPILER_IS_COMO) || \ 00072 defined(RECLS_COMPILER_IS_GCC) || \ 00073 defined(RECLS_COMPILER_IS_INTEL) || \ 00074 ( defined(RECLS_COMPILER_IS_MSVC) && \ 00075 _MSC_VER > 1100) || \ 00076 defined(RECLS_COMPILER_IS_MWERKS) 00077 # define RECLS_COMPILER_REQUIRES_MATCHING_PLACEMENT_DELETE 00078 #endif /* compiler */ 00079 00080 /* ///////////////////////////////////////////////////////////////////////////// 00081 * Namespace 00082 */ 00083 00084 #if !defined(RECLS_NO_NAMESPACE) 00085 namespace recls 00086 { 00087 #endif /* !RECLS_NO_NAMESPACE */ 00088 00089 /* ///////////////////////////////////////////////////////////////////////////// 00090 * Interfaces 00091 */ 00092 00093 // class ReclsSearchDirectoryNode 00097 struct ReclsSearchDirectoryNode 00098 { 00099 // Construction 00100 public: 00105 virtual ~ReclsSearchDirectoryNode() = 0; 00106 00107 // Operations 00108 public: 00109 virtual recls_rc_t GetNext() = 0; 00110 00111 virtual recls_rc_t GetDetails(recls_info_t *pinfo) = 0; 00112 00113 virtual recls_rc_t GetNextDetails(recls_info_t *pinfo) = 0; 00114 }; 00115 00116 inline ReclsSearchDirectoryNode::~ReclsSearchDirectoryNode() 00117 {} 00118 00119 // class ReclsSearch 00120 struct ReclsSearch 00121 { 00122 // Construction 00123 protected: 00124 ReclsSearch(); 00125 public: 00130 virtual ~ReclsSearch() = 0; 00131 00132 // Operations 00133 public: 00134 virtual recls_rc_t GetNext(); 00135 virtual recls_rc_t GetDetails(recls_info_t *pinfo); 00136 virtual recls_rc_t GetNextDetails(recls_info_t *pinfo); 00137 00138 // Accessors 00139 public: 00140 virtual recls_rc_t GetLastError() const; 00141 00142 // Handle interconversion 00143 public: 00144 static hrecls_t ToHandle(ReclsSearch *si); 00145 static ReclsSearch *FromHandle(hrecls_t h); 00146 00147 // Members 00148 protected: 00149 // protected data harmful but necessary, since it enables a drop in code size 00150 ReclsSearchDirectoryNode *m_dnode; 00151 recls_rc_t m_lastError; 00152 }; 00153 00154 /* ///////////////////////////////////////////////////////////////////////////// 00155 * Namespace 00156 */ 00157 00158 #if !defined(RECLS_NO_NAMESPACE) 00159 } /* namespace recls */ 00160 #endif /* !RECLS_NO_NAMESPACE */ 00161 00162 /* ////////////////////////////////////////////////////////////////////////// */ 00163 00164 #endif /* !RECLS_INCL_HPP_RECLS_SEARCH */ 00165 00166 /* ////////////////////////////////////////////////////////////////////////// */
|
recls Library documentation © Synesis Software Pty Ltd, 2001-2006 |