]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/file.cpp
Using a -1 (wxID_ANY) for menu or toolbar item IDs will now generate a
[wxWidgets.git] / src / common / file.cpp
index 0973ec9c3854675aea09a57562f8c9a801bc87f7..3eacce8a6a241b785cd79a97a8de660bda50b709 100644 (file)
@@ -7,14 +7,19 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+/*
+    TODO: remove all the WinCE ugliness from here, implement the wxOpen(),
+          wxSeek(), ... functions in a separate file for WinCE instead!!!
+ */
+
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma implementation "file.h"
 #endif
 
@@ -28,7 +33,7 @@
 #if wxUSE_FILE
 
 // standard
-#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__)
+#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
   #include  <io.h>
 
 #ifndef __SALFORDC__
     #define   NOMCX
 #endif
 
-    #include  <windows.h>     // for GetTempFileName
+#elif defined(__WXMSW__) && defined(__WXWINCE__)
+    // TODO: what to include?
+#elif (defined(__OS2__))
+    #include <io.h>
 #elif (defined(__UNIX__) || defined(__GNUWIN32__))
     #include  <unistd.h>
+    #include  <time.h>
+    #include  <sys/stat.h>
     #ifdef __GNUWIN32__
-        #include <windows.h>
+        #include "wx/msw/wrapwin.h"
+    #endif
+#elif defined(__DOS__)
+    #if defined(__WATCOMC__)
+       #include <io.h>
+    #elif defined(__DJGPP__)
+       #include <io.h>
+       #include <unistd.h>
+       #include <stdio.h>
+    #else
+        #error  "Please specify the header with file functions declarations."
     #endif
-#elif (defined(__WXPM__))
-    #include <io.h>
-    #define   W_OK        2
-    #define   R_OK        4
 #elif (defined(__WXSTUBS__))
     // Have to ifdef this for different environments
     #include <io.h>
 #endif
     char* mktemp( char * path ) { return path ;}
     #include <stat.h>
-    #define   W_OK        2
-    #define   R_OK        4
     #include  <unistd.h>
 #else
     #error  "Please specify the header with file functions declarations."
 #endif  //Win/UNIX
 
 #include  <stdio.h>       // SEEK_xxx constants
+
+#ifndef __WXWINCE__
 #include  <fcntl.h>       // O_RDONLY &c
+#endif
 
-#ifndef __MWERKS__
+#ifdef __WXWINCE__
+// Nothing
+#elif !defined(__MWERKS__)
     #include  <sys/types.h>   // needed for stat
     #include  <sys/stat.h>    // stat
-#elif ( defined(__MWERKS__) && defined(__WXMSW__) )
+#elif defined(__MWERKS__) && ( defined(__WXMSW__) || defined(__MACH__) )
     #include  <sys/types.h>   // needed for stat
     #include  <sys/stat.h>    // stat
 #endif
 
-#if defined(__BORLANDC__) || defined(_MSC_VER)
-    #define   W_OK        2
-    #define   R_OK        4
-#endif
+// Windows compilers don't have these constants
+#ifndef W_OK
+    enum
+    {
+        F_OK = 0,   // test for existence
+        X_OK = 1,   //          execute permission
+        W_OK = 2,   //          write
+        R_OK = 4    //          read
+    };
+#endif // W_OK
 
 // there is no distinction between text and binary files under Unix, so define
 // O_BINARY as 0 if the system headers don't do it already
 #endif // Salford C
 
 // wxWindows
-#include  "wx/string.h"
-#include  "wx/intl.h"
+#ifndef WX_PRECOMP
+    #include  "wx/string.h"
+    #include  "wx/intl.h"
+    #include  "wx/log.h"
+#endif // !WX_PRECOMP
+
+#include  "wx/filename.h"
 #include  "wx/file.h"
-#include  "wx/log.h"
+#include  "wx/filefn.h"
+
+#ifdef __WXMSW__
+    #include "wx/msw/mslu.h"
+#endif
+
+#ifdef __WXWINCE__
+    #include "wx/msw/private.h"
+#endif
 
 // ============================================================================
 // implementation of wxFile
 // ----------------------------------------------------------------------------
 // static functions
 // ----------------------------------------------------------------------------
