Revert HasModifiers() change in behaviour, add HasAnyModifiers().

[wxWidgets.git] / include / wx / file.h

diff --git a/include/wx/file.h b/include/wx/file.h
index ece4086f950fad1936f54b4a73cadeb2cb89fa53..044e891fa8a7cbbdecfe22c1a917e2d97065fe0f 100644 (file)
--- a/include/wx/file.h
+++ b/include/wx/file.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        file.cpp
+// Name:        wx/file.h

 // Purpose:     wxFile - encapsulates low-level "file descriptor"
 //              wxTempFile - safely replace the old file
 // Author:      Vadim Zeitlin
 // Purpose:     wxFile - encapsulates low-level "file descriptor"
 //              wxTempFile - safely replace the old file
 // Author:      Vadim Zeitlin


@@ -7,35 +7,19 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:    wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef   __FILEH__
-#define   __FILEH__
+#ifndef _WX_FILEH__
+#define _WX_FILEH__

 
 

-#ifdef __GNUG__
-#pragma interface "file.h"
-#endif
+#include  "wx/defs.h"

 
 

-// ----------------------------------------------------------------------------
-// simple types
-// ----------------------------------------------------------------------------
-
-#include  <wx/filefn.h>
-
-// define off_t
-#include  <sys/types.h>
-
-#ifdef    _MSC_VER
-  #define   off_t       _off_t
-#endif
+#if wxUSE_FILE

 
 

-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-// error return value for Seek() functions
-const off_t ofsInvalid = (off_t)-1;
+#include  "wx/string.h"
+#include  "wx/filefn.h"
+#include  "wx/strconv.h"

 
 // ----------------------------------------------------------------------------
 // class wxFile: raw file IO
 
 // ----------------------------------------------------------------------------
 // class wxFile: raw file IO


@@ -43,66 +27,85 @@ const off_t ofsInvalid = (off_t)-1;
 // 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.
 // ----------------------------------------------------------------------------
 // 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.
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxFile
+
+class WXDLLIMPEXP_BASE wxFile

 {
 public:
   // more file constants
   // -------------------
 {
 public:
   // more file constants
   // -------------------

-    

     // opening mode
     // opening mode

-  enum OpenMode { read, write, read_write };
+  enum OpenMode { read, write, read_write, write_append, write_excl };

     // standard values for file descriptor
   enum { fd_invalid = -1, fd_stdin, fd_stdout, fd_stderr };
     // standard values for file descriptor
   enum { fd_invalid = -1, fd_stdin, fd_stdout, fd_stderr };

-    // seek type
-  enum SeekMode { FromStart, FromEnd, FromCurrent };

 
   // static functions
   // ----------------
 
   // static functions
   // ----------------

-  static bool Exists(const char *sz);  // also checks it's a regular file
+    // check whether a regular file by this name exists
+  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 wxString& name, OpenMode mode);

 
   // ctors
   // -----
     // def ctor
 
   // ctors
   // -----
     // def ctor

-  wxFile() { m_fd = fd_invalid; }
+  wxFile() { m_fd = fd_invalid; m_lasterror = 0; }

     // open specified file (may fail, use IsOpened())
     // open specified file (may fail, use IsOpened())

-  wxFile(const char *szFileName, OpenMode mode = read);
+  wxFile(const wxString& fileName, OpenMode mode = read);

     // attach to (already opened) file
     // attach to (already opened) file

-  wxFile(int fd) { m_fd = fd; }
+  wxFile(int lfd) { m_fd = lfd; m_lasterror = 0; }

 
   // open/close
 
   // open/close

-  bool Create(const char *szFileName, bool bOverwrite = FALSE);
-  bool Open(const char *szFileName, OpenMode mode = read);
-  void Attach(int fd) { Close(); m_fd = fd; }
-  inline void Close();  // Close is a NOP if not opened
+    // 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 wxString& fileName, bool bOverwrite = false,
+              int access = wxS_DEFAULT);
+  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 lfd) { Close(); m_fd = lfd; m_lasterror = 0; }
+  void Detach()       { m_fd = fd_invalid;  }
+  int  fd() const { return m_fd; }

 
   // read/write (unbuffered)
 
   // read/write (unbuffered)

