ders::file Class Reference

Provides file I/O operations. More...

#include <file.hpp>

Inheritance diagram for ders::file:

List of all members.

Public Types
enum	mode { rdo, wro, rdwr }
	file open modes More...
enum	flags { app = 1, crt = 2, excl = 4, trnc = 8 }
	file open flags More...
enum	whence { set, cur, end }
	seek whence More...
Public Member Functions
	file (mem_pool &m)
	file (mem_pool &m, const ch_rng &path, mode md, int fls)
	file (mem_pool &m, int fd)
	~file ()
virtual void	destroy (mem_pool &mp2)
mem_pool &	pool () const
bool	is_ok () const
bool	is_opened () const
bool	is_owned () const
int	get_fd () const
const sh_text &	get_name () const
error	get_err () const
bool	open (const ch_rng &path, mode md, int fls)
bool	close ()
bool	attach (int fd)
bool	detach ()
virtual int	read (void *buf, int n)
int	read (sh_text &buf, int n)
virtual int	write (const void *buf, int n)
int	write (const ch_rng &r)
int	tell ()
int	seek (int off, whence wh)
void	ex_is_ok () const
void	ex_open (const ch_rng &path, mode md, int fls)
void	ex_close ()
void	ex_attach (int fd)
void	ex_detach ()
int	ex_read (void *buf, int n)
int	ex_read (sh_text &buf, int n)
int	ex_write (const void *buf, int n)
int	ex_write (const ch_rng &r)
int	ex_tell ()
int	ex_seek (int off, whence wh)
Protected Member Functions
void	operator delete (void *ptr, size_t size)
Static Protected Member Functions
template<class T>
static void	destroy_this (T *ptr, mem_pool &mp2)

---

Detailed Description

Provides file I/O operations.

Definition at line 31 of file file.hpp.

---

Member Enumeration Documentation

enum ders::file::mode

file open modes

Enumerator:

rdo
wro
rdwr

Definition at line 34 of file file.hpp.

{ rdo, wro, rdwr };

enum ders::file::flags

file open flags

Enumerator:

app
crt
excl
trnc

Definition at line 36 of file file.hpp.

{ app=1, crt=2, excl=4, trnc=8 };

enum ders::file::whence

seek whence

Enumerator:

set
cur
end

Definition at line 38 of file file.hpp.

{ set, cur, end };

---

Constructor & Destructor Documentation

ders::file::file

(

mem_pool &

m

)

Definition at line 33 of file file.cpp.

                      : mp(m), name(nt(m))
{
 init();
}

ders::file::file	(	mem_pool &	m,
		const ch_rng &	path,
		mode	md,
		int	fls
	)

Definition at line 38 of file file.cpp.

                                                            :
  mp(m), name(nt(m))
{
 init();
 ex_open(path, md, fls);
}

ders::file::file	(	mem_pool &	m,
		int	fd
	)

Definition at line 45 of file file.cpp.

                              : mp(m), name(nt(m))
{
 init();
 ex_attach(fd);
}

ders::file::~file

(

)

Definition at line 51 of file file.cpp.

{
 if (is_owned() && is_opened()) close();
}

---

Member Function Documentation

virtual void ders::file::destroy

(

mem_pool &

mp2

)

[inline, virtual]

Implements ders::destroyable.

Definition at line 58 of file file.hpp.

{ destroy_this(this, mp2); }

mem_pool& ders::file::pool

(

)

const [inline]

Definition at line 60 of file file.hpp.

{ return mp; }

bool ders::file::is_ok

(

)

const [inline]

Definition at line 62 of file file.hpp.

{ return get_err()==ezero; }

bool ders::file::is_opened

(

)

const [inline]

Definition at line 63 of file file.hpp.

{ return get_fd()!=-1; }

bool ders::file::is_owned

(

)

const [inline]

Definition at line 64 of file file.hpp.

{ return own; }

int ders::file::get_fd

(

)

const [inline]

Definition at line 66 of file file.hpp.

{ return fdr; }

const sh_text& ders::file::get_name

(

)

const [inline]

Definition at line 67 of file file.hpp.

{ return name; }

error ders::file::get_err

(

)

const [inline]

Definition at line 68 of file file.hpp.

{ return err; }

bool ders::file::open	(	const ch_rng &	path,
		mode	md,
		int	fls
	)

Definition at line 56 of file file.cpp.

{
 assert(!is_opened());

 fdr=fd::open(nt(mp, path)->c_str(), md, fls, err);
 if (fdr==-1) return false;

 own=true;
 *name=path;

 return true;
}

bool ders::file::close

(

)

Definition at line 69 of file file.cpp.

{
 assert(is_owned());

 bool rc=fd::close(fdr, err);
 if (!rc) return false;

 init();
 return true;
}

bool ders::file::attach

(

int

fd

)

