G4UIExecutive Class Reference

#include <G4UIExecutive.hh>

Public Member Functions
	G4UIExecutive (G4int argc, char **argv, const G4String &type="")
G4UIsession *	GetSession () const
G4bool	IsGUI () const
void	SessionStart ()
void	SetLsColor (TermColorIndex dirColor, TermColorIndex cmdColor)
void	SetPrompt (const G4String &prompt)
void	SetVerbose (G4bool val)
	~G4UIExecutive ()

Private Types
enum	SessionType {   kNone , kQt , kXm , kWin32 ,   kTcsh , kCsh }

Private Member Functions
void	SelectSessionByArg (const G4String &stype)
void	SelectSessionByBestGuess ()
void	SelectSessionByEnv ()
void	SelectSessionByFile (const G4String &appname)

Private Attributes
G4bool	isGUI
SessionType	selected
G4UIsession *	session
std::map< G4String, G4String >	sessionMap
G4VUIshell *	shell
G4bool	verbose

Detailed Description

Definition at line 59 of file G4UIExecutive.hh.

Member Enumeration Documentation

SessionType

enum G4UIExecutive::SessionType

private

Enumerator
kNone
kQt
kXm
kWin32
kTcsh
kCsh

Definition at line 76 of file G4UIExecutive.hh.

{ kNone, kQt, kXm, kWin32, kTcsh, kCsh };

Constructor & Destructor Documentation

G4UIExecutive()

G4UIExecutive::G4UIExecutive	(	G4int	argc,
		char **	argv,
		const G4String &	type = ""
	)

Definition at line 78 of file G4UIExecutive.cc.

  : selected(kNone), session(NULL), shell(NULL), isGUI(false), verbose(true)
{
  if ( verbose ) {
    G4cout << "Available UI session types: [ ";
    if ( qt_build ) G4cout << "Qt, ";
    if ( xm_build ) G4cout << "Xm, ";
    if ( win32_build) G4cout << "Win32, ";
    if (tcsh_build ) G4cout << "tcsh, ";
    G4cout << "csh ]" << G4endl;
  }
 
  // selecting session type...
  // 1st priority : in case argumant specified
  G4String stype = G4StrUtil::to_lower_copy(type); // session type is case-insensitive.
  if (type != "") SelectSessionByArg(stype);
 
  // 2nd priority : refer environment variables (as backword compatibility)
  if ( selected == kNone ) SelectSessionByEnv();
 
  // 3rd priority : refer $HOME/.g4session
  if ( selected == kNone ) {
    G4String appinput = argv[0];
    G4String appname = "";
    size_t islash = appinput.find_last_of("/\\");
    if (islash == G4String::npos)
      appname = appinput;
    else
      appname = appinput.substr(islash+1, appinput.size()-islash-1);
 
    SelectSessionByFile(appname);
  }
 
  // 4th, best guess of session type
  if ( selected == kNone) SelectSessionByBestGuess();
 
  // instantiate a session...
  switch ( selected ) {
  case kQt:
#if defined(G4UI_BUILD_QT_SESSION)
    session = new G4UIQt(argc, argv);
    isGUI = true;
#endif
    break;
  case kXm:
#if defined(G4UI_BUILD_XM_SESSION)
    session = new G4UIXm(argc, argv);
    isGUI = true;
#endif
    break;
  case kWin32:
#if defined(G4UI_BUILD_WIN32_SESSION)
    DISCARD_PARAMETER(argc);
    DISCARD_PARAMETER(argv);
    session = new G4UIWin32();
    isGUI = true;
#endif
    break;
 case kTcsh:
#ifndef WIN32
    DISCARD_PARAMETER(argc);
    DISCARD_PARAMETER(argv);
    shell = new G4UItcsh;
    session = new G4UIterminal(shell);
#endif
    break;
  case kCsh:
    DISCARD_PARAMETER(argc);
    DISCARD_PARAMETER(argv);
    shell = new G4UIcsh;
    session = new G4UIterminal(shell);
  default:
    break;
  }
 
  // fallback (csh)
  if ( session == NULL ) {
    G4Exception("G4UIExecutive::G4UIExecutive()",
                "UI0002",
                JustWarning,
                "Specified session type is not build in your system,\n"
                "or no session type is specified.\n"
                "A fallback session type is used.");
 
    selected = kCsh;
    DISCARD_PARAMETER(argc);
    DISCARD_PARAMETER(argv);
    shell = new G4UIcsh;
    session = new G4UIterminal(shell);
  }
 
  TIMEMORY_INIT(argc, argv);
}