+
 bool wxFile::Exists(const wxChar *name)
 {
-    wxStructStat st;
-#if wxUSE_UNICODE && wxMBFILES
-    wxCharBuffer fname = wxConvFile.cWC2MB(name);
-
-    return !wxAccess(fname, 0) &&
-           !wxStat(wxMBSTRINGCAST fname, &st) &&
-           (st.st_mode & S_IFREG);
-
-#else
-    return !wxAccess(name, 0) &&
-           !wxStat(name, &st) &&
-           (st.st_mode & S_IFREG);
-#endif
+    return wxFileExists(name);
 }
 
 bool wxFile::Access(const wxChar *name, OpenMode mode)
 {
-    int how = 0;
+    int how;
+
+    switch ( mode )
+    {
+        default:
+            wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));
+            // fall through
 
-    switch ( mode ) {
         case read:
             how = R_OK;
             break;
@@ -163,11 +195,17 @@ bool wxFile::Access(const wxChar *name, OpenMode mode)
             how = W_OK;
             break;
 
-        default:
-            wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));
+        case read_write:
+            how = R_OK | W_OK;
+            break;
     }
 
-    return wxAccess(wxFNCONV(name), how) == 0;
+#ifdef __WXWINCE__
+    // FIXME: use CreateFile with 0 access to query the file
+    return TRUE;
+#else
+    return wxAccess(name, how) == 0;
+#endif
 }
 
 // ----------------------------------------------------------------------------
