UTDirectory.h

Go to the documentation of this file.
00001 //==================================================================================================
00002 // Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
00003 //
00004 // This program is free software; you can redistribute it and/or modify it under the terms of the
00005 // GNU General Public License as published by the Free Software Foundation, version 2.0 of the
00006 // License.
00007 //
00008 // This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
00009 // even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00010 // General Public License for more details.
00011 //
00012 // You should have received a copy of the GNU General Public License along with this program; if
00013 // not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00014 // 02110-1301, USA.
00015 //
00016 // For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
00017 // reserves the right and is willing to waive the proprietary source code disclosure aspects of that
00018 // license as applied to the UT library in exchange for either substantial contributions to the
00019 // development of the UT library or other forms of compensation.  Any such waiver must be
00020 // established in writing between the copyright holder and the commercial entity obtaining such a
00021 // waiver.
00022 //==================================================================================================
00023 
00024 
00025 #ifndef _UT_DIRECTORY_H_
00026 #define _UT_DIRECTORY_H_
00027 
00028 
00029 //==================================================================================================
00030 //=== Project headers
00031 //==================================================================================================
00032 #include "UTPath.h"
00033 #include "UTLists.h"
00034 
00035 
00036 //==================================================================================================
00037 class UT_EXPORT Directory_t
00038 //==================================================================================================
00040 {
00041     //----------------------------------------------------------------------------------------------
00042     public:
00043     //----------------------------------------------------------------------------------------------
00044     inline          Directory_t();
00047 
00048     inline          ~Directory_t();
00050 
00051     Status_t        Open(const Path_t& path);
00053 
00054     Status_t        NextChild(out Path_t* child);
00058 
00059     Status_t        Close();
00061 
00062     static Status_t GetFileList(    const Path_t& path,
00063                                     out gives OwnedList_t<Path_t>* file_list,
00064                                     const utf8* only_files_starting_with = NULL );
00071 
00072     //----------------------------------------------------------------------------------------------
00073     private:
00074     //----------------------------------------------------------------------------------------------
00075     dir_t       m_dir;
00076     #if WINDOWS
00077         Path_t  m_first;
00078     #endif
00079 };
00080 
00081 
00082 
00083 
00084 //==================================================================================================
00085 //==================================================================================================
00086 //===
00087 //=== Inline function implementations
00088 //===
00089 //==================================================================================================
00090 //==================================================================================================
00091 inline
00092 Directory_t::Directory_t()
00093 {
00094     m_dir = NULL;
00095 }
00096 
00097 
00098 inline
00099 Directory_t::~Directory_t()
00100 {
00101     if(m_dir)
00102         Close();
00103     assert(!m_dir);
00104 }
00105 
00106 
00107 #endif // _UT_DIRECTORY_H_

Generated on Tue Dec 14 22:35:05 2010 for UT library by  doxygen 1.6.1