src/unix/dir.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/unix/dir.cpp
   3 // Purpose:     wxDir implementation for Unix/POSIX systems
   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 licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/intl.h"
  29     #include "wx/log.h"
  30 #endif // PCH
  31
  32 #include "wx/dir.h"
  33 #include "wx/filefn.h"          // for wxMatchWild
  34
  35 #include <sys/types.h>
  36 #include <sys/stat.h>
  37 #include <unistd.h>
  38
  39 #include <dirent.h>
  40
  41 // ----------------------------------------------------------------------------
  42 // macros
  43 // ----------------------------------------------------------------------------
  44
  45 #define M_DIR       ((wxDirData *)m_data)
  46
  47 // ----------------------------------------------------------------------------
  48 // private classes
  49 // ----------------------------------------------------------------------------
  50
  51 // this class stores everything we need to enumerate the files
  52 class wxDirData
  53 {
  54 public:
  55     wxDirData(const wxString& dirname);
  56     ~wxDirData();
  57
  58     bool IsOk() const { return m_dir != NULL; }
  59
  60     void SetFileSpec(const wxString& filespec) { m_filespec = filespec; }
  61     void SetFlags(int flags) { m_flags = flags; }
  62
  63     void Rewind() { rewinddir(m_dir); }
  64     bool Read(wxString *filename);
  65
  66     const wxString& GetName() const { return m_dirname; }
  67
  68 private:
  69     DIR     *m_dir;
  70
  71     wxString m_dirname;
  72     wxString m_filespec;
  73
  74     int      m_flags;
  75 };
  76
  77 // ============================================================================
  78 // implementation
  79 // ============================================================================
  80
  81 // ----------------------------------------------------------------------------
  82 // wxDirData
  83 // ----------------------------------------------------------------------------
  84
  85 #if !defined( __VMS__ ) || ( __VMS_VER >= 70000000 )
  86
  87 wxDirData::wxDirData(const wxString& dirname)
  88          : m_dirname(dirname)
  89 {
  90     m_dir = NULL;
  91
  92     // throw away the trailing slashes
  93     size_t n = m_dirname.length();
  94     wxCHECK_RET( n, wxT("empty dir name in wxDir") );
  95
  96     while ( n > 0 && m_dirname[--n] == '/' )
  97         ;
  98
  99     m_dirname.Truncate(n + 1);
 100
 101     // do open the dir
 102     m_dir = opendir(m_dirname.fn_str());
 103 }
 104
 105 wxDirData::~wxDirData()
 106 {
 107     if ( m_dir )
 108     {
 109         if ( closedir(m_dir) != 0 )
 110         {
 111             wxLogLastError(wxT("closedir"));
 112         }
 113     }
 114 }
 115
 116 bool wxDirData::Read(wxString *filename)
 117 {
 118     dirent *de = NULL;    // just to silence compiler warnings
 119     bool matches = false;
 120
 121     // speed up string concatenation in the loop a bit
 122     wxString path = m_dirname;
 123     path += wxT('/');
 124     path.reserve(path.length() + 255);
 125
 126     wxString de_d_name;
 127
 128     while ( !matches )
 129     {
 130         de = readdir(m_dir);
 131         if ( !de )
 132             return false;
 133
 134 #if wxUSE_UNICODE
 135         de_d_name = wxString(de->d_name, *wxConvFileName);
 136 #else
 137         de_d_name = de->d_name;
 138 #endif
 139
 140         // don't return "." and ".." unless asked for
 141         if ( de->d_name[0] == '.' &&
 142              ((de->d_name[1] == '.' && de->d_name[2] == '\0') ||
 143               (de->d_name[1] == '\0')) )
 144         {
 145             if ( !(m_flags & wxDIR_DOTDOT) )
 146                 continue;
 147
 148             // we found a valid match
 149             break;
 150         }
 151
 152         // check the type now
 153         if ( !(m_flags & wxDIR_FILES) && !wxDir::Exists(path + de_d_name) )
 154         {
 155             // it's a file, but we don't want them
 156             continue;
 157         }
 158         else if ( !(m_flags & wxDIR_DIRS) && wxDir::Exists(path + de_d_name) )
 159         {
 160             // it's a dir, and we don't want it
 161             continue;
 162         }
 163
 164         // finally, check the name
 165         if ( m_filespec.empty() )
 166         {
 167             matches = m_flags & wxDIR_HIDDEN ? true : de->d_name[0] != '.';
 168         }
 169         else
 170         {
 171             // test against the pattern
 172             matches = wxMatchWild(m_filespec, de_d_name,
 173                                   !(m_flags & wxDIR_HIDDEN));
 174         }
 175     }
 176
 177     *filename = de_d_name;
 178
 179     return true;
 180 }
 181
 182 #else // old VMS (TODO)
 183
 184 wxDirData::wxDirData(const wxString& WXUNUSED(dirname))
 185 {
 186     wxFAIL_MSG(wxT("not implemented"));
 187 }
 188
 189 wxDirData::~wxDirData()
 190 {
 191 }
 192
 193 bool wxDirData::Read(wxString * WXUNUSED(filename))
 194 {
 195     return false;
 196 }
 197
 198 #endif // not or new VMS/old VMS
 199
 200 // ----------------------------------------------------------------------------
 201 // wxDir construction/destruction
 202 // ----------------------------------------------------------------------------
 203
 204 wxDir::wxDir(const wxString& dirname)
 205 {
 206     m_data = NULL;
 207
 208     (void)Open(dirname);
 209 }
 210
 211 bool wxDir::Open(const wxString& dirname)
 212 {
 213     delete M_DIR;
 214     m_data = new wxDirData(dirname);
 215
 216     if ( !M_DIR->IsOk() )
 217     {
 218         delete M_DIR;
 219         m_data = NULL;
 220
 221         return false;
 222     }
 223
 224     return true;
 225 }
 226
 227 bool wxDir::IsOpened() const
 228 {
 229     return m_data != NULL;
 230 }
 231
 232 wxString wxDir::GetName() const
 233 {
 234     wxString name;
 235     if ( m_data )
 236     {
 237         name = M_DIR->GetName();
 238
 239         // Notice that we need to check for length > 1 as we shouldn't remove
 240         // the last slash from the root directory!
 241         if ( name.length() > 1 && (name.Last() == wxT('/')) )
 242         {
 243             // chop off the last slash
 244             name.RemoveLast();
 245         }
 246     }
 247
 248     return name;
 249 }
 250
 251 void wxDir::Close()
 252 {
 253     if ( m_data )
 254     {
 255         delete m_data;
 256         m_data = NULL;
 257     }
 258 }
 259
 260 // ----------------------------------------------------------------------------
 261 // wxDir enumerating
 262 // ----------------------------------------------------------------------------
 263
 264 bool wxDir::GetFirst(wxString *filename,
 265                      const wxString& filespec,
 266                      int flags) const
 267 {
 268     wxCHECK_MSG( IsOpened(), false, wxT("must wxDir::Open() first") );
 269
 270     M_DIR->Rewind();
 271
 272     M_DIR->SetFileSpec(filespec);
 273     M_DIR->SetFlags(flags);
 274
 275     return GetNext(filename);
 276 }
 277
 278 bool wxDir::GetNext(wxString *filename) const
 279 {
 280     wxCHECK_MSG( IsOpened(), false, wxT("must wxDir::Open() first") );
 281
 282     wxCHECK_MSG( filename, false, wxT("bad pointer in wxDir::GetNext()") );
 283
 284     return M_DIR->Read(filename);
 285 }
 286
 287 bool wxDir::HasSubDirs(const wxString& spec) const
 288 {
 289     wxCHECK_MSG( IsOpened(), false, wxT("must wxDir::Open() first") );
 290
 291     if ( spec.empty() )
 292     {
 293         // faster check for presence of any subdirectory: normally each subdir
 294         // has a hard link to the parent directory and so, knowing that there
 295         // are at least "." and "..", we have a subdirectory if and only if
 296         // links number is > 2 - this is just a guess but it works fairly well
 297         // in practice
 298         //
 299         // note that we may guess wrongly in one direction only: i.e. we may
 300         // return true when there are no subdirectories but this is ok as the
 301         // caller will learn it soon enough when it calls GetFirst(wxDIR)
 302         // anyhow
 303         wxStructStat stBuf;
 304         if ( wxStat(M_DIR->GetName(), &stBuf) == 0 )
 305         {
 306             switch ( stBuf.st_nlink )
 307             {
 308                 case 2:
 309                     // just "." and ".."
 310                     return false;
 311
 312                 case 0:
 313                 case 1:
 314                     // weird filesystem, don't try to guess for it, use dumb
 315                     // method below
 316                     break;
 317
 318                 default:
 319                     // assume we have subdirs - may turn out to be wrong if we
 320                     // have other hard links to this directory but it's not
 321                     // that bad as explained above
 322                     return true;
 323             }
 324         }
 325     }
 326
 327     // just try to find first directory
 328     wxString s;
 329     return GetFirst(&s, spec, wxDIR_DIRS | wxDIR_HIDDEN);
 330 }
 331