References DISCARD_PARAMETER, G4cout, G4endl, G4Exception(), isGUI, JustWarning, kCsh, kNone, kNone, kQt, kTcsh, kWin32, kXm, qt_build, selected, SelectSessionByArg(), SelectSessionByBestGuess(), SelectSessionByEnv(), SelectSessionByFile(), shell, tcsh_build, TIMEMORY_INIT, G4StrUtil::to_lower_copy(), verbose, win32_build, and xm_build.

~G4UIExecutive()

G4UIExecutive::~G4UIExecutive

(

)

Definition at line 173 of file G4UIExecutive.cc.

{
  delete session;
}

References session.

Member Function Documentation

GetSession()

G4UIsession * G4UIExecutive::GetSession ( ) const

inline

Definition at line 95 of file G4UIExecutive.hh.

{
  return session;
}

References session.

IsGUI()

G4bool G4UIExecutive::IsGUI ( ) const

inline

Definition at line 100 of file G4UIExecutive.hh.

{
  return isGUI;
}

References isGUI.

SelectSessionByArg()

void G4UIExecutive::SelectSessionByArg ( const G4String &  stype )

private

Definition at line 179 of file G4UIExecutive.cc.

{
  if ( qt_build && stype == "qt" ) selected = kQt;
  else if ( xm_build && stype == "xm" ) selected = kXm;
  else if ( win32_build && stype == "win32" ) selected = kWin32;
  else if ( tcsh_build && stype == "tcsh" ) selected = kTcsh;
  else if ( stype == "csh" ) selected = kCsh;
}

References kCsh, kQt, kTcsh, kWin32, kXm, qt_build, selected, tcsh_build, win32_build, and xm_build.

Referenced by G4UIExecutive().

SelectSessionByBestGuess()

void G4UIExecutive::SelectSessionByBestGuess ( )

private

Definition at line 254 of file G4UIExecutive.cc.

{
  if ( qt_build ) selected = kQt;
  else if ( win32_build ) selected = kWin32;
  else if ( tcsh_build ) selected = kTcsh;
  else if ( xm_build ) selected = kXm;
}

References kQt, kTcsh, kWin32, kXm, qt_build, selected, tcsh_build, win32_build, and xm_build.

Referenced by G4UIExecutive().

SelectSessionByEnv()

void G4UIExecutive::SelectSessionByEnv ( )

private

Definition at line 189 of file G4UIExecutive.cc.

{
  if ( qt_build && std::getenv("G4UI_USE_QT") ) selected = kQt;
  else if ( xm_build && std::getenv("G4UI_USE_XM") ) selected = kXm;
  else if ( win32_build && std::getenv("G4UI_USE_WIN32") ) selected = kWin32;
  else if ( tcsh_build && std::getenv("G4UI_USE_TCSH") ) selected = kTcsh;
}

References kQt, kTcsh, kWin32, kXm, qt_build, selected, tcsh_build, win32_build, and xm_build.

Referenced by G4UIExecutive().

SelectSessionByFile()

void G4UIExecutive::SelectSessionByFile ( const G4String &  appname )

private

Definition at line 198 of file G4UIExecutive.cc.

