Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/file.h b/include/wx/file.h
index df901520ef7b90f266053b5261a6b195515e9dbd..75471c3b62a126487e3ee8ee6f9c9fae971d4c38 100644 (file)
--- a/include/wx/file.h
+++ b/include/wx/file.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        file.h
+// 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


@@ -19,56 +19,7 @@
 
 #include  "wx/string.h"
 #include  "wx/filefn.h"
 
 #include  "wx/string.h"
 #include  "wx/filefn.h"

-#include  "wx/strconv.h"
-
-// ----------------------------------------------------------------------------
-// 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
-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)
-};
+#include  "wx/convauto.h"

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


@@ -98,11 +49,11 @@ public:
   // ctors
   // -----
     // def ctor
   // ctors
   // -----
     // def ctor

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

     // open specified file (may fail, use IsOpened())
   wxFile(const wxString& fileName, OpenMode mode = read);
     // attach to (already opened) file
     // open specified file (may fail, use IsOpened())
   wxFile(const wxString& fileName, OpenMode mode = read);
     // attach to (already opened) file

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

 
   // open/close
     // create a new file (with the default value of bOverwrite, it will fail if
 
   // open/close
     // create a new file (with the default value of bOverwrite, it will fail if


@@ -114,11 +65,13 @@ public:
   bool Close();  // Close is a NOP if not opened
 
   // assign an existing file descriptor and get it back from wxFile object
   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_error = false; }
+  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)
   void Detach()       { m_fd = fd_invalid;  }
   int  fd() const { return m_fd; }
 
   // read/write (unbuffered)

+    // read all data from the file into a string (useful for text files)
+  bool ReadAll(wxString *str, const wxMBConv& conv = wxConvAuto());

     // returns number of bytes read or wxInvalidOffset on error
   ssize_t Read(void *pBuf, size_t nCount);
     // returns the number of bytes written
     // returns number of bytes read or wxInvalidOffset on error
   ssize_t Read(void *pBuf, size_t nCount);
     // returns the number of bytes written


@@ -144,10 +97,15 @@ public:
     // is end of file reached?
   bool Eof() const;
     // has an error occurred?
     // is end of file reached?
   bool Eof() const;
     // has an error occurred?

-  bool Error() const { return m_error; }
+  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); }
 
     // type such as disk or pipe
   wxFileKind GetKind() const { return wxGetFileKind(m_fd); }
 

+

   // dtor closes the file if opened
   ~wxFile() { Close(); }
 
   // dtor closes the file if opened
   ~wxFile() { Close(); }
 


@@ -158,8 +116,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

-  bool m_error; // error memory
+  int m_lasterror; // errno value of last error

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


@@ -197,6 +163,10 @@ public:
   bool Write(const wxString& str, const wxMBConv& conv = wxMBConvUTF8())
     { return m_file.Write(str, conv); }
 
   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
   bool Commit();
   // different ways to close the file
     // validate changes and delete the old file of name m_strName
   bool Commit();