#include <LineReader.hh>

Inheritance diagram for LineReader:

Collaboration diagram for LineReader:

Public Member Functions
	LineReader (std::istream &iStream=std::cin, std::ostream &oStream=std::cout)

virtual	~LineReader ()

virtual void	initialize (std::string defPrompt="", FILE in=stdin, FILE out=stdout, FILE *err=stderr)=0

virtual std::string	readLine (std::string prompt="")=0

virtual std::ostream &	outputStream ()

virtual char	charQuestion (std::string question, std::string allowedChars, bool caseSensitive=false, char defaultAnswer='\0')=0

bool	confirmation (std::string question, char defaultAnswer='n', char yesChar='y', char noChar='n')

virtual void	setSaveInputHistoryToFile (bool flag)

virtual bool	saveInputHistoryToFile () const

virtual void	setInputHistoryLog (const std::string &historyFilename)

virtual void	setInputHistoryLength (std::size_t length)

virtual size_t	inputHistoryMaxLength () const

virtual std::size_t	inputsInHistory () const

virtual std::string	inputHistoryEntry (std::size_t age) const

Protected Member Functions
void	setInitialized ()

bool	initialized () const

void	putInInputHistory (const std::string &inputLine)

Private Member Functions
	LineReader (const LineReader &)
	Copying not allowed.

LineReader &	operator= (const LineReader &)
	Assignment not allowed.

Private Attributes
bool	initialized_
	Flag indicating whether LineReader is initialized.

std::deque< std::string >	inputHistory_
	The input history.

std::size_t	inputHistorySize_
	The maximum size for input history.

bool	saveHistoryToFile_
	Should the history be appended in a file?

std::ofstream *	historyFile_
	The output stream to write the command history to.

std::string	historyFilename_
	The filename to write the command history to.

std::istream &	iStream_
	The input stream.

std::ostream &	oStream_
	The output stream.

Detailed Description

Abstract base class for line readers.

LineReader's purpose is to handle reading from command line and to make it possible for the user to edit the input given to program.

Definition at line 52 of file LineReader.hh.

Constructor & Destructor Documentation

◆ LineReader() [1/2]

LineReader::LineReader	(	std::istream &	iStream = `std::cin`,
		std::ostream &	oStream = `std::cout`
	)

Constructor.

Definition at line 48 of file LineReader.cc.

                                                               : 
    initialized_(false), inputHistorySize_(DEFAULT_INPUT_HISTORY_SIZE), 
    saveHistoryToFile_(false), historyFile_(NULL), 
    historyFilename_("commandhistory.txt"), iStream_(iStream),
    oStream_(oStream) {
}

◆ ~LineReader()

LineReader::~LineReader ( )

virtual

Destructor.

Definition at line 58 of file LineReader.cc.

                        {
    if (historyFile_ != NULL) {
        historyFile_->close();
        delete historyFile_;
        historyFile_ = NULL;
    }
}

References historyFile_.

◆ LineReader() [2/2]

LineReader::LineReader ( const LineReader & )

private

Copying not allowed.

Member Function Documentation

◆ charQuestion()

virtual char LineReader::charQuestion	(	std::string	question,
		std::string	allowedChars,
		bool	caseSensitive = `false`,
		char	defaultAnswer = `'\0'`
	)

pure virtual

Implemented in BaseLineReader, EditLineReader, and ProximLineReader.

Referenced by confirmation().

◆ confirmation()

bool LineReader::confirmation	(	std::string	question,
		char	defaultAnswer = `'n'`,
		char	yesChar = `'y'`,
		char	noChar = `'n'`
	)

Asks confirmation from the user.

Question is asked from user, who should answer with a single character.

Parameters

question	The question that is asked from the user.
defaultAnswer	The default answer.
yesChar	Character meaning "yes" answer.
noChar	Character meaning "no" answer.

Returns: True, if answer is yesChar, false otherwise.

Exceptions

ObjectNotInitialized If LineReader is not initialized.

Definition at line 79 of file LineReader.cc.

                                                                       {
    if (!initialized_) {
        string method = "LineReader::confirmation()";
        string message = "LineReader not initialized.";
        throw ObjectNotInitialized(__FILE__, __LINE__, method, message);
    }
 
    string allowed = string(1, yesChar) + string(1, noChar);
    char answer = charQuestion(question, allowed, false, defaultAnswer);
 
    return (answer == yesChar);
}