-    // returns number of bytes read or ofsInvalid on error
-  off_t Read(void *pBuf, off_t nCount);
-    // returns true on success
-  bool Write(const void *pBuf, uint 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
     // returns true on success

-  bool Write(const wxString& str) { return Write(str.c_str(), str.Len()); }
+  bool Write(const wxString& s, const wxMBConv& conv = wxMBConvUTF8());

     // flush data not yet written
   bool Flush();
 
     // 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
-  off_t Seek(off_t ofs, SeekMode mode = FromStart);
+  // 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
     // move ptr to ofs bytes before the end

-  off_t SeekEnd(off_t ofs = 0) { return Seek(ofs, FromEnd); }
-    // get current off_t
-  off_t Tell() const;
+  wxFileOffset SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
+    // get current offset
+  wxFileOffset Tell() const;

     // get current file length
     // get current file length

-  off_t Length() const;
+  wxFileOffset Length() const;

 
   // simple accessors
     // is file opened?
   bool IsOpened() const { return m_fd != fd_invalid; }
     // is end of file reached?
   bool Eof() const;
 
   // simple accessors
     // is file opened?
   bool IsOpened() const { return m_fd != fd_invalid; }
     // is end of file reached?
   bool Eof() const;

-    
+    // has an error occurred?
+  bool Error() const { return m_lasterror != 0; }
+    // get last errno
+  int GetLastError() const { return m_lasterror; }
+    // reset error state
+  void ClearLastError() { m_lasterror = 0; }
+    // type such as disk or pipe
+  wxFileKind GetKind() const { return wxGetFileKind(m_fd); }
+
+

   // dtor closes the file if opened
   // dtor closes the file if opened

- ~wxFile();
+  ~wxFile() { Close(); }

 
 private:
   // copy ctor and assignment operator are private because
 
 private:
   // copy ctor and assignment operator are private because


@@ -111,7 +114,16 @@ private:
   wxFile(const wxFile&);
   wxFile& operator=(const wxFile&);
 
   wxFile(const wxFile&);
   wxFile& operator=(const wxFile&);
 

+  // Copy the value of errno into m_lasterror if rc == -1 and return true in
+  // this case (indicating that we've got an error). Otherwise return false.
+  //
+  // Notice that we use the possibly 64 bit wxFileOffset instead of int here so
+  // that it works for checking the result of functions such as tell() too.
+  bool CheckForError(wxFileOffset rc) const;
+
+

   int m_fd; // file descriptor or INVALID_FD if not opened
   int m_fd; // file descriptor or INVALID_FD if not opened

+  int m_lasterror; // errno value of last error

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -121,7 +133,8 @@ private:
 // file (and close this one) or call Discard() to cancel the modification. If
 // you call neither of them, dtor will call Discard().
 // ----------------------------------------------------------------------------
 // file (and close this one) or call Discard() to cancel the modification. If
 // you call neither of them, dtor will call Discard().
 // ----------------------------------------------------------------------------

-class wxTempFile
+
+class WXDLLIMPEXP_BASE wxTempFile

 {
 public:
   // ctors
 {
 public:
   // ctors


@@ -135,10 +148,22 @@ public:
 
   // is the file opened?
   bool IsOpened() const { return m_file.IsOpened(); }
 
   // 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)
 
   // I/O (both functions return true on success, false on failure)

-  bool Write(const void *p, uint n) { return m_file.Write(p, n); }
-  bool Write(const wxString& str)   { return m_file.Write(str);  }
+  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); }
+
+  // flush data: can be called before closing file to ensure that data was
+  // correctly written out
+  bool Flush() { return m_file.Flush(); }

 
   // different ways to close the file
     // validate changes and delete the old file of name m_strName
 
   // different ways to close the file
     // validate changes and delete the old file of name m_strName


@@ -150,10 +175,15 @@ public:
  ~wxTempFile();
 
 private:
  ~wxTempFile();
 
 private:

+  // no copy ctor/assignment operator
+  wxTempFile(const wxTempFile&);
+  wxTempFile& operator=(const wxTempFile&);
+

   wxString  m_strName,  // name of the file to replace in Commit()
             m_strTemp;  // temporary file name
   wxFile    m_file;     // the temporary file
 };
 
   wxString  m_strName,  // name of the file to replace in Commit()
             m_strTemp;  // temporary file name
   wxFile    m_file;     // the temporary file
 };
 

-#endif
-       // __FILEH__
+#endif // wxUSE_FILE
+
+#endif // _WX_FILEH__