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