#include <G4UIbatch.hh>

Inheritance diagram for G4UIbatch:

Public Types
using	Transformer = std::function< G4bool(G4String &)>

Public Member Functions
void	AddCerrTransformer (const Transformer &t)

void	AddCerrTransformer (Transformer &&t)

void	AddCoutTransformer (const Transformer &t)

void	AddCoutTransformer (Transformer &&t)

	G4UIbatch (const char fileName, G4UIsession prevSession=nullptr)

G4int	GetLastReturnCode () const

G4UIsession *	GetPreviousSession () const

virtual void	PauseSessionStart (const G4String &Prompt)

virtual G4int	ReceiveG4cerr (const G4String &cerrString)

G4int	ReceiveG4cerr_ (const G4String &msg)

virtual G4int	ReceiveG4cout (const G4String &coutString)

G4int	ReceiveG4cout_ (const G4String &msg)

virtual void	ResetTransformers ()

virtual G4UIsession *	SessionStart ()

	~G4UIbatch ()

Static Public Member Functions
static G4int	InSession ()

Protected Attributes
G4int	ifBatch = 0

G4int	lastRC = 0

std::vector< Transformer >	transformersCerr

std::vector< Transformer >	transformersCout

Static Protected Attributes
static G4ICOMS_DLL G4int	inSession = 0

static G4MTGLOB_DLL G4coutDestination *	masterG4coutDestination = nullptr

Private Member Functions
G4int	ExecCommand (const G4String &command)

G4String	ReadCommand ()

Private Attributes
G4bool	isOpened = false

std::ifstream	macroStream

G4UIsession *	previousSession = nullptr

Detailed Description

Definition at line 46 of file G4UIbatch.hh.

Member Typedef Documentation

◆ Transformer

using G4coutDestination::Transformer = std::function<G4bool(G4String&)>

inherited

Definition at line 61 of file G4coutDestination.hh.

Constructor & Destructor Documentation

◆ G4UIbatch()

G4UIbatch::G4UIbatch	(	const char *	fileName,
		G4UIsession *	prevSession = `nullptr`
	)

Definition at line 66 of file G4UIbatch.cc.

  : G4UIsession(1)
  , previousSession(prevSession)
{
  macroStream.open(fileName, std::ios::in);
  if(macroStream.fail())
  {
    G4cerr << "ERROR: Can not open a macro file <" << fileName
           << ">. Set macro path with \"/control/macroPath\" if needed."
           << G4endl;
    lastRC = fParameterUnreadable;
  }
  else
  {
    isOpened = true;
  }
 
  G4UImanager::GetUIpointer()->SetSession(this);
}

References fParameterUnreadable, G4cerr, G4endl, G4UImanager::GetUIpointer(), isOpened, G4UIsession::lastRC, macroStream, and G4UImanager::SetSession().

◆ ~G4UIbatch()

G4UIbatch::~G4UIbatch ( )

Definition at line 87 of file G4UIbatch.cc.

{
  if(isOpened)
    macroStream.close();
}

References isOpened, and macroStream.

Member Function Documentation

◆ AddCerrTransformer() [1/2]

void G4coutDestination::AddCerrTransformer ( const Transformer & t )

inlineinherited

Definition at line 67 of file G4coutDestination.hh.

  {
    transformersCerr.push_back(t);
  }

References G4coutDestination::transformersCerr.

Referenced by G4MTcoutDestination::HandleFileCerr().

◆ AddCerrTransformer() [2/2]

void G4coutDestination::AddCerrTransformer ( Transformer && t )

inlineinherited

Definition at line 71 of file G4coutDestination.hh.

71{ transformersCerr.push_back(t); }

References G4coutDestination::transformersCerr.

◆ AddCoutTransformer() [1/2]

void G4coutDestination::AddCoutTransformer ( const Transformer & t )

inlineinherited

Definition at line 62 of file G4coutDestination.hh.

  {
    transformersCout.push_back(t);
  }

References G4coutDestination::transformersCout.

Referenced by G4MTcoutDestination::AddMasterOutput(), G4MTcoutDestination::HandleFileCout(), and G4MTcoutDestination::SetDefaultOutput().

