wxChoicebook generic implementation.

[wxWidgets.git] / include / wx / filefn.h

diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index 3c7836428893b9ab6e9d105aace7e121c823c08f..928f608573a9d8be9abb8867740ebc43af87d7c3 100644 (file)
--- a/include/wx/filefn.h
+++ b/include/wx/filefn.h
@@ -6,228 +6,387 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _FILEFN_H_
 #define   _FILEFN_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _FILEFN_H_
 #define   _FILEFN_H_
 

-#ifdef __GNUG__
-#pragma interface "filefn.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "filefn.h"

 #endif
 
 #endif
 

-#include <wx/list.h>
+#include "wx/list.h"
+#include "wx/arrstr.h"
+
+#ifndef __WXWINCE__
+#include <time.h>
+#endif

 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 

-// define off_t
-#ifndef __WXMAC__
-#include  <sys/types.h>
+#ifdef __WXWINCE__
+    typedef long off_t;

 #else
 #else

-typedef long off_t;
-#endif

 
 

-#ifdef    _MSC_VER
-  #define   off_t       _off_t
+// define off_t
+#if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
+    #include  <sys/types.h>
+#else
+    typedef long off_t;

 #endif
 
 #endif
 

-#if defined(__BORLANDC__) && defined(__WIN16__)
-typedef long off_t;
+#if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
+    typedef _off_t off_t;
+#elif defined(__SYMANTEC__)
+    typedef long off_t;
+#elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
+    typedef long off_t;

 #endif
 
 #endif
 

-#if defined(__SC__)
-typedef long off_t;

 #endif
 
 #endif
 

+#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
+//
+// VisualAge C++ V4.0 cannot have any external linkage const decs
+// in headers included by more than one primary source
+//
+extern const off_t wxInvalidOffset;
+#else

 const off_t wxInvalidOffset = (off_t)-1;
 const off_t wxInvalidOffset = (off_t)-1;

+#endif

 
 

-typedef enum {
+enum wxSeekMode
+{

   wxFromStart,
   wxFromCurrent,
   wxFromEnd
   wxFromStart,
   wxFromCurrent,
   wxFromEnd

-} wxSeekMode;
+};
+
+// ----------------------------------------------------------------------------
+// declare our versions of low level file functions: some compilers prepend
+// underscores to the usual names, some also have Unicode versions of them
+// ----------------------------------------------------------------------------
+
+// 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(__DMC__) && defined(__WXMSW__) ) \
+    || ( defined(__WATCOMC__) && defined(__WXMSW__) )
+    // functions
+#if defined(__BORLANDC__) || defined(__WATCOMC__)
+    #define   _tell        tell
+#endif
+    #define   wxClose      _close
+    #define   wxRead       _read
+    #define   wxWrite      _write
+    #define   wxLseek      _lseek
+    #define   wxFsync      _commit
+    #define   wxEof        _eof
+
+    #define   wxTell       _tell
+
+    #if wxUSE_UNICODE
+        #if wxUSE_UNICODE_MSLU
+            #define   wxOpen       wxMSLU__wopen
+
+            #define   wxAccess     wxMSLU__waccess
+            #define   wxMkDir      wxMSLU__wmkdir
+            #define   wxRmDir      wxMSLU__wrmdir
+            #define   wxStat       wxMSLU__wstat
+        #else
+            #define   wxOpen       _wopen
+            #define   wxAccess     _waccess
+            #define   wxMkDir      _wmkdir
+            #define   wxRmDir      _wrmdir
+            #define   wxStat       _wstat
+        #endif
+    #else // !wxUSE_UNICODE
+#ifdef __BORLANDC__
+        #define   wxOpen       open
+#else
+        #define   wxOpen       _open
+#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__) && !defined(__WATCOMC__)
+        #define   O_RDONLY    _O_RDONLY
+        #define   O_WRONLY    _O_WRONLY
+        #define   O_RDWR      _O_RDWR
+        #define   O_EXCL      _O_EXCL
+        #define   O_CREAT     _O_CREAT
+        #define   O_BINARY    _O_BINARY
+    #endif
+
+    #if !defined(__BORLANDC__) && !defined(__WATCOMC__)
+        #define   S_IFMT      _S_IFMT
+        #define   S_IFDIR     _S_IFDIR
+        #define   S_IFREG     _S_IFREG
+    #endif // O_RDONLY
+#else
+    // functions
+    #define   wxClose      close
+    #define   wxRead       read
+    #define   wxWrite      write
+    #define   wxLseek      lseek
+    #define   wxFsync      commit
+    #define   wxEof        eof
+
+    #define   wxMkDir      mkdir
+    #define   wxRmDir      rmdir

 
 

