#include <file.h>
Inheritance diagram for input_file:
Public Member Functions | |
| virtual | ~input_file () |
Static Public Member Functions | |
| static input::pointer | create (const rcstring &filename) |
Private Member Functions | |
| input_file (const rcstring &filename) | |
| size_t | read_inner (source_location &data_locn, void *data, size_t data_size) |
| input_file () | |
| input_file (const input_file &rhs) | |
| input_file & | operator= (const input_file &rhs) |
Private Attributes | |
| rcstring | filename |
| int | line_number |
| int | fd |
Detailed Description
The input_file class is used to represent the processing required to read input from a file.
Constructor & Destructor Documentation
| input_file::~input_file | ( | ) | [virtual] |
| input_file::input_file | ( | const rcstring & | filename | ) | [private] |
| input_file::input_file | ( | ) | [private] |
The default constructor. Do not use.
| input_file::input_file | ( | const input_file & | rhs | ) | [private] |
The copy constructor. Do not use.
- Parameters:
-
rhs The right hand side of the initialization.
Member Function Documentation
| input::pointer input_file::create | ( | const rcstring & | filename | ) | [static] |
| input_file& input_file::operator= | ( | const input_file & | rhs | ) | [private] |
The assignment operator. Do not use.
- Parameters:
-
rhs The right hand side of the assignment.
| size_t input_file::read_inner | ( | source_location & | data_locn, |
| void * | data, | ||
| size_t | data_size | ||
| ) | [private, virtual] |
The read_inner method is called byu the underflow method to fill the buffer buf with more data.
- Parameters:
-
data_locn The location of the beginning of the returned data. It is the first argument because it's position is immediately before the returned data. data pointer to the base of an array to receive the data data_size the maximum number of bytes of data than can be received into the data array.
- Returns:
- The nunber of bytes read into data, or 0 at end of file. always <= data_size
Implements input.
Field Documentation
int input_file::fd [private] |
rcstring input_file::filename [private] |
int input_file::line_number [private] |
The line_number instance variable is used to remember the line number we are up to, relative to the read_inner method.
The documentation for this class was generated from the following files:
