]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/filefn.h
wxChoicebook generic implementation.
[wxWidgets.git] / include / wx / filefn.h
index 9b0bbfeda75ae497449a64ce9a62cd97390df60a..928f608573a9d8be9abb8867740ebc43af87d7c3 100644 (file)
 #ifndef   _FILEFN_H_
 #define   _FILEFN_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "filefn.h"
 #endif
 
 #include "wx/list.h"
+#include "wx/arrstr.h"
 
 #ifndef __WXWINCE__
 #include <time.h>
@@ -39,8 +40,6 @@
 
 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
     typedef _off_t off_t;
-#elif defined(__BORLANDC__) && defined(__WIN16__)
-    typedef long off_t;
 #elif defined(__SYMANTEC__)
     typedef long off_t;
 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
@@ -74,9 +73,11 @@ enum wxSeekMode
 // Microsoft compiler loves underscores, feed them to it
 #if defined( __VISUALC__ ) \
     || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
-    || ( defined(__MWERKS__) && defined(__WXMSW__) )
+    || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
+    || ( defined(__DMC__) && defined(__WXMSW__) ) \
+    || ( defined(__WATCOMC__) && defined(__WXMSW__) )
     // functions
-#ifdef __BORLANDC__
+#if defined(__BORLANDC__) || defined(__WATCOMC__)
     #define   _tell        tell
 #endif
     #define   wxClose      _close
@@ -91,7 +92,7 @@ enum wxSeekMode
     #if wxUSE_UNICODE
         #if wxUSE_UNICODE_MSLU
             #define   wxOpen       wxMSLU__wopen
+
             #define   wxAccess     wxMSLU__waccess
             #define   wxMkDir      wxMSLU__wmkdir
             #define   wxRmDir      wxMSLU__wrmdir
@@ -111,15 +112,23 @@ enum wxSeekMode
 #endif
         #define   wxAccess     _access
         #define   wxMkDir      _mkdir
+#ifdef __WATCOMC__
+        #define   wxRmDir      rmdir
+#else
         #define   wxRmDir      _rmdir
+#endif
         #define   wxStat       _stat
     #endif
 
     // types
+#if defined(__WATCOMC__)&& wxUSE_UNICODE
+    #define   wxStructStat struct _wstat
+#else
     #define   wxStructStat struct _stat
+#endif
 
     // constants (unless already defined by the user code)
-    #if !defined(O_RDONLY) && !defined(__BORLANDC__)
+    #if !defined(O_RDONLY) && !defined(__BORLANDC__) && !defined(__WATCOMC__)
         #define   O_RDONLY    _O_RDONLY
         #define   O_WRONLY    _O_WRONLY
         #define   O_RDWR      _O_RDWR
@@ -128,7 +137,7 @@ enum wxSeekMode
         #define   O_BINARY    _O_BINARY
     #endif
 
-    #ifndef __BORLANDC__
+    #if !defined(__BORLANDC__) && !defined(__WATCOMC__)
         #define   S_IFMT      _S_IFMT
         #define   S_IFDIR     _S_IFDIR
         #define   S_IFREG     _S_IFREG
@@ -148,15 +157,18 @@ enum wxSeekMode
     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 
     #define   wxStructStat struct stat
-    
+
 #if wxUSE_UNICODE
 #   define wxNEED_WX_UNISTD_H
 #if defined(__MWERKS__) && defined(macintosh)
-       #include <sys/stat.h>
+    #include <sys/stat.h>
 #endif
-WXDLLEXPORT_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
-WXDLLEXPORT_BASE int wxAccess( const wxChar *pathname, int mode );
-WXDLLEXPORT_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
+#if defined(__DMC__)
+    typedef unsigned long mode_t;
+#endif
+WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
+WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
+WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
 #else
     #define   wxOpen       open
     #define   wxStat       stat
@@ -168,112 +180,102 @@ WXDLLEXPORT_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
 // ----------------------------------------------------------------------------
 // functions
 // ----------------------------------------------------------------------------
-WXDLLEXPORT_BASE bool wxFileExists(const wxString& filename);
+WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
 
 // does the path exist? (may have or not '/' or '\\' at the end)
-WXDLLEXPORT_BASE bool wxPathExists(const wxChar *pszPathName);
+WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName);
 
-WXDLLEXPORT_BASE bool wxIsAbsolutePath(const wxString& filename);
+WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
 
 // Get filename
-WXDLLEXPORT_BASE wxChar* wxFileNameFromPath(wxChar *path);
-WXDLLEXPORT_BASE wxString wxFileNameFromPath(const wxString& path);
+WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
+WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
 
 // Get directory
-WXDLLEXPORT_BASE wxString wxPathOnly(const wxString& path);
+WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
 
 // wxString version
-WXDLLEXPORT_BASE wxString wxRealPath(const wxString& path);
+WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
 
-WXDLLEXPORT_BASE void wxDos2UnixFilename(wxChar *s);
+WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
 
-WXDLLEXPORT_BASE void wxUnix2DosFilename(wxChar *s);
+WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
 
 // Strip the extension, in situ
-WXDLLEXPORT_BASE void wxStripExtension(wxChar *buffer);
-WXDLLEXPORT_BASE void wxStripExtension(wxString& buffer);
+WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
+WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
 
 // Get a temporary filename
-WXDLLEXPORT_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
-WXDLLEXPORT_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
+WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
+WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 
 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
-WXDLLEXPORT_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
-WXDLLEXPORT_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
+WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
+WXDLLIMPEXP_BASE bool wxExpandPath(wxString& 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]
-WXDLLEXPORT_BASE wxChar* wxContractPath(const wxString& filename,
+WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
                                    const wxString& envname = wxEmptyString,
                                    const wxString& user = wxEmptyString);
 
 // Destructive removal of /./ and /../ stuff