-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+    #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>
+#endif
+#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
+    #define   wxAccess     access
+#endif
+
+#endif  // VC++

 
 // ----------------------------------------------------------------------------
 // functions
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // functions
 // ----------------------------------------------------------------------------

-WXDLLEXPORT bool wxFileExists(const wxString& filename);
-#define FileExists wxFileExists
+WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);

 
 // does the path exist? (may have or not '/' or '\\' at the end)
 
 // does the path exist? (may have or not '/' or '\\' at the end)

-WXDLLEXPORT bool wxPathExists(const char *pszPathName);
+WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName);

 
 

-#define wxDirExists wxPathExists
-#define DirExists wxDirExists
-
-WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
-#define IsAbsolutePath wxIsAbsolutePath
+WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);

 
 // Get filename
 
 // Get filename

-WXDLLEXPORT char* wxFileNameFromPath(char *path);
-WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
-#define FileNameFromPath wxFileNameFromPath
+WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
+WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);

 
 // Get directory
 
 // Get directory

-WXDLLEXPORT char* wxPathOnly(char *path);
-WXDLLEXPORT wxString wxPathOnly(const wxString& path);
-#define PathOnly wxPathOnly
+WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);

 
 // wxString version
 
 // wxString version

-WXDLLEXPORT wxString wxRealPath(const wxString& path);
+WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);

 
 

-WXDLLEXPORT void wxDos2UnixFilename(char *s);
-#define Dos2UnixFilename wxDos2UnixFilename
+WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);

 
 

-WXDLLEXPORT void wxUnix2DosFilename(char *s);
-#define Unix2DosFilename wxUnix2DosFilename
+WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);

 
 

-#ifdef __WXMAC__
-  WXDLLEXPORT void wxMacPathToFSSpec( const char *path , FSSpec *spec ) ;
-  WXDLLEXPORT void wxMac2UnixFilename(char *s);
-  WXDLLEXPORT void wxUnix2MacFilename(char *s);
-#endif

 // Strip the extension, in situ
 // Strip the extension, in situ

-WXDLLEXPORT void wxStripExtension(char *buffer);
-WXDLLEXPORT void wxStripExtension(wxString& buffer);
+WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
+WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);

 
 

-// Get a temporary filename, opening and closing the file.
-WXDLLEXPORT char* wxGetTempFileName(const wxString& prefix, char *buf = (char *) NULL);
+// Get a temporary filename
+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)
 
 // Expand file name (~/ and ${OPENWINHOME}/ stuff)

-WXDLLEXPORT char* wxExpandPath(char *dest, const char *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]
 
 // 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 char* wxContractPath(const wxString& filename,
-                                 const wxString& envname = wxEmptyString,
-                                 const wxString& user = wxEmptyString);
+WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
+                                   const wxString& envname = wxEmptyString,
+                                   const wxString& user = wxEmptyString);

 
 // Destructive removal of /./ and /../ stuff
 
 // Destructive removal of /./ and /../ stuff

-WXDLLEXPORT char* wxRealPath(char *path);
+WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);

 
 // Allocate a copy of the full absolute path
 
 // Allocate a copy of the full absolute path

-WXDLLEXPORT char* 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
 
 // Get first file name matching given wild card.
 // Flags are reserved for future use.
 #define wxFILE  1
 #define wxDIR   2

-WXDLLEXPORT char* wxFindFirstFile(const char *spec, int flags = wxFILE);
-WXDLLEXPORT char* wxFindNextFile(void);
+WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
+WXDLLIMPEXP_BASE wxString wxFindNextFile();

 
 // Does the pattern contain wildcards?
 
 // Does the pattern contain wildcards?

