/////////////////////////////////////////////////////////////////////////////
-// Name: file.cpp
+// Name: src/common/file.cpp
// Purpose: wxFile - encapsulates low-level "file descriptor"
// wxTempFile
// Author: Vadim Zeitlin
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "file.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#if wxUSE_FILE
// standard
-#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__)
- #include <io.h>
-
-#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
-
+#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 <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>
+ #include <unistd.h>
#else
#error "Please specify the header with file functions declarations."
#endif //Win/UNIX
#include <stdio.h> // SEEK_xxx constants
-#include <fcntl.h> // O_RDONLY &c
-
-#ifndef __MWERKS__
- #include <sys/types.h> // needed for stat
- #include <sys/stat.h> // stat
-#elif ( defined(__MWERKS__) && defined(__WXMSW__) )
- #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
+#ifndef __WXWINCE__
+ #include <errno.h>
#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
+
+// 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"
+
// 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 <unix.h>
+#ifdef __WINDOWS__
+ #include "wx/msw/mslu.h"
+#endif
+
+#ifdef __WXWINCE__
+ #include "wx/msw/private.h"
#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
-#ifndef WX_PRECOMP
- #include "wx/string.h"
- #include "wx/intl.h"
- #include "wx/file.h"
- #include "wx/log.h"
-#endif // !WX_PRECOMP
-
-#include "wx/filename.h"
-#include "wx/file.h"
-
// ============================================================================
// 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
+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 = 0;
+ int how;
+
+ switch ( mode )
+ {
+ default:
+ wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));
+ // fall through
- switch ( mode ) {
case read:
how = R_OK;
break;
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;
+ return wxAccess(name, how) == 0;
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// 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(szFileName, mode);
+ Open(fileName, mode);
+}
+
+bool wxFile::CheckForError(wxFileOffset rc) const
+{
+ if ( rc != -1 )
+ return false;
+
+ const_cast<wxFile *>(this)->m_lasterror =
+#ifndef __WXWINCE__
+ errno
+#else
+ ::GetLastError()
+#endif
+ ;
+
+ 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__)
- // 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;
+ int fildes = wxOpen( fileName,
+ O_BINARY | O_WRONLY | O_CREAT |
+ (bOverwrite ? O_TRUNC : O_EXCL),
+ accessMode );
+ if ( CheckForError(fildes) )
+ {
+ 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)
{
int flags = O_BINARY;
- switch ( mode ) {
+ switch ( mode )
+ {
case read:
flags |= O_RDONLY;
break;
case write_append:
- if ( wxFile::Exists(szFileName) )
+ if ( wxFile::Exists(fileName) )
{
flags |= O_WRONLY | O_APPEND;
break;
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;
+#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'"), fileName);
+ return false;
}
+
+ Attach(fildes);
+ return true;
}
// close
bool wxFile::Close()
{
if ( IsOpened() ) {
- if ( close(m_fd) == -1 ) {
+ 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 __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
{
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 ) {
+ 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() ) {
-#if 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;
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// seek
-off_t wxFile::Seek(off_t ofs, wxSeekMode mode)
+wxFileOffset wxFile::Seek(wxFileOffset ofs, wxSeekMode mode)
{
- wxASSERT( IsOpened() );
+ wxASSERT_MSG( IsOpened(), wxT("can't seek on closed file") );
+ wxCHECK_MSG( ofs != wxInvalidOffset || mode != wxFromStart,
+ wxInvalidOffset,
+ wxT("invalid absolute file offset") );
int origin;
switch ( mode ) {
default:
- wxFAIL_MSG(_("unknown seek origin"));
+ wxFAIL_MSG(wxT("unknown seek origin"));
case wxFromStart:
origin = SEEK_SET;
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;
+
+ return iRc;
}
-// get current off_t
-off_t wxFile::Tell() const
+// get current file offset
+wxFileOffset wxFile::Tell() const
{
wxASSERT( IsOpened() );
- int iRc = wxTell(m_fd);
- if ( iRc == -1 ) {
+ 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)iRc;
+
+ return iRc;
}
// get current file length
-off_t wxFile::Length() const
+wxFileOffset wxFile::Length() const
{
wxASSERT( IsOpened() );
-#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 ) {
+ // 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__
+
+ wxFileOffset iRc = Tell();
+ if ( iRc != wxInvalidOffset ) {
+ wxFileOffset iLen = const_cast<wxFile *>(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;
+
+ return iRc;
}
// is end of file reached?
{
wxASSERT( IsOpened() );
- int iRc;
+ wxFileOffset iRc;
-#if 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;
+ return true;
}
// ============================================================================
// ----------------------------------------------------------------------------
// construction
// ----------------------------------------------------------------------------
+
wxTempFile::wxTempFile(const wxString& strName)
{
Open(strName);
bool wxTempFile::Open(const wxString& strName)
{
- m_strName = strName;
+ // 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);
+ }
- m_strTemp = wxFileName::CreateTempFileName(strName);
+ m_strName = fn.GetFullPath();
+
+ m_strTemp = wxFileName::CreateTempFileName(m_strName, &m_file);
if ( m_strTemp.empty() )
{
// CreateTempFileName() failed
- return FALSE;
+ return false;
}
#ifdef __UNIX__
mode_t mode;
wxStructStat st;
- if ( stat(strName.fn_str(), &st) == 0 )
+ if ( stat( (const char*) m_strName.fn_str(), &st) == 0 )
{
mode = st.st_mode;
}
umask(mask);
}
- if ( chmod(m_strTemp.mb_str(), mode) == -1 )
+ if ( chmod( (const char*) m_strTemp.fn_str(), mode) == -1 )
{
+#ifndef __OS2__
wxLogSysError(_("Failed to set temporary file permissions"));
+#endif
}
#endif // Unix
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
if ( wxFile::Exists(m_strName) && wxRemove(m_strName) != 0 ) {
wxLogSysError(_("can't remove file '%s'"), m_strName.c_str());
- return FALSE;
+ 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;
+ 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
projects / wxWidgets.git / blobdiff