G4UItcsh Class Reference

#include <G4UItcsh.hh>

Inheritance diagram for G4UItcsh:

Collaboration diagram for G4UItcsh:

Public Member Functions
	G4UItcsh (const G4String &prompt="%s> ", G4int maxhist=100)
	~G4UItcsh ()
void	SetLsColor (TermColorIndex dirColor, TermColorIndex cmdColor)
virtual G4String	GetCommandLineString (const char *msg=0)
virtual void	ResetTerminal ()
Public Member Functions inherited from G4VUIshell
	G4VUIshell (const G4String &prompt="> ")
virtual	~G4VUIshell ()
void	SetNColumn (G4int ncol)
void	SetPrompt (const G4String &prompt)
void	SetCurrentDirectory (const G4String &ccd)
virtual void	ShowCurrentDirectory () const
virtual void	ListCommand (const G4String &input, const G4String &candidate="") const

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 Member Functions inherited from G4VUIshell
G4UIcommandTree *	GetCommandTree (const G4String &dir) const
G4String	GetAbsCommandDirPath (const G4String &apath) const
G4String	GetCommandPathTail (const G4String &apath) const

Protected Attributes
G4String	commandLine
G4int	cursorPosition
G4String	commandLineBuf
std::vector< G4String >	commandHistory
G4int	maxHistory
G4int	currentHistoryNo
G4int	relativeHistoryIndex
termios	tios
G4String	clearString
Protected Attributes inherited from G4VUIshell
G4String	promptSetting
G4String	promptString
G4int	nColumn
G4bool	lsColorFlag
TermColorIndex	directoryColor
TermColorIndex	commandColor
G4String	currentCommandDir

Detailed Description

Definition at line 71 of file G4UItcsh.hh.

Constructor & Destructor Documentation

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

Definition at line 66 of file G4UItcsh.cc.

  : G4VUIshell(prompt),
    commandLine(""), cursorPosition(1),
    commandHistory(maxhist), maxHistory(maxhist),
    currentHistoryNo(1), relativeHistoryIndex(0)
{  
  // get current terminal mode
  tcgetattr(0, &tios);

  // read a shell history file
  const char* path = getenv("HOME");
  if( path == NULL ) return;

  G4String homedir= path;
  G4String fname= homedir + historyFileName;

  std::ifstream histfile;
  enum { BUFSIZE= 1024 }; char linebuf[BUFSIZE];

  histfile.open(fname, std::ios::in);
  while (histfile.good()) {
    if(histfile.eof()) break;

    histfile.getline(linebuf, BUFSIZE);
    G4String aline= linebuf;
    aline.strip(G4String::both);
    if(aline.size() !=  0) StoreHistory(linebuf);
  }
  histfile.close();
}

Here is the call graph for this function:

G4UItcsh::~G4UItcsh

(

)

Definition at line 99 of file G4UItcsh.cc.

{
  // store a shell history
  const char* path = getenv("HOME");
  if( path == NULL ) return;

  G4String homedir= path;
  G4String fname= homedir + historyFileName;

  std::ofstream histfile;
  histfile.open(fname, std::ios::out);

  G4int n0hist= 1;
  if( currentHistoryNo > maxHistory ) n0hist= currentHistoryNo-maxHistory+1;

  for (G4int i=n0hist; i<= currentHistoryNo; i++) {
    histfile << RestoreHistory(i) << G4endl;
  }
  
  histfile.close();
}

Here is the call graph for this function:

Member Function Documentation

void G4UItcsh::BackspaceCharacter ( )

protected

Definition at line 220 of file G4UItcsh.cc.

