]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/filefn.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
converted to 16 colors
[wxWidgets.git] / include / wx / filefn.h
diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index 720beb4bf28f1cf48103cdfcd07cc6d477d69e76..b7455424ad00917870a6039b84b01725ad89727d 100644 (file)
--- a/include/wx/filefn.h
+++ b/include/wx/filefn.h
@@ -9,195 +9,231 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef   __FILEFNH__
-#define   __FILEFNH__
+#ifndef   _FILEFN_H_
+#define   _FILEFN_H_
 
 #ifdef __GNUG__
 
 #ifdef __GNUG__
-#pragma interface "filefn.h"
+    #pragma interface "filefn.h"
 #endif
 
 #endif
 
+#include <wx/list.h>
+
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 // define off_t
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 // define off_t
-#include  <sys/types.h>
+#ifndef __WXMAC__
+    #include  <sys/types.h>
+#else
+    typedef long off_t;
+#endif
 
 
-#ifdef    _MSC_VER
-  #define   off_t       _off_t
+#if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
+    typedef _off_t off_t;
+#elif defined(__BORLANDC__) && defined(__WIN16__)
+    typedef long off_t;
+#elif defined(__SC__)
+    typedef long off_t;
+#elif defined(__MWERKS__) && !defined(__INTEL__)
+    typedef long off_t;
 #endif
 
 #endif
 
-typedef enum {
+const off_t wxInvalidOffset = (off_t)-1;
+
+enum wxSeekMode
+{
   wxFromStart,
   wxFromCurrent,
   wxFromEnd
   wxFromStart,
   wxFromCurrent,
   wxFromEnd
-} wxSeekMode;
+};
+
+WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 
 // ----------------------------------------------------------------------------
 // functions
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // functions
 // ----------------------------------------------------------------------------
-bool WXDLLEXPORT wxFileExists(const wxString& filename);
+WXDLLEXPORT bool wxFileExists(const wxString& filename);
 #define FileExists wxFileExists
 
 // does the path exist? (may have or not '/' or '\\' at the end)
 #define FileExists wxFileExists
 
 // does the path exist? (may have or not '/' or '\\' at the end)
-bool WXDLLEXPORT wxPathExists(const char *pszPathName);
+WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName);
 
 #define wxDirExists wxPathExists
 #define DirExists wxDirExists
 
 
 #define wxDirExists wxPathExists
 #define DirExists wxDirExists
 
-bool WXDLLEXPORT wxIsAbsolutePath(const wxString& filename);
+WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
 #define IsAbsolutePath wxIsAbsolutePath
 
 // Get filename
 #define IsAbsolutePath wxIsAbsolutePath
 
 // Get filename
-char* WXDLLEXPORT wxFileNameFromPath(char *path);
-wxString WXDLLEXPORT wxFileNameFromPath(const wxString& path);
+WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path);
+WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
 #define FileNameFromPath wxFileNameFromPath
 
 // Get directory
 #define FileNameFromPath wxFileNameFromPath
 
 // Get directory
-char* WXDLLEXPORT wxPathOnly(char *path);
-wxString WXDLLEXPORT wxPathOnly(const wxString& path);
+WXDLLEXPORT wxString wxPathOnly(const wxString& path);
 #define PathOnly wxPathOnly
 
 // wxString version
 #define PathOnly wxPathOnly
 
 // wxString version
-wxString WXDLLEXPORT wxRealPath(const wxString& path);
+WXDLLEXPORT wxString wxRealPath(const wxString& path);
 
 
-void WXDLLEXPORT wxDos2UnixFilename(char *s);
+WXDLLEXPORT void wxDos2UnixFilename(wxChar *s);
 #define Dos2UnixFilename wxDos2UnixFilename
 
 #define Dos2UnixFilename wxDos2UnixFilename
 
-void WXDLLEXPORT wxUnix2DosFilename(char *s);
+WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
 #define Unix2DosFilename wxUnix2DosFilename
 
 #define Unix2DosFilename wxUnix2DosFilename
 
+#ifdef __WXMAC__
+  WXDLLEXPORT void wxMacPathToFSSpec( const wxChar *path , FSSpec *spec ) ;
+  WXDLLEXPORT void wxMac2UnixFilename(wxChar *s);
+  WXDLLEXPORT void wxUnix2MacFilename(wxChar *s);
+#endif
+
 // Strip the extension, in situ
 // Strip the extension, in situ
-void WXDLLEXPORT wxStripExtension(char *buffer);
+WXDLLEXPORT void wxStripExtension(wxChar *buffer);
+WXDLLEXPORT void wxStripExtension(wxString& buffer);
 
 // Get a temporary filename, opening and closing the file.
 
 // Get a temporary filename, opening and closing the file.
