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