arglex_source_file Class Reference

#include <file.h>

Inheritance diagram for arglex_source_file:

Public Member Functions
virtual	~arglex_source_file ()
Static Public Member Functions
static pointer	create (const rcstring &filename)
Protected Member Functions
bool	next (source_location &result_locn, rcstring &result)
Private Member Functions
	arglex_source_file (const rcstring &filename)
	arglex_source_file ()
	arglex_source_file (const arglex_source_file &rhs)
arglex_source_file &	operator= (const arglex_source_file &rhs)
Private Attributes
input::pointer	ip

---

Detailed Description

The arglex_source_file class is used to represent the process of reading command line options from the text file.

There is no quoting mechanism available.

Definition at line 31 of file file.h.

---

Constructor & Destructor Documentation

arglex_source_file::~arglex_source_file

(

)

[virtual]

The destructor.

Definition at line 24 of file file.cc.

arglex_source_file::arglex_source_file

(

const rcstring &

filename

)

[private]

The constructor. It is private on purpose, use the create class method instead.

Parameters:

filename

The name of the file to be read.

Definition at line 29 of file file.cc.

arglex_source_file::arglex_source_file

(

)

[private]

The default constructor. Do not use.

arglex_source_file::arglex_source_file

(

const arglex_source_file &

rhs

)

[private]

The copy constructor. Do not use.

Parameters:

rhs	The right hand side of the initialization.

---

Member Function Documentation

arglex_source_file::pointer arglex_source_file::create

(

const rcstring &

filename

)

[static]

The create class method is used to create new dynamically allocated instances of this class.

Parameters:

filename

The name of the file to be read.

Definition at line 38 of file file.cc.

bool arglex_source_file::next	(	source_location &	result_locn,
		rcstring &	result
	)		[protected, virtual]

The next method is used to obtain the next command line argument from the command line source.

Parameters:

result_locn	the read position immidately before the result.
result	where to put the command line argument

Returns:

true if argument was available, false if end of line (or end of file, etc).

Implements arglex_source.

Definition at line 45 of file file.cc.

arglex_source_file& arglex_source_file::operator=

(

const arglex_source_file &

rhs

)

[private]

The assignment operator. Do not use.

Parameters:

rhs	The right hand side of the assignment.

---

Field Documentation

input::pointer arglex_source_file::ip [private]

The ip instance variable is used to remember where to read the aguments text from.

Definition at line 67 of file file.h.

---

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

• lib/arglex/source/file.h
• lib/arglex/source/file.cc