X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c801d85f158c4cba50b588807daabdcbd0ed3853..a93e536be025cae6ebdae27c940a72ff59c0a006:/src/common/file.cpp diff --git a/src/common/file.cpp b/src/common/file.cpp index 6c6ae4acc5..b662a72b34 100644 --- a/src/common/file.cpp +++ b/src/common/file.cpp @@ -7,7 +7,7 @@ // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// // ---------------------------------------------------------------------------- @@ -15,74 +15,113 @@ // ---------------------------------------------------------------------------- #ifdef __GNUG__ -#pragma implementation "file.h" + #pragma implementation "file.h" #endif // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" -#include "wx/defs.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif +#if wxUSE_FILE + // standard -#if defined(__WINDOWS__) && !defined(__GNUWIN32__) +#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__) #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 + + #include // for GetTempFileName #elif (defined(__UNIX__) || defined(__GNUWIN32__)) - #include + #include + #ifdef __GNUWIN32__ + #include + #endif +#elif (defined(__WXPM__)) + #include + #define W_OK 2 + #define R_OK 4 +#elif (defined(__WXSTUBS__)) + // Have to ifdef this for different environments + #include +#elif (defined(__WXMAC__)) +#if __MSL__ < 0x6000 + int access( const char *path, int mode ) { return 0 ; } #else - #error "Please specify the header with file functions declarations." + int _access( const char *path, int mode ) { return 0 ; } +#endif + char* mktemp( char * path ) { return path ;} + #include + #define W_OK 2 + #define R_OK 4 + #include +#else + #error "Please specify the header with file functions declarations." #endif //Win/UNIX #include // SEEK_xxx constants #include // O_RDONLY &c -#include // needed for stat -#include // stat - -// Microsoft compiler loves underscores, feed them to it -#ifdef _MSC_VER - // functions - #define open _open - #define close _close - #define read _read - #define write _write - #define lseek _lseek - #define fsync _commit - #define access _access - #define eof _eof - - // types - #define stat _stat - - // constants - #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 - - #define S_IFDIR _S_IFDIR - #define S_IFREG _S_IFREG - - #define S_IREAD _S_IREAD - #define S_IWRITE _S_IWRITE -#else - #define tell(fd) lseek(fd, 0, SEEK_CUR) -#endif //_MSC_VER -// there is no distinction between text and binary files under Unix -#ifdef __UNIX__ - #define O_BINARY (0) -#endif //__UNIX__ +#ifndef __MWERKS__ + #include // needed for stat + #include // stat +#endif -// wxWindows -#include -#include -#include -#include +#if defined(__BORLANDC__) || defined(_MSC_VER) + #define W_OK 2 + #define R_OK 4 +#endif +// 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 + +// wxWindows +#include "wx/string.h" +#include "wx/intl.h" +#include "wx/file.h" +#include "wx/log.h" // ============================================================================ // implementation of wxFile @@ -91,10 +130,41 @@ // ---------------------------------------------------------------------------- // static functions // ---------------------------------------------------------------------------- -bool wxFile::Exists(const char *sz) -{ - struct stat st; - return !access(sz, 0) && !stat(sz, &st) && (st.st_mode & S_IFREG); +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 +} + +bool wxFile::Access(const wxChar *name, OpenMode mode) +{ + int how = 0; + + switch ( mode ) { + case read: + how = R_OK; + break; + + case write: + how = W_OK; + break; + + default: + wxFAIL_MSG(wxT("bad wxFile::Access mode parameter.")); + } + + return wxAccess(wxFNCONV(name), how) == 0; } // ---------------------------------------------------------------------------- @@ -102,77 +172,92 @@ bool wxFile::Exists(const char *sz) // ---------------------------------------------------------------------------- // ctors -wxFile::wxFile(const char *szFileName, OpenMode mode) +wxFile::wxFile(const wxChar *szFileName, OpenMode mode) { - m_fd = fd_invalid; - - Open(szFileName, mode); -} + m_fd = fd_invalid; + m_error = FALSE; -// dtor -wxFile::~wxFile() -{ - Close(); + Open(szFileName, mode); } // create the file, fail if it already exists and bOverwrite -bool wxFile::Create(const char *szFileName, bool bOverwrite) +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 - int fd = bOverwrite ? creat(szFileName, 0) - : open(szFileName, O_CREAT | O_EXCL); - - if ( fd == -1 ) { - wxLogSysError("can't create file '%s'", szFileName); - return FALSE; - } - else { - Attach(fd); - return TRUE; - } + // 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); +#else + int fd = wxOpen(wxFNCONV(szFileName), + O_BINARY | O_WRONLY | O_CREAT | + (bOverwrite ? O_TRUNC : O_EXCL) + ACCESS(accessMode)); +#endif + if ( fd == -1 ) { + wxLogSysError(_("can't create file '%s'"), szFileName); + return FALSE; + } + else { + Attach(fd); + return TRUE; + } } // open the file -bool wxFile::Open(const char *szFileName, OpenMode mode) +bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode) { - int flags = O_BINARY; - - switch ( mode ) { - case read: - flags |= O_RDONLY; - break; - - case write: - flags |= O_WRONLY | O_CREAT; - break; - - case read_write: - flags |= O_RDWR; - break; - } - - int fd = open(szFileName, flags, S_IREAD | S_IWRITE); - - if ( fd == -1 ) { - wxLogSysError("can't open file '%s'", szFileName); - return FALSE; - } - else { - Attach(fd); - return TRUE; - } + int flags = O_BINARY; + + switch ( mode ) { + case read: + flags |= O_RDONLY; + break; + + case write_append: + if ( wxFile::Exists(szFileName) ) + { + flags |= O_WRONLY | O_APPEND; + break; + } + //else: fall through as write_append is the same as write if the + // file doesn't exist + + case write: + flags |= O_WRONLY | O_CREAT | O_TRUNC; + break; + + case read_write: + flags |= O_RDWR; + break; + } + + int fd = wxOpen(wxFNCONV(szFileName), flags ACCESS(accessMode)); + if ( fd == -1 ) { + wxLogSysError(_("can't open file '%s'"), szFileName); + return FALSE; + } + else { + Attach(fd); + return TRUE; + } } // close -void wxFile::Close() +bool wxFile::Close() { - if ( IsOpened() ) { - if ( close(m_fd) == -1 ) - wxLogSysError("can't close file descriptor %d", m_fd); + if ( IsOpened() ) { + if ( close(m_fd) == -1 ) { + wxLogSysError(_("can't close file descriptor %d"), m_fd); + m_fd = fd_invalid; + return FALSE; + } + else + m_fd = fd_invalid; + } - m_fd = fd_invalid; - } + return TRUE; } // ---------------------------------------------------------------------------- @@ -182,44 +267,60 @@ void wxFile::Close() // read off_t wxFile::Read(void *pBuf, off_t nCount) { - wxCHECK_RET( (pBuf != NULL) && IsOpened(), 0 ); - - int iRc = ::read(m_fd, pBuf, nCount); - if ( iRc == -1 ) { - wxLogSysError("can't read from file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (uint)iRc; + wxCHECK( (pBuf != NULL) && IsOpened(), 0 ); + +#ifdef __MWERKS__ + int iRc = ::read(m_fd, (char*) pBuf, nCount); +#else + int iRc = ::read(m_fd, pBuf, nCount); +#endif + if ( iRc == -1 ) { + wxLogSysError(_("can't read from file descriptor %d"), m_fd); + return wxInvalidOffset; + } + else + return (size_t)iRc; } // write -bool wxFile::Write(const void *pBuf, uint nCount) +size_t wxFile::Write(const void *pBuf, size_t nCount) { - wxCHECK_RET( (pBuf != NULL) && IsOpened(), 0 ); - - int iRc = ::write(m_fd, pBuf, nCount); - if ( iRc == -1 ) { - wxLogSysError("can't write to file descriptor %d", m_fd); - return FALSE; - } - else - return TRUE; + wxCHECK( (pBuf != NULL) && IsOpened(), 0 ); + +#ifdef __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 ) { + wxLogSysError(_("can't write to file descriptor %d"), m_fd); + m_error = TRUE; + return 0; + } + else + return iRc; } // flush bool wxFile::Flush() { - if ( IsOpened() ) { - // ## fsync() is not ANSI (BSDish) -// if ( fsync(m_fd) == -1 ) { // TODO - if (TRUE) { - wxLogSysError("can't flush file descriptor %d", m_fd); - return FALSE; + if ( IsOpened() ) { +#if defined(__VISUALC__) || wxHAVE_FSYNC + if ( wxFsync(m_fd) == -1 ) + { + wxLogSysError(_("can't flush file descriptor %d"), m_fd); + return FALSE; + } +#else // no fsync + // just do nothing +#endif // fsync } - } - return TRUE; + return TRUE; } // ---------------------------------------------------------------------------- @@ -227,122 +328,118 @@ bool wxFile::Flush() // ---------------------------------------------------------------------------- // seek -off_t wxFile::Seek(off_t ofs, SeekMode mode) +off_t wxFile::Seek(off_t ofs, wxSeekMode mode) { - wxASSERT( IsOpened() ); - - int flag = -1; - switch ( mode ) { - case FromStart: - flag = SEEK_SET; - break; - - case FromCurrent: - flag = SEEK_CUR; - break; - - case FromEnd: - flag = SEEK_END; - break; - - default: - wxFAIL_MSG("unknown seek origin"); - } - - int iRc = lseek(m_fd, ofs, flag); - if ( iRc == -1 ) { - wxLogSysError("can't seek on file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (off_t)iRc; + wxASSERT( IsOpened() ); + + int origin; + switch ( mode ) { + default: + wxFAIL_MSG(_("unknown seek origin")); + + case wxFromStart: + origin = SEEK_SET; + break; + + case wxFromCurrent: + origin = SEEK_CUR; + break; + + case wxFromEnd: + origin = SEEK_END; + break; + } + + int iRc = lseek(m_fd, ofs, origin); + if ( iRc == -1 ) { + wxLogSysError(_("can't seek on file descriptor %d"), m_fd); + return wxInvalidOffset; + } + else + return (off_t)iRc; } // get current off_t off_t wxFile::Tell() const { - wxASSERT( IsOpened() ); - - int iRc = tell(m_fd); - if ( iRc == -1 ) { - wxLogSysError("can't get seek position on file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (off_t)iRc; + wxASSERT( IsOpened() ); + + 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; } // get current file length off_t wxFile::Length() const { - wxASSERT( IsOpened() ); + wxASSERT( IsOpened() ); - #ifdef _MSC_VER +#ifdef __VISUALC__ int iRc = _filelength(m_fd); - #else - int iRc = tell(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 ) { - // restore old position - if ( ((wxFile *)this)->Seek(iRc) == -1 ) { - // error - iLen = -1; + // @ have to use const_cast :-( + int iLen = ((wxFile *)this)->SeekEnd(); + if ( iLen != -1 ) { + // restore old position + if ( ((wxFile *)this)->Seek(iRc) == -1 ) { + // error + iLen = -1; + } } - } - iRc = iLen; + iRc = iLen; } +#endif // VC++ - #endif //_MSC_VER - - if ( iRc == -1 ) { - wxLogSysError("can't find length of file on file descriptor %d", m_fd); - return ofsInvalid; - } - else - return (off_t)iRc; + if ( iRc == -1 ) { + wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd); + return wxInvalidOffset; + } + else + return (off_t)iRc; } // is end of file reached? bool wxFile::Eof() const { - wxASSERT( IsOpened() ); - - // TODO: no eof in GnuWin32 - -#ifdef __LINUX__ - - int iRc = Tell() == Length(); - -#else - -#if defined(__GNUWIN32__) - int iRc = -1; -#else - int iRc = eof(m_fd); -#endif - -#endif - - 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; - - default: - wxFAIL_MSG("invalid eof() return value."); - } + wxASSERT( IsOpened() ); + + int iRc; + +#if defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__) + // @@ this doesn't work, of course, on unseekable file descriptors + off_t ofsCur = Tell(), + ofsMax = Length(); + if ( ofsCur == wxInvalidOffset || ofsMax == wxInvalidOffset ) + iRc = -1; + else + iRc = ofsCur == ofsMax; +#else // Windows and "native" compiler + iRc = eof(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; + + default: + wxFAIL_MSG(_("invalid eof() return value.")); + } - return TRUE; + return TRUE; } // ============================================================================ @@ -354,14 +451,83 @@ bool wxFile::Eof() const // ---------------------------------------------------------------------------- wxTempFile::wxTempFile(const wxString& strName) { - Open(strName); + Open(strName); } bool wxTempFile::Open(const wxString& strName) { - m_strName = strName; - m_strTemp = tmpnam(NULL); - return m_file.Open(m_strTemp, wxFile::write); + 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; + ::DosCreateDir(m_strTemp.GetWriteBuf(MAX_PATH), NULL); +#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 + + 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; + + wxStructStat st; + if ( stat(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; + } + else + { + // file probably didn't exist, just create with default mode _using_ + // user's umask (new files creation should respet umask) + changedUmask = FALSE; + } +#endif // Unix + + bool ok = m_file.Open(m_strTemp, wxFile::write, access); + +#ifdef __UNIX__ + if ( changedUmask ) + { + // restore umask now that the file is created + (void)umask(umaskOld); + } +#endif // Unix + + return ok; } // ---------------------------------------------------------------------------- @@ -370,30 +536,33 @@ bool wxTempFile::Open(const wxString& strName) wxTempFile::~wxTempFile() { - if ( IsOpened() ) - Discard(); + if ( IsOpened() ) + Discard(); } bool wxTempFile::Commit() { - m_file.Close(); + m_file.Close(); - if ( wxFile::Exists(m_strName) && remove(m_strName) != 0 ) { - wxLogSysError("can't remove file '%s'", m_strName.c_str()); - return FALSE; - } + if ( wxFile::Exists(m_strName) && wxRemove(m_strName) != 0 ) { + wxLogSysError(_("can't remove file '%s'"), m_strName.c_str()); + return FALSE; + } - if ( rename(m_strTemp, m_strName) != 0 ) { - wxLogSysError("can't commit changes to file '%s'", m_strName.c_str()); - return FALSE; - } + if ( wxRename(m_strTemp, m_strName) != 0 ) { + wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str()); + return FALSE; + } - return TRUE; + return TRUE; } void wxTempFile::Discard() { - m_file.Close(); - if ( remove(m_strTemp) != 0 ) - wxLogSysError("can't remove temporary file '%s'", m_strTemp.c_str()); + m_file.Close(); + if ( wxRemove(m_strTemp) != 0 ) + wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str()); } + +#endif +