G4UIterminal Class Reference

#include <G4UIterminal.hh>

Inheritance diagram for G4UIterminal:

Collaboration diagram for G4UIterminal:

Public Member Functions
	G4UIterminal (G4VUIshell *aShell=0, G4bool qsig=true)
	~G4UIterminal ()
void	SetPrompt (const G4String &prompt)
virtual G4UIsession *	SessionStart ()
virtual void	PauseSessionStart (const G4String &msg)
virtual G4int	ReceiveG4cout (const G4String &coutString)
virtual G4int	ReceiveG4cerr (const G4String &cerrString)
Public Member Functions inherited from G4VBasicShell
	G4VBasicShell ()
virtual	~G4VBasicShell ()
Public Member Functions inherited from G4UIsession
	G4UIsession ()
virtual	~G4UIsession ()
Public Member Functions inherited from G4coutDestination
	G4coutDestination ()
virtual	~G4coutDestination ()

Private Member Functions
virtual void	ExecuteCommand (const G4String &aCommand)
virtual G4bool	GetHelpChoice (G4int &aInt)
virtual void	ExitHelp () const
G4String	GetCommand (const char *msg=0)

Private Attributes
G4UImanager *	UI
G4VUIshell *	shell
G4bool	iExit
G4bool	iCont

Additional Inherited Members
Protected Member Functions inherited from G4VBasicShell
G4String	ModifyToFullPathCommand (const char *aCommandLine) const
G4String	GetCurrentWorkingDirectory () const
G4bool	ChangeDirectory (const char *newDir)
G4UIcommandTree *	FindDirectory (const char *dirName) const
G4UIcommand *	FindCommand (const char *commandName) const
G4String	Complete (const G4String &)
G4String	FindMatchingPath (G4UIcommandTree *, const G4String &)
void	ApplyShellCommand (const G4String &, G4bool &, G4bool &)
void	ShowCurrent (const G4String &) const
void	ChangeDirectoryCommand (const G4String &)
void	ListDirectory (const G4String &) const
void	TerminalHelp (const G4String &)
Static Protected Attributes inherited from G4coutDestination
static G4coutDestination *	masterG4coutDestination = 0

Detailed Description

Definition at line 71 of file G4UIterminal.hh.

Constructor & Destructor Documentation

G4UIterminal()

G4UIterminal::G4UIterminal	(	G4VUIshell *	aShell = 0,
		G4bool	qsig = true
	)

Definition at line 91 of file G4UIterminal.cc.

{
  UI= G4UImanager::GetUIpointer();
  UI-> SetSession(this);
  UI-> SetCoutDestination(this);

  iExit= FALSE;
  iCont= FALSE;

  if(aShell) shell= aShell;
  else shell= new G4UIcsh;
  theshell= shell; // locally stored for the signal handler

  // add signal handler
  if(qsig) {
#ifndef WIN32
  signal(SIGINT, SignalHandler);
#endif
  }
}

Here is the call graph for this function:

~G4UIterminal()

G4UIterminal::~G4UIterminal

(

)

Definition at line 114 of file G4UIterminal.cc.

{ 
  if(shell) delete shell;

  if(G4UImanager::GetUIpointer()) {
    UI-> SetSession(NULL);
    UI-> SetCoutDestination(NULL);
  }
}

Here is the call graph for this function:

Member Function Documentation

ExecuteCommand()

void G4UIterminal::ExecuteCommand ( const G4String &  aCommand )

privatevirtual

Reimplemented from G4VBasicShell.

Definition at line 161 of file G4UIterminal.cc.

