include/wx/dir.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/dir.h
   3 // Purpose:     wxDir is a class for enumerating the files in a directory
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     08.12.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DIR_H_
  13 #define _WX_DIR_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "dir.h"
  17 #endif
  18
  19 #ifndef WX_PRECOMP
  20     #include  "wx/string.h"
  21 #endif
  22
  23 // ----------------------------------------------------------------------------
  24 // constants
  25 // ----------------------------------------------------------------------------
  26
  27 // these flags define what kind of filenames is included in the list of files
  28 // enumerated by GetFirst/GetNext
  29 enum
  30 {
  31     wxDIR_FILES     = 0x0001,       // include files
  32     wxDIR_DIRS      = 0x0002,       // include directories
  33     wxDIR_HIDDEN    = 0x0004,       // include hidden files
  34     wxDIR_DOTDOT    = 0x0008,       // include '.' and '..'
  35
  36     // by default, enumerate everything except '.' and '..'
  37     wxDIR_DEFAULT   = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
  38 };
  39
  40 // these constants are possible return value of wxDirTraverser::OnDir()
  41 enum wxDirTraverseResult
  42 {
  43     wxDIR_IGNORE = -1,      // ignore this directory but continue with others
  44     wxDIR_STOP,             // stop traversing
  45     wxDIR_CONTINUE          // continue into this directory
  46 };
  47
  48 // ----------------------------------------------------------------------------
  49 // wxDirTraverser: helper class for wxDir::Traverse()
  50 // ----------------------------------------------------------------------------
  51
  52 class WXDLLEXPORT wxDirTraverser
  53 {
  54 public:
  55     // called for each file found by wxDir::Traverse()
  56     //
  57     // return wxDIR_STOP or wxDIR_CONTINUE from here
  58     virtual wxDirTraverseResult OnFile(const wxString& filename) = 0;
  59
  60     // called for each directory found by wxDir::Traverse()
  61     //
  62     // return one of the enum elements defined above
  63     virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
  64 };
  65
  66 // ----------------------------------------------------------------------------
  67 // wxDir: portable equivalent of {open/read/close}dir functions
  68 // ----------------------------------------------------------------------------
  69
  70 class WXDLLEXPORT wxDir
  71 {
  72 public:
  73     // test for existence of a directory with the given name
  74     static bool Exists(const wxString& dir);
  75
  76     // ctors
  77     // -----
  78
  79     // default, use Open()
  80     wxDir() { m_data = NULL; }
  81
  82     // opens the directory for enumeration, use IsOpened() to test success
  83     wxDir(const wxString& dir);
  84
  85     // dtor cleans up the associated ressources
  86     ~wxDir();
  87
  88     // open the directory for enumerating
  89     bool Open(const wxString& dir);
  90
  91     // returns TRUE if the directory was successfully opened
  92     bool IsOpened() const;
  93
  94     // get the full name of the directory (without '/' at the end)
  95     wxString GetName() const;
  96
  97     // file enumeration routines
  98     // -------------------------
  99
 100     // start enumerating all files matching filespec (or all files if it is
 101     // empty) and flags, return TRUE on success
 102     bool GetFirst(wxString *filename,
 103                   const wxString& filespec = wxEmptyString,
 104                   int flags = wxDIR_DEFAULT) const;
 105
 106     // get next file in the enumeration started with either GetFirst() or
 107     // GetFirstNormal()
 108     bool GetNext(wxString *filename) const;
 109
 110     // enumerate all files in this directory and its subdirectories
 111     //
 112     // return the number of files found
 113     size_t Traverse(wxDirTraverser& sink,
 114                     const wxString& filespec = wxEmptyString,
 115                     int flags = wxDIR_DEFAULT) const;
 116
 117     // simplest version of Traverse(): get the names of all files under this
 118     // directory into filenames array, return the number of files
 119     static size_t GetAllFiles(const wxString& dirname,
 120                               wxArrayString *files,
 121                               const wxString& filespec = wxEmptyString,
 122                               int flags = wxDIR_DEFAULT);
 123
 124 private:
 125     friend class WXDLLEXPORT wxDirData;
 126
 127     wxDirData *m_data;
 128 };
 129
 130 #endif // _WX_DIR_H_