include/wx/filefn.h

   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 #include <time.h>
  22
  23 // ----------------------------------------------------------------------------
  24 // constants
  25 // ----------------------------------------------------------------------------
  26
  27 // define off_t
  28 #if !defined(__WXMAC__) || defined(__UNIX__)
  29     #include  <sys/types.h>
  30 #else
  31     typedef long off_t;
  32 #endif
  33
  34 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
  35     typedef _off_t off_t;
  36 #elif defined(__BORLANDC__) && defined(__WIN16__)
  37     typedef long off_t;
  38 #elif defined(__SC__)
  39     typedef long off_t;
  40 #elif defined(__MWERKS__) && !defined(__INTEL__)
  41     typedef long off_t;
  42 #endif
  43
  44 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
  45 //
  46 // VisualAge C++ V4.0 cannot have any external linkage const decs
  47 // in headers included by more than one primary source
  48 //
  49 extern const off_t wxInvalidOffset;
  50 #else
  51 const off_t wxInvalidOffset = (off_t)-1;
  52 #endif
  53
  54 enum wxSeekMode
  55 {
  56   wxFromStart,
  57   wxFromCurrent,
  58   wxFromEnd
  59 };
  60
  61 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
  62
  63 // ----------------------------------------------------------------------------
  64 // declare our versions of low level file functions: some compilers prepend
  65 // underscores to the usual names, some also have Unicode versions of them
  66 // ----------------------------------------------------------------------------
  67
  68 // Microsoft compiler loves underscores, feed them to it
  69 #if defined( __VISUALC__ ) || wxCHECK_W32API_VERSION( 0, 5 ) \
  70     || ( defined(__MWERKS__) && defined(__WXMSW__) )
  71     // functions
  72     #define   wxClose      _close
  73     #define   wxRead       _read
  74     #define   wxWrite      _write
  75     #define   wxLseek      _lseek
  76     #define   wxFsync      _commit
  77     #define   wxEof        _eof
  78
  79     #define   wxTell       _tell
  80
  81     #if wxUSE_UNICODE
  82         #define   wxOpen       _wopen
  83         #define   wxAccess     _waccess
  84
  85         #define   wxMkDir      _wmkdir
  86         #define   wxRmDir      _wrmdir
  87
  88         #define   wxStat       _wstat
  89     #else // !wxUSE_UNICODE
  90         #define   wxOpen       _open
  91         #define   wxAccess     _access
  92
  93         #define   wxMkDir      _mkdir
  94         #define   wxRmDir      _rmdir
  95
  96         #define   wxStat       _stat
  97     #endif
  98
  99     // types
 100     #define   wxStructStat struct _stat
 101
 102     // constants (unless already defined by the user code)
 103     #ifndef O_RDONLY
 104         #define   O_RDONLY    _O_RDONLY
 105         #define   O_WRONLY    _O_WRONLY
 106         #define   O_RDWR      _O_RDWR
 107         #define   O_EXCL      _O_EXCL
 108         #define   O_CREAT     _O_CREAT
 109         #define   O_BINARY    _O_BINARY
 110
 111         #define   S_IFMT      _S_IFMT
 112         #define   S_IFDIR     _S_IFDIR
 113         #define   S_IFREG     _S_IFREG
 114     #endif // O_RDONLY
 115 #else
 116     // functions
 117     #define   wxOpen       open
 118     #define   wxClose      close
 119     #define   wxRead       read
 120     #define   wxWrite      write
 121     #define   wxLseek      lseek
 122     #define   wxFsync      commit
 123     #define   wxAccess     access
 124     #define   wxEof        eof
 125
 126     #define   wxMkDir      mkdir
 127     #define   wxRmDir      rmdir
 128
 129     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 130
 131     #define   wxStat       stat
 132
 133     // types
 134     #define   wxStructStat struct stat
 135
 136 #endif  // VC++
 137
 138 // ----------------------------------------------------------------------------
 139 // functions
 140 // ----------------------------------------------------------------------------
 141 WXDLLEXPORT bool wxFileExists(const wxString& filename);
 142 #define FileExists wxFileExists
 143
 144 // does the path exist? (may have or not '/' or '\\' at the end)
 145 WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName);
 146
 147 #define wxDirExists wxPathExists
 148 #define DirExists wxDirExists
 149
 150 WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
 151 #define IsAbsolutePath wxIsAbsolutePath
 152
 153 // Get filename
 154 WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path);
 155 WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
 156 #define FileNameFromPath wxFileNameFromPath
 157
 158 // Get directory
 159 WXDLLEXPORT wxString wxPathOnly(const wxString& path);
 160 #define PathOnly wxPathOnly
 161
 162 // wxString version
 163 WXDLLEXPORT wxString wxRealPath(const wxString& path);
 164
 165 WXDLLEXPORT void wxDos2UnixFilename(wxChar *s);
 166 #define Dos2UnixFilename wxDos2UnixFilename
 167
 168 WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
 169 #define Unix2DosFilename wxUnix2DosFilename
 170
 171 #if defined(__WXMAC__)
 172   WXDLLEXPORT wxString wxMacFSSpec2MacFilename( const FSSpec *spec ) ;
 173   WXDLLEXPORT void wxMacFilename2FSSpec( const char *path , FSSpec *spec ) ;
 174   WXDLLEXPORT wxString wxMacFSSpec2UnixFilename( const FSSpec *spec ) ;
 175   WXDLLEXPORT void wxUnixFilename2FSSpec( const char *path , FSSpec *spec ) ;
 176   WXDLLEXPORT wxString wxMac2UnixFilename( const char *s) ;
 177   WXDLLEXPORT wxString wxUnix2MacFilename( const char *s);
 178 #endif
 179
 180 // Strip the extension, in situ
 181 WXDLLEXPORT void wxStripExtension(wxChar *buffer);
 182 WXDLLEXPORT void wxStripExtension(wxString& buffer);
 183
 184 // Get a temporary filename, opening and closing the file.
 185 WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 186 WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 187
 188 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 189 WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 190 WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path);
 191
 192 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 193 // and make (if under the home tree) relative to home
 194 // [caller must copy-- volatile]
 195 WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
 196                                    const wxString& envname = wxEmptyString,
 197                                    const wxString& user = wxEmptyString);
 198
 199 // Destructive removal of /./ and /../ stuff
 200 WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
 201
 202 // Allocate a copy of the full absolute path
 203 WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path);
 204
 205 // Get first file name matching given wild card.
 206 // Flags are reserved for future use.
 207 #define wxFILE  1
 208 #define wxDIR   2
 209 WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
 210 WXDLLEXPORT wxString wxFindNextFile();
 211
 212 // Does the pattern contain wildcards?
 213 WXDLLEXPORT bool wxIsWild(const wxString& pattern);
 214
 215 // Does the pattern match the text (usually a filename)?
 216 // If dot_special is TRUE, doesn't match * against . (eliminating
 217 // `hidden' dot files)
 218 WXDLLEXPORT bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
 219
 220 // Concatenate two files to form third
 221 WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 222
 223 // Copy file1 to file2
 224 WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2,
 225                             bool overwrite = TRUE);
 226
 227 // Remove file
 228 WXDLLEXPORT bool wxRemoveFile(const wxString& file);
 229
 230 // Rename file
 231 WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
 232
 233 // Get current working directory.
 234 // If buf is NULL, allocates space using new, else
 235 // copies into buf.
 236 // IMPORTANT NOTE getcwd is know not to work under some releases
 237 // of Win32s 1.3, according to MS release notes!
 238 WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
 239 // new and preferred version of wxGetWorkingDirectory
 240 // NB: can't have the same name because of overloading ambiguity
 241 WXDLLEXPORT wxString wxGetCwd();
 242
 243 // Set working directory
 244 WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
 245
 246 // Make directory
 247 WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
 248
 249 // Remove directory. Flags reserved for future use.
 250 WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 251
 252 // separators in file names
 253 #define wxFILE_SEP_EXT        wxT('.')
 254 #define wxFILE_SEP_DSK        wxT(':')
 255 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 256 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 257 #define wxFILE_SEP_PATH_MAC   wxT(':')
 258
 259 // separator in the path list (as in PATH environment variable)
 260 // there is no PATH variable in Classic Mac OS so just use the
 261 // semicolon (it must be different from the file name separator)
 262 // NB: these are strings and not characters on purpose!
 263 #define wxPATH_SEP_DOS        wxT(";")
 264 #define wxPATH_SEP_UNIX       wxT(":")
 265 #define wxPATH_SEP_MAC        wxT(";")
 266
 267 // platform independent versions
 268 #if defined(__UNIX__)
 269   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 270   #define wxPATH_SEP          wxPATH_SEP_UNIX
 271 #elif defined(__MAC__)
 272   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
 273   #define wxPATH_SEP          wxPATH_SEP_MAC
 274 #else   // Windows and OS/2
 275   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 276   #define wxPATH_SEP          wxPATH_SEP_DOS
 277 #endif  // Unix/Windows
 278
 279 // this is useful for wxString::IsSameAs(): to compare two file names use
 280 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 281 #if defined(__UNIX__) && !defined(__DARWIN__)
 282   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
 283 #else   // Windows, Mac OS and OS/2
 284   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 285 #endif  // Unix/Windows
 286
 287 // is the char a path separator?
 288 inline bool wxIsPathSeparator(wxChar c)
 289   { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; }
 290
 291 // does the string ends with path separator?
 292 WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 293
 294 // split the full path into path (including drive for DOS), name and extension
 295 // (understands both '/' and '\\')
 296 WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName,
 297                              wxString *pstrPath,
 298                              wxString *pstrName,
 299                              wxString *pstrExt);
 300
 301 // find a file in a list of directories, returns false if not found
 302 WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
 303
 304 // Get the OS directory if appropriate (such as the Windows directory).
 305 // On non-Windows platform, probably just return the empty string.
 306 WXDLLEXPORT wxString wxGetOSDirectory();
 307
 308 // Get file modification time
 309 WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename);
 310
 311 // ----------------------------------------------------------------------------
 312 // classes
 313 // ----------------------------------------------------------------------------
 314
 315 // Path searching
 316 class WXDLLEXPORT wxPathList : public wxStringList
 317 {
 318 public:
 319     // Adds all paths in environment variable
 320     void AddEnvList(const wxString& envVariable);
 321
 322     void Add(const wxString& path);
 323     // Avoid compiler warning
 324     wxNode *Add(const wxChar *s) { return wxStringList::Add(s); }
 325     // Find the first full path for which the file exists
 326     wxString FindValidPath(const wxString& filename);
 327     // Find the first full path for which the file exists; ensure it's an
 328     // absolute path that gets returned.
 329     wxString FindAbsoluteValidPath(const wxString& filename);
 330     // Given full path and filename, add path to list
 331     void EnsureFileAccessible(const wxString& path);
 332     // Returns TRUE if the path is in the list
 333     bool Member(const wxString& path);
 334
 335 private:
 336     DECLARE_DYNAMIC_CLASS(wxPathList)
 337 };
 338
 339 #endif
 340   // _WX_FILEFN_H_