G4UIcsh Class Reference

#include <G4UIcsh.hh>

Inheritance diagram for G4UIcsh:

Public Member Functions
	G4UIcsh (const G4String &prompt="%s> ")
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)
virtual void	SetLsColor (TermColorIndex, TermColorIndex)
void	SetNColumn (G4int ncol)
void	SetPrompt (const G4String &prompt)
virtual void	ShowCurrentDirectory () const
	~G4UIcsh ()

Protected Member Functions
G4String	GetAbsCommandDirPath (const G4String &apath) const
G4String	GetCommandPathTail (const G4String &apath) const
G4UIcommandTree *	GetCommandTree (const G4String &dir) const
virtual void	MakePrompt (const char *msg=0)

Protected Attributes
TermColorIndex	commandColor
G4String	currentCommandDir
TermColorIndex	directoryColor
G4bool	lsColorFlag
G4int	nColumn
G4String	promptSetting
G4String	promptString

Detailed Description

Definition at line 39 of file G4UIcsh.hh.

Constructor & Destructor Documentation

G4UIcsh()

G4UIcsh::G4UIcsh

(

const G4String &

prompt = "%s> "

)

Definition at line 32 of file G4UIcsh.cc.

 : G4VUIshell(prompt)
{
}

~G4UIcsh()

G4UIcsh::~G4UIcsh

(

)

Definition at line 39 of file G4UIcsh.cc.

{
}

Member Function Documentation

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 G4UItcsh::CompleteCommand(), and G4UItcsh::ListMatchedCommand().

GetCommandLineString()

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

virtual

Implements G4VUIshell.

Definition at line 46 of file G4UIcsh.cc.

{
  MakePrompt(msg);
  G4cout << promptString << std::flush;
 
  G4String newCommand;
  G4StrUtil::readline(G4cin, newCommand, false);
  if (!G4cin.good()) {
    G4cin.clear(); 
    newCommand= "exit";
    return newCommand;
  }
  G4StrUtil::rstrip(newCommand, '\r'); // fix for odd behavior on Windows
 
  // multi-line
  while( (newCommand.length() > 0) &&
     (newCommand[newCommand.length()-1] == '_') ) {
    G4String newLine;
    newCommand.erase(newCommand.length()-1);
    G4StrUtil::readline(G4cin, newLine, false);
    if (!G4cin.good()) { 
      G4cin.clear(); 
      newCommand= "exit";
      return newCommand;
    }
    newCommand.append(newLine);
  }
  
  return newCommand;
}

References G4cin, G4cout, G4VUIshell::MakePrompt(), G4VUIshell::promptString, G4StrUtil::readline(), and G4StrUtil::rstrip().

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 G4UItcsh::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 G4UItcsh::CompleteCommand().

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 G4UItcsh::ListMatchedCommand().

MakePrompt()

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

protectedvirtualinherited

Reimplemented in G4UItcsh.

Definition at line 60 of file G4VUIshell.cc.

{
  if(promptSetting.length()<=1) {
    promptString= promptSetting;
    return;
  }
 
  promptString="";
  G4int i;
  for(i=0; i<G4int(promptSetting.length())-1; i++){
    if(promptSetting[(size_t)i]=='%'){
      switch (promptSetting[(size_t)(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;
      default:
    promptString += promptSetting[i];
        break;
      }           
    } else {
      promptString += promptSetting[i];
    }
  }
 
  // append last chaacter
  if(i == G4int(promptSetting.length())-1) 
    promptString += promptSetting[i];
}

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

Referenced by GetCommandLineString().

ResetTerminal()

void G4VUIshell::ResetTerminal ( )

virtualinherited

Reimplemented in G4UItcsh.

Definition at line 107 of file G4VUIshell.cc.

{
 
}

SetCurrentDirectory()

void G4VUIshell::SetCurrentDirectory ( const G4String &  ccd )

inlineinherited

Definition at line 114 of file G4VUIshell.hh.

{
  currentCommandDir= dir;
}

References G4VUIshell::currentCommandDir.

SetLsColor()

void G4VUIshell::SetLsColor ( TermColorIndex  , TermColorIndex    )

inlinevirtualinherited

Reimplemented in G4UItcsh.

Definition at line 119 of file G4VUIshell.hh.

{
}

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.

ShowCurrentDirectory()

void G4VUIshell::ShowCurrentDirectory ( ) const

inlinevirtualinherited

Definition at line 123 of file G4VUIshell.hh.

{
  G4cout << currentCommandDir << G4endl;
}

References G4VUIshell::currentCommandDir, G4cout, and G4endl.

Field Documentation

commandColor

TermColorIndex G4VUIshell::commandColor

protectedinherited

Definition at line 69 of file G4VUIshell.hh.

Referenced by G4UItcsh::SetLsColor().

currentCommandDir

G4String G4VUIshell::currentCommandDir

protectedinherited

Definition at line 72 of file G4VUIshell.hh.

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

directoryColor

TermColorIndex G4VUIshell::directoryColor

protectedinherited

Definition at line 68 of file G4VUIshell.hh.

Referenced by G4UItcsh::SetLsColor().

lsColorFlag

G4bool G4VUIshell::lsColorFlag

protectedinherited

Definition at line 67 of file G4VUIshell.hh.

Referenced by G4UItcsh::SetLsColor().

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 G4UItcsh::MakePrompt(), G4VUIshell::MakePrompt(), and G4VUIshell::SetPrompt().

promptString

G4String G4VUIshell::promptString

protectedinherited

Definition at line 61 of file G4VUIshell.hh.

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

---

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

• source/interfaces/basic/include/G4UIcsh.hh
• source/interfaces/basic/src/G4UIcsh.cc