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