#include <G4UItcsh.hh>

Inheritance diagram for G4UItcsh:

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

virtual G4String	GetCommandLineString (const char *msg=0)

virtual void	ListCommand (const G4String &input, const G4String &candidate="") const

virtual void	ResetTerminal ()

void	SetCurrentDirectory (const G4String &ccd)

void	SetLsColor (TermColorIndex dirColor, TermColorIndex cmdColor)

void	SetNColumn (G4int ncol)

void	SetPrompt (const G4String &prompt)

virtual void	ShowCurrentDirectory () const

	~G4UItcsh ()

Protected Member Functions
void	BackspaceCharacter ()

void	BackwardCursor ()

void	ClearAfterCursor ()

void	ClearLine ()

void	ClearScreen ()

void	CompleteCommand ()

void	DeleteCharacter ()

void	ForwardCursor ()

G4String	GetAbsCommandDirPath (const G4String &apath) const

G4String	GetCommandPathTail (const G4String &apath) const

G4UIcommandTree *	GetCommandTree (const G4String &dir) const

G4String	GetFirstMatchedString (const G4String &str1, const G4String &str2) const

void	InitializeCommandLine ()

void	InsertCharacter (char cc)

G4bool	IsCursorLast () const

void	ListMatchedCommand ()

virtual void	MakePrompt (const char *msg=0)

void	MoveCursorEnd ()

void	MoveCursorTop ()

void	NextCommand ()

void	PreviousCommand ()

G4String	ReadLine ()

G4String	RestoreHistory (G4int index)

void	RestoreTerm ()

void	SetTermToInputMode ()

void	StoreHistory (G4String aCommand)

Protected Attributes
G4String	clearString

TermColorIndex	commandColor

std::vector< G4String >	commandHistory

G4String	commandLine

G4String	commandLineBuf

G4String	currentCommandDir

G4int	currentHistoryNo

G4int	cursorPosition

TermColorIndex	directoryColor

G4bool	lsColorFlag

G4int	maxHistory

G4int	nColumn

G4String	promptSetting

G4String	promptString

G4int	relativeHistoryIndex

termios	tios

Detailed Description

Definition at line 70 of file G4UItcsh.hh.

Constructor & Destructor Documentation

◆ G4UItcsh()

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

Definition at line 65 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 = std::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= G4StrUtil::strip_copy(linebuf);
    if(aline.size() !=  0) StoreHistory(linebuf);
  }
  histfile.close();
}

References BUFSIZE, test::fname, historyFileName, StoreHistory(), G4StrUtil::strip_copy(), and tios.

◆ ~G4UItcsh()

G4UItcsh::~G4UItcsh ( )

Definition at line 97 of file G4UItcsh.cc.

{
  // store a shell history
  const char* path = std::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();
}

References currentHistoryNo, test::fname, G4endl, historyFileName, maxHistory, and RestoreHistory().

Member Function Documentation

◆ BackspaceCharacter()

void G4UItcsh::BackspaceCharacter ( )

protected

Definition at line 218 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--;
}

References AsciiBS, commandLine, cursorPosition, G4cout, and IsCursorLast().

Referenced by ReadLine().

◆ BackwardCursor()

void G4UItcsh::BackwardCursor ( )

protected

Definition at line 324 of file G4UItcsh.cc.

{
  if(cursorPosition==1) return;
 
  cursorPosition--;
  G4cout << AsciiBS << std::flush;
}

References AsciiBS, cursorPosition, and G4cout.

Referenced by ReadLine().

◆ ClearAfterCursor()

void G4UItcsh::ClearAfterCursor ( )

protected

Definition at line 283 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);
}

References AsciiBS, commandLine, cursorPosition, G4cout, and IsCursorLast().

Referenced by ReadLine().

◆ ClearLine()

void G4UItcsh::ClearLine ( )

protected

Definition at line 267 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;
}

References AsciiBS, commandLine, cursorPosition, and G4cout.

