1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxFile - encapsulates low-level "file descriptor"
5 // Author: Vadim Zeitlin
9 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
13 // ----------------------------------------------------------------------------
15 // ----------------------------------------------------------------------------
18 #pragma implementation "file.h"
21 // For compilers that support precompilation, includes "wx.h".
22 #include "wx/wxprec.h"
31 #if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXWINE__)
35 #define WIN32_LEAN_AND_MEAN
57 #include <windows.h> // for GetTempFileName
58 #elif (defined(__UNIX__) || defined(__GNUWIN32__))
63 #elif (defined(__WXPM__))
68 #elif (defined(__WXSTUBS__))
69 // Have to ifdef this for different environments
71 #elif (defined(__WXMAC__))
72 int access( const char *path
, int mode
) { return 0 ; }
73 char* mktemp( char * path
) { return path
;}
79 #error "Please specify the header with file functions declarations."
82 #include <stdio.h> // SEEK_xxx constants
83 #include <fcntl.h> // O_RDONLY &c
86 #include <sys/types.h> // needed for stat
87 #include <sys/stat.h> // stat
90 // Microsoft compiler loves underscores, feed them to it
99 #define access _access
107 #define O_RDONLY _O_RDONLY
108 #define O_WRONLY _O_WRONLY
109 #define O_RDWR _O_RDWR
110 #define O_EXCL _O_EXCL
111 #define O_CREAT _O_CREAT
112 #define O_BINARY _O_BINARY
114 #define S_IFDIR _S_IFDIR
115 #define S_IFREG _S_IFREG
117 #define tell(fd) lseek(fd, 0, SEEK_CUR)
120 #if defined(__BORLANDC__) || defined(_MSC_VER)
125 // there is no distinction between text and binary files under Unix, so define
126 // O_BINARY as 0 if the system headers don't do it already
127 #if defined(__UNIX__) && !defined(O_BINARY)
136 #include "wx/string.h"
145 // some broken compilers don't have 3rd argument in open() and creat()
147 #define ACCESS(access)
149 #else // normal compiler
150 #define ACCESS(access) , (access)
153 // ============================================================================
154 // implementation of wxFile
155 // ============================================================================
157 // ----------------------------------------------------------------------------
159 // ----------------------------------------------------------------------------
160 bool wxFile::Exists(const wxChar
*name
)
163 #if wxUSE_UNICODE && wxMBFILES
164 wxCharBuffer fname
= wxConvFile
.cWC2MB(name
);
167 return !access(wxUnix2MacFilename( name
) , 0) && !stat(wxUnix2MacFilename( name
), &st
) && (st
.st_mode
& S_IFREG
);
169 return !access(fname
, 0) &&
170 !stat(wxMBSTRINGCAST fname
, &st
) &&
171 (st
.st_mode
& S_IFREG
);
175 return !access(wxUnix2MacFilename( name
) , 0) && !stat(wxUnix2MacFilename( name
), &st
) && (st
.st_mode
& S_IFREG
);
177 return !access(name
, 0) &&
178 !stat((wxChar
*) name
, &st
) &&
179 (st
.st_mode
& S_IFREG
);
184 bool wxFile::Access(const wxChar
*name
, OpenMode mode
)
198 wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));
201 return access(wxFNCONV(name
), how
) == 0;
204 // ----------------------------------------------------------------------------
206 // ----------------------------------------------------------------------------
209 wxFile::wxFile(const wxChar
*szFileName
, OpenMode mode
)
214 Open(szFileName
, mode
);
217 // create the file, fail if it already exists and bOverwrite
218 bool wxFile::Create(const wxChar
*szFileName
, bool bOverwrite
, int accessMode
)
220 // if bOverwrite we create a new file or truncate the existing one,
221 // otherwise we only create the new file and fail if it already exists
223 int fd
= open(wxUnix2MacFilename( szFileName
), O_CREAT
| (bOverwrite
? O_TRUNC
: O_EXCL
), access
);
225 int fd
= open(wxFNCONV(szFileName
),
226 O_BINARY
| O_WRONLY
| O_CREAT
|
227 (bOverwrite
? O_TRUNC
: O_EXCL
)
231 wxLogSysError(_("can't create file '%s'"), szFileName
);
241 bool wxFile::Open(const wxChar
*szFileName
, OpenMode mode
, int accessMode
)
243 int flags
= O_BINARY
;
251 flags
|= O_WRONLY
| O_CREAT
| O_TRUNC
;
255 flags
|= O_WRONLY
| O_APPEND
;
264 int fd
= open(wxUnix2MacFilename( szFileName
), flags
, access
);
266 int fd
= open(wxFNCONV(szFileName
), flags
ACCESS(accessMode
));
269 wxLogSysError(_("can't open file '%s'"), szFileName
);
282 if ( close(m_fd
) == -1 ) {
283 wxLogSysError(_("can't close file descriptor %d"), m_fd
);
294 // ----------------------------------------------------------------------------
296 // ----------------------------------------------------------------------------
299 off_t
wxFile::Read(void *pBuf
, off_t nCount
)
301 wxCHECK( (pBuf
!= NULL
) && IsOpened(), 0 );
304 int iRc
= ::read(m_fd
, (char*) pBuf
, nCount
);
306 int iRc
= ::read(m_fd
, pBuf
, nCount
);
309 wxLogSysError(_("can't read from file descriptor %d"), m_fd
);
310 return wxInvalidOffset
;
317 size_t wxFile::Write(const void *pBuf
, size_t nCount
)
319 wxCHECK( (pBuf
!= NULL
) && IsOpened(), 0 );
322 int iRc
= ::write(m_fd
, (const char*) pBuf
, nCount
);
324 int iRc
= ::write(m_fd
, pBuf
, nCount
);
327 wxLogSysError(_("can't write to file descriptor %d"), m_fd
);
339 #if defined(__VISUALC__) || wxHAVE_FSYNC
340 if ( fsync(m_fd
) == -1 )
342 wxLogSysError(_("can't flush file descriptor %d"), m_fd
);
353 // ----------------------------------------------------------------------------
355 // ----------------------------------------------------------------------------
358 off_t
wxFile::Seek(off_t ofs
, wxSeekMode mode
)
360 wxASSERT( IsOpened() );
365 wxFAIL_MSG(_("unknown seek origin"));
380 int iRc
= lseek(m_fd
, ofs
, origin
);
382 wxLogSysError(_("can't seek on file descriptor %d"), m_fd
);
383 return wxInvalidOffset
;
390 off_t
wxFile::Tell() const
392 wxASSERT( IsOpened() );
394 int iRc
= tell(m_fd
);
396 wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd
);
397 return wxInvalidOffset
;
403 // get current file length
404 off_t
wxFile::Length() const
406 wxASSERT( IsOpened() );
409 int iRc
= _filelength(m_fd
);
411 int iRc
= tell(m_fd
);
413 // @ have to use const_cast :-(
414 int iLen
= ((wxFile
*)this)->SeekEnd();
416 // restore old position
417 if ( ((wxFile
*)this)->Seek(iRc
) == -1 ) {
428 wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd
);
429 return wxInvalidOffset
;
435 // is end of file reached?
436 bool wxFile::Eof() const
438 wxASSERT( IsOpened() );
442 #if defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__)
443 // @@ this doesn't work, of course, on unseekable file descriptors
444 off_t ofsCur
= Tell(),
446 if ( ofsCur
== wxInvalidOffset
|| ofsMax
== wxInvalidOffset
)
449 iRc
= ofsCur
== ofsMax
;
450 #else // Windows and "native" compiler
452 #endif // Windows/Unix
462 wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd
);
466 wxFAIL_MSG(_("invalid eof() return value."));
472 // ============================================================================
473 // implementation of wxTempFile
474 // ============================================================================
476 // ----------------------------------------------------------------------------
478 // ----------------------------------------------------------------------------
479 wxTempFile::wxTempFile(const wxString
& strName
)
484 bool wxTempFile::Open(const wxString
& strName
)
488 // we want to create the file in the same directory as strName because
489 // otherwise rename() in Commit() might not work (if the files are on
490 // different partitions for example). Unfortunately, the only standard
491 // (POSIX) temp file creation function tmpnam() can't do it.
492 #if defined(__UNIX__) || defined(__WXSTUBS__)|| defined( __WXMAC__ )
493 static const wxChar
*szMktempSuffix
= wxT("XXXXXX");
494 m_strTemp
<< strName
<< szMktempSuffix
;
495 // can use the cast because length doesn't change
496 mktemp(wxMBSTRINGCAST m_strTemp
.mb_str());
497 #elif defined(__WXPM__)
498 // for now just create a file
499 // future enhancements can be to set some extended attributes for file systems
500 // OS/2 supports that have them (HPFS, FAT32) and security (HPFS386)
501 static const wxChar
*szMktempSuffix
= wxT("XXX");
502 m_strTemp
<< strName
<< szMktempSuffix
;
503 mkdir(m_strTemp
.GetWriteBuf(MAX_PATH
));
506 wxSplitPath(strName
, &strPath
, NULL
, NULL
);
507 if ( strPath
.IsEmpty() )
508 strPath
= wxT('.'); // GetTempFileName will fail if we give it empty string
510 if ( !GetTempFileName(strPath
, wxT("wx_"),0, m_strTemp
.GetWriteBuf(MAX_PATH
)) )
512 // Not sure why MSVC++ 1.5 header defines first param as BYTE - bug?
513 if ( !GetTempFileName((BYTE
) (DWORD
)(const wxChar
*) strPath
, wxT("wx_"),0, m_strTemp
.GetWriteBuf(MAX_PATH
)) )
515 wxLogLastError(wxT("GetTempFileName"));
516 m_strTemp
.UngetWriteBuf();
517 #endif // Windows/Unix
519 int access
= wxS_DEFAULT
;
521 // create the file with the same mode as the original one under Unix
522 mode_t umaskOld
= 0; // just to suppress compiler warning
526 if ( stat(strName
.fn_str(), &st
) == 0 )
528 // this assumes that only lower bits of st_mode contain the access
529 // rights, but it's true for at least all Unices which have S_IXXXX()
530 // macros, so should not be less portable than using (not POSIX)
532 access
= st
.st_mode
& 0777;
534 // we want to create the file with exactly the same access rights as
535 // the original one, so disable the user's umask for the moment
541 // file probably didn't exist, just create with default mode _using_
542 // user's umask (new files creation should respet umask)
543 changedUmask
= FALSE
;
547 bool ok
= m_file
.Open(m_strTemp
, wxFile::write
, access
);
552 // restore umask now that the file is created
553 (void)umask(umaskOld
);
560 // ----------------------------------------------------------------------------
562 // ----------------------------------------------------------------------------
564 wxTempFile::~wxTempFile()
570 bool wxTempFile::Commit()
575 if ( wxFile::Exists(m_strName
) && remove(m_strName
.fn_str()) != 0 ) {
576 wxLogSysError(_("can't remove file '%s'"), m_strName
.c_str());
580 if ( rename(m_strTemp
.fn_str(), m_strName
.fn_str()) != 0 ) {
581 wxLogSysError(_("can't commit changes to file '%s'"), m_strName
.c_str());
585 if ( wxFile::Exists(m_strName
) && remove(wxUnix2MacFilename( m_strName
)) != 0 ) {
586 wxLogSysError(_("can't remove file '%s'"), m_strName
.c_str());
590 if ( rename(wxUnix2MacFilename( m_strTemp
), wxUnix2MacFilename( m_strName
)) != 0 ) {
591 wxLogSysError(_("can't commit changes to file '%s'"), m_strName
.c_str());
599 void wxTempFile::Discard()
603 if ( remove(m_strTemp
.fn_str()) != 0 )
604 wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp
.c_str());
606 if ( remove( wxUnix2MacFilename(m_strTemp
.fn_str())) != 0 )
607 wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp
.c_str());