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 "G4VUIshell.hh"
0055
0056 #include <map>
0057
0058 class G4UIsession;
0059
0060 class G4UIExecutive
0061 {
0062  public:
0063   G4UIExecutive(G4int argc, char** argv, const G4String& type = "");
0064   ~G4UIExecutive();
0065
0066   G4UIsession* GetSession() const;
0067
0068   G4bool IsGUI() const;
0069
0070   void SetVerbose(G4bool val);
0071
0072   void SetPrompt(const G4String& prompt);
0073   void SetLsColor(TermColorIndex dirColor, TermColorIndex cmdColor);
0074
0075   void SessionStart();
0076
0077  private:
0078   void SelectSessionByArg(const G4String& stype);
0079   void SelectSessionByEnv();
0080   void SelectSessionByFile(const G4String& appname);
0081   void SelectSessionByBestGuess();
0082
0083   enum SessionType
0084   {
0085     kNone,
0086     kQt,
0087     kXm,
0088     kWin32,
0089     kTcsh,
0090     kCsh
0091   };
0092   SessionType selected;
0093
0094   G4UIsession* session;
0095   G4VUIshell* shell;
0096
0097   G4bool isGUI;
0098
0099   G4bool verbose;
0100
0101   std::map<G4String, G4String> sessionMap;
0102 };
0103
0104 // ====================================================================
0105 inline G4UIsession* G4UIExecutive::GetSession() const { return session; }
0106
0107 inline G4bool G4UIExecutive::IsGUI() const { return isGUI; }
0108
0109 inline void G4UIExecutive::SetVerbose(G4bool val) { verbose = val; }
0110
0111 #endif