Definition at line 80 of file file.cpp.

{
 assert(!is_opened());

 if (fd<0) {
    err=ebadf;
    return false;
 }

 fdr=fd;
 own=false;
 *name=text_buf(mp)+"(attached to "+fdr+')';
 err=ezero;

 return true;
}

bool ders::file::detach

(

)

Definition at line 97 of file file.cpp.

{
 assert(is_opened());

 init();
 return true;
}

int ders::file::read	(	void *	buf,
		int	n
	)			[virtual]

Implements ders::readable.

Definition at line 105 of file file.cpp.

{
 assert(n>=0);

 if (n==0) {
    err=ezero;
    return 0;
 }

 return fd::read(fdr, buf, n, err);
}

int ders::file::read	(	sh_text &	buf,
		int	n
	)

Definition at line 117 of file file.cpp.

{
 assert(n>=0);

 buf->clear();
 buf->reserve(n);

 int rc=read(buf->begin(), n);
 assert(rc<=n);
 if (rc!=-1) buf->uninitialized_resize(rc);

 return rc;
}

int ders::file::write	(	const void *	buf,
		int	n
	)			[virtual]

Implements ders::writable.

Definition at line 131 of file file.cpp.

{
 assert(n>=0);

 if (n==0) {
    err=ezero;
    return 0;
 }

 return fd::write(fdr, buf, n, err);
}

int ders::file::write

(

const ch_rng &

r

)

[inline]

Definition at line 80 of file file.hpp.

{ return write(r.beg, r.size()); }

int ders::file::tell

(

)

[inline]

Definition at line 82 of file file.hpp.

{ return seek(0, cur); }

int ders::file::seek	(	int	off,
		whence	wh
	)

Definition at line 143 of file file.cpp.

{
 return fd::seek(fdr, off, wh, err);
}

void ders::file::ex_is_ok

(

)

const

Definition at line 148 of file file.cpp.

{
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "File error", get_err(),
      get_name());
 }
}

void ders::file::ex_open	(	const ch_rng &	path,
		mode	md,
		int	fls
	)

Definition at line 156 of file file.cpp.

{
 open(path, md, fls);
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "Can't open file", get_err(),
      path);
 }
}

void ders::file::ex_close

(

)

Definition at line 165 of file file.cpp.

{
 close();
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "Can't close file", get_err(),
      get_name());
 }
}

void ders::file::ex_attach

(

int

fd

)

Definition at line 174 of file file.cpp.

{
 attach(fd);
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, text_buf(mp)+"Can't attach to \""+
      fd+"\"", get_err(), get_name());
 }
}

void ders::file::ex_detach

(

)

Definition at line 183 of file file.cpp.

{
 detach();
 if (!is_ok())
    throw newFileErrorException(mp, _FLINE_, "Can't detach", get_err(),
      get_name());
}

int ders::file::ex_read	(	void *	buf,
		int	n
	)

Definition at line 191 of file file.cpp.

{
 int rc=read(buf, n);
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "Can't read from file", get_err(),
      get_name());
 }

 return rc;
}

int ders::file::ex_read	(	sh_text &	buf,
		int	n
	)

Definition at line 202 of file file.cpp.

{
 int rc=read(buf, n);
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "Can't read from file", get_err(),
      get_name());
 }

 return rc;
}

int ders::file::ex_write	(	const void *	buf,
		int	n
	)

Definition at line 213 of file file.cpp.

{
 int rc=write(buf, n);
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "Can't write to file", get_err(),
      get_name());
 }

 return rc;
}

int ders::file::ex_write

(

const ch_rng &

r

)

[inline]

Definition at line 93 of file file.hpp.

{ return ex_write(r.beg, r.size()); }

int ders::file::ex_tell

(

)

Definition at line 224 of file file.cpp.

{
 int rc=tell();
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "Can't tell on file", get_err(),
      get_name());
 }

 return rc;
}

int ders::file::ex_seek	(	int	off,
		whence	wh
	)

Definition at line 235 of file file.cpp.

{
 int rc=seek(off, wh);
 if (!is_ok()) {
    throw newFileErrorException(mp, _FLINE_, "Can't seek on file", get_err(),
      get_name());
 }

 return rc;
}

template<class T>

void ders::destroyable::destroy_this	(	T *	ptr,
		mem_pool &	mp2
	)			[inline, static, protected, inherited]

Definition at line 47 of file destroy.hpp.

{
 assert(typeid(*ptr)==typeid(T));

 ptr->~T();
 mp2.deallocate(ptr, sizeof(T));
}

void ders::destroyable::operator delete	(	void *	ptr,
		size_t	size
	)			[inline, protected, inherited]

Definition at line 39 of file destroy.hpp.

{ hard_assert(false); }

---

The documentation for this class was generated from the following files:

• file.hpp
• file.cpp