X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c801d85f158c4cba50b588807daabdcbd0ed3853..bb4549de8f731378d169faec928ec4e0c64536e8:/include/wx/filefn.h?ds=sidebyside diff --git a/include/wx/filefn.h b/include/wx/filefn.h index 64ff0521de..c9c7cd721c 100644 --- a/include/wx/filefn.h +++ b/include/wx/filefn.h @@ -6,112 +6,135 @@ // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Julian Smart -// Licence: wxWindows license +// Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// -#ifndef __FILEFNH__ -#define __FILEFNH__ +#ifndef _FILEFN_H_ +#define _FILEFN_H_ #ifdef __GNUG__ #pragma interface "filefn.h" #endif -#include "wx/list.h" +#include -bool WXDLLEXPORT wxFileExists(const wxString& filename); +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- + +// define off_t +#include + +#ifdef _MSC_VER + #define off_t _off_t +#endif + +const off_t wxInvalidOffset = (off_t)-1; + +typedef enum { + wxFromStart, + wxFromCurrent, + wxFromEnd +} wxSeekMode; + +// ---------------------------------------------------------------------------- +// functions +// ---------------------------------------------------------------------------- +WXDLLEXPORT bool wxFileExists(const wxString& filename); #define FileExists wxFileExists // does the path exist? (may have or not '/' or '\\' at the end) -bool WXDLLEXPORT wxPathExists(const char *pszPathName); +WXDLLEXPORT bool wxPathExists(const char *pszPathName); #define wxDirExists wxPathExists #define DirExists wxDirExists -bool WXDLLEXPORT wxIsAbsolutePath(const wxString& filename); +WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename); #define IsAbsolutePath wxIsAbsolutePath // Get filename -char* WXDLLEXPORT wxFileNameFromPath(char *path); -wxString WXDLLEXPORT wxFileNameFromPath(const wxString& path); +WXDLLEXPORT char* wxFileNameFromPath(char *path); +WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path); #define FileNameFromPath wxFileNameFromPath // Get directory -char* WXDLLEXPORT wxPathOnly(char *path); -wxString WXDLLEXPORT wxPathOnly(const wxString& path); +WXDLLEXPORT char* wxPathOnly(char *path); +WXDLLEXPORT wxString wxPathOnly(const wxString& path); #define PathOnly wxPathOnly // wxString version -wxString WXDLLEXPORT wxRealPath(const wxString& path); +WXDLLEXPORT wxString wxRealPath(const wxString& path); -void WXDLLEXPORT wxDos2UnixFilename(char *s); +WXDLLEXPORT void wxDos2UnixFilename(char *s); #define Dos2UnixFilename wxDos2UnixFilename -void WXDLLEXPORT wxUnix2DosFilename(char *s); +WXDLLEXPORT void wxUnix2DosFilename(char *s); #define Unix2DosFilename wxUnix2DosFilename // Strip the extension, in situ -void WXDLLEXPORT wxStripExtension(char *buffer); +WXDLLEXPORT void wxStripExtension(char *buffer); +WXDLLEXPORT void wxStripExtension(wxString& buffer); // Get a temporary filename, opening and closing the file. -char* WXDLLEXPORT wxGetTempFileName(const wxString& prefix, char *buf = NULL); +WXDLLEXPORT char* wxGetTempFileName(const wxString& prefix, char *buf = (char *) NULL); // Expand file name (~/ and ${OPENWINHOME}/ stuff) -char* WXDLLEXPORT wxExpandPath(char *dest, const char *path); +WXDLLEXPORT char* wxExpandPath(char *dest, const char *path); // Contract w.r.t environment ( -> ${OPENWINHOME}/lib) // and make (if under the home tree) relative to home // [caller must copy-- volatile] -char* WXDLLEXPORT wxContractPath (const wxString& filename, +WXDLLEXPORT char* wxContractPath (const wxString& filename, const wxString& envname = "", const wxString& user = ""); // Destructive removal of /./ and /../ stuff -char* WXDLLEXPORT wxRealPath(char *path); +WXDLLEXPORT char* wxRealPath(char *path); // Allocate a copy of the full absolute path -char* WXDLLEXPORT wxCopyAbsolutePath(const wxString& path); +WXDLLEXPORT char* wxCopyAbsolutePath(const wxString& path); // Get first file name matching given wild card. // Flags are reserved for future use. #define wxFILE 1 #define wxDIR 2 -char* WXDLLEXPORT wxFindFirstFile(const char *spec, int flags = wxFILE); -char* WXDLLEXPORT wxFindNextFile(void); +WXDLLEXPORT char* wxFindFirstFile(const char *spec, int flags = wxFILE); +WXDLLEXPORT char* wxFindNextFile(void); // Does the pattern contain wildcards? -bool WXDLLEXPORT wxIsWild(const wxString& pattern); +WXDLLEXPORT bool wxIsWild(const wxString& pattern); // Does the pattern match the text (usually a filename)? // If dot_special is TRUE, doesn't match * against . (eliminating // `hidden' dot files) -bool WXDLLEXPORT wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE); +WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE); // Concatenate two files to form third -bool WXDLLEXPORT wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); +WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); // Copy file1 to file2 -bool WXDLLEXPORT wxCopyFile(const wxString& file1, const wxString& file2); +WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2); // Remove file -bool WXDLLEXPORT wxRemoveFile(const wxString& file); +WXDLLEXPORT bool wxRemoveFile(const wxString& file); // Rename file -bool WXDLLEXPORT wxRenameFile(const wxString& file1, const wxString& file2); +WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2); // Get current working directory. // If buf is NULL, allocates space using new, else // copies into buf. // IMPORTANT NOTE getcwd is know not to work under some releases // of Win32s 1.3, according to MS release notes! -char* WXDLLEXPORT wxGetWorkingDirectory(char *buf = NULL, int sz = 1000); +WXDLLEXPORT char* wxGetWorkingDirectory(char *buf = (char *) NULL, int sz = 1000); // Set working directory -bool WXDLLEXPORT wxSetWorkingDirectory(const wxString& d); +WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d); // Make directory -bool WXDLLEXPORT wxMkdir(const wxString& dir); +WXDLLEXPORT bool wxMkdir(const wxString& dir); // Remove directory. Flags reserved for future use. -bool WXDLLEXPORT wxRmdir(const wxString& dir, int flags = 0); +WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0); // separators in file names #define FILE_SEP_EXT '.' @@ -133,34 +156,54 @@ bool WXDLLEXPORT wxRmdir(const wxString& dir, int flags = 0); #define PATH_SEP PATH_SEP_DOS #endif // Unix/Windows +// this is useful for wxString::IsSameAs(): to compare two file names use +// filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE) +#ifdef __UNIX__ + #define wxARE_FILENAMES_CASE_SENSITIVE TRUE +#else // Windows + #define wxARE_FILENAMES_CASE_SENSITIVE FALSE +#endif // Unix/Windows + // is the char a path separator? inline bool wxIsPathSeparator(char c) { return c == FILE_SEP_PATH_DOS || c == FILE_SEP_PATH_UNIX; } // does the string ends with path separator? -bool WXDLLEXPORT wxEndsWithPathSeparator(const char *pszFileName); +WXDLLEXPORT bool wxEndsWithPathSeparator(const char *pszFileName); + +// split the full path into path (including drive for DOS), name and extension +// (understands both '/' and '\\') +WXDLLEXPORT void wxSplitPath(const char *pszFileName, + wxString *pstrPath, + wxString *pstrName, + wxString *pstrExt); // find a file in a list of directories, returns false if not found -bool WXDLLEXPORT wxFindFileInPath(wxString *pStr, const char *pszPath, const char *pszFile); +WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const char *pszPath, const char *pszFile); + +// ---------------------------------------------------------------------------- +// classes +// ---------------------------------------------------------------------------- // Path searching -class WXDLLEXPORT wxPathList: public wxStringList +class WXDLLEXPORT wxPathList : public wxStringList { - DECLARE_DYNAMIC_CLASS(wxPathList) - - public: - void AddEnvList(const wxString& envVariable); // Adds all paths in environment variable - void Add(const wxString& path); - wxString FindValidPath(const wxString& filename); // Find the first full path - // for which the file exists - wxString FindAbsoluteValidPath(const wxString& filename); // Find the first full path - // for which the file exists; ensure it's an absolute - // path that gets returned. - void EnsureFileAccessible(const wxString& path); // Given full path and filename, - // add path to list - bool Member(const wxString& path); +public: + void AddEnvList(const wxString& envVariable); // Adds all paths in environment variable + void Add(const wxString& path); + wxString FindValidPath(const wxString& filename); // Find the first full path + // for which the file exists + wxString FindAbsoluteValidPath(const wxString& filename); // Find the first full path + // for which the file exists; ensure it's an absolute + // path that gets returned. + void EnsureFileAccessible(const wxString& path); // Given full path and filename, + // add path to list + bool Member(const wxString& path); + +private: + DECLARE_DYNAMIC_CLASS(wxPathList) }; #endif - // __FILEFNH__ + // _WX_FILEFN_H_