-WXDLLEXPORT_BASE wxChar* wxRealPath(wxChar *path);
+WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
 
 // Allocate a copy of the full absolute path
-WXDLLEXPORT_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
+WXDLLIMPEXP_BASE 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
-WXDLLEXPORT_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
-WXDLLEXPORT_BASE wxString wxFindNextFile();
+WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
+WXDLLIMPEXP_BASE wxString wxFindNextFile();
 
 // Does the pattern contain wildcards?
-WXDLLEXPORT_BASE bool wxIsWild(const wxString& pattern);
+WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
 
 // Does the pattern match the text (usually a filename)?
-// If dot_special is TRUE, doesn't match * against . (eliminating
+// If dot_special is true, doesn't match * against . (eliminating
 // `hidden' dot files)
-WXDLLEXPORT_BASE bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
+WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = true);
 
 // Concatenate two files to form third
-WXDLLEXPORT_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
+WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 
 // Copy file1 to file2
-WXDLLEXPORT_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
-                            bool overwrite = TRUE);
+WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
+                                 bool overwrite = true);
 
 // Remove file
-WXDLLEXPORT_BASE bool wxRemoveFile(const wxString& file);
+WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 
 // Rename file
-WXDLLEXPORT_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
+WXDLLIMPEXP_BASE 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!
-WXDLLEXPORT_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
+WXDLLIMPEXP_BASE 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_BASE wxString wxGetCwd();
+WXDLLIMPEXP_BASE wxString wxGetCwd();
 
 // Set working directory
-WXDLLEXPORT_BASE bool wxSetWorkingDirectory(const wxString& d);
+WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
 
 // Make directory
-WXDLLEXPORT_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
+WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
 
 // Remove directory. Flags reserved for future use.
-WXDLLEXPORT_BASE bool wxRmdir(const wxString& dir, int flags = 0);
+WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 
 // compatibility defines, don't use in new code
 #define wxDirExists wxPathExists
 
-#if WXWIN_COMPATIBILITY_2
-    #define FileExists wxFileExists
-    #define DirExists wxDirExists
-    #define IsAbsolutePath wxIsAbsolutePath
-    #define FileNameFromPath wxFileNameFromPath
-    #define PathOnly wxPathOnly
-    #define Dos2UnixFilename wxDos2UnixFilename
-    #define Unix2DosFilename wxUnix2DosFilename
-#endif
-
 // ----------------------------------------------------------------------------
 // separators in file names
 // ----------------------------------------------------------------------------
@@ -299,15 +301,13 @@ WXDLLEXPORT_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 #define wxPATH_SEP_MAC        wxT(";")
 
 // platform independent versions
-#if defined(__UNIX__) && !defined(__CYGWIN__)
+#if defined(__UNIX__) && !defined(__OS2__)
+  // CYGWIN also uses UNIX settings
   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
   #define wxPATH_SEP          wxPATH_SEP_UNIX
 #elif defined(__MAC__)
   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
   #define wxPATH_SEP          wxPATH_SEP_MAC
-#elif defined(__CYGWIN__) // Cygwin
-  #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
-  #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
@@ -315,17 +315,17 @@ WXDLLEXPORT_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 
 // this is useful for wxString::IsSameAs(): to compare two file names use
 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
-#if defined(__UNIX__) && !defined(__DARWIN__)
-  #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
+#if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
+  #define wxARE_FILENAMES_CASE_SENSITIVE  true
 #else   // Windows, Mac OS and OS/2
-  #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
+  #define wxARE_FILENAMES_CASE_SENSITIVE  false
 #endif  // Unix/Windows
 
 // is the char a path separator?
 inline bool wxIsPathSeparator(wxChar c)
 {
     // under DOS/Windows we should understand both Unix and DOS file separators
-#if defined(__UNIX__) || defined(__MAC__)
+#if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
     return c == wxFILE_SEP_PATH;
 #else
     return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
@@ -333,39 +333,47 @@ inline bool wxIsPathSeparator(wxChar c)
 }
 
 // does the string ends with path separator?
-WXDLLEXPORT_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
+WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 
 // split the full path into path (including drive for DOS), name and extension
 // (understands both '/' and '\\')
-WXDLLEXPORT_BASE void wxSplitPath(const wxChar *pszFileName,
+WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName,
                              wxString *pstrPath,
                              wxString *pstrName,
                              wxString *pstrExt);
 
 // find a file in a list of directories, returns false if not found
-WXDLLEXPORT_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
+WXDLLIMPEXP_BASE 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_BASE wxString wxGetOSDirectory();
+WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
 
 // Get file modification time
-WXDLLEXPORT_BASE time_t wxFileModificationTime(const wxString& filename);
+WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
+
+// Parses the wildCard, returning the number of filters.
+// Returns 0 if none or if there's a problem,
+// The arrays will contain an equal number of items found before the error.
+// wildCard is in the form:
+// "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
+WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
 
 // ----------------------------------------------------------------------------
 // classes
 // ----------------------------------------------------------------------------
 
 // Path searching
-class WXDLLEXPORT_BASE wxPathList : public wxStringList
+class WXDLLIMPEXP_BASE wxPathList : public wxStringList
 {
 public:
+    // avoid GCC warning about virtual functions w/o virtual dtor
+    virtual ~wxPathList() {}
+
     // 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
@@ -373,11 +381,11 @@ public:
     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
+    // Returns true if the path is in the list
     bool Member(const wxString& path);
 
 private:
-    DECLARE_DYNAMIC_CLASS(wxPathList)
+    // DECLARE_DYNAMIC_CLASS(wxPathList)
 };
 
 #endif