0ad/source/lib/file/file.h
janwas 34186dd017 refactor file interface. requires workspace update
- separate file_system_util into vfs functions (-> vfs/vfs_util) and
file_system (avoids ugly fs_util namespace prefix)
- get rid of non-portable O_BINARY_NP etc. flags
- use standard O_WRONLY etc. flags instead of LIO_WRITE; but avoid the
need for specifying O_CREAT|O_TRUNC
- only open files for aio when O_DIRECT is specified (which 0ad does
not) - avoids wasting time and security issues
- return file descriptor directly instead of via output param
- waio: safer FCB mechanism that avoids mixing descriptors between lowio
and aio

This was SVN commit r9550.
2011-05-25 10:39:13 +00:00

102 lines
2.3 KiB
C++

/* Copyright (c) 2010 Wildfire Games
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/*
* simple POSIX file wrapper.
*/
#ifndef INCLUDED_FILE
#define INCLUDED_FILE
#include "lib/os_path.h"
#include "lib/sysdep/filesystem.h" // O_*, S_*
namespace ERR
{
const Status FILE_ACCESS = -110300;
const Status FILE_NOT_FOUND = -110301;
}
// @param oflag: either O_RDONLY or O_WRONLY (in which case O_CREAT and
// O_TRUNC are added), plus O_DIRECT if aio is desired
// @return file descriptor or a negative Status
LIB_API Status FileOpen(const OsPath& pathname, int oflag);
LIB_API void FileClose(int& fd);
class File
{
public:
File()
: pathname(), fd(-1)
{
}
File(const OsPath& pathname, int oflag)
{
(void)Open(pathname, oflag);
}
~File()
{
Close();
}
Status Open(const OsPath& pathname, int oflag)
{
Status ret = FileOpen(pathname, oflag);
RETURN_STATUS_IF_ERR(ret);
this->pathname = pathname;
this->fd = (int)ret;
this->oflag = oflag;
return INFO::OK;
}
void Close()
{
FileClose(fd);
}
const OsPath& Pathname() const
{
return pathname;
}
int Descriptor() const
{
return fd;
}
int Flags() const
{
return oflag;
}
private:
OsPath pathname;
int fd;
int oflag;
};
typedef shared_ptr<File> PFile;
#endif // #ifndef INCLUDED_FILE