{
  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:

Here is the caller graph for this function:

void G4UItcsh::BackwardCursor ( )

protected

Definition at line 326 of file G4UItcsh.cc.

{
  if(cursorPosition==1) return;

  cursorPosition--;
  G4cout << AsciiBS << std::flush;
}

Here is the caller graph for this function:

void G4UItcsh::ClearAfterCursor ( )

protected

Definition at line 285 of file G4UItcsh.cc.

{
  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:

Here is the caller graph for this function:

void G4UItcsh::ClearLine ( )

protected

Definition at line 269 of file G4UItcsh.cc.

{
  // 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;
}

Here is the caller graph for this function:

void G4UItcsh::ClearScreen ( )

protected

Definition at line 302 of file G4UItcsh.cc.

{
  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 439 of file G4UItcsh.cc.

{
  // 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);
  }

  // tail string
  size_t thead = input.find_last_of('/');
  G4String strtail = input;
  if (thead != G4String::npos) strtail = input(thead+1, input.size()-thead-1);

  // 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++;
    }
  }

  // display...
  input= commandLine;
  // target token is last token
  jhead= input.last(' ');
  if(jhead == G4int(G4String::npos)) jhead=0;
  else jhead++;

  G4int jt = jhead;

  G4String dspstr; 
  G4int i;
  for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= G4String(AsciiBS); 
  for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= G4String(' '); 
  for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= G4String(AsciiBS); 

  dspstr+= (vpath + stream);
  if (nMatch == 0) dspstr+= strtail;
  G4cout << dspstr << std::flush;

  // command line string
  input.remove(jt);
  input+= (vpath + stream);
  if (nMatch==0) input+= strtail;

  commandLine= input;
  cursorPosition= commandLine.length()+1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4UItcsh::DeleteCharacter ( )

protected

Definition at line 248 of file G4UItcsh.cc.

{
  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:

Here is the caller graph for this function:

void G4UItcsh::ForwardCursor ( )

protected

Definition at line 316 of file G4UItcsh.cc.

{
  if(IsCursorLast()) return;

  G4cout << commandLine[(size_t)(cursorPosition-1)] << std::flush;
  cursorPosition++;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4String G4UItcsh::GetCommandLineString ( const char *  msg = 0 )

virtual

Implements G4VUIshell.

Definition at line 648 of file G4UItcsh.cc.

{
  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 688 of file G4UItcsh.cc.

{
  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;
}

Here is the caller graph for this function:

void G4UItcsh::InitializeCommandLine ( )

protected

Definition at line 188 of file G4UItcsh.cc.

{
  commandLine= "";
  cursorPosition= 1;
}

Here is the caller graph for this function:

void G4UItcsh::InsertCharacter ( char  cc )

protected

Definition at line 196 of file G4UItcsh.cc.

{
  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:

Here is the caller graph for this function:

G4bool G4UItcsh::IsCursorLast ( ) const

inlineprotected

Definition at line 134 of file G4UItcsh.hh.

{
  if(cursorPosition == G4int(commandLine.length()+1)) return TRUE;
  else return FALSE;
}

Here is the caller graph for this function:

void G4UItcsh::ListMatchedCommand ( )

protected

Definition at line 398 of file G4UItcsh.cc.

{
  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);
  }
  //G4cout << "@@@@ input=" << input << G4endl;

  // 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
  //G4cout << "@@@ vpath=" << vpath <<":vcmd=" << vcmd << G4endl;
  ListCommand(vpath, vpath+vcmd);

  G4cout << promptString << commandLine << std::flush;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4UItcsh::MakePrompt ( const char *  msg = 0 )

protectedvirtual

Reimplemented from G4VUIshell.

Definition at line 123 of file G4UItcsh.cc.

{
  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]));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4UItcsh::MoveCursorEnd ( )

protected

Definition at line 347 of file G4UItcsh.cc.

{
  for(size_t i=cursorPosition-1; i<commandLine.length(); i++){
    G4cout << commandLine[i];
  }
  G4cout << std::flush;
  cursorPosition=commandLine.length()+1;
}

Here is the caller graph for this function:

void G4UItcsh::MoveCursorTop ( )

protected

Definition at line 336 of file G4UItcsh.cc.

{
  for(G4int i=cursorPosition; i>1; i--){
    G4cout << AsciiBS;
  }
  G4cout << std::flush;
  cursorPosition=1;
}

Here is the caller graph for this function:

void G4UItcsh::NextCommand ( )

protected

Definition at line 378 of file G4UItcsh.cc.

{  
  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:

Here is the caller graph for this function:

void G4UItcsh::PreviousCommand ( )

protected

Definition at line 358 of file G4UItcsh.cc.

{
  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:

Here is the caller graph for this function:

G4String G4UItcsh::ReadLine ( )

protected

Definition at line 548 of file G4UItcsh.cc.

{
  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()) {
        return G4String("exit");    
      } 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 == '[' || 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:

Here is the caller graph for this function:

void G4UItcsh::ResetTerminal ( )

virtual

Reimplemented from G4VUIshell.

Definition at line 177 of file G4UItcsh.cc.

{
  RestoreTerm();
}

Here is the call graph for this function:

G4String G4UItcsh::RestoreHistory ( G4int  index )

protected

Definition at line 724 of file G4UItcsh.cc.

{
  if(histNo>= currentHistoryNo) return "";

  G4int index= histNo%maxHistory;
  if(index==0) index= maxHistory;

  return commandHistory[index-1]; // 0-offset
}

Here is the caller graph for this function:

void G4UItcsh::RestoreTerm ( )

protected

Definition at line 755 of file G4UItcsh.cc.

{
  tcsetattr(0, TCSAFLUSH, &tios);
}  

Here is the caller graph for this function:

void G4UItcsh::SetLsColor ( TermColorIndex  dirColor, TermColorIndex  cmdColor  )

inlinevirtual

Reimplemented from G4VUIshell.

Definition at line 140 of file G4UItcsh.hh.

{
  lsColorFlag= TRUE;
  directoryColor= dirColor;
  commandColor= cmdColor;
}

void G4UItcsh::SetTermToInputMode ( )

protected

Definition at line 739 of file G4UItcsh.cc.

{  
  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);
}

Here is the caller graph for this function:

void G4UItcsh::StoreHistory ( G4String  aCommand )

protected

Definition at line 713 of file G4UItcsh.cc.

{
  G4int i= currentHistoryNo%maxHistory; 
  if(i==0) i=maxHistory;

  commandHistory[i-1]= aCommand;  // 0-offset
  currentHistoryNo++;
}

Here is the caller graph for this function:

Member Data Documentation

G4String G4UItcsh::clearString

protected

Definition at line 117 of file G4UItcsh.hh.

std::vector<G4String> G4UItcsh::commandHistory

protected

Definition at line 106 of file G4UItcsh.hh.

G4String G4UItcsh::commandLine

protected

Definition at line 75 of file G4UItcsh.hh.

G4String G4UItcsh::commandLineBuf

protected

Definition at line 77 of file G4UItcsh.hh.

G4int G4UItcsh::currentHistoryNo

protected

Definition at line 108 of file G4UItcsh.hh.

G4int G4UItcsh::cursorPosition

protected

Definition at line 76 of file G4UItcsh.hh.

G4int G4UItcsh::maxHistory

protected

Definition at line 107 of file G4UItcsh.hh.

G4int G4UItcsh::relativeHistoryIndex

protected

Definition at line 109 of file G4UItcsh.hh.

termios G4UItcsh::tios

protected

Definition at line 116 of file G4UItcsh.hh.

---

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

• geant4.10.03.p01/source/interfaces/basic/include/G4UItcsh.hh
• geant4.10.03.p01/source/interfaces/basic/src/G4UItcsh.cc