#include <remove_hash_comments.h>
Public Member Functions | |
| virtual | ~input_remove_hash_comments () |
Static Public Member Functions | |
| static pointer | create (const input::pointer &deeper) |
Private Types | |
| enum | state_t { state_start_of_line, state_white_space, state_discarding, state_content } |
Private Member Functions | |
| input_remove_hash_comments (const input::pointer &deeper) | |
| size_t | read_inner (source_location &data_locn, void *data, size_t data_size) |
| input_remove_hash_comments () | |
| input_remove_hash_comments (const input_remove_hash_comments &rhs) | |
| input_remove_hash_comments & | operator= (const input_remove_hash_comments &rhs) |
Private Attributes | |
| input::pointer | deeper |
| state_t | state |
| rcstring_accumulator | whitespace |
Detailed Description
The input_remove_hash_comments class is used to represent the processing required to remove # comments from an input stream.
Definition at line 29 of file remove_hash_comments.h.
Member Enumeration Documentation
enum input_remove_hash_comments::state_t [private] |
Definition at line 63 of file remove_hash_comments.h.
Constructor & Destructor Documentation
| input_remove_hash_comments::~input_remove_hash_comments | ( | ) | [virtual] |
The destructor.
Definition at line 24 of file remove_hash_comments.cc.
| input_remove_hash_comments::input_remove_hash_comments | ( | const input::pointer & | deeper | ) | [private] |
The constructor. It is private on purpose, use the create class method instead.
- Parameters:
-
deeper The input source to be filtered to remove # comments.
Definition at line 29 of file remove_hash_comments.cc.
| input_remove_hash_comments::input_remove_hash_comments | ( | ) | [private] |
The default constructor. Do not use.
| input_remove_hash_comments::input_remove_hash_comments | ( | const input_remove_hash_comments & | rhs | ) | [private] |
The copy constructor. Do not use.
- Parameters:
-
rhs The right hand side of the initialization.
Member Function Documentation
| input_remove_hash_comments::pointer input_remove_hash_comments::create | ( | const input::pointer & | deeper | ) | [static] |
The create class method is used to create new dynamically allocated instances of this class.
- Parameters:
-
deeper The input sourec to be filtered to remove # comments.
Definition at line 39 of file remove_hash_comments.cc.
| input_remove_hash_comments& input_remove_hash_comments::operator= | ( | const input_remove_hash_comments & | rhs | ) | [private] |
The assignment operator. Do not use.
- Parameters:
-
rhs The right hand side of the assignment.
| size_t input_remove_hash_comments::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.
Definition at line 46 of file remove_hash_comments.cc.
Field Documentation
The deeper instance variable is used to remember the input source to be filtered to remove # comments.
Definition at line 61 of file remove_hash_comments.h.
state_t input_remove_hash_comments::state [private] |
Definition at line 71 of file remove_hash_comments.h.
Definition at line 73 of file remove_hash_comments.h.
The documentation for this class was generated from the following files:
- lib/input/remove_hash_comments.h
- lib/input/remove_hash_comments.cc