Referenced by NextCommand(), and PreviousCommand().

◆ ClearScreen()

void G4UItcsh::ClearScreen ( )

protected

Definition at line 300 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;
  }
}

References AsciiBS, clearString, commandLine, cursorPosition, G4cout, and G4VUIshell::promptString.

◆ CompleteCommand()

void G4UItcsh::CompleteCommand ( )

protected

Definition at line 436 of file G4UItcsh.cc.

{
  // inputting string
  G4String input = G4StrUtil::lstrip_copy(commandLine);
 
  // target token is last token
  auto jhead= input.rfind(' ');
  if(jhead != G4String::npos) {
    input.erase(0, jhead);
    G4StrUtil::lstrip(input);
  }
 
  // tail string
  size_t thead = input.find_last_of('/');
  G4String strtail = input;
  if (thead != G4String::npos) strtail = input.substr(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.substr(0,indx+1));
    if(!(indx==0  && len==1)) vcmd= input.substr(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.find(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.find(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.rfind(' ');
  if(jhead == G4String::npos) jhead=0;
  else jhead++;
 
  G4int jt = jhead;
 
  G4String dspstr; 
  G4int i;
  for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= AsciiBS; 
  for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= ' '; 
  for(i=jt; i<=G4int(input.length())-1; i++) dspstr+= AsciiBS; 
 
  dspstr+= (vpath + stream);
  if (nMatch == 0) dspstr+= strtail;
  G4cout << dspstr << std::flush;
 
  // command line string
  input.erase(jt);
  input+= (vpath + stream);
  if (nMatch==0) input+= strtail;
 
  commandLine= input;
  cursorPosition= commandLine.length()+1;
}

References AsciiBS, commandLine, G4VUIshell::currentCommandDir, cursorPosition, G4cout, G4VUIshell::GetAbsCommandDirPath(), G4VUIshell::GetCommandPathTail(), G4VUIshell::GetCommandTree(), GetFirstMatchedString(), G4StrUtil::lstrip(), and G4StrUtil::lstrip_copy().

Referenced by ReadLine().

◆ DeleteCharacter()

void G4UItcsh::DeleteCharacter ( )

protected

Definition at line 246 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);
}

References AsciiBS, commandLine, cursorPosition, G4cout, and IsCursorLast().

Referenced by ReadLine().

◆ ForwardCursor()

void G4UItcsh::ForwardCursor ( )

protected

Definition at line 314 of file G4UItcsh.cc.

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

References commandLine, cursorPosition, G4cout, and IsCursorLast().

Referenced by ReadLine().

◆ GetAbsCommandDirPath()

G4String G4VUIshell::GetAbsCommandDirPath ( const G4String & apath ) const

protectedinherited

Definition at line 145 of file G4VUIshell.cc.

{
  if(apath.empty()) return apath;  // null string
 
  // if "apath" does not start with "/", 
  //   then it is treared as relative path
  G4String bpath= apath;
  if(apath[(size_t)0] != '/') bpath= currentCommandDir + apath;
 
  // parsing...
  G4String absPath= "/";
  for(G4int indx=1; indx<=G4int(bpath.length())-1; ) {
    G4int jslash= bpath.find("/", indx);  // search index begin with "/"
    if(indx == jslash) { // skip first '///'
      indx++;
      continue;
    }
    if(jslash != G4int(G4String::npos)) {
      if(bpath.substr(indx,jslash-indx) == ".."){  // directory up
        if(absPath == "/") {
          indx = jslash+1;
          continue;
        }
        if(absPath.length() >= 2) {
          absPath.erase(absPath.length()-1);  // remove last  "/"
          auto jpre= absPath.rfind('/');
          if(jpre != G4String::npos) absPath.erase(jpre+1);
        }
      } else if(bpath.substr(indx,jslash-indx) == "."){  // nothing to do
      } else { // add
        if( !(jslash==indx && bpath[indx]=='/') ) // truncate "////"
          absPath+= bpath.substr(indx, jslash-indx+1);
          // better to be check directory existence. (it costs!)
      }
      indx= jslash+1;
    } else { // directory ONLY (ignore non-"/" terminated string)
      break;
    }
  }
 
  return  absPath;
}

Referenced by CompleteCommand(), and ListMatchedCommand().

◆ GetCommandLineString()

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

virtual

Implements G4VUIshell.

Definition at line 646 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.erase(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;
}

References FALSE, G4cout, G4endl, MakePrompt(), G4VUIshell::promptString, ReadLine(), relativeHistoryIndex, RestoreTerm(), SetTermToInputMode(), StoreHistory(), and TRUE.

◆ GetCommandPathTail()

G4String G4VUIshell::GetCommandPathTail ( const G4String & apath ) const

protectedinherited

Definition at line 191 of file G4VUIshell.cc.

{   // xxx/xxx/zzz -> zzz, trancate /// -> /
  if(apath.empty()) return apath;
 
  G4int lstr= apath.length();
 
  // for trancating "/"
  G4bool Qsla= FALSE;
  if(apath[(size_t)(lstr-1)]=='/') Qsla= TRUE;
 
  // searching last '/' from tail
  G4int indx= -1;
  for(G4int i=lstr-1; i>=0; i--) {
    if(Qsla && apath[(size_t)i]!='/') Qsla= FALSE; // break "/" flag!!
    if(apath[(size_t)i]=='/' && !Qsla) {
      indx= i;
      break;
    } 
  }
 
  if(indx==-1) return apath;  // not found
 
  if(indx==0  && lstr==1) { // "/"
    G4String nullStr;
    return nullStr;
  } else {  
    //G4String newPath= apath(indx+1,lstr-indx-1); 
    G4String newPath= apath;
    newPath= newPath.substr(indx+1,lstr-indx-1);
    return newPath;
  }
}

References FALSE, and TRUE.

Referenced by CompleteCommand().

◆ GetCommandTree()

G4UIcommandTree * G4VUIshell::GetCommandTree ( const G4String & dir ) const

protectedinherited

Definition at line 117 of file G4VUIshell.cc.

{
  G4UImanager* UI= G4UImanager::GetUIpointer();
 
  G4UIcommandTree* cmdTree= UI-> GetTree();  // root tree
 
  G4String absPath = GetAbsCommandDirPath(G4StrUtil::strip_copy(input));
 
  // parsing absolute path ...
  if(absPath.length()==0) return NULL;
  if(absPath[absPath.length()-1] != '/') return NULL; // error??
  if(absPath=="/") return cmdTree;
 
  for(G4int indx=1; indx<G4int(absPath.length())-1; ) {
    G4int jslash= absPath.find("/", indx);  // search index begin with "/" 
    if(jslash != G4int(G4String::npos)) {
      if(cmdTree != NULL)
        cmdTree= cmdTree-> GetTree(G4String(absPath.substr(0,jslash+1)));
    }
    indx= jslash+1;
  }
 
  if(cmdTree == NULL) return NULL;
  else return cmdTree;
}

References G4UImanager::GetUIpointer(), and G4StrUtil::strip_copy().

Referenced by CompleteCommand().

◆ GetFirstMatchedString()

G4String G4UItcsh::GetFirstMatchedString	(	const G4String &	str1,
		const G4String &	str2
	)		const

protected

Definition at line 686 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;
}

