1999-12-08 09:16:53 -05:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: wx/dir.h
|
|
|
|
// Purpose: wxDir is a class for enumerating the files in a directory
|
|
|
|
// Author: Vadim Zeitlin
|
|
|
|
// Modified by:
|
|
|
|
// Created: 08.12.99
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
1999-12-08 09:16:53 -05:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
#ifndef _WX_DIR_H_
|
|
|
|
#define _WX_DIR_H_
|
|
|
|
|
2005-09-25 16:49:40 -04:00
|
|
|
#include "wx/string.h"
|
1999-12-08 09:16:53 -05:00
|
|
|
|
2003-07-19 18:01:14 -04:00
|
|
|
class WXDLLIMPEXP_BASE wxArrayString;
|
|
|
|
|
1999-12-08 09:16:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// constants
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// these flags define what kind of filenames is included in the list of files
|
|
|
|
// enumerated by GetFirst/GetNext
|
|
|
|
enum
|
|
|
|
{
|
|
|
|
wxDIR_FILES = 0x0001, // include files
|
|
|
|
wxDIR_DIRS = 0x0002, // include directories
|
|
|
|
wxDIR_HIDDEN = 0x0004, // include hidden files
|
|
|
|
wxDIR_DOTDOT = 0x0008, // include '.' and '..'
|
|
|
|
|
|
|
|
// by default, enumerate everything except '.' and '..'
|
|
|
|
wxDIR_DEFAULT = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
|
|
|
|
};
|
|
|
|
|
2001-05-18 20:58:05 -04:00
|
|
|
// these constants are possible return value of wxDirTraverser::OnDir()
|
|
|
|
enum wxDirTraverseResult
|
|
|
|
{
|
|
|
|
wxDIR_IGNORE = -1, // ignore this directory but continue with others
|
|
|
|
wxDIR_STOP, // stop traversing
|
|
|
|
wxDIR_CONTINUE // continue into this directory
|
|
|
|
};
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxDirTraverser: helper class for wxDir::Traverse()
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2003-07-01 21:59:24 -04:00
|
|
|
class WXDLLIMPEXP_BASE wxDirTraverser
|
2001-05-18 20:58:05 -04:00
|
|
|
{
|
|
|
|
public:
|
2005-02-24 09:33:32 -05:00
|
|
|
/// a virtual dtor has been provided since this class has virtual members
|
|
|
|
virtual ~wxDirTraverser() { }
|
2001-05-18 20:58:05 -04:00
|
|
|
// called for each file found by wxDir::Traverse()
|
|
|
|
//
|
2003-01-23 19:32:17 -05:00
|
|
|
// return wxDIR_STOP or wxDIR_CONTINUE from here (wxDIR_IGNORE doesn't
|
|
|
|
// make sense)
|
2001-05-18 20:58:05 -04:00
|
|
|
virtual wxDirTraverseResult OnFile(const wxString& filename) = 0;
|
|
|
|
|
|
|
|
// called for each directory found by wxDir::Traverse()
|
|
|
|
//
|
|
|
|
// return one of the enum elements defined above
|
|
|
|
virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
|
2003-01-23 19:32:17 -05:00
|
|
|
|
|
|
|
// called for each directory which we couldn't open during our traversal
|
|
|
|
// of the directory tyree
|
|
|
|
//
|
|
|
|
// this method can also return either wxDIR_STOP, wxDIR_IGNORE or
|
|
|
|
// wxDIR_CONTINUE but the latter is treated specially: it means to retry
|
|
|
|
// opening the directory and so may lead to infinite loop if it is
|
|
|
|
// returned unconditionally, be careful with this!
|
|
|
|
//
|
|
|
|
// the base class version always returns wxDIR_IGNORE
|
|
|
|
virtual wxDirTraverseResult OnOpenError(const wxString& dirname);
|
2001-05-18 20:58:05 -04:00
|
|
|
};
|
|
|
|
|
1999-12-08 09:16:53 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxDir: portable equivalent of {open/read/close}dir functions
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2003-07-01 21:59:24 -04:00
|
|
|
class WXDLLIMPEXP_BASE wxDirData;
|
2002-02-15 10:11:06 -05:00
|
|
|
|
2003-07-01 21:59:24 -04:00
|
|
|
class WXDLLIMPEXP_BASE wxDir
|
1999-12-08 09:16:53 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
// test for existence of a directory with the given name
|
|
|
|
static bool Exists(const wxString& dir);
|
|
|
|
|
|
|
|
// ctors
|
|
|
|
// -----
|
|
|
|
|
|
|
|
// default, use Open()
|
|
|
|
wxDir() { m_data = NULL; }
|
|
|
|
|
|
|
|
// opens the directory for enumeration, use IsOpened() to test success
|
|
|
|
wxDir(const wxString& dir);
|
|
|
|
|
|
|
|
// dtor cleans up the associated ressources
|
|
|
|
~wxDir();
|
|
|
|
|
|
|
|
// open the directory for enumerating
|
|
|
|
bool Open(const wxString& dir);
|
|
|
|
|
2004-09-10 08:56:07 -04:00
|
|
|
// returns true if the directory was successfully opened
|
1999-12-08 09:16:53 -05:00
|
|
|
bool IsOpened() const;
|
|
|
|
|
2001-05-18 20:58:05 -04:00
|
|
|
// get the full name of the directory (without '/' at the end)
|
|
|
|
wxString GetName() const;
|
|
|
|
|
1999-12-08 09:16:53 -05:00
|
|
|
// file enumeration routines
|
|
|
|
// -------------------------
|
|
|
|
|
|
|
|
// start enumerating all files matching filespec (or all files if it is
|
2004-09-10 08:56:07 -04:00
|
|
|
// empty) and flags, return true on success
|
1999-12-08 09:16:53 -05:00
|
|
|
bool GetFirst(wxString *filename,
|
|
|
|
const wxString& filespec = wxEmptyString,
|
|
|
|
int flags = wxDIR_DEFAULT) const;
|
|
|
|
|
2001-07-23 09:28:39 -04:00
|
|
|
// get next file in the enumeration started with GetFirst()
|
1999-12-08 09:16:53 -05:00
|
|
|
bool GetNext(wxString *filename) const;
|
|
|
|
|
2001-07-23 09:28:39 -04:00
|
|
|
// return true if this directory has any files in it
|
2001-08-28 09:48:53 -04:00
|
|
|
bool HasFiles(const wxString& spec = wxEmptyString);
|
2001-07-23 09:28:39 -04:00
|
|
|
|
|
|
|
// return true if this directory has any subdirectories
|
2001-08-28 09:48:53 -04:00
|
|
|
bool HasSubDirs(const wxString& spec = wxEmptyString);
|
2001-07-23 09:28:39 -04:00
|
|
|
|
2001-05-18 20:58:05 -04:00
|
|
|
// enumerate all files in this directory and its subdirectories
|
1999-12-08 09:16:53 -05:00
|
|
|
//
|
2001-05-18 20:58:05 -04:00
|
|
|
// return the number of files found
|
|
|
|
size_t Traverse(wxDirTraverser& sink,
|
|
|
|
const wxString& filespec = wxEmptyString,
|
|
|
|
int flags = wxDIR_DEFAULT) const;
|
|
|
|
|
|
|
|
// simplest version of Traverse(): get the names of all files under this
|
|
|
|
// directory into filenames array, return the number of files
|
|
|
|
static size_t GetAllFiles(const wxString& dirname,
|
|
|
|
wxArrayString *files,
|
|
|
|
const wxString& filespec = wxEmptyString,
|
|
|
|
int flags = wxDIR_DEFAULT);
|
1999-12-08 09:16:53 -05:00
|
|
|
|
2006-08-12 20:23:58 -04:00
|
|
|
// check if there any files matching the given filespec under the given
|
|
|
|
// directory (i.e. searches recursively), return the file path if found or
|
|
|
|
// empty string otherwise
|
|
|
|
static wxString FindFirst(const wxString& dirname,
|
|
|
|
const wxString& filespec,
|
|
|
|
int flags = wxDIR_DEFAULT);
|
|
|
|
|
1999-12-08 09:16:53 -05:00
|
|
|
private:
|
2003-07-01 21:41:23 -04:00
|
|
|
friend class wxDirData;
|
1999-12-08 09:16:53 -05:00
|
|
|
|
|
|
|
wxDirData *m_data;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
|
|
|
DECLARE_NO_COPY_CLASS(wxDir)
|
1999-12-08 09:16:53 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // _WX_DIR_H_
|
2003-07-01 21:41:23 -04:00
|
|
|
|