]>
git.saurik.com Git - wxWidgets.git/blob - interface/ffile.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxFFile
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
12 Values used for both wxFile and wxFFile.
14 @todo make the value names uppercase
24 See wxFFile::GetKind().
29 wxFILE_KIND_DISK
, /**< A file supporting seeking to arbitrary offsets. */
30 wxFILE_KIND_TERMINAL
, /**< A terminal. */
31 wxFILE_KIND_PIPE
/**< A pipe. */
39 wxFFile implements buffered file I/O.
41 This is a very small class designed to minimize the overhead of using it - in fact,
42 there is hardly any overhead at all, but using it brings you automatic error checking
43 and hides differences between platforms and compilers.
45 It wraps inside it a @c FILE * handle used by standard C IO library (also known as @c stdio).
50 @see wxFFile::IsOpened
58 Opens a file with the given file pointer, which has already been opened.
61 An existing file descriptor, such as stderr.
66 Opens a file with the given mode.
67 As there is no way to return whether the operation was successful or not from
68 the constructor you should test the return value of IsOpened() to check that it
74 The mode in which to open the file using standard C strings.
75 Note that you should use "b" flag if you use binary files under Windows
76 or the results might be unexpected due to automatic newline conversion done
79 wxFFile(const wxString
& filename
, const wxString
& mode
= "r");
83 Destructor will close the file.
85 @note it is not virtual so you should @e not derive from wxFFile!
90 Attaches an existing file pointer to the wxFFile object.
92 The descriptor should be already opened and it will be closed by wxFFile object.
94 void Attach(FILE* fp
);
97 Closes the file and returns @true on success.
102 Get back a file pointer from wxFFile object -- the caller is responsible for
103 closing the file if this descriptor is opened.
105 IsOpened() will return @false after call to Detach().
110 Returns @true if the an attempt has been made to read @e past
113 Note that the behaviour of the file descriptor based class wxFile is different as
114 wxFile::Eof() will return @true here as soon as the last byte of the file has been read.
116 Also note that this method may only be called for opened files and may crash if
117 the file is not opened.
119 @todo THIS METHOD MAY CRASH? DOESN'T SOUND GOOD
126 Returns @true if an error has occurred on this file, similar to the standard
127 @c ferror() function.
129 Please note that this method may only be called for opened files and may crash
130 if the file is not opened.
132 @todo THIS METHOD MAY CRASH? DOESN'T SOUND GOOD
139 Flushes the file and returns @true on success.
144 Returns the type of the file.
148 wxFileKind
GetKind() const;
151 Returns @true if the file is opened.
153 Most of the methods of this class may only be used for an opened file.
155 bool IsOpened() const;
158 Returns the length of the file.
160 wxFileOffset
Length() const;
163 Opens the file, returning @true if successful.
168 The mode in which to open the file.
170 bool Open(const wxString
& filename
, const wxString
& mode
= "r");
173 Reads the specified number of bytes into a buffer, returning the actual number read.
176 A buffer to receive the data.
178 The number of bytes to read.
180 @return The number of bytes read.
182 size_t Read(void* buffer
, size_t count
);
185 Reads the entire contents of the file into a string.
188 String to read data into.
190 Conversion object to use in Unicode build; by default supposes
191 that file contents is encoded in UTF-8.
193 @return @true if file was read successfully, @false otherwise.
195 bool ReadAll(wxString
* str
, const wxMBConv
& conv
= wxConvAuto());
198 Seeks to the specified position and returns @true on success.
203 One of wxFromStart, wxFromEnd, wxFromCurrent.
205 bool Seek(wxFileOffset ofs
, wxSeekMode mode
= wxFromStart
);
208 Moves the file pointer to the specified number of bytes before the end of the
209 file and returns @true on success.
212 Number of bytes before the end of the file.
214 bool SeekEnd(wxFileOffset ofs
= 0);
217 Returns the current position.
219 wxFileOffset
Tell() const;
222 Writes the contents of the string to the file, returns @true on success.
224 The second argument is only meaningful in Unicode build of wxWidgets when
225 @a conv is used to convert @a str to multibyte representation.
227 bool Write(const wxString
& str
, const wxMBConv
& conv
= wxConvAuto());
230 Writes the specified number of bytes from a buffer.
233 A buffer containing the data.
235 The number of bytes to write.
237 @return The number of bytes written.
239 size_t Write(const void* buffer
, size_t count
);
242 Returns the file pointer associated with the file.