References charQuestion(), and initialized_.

Here is the call graph for this function:

◆ initialize()

virtual void LineReader::initialize	(	std::string	defPrompt = `""`,
		FILE *	in = `stdin`,
		FILE *	out = `stdout`,
		FILE *	err = `stderr`
	)

pure virtual

Implemented in BaseLineReader, EditLineReader, and ProximLineReader.

Referenced by main(), and SimulatorCLI::SimulatorCLI().

◆ initialized()

bool LineReader::initialized ( ) const

protected

Referenced by BaseLineReader::charQuestion(), EditLineReader::charQuestion(), ProximLineReader::charQuestion(), BaseLineReader::readLine(), EditLineReader::readLine(), and ProximLineReader::readLine().

◆ inputHistoryEntry()

std::string LineReader::inputHistoryEntry ( std::size_t age ) const

virtual

Returns the string at input history log with the given age.

In case the given age is 0, the newest entry is returned, if it's 1, the 2nd newest, and so on.

Parameters

age	The age of the requested history entry. An empty string is is returned in case there's no entry with the given age.

Definition at line 165 of file LineReader.cc.

                                                 {
    if (inputHistory_.size() == 0 || 
        age > static_cast<std::size_t>(inputHistory_.size() - 1))
        return "";
    return inputHistory_.at(inputHistory_.size() - age - 1);
}

References inputHistory_.

Referenced by ConsoleWindow::onInputKey(), ProximCmdHistoryWindow::onSave(), and ProximCmdHistoryWindow::updateCommandList().

◆ inputHistoryMaxLength()

virtual size_t LineReader::inputHistoryMaxLength ( ) const

virtual

Referenced by SimulatorSettingsDialog::onOK(), and SimulatorSettingsDialog::TransferDataToWindow().

◆ inputsInHistory()

std::size_t LineReader::inputsInHistory ( ) const

virtual

Returns the count of entries in the input history log.

Returns: The count of entries in the log.

Definition at line 150 of file LineReader.cc.

                                  {
    return inputHistory_.size();
}

References inputHistory_.

Referenced by ConsoleWindow::onInputKey(), ProximCmdHistoryWindow::onSave(), and ProximCmdHistoryWindow::updateCommandList().

◆ operator=()

LineReader & LineReader::operator= ( const LineReader & )

private

Assignment not allowed.

◆ outputStream()

std::ostream & LineReader::outputStream ( )

virtual

Returns the output stream which can be used to print information to the user.

This stream should be used to ask confirmation, etc. from the user.

Returns: The output stream (std::cout by default).

Reimplemented in ProximLineReader.

Definition at line 102 of file LineReader.cc.

                         {
    return oStream_;
}

References oStream_.

Referenced by SetHistoryFilename::execute(), and SimControlLanguageCommand::outputStream().

◆ putInInputHistory()

void LineReader::putInInputHistory ( const std::string & inputLine )

protected

Puts an input to the input history log.

Also writes the input to the input history log stream, if there's one, and input history logging to a file is enabled.

Expects that the terminating '
' is in place in case it's wanted to be stored in the log.

Parameters

inputLine The line to store.

Definition at line 184 of file LineReader.cc.

                                                        {
 
    // make room for the entry in case the input history is full
    if (inputHistory_.size() >= inputHistorySize_)
        inputHistory_.pop_front();
    
    inputHistory_.push_back(inputLine);
    
    if (saveHistoryToFile_) {
        // initialize the log file in case it hasn't been initialized before
        if (historyFile_ == NULL) {
            historyFile_ = 
                new std::ofstream(historyFilename_.c_str(), std::ios::app);
            if (!historyFile_->is_open()) {
                debugLog("Could not open history file for writing.");
                return;
            }
        }
        *historyFile_ << inputLine;
    }
}

References debugLog, historyFile_, historyFilename_, inputHistory_, inputHistorySize_, and saveHistoryToFile_.

Referenced by ProximLineReader::readLine(), and EditLineReader::updateHistory().

◆ readLine()

virtual std::string LineReader::readLine ( std::string prompt = "" )

pure virtual

Implemented in BaseLineReader, EditLineReader, and ProximLineReader.

Referenced by TclInterpreter::interpret(), main(), and SimulatorCLI::run().