◆ AddCoutTransformer() [2/2]

void G4coutDestination::AddCoutTransformer ( Transformer && t )

inlineinherited

Definition at line 66 of file G4coutDestination.hh.

66{ transformersCout.push_back(t); }

References G4coutDestination::transformersCout.

◆ ExecCommand()

G4int G4UIbatch::ExecCommand ( const G4String & command )

private

Definition at line 179 of file G4UIbatch.cc.

{
  G4UImanager* UI = G4UImanager::GetUIpointer();
  G4int rc        = UI->ApplyCommand(command);
 
  switch(rc)
  {
    case fCommandSucceeded:
      break;
    case fCommandNotFound:
      G4cerr << "***** COMMAND NOT FOUND <" << command << "> *****" << G4endl;
      break;
    case fIllegalApplicationState:
      G4cerr << "***** Illegal application state <" << command << "> *****"
             << G4endl;
      break;
    default:
      G4int pn = rc % 100;
      G4cerr << "***** Illegal parameter (" << pn << ") <" << command
             << "> *****" << G4endl;
  }
 
  return rc;
}

References G4UImanager::ApplyCommand(), fCommandNotFound, fCommandSucceeded, fIllegalApplicationState, G4cerr, G4endl, G4UImanager::GetUIpointer(), and G4InuclParticleNames::pn.

Referenced by SessionStart().

◆ GetLastReturnCode()

G4int G4UIsession::GetLastReturnCode ( ) const

inlineinherited

Definition at line 63 of file G4UIsession.hh.

63{ return lastRC; }

References G4UIsession::lastRC.

◆ GetPreviousSession()

G4UIsession * G4UIbatch::GetPreviousSession ( ) const

inline

Definition at line 77 of file G4UIbatch.hh.

{
  return previousSession;
}

References previousSession.

◆ InSession()

G4int G4UIsession::InSession ( )

staticinherited

Definition at line 68 of file G4UIsession.cc.

{
  return inSession;
}

References G4UIsession::inSession.

Referenced by G4UIcontrolMessenger::SetNewValue().

◆ PauseSessionStart()

void G4UIbatch::PauseSessionStart ( const G4String & Prompt )

virtual

Reimplemented from G4UIsession.

Definition at line 243 of file G4UIbatch.cc.

{
  G4cout << "Pause session <" << Prompt << "> start." << G4endl;
 
  SessionStart();
 
  G4cout << "Pause session <" << Prompt << "> Terminate." << G4endl;
}

References G4cout, G4endl, and SessionStart().

◆ ReadCommand()

G4String G4UIbatch::ReadCommand ( )

private

Definition at line 94 of file G4UIbatch.cc.

{
  enum
  {
    BUFSIZE = 4096
  };
  static G4ThreadLocal char* linebuf = 0;
  if(!linebuf)
    linebuf = new char[BUFSIZE];
  const char ctrM = 0x0d;
 
  G4String cmdtotal = "";
  G4bool qcontinued = false;
  while(macroStream.good())
  {
    macroStream.getline(linebuf, BUFSIZE);
 
    G4String cmdline(linebuf);
 
    // TAB-> ' ' conversion
    G4String::size_type nb = 0;
    while((nb = cmdline.find('\t', nb)) != G4String::npos)
    {
      cmdline.replace(nb, 1, " ");
    }
 
    // strip
    G4StrUtil::strip(cmdline);
    G4StrUtil::rstrip(cmdline, ctrM);
 
    // skip null line if single line
    if(!qcontinued && cmdline.size() == 0)
      continue;
 
    // '#' is treated as echoing something
    if(cmdline[(std::size_t) 0] == '#')
      return cmdline;
 
    // tokenize...
    std::vector<G4String> tokens;
    Tokenize(cmdline, tokens);
    qcontinued = false;
    for(G4int i = 0; i < G4int(tokens.size()); ++i)
    {
      // string after '#" is ignored
      if(tokens[i][(std::size_t) 0] == '#')
        break;
      // '\' or '_' is treated as continued line.
      if(tokens[i] == "\\" || tokens[i] == "_")
      {
        qcontinued = true;
        // check nothing after line continuation character
        if(i != G4int(tokens.size()) - 1)
        {
          G4Exception("G4UIbatch::ReadCommand", "UI0003", JustWarning,
                      "unexpected character after line continuation character");
        }
        break;  // stop parsing
      }
      cmdtotal += tokens[i];
      cmdtotal += " ";
    }
 
    if(qcontinued)
      continue;  // read the next line
 
    if(cmdtotal.size() != 0)
      break;
    if(macroStream.eof())
      break;
  }
 
  // strip again
  G4StrUtil::strip(cmdtotal);
 
  // finally,
  if(macroStream.eof() && cmdtotal.size() == 0)
  {
    return "exit";
  }
 
  return cmdtotal;
}