-char* WXDLLEXPORT wxGetTempFileName(const wxString& prefix, char *buf = NULL);
+WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 
 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 
 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
-char* WXDLLEXPORT wxExpandPath(char *dest, const char *path);
+WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 
 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 // and make (if under the home tree) relative to home
 // [caller must copy-- volatile]
 
 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 // and make (if under the home tree) relative to home
 // [caller must copy-- volatile]
-char* WXDLLEXPORT wxContractPath (const wxString& filename,
-   const wxString& envname = "", const wxString& user = "");
+WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
+                                  const wxString& envname = wxEmptyString,
+                                  const wxString& user = wxEmptyString);
 
 // Destructive removal of /./ and /../ stuff
 
 // Destructive removal of /./ and /../ stuff
-char* WXDLLEXPORT wxRealPath(char *path);
+WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
 
 // Allocate a copy of the full absolute path
 
 // Allocate a copy of the full absolute path
-char* WXDLLEXPORT wxCopyAbsolutePath(const wxString& path);
+WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path);
 
 // Get first file name matching given wild card.
 // Flags are reserved for future use.
 #define wxFILE  1
 #define wxDIR   2
 
 // Get first file name matching given wild card.
 // Flags are reserved for future use.
 #define wxFILE  1
 #define wxDIR   2
-char* WXDLLEXPORT wxFindFirstFile(const char *spec, int flags = wxFILE);
-char* WXDLLEXPORT wxFindNextFile(void);
+WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
+WXDLLEXPORT wxString wxFindNextFile();
 
 // Does the pattern contain wildcards?
 
 // Does the pattern contain wildcards?
-bool WXDLLEXPORT wxIsWild(const wxString& pattern);
+WXDLLEXPORT bool wxIsWild(const wxString& pattern);
 
 // Does the pattern match the text (usually a filename)?
 // If dot_special is TRUE, doesn't match * against . (eliminating
 // `hidden' dot files)
 
 // Does the pattern match the text (usually a filename)?
 // If dot_special is TRUE, doesn't match * against . (eliminating
 // `hidden' dot files)
-bool WXDLLEXPORT wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
+WXDLLEXPORT bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
 
 // Concatenate two files to form third
 
 // Concatenate two files to form third
-bool WXDLLEXPORT wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
+WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 
 // Copy file1 to file2
 
 // Copy file1 to file2
-bool WXDLLEXPORT wxCopyFile(const wxString& file1, const wxString& file2);
+WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2);
 
 // Remove file
 
 // Remove file
-bool WXDLLEXPORT wxRemoveFile(const wxString& file);
+WXDLLEXPORT bool wxRemoveFile(const wxString& file);
 
 // Rename file
 
 // Rename file
-bool WXDLLEXPORT wxRenameFile(const wxString& file1, const wxString& file2);
+WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
 
 // Get current working directory.
 // If buf is NULL, allocates space using new, else
 // copies into buf.
 // IMPORTANT NOTE getcwd is know not to work under some releases
 // of Win32s 1.3, according to MS release notes!
 
 // Get current working directory.
 // If buf is NULL, allocates space using new, else
 // copies into buf.
 // IMPORTANT NOTE getcwd is know not to work under some releases
 // of Win32s 1.3, according to MS release notes!
-char* WXDLLEXPORT wxGetWorkingDirectory(char *buf = NULL, int sz = 1000);
+WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
+// new and preferred version of wxGetWorkingDirectory
+// NB: can't have the same name because of overloading ambiguity
+WXDLLEXPORT wxString wxGetCwd();
 
 // Set working directory
 
 // Set working directory
-bool WXDLLEXPORT wxSetWorkingDirectory(const wxString& d);
+WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
 
 // Make directory
 
 // Make directory
-bool WXDLLEXPORT wxMkdir(const wxString& dir);
+WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
 
 // Remove directory. Flags reserved for future use.
 
 // Remove directory. Flags reserved for future use.
-bool WXDLLEXPORT wxRmdir(const wxString& dir, int flags = 0);
+WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 
 // separators in file names
 
 // separators in file names
-#define FILE_SEP_EXT        '.'
-#define FILE_SEP_DSK        ':'
-#define FILE_SEP_PATH_DOS   '\\'
-#define FILE_SEP_PATH_UNIX  '/'
+#define wxFILE_SEP_EXT        _T('.')
+#define wxFILE_SEP_DSK        _T(':')
+#define wxFILE_SEP_PATH_DOS   _T('\\')
+#define wxFILE_SEP_PATH_UNIX  _T('/')
 
 // separator in the path list (as in PATH environment variable)
 // NB: these are strings and not characters on purpose!
 
 // separator in the path list (as in PATH environment variable)
 // NB: these are strings and not characters on purpose!
