/////////////////////////////////////////////////////////////////////////////
-// Name: file.cpp
+// Name: file.h
// Purpose: wxFile - encapsulates low-level "file descriptor"
// wxTempFile - safely replace the old file
// Author: Vadim Zeitlin
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifndef __FILEH__
-#define __FILEH__
+#ifndef _WX_FILEH__
+#define _WX_FILEH__
-#ifdef __GNUG__
-#pragma interface "file.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_FILE
#include "wx/string.h"
#include "wx/filefn.h"
+#include "wx/strconv.h"
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
-// error return value for Seek() functions
-const off_t ofsInvalid = (off_t)-1;
+// we redefine these constants here because S_IREAD &c are _not_ standard
+// however, we do assume that the values correspond to the Unix umask bits
+#define wxS_IRUSR 00400
+#define wxS_IWUSR 00200
+#define wxS_IXUSR 00100
+
+#define wxS_IRGRP 00040
+#define wxS_IWGRP 00020
+#define wxS_IXGRP 00010
+
+#define wxS_IROTH 00004
+#define wxS_IWOTH 00002
+#define wxS_IXOTH 00001
+
+// default mode for the new files: corresponds to umask 022
+#define wxS_DEFAULT (wxS_IRUSR | wxS_IWUSR | wxS_IRGRP | wxS_IWGRP |\
+ wxS_IROTH | wxS_IWOTH)
// ----------------------------------------------------------------------------
// class wxFile: raw file IO
// NB: for space efficiency this class has no virtual functions, including
// dtor which is _not_ virtual, so it shouldn't be used as a base class.
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxFile
+
+class WXDLLIMPEXP_BASE wxFile
{
public:
// more file constants
// -------------------
-
// opening mode
- enum OpenMode { read, write, read_write, write_append };
+ enum OpenMode { read, write, read_write, write_append, write_excl };
// standard values for file descriptor
enum { fd_invalid = -1, fd_stdin, fd_stdout, fd_stderr };
// static functions
// ----------------
- static bool Exists(const char *sz); // also checks it's a regular file
+ // check whether a regular file by this name exists
+ static bool Exists(const wxString& name);
+ // check whether we can access the given file in given mode
+ // (only read and write make sense here)
+ static bool Access(const wxString& name, OpenMode mode);
// ctors
// -----
// def ctor
- wxFile() { m_fd = fd_invalid; }
+ wxFile() { m_fd = fd_invalid; m_error = false; }
// open specified file (may fail, use IsOpened())
- wxFile(const char *szFileName, OpenMode mode = read);
+ wxFile(const wxString& fileName, OpenMode mode = read);
// attach to (already opened) file
- wxFile(int fd) { m_fd = fd; }
+ wxFile(int lfd) { m_fd = lfd; m_error = false; }
// open/close
- bool Create(const char *szFileName, bool bOverwrite = FALSE);
- bool Open(const char *szFileName, OpenMode mode = read);
- inline bool Close(); // Close is a NOP if not opened
+ // create a new file (with the default value of bOverwrite, it will fail if
+ // the file already exists, otherwise it will overwrite it and succeed)
+ bool Create(const wxString& fileName, bool bOverwrite = false,
+ int access = wxS_DEFAULT);
+ bool Open(const wxString& fileName, OpenMode mode = read,
+ int access = wxS_DEFAULT);
+ bool Close(); // Close is a NOP if not opened
// assign an existing file descriptor and get it back from wxFile object
- void Attach(int fd) { Close(); m_fd = fd; }
+ void Attach(int lfd) { Close(); m_fd = lfd; m_error = false; }
void Detach() { m_fd = fd_invalid; }
int fd() const { return m_fd; }
// read/write (unbuffered)
- // returns number of bytes read or ofsInvalid on error
- off_t Read(void *pBuf, off_t nCount);
- // returns true on success
- uint Write(const void *pBuf, uint nCount);
+ // returns number of bytes read or wxInvalidOffset on error
+ ssize_t Read(void *pBuf, size_t nCount);
+ // returns the number of bytes written
+ size_t Write(const void *pBuf, size_t nCount);
// returns true on success
- bool Write(const wxString& s) { return Write(s.c_str(), s.Len()) != 0; }
+ bool Write(const wxString& s, const wxMBConv& conv = wxMBConvUTF8());
// flush data not yet written
bool Flush();
- // file pointer operations (return ofsInvalid on failure)
- // move ptr ofs bytes related to start/current off_t/end of file
- off_t Seek(off_t ofs, wxSeekMode mode = wxFromStart);
+ // file pointer operations (return wxInvalidOffset on failure)
+ // move ptr ofs bytes related to start/current offset/end of file
+ wxFileOffset Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
// move ptr to ofs bytes before the end
- off_t SeekEnd(off_t ofs = 0) { return Seek(ofs, wxFromEnd); }
- // get current off_t
- off_t Tell() const;
+ wxFileOffset SeekEnd(wxFileOffset ofs = 0) { return Seek(ofs, wxFromEnd); }
+ // get current offset
+ wxFileOffset Tell() const;
// get current file length
- off_t Length() const;
+ wxFileOffset Length() const;
// simple accessors
// is file opened?
bool IsOpened() const { return m_fd != fd_invalid; }
// is end of file reached?
bool Eof() const;
- // is an error occured?
+ // has an error occurred?
bool Error() const { return m_error; }
-
+ // type such as disk or pipe
+ wxFileKind GetKind() const { return wxGetFileKind(m_fd); }
+
// dtor closes the file if opened
- ~wxFile();
+ ~wxFile() { Close(); }
private:
// copy ctor and assignment operator are private because
// file (and close this one) or call Discard() to cancel the modification. If
// you call neither of them, dtor will call Discard().
// ----------------------------------------------------------------------------
-class wxTempFile
+
+class WXDLLIMPEXP_BASE wxTempFile
{
public:
// ctors
// is the file opened?
bool IsOpened() const { return m_file.IsOpened(); }
+ // get current file length
+ wxFileOffset Length() const { return m_file.Length(); }
+ // move ptr ofs bytes related to start/current offset/end of file
+ wxFileOffset Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart)
+ { return m_file.Seek(ofs, mode); }
+ // get current offset
+ wxFileOffset Tell() const { return m_file.Tell(); }
// I/O (both functions return true on success, false on failure)
- bool Write(const void *p, uint n) { return m_file.Write(p, n) != 0; }
- bool Write(const wxString& str) { return m_file.Write(str); }
+ bool Write(const void *p, size_t n) { return m_file.Write(p, n) == n; }
+ bool Write(const wxString& str, const wxMBConv& conv = wxMBConvUTF8())
+ { return m_file.Write(str, conv); }
// different ways to close the file
// validate changes and delete the old file of name m_strName
~wxTempFile();
private:
+ // no copy ctor/assignment operator
+ wxTempFile(const wxTempFile&);
+ wxTempFile& operator=(const wxTempFile&);
+
wxString m_strName, // name of the file to replace in Commit()
m_strTemp; // temporary file name
wxFile m_file; // the temporary file
};
-#endif
- // __FILEH__
+#endif // wxUSE_FILE
+
+#endif // _WX_FILEH__
projects / wxWidgets.git / blobdiff