{
  const char* path = std::getenv("HOME");
  if( path == NULL ) return;
  G4String homedir = path;
 
#ifndef WIN32
  G4String fname= homedir + "/.g4session";
#else
  G4String fname= homedir + "\\.g4session";
#endif
 
  std::ifstream fsession;
  enum { BUFSIZE= 1024 }; char linebuf[BUFSIZE];
 
  fsession.open(fname, std::ios::in);
 
  G4String default_session = "";
  G4int iline = 1;
  sessionMap.clear();
  while( fsession.good() ) {
    if( fsession.eof()) break;
    fsession.getline(linebuf, BUFSIZE);
    G4String aline = G4StrUtil::strip_copy(linebuf);
    if ( aline[0] == '#' ) continue;
    if ( aline == "" ) continue;
    if ( iline == 1 )
      default_session = aline;
    else {
      size_t idx = aline.find_first_of(" ");
      if ( idx == G4String::npos ) break;
      G4String aname = aline.substr(0, idx);
      idx = aline.find_first_not_of(" ", idx);
      if (idx == G4String::npos ) break;
      G4String sname = aline.substr(idx, aline.size()-idx);
      sessionMap[aname] = sname;
    }
    iline++;
  }
  fsession.close();
 
  G4String stype = "";
  std::map<G4String, G4String>::iterator it = sessionMap.find(appname);
  if ( it != sessionMap.end() ) stype = sessionMap[appname];
  else stype = default_session;
  G4StrUtil::to_lower(stype);
 
  // select session...
  if ( qt_build && stype == "qt" ) selected = kQt;
  else if ( xm_build && stype == "xm" ) selected = kXm;
  else if ( win32_build && stype == "win32" ) selected = kWin32;
  else if ( tcsh_build && stype == "tcsh" ) selected = kTcsh;
  else if ( stype == "csh" ) selected = kCsh;
}

References BUFSIZE, test::fname, kCsh, kQt, kTcsh, kWin32, kXm, qt_build, selected, sessionMap, G4StrUtil::strip_copy(), tcsh_build, G4StrUtil::to_lower(), win32_build, and xm_build.

Referenced by G4UIExecutive().

SessionStart()

void G4UIExecutive::SessionStart

(

)

Definition at line 276 of file G4UIExecutive.cc.

{
  session-> SessionStart();
}

References SessionStart().

Referenced by SessionStart().

SetLsColor()

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

Definition at line 269 of file G4UIExecutive.cc.

{
  if(shell) shell-> SetLsColor(dirColor, cmdColor);
}

References SetLsColor(), and shell.

Referenced by SetLsColor().

SetPrompt()

void G4UIExecutive::SetPrompt

(

const G4String &

prompt

)

Definition at line 263 of file G4UIExecutive.cc.

{
  if(shell) shell-> SetPrompt(prompt);
}

References SetPrompt(), and shell.

Referenced by SetPrompt().

SetVerbose()

void G4UIExecutive::SetVerbose ( G4bool  val )

inline

Definition at line 105 of file G4UIExecutive.hh.

{
  verbose = val;
}

References verbose.

Field Documentation

isGUI

G4bool G4UIExecutive::isGUI

private

Definition at line 82 of file G4UIExecutive.hh.

Referenced by G4UIExecutive(), and IsGUI().

selected

SessionType G4UIExecutive::selected

private

Definition at line 77 of file G4UIExecutive.hh.

Referenced by G4UIExecutive(), SelectSessionByArg(), SelectSessionByBestGuess(), SelectSessionByEnv(), and SelectSessionByFile().

session

G4UIsession* G4UIExecutive::session

private

Definition at line 79 of file G4UIExecutive.hh.

Referenced by GetSession(), and ~G4UIExecutive().

sessionMap

std::map<G4String, G4String> G4UIExecutive::sessionMap

private

Definition at line 86 of file G4UIExecutive.hh.

Referenced by SelectSessionByFile().

shell

G4VUIshell* G4UIExecutive::shell

private

Definition at line 80 of file G4UIExecutive.hh.

Referenced by G4UIExecutive(), SetLsColor(), and SetPrompt().

verbose

G4bool G4UIExecutive::verbose

private

Definition at line 84 of file G4UIExecutive.hh.

Referenced by G4UIExecutive(), and SetVerbose().

---

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

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