Referenced by CompleteCommand().

◆ InitializeCommandLine()

void G4UItcsh::InitializeCommandLine ( )

protected

Definition at line 186 of file G4UItcsh.cc.

{
  commandLine= "";
  cursorPosition= 1;
}

References commandLine, and cursorPosition.

Referenced by ReadLine().

◆ InsertCharacter()

void G4UItcsh::InsertCharacter ( char cc )

protected

Definition at line 194 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(1,cc));
  }
  cursorPosition++;
}

References AsciiBS, AsciiPrintableMin, commandLine, cursorPosition, G4cout, and IsCursorLast().

Referenced by ReadLine().

◆ IsCursorLast()

G4bool G4UItcsh::IsCursorLast ( ) const

inlineprotected

Definition at line 133 of file G4UItcsh.hh.

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

References commandLine, cursorPosition, FALSE, and TRUE.

Referenced by BackspaceCharacter(), ClearAfterCursor(), DeleteCharacter(), ForwardCursor(), InsertCharacter(), and ReadLine().

◆ ListCommand()

void G4VUIshell::ListCommand	(	const G4String &	input,
		const G4String &	candidate = `""`
	)		const

virtualinherited

Definition at line 229 of file G4VUIshell.cc.

{
  // specified directpry
  G4String input = G4StrUtil::strip_copy(dir); 
 
  // 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--) { // search last '/'
      if(input[(size_t)i]=='/') {
        indx= i;
        break;
      }   
    }
    // get abs. path
    if(indx != -1) vpath= GetAbsCommandDirPath(input.substr(0,indx+1));
    if(!(indx==0  && len==1)) vcmd= input.substr(indx+1,len-indx-1); // care for "/"
  }
 
  // check "vcmd" is directory?
  G4String inputpath= vpath+vcmd;
  if(! vcmd.empty()){
    G4String tmpstr= inputpath + "/";
    if(GetCommandTree(tmpstr) != NULL) {
      vpath= tmpstr;
      vcmd= "";
    }
  }
      
  // check "vpath" directory exists?
  G4UIcommandTree* atree= GetCommandTree(vpath);  
  if(atree == NULL) {
    G4cout << "<" << input << ">: No such directory" << G4endl;
    return;
  }
 
  // list matched directories/commands
  G4String stream;
  G4bool isMatch= FALSE;
 
  G4int Ndir= atree-> GetTreeEntry();
  G4int Ncmd= atree-> GetCommandEntry();
  if(Ndir==0 && Ncmd==0) return;  // no contents
  
  // directory ...
  for(G4int idir=1; idir<=Ndir; idir++) {
    if(idir==1 && lsColorFlag) stream+= TermColorString[directoryColor];
    G4String fpdir= atree-> GetTree(idir)-> GetPathName();
    // matching test
    if(candidate.empty()) { // list all
      if(vcmd=="" || fpdir==inputpath) {
    stream+= GetCommandPathTail(fpdir); stream+= "  ";
    isMatch= TRUE;
      }
    } else { // list only matched with candidate
      if( fpdir.find(candidate, 0) == 0) {
    stream+= GetCommandPathTail(fpdir); stream+= "  ";
      }
    }
  }
  
  // command ...
  for(G4int icmd=1; icmd<=Ncmd; icmd++){
    if(icmd==1 && lsColorFlag) stream+= TermColorString[commandColor];
    G4String fpcmd= atree-> GetPathName() +
             atree-> GetCommand(icmd) -> GetCommandName();
    // matching test
    if(candidate.empty()) { // list all
      if(vcmd=="" || fpcmd==inputpath) {
    stream+= GetCommandPathTail(fpcmd); stream+= "*  ";
    isMatch= TRUE;
      }
    } else {  // list only matched with candidate
      if( fpcmd.find(candidate, 0) == 0) {
    stream+= GetCommandPathTail(fpcmd); stream+= "*  ";
      }
    }
  }
  
  // waring : not matched
  if(!isMatch && candidate.empty()) 
    G4cout << "<" << input 
       << ">: No such directory or command" << std::flush;
 
  // display
  G4UIArrayString arrayString(stream);
  arrayString.Show(nColumn);
}