{
  if(aCommand.length()<2) return;

  G4int returnVal = UI-> ApplyCommand(aCommand);

  G4int paramIndex = returnVal % 100;
  // 0 - 98 : paramIndex-th parameter is invalid
  // 99     : convination of parameters is invalid
  G4int commandStatus = returnVal - paramIndex;

  G4UIcommand* cmd = 0;
  if(commandStatus!=fCommandSucceeded)
  { cmd = FindCommand(aCommand); }

  switch(commandStatus) {
  case fCommandSucceeded:
    break;
  case fCommandNotFound:
    G4cerr << "command <" << UI->SolveAlias(aCommand) << "> not found" << G4endl;
    if( aCommand.index("@@") != G4String::npos) {
      G4cout << "@@G4UIterminal" << G4endl;
    }
    break;
  case fIllegalApplicationState:
    G4cerr << "illegal application state -- command refused" << G4endl;
    break;
  case fParameterOutOfRange:
    // if(paramIndex<99) {
    //   G4cerr << "Parameter is out of range (index " << paramIndex << ")" << G4endl;
    //   G4cerr << "Allowed range : " << cmd->GetParameter(paramIndex)->GetParameterRange() << G4endl;
    // } else {
    //   G4cerr << "Parameter is out of range" << G4endl;
    //   G4cerr << "Allowed range : " << cmd->GetRange() << G4endl;
    // }
    break;
  case fParameterOutOfCandidates:
    G4cerr << "Parameter is out of candidate list (index " << paramIndex << ")" << G4endl;
    G4cerr << "Candidates : " << cmd->GetParameter(paramIndex)->GetParameterCandidates() << G4endl;
    break;
  case fParameterUnreadable:
    G4cerr << "Parameter is wrong type and/or is not omittable (index " << paramIndex << ")" << G4endl;
    break;
  case fAliasNotFound:
  default:
    G4cerr << "command refused (" << commandStatus << ")" << G4endl;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

ExitHelp()

void G4UIterminal::ExitHelp ( ) const

privatevirtual

Implements G4VBasicShell.

Definition at line 336 of file G4UIterminal.cc.

{
  char temp[100];
  G4cin.getline(temp, 100);
}

GetCommand()

G4String G4UIterminal::GetCommand ( const char *  msg = 0 )

private

Definition at line 212 of file G4UIterminal.cc.

{
  G4String newCommand;
  G4String nullString;

  newCommand= shell-> GetCommandLineString(msg);

  G4String nC = newCommand.strip(G4String::leading);
  if( nC.length() == 0 ) {
    newCommand= nullString;

  } else if( nC(0) == '#' ) {  
    G4cout << nC << G4endl;
    newCommand= nullString;

  } else if(nC=="ls" || nC.substr(0,3)=="ls " ) {  // list commands
    ListDirectory(nC); 
    newCommand= nullString;

  } else if(nC=="lc" || nC.substr(0,3)=="lc " ) {  // ... by shell
    shell-> ListCommand(nC.remove(0,2)); 
    newCommand= nullString;

  } else if(nC == "pwd") { // show current directory
    G4cout << "Current Command Directory : " 
       << GetCurrentWorkingDirectory() << G4endl; 
    newCommand= nullString;

  } else if(nC == "cwd") { // ... by shell
    shell-> ShowCurrentDirectory();
    newCommand= nullString;

  } else if(nC == "cd" || nC.substr(0,3) == "cd ") {  // "cd"
    ChangeDirectoryCommand(nC); 
    shell-> SetCurrentDirectory(GetCurrentWorkingDirectory());
    newCommand= nullString;

  } else if(nC == "help" || nC.substr(0,5) == "help ") {  // "help"
    TerminalHelp(nC);
    newCommand= nullString;

  } else if(nC(0) == '?') {   // "show current value of a parameter"
    ShowCurrent(nC);
    newCommand= nullString;

  } else if(nC == "hist" || nC == "history") {     // "hist/history"
    G4int nh= UI-> GetNumberOfHistory();
    for (G4int i=0; i<nh; i++) { 
      G4cout << i << ": " << UI->GetPreviousCommand(i) << G4endl; 
    }
    newCommand= nullString;

  } else if(nC(0) == '!') {   // "!"
    G4String ss= nC(1, nC.length()-1);
    G4int vl;
    const char* tt= ss;
    std::istringstream is(tt);
    is >> vl;
    G4int nh= UI-> GetNumberOfHistory();
    if(vl>=0 && vl<nh) { 
      newCommand= UI-> GetPreviousCommand(vl); 
      G4cout << newCommand << G4endl;
    } else { 
      G4cerr << "history " << vl << " is not found." << G4endl; 
      newCommand= nullString;
    }

  } else if(nC == "exit") {   // "exit"
    if(iCont) { 
      G4cout << "You are now processing RUN." << G4endl;
      G4cout << "Please abort it using \"/run/abort\" command first" << G4endl;
      G4cout << " and use \"continue\" command until the application" 
         << G4endl;
      G4cout << " becomes to Idle." << G4endl;
    } else {
      iExit= FALSE;
      newCommand= nullString;
    }

  } else if( nC == "cont" || nC == "continue"){     // "cont/continu"
    iCont= FALSE;
    newCommand= nullString;

  } else if( nC.empty() ){ // NULL command
    newCommand= nullString;
    
  } else {
  }

  return ModifyToFullPathCommand(newCommand);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetHelpChoice()

G4bool G4UIterminal::GetHelpChoice ( G4int &  aInt )

privatevirtual

Implements G4VBasicShell.

Definition at line 323 of file G4UIterminal.cc.

{
  G4cin >> aInt;
  if(!G4cin.good()){
    G4cin.clear();
    G4cin.ignore(30,'\n');
    return FALSE;
  }
  return TRUE;
}

PauseSessionStart()

void G4UIterminal::PauseSessionStart ( const G4String &  msg )

virtual

Implements G4VBasicShell.

Definition at line 148 of file G4UIterminal.cc.

{
  iCont= TRUE;

  G4String newCommand= GetCommand(msg);
  while(iCont){
    ExecuteCommand(newCommand);
    newCommand= GetCommand(msg);
  }
}

Here is the call graph for this function:

ReceiveG4cerr()

G4int G4UIterminal::ReceiveG4cerr ( const G4String &  cerrString )

virtual

Reimplemented from G4UIsession.

Definition at line 315 of file G4UIterminal.cc.

{
  std::cerr << cerrString << std::flush;
  return 0;
}

ReceiveG4cout()

G4int G4UIterminal::ReceiveG4cout ( const G4String &  coutString )

virtual

Reimplemented from G4UIsession.

Definition at line 307 of file G4UIterminal.cc.

{
  std::cout << coutString << std::flush;
  return 0;
}

SessionStart()

G4UIsession * G4UIterminal::SessionStart ( )

virtual

Implements G4VBasicShell.

Definition at line 134 of file G4UIterminal.cc.

{
  iExit= TRUE;

  G4String newCommand= GetCommand();
  while(iExit){
    ExecuteCommand(newCommand);
    newCommand= GetCommand();
  }
  return NULL;
}

Here is the call graph for this function:

SetPrompt()

void G4UIterminal::SetPrompt

(

const G4String &

prompt

)

Definition at line 127 of file G4UIterminal.cc.

{
  shell-> SetPrompt(prompt);
}

Member Data Documentation

iCont

G4bool G4UIterminal::iCont

private

Definition at line 79 of file G4UIterminal.hh.

iExit

G4bool G4UIterminal::iExit

private

Definition at line 78 of file G4UIterminal.hh.

shell

G4VUIshell* G4UIterminal::shell

private

Definition at line 75 of file G4UIterminal.hh.

UI

G4UImanager* G4UIterminal::UI

private

Definition at line 73 of file G4UIterminal.hh.

---

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

• G4UIterminal.hh
• G4UIterminal.cc