#ifndef _WX_FILEH__
#define _WX_FILEH__
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "file.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_FILE
#include "wx/string.h"
#include "wx/filefn.h"
#include "wx/strconv.h"
-#if wxUSE_FILE
-
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
// 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
-#define wxS_IRUSR 00400
-#define wxS_IWUSR 00200
-#define wxS_IXUSR 00100
-
-#define wxS_IRGRP 00040
-#define wxS_IWGRP 00020
-#define wxS_IXGRP 00010
-
-#define wxS_IROTH 00004
-#define wxS_IWOTH 00002
-#define wxS_IXOTH 00001
-
-// default mode for the new files: corresponds to umask 022
-#define wxS_DEFAULT (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IWGRP |\
- wxS_IROTH | wxS_IWOTH)
+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,
+
+ // longer but more readable synonims for the constants above:
+ 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)
+};
// ----------------------------------------------------------------------------
// class wxFile: raw file IO
// static functions
// ----------------
// check whether a regular file by this name exists
- static bool Exists(const wxChar *name);
+ static bool Exists(const wxString& name);
// check whether we can access the given file in given mode
// (only read and write make sense here)
- static bool Access(const wxChar *name, OpenMode mode);
+ static bool Access(const wxString& name, OpenMode mode);
// ctors
// -----
// def ctor
wxFile() { m_fd = fd_invalid; m_error = false; }
// open specified file (may fail, use IsOpened())
- wxFile(const wxChar *szFileName, OpenMode mode = read);
+ wxFile(const wxString& fileName, OpenMode mode = read);
// attach to (already opened) file
- wxFile(int fd) { m_fd = fd; m_error = false; }
+ wxFile(int lfd) { m_fd = lfd; m_error = false; }
// open/close
// 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)
- bool Create(const wxChar *szFileName, bool bOverwrite = false,
+ bool Create(const wxString& fileName, bool bOverwrite = false,
int access = wxS_DEFAULT);
- bool Open(const wxChar *szFileName, OpenMode mode = read,
+ bool Open(const wxString& fileName, OpenMode mode = read,
int access = wxS_DEFAULT);
bool Close(); // Close is a NOP if not opened
// assign an existing file descriptor and get it back from wxFile object
- void Attach(int fd) { Close(); m_fd = fd; m_error = false; }
+ void Attach(int lfd) { Close(); m_fd = lfd; m_error = false; }
void Detach() { m_fd = fd_invalid; }
int fd() const { return m_fd; }
// read/write (unbuffered)
- // returns number of bytes read or ofsInvalid on error
- size_t Read(void *pBuf, size_t nCount);
+ // returns number of bytes read or wxInvalidOffset on error
+ ssize_t Read(void *pBuf, size_t nCount);
// returns the number of bytes written
size_t Write(const void *pBuf, size_t nCount);
// returns true on success
- bool Write(const wxString& s, wxMBConv& conv = wxConvUTF8)
- {
- const wxWX2MBbuf buf = s.mb_str(conv);
- size_t size = strlen(buf);
- return Write((const char *) buf, size) == size;
- }
+ bool Write(const wxString& s, const wxMBConv& conv = wxMBConvUTF8());
// flush data not yet written
bool Flush();
- // file pointer operations (return ofsInvalid on failure)
- // move ptr ofs bytes related to start/current off_t/end of file
+ // 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);
// move ptr to ofs bytes before the end
wxFileOffset SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
- // get current off_t
+ // get current offset
wxFileOffset Tell() const;
// get current file length
wxFileOffset Length() const;
bool IsOpened() const { return m_fd != fd_invalid; }
// is end of file reached?
bool Eof() const;
- // has an error occured?
+ // has an error occurred?
bool Error() const { return m_error; }
+ // type such as disk or pipe
+ wxFileKind GetKind() const { return wxGetFileKind(m_fd); }
// dtor closes the file if opened
~wxFile() { Close(); }
// is the file opened?
bool IsOpened() const { return m_file.IsOpened(); }
+ // 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(); }
// I/O (both functions return true on success, false on failure)
- bool Write(const void *p, size_t n) { return m_file.Write(p, n) != 0; }
- bool Write(const wxString& str, wxMBConv& conv = wxConvUTF8)
+ bool Write(const void *p, size_t n) { return m_file.Write(p, n) == n; }
+ bool Write(const wxString& str, const wxMBConv& conv = wxMBConvUTF8())
{ return m_file.Write(str, conv); }
// different ways to close the file
projects / wxWidgets.git / blobdiff