References FALSE, G4cout, G4endl, anonymous_namespace{G4ZMQServer.cc}::GetCommandTree(), G4UIArrayString::Show(), G4StrUtil::strip_copy(), TermColorString, and TRUE.

Referenced by ListMatchedCommand().

◆ ListMatchedCommand()

void G4UItcsh::ListMatchedCommand ( )

protected

Definition at line 396 of file G4UItcsh.cc.

{
  G4cout << G4endl;
  
  // input string
  G4String input = G4StrUtil::lstrip_copy(commandLine);
  // target token is last token
  auto jhead= input.rfind(' ');
  if(jhead != G4String::npos) {
    input.erase(0, jhead);
    G4StrUtil::lstrip(input);
  }
 
  // 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.substr(0,indx+1));  
    if(!(indx==0  && len==1)) vcmd= input.substr(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;
}

References commandLine, G4VUIshell::currentCommandDir, G4cout, G4endl, G4VUIshell::GetAbsCommandDirPath(), G4VUIshell::ListCommand(), G4StrUtil::lstrip(), G4StrUtil::lstrip_copy(), and G4VUIshell::promptString.

Referenced by ReadLine().

◆ MakePrompt()

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

protectedvirtual

Reimplemented from G4VUIshell.

Definition at line 121 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 += promptSetting[i];
    }
  }
 
  // append last chaacter
  if(i == promptSetting.length()-1) 
    promptString += promptSetting[i];
}

