lestes::lang::cplus::lex::named_istream Class Reference

Named input stream. More...

#include <named_istream.hh>

Inheritance diagram for lestes::lang::cplus::lex::named_istream:

Inheritance graph
[legend]
List of all members.

Public Member Functions

lstring file_name_get (void) const
 Returns file name of the source file.
lstring print_name_get (void) const
 Returns print name of the stream.
ptr< istream_wrapper > stream_get (void) const
 Returns the stream.

Static Public Member Functions

static ptr< named_istreamcreate (const ptr< istream_wrapper > &a_stream, const lstring &a_file_name, const lstring &a_print_name)
 Returns new instance.

Protected Member Functions

 named_istream (const ptr< istream_wrapper > &a_stream, const lstring &a_file_name, const lstring &a_print_name)
 Creates the object.
virtual void gc_mark (void)
 Marks the object.

Private Member Functions

 named_istream (const named_istream &)
 Hides copy constructor.
named_istreamoperator= (const named_istream &)
 Hides assignment operator.

Private Attributes

srp< istream_wrapper > stream
 The input stream.
lstring file_name
 The file path and name.
lstring print_name
 The print name of the stream.

Detailed Description

Named input stream.

Represents input stream with associated file name and print name of the stream.


Constructor & Destructor Documentation

lestes::lang::cplus::lex::named_istream::named_istream ( const ptr< istream_wrapper > &  a_stream,
const lstring &  a_file_name,
const lstring &  a_print_name 
) [protected]

Creates the object.

Creates the object.

Parameters:
a_stream The represented stream.
a_file_name The path and name of the associated file.
a_print_name The print name of the associated file.

lestes::lang::cplus::lex::named_istream::named_istream ( const named_istream  )  [private]

Hides copy constructor.


Member Function Documentation

lstring lestes::lang::cplus::lex::named_istream::file_name_get ( void   )  const

Returns file name of the source file.

Returns the name of the associated file.

Returns:
The path and file name.

lstring lestes::lang::cplus::lex::named_istream::print_name_get ( void   )  const

Returns print name of the stream.

Returns the print name of the stream

Returns:
The print name, usually the file name itself.

ptr< istream_wrapper > lestes::lang::cplus::lex::named_istream::stream_get ( void   )  const

Returns the stream.

Returns the represented stream.

Returns:
The stream.

ptr< named_istream > lestes::lang::cplus::lex::named_istream::create ( const ptr< istream_wrapper > &  a_stream,
const lstring &  a_file_name,
const lstring &  a_print_name 
) [static]

Returns new instance.

Returns the named input stream.

Precondition:
a_stream != NULL
Parameters:
a_stream The represented stream.
a_file_name The name of the associated file.
a_print_name The print name of the associated file.

void lestes::lang::cplus::lex::named_istream::gc_mark ( void   )  [protected, virtual]

Marks the object.

Marks the object.

Reimplemented from lestes::std::mem::keystone.

named_istream& lestes::lang::cplus::lex::named_istream::operator= ( const named_istream  )  [private]

Hides assignment operator.


Member Data Documentation

srp<istream_wrapper> lestes::lang::cplus::lex::named_istream::stream [private]

The input stream.

lstring lestes::lang::cplus::lex::named_istream::file_name [private]

The file path and name.

lstring lestes::lang::cplus::lex::named_istream::print_name [private]

The print name of the stream.


The documentation for this class was generated from the following files:
Generated on Mon Feb 12 18:43:47 2007 for lestes by doxygen 1.5.1-20070107