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