G4VUIshell Class Reference

#include <G4VUIshell.hh>

Inheritance diagram for G4VUIshell:

Public Member Functions
	G4VUIshell (const G4String &prompt="> ")
virtual	~G4VUIshell ()
void	SetNColumn (G4int ncol)
void	SetPrompt (const G4String &prompt)
void	SetCurrentDirectory (const G4String &ccd)
virtual void	SetLsColor (TermColorIndex, TermColorIndex)
virtual void	ShowCurrentDirectory () const
virtual void	ListCommand (const G4String &input, const G4String &candidate="") const
virtual G4String	GetCommandLineString (const char *msg=nullptr)=0
virtual void	ResetTerminal ()

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

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

Detailed Description

Definition at line 67 of file G4VUIshell.hh.

Constructor & Destructor Documentation

G4VUIshell()

G4VUIshell::G4VUIshell

(

const G4String &

prompt = "> "

)

Definition at line 44 of file G4VUIshell.cc.

  : promptSetting(prompt),
    promptString(""),
    nColumn(80),
    lsColorFlag(false),
    directoryColor(BLACK),
    commandColor(BLACK),
    currentCommandDir("/")
///////////////////////////////////////////////////////////////////
{}

~G4VUIshell()

G4VUIshell::~G4VUIshell ( )

virtualdefault

Member Function Documentation

GetAbsCommandDirPath()

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

protected

Definition at line 140 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[(std::size_t)0] != '/') bpath = currentCommandDir + apath;
 
  // parsing...
  G4String absPath = "/";
  for (std::size_t indx = 1; indx <= bpath.length() - 1;) {
    std::size_t jslash = bpath.find('/', indx);  // search index begin with "/"
    if (indx == jslash) {  // skip first '///'
      ++indx;
      continue;
    }
    if (jslash != 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[(G4int)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()

virtual G4String G4VUIshell::GetCommandLineString ( const char * msg = nullptr )

pure virtual

Implemented in G4UIcsh, and G4UItcsh.

GetCommandPathTail()

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

protected

Definition at line 188 of file G4VUIshell.cc.

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

Referenced by G4UItcsh::CompleteCommand().

GetCommandTree()

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

protected

Definition at line 113 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 nullptr;
  if (absPath[G4int(absPath.length() - 1)] != '/') return nullptr;  // error??
  if (absPath == "/") return cmdTree;
 
  for (std::size_t indx = 1; indx < absPath.length() - 1;) {
    std::size_t jslash = absPath.find('/', indx);  // search index begin with "/"
    if (jslash != G4String::npos) {
      if (cmdTree != nullptr) cmdTree = cmdTree->GetTree(G4String(absPath.substr(0, jslash + 1)));
    }
    indx = jslash + 1;
  }
 
  if (cmdTree == nullptr) return nullptr;
  return cmdTree;
}

Referenced by G4UItcsh::CompleteCommand().

ListCommand()

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

virtual

Definition at line 225 of file G4VUIshell.cc.

{
  // specified directpry
  G4String input = G4StrUtil::strip_copy(dir);
 
  // command tree of "user specified directory"
  G4String vpath = currentCommandDir;
  G4String vcmd;
 
  auto len = (G4int)input.length();
  if (! input.empty()) {
    G4int indx = -1;
    for (G4int i = len - 1; i >= 0; --i) {  // search last '/'
      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 "/"
  }
 
  // check "vcmd" is directory?
  G4String inputpath = vpath + vcmd;
  if (! vcmd.empty()) {
    G4String tmpstr = inputpath + "/";
    if (GetCommandTree(tmpstr) != nullptr) {
      vpath = tmpstr;
      vcmd = "";
    }
  }
 
  // check "vpath" directory exists?
  G4UIcommandTree* atree = GetCommandTree(vpath);
  if (atree == nullptr) {
    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.empty() || 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.empty() || 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);
}

Referenced by G4UItcsh::ListMatchedCommand().

MakePrompt()

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

protectedvirtual

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[i] == '%') {
      switch (promptSetting[i + 1]) {
        case 's':  // current application status
        {
          G4String stateStr;
          if (msg != nullptr) {
            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];
}

Referenced by G4UIcsh::GetCommandLineString().

ResetTerminal()

void G4VUIshell::ResetTerminal ( )

virtual

Reimplemented in G4UItcsh.

Definition at line 105 of file G4VUIshell.cc.

{}

SetCurrentDirectory()

void G4VUIshell::SetCurrentDirectory ( const G4String & ccd )

inline

Definition at line 123 of file G4VUIshell.hh.

{ currentCommandDir = dir; }

SetLsColor()

void G4VUIshell::SetLsColor ( TermColorIndex , TermColorIndex  )

inlinevirtual

Reimplemented in G4UItcsh.

Definition at line 125 of file G4VUIshell.hh.

{}

Referenced by G4UIExecutive::SetLsColor().

SetNColumn()

void G4VUIshell::SetNColumn ( G4int ncol )

inline

Definition at line 119 of file G4VUIshell.hh.

{ nColumn = ncol; }

SetPrompt()

void G4VUIshell::SetPrompt ( const G4String & prompt )

inline

Definition at line 121 of file G4VUIshell.hh.

{ promptSetting = prompt; }

Referenced by G4UIExecutive::SetPrompt(), and G4UIterminal::SetPrompt().

ShowCurrentDirectory()

void G4VUIshell::ShowCurrentDirectory ( ) const

inlinevirtual

Definition at line 127 of file G4VUIshell.hh.

{ G4cout << currentCommandDir << G4endl; }

Member Data Documentation

commandColor

TermColorIndex G4VUIshell::commandColor

protected

Definition at line 110 of file G4VUIshell.hh.

Referenced by G4UItcsh::SetLsColor().

currentCommandDir

G4String G4VUIshell::currentCommandDir

protected

Definition at line 113 of file G4VUIshell.hh.

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

directoryColor

TermColorIndex G4VUIshell::directoryColor

protected

Definition at line 109 of file G4VUIshell.hh.

Referenced by G4UItcsh::SetLsColor().

lsColorFlag

G4bool G4VUIshell::lsColorFlag

protected

Definition at line 108 of file G4VUIshell.hh.

Referenced by G4UItcsh::SetLsColor().

nColumn

G4int G4VUIshell::nColumn

protected

Definition at line 104 of file G4VUIshell.hh.

Referenced by SetNColumn().

promptSetting

G4String G4VUIshell::promptSetting

protected

Definition at line 102 of file G4VUIshell.hh.

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

promptString

G4String G4VUIshell::promptString

protected

Definition at line 103 of file G4VUIshell.hh.

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

---

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

• G4VUIshell.hh
• G4VUIshell.cc