Trying to hide evidence of my negative programming skills...

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

diff --git a/include/wx/file.h b/include/wx/file.h
index 40d4d8f21b48ad8d782dacd77e6abfaf9ee782eb..d52ad5f423852d28abae15666d3edcb4dd2ee806 100644 (file)
--- a/include/wx/file.h
+++ b/include/wx/file.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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


@@ -10,23 +10,24 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

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

 
 #ifdef __GNUG__
 #pragma interface "file.h"
 #endif
 
 
 #ifdef __GNUG__
 #pragma interface "file.h"
 #endif
 

-#include  "wx/string.h"
-#include  "wx/filefn.h"
+#ifndef WX_PRECOMP
+  #include  "wx/string.h"
+  #include  "wx/filefn.h"
+#endif
+
+#if wxUSE_FILE

 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 

-// error return value for Seek() functions
-const off_t ofsInvalid = (off_t)-1;
-

 // 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
 // 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


@@ -42,7 +43,8 @@ const off_t ofsInvalid = (off_t)-1;
 #define wxS_IXOTH 00001
 
 // default mode for the new files: corresponds to umask 022
 #define wxS_IXOTH 00001
 
 // default mode for the new files: corresponds to umask 022

-#define wxS_DEFAULT   (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IROTH)
+#define wxS_DEFAULT   (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IWGRP |\
+                       wxS_IROTH | wxS_IWOTH)

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


@@ -55,7 +57,6 @@ class WXDLLEXPORT wxFile
 public:
   // more file constants
   // -------------------
 public:
   // more file constants
   // -------------------

-

     // opening mode
   enum OpenMode { read, write, read_write, write_append };
     // standard values for file descriptor
     // opening mode
   enum OpenMode { read, write, read_write, write_append };
     // standard values for file descriptor


@@ -63,23 +64,27 @@ public:
 
   // 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 wxChar *name);
+    // check whetther we can access the given file in given mode
+    // (only read and write make sense here)
+  static bool Access(const wxChar *name, OpenMode mode);

 
   // ctors
   // -----
     // def ctor
   wxFile() { m_fd = fd_invalid; }
     // open specified file (may fail, use IsOpened())
 
   // ctors
   // -----
     // def ctor
   wxFile() { m_fd = fd_invalid; }
     // open specified file (may fail, use IsOpened())

-  wxFile(const char *szFileName, OpenMode mode = read);
+  wxFile(const wxChar *szFileName, OpenMode mode = read);

     // attach to (already opened) file
   wxFile(int fd) { m_fd = fd; }
 
   // 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)
     // attach to (already opened) file
   wxFile(int fd) { m_fd = fd; }
 
   // 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 char *szFileName, bool bOverwrite = FALSE,
+  bool Create(const wxChar *szFileName, bool bOverwrite = FALSE,

               int access = wxS_DEFAULT);
               int access = wxS_DEFAULT);

-  bool Open(const char *szFileName, OpenMode mode = read,
+  bool Open(const wxChar *szFileName, OpenMode mode = read,

             int access = wxS_DEFAULT);
   bool Close();  // Close is a NOP if not opened
 
             int access = wxS_DEFAULT);
   bool Close();  // Close is a NOP if not opened
 


@@ -91,10 +96,15 @@ public:
   // read/write (unbuffered)
     // returns number of bytes read or ofsInvalid on error
   off_t Read(void *pBuf, off_t nCount);
   // read/write (unbuffered)
     // returns number of bytes read or ofsInvalid on error
   off_t Read(void *pBuf, off_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

-  uint Write(const void *pBuf, uint nCount);
-    // returns true on success
-  bool Write(const wxString& s) { return Write(s.c_str(), s.Len()) != 0; }
+  bool Write(const wxString& s, wxMBConv& conv = wxConvLibc)
+  {
+      const wxWX2MBbuf buf = s.mb_str(conv);
+      size_t size = strlen(buf);
+      return Write((const char *) buf, size) == size;
+  }

     // flush data not yet written
   bool Flush();
 
     // flush data not yet written
   bool Flush();
 


@@ -113,11 +123,11 @@ public:
   bool IsOpened() const { return m_fd != fd_invalid; }
     // is end of file reached?
   bool Eof() const;
   bool IsOpened() const { return m_fd != fd_invalid; }
     // is end of file reached?
   bool Eof() const;

-    // is an error occured?
+    // has an error occured?

   bool Error() const { return m_error; }
 
   // dtor closes the file if opened
   bool Error() const { return m_error; }
 
   // 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


@@ -153,7 +163,7 @@ public:
   bool IsOpened() const { return m_file.IsOpened(); }
 
   // I/O (both functions return true on success, false on failure)
   bool IsOpened() const { return m_file.IsOpened(); }
 
   // I/O (both functions return true on success, false on failure)

-  bool Write(const void *p, uint n) { return m_file.Write(p, n) != 0; }
+  bool Write(const void *p, size_t n) { return m_file.Write(p, n) != 0; }

   bool Write(const wxString& str)   { return m_file.Write(str); }
 
   // different ways to close the file
   bool Write(const wxString& str)   { return m_file.Write(str); }
 
   // different ways to close the file


@@ -166,10 +176,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__