// 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__
- #pragma interface "filename.h"
-#endif
-
-#ifndef WX_PRECOMP
- #include "wx/string.h"
-#endif
-
/*
TODO:
2. more file operations:
a) chmod()
b) [acm]time() - get and set
- c) file size
- d) file permissions with readable accessors for most common bits
- such as IsReadable() &c
- e) rename()?
+ c) rename()?
3. SameFileAs() function to compare inodes under Unix
*/
-// ridiculously enough, this will replace DirExists with wxDirExists etc
+#include "wx/arrstr.h"
#include "wx/filefn.h"
#include "wx/datetime.h"
+#include "wx/intl.h"
+#include "wx/longlong.h"
+#include "wx/file.h"
-class WXDLLEXPORT wxFile;
+#if wxUSE_FILE
+class WXDLLIMPEXP_FWD_BASE wxFile;
+#endif
+
+#if wxUSE_FFILE
+class WXDLLIMPEXP_FWD_BASE wxFFile;
+#endif
+
+// this symbol is defined for the platforms where file systems use volumes in
+// paths
+#if defined(__WINDOWS__) || defined(__DOS__) || defined(__OS2__)
+ #define wxHAS_FILESYSTEM_VOLUMES
+#endif
// ----------------------------------------------------------------------------
// 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
+};
+
+// different conventions that may be used with GetHumanReadableSize()
+enum wxSizeConvention
+{
+ wxSIZE_CONV_TRADITIONAL, // 1024 bytes = 1 KB
+ wxSIZE_CONV_IEC, // 1024 bytes = 1 KiB
+ wxSIZE_CONV_SI // 1000 bytes = 1 KB
};
// the kind of normalization to do with the file name: these values can be
enum wxPathNormalize
{
wxPATH_NORM_ENV_VARS = 0x0001, // replace env vars with their values
- wxPATH_NORM_DOTS = 0x0002, // squeeze all .. and . and prepend cwd
+ wxPATH_NORM_DOTS = 0x0002, // squeeze all .. and .
wxPATH_NORM_TILDE = 0x0004, // Unix only: replace ~ and ~user
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_NO_SEPARATOR = 0x0000, // for symmetry with wxPATH_GET_SEPARATOR
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
+};
+
+// Rmdir flags
+enum
+{
+ wxPATH_RMDIR_FULL = 0x0001, // delete with subdirectories if empty
+ wxPATH_RMDIR_RECURSIVE = 0x0002 // delete all recursively (dangerous!)
+};
+
+// FileExists flags
+enum
+{
+ wxFILE_EXISTS_REGULAR = 0x0001, // check for existence of a regular file
+ wxFILE_EXISTS_DIR = 0x0002, // check for existence of a directory
+ wxFILE_EXISTS_SYMLINK = 0x1004, // check for existence of a symbolic link;
+ // also sets wxFILE_EXISTS_NO_FOLLOW as
+ // it would never be satisfied otherwise
+ wxFILE_EXISTS_DEVICE = 0x0008, // check for existence of a device
+ wxFILE_EXISTS_FIFO = 0x0016, // check for existence of a FIFO
+ wxFILE_EXISTS_SOCKET = 0x0032, // check for existence of a socket
+ // gap for future types
+ wxFILE_EXISTS_NO_FOLLOW = 0x1000, // don't dereference a contained symlink
+ wxFILE_EXISTS_ANY = 0x1FFF // check for existence of anything
+};
+
+#if wxUSE_LONGLONG
+// error code of wxFileName::GetSize()
+extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize;
+#endif // wxUSE_LONGLONG
+
+
+
// ----------------------------------------------------------------------------
// 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
// extension are extracted from it
wxFileName( const wxString& fullpath, wxPathFormat format = wxPATH_NATIVE )
- { Assign( fullpath, format ); }
+ { Assign( fullpath, format ); m_dontFollowLinks = false; }
// from a directory name and a file name
wxFileName(const wxString& path,
const wxString& name,
wxPathFormat format = wxPATH_NATIVE)
- { Assign(path, name, format); }
+ { Assign(path, name, format); m_dontFollowLinks = false; }
// from a volume, directory name, file base name and extension
wxFileName(const wxString& volume,
const wxString& name,
const wxString& ext,
wxPathFormat format = wxPATH_NATIVE)
- { Assign(volume, path, name, ext, format); }
+ { Assign(volume, path, name, ext, format); m_dontFollowLinks = false; }
// from a directory name, file base name and extension
wxFileName(const wxString& path,
const wxString& name,
const wxString& ext,
wxPathFormat format = wxPATH_NATIVE)
- { Assign(path, name, ext, format); }
+ { Assign(path, name, ext, format); m_dontFollowLinks = false; }
// the same for delayed initialization
const wxString& path,
const wxString& name,
const wxString& ext,
+ bool hasExt,
wxPathFormat format = wxPATH_NATIVE);
+ void Assign(const wxString& volume,
+ const wxString& path,
+ const wxString& name,
+ const wxString& ext,
+ wxPathFormat format = wxPATH_NATIVE)
+ { Assign(volume, path, name, ext, !ext.empty(), format); }
+
void Assign(const wxString& path,
const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
void Assign(const wxString& path,
const wxString& name,
const wxString& ext,
- wxPathFormat format = wxPATH_NATIVE)
- {
- // empty volume
- Assign(_T(""), path, name, ext, format);
- }
+ wxPathFormat format = wxPATH_NATIVE);
void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
// assorted assignment operators
wxFileName& operator=(const wxFileName& filename)
- { Assign(filename); return *this; }
+ { if (this != &filename) Assign(filename); return *this; }
wxFileName& operator=(const wxString& filename)
{ Assign(filename); return *this; }
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.empty() || !m_relative ||
+ !m_ext.empty() || m_hasExt;
+ }
- // does the file with this name exists?
- bool FileExists();
+ // does the file with this name exist?
+ bool FileExists() const;
static bool FileExists( const wxString &file );
- // does the directory with this name exists?
- bool DirExists();
+ // does the directory with this name exist?
+ bool DirExists() const;
static bool DirExists( const wxString &dir );
- // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
+ // does anything at all with this name (i.e. file, directory or some
+ // other file system object such as a device, socket, ...) exist?
+ bool Exists(int flags = wxFILE_EXISTS_ANY) const;
+ static bool Exists(const wxString& path, int flags = wxFILE_EXISTS_ANY);
- // time functions
+ // checks on most common flags for files/directories;
+ // more platform-specific features (like e.g. Unix permissions) are not
+ // available in wxFileName
+
+ bool IsDirWritable() const { return wxIsWritable(GetPath()); }
+ static bool IsDirWritable(const wxString &path) { return wxDirExists(path) && wxIsWritable(path); }
+
+ bool IsDirReadable() const { return wxIsReadable(GetPath()); }
+ static bool IsDirReadable(const wxString &path) { return wxDirExists(path) && wxIsReadable(path); }
+
+ // NOTE: IsDirExecutable() is not present because the meaning of "executable"
+ // directory is very platform-dependent and also not so useful
+
+ bool IsFileWritable() const { return wxIsWritable(GetFullPath()); }
+ static bool IsFileWritable(const wxString &path) { return wxFileExists(path) && wxIsWritable(path); }
+
+ bool IsFileReadable() const { return wxIsReadable(GetFullPath()); }
+ static bool IsFileReadable(const wxString &path) { return wxFileExists(path) && wxIsReadable(path); }
+
+ bool IsFileExecutable() const { return wxIsExecutable(GetFullPath()); }
+ static bool IsFileExecutable(const wxString &path) { return wxFileExists(path) && wxIsExecutable(path); }
+
+
+ // time functions
+#if wxUSE_DATETIME
// set the file last access/mod and creation times
// (any of the pointers may be NULL)
bool SetTimes(const wxDateTime *dtAccess,
const wxDateTime *dtMod,
- const wxDateTime *dtCreate);
+ const wxDateTime *dtCreate) const;
// set the access and modification times to the current moment
- bool Touch();
+ bool Touch() const;
// return the last access, last modification and create times
// (any of the pointers may be NULL)
(void)GetTimes(NULL, &dtMod, NULL);
return dtMod;
}
+#endif // wxUSE_DATETIME
-#ifdef __WXMAC__
+#if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
- bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
+ bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) const;
// 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
// looks up the appropriate type and creator from the registration and then sets
bool MacSetDefaultTypeAndCreator() ;
#endif
+
// various file/dir operations
// retrieve the value of the current working directory
static wxString GetCwd(const wxString& volume = wxEmptyString);
// change the current working directory
- bool SetCwd();
+ bool SetCwd() const;
static bool SetCwd( const wxString &cwd );
// get the value of user home (Unix only mainly)
void AssignHomeDir();
static wxString GetHomeDir();
+ // get the system temporary directory
+ static wxString GetTempDir();
+
+#if wxUSE_FILE || wxUSE_FFILE
+ // get a temp file name starting with the specified prefix
+ void AssignTempFileName(const wxString& prefix);
+ static wxString CreateTempFileName(const wxString& prefix);
+#endif // wxUSE_FILE
+
+#if wxUSE_FILE
// 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);
+ void AssignTempFileName(const wxString& prefix, wxFile *fileTemp);
static wxString CreateTempFileName(const wxString& prefix,
- wxFile *fileTemp = NULL);
+ wxFile *fileTemp);
+#endif // wxUSE_FILE
+
+#if wxUSE_FFILE
+ // 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, wxFFile *fileTemp);
+ static wxString CreateTempFileName(const wxString& prefix,
+ wxFFile *fileTemp);
+#endif // wxUSE_FFILE
// 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 = wxS_DIR_DEFAULT, int flags = 0) const;
+ static bool Mkdir(const wxString &dir, int perm = wxS_DIR_DEFAULT,
+ int flags = 0);
- bool Rmdir();
- static bool Rmdir( const wxString &dir );
+ bool Rmdir(int flags = 0) const;
+ static bool Rmdir(const wxString &dir, int flags = 0);
// operations on the path
//
// 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 the path is a symbolic link (Unix-only), indicate that all
+ // filesystem operations on this path should be performed on the link
+ // itself and not on the file it points to, as is the case by default.
+ //
+ // No effect if this is not a symbolic link.
+ void DontFollowLink()
+ {
+ m_dontFollowLinks = true;
+ }
+
+ // If the path is a symbolic link (Unix-only), returns whether various
+ // file operations should act on the link itself, or on its target.
+ //
+ // This does not test if the path is really a symlink or not.
+ bool ShouldFollowLink() const
+ {
+ return !m_dontFollowLinks;
+ }
+
+#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) const;
+#endif
+
+#ifndef __WXWINCE__
+ // if the path contains the value of the environment variable named envname
+ // then this function replaces it with the string obtained from
+ // wxString::Format(replacementFmtString, value_of_envname_variable)
+ //
+ // Example:
+ // wxFileName fn("/usr/openwin/lib/someFile");
+ // fn.ReplaceEnvVariable("OPENWINHOME");
+ // // now fn.GetFullPath() == "$OPENWINHOME/lib/someFile"
+ bool ReplaceEnvVariable(const wxString& envname,
+ const wxString& replacementFmtString = "$%s",
+ wxPathFormat format = wxPATH_NATIVE);
+#endif
+
+ // replaces, if present in the path, the home directory for the given user
+ // (see wxGetHomeDir) with a tilde
+ bool ReplaceHomeDir(wxPathFormat format = wxPATH_NATIVE);
+
// 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;
+
+ // compare with another filename object
+ bool operator==(const wxFileName& filename) const
+ { return SameAs(filename); }
+ bool operator!=(const wxFileName& filename) const
+ { return !SameAs(filename); }
- // uses the current platform settings
- bool operator==(const wxFileName& filename) { return SameAs(filename); }
- bool operator==(const wxString& filename)
- { return *this == wxFileName(filename); }
+ // 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 );
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 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)
+ static wxUniChar 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);
+ // is this is a DOS path which beings with a windows unique volume name
+ // ('\\?\Volume{guid}\')?
+ static bool IsMSWUniqueVolumeNamePath(const wxString& path,
+ 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(); }
+ void AppendDir(const wxString& dir);
+ void PrependDir(const wxString& dir);
+ void InsertDir(size_t before, const wxString& dir);
+ void RemoveDir(size_t pos);
+ void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }
// Other accessors
- void SetExt( const wxString &ext ) { m_ext = ext; }
+ void SetExt( const wxString &ext ) { m_ext = ext; m_hasExt = !m_ext.empty(); }
+ void ClearExt() { m_ext = wxEmptyString; m_hasExt = false; }
+ void SetEmptyExt() { m_ext = wxT(""); m_hasExt = true; }
wxString GetExt() const { return m_ext; }
- bool HasExt() const { return !m_ext.empty(); }
+ bool HasExt() const { return m_hasExt; }
void SetName( const wxString &name ) { m_name = name; }
wxString GetName() const { return m_name; }
const wxArrayString& GetDirs() const { return m_dirs; }
// flags are combination of wxPATH_GET_XXX flags
- wxString GetPath(int flags = 0, wxPathFormat format = wxPATH_NATIVE) const;
+ wxString GetPath(int flags = wxPATH_GET_VOLUME,
+ wxPathFormat format = wxPATH_NATIVE) const;
// Replace current path with this one
void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
wxString *path,
wxString *name,
wxString *ext,
+ bool *hasExt = NULL,
wxPathFormat format = wxPATH_NATIVE);
- // compatibility version
+ static void SplitPath(const wxString& fullpath,
+ wxString *volume,
+ wxString *path,
+ wxString *name,
+ wxString *ext,
+ wxPathFormat format)
+ {
+ SplitPath(fullpath, volume, path, name, ext, NULL, format);
+ }
+
+ // compatibility version: volume is part of path
static void SplitPath(const wxString& fullpath,
wxString *path,
wxString *name,
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);
+
+ // strip the file extension: "foo.bar" => "foo" (but ".baz" => ".baz")
+ static wxString StripExtension(const wxString& fullpath);
+
+#ifdef wxHAS_FILESYSTEM_VOLUMES
+ // return the string representing a file system volume, or drive
+ static wxString GetVolumeString(char drive, int flags = wxPATH_GET_SEPARATOR);
+#endif // wxHAS_FILESYSTEM_VOLUMES
+
+ // File size
+
+#if wxUSE_LONGLONG
+ // returns the size of the given filename
+ wxULongLong GetSize() const;
+ static wxULongLong GetSize(const wxString &file);
+
+ // returns the size in a human readable form
+ wxString
+ GetHumanReadableSize(const wxString& nullsize = _("Not available"),
+ int precision = 1,
+ wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL) const;
+ static wxString
+ GetHumanReadableSize(const wxULongLong& sz,
+ const wxString& nullsize = _("Not available"),
+ int precision = 1,
+ wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL);
+#endif // wxUSE_LONGLONG
+
// 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); }
+ { return GetPath(wxPATH_GET_VOLUME | 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;
// 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
+ // true in the former and false in the latter
//
- // NB: the path is not absolute just because m_relative is FALSE, it still
+ // 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;
+
+ // when m_ext is empty, it may be because we don't have any extension or
+ // because we have an empty extension
+ //
+ // the difference is important as file with name "foo" and without
+ // extension has full name "foo" while with empty extension it is "foo."
+ bool m_hasExt;
+
+ // by default, symlinks are dereferenced but this flag can be set with
+ // DontFollowLink() to change this and make different operations work on
+ // this file path itself instead of the target of the symlink
+ bool m_dontFollowLinks;
};
#endif // _WX_FILENAME_H_
projects / wxWidgets.git / blobdiff