itextinput.h

#ifndef _ITEXTINPUT_H
#define _ITEXTINPUT_H
 
namespace itasca {
 struct InputLine {
 inline InputLine(const IString &t,const IString &s,uint l,bool us,bool in=false) 
 : text_(t), source_(s), line_(l), undoStart_(us), interactive_(in) { }
 IString text_; // Actual text line input.
 IString source_; // Description of where the input came from, terminal, file, etc.
 uint32 line_; // Line number of where the input came from, if applicable.
 bool undoStart_; // TRUE if this line is a start of a block of 1 or more lines that 
 // can be undone.
 bool interactive_; // TRUE if this line came from an interactive source.
 bool safeInterruptAllowed_ = true; // TRUE if the input source supports repeatable interrupting.
 bool undone_ = false; // TRUE if a command that has been undone with smart undo, or a smart 
 // undo command.
 };
 
 struct InputContext {
 inline InputContext() : wait_(true), undoAllowed_(true), continuation_(false) { }
 IString prompt_; // Prompt to use for interactive sources.
 IString starting_; // Starting contents (if any) for prompted input.
 bool wait_; // If TRUE will wait till input available, otherwise if none
 // available will return with a null string immediately.
 bool undoAllowed_; // If FALSE this input cannot be used as a starting mark for an UNDO 
 // operation, must skip over.
 bool continuation_; // If TRUE this input is considered a continuation of a previous 
 // input, for the purposes of collecting input lines 
 // representing a single operation.
 bool checkExpectedError_ = true; // Check each line of input for first '!' character, and tag input source if present.
 bool checkExpectedWarning_ = true; // Check each line of input for first '*' character, and tag input source if present.
 };
 
 class ITextInput {
 public:
 virtual InputLine getInput(const InputContext &context)=0; 
 };
} // /namespace itasca
namespace utility {
 using itasca::InputLine;
 using itasca::InputContext;
 using itasca::ITextInput;
}
#endif
// EOF