References BUFSIZE, G4Exception(), G4ThreadLocal, JustWarning, macroStream, G4StrUtil::rstrip(), G4StrUtil::strip(), and Tokenize().

Referenced by SessionStart().

◆ ReceiveG4cerr()

G4int G4UIsession::ReceiveG4cerr ( const G4String & cerrString )

virtualinherited

Reimplemented from G4coutDestination.

Reimplemented in G4UIQt, G4UIXm, G4UIWin32, G4ZMQServer, and G4UIterminal.

Definition at line 81 of file G4UIsession.cc.

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

◆ ReceiveG4cerr_()

G4int G4coutDestination::ReceiveG4cerr_ ( const G4String & msg )

inherited

Definition at line 84 of file G4coutDestination.cc.

{
  if(transformersCout.size() > 0)
  {
    G4String m = msg;
    std::for_each(transformersCerr.begin(), transformersCerr.end(),
                  [&m](const Transformer& t) { t(m); }
                  // Call transforming function on message
    );
    return ReceiveG4cerr(m);
  }
  else
  {
    return ReceiveG4cerr(msg);
  }
}

References m, G4coutDestination::ReceiveG4cerr(), G4coutDestination::transformersCerr, and G4coutDestination::transformersCout.

Referenced by G4MasterForwardcoutDestination::ReceiveG4cerr().

◆ ReceiveG4cout()

G4int G4UIsession::ReceiveG4cout ( const G4String & coutString )

virtualinherited

Reimplemented from G4coutDestination.

Reimplemented in G4UIQt, G4UIXm, G4UIWin32, G4ZMQServer, and G4UIterminal.

Definition at line 74 of file G4UIsession.cc.

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

◆ ReceiveG4cout_()

G4int G4coutDestination::ReceiveG4cout_ ( const G4String & msg )

inherited

Definition at line 62 of file G4coutDestination.cc.

{
  // Avoid copy of string if not necessary
  if(transformersCout.size() > 0)
  {
    G4String m    = msg;
    G4bool result = true;
    for(const auto& el : transformersCout)
    {
      result &= el(m);
      if(!result)
        break;
    }
    return (result ? ReceiveG4cout(m) : 0);
  }
  else
  {
    return ReceiveG4cout(msg);
  }
}

References m, G4coutDestination::ReceiveG4cout(), and G4coutDestination::transformersCout.

Referenced by G4MasterForwardcoutDestination::ReceiveG4cout().

◆ ResetTransformers()

void G4coutDestination::ResetTransformers ( )

virtualinherited

Definition at line 41 of file G4coutDestination.cc.

{
  transformersCout.clear();
  transformersCerr.clear();
}

References G4coutDestination::transformersCerr, and G4coutDestination::transformersCout.

◆ SessionStart()

G4UIsession * G4UIbatch::SessionStart ( )

virtual

Reimplemented from G4UIsession.

Definition at line 205 of file G4UIbatch.cc.

