1998-05-20 10:01:55 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
1999-07-14 18:55:57 -04:00
|
|
|
// Name: file.h
|
1998-05-20 10:01:55 -04:00
|
|
|
// Purpose: wxFile - encapsulates low-level "file descriptor"
|
|
|
|
// wxTempFile - safely replace the old file
|
|
|
|
// Author: Vadim Zeitlin
|
|
|
|
// Modified by:
|
|
|
|
// Created: 29/01/98
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
1998-05-20 10:01:55 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
#ifndef _WX_FILEH__
|
|
|
|
#define _WX_FILEH__
|
1998-05-20 10:01:55 -04:00
|
|
|
|
2005-03-16 11:18:31 -05:00
|
|
|
#include "wx/defs.h"
|
|
|
|
|
|
|
|
#if wxUSE_FILE
|
|
|
|
|
2004-05-30 12:34:49 -04:00
|
|
|
#include "wx/string.h"
|
|
|
|
#include "wx/filefn.h"
|
|
|
|
#include "wx/strconv.h"
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// constants
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
1998-07-24 13:03:26 -04:00
|
|
|
// we redefine these constants here because S_IREAD &c are _not_ standard
|
|
|
|
// however, we do assume that the values correspond to the Unix umask bits
|
2008-09-27 06:28:43 -04:00
|
|
|
enum wxPosixPermissions
|
|
|
|
{
|
|
|
|
// standard Posix names for these permission flags:
|
|
|
|
wxS_IRUSR = 00400,
|
|
|
|
wxS_IWUSR = 00200,
|
|
|
|
wxS_IXUSR = 00100,
|
|
|
|
|
|
|
|
wxS_IRGRP = 00040,
|
|
|
|
wxS_IWGRP = 00020,
|
|
|
|
wxS_IXGRP = 00010,
|
|
|
|
|
|
|
|
wxS_IROTH = 00004,
|
|
|
|
wxS_IWOTH = 00002,
|
|
|
|
wxS_IXOTH = 00001,
|
|
|
|
|
2009-11-05 09:59:30 -05:00
|
|
|
// longer but more readable synonyms for the constants above:
|
2008-09-27 06:28:43 -04:00
|
|
|
wxPOSIX_USER_READ = wxS_IRUSR,
|
|
|
|
wxPOSIX_USER_WRITE = wxS_IWUSR,
|
|
|
|
wxPOSIX_USER_EXECUTE = wxS_IXUSR,
|
|
|
|
|
|
|
|
wxPOSIX_GROUP_READ = wxS_IRGRP,
|
|
|
|
wxPOSIX_GROUP_WRITE = wxS_IWGRP,
|
|
|
|
wxPOSIX_GROUP_EXECUTE = wxS_IXGRP,
|
|
|
|
|
|
|
|
wxPOSIX_OTHERS_READ = wxS_IROTH,
|
|
|
|
wxPOSIX_OTHERS_WRITE = wxS_IWOTH,
|
|
|
|
wxPOSIX_OTHERS_EXECUTE = wxS_IXOTH,
|
|
|
|
|
|
|
|
// default mode for the new files: allow reading/writing them to everybody but
|
|
|
|
// the effective file mode will be set after anding this value with umask and
|
|
|
|
// so won't include wxS_IW{GRP,OTH} for the default 022 umask value
|
|
|
|
wxS_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | \
|
|
|
|
wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | \
|
|
|
|
wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE),
|
|
|
|
|
|
|
|
// default mode for the new directories (see wxFileName::Mkdir): allow
|
|
|
|
// reading/writing/executing them to everybody, but just like wxS_DEFAULT
|
|
|
|
// the effective directory mode will be set after anding this value with umask
|
|
|
|
wxS_DIR_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | wxPOSIX_USER_EXECUTE | \
|
|
|
|
wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | wxPOSIX_GROUP_EXECUTE | \
|
|
|
|
wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE | wxPOSIX_OTHERS_EXECUTE)
|
|
|
|
};
|
1998-07-24 13:03:26 -04:00
|
|
|
|
1998-05-20 10:01:55 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// class wxFile: raw file IO
|
|
|
|
//
|
|
|
|
// NB: for space efficiency this class has no virtual functions, including
|
|
|
|
// dtor which is _not_ virtual, so it shouldn't be used as a base class.
|
|
|
|
// ----------------------------------------------------------------------------
|
2003-07-01 21:41:23 -04:00
|
|
|
|
2003-07-01 21:59:24 -04:00
|
|
|
class WXDLLIMPEXP_BASE wxFile
|
1998-05-20 10:01:55 -04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
// more file constants
|
|
|
|
// -------------------
|
|
|
|
// opening mode
|
2001-12-01 08:51:24 -05:00
|
|
|
enum OpenMode { read, write, read_write, write_append, write_excl };
|
1998-05-20 10:01:55 -04:00
|
|
|
// standard values for file descriptor
|
|
|
|
enum { fd_invalid = -1, fd_stdin, fd_stdout, fd_stderr };
|
|
|
|
|
|
|
|
// static functions
|
|
|
|
// ----------------
|
1998-08-11 17:03:57 -04:00
|
|
|
// check whether a regular file by this name exists
|
2007-05-04 15:04:19 -04:00
|
|
|
static bool Exists(const wxString& name);
|
2004-07-04 07:19:47 -04:00
|
|
|
// check whether we can access the given file in given mode
|
1998-08-11 17:03:57 -04:00
|
|
|
// (only read and write make sense here)
|
2007-05-04 15:04:19 -04:00
|
|
|
static bool Access(const wxString& name, OpenMode mode);
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// ctors
|
|
|
|
// -----
|
|
|
|
// def ctor
|
2003-12-11 05:59:05 -05:00
|
|
|
wxFile() { m_fd = fd_invalid; m_error = false; }
|
1998-05-20 10:01:55 -04:00
|
|
|
// open specified file (may fail, use IsOpened())
|
2007-04-05 17:28:14 -04:00
|
|
|
wxFile(const wxString& fileName, OpenMode mode = read);
|
1998-05-20 10:01:55 -04:00
|
|
|
// attach to (already opened) file
|
2005-06-08 11:17:42 -04:00
|
|
|
wxFile(int lfd) { m_fd = lfd; m_error = false; }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// open/close
|
1998-07-24 13:03:26 -04:00
|
|
|
// create a new file (with the default value of bOverwrite, it will fail if
|
|
|
|
// the file already exists, otherwise it will overwrite it and succeed)
|
2007-05-04 15:04:19 -04:00
|
|
|
bool Create(const wxString& fileName, bool bOverwrite = false,
|
1998-07-24 13:03:26 -04:00
|
|
|
int access = wxS_DEFAULT);
|
2007-05-04 15:04:19 -04:00
|
|
|
bool Open(const wxString& fileName, OpenMode mode = read,
|
1998-07-24 13:03:26 -04:00
|
|
|
int access = wxS_DEFAULT);
|
1998-07-17 16:52:40 -04:00
|
|
|
bool Close(); // Close is a NOP if not opened
|
1998-05-26 11:05:56 -04:00
|
|
|
|
|
|
|
// assign an existing file descriptor and get it back from wxFile object
|
2005-06-08 11:17:42 -04:00
|
|
|
void Attach(int lfd) { Close(); m_fd = lfd; m_error = false; }
|
1998-05-26 11:05:56 -04:00
|
|
|
void Detach() { m_fd = fd_invalid; }
|
|
|
|
int fd() const { return m_fd; }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// read/write (unbuffered)
|
2004-11-11 22:30:07 -05:00
|
|
|
// returns number of bytes read or wxInvalidOffset on error
|
|
|
|
ssize_t Read(void *pBuf, size_t nCount);
|
1999-07-14 18:55:57 -04:00
|
|
|
// returns the number of bytes written
|
2004-11-10 16:02:58 -05:00
|
|
|
size_t Write(const void *pBuf, size_t nCount);
|
1998-05-20 10:01:55 -04:00
|
|
|
// returns true on success
|
2007-05-11 16:55:24 -04:00
|
|
|
bool Write(const wxString& s, const wxMBConv& conv = wxMBConvUTF8());
|
1998-05-20 10:01:55 -04:00
|
|
|
// flush data not yet written
|
|
|
|
bool Flush();
|
|
|
|
|
2004-11-10 16:02:58 -05:00
|
|
|
// file pointer operations (return wxInvalidOffset on failure)
|
|
|
|
// move ptr ofs bytes related to start/current offset/end of file
|
|
|
|
wxFileOffset Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
|
1998-05-20 10:01:55 -04:00
|
|
|
// move ptr to ofs bytes before the end
|
2004-11-10 16:02:58 -05:00
|
|
|
wxFileOffset SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
|
|
|
|
// get current offset
|
|
|
|
wxFileOffset Tell() const;
|
1998-05-20 10:01:55 -04:00
|
|
|
// get current file length
|
2004-11-10 16:02:58 -05:00
|
|
|
wxFileOffset Length() const;
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// simple accessors
|
|
|
|
// is file opened?
|
|
|
|
bool IsOpened() const { return m_fd != fd_invalid; }
|
|
|
|
// is end of file reached?
|
|
|
|
bool Eof() const;
|
2005-05-31 05:20:43 -04:00
|
|
|
// has an error occurred?
|
1998-07-14 08:06:50 -04:00
|
|
|
bool Error() const { return m_error; }
|
2005-02-11 07:39:03 -05:00
|
|
|
// type such as disk or pipe
|
2005-02-12 16:53:51 -05:00
|
|
|
wxFileKind GetKind() const { return wxGetFileKind(m_fd); }
|
1998-07-24 13:03:26 -04:00
|
|
|
|
1998-05-20 10:01:55 -04:00
|
|
|
// dtor closes the file if opened
|
1999-07-14 18:55:57 -04:00
|
|
|
~wxFile() { Close(); }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
private:
|
|
|
|
// copy ctor and assignment operator are private because
|
|
|
|
// it doesn't make sense to copy files this way:
|
|
|
|
// attempt to do it will provoke a compile-time error.
|
|
|
|
wxFile(const wxFile&);
|
|
|
|
wxFile& operator=(const wxFile&);
|
|
|
|
|
|
|
|
int m_fd; // file descriptor or INVALID_FD if not opened
|
1998-07-14 08:06:50 -04:00
|
|
|
bool m_error; // error memory
|
1998-05-20 10:01:55 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// class wxTempFile: if you want to replace another file, create an instance
|
|
|
|
// of wxTempFile passing the name of the file to be replaced to the ctor. Then
|
|
|
|
// you can write to wxTempFile and call Commit() function to replace the old
|
|
|
|
// file (and close this one) or call Discard() to cancel the modification. If
|
|
|
|
// you call neither of them, dtor will call Discard().
|
|
|
|
// ----------------------------------------------------------------------------
|
2003-07-01 21:41:23 -04:00
|
|
|
|
2003-07-01 21:59:24 -04:00
|
|
|
class WXDLLIMPEXP_BASE wxTempFile
|
1998-05-20 10:01:55 -04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
// ctors
|
|
|
|
// default
|
|
|
|
wxTempFile() { }
|
|
|
|
// associates the temp file with the file to be replaced and opens it
|
|
|
|
wxTempFile(const wxString& strName);
|
|
|
|
|
|
|
|
// open the temp file (strName is the name of file to be replaced)
|
|
|
|
bool Open(const wxString& strName);
|
|
|
|
|
|
|
|
// is the file opened?
|
|
|
|
bool IsOpened() const { return m_file.IsOpened(); }
|
2005-03-13 11:20:51 -05:00
|
|
|
// get current file length
|
|
|
|
wxFileOffset Length() const { return m_file.Length(); }
|
|
|
|
// move ptr ofs bytes related to start/current offset/end of file
|
|
|
|
wxFileOffset Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart)
|
|
|
|
{ return m_file.Seek(ofs, mode); }
|
|
|
|
// get current offset
|
|
|
|
wxFileOffset Tell() const { return m_file.Tell(); }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
|
|
|
// I/O (both functions return true on success, false on failure)
|
2004-11-10 16:02:58 -05:00
|
|
|
bool Write(const void *p, size_t n) { return m_file.Write(p, n) == n; }
|
2007-05-11 16:55:24 -04:00
|
|
|
bool Write(const wxString& str, const wxMBConv& conv = wxMBConvUTF8())
|
2003-02-26 14:31:44 -05:00
|
|
|
{ return m_file.Write(str, conv); }
|
1998-05-20 10:01:55 -04:00
|
|
|
|
2009-05-31 05:49:31 -04:00
|
|
|
// flush data: can be called before closing file to ensure that data was
|
|
|
|
// correctly written out
|
|
|
|
bool Flush() { return m_file.Flush(); }
|
|
|
|
|
1998-05-20 10:01:55 -04:00
|
|
|
// different ways to close the file
|
|
|
|
// validate changes and delete the old file of name m_strName
|
|
|
|
bool Commit();
|
|
|
|
// discard changes
|
|
|
|
void Discard();
|
|
|
|
|
|
|
|
// dtor calls Discard() if file is still opened
|
|
|
|
~wxTempFile();
|
|
|
|
|
|
|
|
private:
|
1998-11-24 18:30:50 -05:00
|
|
|
// no copy ctor/assignment operator
|
|
|
|
wxTempFile(const wxTempFile&);
|
|
|
|
wxTempFile& operator=(const wxTempFile&);
|
|
|
|
|
1998-05-20 10:01:55 -04:00
|
|
|
wxString m_strName, // name of the file to replace in Commit()
|
|
|
|
m_strTemp; // temporary file name
|
|
|
|
wxFile m_file; // the temporary file
|
|
|
|
};
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
#endif // wxUSE_FILE
|
1999-06-15 16:21:59 -04:00
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
#endif // _WX_FILEH__
|