/////////////////////////////////////////////////////////////////////////////
-// Name: ffile.h
+// Name: wx/ffile.h
// Purpose: wxFFile - encapsulates "FILE *" stream
// Author: Vadim Zeitlin
// Modified by:
// Created: 14.07.99
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_FFILE_H_
#define _WX_FFILE_H_
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "ffile.h"
#endif
+#include "wx/defs.h" // for wxUSE_FFILE
+
#if wxUSE_FFILE
#ifndef WX_PRECOMP
// dtor which is _not_ virtual, so it shouldn't be used as a base class.
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxFFile
+class WXDLLIMPEXP_BASE wxFFile
{
public:
// ctors
// def ctor
wxFFile() { m_fp = NULL; }
// open specified file (may fail, use IsOpened())
- wxFFile(const wxChar *filename, const char *mode = "r");
+ wxFFile(const wxChar *filename, const wxChar *mode = _T("r"));
// attach to (already opened) file
wxFFile(FILE *fp) { m_fp = fp; }
// open/close
// open a file (existing or not - the mode controls what happens)
- bool Open(const wxChar *filename, const char *mode = "r");
+ bool Open(const wxChar *filename, const wxChar *mode = _T("r"));
// closes the opened file (this is a NOP if not opened)
bool Close();
// assign an existing file descriptor and get it back from wxFFile object
- void Attach(FILE *fp, const wxString& name = wxT(""))
+ void Attach(FILE *fp, const wxString& name = wxEmptyString)
{ Close(); m_fp = fp; m_name = name; }
void Detach() { m_fp = NULL; }
FILE *fp() const { return m_fp; }
// returns the number of bytes written
size_t Write(const void *pBuf, size_t nCount);
// returns true on success
- bool Write(const wxString& s, wxMBConv& conv = wxConvLibc)
+ bool Write(const wxString& s, wxMBConv& conv = wxConvUTF8)
{
const wxWX2MBbuf buf = s.mb_str(conv);
size_t size = strlen(buf);
// file pointer operations (return ofsInvalid on failure)
// move ptr ofs bytes related to start/current pos/end of file
- bool Seek(long ofs, wxSeekMode mode = wxFromStart);
+ bool Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
// move ptr to ofs bytes before the end
- bool SeekEnd(long ofs = 0) { return Seek(ofs, wxFromEnd); }
+ bool SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
// get current position in the file
- size_t Tell() const;
+ wxFileOffset Tell() const;
// get current file length
- size_t Length() const;
+ wxFileOffset Length() const;
- // simple accessors
+ // simple accessors: note that Eof() and Error() may only be called if
+ // IsOpened()!
// is file opened?
bool IsOpened() const { return m_fp != NULL; }
// is end of file reached?
bool Error() const { return ferror(m_fp) != 0; }
// get the file name
const wxString& GetName() const { return m_name; }
+ // type such as disk or pipe
+ wxFileKind GetKind() const { return wxGetFileKind(m_fp); }
// dtor closes the file if opened
~wxFFile() { Close(); }