]> git.saurik.com Git - wxWidgets.git/blame - include/wx/ffile.h
Added simplistic makefile/project files for wxWinCE.
[wxWidgets.git] / include / wx / ffile.h
CommitLineData
a1b82138 1/////////////////////////////////////////////////////////////////////////////
0e0a4e64 2// Name: wx/ffile.h
a1b82138
VZ
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 license
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_FFILE_H_
13#define _WX_FFILE_H_
14
af49c4b8 15#if defined(__GNUG__) && !defined(__APPLE__)
a1b82138
VZ
16 #pragma interface "ffile.h"
17#endif
18
0e0a4e64
VZ
19#include "wx/defs.h" // for wxUSE_FFILE
20
1e6feb95 21#if wxUSE_FFILE
a1b82138
VZ
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
37class WXDLLEXPORT wxFFile
38{
39public:
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 char *mode = "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 char *mode = "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
223d09f6 56 void Attach(FILE *fp, const wxString& name = wxT(""))
a1b82138
VZ
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);
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
f6bcfd97 70 bool Write(const wxString& s, wxMBConv& conv = wxConvLibc)
a1b82138 71 {
f6bcfd97
BP
72 const wxWX2MBbuf buf = s.mb_str(conv);
73 size_t size = strlen(buf);
74 return Write((const char *)buf, size) == size;
a1b82138
VZ
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(long ofs, wxSeekMode mode = wxFromStart);
82 // move ptr to ofs bytes before the end
83 bool SeekEnd(long ofs = 0) { return Seek(ofs, wxFromEnd); }
84 // get current position in the file
85 size_t Tell() const;
86 // get current file length
87 size_t Length() const;
88
89 // simple accessors
90 // is file opened?
91 bool IsOpened() const { return m_fp != NULL; }
92 // is end of file reached?
93 bool Eof() const { return feof(m_fp) != 0; }
94 // is an error occured?
95 bool Error() const { return ferror(m_fp) != 0; }
96 // get the file name
97 const wxString& GetName() const { return m_name; }
98
99 // dtor closes the file if opened
100 ~wxFFile() { Close(); }
101
102private:
103 // copy ctor and assignment operator are private because it doesn't make
104 // sense to copy files this way: attempt to do it will provoke a compile-time
105 // error.
106 wxFFile(const wxFFile&);
107 wxFFile& operator=(const wxFFile&);
108
109 FILE *m_fp; // IO stream or NULL if not opened
110
111 wxString m_name; // the name of the file (for diagnostic messages)
112};
113
1e6feb95 114#endif // wxUSE_FFILE
a1b82138
VZ
115
116#endif // _WX_FFILE_H_
117