{
  if(!isOpened)
    return previousSession;
 
  while(1)
  {
    G4String newCommand = ReadCommand();
 
    if(newCommand == "exit")
    {
      break;
    }
 
    // just echo something
    if(newCommand[(std::size_t) 0] == '#')
    {
      if(G4UImanager::GetUIpointer()->GetVerboseLevel() == 2)
      {
        G4cout << newCommand << G4endl;
      }
      continue;
    }
 
    // execute command
    G4int rc = ExecCommand(newCommand);
    if(rc != fCommandSucceeded)
    {
      G4cerr << G4endl << "***** Batch is interrupted!! *****" << G4endl;
      lastRC = rc;
      break;
    }
  }
 
  return previousSession;
}

References ExecCommand(), fCommandSucceeded, G4cerr, G4cout, G4endl, G4UImanager::GetUIpointer(), isOpened, G4UIsession::lastRC, previousSession, and ReadCommand().

Referenced by PauseSessionStart().

Field Documentation

◆ ifBatch

G4int G4UIsession::ifBatch = 0

protectedinherited

Definition at line 68 of file G4UIsession.hh.

Referenced by G4UIsession::~G4UIsession().

◆ inSession

G4int G4UIsession::inSession = 0

staticprotectedinherited

Definition at line 67 of file G4UIsession.hh.

Referenced by G4UIsession::G4UIsession(), G4UIsession::InSession(), and G4UIsession::~G4UIsession().

◆ isOpened

G4bool G4UIbatch::isOpened = false

private

Definition at line 70 of file G4UIbatch.hh.

Referenced by G4UIbatch(), SessionStart(), and ~G4UIbatch().

◆ lastRC

G4int G4UIsession::lastRC = 0

protectedinherited

Definition at line 69 of file G4UIsession.hh.

Referenced by G4UIbatch(), G4UIsession::GetLastReturnCode(), and SessionStart().

◆ macroStream

std::ifstream G4UIbatch::macroStream

private

Definition at line 69 of file G4UIbatch.hh.

Referenced by G4UIbatch(), ReadCommand(), and ~G4UIbatch().

◆ masterG4coutDestination

G4coutDestination * G4coutDestination::masterG4coutDestination = nullptr

staticprotectedinherited

Definition at line 88 of file G4coutDestination.hh.

Referenced by G4UIQt::G4UIQt(), G4MasterForwardcoutDestination::ReceiveG4cerr(), G4MasterForwardcoutDestination::ReceiveG4cout(), and G4UIQt::~G4UIQt().

◆ previousSession

G4UIsession* G4UIbatch::previousSession = nullptr

private

Definition at line 67 of file G4UIbatch.hh.

Referenced by GetPreviousSession(), and SessionStart().

◆ transformersCerr

std::vector<Transformer> G4coutDestination::transformersCerr

protectedinherited

Definition at line 94 of file G4coutDestination.hh.

Referenced by G4coutDestination::AddCerrTransformer(), G4coutDestination::ReceiveG4cerr_(), and G4coutDestination::ResetTransformers().

◆ transformersCout

std::vector<Transformer> G4coutDestination::transformersCout

protectedinherited

Definition at line 93 of file G4coutDestination.hh.

Referenced by G4coutDestination::AddCoutTransformer(), G4coutDestination::ReceiveG4cerr_(), G4coutDestination::ReceiveG4cout_(), and G4coutDestination::ResetTransformers().

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

source/intercoms/include/G4UIbatch.hh
source/intercoms/src/G4UIbatch.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Transformer

Constructor & Destructor Documentation

◆ G4UIbatch()

◆ ~G4UIbatch()

Member Function Documentation

◆ AddCerrTransformer() [1/2]

◆ AddCerrTransformer() [2/2]

◆ AddCoutTransformer() [1/2]

◆ AddCoutTransformer() [2/2]

◆ ExecCommand()

◆ GetLastReturnCode()

◆ GetPreviousSession()

◆ InSession()

◆ PauseSessionStart()

◆ ReadCommand()

◆ ReceiveG4cerr()

◆ ReceiveG4cerr_()

◆ ReceiveG4cout()

◆ ReceiveG4cout_()

◆ ResetTransformers()

◆ SessionStart()

Field Documentation

◆ ifBatch

◆ inSession

◆ isOpened

◆ lastRC

◆ macroStream

◆ masterG4coutDestination

◆ previousSession

◆ transformersCerr

◆ transformersCout