@@ -188,21 +226,34 @@ bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode)
 {
     // if bOverwrite we create a new file or truncate the existing one,
     // otherwise we only create the new file and fail if it already exists
-#if defined(__WXMAC__) && !defined(__UNIX__)
-  // Dominic Mazzoni [dmazzoni+@cs.cmu.edu] reports that open is still broken on the mac, so we replace
-  // int fd = open(wxUnix2MacFilename( szFileName ), O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access);
-  int fd = creat( szFileName , accessMode);
+#if defined(__WXMAC__) && !defined(__UNIX__) && !wxUSE_UNICODE
+    // Dominic Mazzoni [dmazzoni+@cs.cmu.edu] reports that open is still broken on the mac, so we replace
+    // int fd = open(wxUnix2MacFilename( szFileName ), O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access);
+    int fd = creat( szFileName , accessMode);
+#else
+#ifdef __WXWINCE__
+    HANDLE fileHandle = ::CreateFile(szFileName, GENERIC_WRITE, 0, NULL,
+        bOverwrite ? CREATE_ALWAYS : CREATE_NEW, FILE_ATTRIBUTE_NORMAL,
+        0);
+    int fd = 0;
+    if (fileHandle == INVALID_HANDLE_VALUE)
+        fd = (int) fileHandle;
+    else
+        fd = -1;
 #else
-    int fd = wxOpen(wxFNCONV(szFileName),
-                    O_BINARY | O_WRONLY | O_CREAT |
-                    (bOverwrite ? O_TRUNC : O_EXCL)
-                    ACCESS(accessMode));
+    int fd = wxOpen( szFileName,
+                     O_BINARY | O_WRONLY | O_CREAT |
+                     (bOverwrite ? O_TRUNC : O_EXCL)
+                     ACCESS(accessMode) );
+#endif
 #endif
-    if ( fd == -1 ) {
+    if ( fd == -1 )
+    {
         wxLogSysError(_("can't create file '%s'"), szFileName);
         return FALSE;
     }
-    else {
+    else
+    {
         Attach(fd);
         return TRUE;
     }
@@ -211,9 +262,63 @@ bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode)
 // open the file
 bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
 {
+#ifdef __WXWINCE__
+    DWORD access = 0;
+    DWORD shareMode = 0;
+    DWORD disposition = 0;
+
     int flags = O_BINARY;
 
-    switch ( mode ) {
+    switch ( mode )
+    {
+        case read:
+            access = GENERIC_READ;
+            shareMode = FILE_SHARE_READ|FILE_SHARE_WRITE;
+            disposition = OPEN_EXISTING;
+            break;
+
+        case write_append:
+            if ( wxFile::Exists(szFileName) )
+            {
+                access = GENERIC_READ|GENERIC_WRITE;
+                shareMode = FILE_SHARE_READ;
+                disposition = 0;
+                break;
+            }
+            //else: fall through as write_append is the same as write if the
+            //      file doesn't exist
+
+        case write:
+            access = GENERIC_WRITE;
+            shareMode = 0;
+            disposition = TRUNCATE_EXISTING;
+            break;
+
+        case write_excl:
+            access = GENERIC_WRITE;
+            shareMode = 0;
+            disposition = TRUNCATE_EXISTING;
+            break;
+
+        case read_write:
+            access = GENERIC_READ|GENERIC_WRITE;
+            shareMode = 0;
+            disposition = 0;
+            break;
+    }
+
+    int fd = 0;
+    HANDLE fileHandle = ::CreateFile(szFileName, access, shareMode, NULL,
+        disposition, FILE_ATTRIBUTE_NORMAL, 0);
+    if (fileHandle == INVALID_HANDLE_VALUE)
+        fd = -1;
+    else
+        fd = (int) fileHandle;
+#else
+    int flags = O_BINARY;
+
+    switch ( mode )
+    {
         case read:
             flags |= O_RDONLY;
             break;
@@ -231,13 +336,19 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
             flags |= O_WRONLY | O_CREAT | O_TRUNC;
             break;
 
+        case write_excl:
+            flags |= O_WRONLY | O_CREAT | O_EXCL;
+            break;
+
         case read_write:
             flags |= O_RDWR;
             break;
     }
 
-    int fd = wxOpen(wxFNCONV(szFileName), flags ACCESS(accessMode));
-    if ( fd == -1 ) {
+    int fd = wxOpen( szFileName, flags ACCESS(accessMode));
+#endif
+    if ( fd == -1 )
+    {
         wxLogSysError(_("can't open file '%s'"), szFileName);
         return FALSE;
     }
@@ -251,7 +362,12 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
 bool wxFile::Close()
 {
     if ( IsOpened() ) {
-        if ( close(m_fd) == -1 ) {
+#ifdef __WXWINCE__
+        if (!CloseHandle((HANDLE) m_fd))
+#else
+        if ( close(m_fd) == -1 )
+#endif
+        {
             wxLogSysError(_("can't close file descriptor %d"), m_fd);
             m_fd = fd_invalid;
             return FALSE;
@@ -272,7 +388,14 @@ off_t wxFile::Read(void *pBuf, off_t nCount)
 {
     wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
 
-#ifdef __MWERKS__
+#ifdef __WXWINCE__
+    DWORD bytesRead = 0;
+    int iRc = 0;
+    if (ReadFile((HANDLE) m_fd, pBuf, (DWORD) nCount, & bytesRead, NULL))
+        iRc = bytesRead;
+    else
+        iRc = -1;
+#elif defined(__MWERKS__)
     int iRc = ::read(m_fd, (char*) pBuf, nCount);
 #else
     int iRc = ::read(m_fd, pBuf, nCount);
@@ -290,7 +413,14 @@ size_t wxFile::Write(const void *pBuf, size_t nCount)
 {
     wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
 
-#ifdef __MWERKS__
+#ifdef __WXWINCE__
+    DWORD bytesRead = 0;
+    int iRc = 0;
+    if (WriteFile((HANDLE) m_fd, pBuf, (DWORD) nCount, & bytesRead, NULL))
+        iRc = bytesRead;
+    else
+        iRc = -1;
+#elif defined(__MWERKS__)
 #if __MSL__ >= 0x6000
     int iRc = ::write(m_fd, (void*) pBuf, nCount);
 #else
@@ -312,7 +442,9 @@ size_t wxFile::Write(const void *pBuf, size_t nCount)
 bool wxFile::Flush()
 {
     if ( IsOpened() ) {
-#if defined(__VISUALC__) || wxHAVE_FSYNC
+#ifdef __WXWINCE__
+        // Do nothing
+#elif defined(__VISUALC__) || wxHAVE_FSYNC
         if ( wxFsync(m_fd) == -1 )
         {
             wxLogSysError(_("can't flush file descriptor %d"), m_fd);
@@ -335,6 +467,34 @@ off_t wxFile::Seek(off_t ofs, wxSeekMode mode)
 {
     wxASSERT( IsOpened() );
 
+#ifdef __WXWINCE__
+    int origin;
+    switch ( mode ) {
+        default:
+            wxFAIL_MSG(_("unknown seek origin"));
+
+        case wxFromStart:
+            origin = FILE_BEGIN;
+            break;
+
+        case wxFromCurrent:
+            origin = FILE_CURRENT;
+            break;
+
+        case wxFromEnd:
+            origin = FILE_END;
+            break;
+    }
+
+    DWORD res = SetFilePointer((HANDLE) m_fd, ofs, 0, origin) ;
+    if (res == 0xFFFFFFFF && GetLastError() != NO_ERROR)
+    {
+        wxLogSysError(_("can't seek on file descriptor %d"), m_fd);
+        return wxInvalidOffset;
+    }
+    else
+        return (off_t)res;
+#else
     int origin;
     switch ( mode ) {
         default:
@@ -360,6 +520,7 @@ off_t wxFile::Seek(off_t ofs, wxSeekMode mode)
     }
     else
         return (off_t)iRc;
+#endif
 }
 
 // get current off_t
@@ -367,6 +528,16 @@ off_t wxFile::Tell() const
 {
     wxASSERT( IsOpened() );
 
+#ifdef __WXWINCE__
+    DWORD res = SetFilePointer((HANDLE) m_fd, 0, 0, FILE_CURRENT) ;
+    if (res == 0xFFFFFFFF && GetLastError() != NO_ERROR)
+    {
+        wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
+        return wxInvalidOffset;
+    }
+    else
+        return (off_t)res;
+#else
     int iRc = wxTell(m_fd);
     if ( iRc == -1 ) {
         wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
@@ -374,6 +545,7 @@ off_t wxFile::Tell() const
     }
     else
         return (off_t)iRc;
+#endif
 }
 
 // get current file length
@@ -381,6 +553,15 @@ off_t wxFile::Length() const
 {
     wxASSERT( IsOpened() );
 
+#ifdef __WXWINCE__
+    DWORD off0 = SetFilePointer((HANDLE) m_fd, 0, 0, FILE_CURRENT);
+    DWORD off1 = SetFilePointer((HANDLE) m_fd, 0, 0, FILE_END);
+    off_t len = off1;
+
+    // Restore position
+    SetFilePointer((HANDLE) m_fd, off0, 0, FILE_BEGIN);
+    return len;
+#else
 #ifdef __VISUALC__
     int iRc = _filelength(m_fd);
 #else // !VC++
@@ -406,6 +587,7 @@ off_t wxFile::Length() const
     }
     else
         return (off_t)iRc;
+#endif
 }
 
 // is end of file reached?
@@ -413,9 +595,20 @@ bool wxFile::Eof() const
 {
     wxASSERT( IsOpened() );
 
+#ifdef __WXWINCE__
+    DWORD off0 = SetFilePointer((HANDLE) m_fd, 0, 0, FILE_CURRENT);
+    DWORD off1 = SetFilePointer((HANDLE) m_fd, 0, 0, FILE_END);
+    if (off0 == off1)
+        return TRUE;
+    else
+    {
+        SetFilePointer((HANDLE) m_fd, off0, 0, FILE_BEGIN);
+        return FALSE;
+    }
+#else
     int iRc;
 
-#if defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__)
+#if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__)
     // @@ this doesn't work, of course, on unseekable file descriptors
     off_t ofsCur = Tell(),
     ofsMax = Length();
@@ -443,6 +636,7 @@ bool wxFile::Eof() const
     }
 
     return TRUE;
+#endif
 }
 
 // ============================================================================
@@ -452,6 +646,7 @@ bool wxFile::Eof() const
 // ----------------------------------------------------------------------------
 // construction
 // ----------------------------------------------------------------------------
+
 wxTempFile::wxTempFile(const wxString& strName)
 {
     Open(strName);
@@ -459,81 +654,56 @@ wxTempFile::wxTempFile(const wxString& strName)
 
 bool wxTempFile::Open(const wxString& strName)
 {
-    m_strName = strName;
-
-    // we want to create the file in the same directory as strName because
-    // otherwise rename() in Commit() might not work (if the files are on
-    // different partitions for example). Unfortunately, the only standard
-    // (POSIX) temp file creation function tmpnam() can't do it.
-#if defined(__UNIX__) || defined(__WXSTUBS__)|| defined( __WXMAC__ )
-    static const wxChar *szMktempSuffix = wxT("XXXXXX");
-    m_strTemp << strName << szMktempSuffix;
-    // can use the cast because length doesn't change
-    mktemp(wxMBSTRINGCAST m_strTemp.mb_str());
-#elif  defined(__WXPM__)
-    // for now just create a file
-    // future enhancements can be to set some extended attributes for file systems
-    // OS/2 supports that have them (HPFS, FAT32) and security (HPFS386)
-    static const wxChar *szMktempSuffix = wxT("XXX");
-    m_strTemp << strName << szMktempSuffix;
-    // Temporarily remove - MN
-    #ifndef __WATCOMC__
-    ::DosCreateDir(m_strTemp.GetWriteBuf(MAX_PATH), NULL);
-    #endif
-#else // Windows
-    wxString strPath;
-    wxSplitPath(strName, &strPath, NULL, NULL);
-    if ( strPath.IsEmpty() )
-        strPath = wxT('.');  // GetTempFileName will fail if we give it empty string
-#ifdef __WIN32__
-    if ( !GetTempFileName(strPath, wxT("wx_"),0, m_strTemp.GetWriteBuf(MAX_PATH)) )
-#else
-        // Not sure why MSVC++ 1.5 header defines first param as BYTE - bug?
-        if ( !GetTempFileName((BYTE) (DWORD)(const wxChar*) strPath, wxT("wx_"),0, m_strTemp.GetWriteBuf(MAX_PATH)) )
-#endif
-            wxLogLastError(wxT("GetTempFileName"));
-    m_strTemp.UngetWriteBuf();
-#endif  // Windows/Unix
+    // we must have an absolute filename because otherwise CreateTempFileName()
+    // would create the temp file in $TMP (i.e. the system standard location
+    // for the temp files) which might be on another volume/drive/mount and
+    // wxRename()ing it later to m_strName from Commit() would then fail
+    //
+    // with the absolute filename, the temp file is created in the same
+    // directory as this one which ensures that wxRename() may work later
+    wxFileName fn(strName);
+    if ( !fn.IsAbsolute() )
+    {
+        fn.Normalize(wxPATH_NORM_ABSOLUTE);
+    }
 
-    int access = wxS_DEFAULT;
-#ifdef __UNIX__
-    // create the file with the same mode as the original one under Unix
-    mode_t umaskOld = 0; // just to suppress compiler warning
-    bool changedUmask;
+    m_strName = fn.GetFullPath();
+
+    m_strTemp = wxFileName::CreateTempFileName(m_strName, &m_file);
+
+    if ( m_strTemp.empty() )
+    {
+        // CreateTempFileName() failed
+        return FALSE;
+    }
 
+#ifdef __UNIX__
+    // the temp file should have the same permissions as the original one
+    mode_t mode;
+    
     wxStructStat st;
-    if ( stat(strName.fn_str(), &st) == 0 )
+    if ( stat( (const char*) m_strName.fn_str(), &st) == 0 )
     {
-        // this assumes that only lower bits of st_mode contain the access
-        // rights, but it's true for at least all Unices which have S_IXXXX()
-        // macros, so should not be less portable than using (not POSIX)
-        // S_IFREG &c
-        access = st.st_mode & 0777;
-
-        // we want to create the file with exactly the same access rights as
-        // the original one, so disable the user's umask for the moment
-        umaskOld = umask(0);
-        changedUmask = TRUE;
+        mode = st.st_mode;
     }
     else
     {
-        // file probably didn't exist, just create with default mode _using_
-        // user's umask (new files creation should respet umask)
-        changedUmask = FALSE;
+        // file probably didn't exist, just give it the default mode _using_
+        // user's umask (new files creation should respect umask)
+        mode_t mask = umask(0777);
+        mode = 0666 & ~mask;
+        umask(mask);
     }
-#endif // Unix
-
-    bool ok = m_file.Open(m_strTemp, wxFile::write, access);
 
-#ifdef __UNIX__
-    if ( changedUmask )
+    if ( chmod( (const char*) m_strTemp.fn_str(), mode) == -1 )
     {
-        // restore umask now that the file is created
-        (void)umask(umaskOld);
+#ifndef __OS2__
+        wxLogSysError(_("Failed to set temporary file permissions"));
+#endif
     }
 #endif // Unix
 
-    return ok;
+    return TRUE;
 }
 
 // ----------------------------------------------------------------------------
@@ -555,7 +725,7 @@ bool wxTempFile::Commit()
         return FALSE;
     }
 
-    if ( wxRename(m_strTemp, m_strName) != 0 ) {
+    if ( !wxRenameFile(m_strTemp, m_strName)  ) {
         wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str());
         return FALSE;
     }
@@ -570,5 +740,5 @@ void wxTempFile::Discard()
         wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str());
 }
 
-#endif
+#endif // wxUSE_FILE