-#define PATH_SEP_DOS        ";"
-#define PATH_SEP_UNIX       ":"
+#define wxPATH_SEP_DOS        _T(";")
+#define wxPATH_SEP_UNIX       _T(":")
 
 // platform independent versions
 #ifdef  __UNIX__
 
 // platform independent versions
 #ifdef  __UNIX__
-  #define FILE_SEP_PATH     FILE_SEP_PATH_UNIX
-  #define PATH_SEP          PATH_SEP_UNIX
-#else   // Windows
-  #define FILE_SEP_PATH     FILE_SEP_PATH_DOS
-  #define PATH_SEP          PATH_SEP_DOS
+  #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
+  #define wxPATH_SEP          wxPATH_SEP_UNIX
+#else   // Windows and OS/2
+  #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
+  #define wxPATH_SEP          wxPATH_SEP_DOS
 #endif  // Unix/Windows
 
 // this is useful for wxString::IsSameAs(): to compare two file names use
 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 #ifdef  __UNIX__
   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
 #endif  // Unix/Windows
 
 // this is useful for wxString::IsSameAs(): to compare two file names use
 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 #ifdef  __UNIX__
   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
-#else   // Windows
+#else   // Windows and OS/2
   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 #endif  // Unix/Windows
 
 // is the char a path separator?
   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 #endif  // Unix/Windows
 
 // is the char a path separator?
-inline bool wxIsPathSeparator(char c)
-  { return c == FILE_SEP_PATH_DOS || c == FILE_SEP_PATH_UNIX; }
+inline bool wxIsPathSeparator(wxChar c)
+  { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; }
 
 // does the string ends with path separator?
 
 // does the string ends with path separator?
-bool WXDLLEXPORT wxEndsWithPathSeparator(const char *pszFileName);
+WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 
 // split the full path into path (including drive for DOS), name and extension
 // (understands both '/' and '\\')
 
 // split the full path into path (including drive for DOS), name and extension
 // (understands both '/' and '\\')
-void WXDLLEXPORT wxSplitPath(const char *pszFileName,
+WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName,
                              wxString *pstrPath,
                              wxString *pstrName,
                              wxString *pstrExt);
 
 // find a file in a list of directories, returns false if not found
                              wxString *pstrPath,
                              wxString *pstrName,
                              wxString *pstrExt);
 
 // find a file in a list of directories, returns false if not found
-bool WXDLLEXPORT wxFindFileInPath(wxString *pStr, const char *pszPath, const char *pszFile);
+WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
+
+// Get the OS directory if appropriate (such as the Windows directory).
+// On non-Windows platform, probably just return the empty string.
+WXDLLEXPORT wxString wxGetOSDirectory();
 
 // ----------------------------------------------------------------------------
 // classes
 // ----------------------------------------------------------------------------
 
 // Path searching
 
 // ----------------------------------------------------------------------------
 // classes
 // ----------------------------------------------------------------------------
 
 // Path searching
-class WXDLLEXPORT wxPathList: public wxStringList
+class WXDLLEXPORT wxPathList : public wxStringList
 {
 {
-  DECLARE_DYNAMIC_CLASS(wxPathList)
-
-  public:
-  void AddEnvList(const wxString& envVariable);    // Adds all paths in environment variable
-  void Add(const wxString& path);
-  wxString FindValidPath(const wxString& filename);   // Find the first full path
-                                         // for which the file exists
-  wxString FindAbsoluteValidPath(const wxString& filename);   // Find the first full path
-                                         // for which the file exists; ensure it's an absolute
-                                         // path that gets returned.
-  void EnsureFileAccessible(const wxString& path); // Given full path and filename,
-                                         // add path to list
-  bool Member(const wxString& path);
+public:
+    // Adds all paths in environment variable
+    void AddEnvList(const wxString& envVariable);
+
+    void Add(const wxString& path);
+    // Avoid compiler warning
+    wxNode *Add(const wxChar *s) { return wxStringList::Add(s); }
+    // Find the first full path for which the file exists
+    wxString FindValidPath(const wxString& filename);
+    // Find the first full path for which the file exists; ensure it's an
+    // absolute path that gets returned.
+    wxString FindAbsoluteValidPath(const wxString& filename);
+    // Given full path and filename, add path to list
+    void EnsureFileAccessible(const wxString& path);
+    // Returns TRUE if the path is in the list
+    bool Member(const wxString& path);
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxPathList)
 };
 
 #endif
 };
 
 #endif
-  // __FILEFNH__
-
+  // _WX_FILEFN_H_
wxWidgets (Impactor)