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__) && 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 wxString wxMacFSSpec2MacFilename( const FSSpec *spec ) ;
  88   WXDLLEXPORT wxString wxMacFSSpec2UnixFilename( const FSSpec *spec ) ;
  89   WXDLLEXPORT void wxUnixFilename2FSSpec( const char *path , FSSpec *spec ) ;
  90   WXDLLEXPORT void wxMacFilename2FSSpec( const char *path , FSSpec *spec ) ;
  91   WXDLLEXPORT wxString wxMac2UnixFilename( const char *s) ;
  92   WXDLLEXPORT wxString wxUnix2MacFilename( const char *s);
  93 #endif
  94
  95 // Strip the extension, in situ
  96 WXDLLEXPORT void wxStripExtension(wxChar *buffer);
  97 WXDLLEXPORT void wxStripExtension(wxString& buffer);
  98
  99 // Get a temporary filename, opening and closing the file.
 100 WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 101 WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 102
 103 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 104 WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 105 WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path);
 106
 107 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 108 // and make (if under the home tree) relative to home
 109 // [caller must copy-- volatile]
 110 WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
 111                                    const wxString& envname = wxEmptyString,
 112                                    const wxString& user = wxEmptyString);
 113
 114 // Destructive removal of /./ and /../ stuff
 115 WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
 116
 117 // Allocate a copy of the full absolute path
 118 WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path);
 119
 120 // Get first file name matching given wild card.
 121 // Flags are reserved for future use.
 122 #define wxFILE  1
 123 #define wxDIR   2
 124 WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
 125 WXDLLEXPORT wxString wxFindNextFile();
 126
 127 // Does the pattern contain wildcards?
 128 WXDLLEXPORT bool wxIsWild(const wxString& pattern);
 129
 130 // Does the pattern match the text (usually a filename)?
 131 // If dot_special is TRUE, doesn't match * against . (eliminating
 132 // `hidden' dot files)
 133 WXDLLEXPORT bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
 134
 135 // Concatenate two files to form third
 136 WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 137
 138 // Copy file1 to file2
 139 WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2);
 140
 141 // Remove file
 142 WXDLLEXPORT bool wxRemoveFile(const wxString& file);
 143
 144 // Rename file
 145 WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
 146
 147 // Get current working directory.
 148 // If buf is NULL, allocates space using new, else
 149 // copies into buf.
 150 // IMPORTANT NOTE getcwd is know not to work under some releases
 151 // of Win32s 1.3, according to MS release notes!
 152 WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
 153 // new and preferred version of wxGetWorkingDirectory
 154 // NB: can't have the same name because of overloading ambiguity
 155 WXDLLEXPORT wxString wxGetCwd();
 156
 157 // Set working directory
 158 WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
 159
 160 // Make directory
 161 WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
 162
 163 // Remove directory. Flags reserved for future use.
 164 WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 165
 166 // separators in file names
 167 #define wxFILE_SEP_EXT        wxT('.')
 168 #define wxFILE_SEP_DSK        wxT(':')
 169 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 170 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 171
 172 // separator in the path list (as in PATH environment variable)
 173 // NB: these are strings and not characters on purpose!
 174 #define wxPATH_SEP_DOS        wxT(";")
 175 #define wxPATH_SEP_UNIX       wxT(":")
 176
 177 // platform independent versions
 178 #ifdef  __UNIX__
 179   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 180   #define wxPATH_SEP          wxPATH_SEP_UNIX
 181 #else   // Windows and OS/2
 182   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 183   #define wxPATH_SEP          wxPATH_SEP_DOS
 184 #endif  // Unix/Windows
 185
 186 // this is useful for wxString::IsSameAs(): to compare two file names use
 187 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 188 #ifdef  __UNIX__
 189   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
 190 #else   // Windows and OS/2
 191   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 192 #endif  // Unix/Windows
 193
 194 // is the char a path separator?
 195 inline bool wxIsPathSeparator(wxChar c)
 196   { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; }
 197
 198 // does the string ends with path separator?
 199 WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 200
 201 // split the full path into path (including drive for DOS), name and extension
 202 // (understands both '/' and '\\')
 203 WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName,
 204                              wxString *pstrPath,
 205                              wxString *pstrName,
 206                              wxString *pstrExt);
 207
 208 // find a file in a list of directories, returns false if not found
 209 WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
 210
 211 // Get the OS directory if appropriate (such as the Windows directory).
 212 // On non-Windows platform, probably just return the empty string.
 213 WXDLLEXPORT wxString wxGetOSDirectory();
 214
 215 // ----------------------------------------------------------------------------
 216 // classes
 217 // ----------------------------------------------------------------------------
 218
 219 // Path searching
 220 class WXDLLEXPORT wxPathList : public wxStringList
 221 {
 222 public:
 223     // Adds all paths in environment variable
 224     void AddEnvList(const wxString& envVariable);
 225
 226     void Add(const wxString& path);
 227     // Avoid compiler warning
 228     wxNode *Add(const wxChar *s) { return wxStringList::Add(s); }
 229     // Find the first full path for which the file exists
 230     wxString FindValidPath(const wxString& filename);
 231     // Find the first full path for which the file exists; ensure it's an
 232     // absolute path that gets returned.
 233     wxString FindAbsoluteValidPath(const wxString& filename);
 234     // Given full path and filename, add path to list
 235     void EnsureFileAccessible(const wxString& path);
 236     // Returns TRUE if the path is in the list
 237     bool Member(const wxString& path);
 238
 239 private:
 240     DECLARE_DYNAMIC_CLASS(wxPathList)
 241 };
 242
 243 #endif
 244   // _WX_FILEFN_H_