include/wx/file.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        file.h
   3 // Purpose:     wxFile - encapsulates low-level "file descriptor"
   4 //              wxTempFile - safely replace the old file
   5 // Author:      Vadim Zeitlin
   6 // Modified by:
   7 // Created:     29/01/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_FILEH__
  14 #define _WX_FILEH__
  15
  16 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  17 #pragma interface "file.h"
  18 #endif
  19
  20 #include  "wx/string.h"
  21 #include  "wx/filefn.h"
  22 #include  "wx/strconv.h"
  23
  24 #if wxUSE_FILE
  25
  26 // ----------------------------------------------------------------------------
  27 // constants
  28 // ----------------------------------------------------------------------------
  29
  30 // we redefine these constants here because S_IREAD &c are _not_ standard
  31 // however, we do assume that the values correspond to the Unix umask bits
  32 #define wxS_IRUSR 00400
  33 #define wxS_IWUSR 00200
  34 #define wxS_IXUSR 00100
  35
  36 #define wxS_IRGRP 00040
  37 #define wxS_IWGRP 00020
  38 #define wxS_IXGRP 00010
  39
  40 #define wxS_IROTH 00004
  41 #define wxS_IWOTH 00002
  42 #define wxS_IXOTH 00001
  43
  44 // default mode for the new files: corresponds to umask 022
  45 #define wxS_DEFAULT   (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IWGRP |\
  46                        wxS_IROTH | wxS_IWOTH)
  47
  48 // ----------------------------------------------------------------------------
  49 // class wxFile: raw file IO
  50 //
  51 // NB: for space efficiency this class has no virtual functions, including
  52 //     dtor which is _not_ virtual, so it shouldn't be used as a base class.
  53 // ----------------------------------------------------------------------------
  54
  55 class WXDLLIMPEXP_BASE wxFile
  56 {
  57 public:
  58   // more file constants
  59   // -------------------
  60     // opening mode
  61   enum OpenMode { read, write, read_write, write_append, write_excl };
  62     // standard values for file descriptor
  63   enum { fd_invalid = -1, fd_stdin, fd_stdout, fd_stderr };
  64
  65   // static functions
  66   // ----------------
  67     // check whether a regular file by this name exists
  68   static bool Exists(const wxChar *name);
  69     // check whether we can access the given file in given mode
  70     // (only read and write make sense here)
  71   static bool Access(const wxChar *name, OpenMode mode);
  72
  73   // ctors
  74   // -----
  75     // def ctor
  76   wxFile() { m_fd = fd_invalid; m_error = false; }
  77     // open specified file (may fail, use IsOpened())
  78   wxFile(const wxChar *szFileName, OpenMode mode = read);
  79     // attach to (already opened) file
  80   wxFile(int fd) { m_fd = fd; m_error = false; }
  81
  82   // open/close
  83     // create a new file (with the default value of bOverwrite, it will fail if
  84     // the file already exists, otherwise it will overwrite it and succeed)
  85   bool Create(const wxChar *szFileName, bool bOverwrite = false,
  86               int access = wxS_DEFAULT);
  87   bool Open(const wxChar *szFileName, OpenMode mode = read,
  88             int access = wxS_DEFAULT);
  89   bool Close();  // Close is a NOP if not opened
  90
  91   // assign an existing file descriptor and get it back from wxFile object
  92   void Attach(int fd) { Close(); m_fd = fd; m_error = false; }
  93   void Detach()       { m_fd = fd_invalid;  }
  94   int  fd() const { return m_fd; }
  95
  96   // read/write (unbuffered)
  97     // returns number of bytes read or wxInvalidOffset on error
  98   ssize_t Read(void *pBuf, size_t nCount);
  99     // returns the number of bytes written
 100   size_t Write(const void *pBuf, size_t nCount);
 101     // returns true on success
 102   bool Write(const wxString& s, wxMBConv& conv = wxConvUTF8)
 103   {
 104       const wxWX2MBbuf buf = s.mb_str(conv);
 105       size_t size = strlen(buf);
 106       return Write((const char *) buf, size) == size;
 107   }
 108     // flush data not yet written
 109   bool Flush();
 110
 111   // file pointer operations (return wxInvalidOffset on failure)
 112     // move ptr ofs bytes related to start/current offset/end of file
 113   wxFileOffset Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
 114     // move ptr to ofs bytes before the end
 115   wxFileOffset SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
 116     // get current offset
 117   wxFileOffset Tell() const;
 118     // get current file length
 119   wxFileOffset Length() const;
 120
 121   // simple accessors
 122     // is file opened?
 123   bool IsOpened() const { return m_fd != fd_invalid; }
 124     // is end of file reached?
 125   bool Eof() const;
 126     // has an error occured?
 127   bool Error() const { return m_error; }
 128     // type such as disk or pipe
 129   wxFileTypeEnum GetFileType() const { return wxGetFileType(m_fd); }
 130
 131   // dtor closes the file if opened
 132   ~wxFile() { Close(); }
 133
 134 private:
 135   // copy ctor and assignment operator are private because
 136   // it doesn't make sense to copy files this way:
 137   // attempt to do it will provoke a compile-time error.
 138   wxFile(const wxFile&);
 139   wxFile& operator=(const wxFile&);
 140
 141   int m_fd; // file descriptor or INVALID_FD if not opened
 142   bool m_error; // error memory
 143 };
 144
 145 // ----------------------------------------------------------------------------
 146 // class wxTempFile: if you want to replace another file, create an instance
 147 // of wxTempFile passing the name of the file to be replaced to the ctor. Then
 148 // you can write to wxTempFile and call Commit() function to replace the old
 149 // file (and close this one) or call Discard() to cancel the modification. If
 150 // you call neither of them, dtor will call Discard().
 151 // ----------------------------------------------------------------------------
 152
 153 class WXDLLIMPEXP_BASE wxTempFile
 154 {
 155 public:
 156   // ctors
 157     // default
 158   wxTempFile() { }
 159     // associates the temp file with the file to be replaced and opens it
 160   wxTempFile(const wxString& strName);
 161
 162   // open the temp file (strName is the name of file to be replaced)
 163   bool Open(const wxString& strName);
 164
 165   // is the file opened?
 166   bool IsOpened() const { return m_file.IsOpened(); }
 167
 168   // I/O (both functions return true on success, false on failure)
 169   bool Write(const void *p, size_t n) { return m_file.Write(p, n) == n; }
 170   bool Write(const wxString& str, wxMBConv& conv = wxConvUTF8)
 171     { return m_file.Write(str, conv); }
 172
 173   // different ways to close the file
 174     // validate changes and delete the old file of name m_strName
 175   bool Commit();
 176     // discard changes
 177   void Discard();
 178
 179   // dtor calls Discard() if file is still opened
 180  ~wxTempFile();
 181
 182 private:
 183   // no copy ctor/assignment operator
 184   wxTempFile(const wxTempFile&);
 185   wxTempFile& operator=(const wxTempFile&);
 186
 187   wxString  m_strName,  // name of the file to replace in Commit()
 188             m_strTemp;  // temporary file name
 189   wxFile    m_file;     // the temporary file
 190 };
 191
 192 #endif // wxUSE_FILE
 193
 194 #endif // _WX_FILEH__