-WXDLLEXPORT bool wxIsWild(const wxString& pattern);
+WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);

 
 // Does the pattern match the text (usually a filename)?
 
 // 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)
 // `hidden' dot files)

-WXDLLEXPORT 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
 
 // Concatenate two files to form third

-WXDLLEXPORT 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
 
 // Copy file1 to file2

-WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2);
+WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
+                                 bool overwrite = true);

 
 // Remove file
 
 // Remove file

-WXDLLEXPORT bool wxRemoveFile(const wxString& file);
+WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);

 
 // Rename file
 
 // Rename file

-WXDLLEXPORT 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!
 
 // 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 char* wxGetWorkingDirectory(char *buf = (char *) 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
+WXDLLIMPEXP_BASE wxString wxGetCwd();

 
 // Set working directory
 
 // Set working directory

-WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
+WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);

 
 // Make directory
 
 // Make directory

-WXDLLEXPORT bool wxMkdir(const wxString& dir);
+WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);

 
 // Remove directory. Flags reserved for future use.
 
 // Remove directory. Flags reserved for future use.

-WXDLLEXPORT 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
+
+// ----------------------------------------------------------------------------

 // 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  '/'
+// ----------------------------------------------------------------------------
+
+// between file name and extension
+#define wxFILE_SEP_EXT        wxT('.')
+
+// between drive/volume name and the path
+#define wxFILE_SEP_DSK        wxT(':')
+
+// between the path components
+#define wxFILE_SEP_PATH_DOS   wxT('\\')
+#define wxFILE_SEP_PATH_UNIX  wxT('/')
+#define wxFILE_SEP_PATH_MAC   wxT(':')
+#define wxFILE_SEP_PATH_VMS   wxT('.') // VMS also uses '[' and ']'

 
 // separator in the path list (as in PATH environment variable)
 
 // separator in the path list (as in PATH environment variable)

+// there is no PATH variable in Classic Mac OS so just use the
+// semicolon (it must be different from the file name separator)

 // NB: these are strings and not characters on purpose!
 // NB: these are strings and not characters on purpose!

-#define PATH_SEP_DOS        ";"
-#define PATH_SEP_UNIX       ":"
+#define wxPATH_SEP_DOS        wxT(";")
+#define wxPATH_SEP_UNIX       wxT(":")
+#define wxPATH_SEP_MAC        wxT(";")

 
 // platform independent versions
 
 // 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
+#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
+#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)
 #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
-  #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
+#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

 #endif  // Unix/Windows
 
 // is the char a path separator?
 #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)
+{
+    // under DOS/Windows we should understand both Unix and DOS file separators
+#if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
+    return c == wxFILE_SEP_PATH;
+#else
+    return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
+#endif
+}

 
 // does the string ends with path separator?
 
 // does the string ends with path separator?

-WXDLLEXPORT bool wxEndsWithPathSeparator(const char *pszFileName);
+WXDLLIMPEXP_BASE 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 '\\')

-WXDLLEXPORT void wxSplitPath(const char *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
                              wxString *pstrPath,
                              wxString *pstrName,
                              wxString *pstrExt);
 
 // find a file in a list of directories, returns false if not found

-WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const char *pszPath, const char *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.
+WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
+
+// Get file modification time
+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
 
 // ----------------------------------------------------------------------------
 // classes
 // ----------------------------------------------------------------------------
 
 // Path searching

-class WXDLLEXPORT wxPathList : public wxStringList
+class WXDLLIMPEXP_BASE wxPathList : public wxStringList

 {
 public:
 {
 public:

-    void AddEnvList(const wxString& envVariable);    // Adds all paths in environment variable
+    // 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);
 
     void Add(const wxString& path);

-    // Avoid compiler warning
-    wxNode *Add(const char *s) { return wxStringList::Add(s); }
-
-    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
+    // 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:
     bool Member(const wxString& path);
 
 private:

-    DECLARE_DYNAMIC_CLASS(wxPathList)
+    // DECLARE_DYNAMIC_CLASS(wxPathList)

 };
 
 #endif
   // _WX_FILEFN_H_
 };
 
 #endif
   // _WX_FILEFN_H_

-