1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxFile - encapsulates low-level "file descriptor"
4 // wxTempFile - safely replace the old file
5 // Author: Vadim Zeitlin
9 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
20 #include "wx/string.h"
21 #include "wx/filefn.h"
22 #include "wx/strconv.h"
24 // ----------------------------------------------------------------------------
26 // ----------------------------------------------------------------------------
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
34 #define wxS_IRGRP 00040
35 #define wxS_IWGRP 00020
36 #define wxS_IXGRP 00010
38 #define wxS_IROTH 00004
39 #define wxS_IWOTH 00002
40 #define wxS_IXOTH 00001
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)
46 // ----------------------------------------------------------------------------
47 // class wxFile: raw file IO
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 // ----------------------------------------------------------------------------
53 class WXDLLIMPEXP_BASE wxFile
56 // more file constants
57 // -------------------
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
};
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
);
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; }
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
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
; }
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
, const wxMBConv
& conv
= wxConvUTF8
)
102 const wxWX2MBbuf buf
= s
.mb_str(conv
);
105 size_t size
= strlen(buf
);
106 return Write((const char *) buf
, size
) == size
;
111 // flush data not yet written
114 // file pointer operations (return wxInvalidOffset on failure)
115 // move ptr ofs bytes related to start/current offset/end of file
116 wxFileOffset
Seek(wxFileOffset ofs
, wxSeekMode mode
= wxFromStart
);
117 // move ptr to ofs bytes before the end
118 wxFileOffset
SeekEnd(wxFileOffset ofs
= 0) { return Seek(ofs
, wxFromEnd
); }
119 // get current offset
120 wxFileOffset
Tell() const;
121 // get current file length
122 wxFileOffset
Length() const;
126 bool IsOpened() const { return m_fd
!= fd_invalid
; }
127 // is end of file reached?
129 // has an error occurred?
130 bool Error() const { return m_error
; }
131 // type such as disk or pipe
132 wxFileKind
GetKind() const { return wxGetFileKind(m_fd
); }
134 // dtor closes the file if opened
135 ~wxFile() { Close(); }
138 // copy ctor and assignment operator are private because
139 // it doesn't make sense to copy files this way:
140 // attempt to do it will provoke a compile-time error.
141 wxFile(const wxFile
&);
142 wxFile
& operator=(const wxFile
&);
144 int m_fd
; // file descriptor or INVALID_FD if not opened
145 bool m_error
; // error memory
148 // ----------------------------------------------------------------------------
149 // class wxTempFile: if you want to replace another file, create an instance
150 // of wxTempFile passing the name of the file to be replaced to the ctor. Then
151 // you can write to wxTempFile and call Commit() function to replace the old
152 // file (and close this one) or call Discard() to cancel the modification. If
153 // you call neither of them, dtor will call Discard().
154 // ----------------------------------------------------------------------------
156 class WXDLLIMPEXP_BASE wxTempFile
162 // associates the temp file with the file to be replaced and opens it
163 wxTempFile(const wxString
& strName
);
165 // open the temp file (strName is the name of file to be replaced)
166 bool Open(const wxString
& strName
);
168 // is the file opened?
169 bool IsOpened() const { return m_file
.IsOpened(); }
170 // get current file length
171 wxFileOffset
Length() const { return m_file
.Length(); }
172 // move ptr ofs bytes related to start/current offset/end of file
173 wxFileOffset
Seek(wxFileOffset ofs
, wxSeekMode mode
= wxFromStart
)
174 { return m_file
.Seek(ofs
, mode
); }
175 // get current offset
176 wxFileOffset
Tell() const { return m_file
.Tell(); }
178 // I/O (both functions return true on success, false on failure)
179 bool Write(const void *p
, size_t n
) { return m_file
.Write(p
, n
) == n
; }
180 bool Write(const wxString
& str
, const wxMBConv
& conv
= wxConvUTF8
)
181 { return m_file
.Write(str
, conv
); }
183 // different ways to close the file
184 // validate changes and delete the old file of name m_strName
189 // dtor calls Discard() if file is still opened
193 // no copy ctor/assignment operator
194 wxTempFile(const wxTempFile
&);
195 wxTempFile
& operator=(const wxTempFile
&);
197 wxString m_strName
, // name of the file to replace in Commit()
198 m_strTemp
; // temporary file name
199 wxFile m_file
; // the temporary file
204 #endif // _WX_FILEH__