// Created: 28.12.00
// RCS-ID: $Id$
// Copyright: (c) 2000 Robert Roebling
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_FILENAME_H_
#define _WX_FILENAME_H_
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "filename.h"
#endif
#ifndef WX_PRECOMP
#include "wx/string.h"
+ #include "wx/arrstr.h"
#endif
/*
#include "wx/filefn.h"
#include "wx/datetime.h"
+class WXDLLIMPEXP_BASE wxFile;
+
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
{
wxPATH_NATIVE = 0, // the path format for the current platform
wxPATH_UNIX,
+ wxPATH_BEOS = wxPATH_UNIX,
wxPATH_MAC,
wxPATH_DOS,
+ wxPATH_WIN = wxPATH_DOS,
+ wxPATH_OS2 = wxPATH_DOS,
wxPATH_VMS,
- wxPATH_BEOS = wxPATH_UNIX,
- wxPATH_WIN = wxPATH_DOS,
- wxPATH_OS2 = wxPATH_DOS
+ wxPATH_MAX // Not a valid value for specifying path format
};
// the kind of normalization to do with the file name: these values can be
wxPATH_NORM_CASE = 0x0008, // if case insensitive => tolower
wxPATH_NORM_ABSOLUTE = 0x0010, // make the path absolute
wxPATH_NORM_LONG = 0x0020, // make the path the long form
- wxPATH_NORM_ALL = 0x003f
+ wxPATH_NORM_SHORTCUT = 0x0040, // resolve the shortcut, if it is a shortcut
+ wxPATH_NORM_ALL = 0x00ff & ~wxPATH_NORM_CASE
+};
+
+// what exactly should GetPath() return?
+enum
+{
+ wxPATH_GET_VOLUME = 0x0001, // include the volume if applicable
+ wxPATH_GET_SEPARATOR = 0x0002 // terminate the path with the separator
+};
+
+// MkDir flags
+enum
+{
+ wxPATH_MKDIR_FULL = 0x0001 // create directories recursively
};
// ----------------------------------------------------------------------------
// wxFileName: encapsulates a file path
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxFileName
+class WXDLLIMPEXP_BASE wxFileName
{
public:
// constructors and assignment
// the usual stuff
- wxFileName() { }
- wxFileName( const wxFileName &filepath ) { Assign(filepath); }
+ wxFileName() { Clear(); }
+ wxFileName(const wxFileName& filepath) { Assign(filepath); }
// from a full filename: if it terminates with a '/', a directory path
// is contructed (the name will be empty), otherwise a file name and
wxPathFormat format = wxPATH_NATIVE)
{
// empty volume
- Assign(_T(""), path, name, ext, format);
+ Assign(wxEmptyString, path, name, ext, format);
}
void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
void Clear();
// static pseudo constructors
- static wxFileName FileName(const wxString& file);
- static wxFileName DirName(const wxString& dir);
+ static wxFileName FileName(const wxString& file,
+ wxPathFormat format = wxPATH_NATIVE);
+ static wxFileName DirName(const wxString& dir,
+ wxPathFormat format = wxPATH_NATIVE);
// file tests
// is the filename valid at all?
- bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); }
+ bool IsOk() const
+ {
+ // we're fine if we have the path or the name or if we're a root dir
+ return m_dirs.size() != 0 || !m_name.IsEmpty() || !m_relative;
+ }
// does the file with this name exists?
- bool FileExists();
+ bool FileExists() const;
static bool FileExists( const wxString &file );
// does the directory with this name exists?
- bool DirExists();
+ bool DirExists() const;
static bool DirExists( const wxString &dir );
// VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
// time functions
-
- // set the file creation and last access/mod times
+#if wxUSE_DATETIME
+ // set the file last access/mod and creation times
// (any of the pointers may be NULL)
- bool SetTimes(const wxDateTime *dtCreate,
- const wxDateTime *dtAccess,
- const wxDateTime *dtMod);
+ bool SetTimes(const wxDateTime *dtAccess,
+ const wxDateTime *dtMod,
+ const wxDateTime *dtCreate);
// set the access and modification times to the current moment
bool Touch();
- // return the last access, last modification and last change times
+ // return the last access, last modification and create times
// (any of the pointers may be NULL)
bool GetTimes(wxDateTime *dtAccess,
wxDateTime *dtMod,
- wxDateTime *dtChange) const;
+ wxDateTime *dtCreate) const;
// convenience wrapper: get just the last mod time of the file
wxDateTime GetModificationTime() const
(void)GetTimes(NULL, &dtMod, NULL);
return dtMod;
}
+#endif // wxUSE_DATETIME
+
+#ifdef __WXMAC__
+ bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
+ bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
+ // gets the 'common' type and creator for a certain extension
+ static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ;
+ // registers application defined extensions and their default type and creator
+ static void MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator ) ;
+ // looks up the appropriate type and creator from the registration and then sets
+ bool MacSetDefaultTypeAndCreator() ;
+#endif
// various file/dir operations
void AssignHomeDir();
static wxString GetHomeDir();
- // get a temp file name starting with the specified prefix
- void AssignTempFileName(const wxString& prefix);
- static wxString CreateTempFileName(const wxString& prefix);
+ // get a temp file name starting with the specified prefix and open the
+ // file passed to us using this name for writing (atomically if
+ // possible)
+ void AssignTempFileName(const wxString& prefix, wxFile *fileTemp = NULL);
+ static wxString CreateTempFileName(const wxString& prefix,
+ wxFile *fileTemp = NULL);
// directory creation and removal.
- // if full is TRUE, will try to make each directory in the path.
- bool Mkdir( int perm = 0777, bool full = FALSE);
- static bool Mkdir( const wxString &dir, int perm = 0777, bool full = FALSE );
+ bool Mkdir( int perm = 0777, int flags = 0);
+ static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );
bool Rmdir();
static bool Rmdir( const wxString &dir );
// variables will be expanded in it
//
// this may be done using another (than current) value of cwd
- bool Normalize(wxPathNormalize flags = wxPATH_NORM_ALL,
+ bool Normalize(int flags = wxPATH_NORM_ALL,
const wxString& cwd = wxEmptyString,
wxPathFormat format = wxPATH_NATIVE);
//
// pass an empty string to get a path relative to the working directory
//
- // returns TRUE if the file name was modified, FALSE if we failed to do
+ // returns true if the file name was modified, false if we failed to do
// anything with it (happens when the file is on a different volume,
// for example)
- bool MakeRelativeTo(const wxString& pathBase = _T(""),
+ bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
wxPathFormat format = wxPATH_NATIVE);
+ // make the path absolute
+ //
+ // this may be done using another (than current) value of cwd
+ bool MakeAbsolute(const wxString& cwd = wxEmptyString,
+ wxPathFormat format = wxPATH_NATIVE)
+ { return Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
+ wxPATH_NORM_TILDE, cwd, format); }
+
+#if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
+ // if the path is a shortcut, return the target and optionally,
+ // the arguments
+ bool GetShortcutTarget(const wxString& shortcutPath,
+ wxString& targetFilename,
+ wxString* arguments = NULL);
+#endif
// Comparison
- // compares with the rules of this platform
- bool SameAs(const wxFileName &filepath,
- wxPathFormat format = wxPATH_NATIVE);
+ // compares with the rules of the given platforms format
+ bool SameAs(const wxFileName& filepath,
+ wxPathFormat format = wxPATH_NATIVE) const;
- // uses the current platform settings
- bool operator==(const wxFileName& filename) { return SameAs(filename); }
- bool operator==(const wxString& filename)
- { return *this == wxFileName(filename); }
+ // compare with another filename object
+ bool operator==(const wxFileName& filename) const
+ { return SameAs(filename); }
+ bool operator!=(const wxFileName& filename) const
+ { return !SameAs(filename); }
- // Tests
+ // compare with a filename string interpreted as a native file name
+ bool operator==(const wxString& filename) const
+ { return SameAs(wxFileName(filename)); }
+ bool operator!=(const wxString& filename) const
+ { return !SameAs(wxFileName(filename)); }
// are the file names of this type cases sensitive?
static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
// is this filename absolute?
- bool IsAbsolute() const
- { return !m_relative; }
+ bool IsAbsolute(wxPathFormat format = wxPATH_NATIVE) const;
// is this filename relative?
- bool IsRelative() const
- { return m_relative; }
+ bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
+ { return !IsAbsolute(format); }
+
+ // Returns the characters that aren't allowed in filenames
+ // on the specified platform.
+ static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
// Information about path format
- // get the string separating the volume from the path for this format
+ // get the string separating the volume from the path for this format,
+ // return an empty string if this format doesn't support the notion of
+ // volumes at all
static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
// get the string of path separators for this format
static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
+ // get the string of path terminators, i.e. characters which terminate the
+ // path
+ static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
+
+ // get the canonical path separator for this format
+ static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE)
+ { return GetPathSeparators(format)[0u]; }
+
// is the char a path separator for this format?
static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
- // FIXME: what exactly does this do?
- bool IsWild( wxPathFormat format = wxPATH_NATIVE );
-
// Dir accessors
void AppendDir( const wxString &dir );
void PrependDir( const wxString &dir );
void InsertDir( int before, const wxString &dir );
void RemoveDir( int pos );
- size_t GetDirCount() const { return m_dirs.GetCount(); }
+ size_t GetDirCount() const { return m_dirs.size(); }
// Other accessors
void SetExt( const wxString &ext ) { m_ext = ext; }
const wxArrayString& GetDirs() const { return m_dirs; }
- // Construct path only - possibly with the trailing separator
- wxString GetPath( bool add_separator = FALSE,
- wxPathFormat format = wxPATH_NATIVE ) const;
+ // flags are combination of wxPATH_GET_XXX flags
+ wxString GetPath(int flags = wxPATH_GET_VOLUME,
+ wxPathFormat format = wxPATH_NATIVE) const;
- // more readable synonym
- wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
- { return GetPath(TRUE /* add separator */, format); }
+ // Replace current path with this one
+ void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
// Construct full path with name and ext
wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
// Return the long form of the path (returns identity on non-Windows platforms)
wxString GetLongPath() const;
+ // Is this a file or directory (not necessarily an existing one)
+ bool IsDir() const { return m_name.empty() && m_ext.empty(); }
+
// various helpers
// get the canonical path format for this platform
wxString *ext,
wxPathFormat format = wxPATH_NATIVE);
+ // split a path into volume and pure path part
+ static void SplitVolume(const wxString& fullpathWithVolume,
+ wxString *volume,
+ wxString *path,
+ wxPathFormat format = wxPATH_NATIVE);
+
+ // deprecated methods, don't use any more
+ // --------------------------------------
+
+#ifndef __DIGITALMARS__
+ wxString GetPath( bool withSep, wxPathFormat format = wxPATH_NATIVE ) const
+ { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); }
+#endif
+ wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
+ { return GetPath(wxPATH_GET_SEPARATOR, format); }
+
private:
+ // check whether this dir is valid for Append/Prepend/InsertDir()
+ static bool IsValidDirComponent(const wxString& dir);
+
// the drive/volume/device specification (always empty for Unix)
wxString m_volume;
// the file name and extension (empty for directories)
wxString m_name,
m_ext;
-
- // is the path relative
+
+ // when m_dirs is empty it may mean either that we have no path at all or
+ // that our path is '/', i.e. the root directory
+ //
+ // we use m_relative to distinguish between these two cases, it will be
+ // true in the former and false in the latter
+ //
+ // NB: the path is not absolute just because m_relative is false, it still
+ // needs the drive (i.e. volume) in some formats (Windows)
bool m_relative;
};
projects / wxWidgets.git / blobdiff