| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: filefn.h |
| 3 | // Purpose: File- and directory-related functions |
| 4 | // Author: Julian Smart |
| 5 | // Modified by: |
| 6 | // Created: 29/01/98 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) 1998 Julian Smart |
| 9 | // Licence: wxWindows license |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _FILEFN_H_ |
| 13 | #define _FILEFN_H_ |
| 14 | |
| 15 | #ifdef __GNUG__ |
| 16 | #pragma interface "filefn.h" |
| 17 | #endif |
| 18 | |
| 19 | #include "wx/list.h" |
| 20 | |
| 21 | // ---------------------------------------------------------------------------- |
| 22 | // constants |
| 23 | // ---------------------------------------------------------------------------- |
| 24 | |
| 25 | // define off_t |
| 26 | #ifndef __WXMAC__ |
| 27 | #include <sys/types.h> |
| 28 | #else |
| 29 | typedef long off_t; |
| 30 | #endif |
| 31 | |
| 32 | #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) ) |
| 33 | typedef _off_t off_t; |
| 34 | #elif defined(__BORLANDC__) && defined(__WIN16__) |
| 35 | typedef long off_t; |
| 36 | #elif defined(__SC__) |
| 37 | typedef long off_t; |
| 38 | #elif defined(__MWERKS__) && !defined(__INTEL__) |
| 39 | typedef long off_t; |
| 40 | #endif |
| 41 | |
| 42 | const off_t wxInvalidOffset = (off_t)-1; |
| 43 | |
| 44 | enum wxSeekMode |
| 45 | { |
| 46 | wxFromStart, |
| 47 | wxFromCurrent, |
| 48 | wxFromEnd |
| 49 | }; |
| 50 | |
| 51 | WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; |
| 52 | |
| 53 | // ---------------------------------------------------------------------------- |
| 54 | // functions |
| 55 | // ---------------------------------------------------------------------------- |
| 56 | WXDLLEXPORT bool wxFileExists(const wxString& filename); |
| 57 | #define FileExists wxFileExists |
| 58 | |
| 59 | // does the path exist? (may have or not '/' or '\\' at the end) |
| 60 | WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName); |
| 61 | |
| 62 | #define wxDirExists wxPathExists |
| 63 | #define DirExists wxDirExists |
| 64 | |
| 65 | WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename); |
| 66 | #define IsAbsolutePath wxIsAbsolutePath |
| 67 | |
| 68 | // Get filename |
| 69 | WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path); |
| 70 | WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path); |
| 71 | #define FileNameFromPath wxFileNameFromPath |
| 72 | |
| 73 | // Get directory |
| 74 | WXDLLEXPORT wxString wxPathOnly(const wxString& path); |
| 75 | #define PathOnly wxPathOnly |
| 76 | |
| 77 | // wxString version |
| 78 | WXDLLEXPORT wxString wxRealPath(const wxString& path); |
| 79 | |
| 80 | WXDLLEXPORT void wxDos2UnixFilename(wxChar *s); |
| 81 | #define Dos2UnixFilename wxDos2UnixFilename |
| 82 | |
| 83 | WXDLLEXPORT void wxUnix2DosFilename(wxChar *s); |
| 84 | #define Unix2DosFilename wxUnix2DosFilename |
| 85 | |
| 86 | #ifdef __WXMAC__ |
| 87 | WXDLLEXPORT void wxMacPathToFSSpec( const wxChar *path , FSSpec *spec ) ; |
| 88 | WXDLLEXPORT void wxMac2UnixFilename(wxChar *s); |
| 89 | WXDLLEXPORT void wxUnix2MacFilename(wxChar *s); |
| 90 | #endif |
| 91 | |
| 92 | // Strip the extension, in situ |
| 93 | WXDLLEXPORT void wxStripExtension(wxChar *buffer); |
| 94 | WXDLLEXPORT void wxStripExtension(wxString& buffer); |
| 95 | |
| 96 | // Get a temporary filename, opening and closing the file. |
| 97 | WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL); |
| 98 | |
| 99 | // Expand file name (~/ and ${OPENWINHOME}/ stuff) |
| 100 | WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path); |
| 101 | |
| 102 | // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib) |
| 103 | // and make (if under the home tree) relative to home |
| 104 | // [caller must copy-- volatile] |
| 105 | WXDLLEXPORT wxChar* wxContractPath(const wxString& filename, |
| 106 | const wxString& envname = wxEmptyString, |
| 107 | const wxString& user = wxEmptyString); |
| 108 | |
| 109 | // Destructive removal of /./ and /../ stuff |
| 110 | WXDLLEXPORT wxChar* wxRealPath(wxChar *path); |
| 111 | |
| 112 | // Allocate a copy of the full absolute path |
| 113 | WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path); |
| 114 | |
| 115 | // Get first file name matching given wild card. |
| 116 | // Flags are reserved for future use. |
| 117 | #define wxFILE 1 |
| 118 | #define wxDIR 2 |
| 119 | WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE); |
| 120 | WXDLLEXPORT wxString wxFindNextFile(); |
| 121 | |
| 122 | // Does the pattern contain wildcards? |
| 123 | WXDLLEXPORT bool wxIsWild(const wxString& pattern); |
| 124 | |
| 125 | // Does the pattern match the text (usually a filename)? |
| 126 | // If dot_special is TRUE, doesn't match * against . (eliminating |
| 127 | // `hidden' dot files) |
| 128 | WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE); |
| 129 | |
| 130 | // Concatenate two files to form third |
| 131 | WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); |
| 132 | |
| 133 | // Copy file1 to file2 |
| 134 | WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2); |
| 135 | |
| 136 | // Remove file |
| 137 | WXDLLEXPORT bool wxRemoveFile(const wxString& file); |
| 138 | |
| 139 | // Rename file |
| 140 | WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2); |
| 141 | |
| 142 | // Get current working directory. |
| 143 | // If buf is NULL, allocates space using new, else |
| 144 | // copies into buf. |
| 145 | // IMPORTANT NOTE getcwd is know not to work under some releases |
| 146 | // of Win32s 1.3, according to MS release notes! |
| 147 | WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000); |
| 148 | // new and preferred version of wxGetWorkingDirectory |
| 149 | // NB: can't have the same name because of overloading ambiguity |
| 150 | WXDLLEXPORT wxString wxGetCwd(); |
| 151 | |
| 152 | // Set working directory |
| 153 | WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d); |
| 154 | |
| 155 | // Make directory |
| 156 | WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777); |
| 157 | |
| 158 | // Remove directory. Flags reserved for future use. |
| 159 | WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0); |
| 160 | |
| 161 | // separators in file names |
| 162 | #define wxFILE_SEP_EXT wxT('.') |
| 163 | #define wxFILE_SEP_DSK wxT(':') |
| 164 | #define wxFILE_SEP_PATH_DOS wxT('\\') |
| 165 | #define wxFILE_SEP_PATH_UNIX wxT('/') |
| 166 | |
| 167 | // separator in the path list (as in PATH environment variable) |
| 168 | // NB: these are strings and not characters on purpose! |
| 169 | #define wxPATH_SEP_DOS wxT(";") |
| 170 | #define wxPATH_SEP_UNIX wxT(":") |
| 171 | |
| 172 | // platform independent versions |
| 173 | #ifdef __UNIX__ |
| 174 | #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX |
| 175 | #define wxPATH_SEP wxPATH_SEP_UNIX |
| 176 | #else // Windows and OS/2 |
| 177 | #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS |
| 178 | #define wxPATH_SEP wxPATH_SEP_DOS |
| 179 | #endif // Unix/Windows |
| 180 | |
| 181 | // this is useful for wxString::IsSameAs(): to compare two file names use |
| 182 | // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE) |
| 183 | #ifdef __UNIX__ |
| 184 | #define wxARE_FILENAMES_CASE_SENSITIVE TRUE |
| 185 | #else // Windows and OS/2 |
| 186 | #define wxARE_FILENAMES_CASE_SENSITIVE FALSE |
| 187 | #endif // Unix/Windows |
| 188 | |
| 189 | // is the char a path separator? |
| 190 | inline bool wxIsPathSeparator(wxChar c) |
| 191 | { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; } |
| 192 | |
| 193 | // does the string ends with path separator? |
| 194 | WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName); |
| 195 | |
| 196 | // split the full path into path (including drive for DOS), name and extension |
| 197 | // (understands both '/' and '\\') |
| 198 | WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName, |
| 199 | wxString *pstrPath, |
| 200 | wxString *pstrName, |
| 201 | wxString *pstrExt); |
| 202 | |
| 203 | // find a file in a list of directories, returns false if not found |
| 204 | WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile); |
| 205 | |
| 206 | // Get the OS directory if appropriate (such as the Windows directory). |
| 207 | // On non-Windows platform, probably just return the empty string. |
| 208 | WXDLLEXPORT wxString wxGetOSDirectory(); |
| 209 | |
| 210 | // ---------------------------------------------------------------------------- |
| 211 | // classes |
| 212 | // ---------------------------------------------------------------------------- |
| 213 | |
| 214 | // Path searching |
| 215 | class WXDLLEXPORT wxPathList : public wxStringList |
| 216 | { |
| 217 | public: |
| 218 | // Adds all paths in environment variable |
| 219 | void AddEnvList(const wxString& envVariable); |
| 220 | |
| 221 | void Add(const wxString& path); |
| 222 | // Avoid compiler warning |
| 223 | wxNode *Add(const wxChar *s) { return wxStringList::Add(s); } |
| 224 | // Find the first full path for which the file exists |
| 225 | wxString FindValidPath(const wxString& filename); |
| 226 | // Find the first full path for which the file exists; ensure it's an |
| 227 | // absolute path that gets returned. |
| 228 | wxString FindAbsoluteValidPath(const wxString& filename); |
| 229 | // Given full path and filename, add path to list |
| 230 | void EnsureFileAccessible(const wxString& path); |
| 231 | // Returns TRUE if the path is in the list |
| 232 | bool Member(const wxString& path); |
| 233 | |
| 234 | private: |
| 235 | DECLARE_DYNAMIC_CLASS(wxPathList) |
| 236 | }; |
| 237 | |
| 238 | #endif |
| 239 | // _WX_FILEFN_H_ |