include/Geant4/G4UIExecutive.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 // ====================================================================
0028 //   G4UIExecutive.hh
0029 //
0030 //   This class helps automatic instantiation of user session
0031 //   according to your environment variable like G4UI_USE_XXX.
0032 //
0033 //   Usage in main():
0034 //
0035 //   ...
0036 //   #include "G4UIExecutive.hh"
0037 //
0038 //   int main(int argc, char** argv)
0039 //   {
0040 //     ...
0041 //     G4UIExecutive* myapp = new G4UIExecutive(argc, argv);
0042 //     if (session->IsGUI())
0043 //       // Do any extra for a GUI session
0044 //
0045 //     myapp-> SessionStart();
0046 //     ...
0047 //     delete myapp;
0048 //     ...
0049 //
0050 // ====================================================================
0051 #ifndef G4UI_EXECUTIVE_HH
0052 #define G4UI_EXECUTIVE_HH
0053
0054 #include "G4String.hh"
0055 #include "G4Types.hh"
0056 #include "G4VUIshell.hh"
0057
0058 #include <map>
0059
0060 class G4UIsession;
0061
0062 class G4UIExecutive
0063 {
0064  public:
0065   G4UIExecutive(G4int argc, char** argv, const G4String& type = "");
0066   ~G4UIExecutive();
0067
0068   G4UIsession* GetSession() const;
0069
0070   G4bool IsGUI() const;
0071
0072   void SetVerbose(G4bool val);
0073
0074   void SetPrompt(const G4String& prompt);
0075   void SetLsColor(TermColorIndex dirColor, TermColorIndex cmdColor);
0076
0077   void SessionStart();
0078
0079  private:
0080   void SelectSessionByArg(const G4String& stype);
0081   void SelectSessionByEnv();
0082   void SelectSessionByFile(const G4String& appname);
0083   void SelectSessionByBestGuess();
0084
0085   enum SessionType
0086   {
0087     kNone,
0088     kQt,
0089     kXm,
0090     kWin32,
0091     kTcsh,
0092     kCsh
0093   };
0094   SessionType selected;
0095
0096   G4UIsession* session;
0097   G4VUIshell* shell;
0098
0099   G4bool isGUI;
0100
0101   G4bool verbose;
0102
0103   std::map<G4String, G4String> sessionMap;
0104 };
0105
0106 // ====================================================================
0107 inline G4UIsession* G4UIExecutive::GetSession() const { return session; }
0108
0109 inline G4bool G4UIExecutive::IsGUI() const { return isGUI; }
0110
0111 inline void G4UIExecutive::SetVerbose(G4bool val) { verbose = val; }
0112
0113 #endif