/////////////////////////////////////////////////////////////////////////////
-// 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__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "file.h"
#endif
-#include "wx/string.h"
-#include "wx/filefn.h"
+#ifndef WX_PRECOMP
+ #include "wx/string.h"
+ #include "wx/filefn.h"
+ #include "wx/strconv.h"
+#endif
+
+#if wxUSE_FILE
// ----------------------------------------------------------------------------
// 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 wxChar *name);
+ // check whetther we can access the given file in given mode
+ // (only read and write make sense here)
+ static bool Access(const wxChar *name, OpenMode mode);
// ctors
// -----
// def ctor
wxFile() { m_fd = fd_invalid; }
// open specified file (may fail, use IsOpened())
- wxFile(const char *szFileName, OpenMode mode = read);
+ wxFile(const wxChar *szFileName, OpenMode mode = read);
// attach to (already opened) file
wxFile(int fd) { m_fd = fd; }
// 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 wxChar *szFileName, bool bOverwrite = FALSE,
+ int access = wxS_DEFAULT);
+ bool Open(const wxChar *szFileName, 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; }
// read/write (unbuffered)
// returns number of bytes read or ofsInvalid on error
off_t Read(void *pBuf, off_t nCount);
+ // returns the number of bytes written
+ size_t Write(const void *pBuf, size_t nCount);
// returns true on success
- uint Write(const void *pBuf, uint nCount);
- // returns true on success
- bool Write(const wxString& s) { return Write(s.c_str(), s.Len()) != 0; }
+ bool Write(const wxString& s, wxMBConv& conv = wxConvUTF8)
+ {
+ const wxWX2MBbuf buf = s.mb_str(conv);
+ size_t size = strlen(buf);
+ return Write((const char *) buf, size) == size;
+ }
// flush data not yet written
bool Flush();
bool IsOpened() const { return m_fd != fd_invalid; }
// is end of file reached?
bool Eof() const;
- // is an error occured?
+ // has an error occured?
bool Error() const { return m_error; }
-
+
// 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
bool IsOpened() const { return m_file.IsOpened(); }
// 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) != 0; }
+ bool Write(const wxString& str, wxMBConv& conv = wxConvUTF8)
+ { 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