◆ saveInputHistoryToFile()

virtual bool LineReader::saveInputHistoryToFile ( ) const

virtual

Referenced by SimulatorSettingsDialog::onOK(), and SimulatorSettingsDialog::TransferDataToWindow().

◆ setInitialized()

void LineReader::setInitialized ( )

protected

Referenced by BaseLineReader::initialize(), EditLineReader::initialize(), and ProximLineReader::initialize().

◆ setInputHistoryLength()

void LineReader::setInputHistoryLength ( std::size_t length )

virtual

Sets the maximum size of the command history log.

Parameters

length New length for the command history log.

Definition at line 140 of file LineReader.cc.

                                                  {
    inputHistorySize_ = length;
}

References inputHistorySize_.

Referenced by SetHistorySize::execute().

◆ setInputHistoryLog()

void LineReader::setInputHistoryLog ( const std::string & historyFilename )

virtual

Sets the output file name to save the command history to.

Parameters

historyFilename The command log stream.

Reimplemented in ProximLineReader.

Definition at line 124 of file LineReader.cc.

                                                               {
 
    if (historyFile_ != NULL) {
        historyFile_->close();
        delete historyFile_;
        historyFile_ = NULL;
    }
    historyFilename_ = historyFilename;
}

References historyFile_, and historyFilename_.

Referenced by SetHistoryFilename::execute(), ProximLineReader::setInputHistoryLog(), and SimulatorCLI::SimulatorCLI().

◆ setSaveInputHistoryToFile()

void LineReader::setSaveInputHistoryToFile ( bool flag )

virtual

Sets whether command history should be also saved to a stream.

The file name should be set with setInputHistoryLog().

Parameters

flag	Status of this option.

Definition at line 114 of file LineReader.cc.

                                               {
    saveHistoryToFile_ = flag;
}

References saveHistoryToFile_.

Referenced by SetHistorySave::execute().

Member Data Documentation

◆ historyFile_

std::ofstream* LineReader::historyFile_

private

The output stream to write the command history to.

Definition at line 103 of file LineReader.hh.

Referenced by putInInputHistory(), setInputHistoryLog(), and ~LineReader().

◆ historyFilename_

std::string LineReader::historyFilename_

private

The filename to write the command history to.

Definition at line 105 of file LineReader.hh.

Referenced by putInInputHistory(), and setInputHistoryLog().

◆ initialized_

bool LineReader::initialized_

private

Flag indicating whether LineReader is initialized.

Definition at line 95 of file LineReader.hh.

Referenced by confirmation().

◆ inputHistory_

std::deque<std::string> LineReader::inputHistory_

private

The input history.

Definition at line 97 of file LineReader.hh.

Referenced by inputHistoryEntry(), inputsInHistory(), and putInInputHistory().

◆ inputHistorySize_

std::size_t LineReader::inputHistorySize_

private

The maximum size for input history.

Definition at line 99 of file LineReader.hh.

Referenced by putInInputHistory(), and setInputHistoryLength().

◆ iStream_

std::istream& LineReader::iStream_

private

The input stream.

Definition at line 107 of file LineReader.hh.

◆ oStream_

std::ostream& LineReader::oStream_

private

The output stream.

Definition at line 109 of file LineReader.hh.

Referenced by outputStream().

◆ saveHistoryToFile_

bool LineReader::saveHistoryToFile_

private

Should the history be appended in a file?

Definition at line 101 of file LineReader.hh.

Referenced by putInInputHistory(), and setSaveInputHistoryToFile().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LineReader() [1/2]

◆ ~LineReader()

◆ LineReader() [2/2]

Member Function Documentation

◆ charQuestion()

◆ confirmation()

◆ initialize()

◆ initialized()

◆ inputHistoryEntry()

◆ inputHistoryMaxLength()

◆ inputsInHistory()

◆ operator=()

◆ outputStream()

◆ putInInputHistory()

◆ readLine()

◆ saveInputHistoryToFile()

◆ setInitialized()

◆ setInputHistoryLength()

◆ setInputHistoryLog()

◆ setSaveInputHistoryToFile()

Member Data Documentation

◆ historyFile_

◆ historyFilename_

◆ initialized_

◆ inputHistory_

◆ inputHistorySize_

◆ iStream_

◆ oStream_

◆ saveHistoryToFile_