moved XML classes to the core

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

diff --git a/include/wx/file.h b/include/wx/file.h
index a12d35550755e4a72e7a7de155d1ee51f20b97e4..8a382583ee650e240e2e5de4cc292d2e197ca42c 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
@@ -7,26 +7,28 @@
 // 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__
+#if defined(__GNUG__) && !defined(__APPLE__)
 #pragma interface "file.h"
 #endif
 
-#include  "wx/string.h"
-#include  "wx/filefn.h"
+#ifndef WX_PRECOMP
+  #include  "wx/string.h"
+  #include  "wx/filefn.h"
+  #include  "wx/strconv.h"
+#endif
+
+#if wxUSE_FILE
 
 // ----------------------------------------------------------------------------
 // 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
@@ -51,36 +53,40 @@ 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.
 // ----------------------------------------------------------------------------
-class WXDLLEXPORT wxFile
+
+class WXDLLIMPEXP_BASE wxFile
 {
 public:
   // more file constants
   // -------------------
-
     // opening mode
-  enum OpenMode { read, write, read_write, write_append };
+  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 };
 
   // 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())
-  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)
-  bool Create(const char *szFileName, bool bOverwrite = FALSE,
+  bool Create(const wxChar *szFileName, bool bOverwrite = FALSE,
               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
 
@@ -92,10 +98,15 @@ public:
   // 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
-  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 = wxConvUTF8)
+  {
+      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();
 
@@ -114,11 +125,11 @@ public:
   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
- ~wxFile();
+  ~wxFile() { Close(); }
 
 private:
   // copy ctor and assignment operator are private because
@@ -138,7 +149,8 @@ private:
 // file (and close this one) or call Discard() to cancel the modification. If
 // you call neither of them, dtor will call Discard().
 // ----------------------------------------------------------------------------
-class WXDLLEXPORT wxTempFile
+
+class WXDLLIMPEXP_BASE wxTempFile
 {
 public:
   // ctors
@@ -154,8 +166,9 @@ public:
   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 wxString& str)   { return m_file.Write(str); }
+  bool Write(const void *p, size_t n) { return m_file.Write(p, n) != 0; }
+  bool Write(const wxString& str, wxMBConv& conv = wxConvUTF8)
+    { return m_file.Write(str, conv); }
 
   // different ways to close the file
     // validate changes and delete the old file of name m_strName
@@ -167,10 +180,15 @@ public:
  ~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
 };
 
-#endif
-        // __FILEH__
+#endif // wxUSE_FILE
+
+#endif // _WX_FILEH__