input_env Class Reference

#include <env.h>

Inheritance diagram for input_env:

input_ty

Public Member Functions

virtual ~input_env ()
 input_env (const nstring &name)
nstring name ()
long length ()
long read_inner (void *data, size_t nbytes)
long ftell_inner ()

Private Member Functions

 input_env ()
 input_env (const input_env &arg)
input_envoperator= (const input_env &arg)

Private Attributes

nstring gname
nstring base
size_t pos

Detailed Description

Definition at line 25 of file env.h.


Constructor & Destructor Documentation

virtual input_env::~input_env (  )  [virtual]

The destructor.

input_env::input_env ( const nstring name  ) 

The constructor.

input_env::input_env (  )  [private]

The default constructor. Do not use.

input_env::input_env ( const input_env arg  )  [private]

The copy constructor. Do not use.


Member Function Documentation

nstring input_env::name (  )  [virtual]

The name method is used to determine the name of the input.

Implements input_ty.

long input_env::length (  )  [virtual]

The length method is used to determine the length of the input. May return -1 if the length is unknown.

Implements input_ty.

long input_env::read_inner ( void *  data,
size_t  nbytes 
) [virtual]

The read_inner method is used to read unbuffered data from the given input stream. At most nbytes bytes will be read into data. The number of bytes actually read will be returned. At end-of-file, a value <= 0 will be returned, and data will be unchanged. All file read errors or format errors are fatal, and will cause the method to not return.

Parameters:
data Where to put the results of the read.
nbytes The maximum number of bytes to read.
Returns:
The actual number of bytes read, or zero for end-of-file.

Implements input_ty.

long input_env::ftell_inner (  )  [virtual]

The ftell_inner method is used to determine the unbuffered current position within the input.

Implements input_ty.

input_env& input_env::operator= ( const input_env arg  )  [private]

The assignment operator. Do not use.


Field Documentation

Definition at line 52 of file env.h.

Definition at line 53 of file env.h.

size_t input_env::pos [private]

Definition at line 54 of file env.h.


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

Generated on Wed Mar 12 23:37:40 2008 for Aegis by  doxygen 1.5.5