Files
geant4/source/interfaces/core/include/G4VBasicShell.hh
T
2023-06-30 09:09:57 +02:00

107 lines
3.9 KiB
C++

//
// ********************************************************************
// * License and Disclaimer *
// * *
// * The Geant4 software is copyright of the Copyright Holders of *
// * the Geant4 Collaboration. It is provided under the terms and *
// * conditions of the Geant4 Software License, included in the file *
// * LICENSE and available at http://cern.ch/geant4/license . These *
// * include a list of copyright holders. *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. Please see the license in the file LICENSE and URL above *
// * for the full disclaimer and the limitation of liability. *
// * *
// * This code implementation is the result of the scientific and *
// * technical work of the GEANT4 collaboration. *
// * By using, copying, modifying or distributing the software (or *
// * any work based on the software) you agree to acknowledge its *
// * use in resulting scientific publications, and indicate your *
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
//
//
#ifndef G4VBasicShell_H
#define G4VBasicShell_H 1
class G4UIcommandTree;
class G4UIcommand;
#include "G4UIsession.hh"
#include "globals.hh"
// Class description :
//
// G4VBasicShell : a base class to extract common things to various
// sessions.
//
// It handles "seek" completion logic, help logic.
// VBasicShell handles also commands like "cd, ls, pwd"
// without passing by a Geant4 "intercom" command. This feature,
// which is similar to a UNIX shell one, had given.
// its name to the class.
//
// Class description - end :
class G4VBasicShell : public G4UIsession
{
public:
G4VBasicShell();
~G4VBasicShell() override;
G4UIsession* SessionStart() override = 0;
// null should be returned for interactive session
void PauseSessionStart(const G4String& Prompt) override = 0;
// Prompt string can be ignored
protected:
// convert "BeamOn 10" to "/run/BeamOn 10" if the
// current working directory is "/run/"
G4String ModifyToFullPathCommand(const char* aCommandLine) const;
// directory string starts with '/' and ends with '/'
G4String GetCurrentWorkingDirectory() const;
// change directory to newDir
// false will be returned if the target directory doesn't exist
G4bool ChangeDirectory(const char* newDir);
// find G4UIcommandTree object
// null returned if the taregt does not exist
G4UIcommandTree* FindDirectory(const char* dirName) const;
// find G4UIcommand object
// null returned if the target does not exist
G4UIcommand* FindCommand(const char* commandName) const;
// command completion
G4String Complete(const G4String&);
G4String FindMatchingPath(G4UIcommandTree*, const G4String&);
/////////////////////////////////////////////
// Methods involving an interactive G4cout //
/////////////////////////////////////////////
virtual void ExecuteCommand(const G4String&);
virtual G4bool GetHelpChoice(G4int&) = 0;
virtual void ExitHelp() const = 0;
void ApplyShellCommand(const G4String&, G4bool&, G4bool&);
void ShowCurrent(const G4String&) const;
void ChangeDirectoryCommand(const G4String&);
void ListDirectory(const G4String&) const;
void TerminalHelp(const G4String&);
private:
G4String ModifyPath(const G4String& tempPath) const;
G4String currentDirectory;
};
#endif