OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
FileStream Class Reference

A stream of input tokens. More...

#include <FileStream.h>

Inheritance diagram for FileStream:
Inheritance graph
Collaboration diagram for FileStream:
Collaboration graph

Public Member Functions

 FileStream (const std::string &name)
 Constructor. More...
 
virtual ~FileStream ()
 Destructor. More...
 
virtual bool fillLine ()
 Read next input line. More...
 
virtual Token readToken ()
 Read single token from file. More...
 
void putBack (const Token &token)
 Put token back to stream. More...
 
const std::string & getName () const
 Return stream name. More...
 
int getLine () const
 Return line number. More...
 
int addReference () const
 Increment reference count. More...
 
int removeReference () const
 Decrement the reference count. More...
 
bool isShared () const
 Test for sharing. More...
 

Static Public Member Functions

static void setEcho (bool flag)
 Set echo flag. More...
 
static bool getEcho ()
 Return echo flag. More...
 

Protected Member Functions

Token readNumber ()
 
Token readString ()
 
Token readWord ()
 
bool skipComments ()
 

Protected Attributes

std::string line
 
int curr_char
 
std::string stream_name
 
int curr_line
 
bool put_back_flag
 
Token put_back
 

Private Member Functions

 FileStream ()
 
 FileStream (const FileStream &)
 
void operator= (const FileStream &)
 

Private Attributes

std::ifstream is
 
int refCount
 

Static Private Attributes

static bool echoFlag = false
 

Detailed Description

A stream of input tokens.

Definition at line 32 of file FileStream.h.

Constructor & Destructor Documentation

◆ FileStream() [1/3]

FileStream::FileStream ( const std::string &  name)
explicit

Constructor.

Definition at line 33 of file FileStream.cpp.

References is, and name.

◆ ~FileStream()

FileStream::~FileStream ( )
virtual

Destructor.

Definition at line 43 of file FileStream.cpp.

◆ FileStream() [2/3]

FileStream::FileStream ( )
private

◆ FileStream() [3/3]

FileStream::FileStream ( const FileStream )
private

Member Function Documentation

◆ addReference()

int RCObject::addReference ( ) const
inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References RCObject::refCount.

Referenced by Pointer< Object >::operator=(), and Pointer< Object >::unique().

◆ fillLine()

bool FileStream::fillLine ( )
virtual

Read next input line.

Implements AbsFileStream.

Definition at line 57 of file FileStream.cpp.

References AbsFileStream::curr_char, TokenStream::curr_line, echoFlag, is, AbsFileStream::line, IpplInfo::myNode(), and TokenStream::stream_name.

Here is the call graph for this function:

◆ getEcho()

bool FileStream::getEcho ( )
static

Return echo flag.

Definition at line 52 of file FileStream.cpp.

References echoFlag.

◆ getLine()

int TokenStream::getLine ( ) const
inherited

Return line number.

Definition at line 49 of file TokenStream.cpp.

References TokenStream::curr_line.

◆ getName()

const std::string & TokenStream::getName ( ) const
inherited

Return stream name.

Definition at line 54 of file TokenStream.cpp.

References TokenStream::stream_name.

◆ isShared()

bool RCObject::isShared ( ) const
inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References RCObject::refCount.

◆ operator=()

void FileStream::operator= ( const FileStream )
private

◆ putBack()

void TokenStream::putBack ( const Token token)
inherited

Put token back to stream.

Definition at line 38 of file TokenStream.cpp.

References TokenStream::put_back, and TokenStream::put_back_flag.

Referenced by IfStatement::IfStatement().

◆ readNumber()

Token AbsFileStream::readNumber ( )
protectedinherited

◆ readString()

Token AbsFileStream::readString ( )
protectedinherited

◆ readToken()

◆ readWord()

Token AbsFileStream::readWord ( )
protectedinherited

◆ removeReference()

int RCObject::removeReference ( ) const
inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ setEcho()

void FileStream::setEcho ( bool  flag)
static

Set echo flag.

Definition at line 47 of file FileStream.cpp.

References echoFlag.

Referenced by Option::execute(), opalMain(), and Option::Option().

◆ skipComments()

bool AbsFileStream::skipComments ( )
protectedinherited

Definition at line 278 of file AbsFileStream.cpp.

References AbsFileStream::curr_char, AbsFileStream::fillLine(), AbsFileStream::line, and AbsFileStream::skipComments().

Referenced by AbsFileStream::readToken(), and AbsFileStream::skipComments().

Here is the call graph for this function:

Member Data Documentation

◆ curr_char

int AbsFileStream::curr_char
protectedinherited

◆ curr_line

◆ echoFlag

bool FileStream::echoFlag = false
staticprivate

Definition at line 66 of file FileStream.h.

Referenced by fillLine(), getEcho(), and setEcho().

◆ is

std::ifstream FileStream::is
private

Definition at line 63 of file FileStream.h.

Referenced by FileStream(), and fillLine().

◆ line

std::string AbsFileStream::line
protectedinherited

◆ put_back

Token TokenStream::put_back
protectedinherited

◆ put_back_flag

bool TokenStream::put_back_flag
protectedinherited

◆ refCount

int RCObject::refCount
mutableprivateinherited

◆ stream_name


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