G4UItcsh Class Reference

#include <G4UItcsh.hh>

Inheritance diagram for G4UItcsh:

[legend]Collaboration diagram for G4UItcsh:

[legend]List of all members.

Public Member Functions
	G4UItcsh (const G4String &prompt="%s >", G4int maxhist=100)
	~G4UItcsh ()
void	SetLsColor (TermColorIndex dirColor, TermColorIndex cmdColor)
virtual G4String	GetCommandLine (const char *msg=0)
Protected Member Functions
virtual void	MakePrompt (const char *msg=0)
G4bool	IsCursorLast () const
void	InitializeCommandLine ()
G4String	ReadLine ()
void	InsertCharacter (char cc)
void	BackspaceCharacter ()
void	DeleteCharacter ()
void	ClearLine ()
void	ClearAfterCursor ()
void	ClearScreen ()
void	ForwardCursor ()
void	BackwardCursor ()
void	MoveCursorTop ()
void	MoveCursorEnd ()
void	NextCommand ()
void	PreviousCommand ()
void	ListMatchedCommand ()
void	CompleteCommand ()
G4String	GetFirstMatchedString (const G4String &str1, const G4String &str2) const
void	StoreHistory (G4String aCommand)
G4String	RestoreHistory (G4int index)
void	SetTermToInputMode ()
void	RestoreTerm ()
Protected Attributes
G4String	commandLine
G4int	cursorPosition
G4String	commandLineBuf
std::vector< G4String >	commandHistory
G4int	maxHistory
G4int	currentHistoryNo
G4int	relativeHistoryIndex
termios	tios
G4String	clearString

---

Constructor & Destructor Documentation

G4UItcsh::G4UItcsh (  const G4String &  prompt = "%s >", G4int  maxhist = 100 )

