X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/655719367ac5e131d9642e5783f3ecf64d1a3385..8fdbcf4de8eeff67ccfaf3deec833d203f112629:/src/common/file.cpp diff --git a/src/common/file.cpp b/src/common/file.cpp index 283d91002f..d6b4620e7d 100644 --- a/src/common/file.cpp +++ b/src/common/file.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: file.cpp +// Name: src/common/file.cpp // Purpose: wxFile - encapsulates low-level "file descriptor" // wxTempFile // Author: Vadim Zeitlin @@ -10,19 +10,10 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -/* - TODO: remove all the WinCE ugliness from here, implement the wxOpen(), - wxSeek(), ... functions in a separate file for WinCE instead!!! - */ - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "file.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -33,34 +24,31 @@ #if wxUSE_FILE // standard -#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__) - #include - -#ifndef __SALFORDC__ - #define WIN32_LEAN_AND_MEAN - #define NOSERVICE - #define NOIME - #define NOATOM - #define NOGDI - #define NOGDICAPMASKS - #define NOMETAFILE - #define NOMINMAX - #define NOMSG - #define NOOPENFILE - #define NORASTEROPS - #define NOSCROLL - #define NOSOUND - #define NOSYSMETRICS - #define NOTEXTMETRIC - #define NOWH - #define NOCOMM - #define NOKANJI - #define NOCRYPT - #define NOMCX -#endif - -#elif defined(__WXMSW__) && defined(__WXWINCE__) - // TODO: what to include? +#if defined(__WINDOWS__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__) + +#define WIN32_LEAN_AND_MEAN +#define NOSERVICE +#define NOIME +#define NOATOM +#define NOGDI +#define NOGDICAPMASKS +#define NOMETAFILE +#define NOMINMAX +#define NOMSG +#define NOOPENFILE +#define NORASTEROPS +#define NOSCROLL +#define NOSOUND +#define NOSYSMETRICS +#define NOTEXTMETRIC +#define NOWH +#define NOCOMM +#define NOKANJI +#define NOCRYPT +#define NOMCX + +#elif defined(__WINDOWS__) && defined(__WXWINCE__) + #include "wx/msw/missing.h" #elif (defined(__OS2__)) #include #elif (defined(__UNIX__) || defined(__GNUWIN32__)) @@ -91,7 +79,7 @@ #endif char* mktemp( char * path ) { return path ;} #include - #include + #include #else #error "Please specify the header with file functions declarations." #endif //Win/UNIX @@ -99,17 +87,7 @@ #include // SEEK_xxx constants #ifndef __WXWINCE__ -#include // O_RDONLY &c -#endif - -#ifdef __WXWINCE__ -// Nothing -#elif !defined(__MWERKS__) - #include // needed for stat - #include // stat -#elif defined(__MWERKS__) && ( defined(__WXMSW__) || defined(__MACH__) ) - #include // needed for stat - #include // stat + #include #endif // Windows compilers don't have these constants @@ -123,40 +101,25 @@ }; #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 -#if defined(__UNIX__) && !defined(O_BINARY) - #define O_BINARY (0) -#endif //__UNIX__ - -#ifdef __SALFORDC__ - #include -#endif - -#ifndef MAX_PATH - #define MAX_PATH 512 -#endif - -// some broken compilers don't have 3rd argument in open() and creat() -#ifdef __SALFORDC__ - #define ACCESS(access) - #define stat _stat -#else // normal compiler - #define ACCESS(access) , (access) -#endif // Salford C - // wxWidgets #ifndef WX_PRECOMP #include "wx/string.h" #include "wx/intl.h" #include "wx/log.h" + #include "wx/crt.h" #endif // !WX_PRECOMP #include "wx/filename.h" #include "wx/file.h" #include "wx/filefn.h" -#ifdef __WXMSW__ +// 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 +#if defined(__UNIX__) && !defined(O_BINARY) + #define O_BINARY (0) +#endif //__UNIX__ + +#ifdef __WINDOWS__ #include "wx/msw/mslu.h" #endif @@ -164,6 +127,10 @@ #include "wx/msw/private.h" #endif +#ifndef MAX_PATH + #define MAX_PATH 512 +#endif + // ============================================================================ // implementation of wxFile // ============================================================================ @@ -172,12 +139,12 @@ // static functions // ---------------------------------------------------------------------------- -bool wxFile::Exists(const wxChar *name) +bool wxFile::Exists(const wxString& name) { return wxFileExists(name); } -bool wxFile::Access(const wxChar *name, OpenMode mode) +bool wxFile::Access(const wxString& name, OpenMode mode) { int how; @@ -200,12 +167,7 @@ bool wxFile::Access(const wxChar *name, OpenMode mode) break; } -#ifdef __WXWINCE__ - // FIXME: use CreateFile with 0 access to query the file - return TRUE; -#else return wxAccess(name, how) == 0; -#endif } // ---------------------------------------------------------------------------- @@ -213,108 +175,52 @@ bool wxFile::Access(const wxChar *name, OpenMode mode) // ---------------------------------------------------------------------------- // ctors -wxFile::wxFile(const wxChar *szFileName, OpenMode mode) +wxFile::wxFile(const wxString& fileName, OpenMode mode) { m_fd = fd_invalid; - m_error = FALSE; + m_lasterror = 0; + + Open(fileName, mode); +} + +bool wxFile::CheckForError(wxFileOffset rc) const +{ + if ( rc != -1 ) + return false; + + const_cast(this)->m_lasterror = +#ifndef __WXWINCE__ + errno +#else + ::GetLastError() +#endif + ; - Open(szFileName, mode); + return true; } // create the file, fail if it already exists and bOverwrite -bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode) +bool wxFile::Create(const wxString& fileName, 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__) && !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( szFileName, + int fildes = wxOpen( fileName, O_BINARY | O_WRONLY | O_CREAT | - (bOverwrite ? O_TRUNC : O_EXCL) - ACCESS(accessMode) ); -#endif -#endif - if ( fd == -1 ) - { - wxLogSysError(_("can't create file '%s'"), szFileName); - return FALSE; - } - else + (bOverwrite ? O_TRUNC : O_EXCL), + accessMode ); + if ( CheckForError(fildes) ) { - Attach(fd); - return TRUE; + wxLogSysError(_("can't create file '%s'"), fileName); + return false; } + + Attach(fildes); + return true; } // open the file -bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode) +bool wxFile::Open(const wxString& fileName, OpenMode mode, int accessMode) { -#ifdef __WXWINCE__ - DWORD access = 0; - DWORD shareMode = 0; - DWORD disposition = 0; - - int flags = O_BINARY; - - 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 ) @@ -324,7 +230,7 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode) break; case write_append: - if ( wxFile::Exists(szFileName) ) + if ( wxFile::Exists(fileName) ) { flags |= O_WRONLY | O_APPEND; break; @@ -345,67 +251,92 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode) break; } - int fd = wxOpen( szFileName, flags ACCESS(accessMode)); -#endif - if ( fd == -1 ) +#ifdef __WINDOWS__ + // only read/write bits for "all" are supported by this function under + // Windows, and VC++ 8 returns EINVAL if any other bits are used in + // accessMode, so clear them as they have at best no effect anyhow + accessMode &= wxS_IRUSR | wxS_IWUSR; +#endif // __WINDOWS__ + + int fildes = wxOpen( fileName, flags, accessMode); + + if ( CheckForError(fildes) ) { - wxLogSysError(_("can't open file '%s'"), szFileName); - return FALSE; - } - else { - Attach(fd); - return TRUE; + wxLogSysError(_("can't open file '%s'"), fileName); + return false; } + + Attach(fildes); + return true; } // close bool wxFile::Close() { if ( IsOpened() ) { -#ifdef __WXWINCE__ - if (!CloseHandle((HANDLE) m_fd)) -#else - if ( close(m_fd) == -1 ) -#endif + if ( CheckForError(wxClose(m_fd)) ) { wxLogSysError(_("can't close file descriptor %d"), m_fd); m_fd = fd_invalid; - return FALSE; + return false; } else m_fd = fd_invalid; } - return TRUE; + return true; } // ---------------------------------------------------------------------------- // read/write // ---------------------------------------------------------------------------- +bool wxFile::ReadAll(wxString *str, const wxMBConv& conv) +{ + wxCHECK_MSG( str, false, wxS("Output string must be non-NULL") ); + + ssize_t length = Length(); + wxCHECK_MSG( (wxFileOffset)length == Length(), false, wxT("huge file not supported") ); + + wxCharBuffer buf(length); + char* p = buf.data(); + for ( ;; ) + { + static const ssize_t READSIZE = 4096; + + ssize_t nread = Read(p, length > READSIZE ? READSIZE : length); + if ( nread == wxInvalidOffset ) + return false; + + p += nread; + if ( length <= nread ) + break; + + length -= nread; + } + + *p = 0; + + wxString strTmp(buf, conv); + str->swap(strTmp); + + return true; +} + // read -off_t wxFile::Read(void *pBuf, off_t nCount) +ssize_t wxFile::Read(void *pBuf, size_t nCount) { wxCHECK( (pBuf != NULL) && IsOpened(), 0 ); -#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); -#endif - if ( iRc == -1 ) { + ssize_t iRc = wxRead(m_fd, pBuf, nCount); + + if ( CheckForError(iRc) ) + { wxLogSysError(_("can't read from file descriptor %d"), m_fd); return wxInvalidOffset; } - else - return (size_t)iRc; + + return iRc; } // write @@ -413,49 +344,49 @@ size_t wxFile::Write(const void *pBuf, size_t nCount) { wxCHECK( (pBuf != NULL) && IsOpened(), 0 ); -#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 - int iRc = ::write(m_fd, (const char*) pBuf, nCount); -#endif -#else - int iRc = ::write(m_fd, pBuf, nCount); -#endif - if ( iRc == -1 ) { + ssize_t iRc = wxWrite(m_fd, pBuf, nCount); + + if ( CheckForError(iRc) ) + { wxLogSysError(_("can't write to file descriptor %d"), m_fd); - m_error = TRUE; - return 0; + iRc = 0; } - else - return iRc; + + return iRc; +} + +bool wxFile::Write(const wxString& s, const wxMBConv& conv) +{ + const wxWX2MBbuf buf = s.mb_str(conv); + if ( !buf ) + return false; + +#if wxUSE_UNICODE + const size_t size = buf.length(); +#else + const size_t size = s.length(); +#endif + + return Write(buf, size) == size; } // flush bool wxFile::Flush() { - if ( IsOpened() ) { -#ifdef __WXWINCE__ - // Do nothing -#elif defined(__VISUALC__) || wxHAVE_FSYNC - if ( wxFsync(m_fd) == -1 ) +#ifdef HAVE_FSYNC + // fsync() only works on disk files and returns errors for pipes, don't + // call it then + if ( IsOpened() && GetKind() == wxFILE_KIND_DISK ) + { + if ( CheckForError(wxFsync(m_fd)) ) { wxLogSysError(_("can't flush file descriptor %d"), m_fd); - return FALSE; + return false; } -#else // no fsync - // just do nothing -#endif // fsync } +#endif // HAVE_FSYNC - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -463,42 +394,17 @@ bool wxFile::Flush() // ---------------------------------------------------------------------------- // seek -off_t wxFile::Seek(off_t ofs, wxSeekMode mode) +wxFileOffset wxFile::Seek(wxFileOffset 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; - } + wxASSERT_MSG( IsOpened(), wxT("can't seek on closed file") ); + wxCHECK_MSG( ofs != wxInvalidOffset || mode != wxFromStart, + wxInvalidOffset, + wxT("invalid absolute file offset") ); - 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: - wxFAIL_MSG(_("unknown seek origin")); + wxFAIL_MSG(wxT("unknown seek origin")); case wxFromStart: origin = SEEK_SET; @@ -513,81 +419,70 @@ off_t wxFile::Seek(off_t ofs, wxSeekMode mode) break; } - int iRc = lseek(m_fd, ofs, origin); - if ( iRc == -1 ) { + wxFileOffset iRc = wxSeek(m_fd, ofs, origin); + if ( CheckForError(iRc) ) + { wxLogSysError(_("can't seek on file descriptor %d"), m_fd); - return wxInvalidOffset; } - else - return (off_t)iRc; -#endif + + return iRc; } -// get current off_t -off_t wxFile::Tell() const +// get current file offset +wxFileOffset wxFile::Tell() const { wxASSERT( IsOpened() ); -#ifdef __WXWINCE__ - DWORD res = SetFilePointer((HANDLE) m_fd, 0, 0, FILE_CURRENT) ; - if (res == 0xFFFFFFFF && GetLastError() != NO_ERROR) + wxFileOffset iRc = wxTell(m_fd); + if ( CheckForError(iRc) ) { 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); - return wxInvalidOffset; } - else - return (off_t)iRc; -#endif + + return iRc; } // get current file length -off_t wxFile::Length() const +wxFileOffset 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; + // we use a special method for Linux systems where files in sysfs (i.e. + // those under /sys typically) return length of 4096 bytes even when + // they're much smaller -- this is a problem as it results in errors later + // when we try reading 4KB from them +#ifdef __LINUX__ + struct stat st; + if ( fstat(m_fd, &st) == 0 ) + { + // returning 0 for the special files indicates to the caller that they + // are not seekable + return st.st_blocks ? st.st_size : 0; + } + //else: failed to stat, try the normal method +#endif // __LINUX__ - // Restore position - SetFilePointer((HANDLE) m_fd, off0, 0, FILE_BEGIN); - return len; -#else -#ifdef __VISUALC__ - int iRc = _filelength(m_fd); -#else // !VC++ - int iRc = wxTell(m_fd); - if ( iRc != -1 ) { - // @ have to use const_cast :-( - int iLen = ((wxFile *)this)->SeekEnd(); - if ( iLen != -1 ) { + wxFileOffset iRc = Tell(); + if ( iRc != wxInvalidOffset ) { + wxFileOffset iLen = const_cast(this)->SeekEnd(); + if ( iLen != wxInvalidOffset ) { // restore old position - if ( ((wxFile *)this)->Seek(iRc) == -1 ) { + if ( ((wxFile *)this)->Seek(iRc) == wxInvalidOffset ) { // error - iLen = -1; + iLen = wxInvalidOffset; } } iRc = iLen; } -#endif // VC++ - if ( iRc == -1 ) { + if ( iRc == wxInvalidOffset ) + { + // last error was already set by Tell() wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd); - return wxInvalidOffset; } - else - return (off_t)iRc; -#endif + + return iRc; } // is end of file reached? @@ -595,48 +490,29 @@ 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; + wxFileOffset iRc; -#if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__) +#if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) // @@ this doesn't work, of course, on unseekable file descriptors - off_t ofsCur = Tell(), + wxFileOffset ofsCur = Tell(), ofsMax = Length(); if ( ofsCur == wxInvalidOffset || ofsMax == wxInvalidOffset ) - iRc = -1; + iRc = wxInvalidOffset; else iRc = ofsCur == ofsMax; #else // Windows and "native" compiler - iRc = eof(m_fd); + iRc = wxEof(m_fd); #endif // Windows/Unix - switch ( iRc ) { - case 1: - break; - - case 0: - return FALSE; - - case -1: - wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd); - break; + if ( iRc == 0 ) + return false; - default: - wxFAIL_MSG(_("invalid eof() return value.")); + if ( iRc == wxInvalidOffset ) + { + wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd); } - return TRUE; -#endif + return true; } // ============================================================================ @@ -674,13 +550,13 @@ bool wxTempFile::Open(const wxString& strName) if ( m_strTemp.empty() ) { // CreateTempFileName() failed - return FALSE; + return false; } #ifdef __UNIX__ // the temp file should have the same permissions as the original one mode_t mode; - + wxStructStat st; if ( stat( (const char*) m_strName.fn_str(), &st) == 0 ) { @@ -703,7 +579,7 @@ bool wxTempFile::Open(const wxString& strName) } #endif // Unix - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -722,22 +598,24 @@ bool wxTempFile::Commit() if ( wxFile::Exists(m_strName) && wxRemove(m_strName) != 0 ) { wxLogSysError(_("can't remove file '%s'"), m_strName.c_str()); - return FALSE; + return false; } if ( !wxRenameFile(m_strTemp, m_strName) ) { wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str()); - return FALSE; + return false; } - return TRUE; + return true; } void wxTempFile::Discard() { m_file.Close(); if ( wxRemove(m_strTemp) != 0 ) + { wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str()); + } } #endif // wxUSE_FILE