added GetHimagelist()
[wxWidgets.git] / include / wx / ffile.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/ffile.h
3 // Purpose: wxFFile - encapsulates "FILE *" stream
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 14.07.99
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_FFILE_H_
13 #define _WX_FFILE_H_
14
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "ffile.h"
17 #endif
18
19 #include "wx/defs.h" // for wxUSE_FFILE
20
21 #if wxUSE_FFILE
22
23 #ifndef WX_PRECOMP
24 #include "wx/string.h"
25 #include "wx/filefn.h"
26 #endif
27
28 #include <stdio.h>
29
30 // ----------------------------------------------------------------------------
31 // class wxFFile: standard C stream library IO
32 //
33 // NB: for space efficiency this class has no virtual functions, including
34 // dtor which is _not_ virtual, so it shouldn't be used as a base class.
35 // ----------------------------------------------------------------------------
36
37 class WXDLLIMPEXP_BASE wxFFile
38 {
39 public:
40 // ctors
41 // -----
42 // def ctor
43 wxFFile() { m_fp = NULL; }
44 // open specified file (may fail, use IsOpened())
45 wxFFile(const wxChar *filename, const wxChar *mode = _T("r"));
46 // attach to (already opened) file
47 wxFFile(FILE *fp) { m_fp = fp; }
48
49 // open/close
50 // open a file (existing or not - the mode controls what happens)
51 bool Open(const wxChar *filename, const wxChar *mode = _T("r"));
52 // closes the opened file (this is a NOP if not opened)
53 bool Close();
54
55 // assign an existing file descriptor and get it back from wxFFile object
56 void Attach(FILE *fp, const wxString& name = wxEmptyString)
57 { Close(); m_fp = fp; m_name = name; }
58 void Detach() { m_fp = NULL; }
59 FILE *fp() const { return m_fp; }
60
61 // read/write (unbuffered)
62 // read all data from the file into a string (useful for text files)
63 bool ReadAll(wxString *str, wxMBConv& conv = wxConvUTF8);
64 // returns number of bytes read - use Eof() and Error() to see if an error
65 // occured or not
66 size_t Read(void *pBuf, size_t nCount);
67 // returns the number of bytes written
68 size_t Write(const void *pBuf, size_t nCount);
69 // returns true on success
70 bool Write(const wxString& s, wxMBConv& conv = wxConvUTF8)
71 {
72 const wxWX2MBbuf buf = s.mb_str(conv);
73 size_t size = strlen(buf);
74 return Write((const char *)buf, size) == size;
75 }
76 // flush data not yet written
77 bool Flush();
78
79 // file pointer operations (return ofsInvalid on failure)
80 // move ptr ofs bytes related to start/current pos/end of file
81 bool Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
82 // move ptr to ofs bytes before the end
83 bool SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
84 // get current position in the file
85 wxFileOffset Tell() const;
86 // get current file length
87 wxFileOffset Length() const;
88
89 // simple accessors: note that Eof() and Error() may only be called if
90 // IsOpened()!
91 // is file opened?
92 bool IsOpened() const { return m_fp != NULL; }
93 // is end of file reached?
94 bool Eof() const { return feof(m_fp) != 0; }
95 // is an error occured?
96 bool Error() const { return ferror(m_fp) != 0; }
97 // get the file name
98 const wxString& GetName() const { return m_name; }
99 // type such as disk or pipe
100 wxFileKind GetKind() const { return wxGetFileKind(m_fp); }
101
102 // dtor closes the file if opened
103 ~wxFFile() { Close(); }
104
105 private:
106 // copy ctor and assignment operator are private because it doesn't make
107 // sense to copy files this way: attempt to do it will provoke a compile-time
108 // error.
109 wxFFile(const wxFFile&);
110 wxFFile& operator=(const wxFFile&);
111
112 FILE *m_fp; // IO stream or NULL if not opened
113
114 wxString m_name; // the name of the file (for diagnostic messages)
115 };
116
117 #endif // wxUSE_FFILE
118
119 #endif // _WX_FFILE_H_
120