interface/wx/ffile.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        ffile.h
   3 // Purpose:     interface of wxFFile
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10
  11 /**
  12     Values used for both wxFile and wxFFile.
  13
  14     @todo make the value names uppercase
  15 */
  16 enum wxSeekMode
  17 {
  18   wxFromStart,
  19   wxFromCurrent,
  20   wxFromEnd
  21 };
  22
  23 /**
  24     See wxFFile::GetKind().
  25 */
  26 enum wxFileKind
  27 {
  28   wxFILE_KIND_UNKNOWN,
  29   wxFILE_KIND_DISK,     /**< A file supporting seeking to arbitrary offsets. */
  30   wxFILE_KIND_TERMINAL, /**< A terminal. */
  31   wxFILE_KIND_PIPE      /**< A pipe. */
  32 };
  33
  34
  35 /**
  36     @class wxFFile
  37
  38     wxFFile implements buffered file I/O.
  39
  40     This is a very small class designed to minimize the overhead of using it - in fact,
  41     there is hardly any overhead at all, but using it brings you automatic error checking
  42     and hides differences between platforms and compilers.
  43
  44     It wraps inside it a @c FILE * handle used by standard C IO library (also known as @c stdio).
  45
  46     @library{wxbase}
  47     @category{file}
  48
  49     @see wxFFile::IsOpened
  50 */
  51 class wxFFile
  52 {
  53 public:
  54     wxFFile();
  55
  56     /**
  57         Opens a file with the given file pointer, which has already been opened.
  58
  59         @param fp
  60             An existing file descriptor, such as stderr.
  61     */
  62     wxFFile(FILE* fp);
  63
  64     /**
  65         Opens a file with the given mode.
  66         As there is no way to return whether the operation was successful or not from
  67         the constructor you should test the return value of IsOpened() to check that it
  68         didn't fail.
  69
  70         @param filename
  71             The filename.
  72         @param mode
  73             The mode in which to open the file using standard C strings.
  74             Note that you should use "b" flag if you use binary files under Windows
  75             or the results might be unexpected due to automatic newline conversion done
  76             for the text files.
  77     */
  78     wxFFile(const wxString& filename, const wxString& mode = "r");
  79
  80
  81     /**
  82         Destructor will close the file.
  83
  84         @note it is not virtual so you should @e not derive from wxFFile!
  85     */
  86     ~wxFFile();
  87
  88     /**
  89         Attaches an existing file pointer to the wxFFile object.
  90
  91         The descriptor should be already opened and it will be closed by wxFFile object.
  92     */
  93     void Attach(FILE* fp);
  94
  95     /**
  96         Closes the file and returns @true on success.
  97     */
  98     bool Close();
  99
 100     /**
 101         Get back a file pointer from wxFFile object -- the caller is responsible for
 102         closing the file if this descriptor is opened.
 103
 104         IsOpened() will return @false after call to Detach().
 105     */
 106     void Detach();
 107
 108     /**
 109         Returns @true if the an attempt has been made to read @e past
 110         the end of the file.
 111
 112         Note that the behaviour of the file descriptor based class  wxFile is different as
 113         wxFile::Eof() will return @true here as soon as the last byte of the file has been read.
 114
 115         Also note that this method may only be called for opened files and may crash if
 116         the file is not opened.
 117
 118         @todo THIS METHOD MAY CRASH? DOESN'T SOUND GOOD
 119
 120         @see IsOpened()
 121     */
 122     bool Eof() const;
 123
 124     /**
 125         Returns @true if an error has occurred on this file, similar to the standard
 126         @c ferror() function.
 127
 128         Please note that this method may only be called for opened files and may crash
 129         if the file is not opened.
 130
 131         @todo THIS METHOD MAY CRASH? DOESN'T SOUND GOOD
 132
 133         @see IsOpened()
 134     */
 135     bool Error() const;
 136
 137     /**
 138         Flushes the file and returns @true on success.
 139     */
 140     bool Flush();
 141
 142     /**
 143         Returns the type of the file.
 144
 145         @see wxFileKind
 146     */
 147     wxFileKind GetKind() const;
 148
 149     /**
 150         Returns @true if the file is opened.
 151
 152         Most of the methods of this class may only be used for an opened file.
 153     */
 154     bool IsOpened() const;
 155
 156     /**
 157         Returns the length of the file.
 158     */
 159     wxFileOffset Length() const;
 160
 161     /**
 162         Opens the file, returning @true if successful.
 163
 164         @param filename
 165             The filename.
 166         @param mode
 167             The mode in which to open the file.
 168     */
 169     bool Open(const wxString& filename, const wxString& mode = "r");
 170
 171     /**
 172         Reads the specified number of bytes into a buffer, returning the actual number read.
 173
 174         @param buffer
 175             A buffer to receive the data.
 176         @param count
 177             The number of bytes to read.
 178
 179         @return The number of bytes read.
 180     */
 181     size_t Read(void* buffer, size_t count);
 182
 183     /**
 184         Reads the entire contents of the file into a string.
 185
 186         @param str
 187             String to read data into.
 188         @param conv
 189             Conversion object to use in Unicode build; by default supposes
 190             that file contents is encoded in UTF-8.
 191
 192         @return @true if file was read successfully, @false otherwise.
 193     */
 194     bool ReadAll(wxString* str, const wxMBConv& conv = wxConvAuto());
 195
 196     /**
 197         Seeks to the specified position and returns @true on success.
 198
 199         @param ofs
 200             Offset to seek to.
 201         @param mode
 202             One of wxFromStart, wxFromEnd, wxFromCurrent.
 203     */
 204     bool Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
 205
 206     /**
 207         Moves the file pointer to the specified number of bytes before the end of the
 208         file and returns @true on success.
 209
 210         @param ofs
 211             Number of bytes before the end of the file.
 212     */
 213     bool SeekEnd(wxFileOffset ofs = 0);
 214
 215     /**
 216         Returns the current position.
 217     */
 218     wxFileOffset Tell() const;
 219
 220     /**
 221         Writes the contents of the string to the file, returns @true on success.
 222
 223         The second argument is only meaningful in Unicode build of wxWidgets when
 224         @a conv is used to convert @a str to multibyte representation.
 225     */
 226     bool Write(const wxString& str, const wxMBConv& conv = wxConvAuto());
 227
 228     /**
 229         Writes the specified number of bytes from a buffer.
 230
 231         @param buffer
 232             A buffer containing the data.
 233         @param count
 234             The number of bytes to write.
 235
 236         @return The number of bytes written.
 237     */
 238     size_t Write(const void* buffer, size_t count);
 239
 240     /**
 241         Returns the file pointer associated with the file.
 242     */
 243     FILE* fp() const;
 244 };
 245