References G4VUIshell::currentCommandDir, currentHistoryNo, G4StateManager::GetCurrentState(), G4StateManager::GetStateManager(), G4VUIshell::promptSetting, and G4VUIshell::promptString.

Referenced by GetCommandLineString().

◆ MoveCursorEnd()

void G4UItcsh::MoveCursorEnd ( )

protected

Definition at line 345 of file G4UItcsh.cc.

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

References commandLine, cursorPosition, and G4cout.

Referenced by ReadLine().

◆ MoveCursorTop()

void G4UItcsh::MoveCursorTop ( )

protected

Definition at line 334 of file G4UItcsh.cc.

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

References AsciiBS, cursorPosition, and G4cout.

Referenced by ReadLine().

◆ NextCommand()

void G4UItcsh::NextCommand ( )

protected

Definition at line 376 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;
  }
}

References ClearLine(), commandLine, commandLineBuf, currentHistoryNo, cursorPosition, G4cout, maxHistory, relativeHistoryIndex, and RestoreHistory().

Referenced by ReadLine().

◆ PreviousCommand()

void G4UItcsh::PreviousCommand ( )

protected

Definition at line 356 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;
  }
}

References ClearLine(), commandLine, commandLineBuf, currentHistoryNo, cursorPosition, G4cout, maxHistory, relativeHistoryIndex, and RestoreHistory().

Referenced by ReadLine().

◆ ReadLine()

G4String G4UItcsh::ReadLine ( )

protected

Definition at line 546 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;
}

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(), G4cin, InitializeCommandLine(), InsertCharacter(), IsCursorLast(), ListMatchedCommand(), MoveCursorEnd(), MoveCursorTop(), NextCommand(), and PreviousCommand().

Referenced by GetCommandLineString().

◆ ResetTerminal()

void G4UItcsh::ResetTerminal ( )

virtual

Reimplemented from G4VUIshell.

Definition at line 175 of file G4UItcsh.cc.

{
  RestoreTerm();
}

References RestoreTerm().

◆ RestoreHistory()

G4String G4UItcsh::RestoreHistory ( G4int index )

protected

Definition at line 722 of file G4UItcsh.cc.

{
  if(histNo>= currentHistoryNo) return "";
 
  G4int index= histNo%maxHistory;
  if(index==0) index= maxHistory;
 
  return commandHistory[index-1]; // 0-offset
}

References commandHistory, currentHistoryNo, and maxHistory.

Referenced by NextCommand(), PreviousCommand(), and ~G4UItcsh().

◆ RestoreTerm()

void G4UItcsh::RestoreTerm ( )

protected

Definition at line 753 of file G4UItcsh.cc.

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

References tios.

Referenced by GetCommandLineString(), and ResetTerminal().

◆ SetCurrentDirectory()

