/[pcsx2_0.9.7]/branch/r3113_0.9.7_beta/3rdparty/wxWidgets/include/wx/ffile.h
ViewVC logotype

Contents of /branch/r3113_0.9.7_beta/3rdparty/wxWidgets/include/wx/ffile.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 32 - (show annotations) (download)
Tue Sep 7 03:29:01 2010 UTC (9 years, 5 months ago) by william
File MIME type: text/plain
File size: 3941 byte(s)
branching from upstream revision (http://pcsx2.googlecode.com/svn/trunk
): r3113 to
https://svn.netsolutions.dnsalias.com/websvn/ps2/pcsx2/pcsx2_0.9.7/branch/r3113_0.9.7_beta
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: ffile.h 38570 2006-04-05 14:37:47Z VZ $
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 #include "wx/defs.h" // for wxUSE_FFILE
16
17 #if wxUSE_FFILE
18
19 #include "wx/string.h"
20 #include "wx/filefn.h"
21 #include "wx/convauto.h"
22
23 #include <stdio.h>
24
25 // ----------------------------------------------------------------------------
26 // class wxFFile: standard C stream library IO
27 //
28 // NB: for space efficiency this class has no virtual functions, including
29 // dtor which is _not_ virtual, so it shouldn't be used as a base class.
30 // ----------------------------------------------------------------------------
31
32 class WXDLLIMPEXP_BASE wxFFile
33 {
34 public:
35 // ctors
36 // -----
37 // def ctor
38 wxFFile() { m_fp = NULL; }
39 // open specified file (may fail, use IsOpened())
40 wxFFile(const wxChar *filename, const wxChar *mode = _T("r"));
41 // attach to (already opened) file
42 wxFFile(FILE *lfp) { m_fp = lfp; }
43
44 // open/close
45 // open a file (existing or not - the mode controls what happens)
46 bool Open(const wxChar *filename, const wxChar *mode = _T("r"));
47 // closes the opened file (this is a NOP if not opened)
48 bool Close();
49
50 // assign an existing file descriptor and get it back from wxFFile object
51 void Attach(FILE *lfp, const wxString& name = wxEmptyString)
52 { Close(); m_fp = lfp; m_name = name; }
53 void Detach() { m_fp = NULL; }
54 FILE *fp() const { return m_fp; }
55
56 // read/write (unbuffered)
57 // read all data from the file into a string (useful for text files)
58 bool ReadAll(wxString *str, const wxMBConv& conv = wxConvAuto());
59 // returns number of bytes read - use Eof() and Error() to see if an error
60 // occurred or not
61 size_t Read(void *pBuf, size_t nCount);
62 // returns the number of bytes written
63 size_t Write(const void *pBuf, size_t nCount);
64 // returns true on success
65 bool Write(const wxString& s, const wxMBConv& conv = wxConvAuto())
66 {
67 const wxWX2MBbuf buf = s.mb_str(conv);
68 size_t size = strlen(buf);
69 return Write((const char *)buf, size) == size;
70 }
71 // flush data not yet written
72 bool Flush();
73
74 // file pointer operations (return ofsInvalid on failure)
75 // move ptr ofs bytes related to start/current pos/end of file
76 bool Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
77 // move ptr to ofs bytes before the end
78 bool SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
79 // get current position in the file
80 wxFileOffset Tell() const;
81 // get current file length
82 wxFileOffset Length() const;
83
84 // simple accessors: note that Eof() and Error() may only be called if
85 // IsOpened()!
86 // is file opened?
87 bool IsOpened() const { return m_fp != NULL; }
88 // is end of file reached?
89 bool Eof() const { return feof(m_fp) != 0; }
90 // has an error occurred?
91 bool Error() const { return ferror(m_fp) != 0; }
92 // get the file name
93 const wxString& GetName() const { return m_name; }
94 // type such as disk or pipe
95 wxFileKind GetKind() const { return wxGetFileKind(m_fp); }
96
97 // dtor closes the file if opened
98 ~wxFFile() { Close(); }
99
100 private:
101 // copy ctor and assignment operator are private because it doesn't make
102 // sense to copy files this way: attempt to do it will provoke a compile-time
103 // error.
104 wxFFile(const wxFFile&);
105 wxFFile& operator=(const wxFFile&);
106
107 FILE *m_fp; // IO stream or NULL if not opened
108
109 wxString m_name; // the name of the file (for diagnostic messages)
110 };
111
112 #endif // wxUSE_FFILE
113
114 #endif // _WX_FFILE_H_
115

  ViewVC Help
Powered by ViewVC 1.1.22