added wxConvFileName which is a variable, not define as wxConvFile; added comments...

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

diff --git a/include/wx/ffile.h b/include/wx/ffile.h
index 640becf4c568fdcbda6da714dfb2708bddd7d846..6b63bded48a9857d956e2917ff67591eec57358f 100644 (file)
--- a/include/wx/ffile.h
+++ b/include/wx/ffile.h
@@ -1,22 +1,24 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        ffile.h
+// Name:        wx/ffile.h
 // Purpose:     wxFFile - encapsulates "FILE *" stream
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     14.07.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _WX_FFILE_H_
 #define   _WX_FFILE_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "ffile.h"
 #endif
 
-#if wxUSE_FILE
+#include "wx/defs.h"        // for wxUSE_FFILE
+
+#if wxUSE_FFILE
 
 #ifndef WX_PRECOMP
   #include  "wx/string.h"
@@ -32,7 +34,7 @@
 //     dtor which is _not_ virtual, so it shouldn't be used as a base class.
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxFFile
+class WXDLLIMPEXP_BASE wxFFile
 {
 public:
   // ctors
@@ -40,50 +42,52 @@ public:
     // def ctor
   wxFFile() { m_fp = NULL; }
     // open specified file (may fail, use IsOpened())
-  wxFFile(const wxChar *filename, const char *mode = "r");
+  wxFFile(const wxChar *filename, const wxChar *mode = _T("r"));
     // attach to (already opened) file
   wxFFile(FILE *fp) { m_fp = fp; }
 
   // open/close
     // open a file (existing or not - the mode controls what happens)
-  bool Open(const wxChar *filename, const char *mode = "r");
+  bool Open(const wxChar *filename, const wxChar *mode = _T("r"));
     // closes the opened file (this is a NOP if not opened)
   bool Close();
 
   // assign an existing file descriptor and get it back from wxFFile object
-  void Attach(FILE *fp, const wxString& name = T(""))
+  void Attach(FILE *fp, const wxString& name = wxEmptyString)
     { Close(); m_fp = fp; m_name = name; }
   void Detach() { m_fp = NULL; }
   FILE *fp() const { return m_fp; }
 
   // read/write (unbuffered)
     // read all data from the file into a string (useful for text files)
-  bool ReadAll(wxString *str);
+  bool ReadAll(wxString *str, wxMBConv& conv = wxConvUTF8);
     // returns number of bytes read - use Eof() and Error() to see if an error
     // occured or not
   size_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)
+  bool Write(const wxString& s, wxMBConv& conv = wxConvUTF8)
   {
-      size_t size = s.Len()*sizeof(wxChar);
-      return Write(s.c_str(), size) == size;
+      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();
 
   // file pointer operations (return ofsInvalid on failure)
     // move ptr ofs bytes related to start/current pos/end of file
-  bool Seek(long ofs, wxSeekMode mode = wxFromStart);
+  bool Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
     // move ptr to ofs bytes before the end
-  bool SeekEnd(long ofs = 0) { return Seek(ofs, wxFromEnd); }
+  bool SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
     // get current position in the file
-  size_t Tell() const;
+  wxFileOffset Tell() const;
     // get current file length
-  size_t Length() const;
+  wxFileOffset Length() const;
 
-  // simple accessors
+  // simple accessors: note that Eof() and Error() may only be called if
+  // IsOpened()!
     // is file opened?
   bool IsOpened() const { return m_fp != NULL; }
     // is end of file reached?
@@ -92,6 +96,8 @@ public:
   bool Error() const { return ferror(m_fp) != 0; }
     // get the file name
   const wxString& GetName() const { return m_name; }
+    // type such as disk or pipe
+  wxFileKind GetKind() const { return wxGetFileKind(m_fp); }
 
   // dtor closes the file if opened
   ~wxFFile() { Close(); }
@@ -108,7 +114,7 @@ private:
   wxString m_name;  // the name of the file (for diagnostic messages)
 };
 
-#endif // wxUSE_FILE
+#endif // wxUSE_FFILE
 
 #endif // _WX_FFILE_H_