void G4VUIshell::SetCurrentDirectory ( const G4String & ccd )

inlineinherited

Definition at line 114 of file G4VUIshell.hh.

{
  currentCommandDir= dir;
}

References G4VUIshell::currentCommandDir.

◆ SetLsColor()

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

inlinevirtual

Reimplemented from G4VUIshell.

Definition at line 139 of file G4UItcsh.hh.

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

References G4VUIshell::commandColor, G4VUIshell::directoryColor, G4VUIshell::lsColorFlag, and TRUE.

◆ SetNColumn()

void G4VUIshell::SetNColumn ( G4int ncol )

inlineinherited

Definition at line 104 of file G4VUIshell.hh.

{
  nColumn= ncol;
}

References G4VUIshell::nColumn.

◆ SetPrompt()

void G4VUIshell::SetPrompt ( const G4String & prompt )

inlineinherited

Definition at line 109 of file G4VUIshell.hh.

{
  promptSetting= prompt;
}

References G4VUIshell::promptSetting.

◆ SetTermToInputMode()

void G4UItcsh::SetTermToInputMode ( )

protected

Definition at line 737 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);
}

References tios.

Referenced by GetCommandLineString().

◆ ShowCurrentDirectory()

void G4VUIshell::ShowCurrentDirectory ( ) const

inlinevirtualinherited

Definition at line 123 of file G4VUIshell.hh.

{
  G4cout << currentCommandDir << G4endl;
}

References G4VUIshell::currentCommandDir, G4cout, and G4endl.

◆ StoreHistory()

void G4UItcsh::StoreHistory ( G4String aCommand )

protected

Definition at line 711 of file G4UItcsh.cc.

{
  G4int i= currentHistoryNo%maxHistory; 
  if(i==0) i=maxHistory;
 
  commandHistory[i-1]= aCommand;  // 0-offset
  currentHistoryNo++;
}

References commandHistory, currentHistoryNo, and maxHistory.

Referenced by G4UItcsh(), and GetCommandLineString().

Field Documentation

◆ clearString

G4String G4UItcsh::clearString

protected

Definition at line 116 of file G4UItcsh.hh.

Referenced by ClearScreen().

◆ commandColor

TermColorIndex G4VUIshell::commandColor

protectedinherited

Definition at line 69 of file G4VUIshell.hh.

Referenced by SetLsColor().

◆ commandHistory

std::vector<G4String> G4UItcsh::commandHistory

protected

Definition at line 105 of file G4UItcsh.hh.

Referenced by RestoreHistory(), and StoreHistory().

◆ commandLine

G4String G4UItcsh::commandLine

protected

Definition at line 74 of file G4UItcsh.hh.

Referenced by BackspaceCharacter(), ClearAfterCursor(), ClearLine(), ClearScreen(), CompleteCommand(), DeleteCharacter(), ForwardCursor(), InitializeCommandLine(), InsertCharacter(), IsCursorLast(), ListMatchedCommand(), MoveCursorEnd(), NextCommand(), PreviousCommand(), and ReadLine().

◆ commandLineBuf

G4String G4UItcsh::commandLineBuf

protected

Definition at line 76 of file G4UItcsh.hh.

Referenced by NextCommand(), and PreviousCommand().

◆ currentCommandDir

G4String G4VUIshell::currentCommandDir

protectedinherited

Definition at line 72 of file G4VUIshell.hh.

Referenced by CompleteCommand(), ListMatchedCommand(), MakePrompt(), G4VUIshell::MakePrompt(), G4VUIshell::SetCurrentDirectory(), and G4VUIshell::ShowCurrentDirectory().

◆ currentHistoryNo

G4int G4UItcsh::currentHistoryNo

protected

Definition at line 107 of file G4UItcsh.hh.

Referenced by MakePrompt(), NextCommand(), PreviousCommand(), RestoreHistory(), StoreHistory(), and ~G4UItcsh().

◆ cursorPosition