Definition at line 62 of file G4UItcsh.cc. References tios. : G4VUIshell(prompt), commandLine(""), cursorPosition(1), commandHistory(maxhist), maxHistory(maxhist), currentHistoryNo(1), relativeHistoryIndex(0) { // get current terminal mode tcgetattr(0, &tios); }

G4UItcsh::~G4UItcsh (   )

Definition at line 74 of file G4UItcsh.cc. { }

---

Member Function Documentation

void G4UItcsh::BackspaceCharacter (   )  [protected]

Definition at line 168 of file G4UItcsh.cc. References AsciiBS, commandLine, cursorPosition, and IsCursorLast(). Referenced by ReadLine(). { if(cursorPosition==1) return; // display... if(IsCursorLast()) { G4cout << AsciiBS << ' ' << AsciiBS << std::flush; } else { G4cout << AsciiBS; size_t i; for(i=cursorPosition-2; i< commandLine.length()-1 ;i++){ G4cout << commandLine[i+1]; } G4cout << ' '; for(i=cursorPosition-2; i< commandLine.length() ;i++){ G4cout << AsciiBS; } G4cout << std::flush; } // command line string... commandLine.erase(cursorPosition-2, 1); cursorPosition--; }

Here is the call graph for this function:

void G4UItcsh::BackwardCursor (   )  [protected]

Definition at line 274 of file G4UItcsh.cc. References AsciiBS, and cursorPosition. Referenced by ReadLine(). { if(cursorPosition==1) return; cursorPosition--; G4cout << AsciiBS << std::flush; }

void G4UItcsh::ClearAfterCursor (   )  [protected]

Definition at line 233 of file G4UItcsh.cc. References AsciiBS, commandLine, cursorPosition, and IsCursorLast(). Referenced by ReadLine(). { if(IsCursorLast()) return; // display... G4int i; for(i=cursorPosition; i<=G4int(commandLine.length()); i++) G4cout << ' '; for(i=commandLine.length(); i>=cursorPosition; i--) G4cout << AsciiBS; G4cout << std::flush; // command line string... commandLine.erase(cursorPosition-1, commandLine.length()-cursorPosition+1); }

Here is the call graph for this function:

void G4UItcsh::ClearLine (   )  [protected]

Definition at line 217 of file G4UItcsh.cc. References AsciiBS, commandLine, and cursorPosition. Referenced by NextCommand(), and PreviousCommand(). { // display... G4int i; for(i= cursorPosition; i>=2; i--) G4cout << AsciiBS; for(i=1; i<=G4int(commandLine.length()); i++) G4cout << ' '; for(i=1; i<=G4int(commandLine.length()); i++) G4cout << AsciiBS; G4cout << std::flush; // command line string... commandLine.erase(); cursorPosition= 1; }

void G4UItcsh::ClearScreen (   )  [protected]

Definition at line 250 of file G4UItcsh.cc. References AsciiBS, clearString, commandLine, cursorPosition, and G4VUIshell::promptString. { if(! clearString.empty() ) { G4cout << clearString; G4cout << promptString << commandLine << std::flush; // reset cursur position for(G4int i=commandLine.length()+1; i>=cursorPosition+1; i--) G4cout << AsciiBS << std::flush; } }

void G4UItcsh::CompleteCommand (   )  [protected]

Definition at line 385 of file G4UItcsh.cc. References AsciiBS, commandLine, G4VUIshell::currentCommandDir, cursorPosition, G4VUIshell::GetAbsCommandDirPath(), G4VUIshell::GetCommandPathTail(), G4VUIshell::GetCommandTree(), and GetFirstMatchedString(). Referenced by ReadLine(). { // inputting string G4String input= G4String(commandLine).strip(G4String::leading); // target token is last token G4int jhead= input.last(' '); if(jhead != G4int(G4String::npos)) { input.remove(0, jhead); input= input.strip(G4String::leading); } // command tree of "user specified directory" G4String vpath= currentCommandDir; G4String vcmd; G4int len= input.length(); if(!input.empty()) { G4int indx= -1; for(G4int i=len-1; i>=0; i--) { if(input(i)=='/') { indx= i; break; } } // get abs. path if(indx != -1) vpath= GetAbsCommandDirPath(input(0,indx+1)); if(!(indx==0 && len==1)) vcmd= input(indx+1,len-indx-1); // care for "/" } G4UIcommandTree* atree= GetCommandTree(vpath); // get command tree if(atree == NULL) return; // list matched directories/commands G4String stream, strtmp; G4String inputpath= vpath+vcmd; G4int nMatch= 0; int Ndir= atree-> GetTreeEntry(); int Ncmd= atree-> GetCommandEntry(); // directory ... for(G4int idir=1; idir<=Ndir; idir++) { G4String fpdir= atree-> GetTree(idir)-> GetPathName(); // matching test if( fpdir.index(inputpath, 0) == 0) { if(nMatch==0) { stream= GetCommandPathTail(fpdir); } else { strtmp= GetCommandPathTail(fpdir); stream= GetFirstMatchedString(stream, strtmp); } nMatch++; } } // command ... for(G4int icmd=1; icmd<=Ncmd; icmd++){ G4String fpcmd= atree-> GetPathName() + atree-> GetCommand(icmd) -> GetCommandName(); // matching test if( fpcmd.index(inputpath, 0) ==0) { if(nMatch==0) { stream= GetCommandPathTail(fpcmd) + " "; } else { strtmp= GetCommandPathTail(fpcmd) + " "; stream= GetFirstMatchedString(stream, strtmp); } nMatch++; } } if(nMatch==0) return; // no matched // display... input= commandLine; // target token is last token jhead= input.last(' '); if(jhead == G4int(G4String::npos)) jhead=0; else jhead++; G4int jt= input.find_last_of('/'); if(jt<jhead) jt=G4String::npos; if(jt==G4int(G4String::npos)) jt= jhead; else jt++; G4String dspstr; G4int i; for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= G4String(AsciiBS); // cleanup for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= G4String(' '); for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= G4String(AsciiBS); dspstr+= stream; G4cout << dspstr << std::flush; // command line string input.remove(jt); input+= stream; commandLine= input; cursorPosition= commandLine.length()+1; }

Here is the call graph for this function:

void G4UItcsh::DeleteCharacter (   )  [protected]

Definition at line 196 of file G4UItcsh.cc. References AsciiBS, commandLine, cursorPosition, and IsCursorLast(). Referenced by ReadLine(). { if(IsCursorLast()) return; // display... size_t i; for(i=cursorPosition-1; i< commandLine.length()-1 ;i++){ G4cout << commandLine[i+1]; } G4cout << ' '; for(i=cursorPosition-1; i< commandLine.length() ;i++){ G4cout << AsciiBS; } G4cout << std::flush; // command lin string... commandLine.erase(cursorPosition-1, 1); }

Here is the call graph for this function:

void G4UItcsh::ForwardCursor (   )  [protected]

Definition at line 264 of file G4UItcsh.cc. References commandLine, cursorPosition, and IsCursorLast(). Referenced by ReadLine(). { if(IsCursorLast()) return; G4cout << commandLine[(size_t)(cursorPosition-1)] << std::flush; cursorPosition++; }

Here is the call graph for this function:

G4String G4UItcsh::GetCommandLine (  const char *  msg = 0  )  [virtual]

Implements G4VUIshell. Definition at line 595 of file G4UItcsh.cc. References MakePrompt(), G4VUIshell::promptString, ReadLine(), relativeHistoryIndex, RestoreTerm(), SetTermToInputMode(), and StoreHistory(). { SetTermToInputMode(); MakePrompt(msg); // update relativeHistoryIndex= 0; G4cout << promptString << std::flush; G4String newCommand= ReadLine(); // read line... // multi-line while( (newCommand.length() > 0) && ( newCommand[newCommand.length()-1] == '_') ) { newCommand.remove(newCommand.length()-1); G4cout << G4endl; promptString= "? "; G4cout << promptString << std::flush; G4String newLine= ReadLine(); newCommand.append(newLine); } // update history... G4bool isMeaningfull= FALSE; // check NULL command for (size_t i=0; i<newCommand.length(); i++) { if(newCommand[i] != ' ') { isMeaningfull= TRUE; break; } } if( !newCommand.empty() && isMeaningfull) StoreHistory(newCommand); // reset terminal RestoreTerm(); G4cout << G4endl; return newCommand; }

Here is the call graph for this function:

G4String G4UItcsh::GetFirstMatchedString (  const G4String &  str1, const G4String &  str2 )  const [protected]

Definition at line 635 of file G4UItcsh.cc. Referenced by CompleteCommand(). { int nlen1= str1.length(); int nlen2= str2.length(); int nmin = nlen1<nlen2 ? nlen1 : nlen2; G4String strMatched; for(size_t i=0; G4int(i)<nmin; i++){ if(str1[i]==str2[i]) { strMatched+= str1[i]; } else { break; } } return strMatched; }

void G4UItcsh::InitializeCommandLine (   )  [protected]

Definition at line 136 of file G4UItcsh.cc. References commandLine, and cursorPosition. Referenced by ReadLine(). { commandLine= ""; cursorPosition= 1; }

void G4UItcsh::InsertCharacter (  char  cc  )  [protected]

Definition at line 144 of file G4UItcsh.cc. References AsciiBS, AsciiPrintableMin, commandLine, cursorPosition, and IsCursorLast(). Referenced by ReadLine(). { if( ! (cc >= AsciiPrintableMin && isprint(cc)) ) return; // display... G4cout << cc; size_t i; for(i=cursorPosition-1; i<commandLine.length() ;i++) G4cout << commandLine[i]; for(i=cursorPosition-1; i<commandLine.length() ;i++) G4cout << AsciiBS; G4cout << std::flush; // command line string... if(IsCursorLast()) { // add commandLine+= cc; } else { // insert commandLine.insert(cursorPosition-1, G4String(cc)); } cursorPosition++; }

Here is the call graph for this function:

G4bool G4UItcsh::IsCursorLast (   )  const [inline, protected]

Definition at line 129 of file G4UItcsh.hh. References commandLine, and cursorPosition. Referenced by BackspaceCharacter(), ClearAfterCursor(), DeleteCharacter(), ForwardCursor(), InsertCharacter(), and ReadLine(). { if(cursorPosition == G4int(commandLine.length()+1)) return TRUE; else return FALSE; }

void G4UItcsh::ListMatchedCommand (   )  [protected]

Definition at line 346 of file G4UItcsh.cc. References commandLine, G4VUIshell::currentCommandDir, G4VUIshell::GetAbsCommandDirPath(), G4VUIshell::ListCommand(), and G4VUIshell::promptString. Referenced by ReadLine(). { G4cout << G4endl; // input string G4String input= G4String(commandLine).strip(G4String::leading); // target token is last token G4int jhead= input.last(' '); if(jhead != G4int(G4String::npos)) { input.remove(0, jhead); input= input.strip(G4String::leading); } // command tree of "user specified directory" G4String vpath= currentCommandDir; G4String vcmd; if( !input.empty() ) { G4int len= input.length(); G4int indx=-1; for(G4int i=len-1; i>=0; i--) { if(input[(size_t)i]=='/') { indx= i; break; } } // get abs. path if(indx != -1) vpath= GetAbsCommandDirPath(input(0,indx+1)); if(!(indx==0 && len==1)) vcmd= input(indx+1,len-indx-1); // care for "/" } // list matched dirs/commands ListCommand(vpath, vpath+vcmd); G4cout << promptString << commandLine << std::flush; }

Here is the call graph for this function:

void G4UItcsh::MakePrompt (  const char *  msg = 0  )  [protected, virtual]

Reimplemented from G4VUIshell. Definition at line 80 of file G4UItcsh.cc. References G4VUIshell::currentCommandDir, currentHistoryNo, G4VUIshell::promptSetting, and G4VUIshell::promptString. Referenced by GetCommandLine(). { if(promptSetting.length()<=1) { promptString= promptSetting; return; } promptString=""; size_t i; for(i=0; i<promptSetting.length()-1; i++){ if(promptSetting[i]=='%'){ switch (promptSetting[i+1]) { case 's': // current application status { G4String stateStr; if(msg) { stateStr = msg; } else { G4StateManager* statM= G4StateManager::GetStateManager(); stateStr= statM-> GetStateString(statM->GetCurrentState()); } promptString.append(stateStr); i++; } break; case '/': // current working directory promptString.append(currentCommandDir); i++; break; case 'h': // history# { std::ostringstream os; os << currentHistoryNo; promptString.append(os.str()); i++; } break; default: break; } } else { promptString.append(G4String(promptSetting[i])); } } // append last chaacter if(i == promptSetting.length()-1) promptString.append(G4String(promptSetting[i])); }

void G4UItcsh::MoveCursorEnd (   )  [protected]

Definition at line 295 of file G4UItcsh.cc. References commandLine, and cursorPosition. Referenced by ReadLine(). { for(size_t i=cursorPosition-1; i<commandLine.length(); i++){ G4cout << commandLine[i]; } G4cout << std::flush; cursorPosition=commandLine.length()+1; }

void G4UItcsh::MoveCursorTop (   )  [protected]

Definition at line 284 of file G4UItcsh.cc. References AsciiBS, and cursorPosition. Referenced by ReadLine(). { for(G4int i=cursorPosition; i>1; i--){ G4cout << AsciiBS; } G4cout << std::flush; cursorPosition=1; }

void G4UItcsh::NextCommand (   )  [protected]

Definition at line 326 of file G4UItcsh.cc. References ClearLine(), commandLine, commandLineBuf, currentHistoryNo, cursorPosition, maxHistory, relativeHistoryIndex, and RestoreHistory(). Referenced by ReadLine(). { G4int nhmax= currentHistoryNo-1 >= maxHistory ? maxHistory : currentHistoryNo-1; if(relativeHistoryIndex>=-nhmax && relativeHistoryIndex<=-1) { ClearLine(); relativeHistoryIndex++; if(relativeHistoryIndex==0) commandLine= commandLineBuf; else commandLine= RestoreHistory(currentHistoryNo+relativeHistoryIndex); G4cout << commandLine << std::flush; cursorPosition= commandLine.length()+1; } }

Here is the call graph for this function:

void G4UItcsh::PreviousCommand (   )  [protected]

Definition at line 306 of file G4UItcsh.cc. References ClearLine(), commandLine, commandLineBuf, currentHistoryNo, cursorPosition, maxHistory, relativeHistoryIndex, and RestoreHistory(). Referenced by ReadLine(). { G4int nhmax= currentHistoryNo-1 >= maxHistory ? maxHistory : currentHistoryNo-1; // retain current input if(relativeHistoryIndex==0) commandLineBuf= commandLine; if(relativeHistoryIndex>=-nhmax+1 && relativeHistoryIndex<=0) { ClearLine(); relativeHistoryIndex--; commandLine= RestoreHistory(currentHistoryNo+relativeHistoryIndex); G4cout << commandLine << std::flush; cursorPosition= commandLine.length()+1; } }

Here is the call graph for this function:

G4String G4UItcsh::ReadLine (   )  [protected]

Definition at line 494 of file G4UItcsh.cc. References AsciiBS, AsciiCtrA, AsciiCtrB, AsciiCtrC, AsciiCtrD, AsciiCtrE, AsciiCtrF, AsciiCtrK, AsciiCtrL, AsciiCtrN, AsciiCtrP, AsciiCtrQ, AsciiCtrS, AsciiCtrZ, AsciiDEL, AsciiESC, AsciiTAB, BackspaceCharacter(), BackwardCursor(), ClearAfterCursor(), commandLine, CompleteCommand(), DeleteCharacter(), ForwardCursor(), InitializeCommandLine(), InsertCharacter(), IsCursorLast(), ListMatchedCommand(), MoveCursorEnd(), MoveCursorTop(), NextCommand(), and PreviousCommand(). Referenced by GetCommandLine(). { InitializeCommandLine(); char cc; do{ // input loop G4cin.get(cc); // treatment for special character switch(cc){ case AsciiCtrA: // ... move cursor to the top MoveCursorTop(); break; case AsciiCtrB: // ... backward cursor BackwardCursor(); break; case AsciiCtrD: // ... delete/exit/show matched list if(commandLine.length()!=0 && IsCursorLast()) ListMatchedCommand(); else if (commandLine.empty()) { G4cout << G4endl; exit(0); } else DeleteCharacter(); break; case AsciiCtrE: // ... move cursor to the end MoveCursorEnd(); break; case AsciiCtrF: // ... forward cursor ForwardCursor(); break; case AsciiCtrK: // ... clear after the cursor ClearAfterCursor(); break; case AsciiCtrL: // ... clear screen // ClearScreen(); break; case AsciiCtrN: // ... next command NextCommand(); break; case AsciiCtrP: // ... previous command PreviousCommand(); break; case AsciiTAB: // ... command completion if( (!commandLine.empty()) && IsCursorLast()) CompleteCommand(); break; case AsciiDEL: // ... backspace BackspaceCharacter(); break; case AsciiBS: // ... backspace BackspaceCharacter(); break; case AsciiCtrC: // ... kill prompt break; case AsciiCtrQ: // ... restarts suspeded output break; case AsciiCtrS: // ... suspend output break; case AsciiCtrZ: // ... suspend break; default: break; } // treatment for ESC. character if( cc == AsciiESC) { // ESC G4cin.get(cc); if (cc == '[' || 'O') { // care for another termcap, such as konsole G4cin.get(cc); switch(cc) { case 'A': // [UP] cc = 'P' - '@'; PreviousCommand(); // ... show previous commad break; case 'B': // [DOWN] cc = 'N' - '@'; NextCommand(); // ... show next commad break; case 'C': // [RIGHT] cc = 'F' - '@'; ForwardCursor(); // ... forward cursor break; case 'D': // [LEFT] cc = 'B' - '@'; BackwardCursor(); // ... backward cursor break; default: // who knows !? cc = 0; break; } } } // insert character to command line and display InsertCharacter(cc); } while( cc != '\n'); return commandLine; }

Here is the call graph for this function:

G4String G4UItcsh::RestoreHistory (  G4int  index  )  [protected]

Definition at line 671 of file G4UItcsh.cc. References commandHistory, currentHistoryNo, and maxHistory. Referenced by NextCommand(), and PreviousCommand(). { if(histNo>= currentHistoryNo) return ""; G4int index= histNo%maxHistory; if(index==0) index= maxHistory; return commandHistory[index-1]; // 0-offset }

void G4UItcsh::RestoreTerm (   )  [protected]

Definition at line 702 of file G4UItcsh.cc. References tios. Referenced by GetCommandLine(). { tcsetattr(0, TCSAFLUSH, &tios); }

void G4UItcsh::SetLsColor (  TermColorIndex  dirColor, TermColorIndex  cmdColor )  [inline]

Definition at line 135 of file G4UItcsh.hh. References G4VUIshell::commandColor, G4VUIshell::directoryColor, and G4VUIshell::lsColorFlag. { lsColorFlag= TRUE; directoryColor= dirColor; commandColor= cmdColor; }

void G4UItcsh::SetTermToInputMode (   )  [protected]

Definition at line 686 of file G4UItcsh.cc. References tios. Referenced by GetCommandLine(). { termios tiosbuf= tios; tiosbuf.c_iflag &= ~(BRKINT | ISTRIP); tiosbuf.c_iflag |= (IGNBRK | IGNPAR); tiosbuf.c_lflag &= ~(ICANON | IEXTEN | ECHO); tiosbuf.c_cc[VMIN] = 1; tiosbuf.c_cc[VTIME] = 0; tcsetattr(0, TCSAFLUSH, &tiosbuf); }

void G4UItcsh::StoreHistory (  G4String  aCommand  )  [protected]

Definition at line 660 of file G4UItcsh.cc. References commandHistory, currentHistoryNo, and maxHistory. Referenced by GetCommandLine(). { G4int i= currentHistoryNo%maxHistory; if(i==0) i=maxHistory; commandHistory[i-1]= aCommand; // 0-offset currentHistoryNo++; }

---

Member Data Documentation

G4String G4UItcsh::clearString [protected]

Definition at line 117 of file G4UItcsh.hh. Referenced by ClearScreen().

std::vector<G4String> G4UItcsh::commandHistory [protected]

Definition at line 106 of file G4UItcsh.hh. Referenced by RestoreHistory(), and StoreHistory().

G4String G4UItcsh::commandLine [protected]

Definition at line 75 of file G4UItcsh.hh. Referenced by BackspaceCharacter(), ClearAfterCursor(), ClearLine(), ClearScreen(), CompleteCommand(), DeleteCharacter(), ForwardCursor(), InitializeCommandLine(), InsertCharacter(), IsCursorLast(), ListMatchedCommand(), MoveCursorEnd(), NextCommand(), PreviousCommand(), and ReadLine().

G4String G4UItcsh::commandLineBuf [protected]

Definition at line 77 of file G4UItcsh.hh. Referenced by NextCommand(), and PreviousCommand().

G4int G4UItcsh::currentHistoryNo [protected]

Definition at line 108 of file G4UItcsh.hh. Referenced by MakePrompt(), NextCommand(), PreviousCommand(), RestoreHistory(), and StoreHistory().

G4int G4UItcsh::cursorPosition [protected]

Definition at line 76 of file G4UItcsh.hh. Referenced by BackspaceCharacter(), BackwardCursor(), ClearAfterCursor(), ClearLine(), ClearScreen(), CompleteCommand(), DeleteCharacter(), ForwardCursor(), InitializeCommandLine(), InsertCharacter(), IsCursorLast(), MoveCursorEnd(), MoveCursorTop(), NextCommand(), and PreviousCommand().

G4int G4UItcsh::maxHistory [protected]

Definition at line 107 of file G4UItcsh.hh. Referenced by NextCommand(), PreviousCommand(), RestoreHistory(), and StoreHistory().

G4int G4UItcsh::relativeHistoryIndex [protected]

Definition at line 109 of file G4UItcsh.hh. Referenced by GetCommandLine(), NextCommand(), and PreviousCommand().

termios G4UItcsh::tios [protected]

Definition at line 116 of file G4UItcsh.hh. Referenced by G4UItcsh(), RestoreTerm(), and SetTermToInputMode().

---

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

• G4UItcsh.hh
• G4UItcsh.cc

---