[ 1960295 ] wxWeakRef - Reorganization and comments

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

diff --git a/include/wx/file.h b/include/wx/file.h
index fde5099582ef8f7c22e99ced8befd40cf8129216..631f12c3c1d944e42ac109914b5bac014fed6557 100644 (file)
--- a/include/wx/file.h
+++ b/include/wx/file.h
@@ -13,16 +13,14 @@
 #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
 // ----------------------------------------------------------------------------
@@ -65,31 +63,31 @@ public:
   // 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; }
 
@@ -99,12 +97,7 @@ public:
     // 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();
 
@@ -123,8 +116,10 @@ public:
   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(); }
@@ -162,10 +157,17 @@ public:
 
   // 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) == n; }
-  bool Write(const wxString& str, wxMBConv& conv = wxConvUTF8)
+  bool Write(const wxString& str, const wxMBConv& conv = wxMBConvUTF8())
     { return m_file.Write(str, conv); }
 
   // different ways to close the file