G4int G4UItcsh::cursorPosition

protected

Definition at line 75 of file G4UItcsh.hh.

Referenced by BackspaceCharacter(), BackwardCursor(), ClearAfterCursor(), ClearLine(), ClearScreen(), CompleteCommand(), DeleteCharacter(), ForwardCursor(), InitializeCommandLine(), InsertCharacter(), IsCursorLast(), MoveCursorEnd(), MoveCursorTop(), NextCommand(), and PreviousCommand().

◆ directoryColor

TermColorIndex G4VUIshell::directoryColor

protectedinherited

Definition at line 68 of file G4VUIshell.hh.

Referenced by SetLsColor().

◆ lsColorFlag

G4bool G4VUIshell::lsColorFlag

protectedinherited

Definition at line 67 of file G4VUIshell.hh.

Referenced by SetLsColor().

◆ maxHistory

G4int G4UItcsh::maxHistory

protected

Definition at line 106 of file G4UItcsh.hh.

Referenced by NextCommand(), PreviousCommand(), RestoreHistory(), StoreHistory(), and ~G4UItcsh().

◆ nColumn

G4int G4VUIshell::nColumn

protectedinherited

Definition at line 63 of file G4VUIshell.hh.

Referenced by G4VUIshell::SetNColumn().

◆ promptSetting

G4String G4VUIshell::promptSetting

protectedinherited

Definition at line 60 of file G4VUIshell.hh.

Referenced by MakePrompt(), G4VUIshell::MakePrompt(), and G4VUIshell::SetPrompt().

◆ promptString

G4String G4VUIshell::promptString

protectedinherited

Definition at line 61 of file G4VUIshell.hh.

Referenced by ClearScreen(), G4UIcsh::GetCommandLineString(), GetCommandLineString(), ListMatchedCommand(), MakePrompt(), and G4VUIshell::MakePrompt().

◆ relativeHistoryIndex

G4int G4UItcsh::relativeHistoryIndex

protected

Definition at line 108 of file G4UItcsh.hh.

Referenced by GetCommandLineString(), NextCommand(), and PreviousCommand().

◆ tios

termios G4UItcsh::tios

protected

Definition at line 115 of file G4UItcsh.hh.

Referenced by G4UItcsh(), RestoreTerm(), and SetTermToInputMode().

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

source/interfaces/basic/include/G4UItcsh.hh
source/interfaces/basic/src/G4UItcsh.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4UItcsh()

◆ ~G4UItcsh()

Member Function Documentation

◆ BackspaceCharacter()

◆ BackwardCursor()

◆ ClearAfterCursor()

◆ ClearLine()

◆ ClearScreen()

◆ CompleteCommand()

◆ DeleteCharacter()

◆ ForwardCursor()

◆ GetAbsCommandDirPath()

◆ GetCommandLineString()

◆ GetCommandPathTail()

◆ GetCommandTree()

◆ GetFirstMatchedString()

◆ InitializeCommandLine()

◆ InsertCharacter()

◆ IsCursorLast()

◆ ListCommand()

◆ ListMatchedCommand()

◆ MakePrompt()

◆ MoveCursorEnd()

◆ MoveCursorTop()

◆ NextCommand()

◆ PreviousCommand()

◆ ReadLine()

◆ ResetTerminal()

◆ RestoreHistory()

◆ RestoreTerm()

◆ SetCurrentDirectory()

◆ SetLsColor()

◆ SetNColumn()

◆ SetPrompt()

◆ SetTermToInputMode()

◆ ShowCurrentDirectory()

◆ StoreHistory()

Field Documentation

◆ clearString

◆ commandColor

◆ commandHistory

◆ commandLine

◆ commandLineBuf

◆ currentCommandDir

◆ currentHistoryNo

◆ cursorPosition

◆ directoryColor

◆ lsColorFlag

◆ maxHistory

◆ nColumn

◆ promptSetting

◆ promptString

◆ relativeHistoryIndex

◆ tios