source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/GettingStarted/graphicalUserInterface.xml @ 1222

<!-- ******************************************************** -->
<!--                                                          -->
<!--  [History]                                               -->
<!--    Converted to DocBook: Katsuya Amako, Aug-2006         -->
<!--    Update G4UIExecutive : Laurent Garnier, Dec-2009      -->
<!--    Reviced : Koichi Murakami, Dec-2009                   -->
<!--                                                          -->
<!-- ******************************************************** -->


<!-- ******************* Section (Level#1) ****************** -->
<sect1 id="sect.HowToSetUpInter">
<title>
How to Set Up an Interactive Session
</title>


<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.HowToSetUpInter.Intro">
<title>
Introduction
</title>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToSetUpInter.Intro.RolesIntercoms">
<title>
Roles of the "intercoms" category
</title>

<para>
The "intercoms" category provides an expandable command interpreter.
It is the key mechanism of Geant4 to realize secure user interactions
in all categories without being annoyed by the dependencies among categories. 
<!-- 
The direct use
of Geant4 classes in a C++ program offers a first ground level of
interactivity, i.e., the batch session. As seen in the
examples/novice/N01, Geant4 commands and macros are to be
hard-coded in the program.-->
The Geant4 commands can be used both in a interactive terminal session and 
in a batch mode with a maco file or a direct C++ call. 
</para>


</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToSetUpInter.Intro.UserInterfaces">
<title>
User Interfaces to steer the simulation
</title>

<para>
Geant4 can be controllled by a seriese of Geant4 UI commands.
The "intercoms" category provides the abstract class 
<emphasis>G4UIsession</emphasis> that processes interactive commands. 
The concrete implementation of (graphical) user interfaceis is located
in the "interfaces" category. This interfacing strategy opens an
important door towards various user interface tools, 
and allows Geant4 to utilize the state-of-the-art GUI tools 
such as Motif, Qt, and Java etc.
The richness of the collaboration realizes
various user interfaces to the Geant4 command system.
The following interfaces is currently available;

<orderedlist spacing="compact">
  <listitem><para>
  Character terminal (dumb terminal and tcsh-like terminal), 
  that is the default user interface of Geant4
  </para></listitem>
  <listitem><para>
  Xm, Xaw, Win32, Qt variations of the above terminal by using a
  Motif, Athena, Qt or Windows widget
  </para></listitem>
  <listitem><para>
  GAG, a fully graphical user interface and its network extension
  GainServer of the client/server type.
  </para></listitem>
</orderedlist>
</para>

<para>
Implementation of the user sesssions (1 and 2) is included 
in the <literal>source/interfaces/basic</literal> directory.
As for GAG, the front-end class is included
in the source/interfaces/GAG directory,
while its partner GUI package MOMO.jar is available 
under the <literal>environments/MOMO</literal> directory. 
MOMO.jar, Java archive file, contains 
not only GAG, but also GGE and other helper packages.
Supplementary information is available 
from the author's web page (see URL below). 
</para>

<para>
GAG, GainServer's client GUI Gain: 
<ulink url="http://www-geant4.kek.jp/~yoshidah">
http://www-geant4.kek.jp/~yoshidah
</ulink>
</para>

</sect3>
</sect2>

<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.HowToSetUpInter.DescInter">
<title>
A Short Description of Available Interface Classes
</title>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToSetUpInter.DescInter.G4UI">
<title>
<emphasis>G4UIterminal</emphasis> and <emphasis>G4UItcsh</emphasis> classes
</title>

<para>
These interfaces open a session on the character terminal. 
<emphasis>G4UIterminal</emphasis> runs on all platforms supported by Geant4, 
including <emphasis>cygwin</emphasis> on Windows.

The following built-in commands are available in 
<emphasis>G4UIterminal</emphasis>;

<variablelist>
  <varlistentry>
    <term>cd, pwd</term>
    <listitem>
    change, display the current command directory.
    </listitem>
  </varlistentry>

  <varlistentry>
    <term>ls, lc</term>
    <listitem>
    list commands and subdirectories in the current directory.
    </listitem>
  </varlistentry>

  <varlistentry>
    <term>history</term>
    <listitem>
    show previous commands.
    </listitem>
  </varlistentry>

  <varlistentry>
    <term>!historyID</term>
    <listitem>
    reissue previous command.
    </listitem>
  </varlistentry>

  <varlistentry>
    <term>?command</term>
    <listitem>
    show current parameter values of the command.
    </listitem>
  </varlistentry>

  <varlistentry>
    <term>help command</term>
    <listitem>
    show command help.
    </listitem>
  </varlistentry>

  <varlistentry>
    <term>exit</term>
    <listitem>
    terminate the session.
    </listitem>
  </varlistentry>
</variablelist>

G4UItcsh supports user-friendly key bindings a-la-tcsh.
<emphasis>G4UItcsh</emphasis> runs on Solaris and Linux.
The following keybindings are supported;

<variablelist>
  <varlistentry>
    <term>^A</term>
    <listitem>
    move cursor to the top
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^B</term>
    <listitem>
    backward cursor ([LEFT] cursor)
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^C (except Windows terminal)</term>
    <listitem>
    abort a run (<emphasis>soft abort</emphasis>) during event processing. 
    A program will be terminated while accepting a user command. 
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^D</term>
    <listitem>
    delete/exit/show matched list
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^E</term>
    <listitem>
    move cursor to the end
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^F</term>
    <listitem>
    forward cursor ([RIGHT] cursor)
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^K</term>
    <listitem>
    clear after the cursor
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^N</term>
    <listitem>
    next command ([DOWN] cursor)
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>^P</term>
    <listitem>
    previous command ([UP] cursor)
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>TAB</term>
    <listitem>
    command completion
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>DEL</term>
    <listitem>
    backspace
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>BS</term>
    <listitem>
    backspace
    </listitem>
  </varlistentry>
</variablelist>
</para>

<para>
The example below shows how to set a user's prompt.
<informalexample>
<programlisting>
  G4UItcsh* tcsh = new G4UItcsh();
  tcsh-> SetPrompt("%s&gt;");
</programlisting>
</informalexample>

The following strings are supported as substitutions in a prompt string.
<variablelist>
  <varlistentry>
    <term>%s</term>
    <listitem>
    current application status
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>%/</term>
    <listitem>
    current working directory
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>%h</term>
    <listitem>
    history number
    </listitem>
  </varlistentry>
</variablelist>
</para>

<para>
Command history in a user's session is saved 
in a file <literal>$(HOME)/.g4_hist</literal>
that is automatically read at the next session, 
so that command history is available across sessions.
</para>

</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToSetUpInter.DescInter.G4UIXm">
<title>
<emphasis>G4UIXm</emphasis>, <emphasis>G4UIXaw</emphasis>, <emphasis>G4UIQt</emphasis> and 
<emphasis>G4UIWin32</emphasis> classes
</title>

<para>
These interfaces are versions of <emphasis>G4UIterminal</emphasis> 
implemented over libraries Motif, Athena, Qt and WIN32 respectively. 
<emphasis>G4UIXm</emphasis> uses the Motif XmCommand widget, 
<emphasis>G4UIXaw</emphasis> the Athena dialog
widget, <emphasis>G4UIQt</emphasis> the Qt dialog widget, 
and <emphasis>G4UIWin32</emphasis> the Windows "edit" component to do the
command capturing. These interfaces are useful if working in
conjunction with visualization drivers that use the Xt library, Qt library or
the WIN32 one.
</para>

<para>
A command box is at disposal for entering or recalling Geant4 commands.
Command completion by typing "TAB" key is
available in the command box. The shell commands "exit, cont,
help, ls, cd..." are also supported. A menu bar can be customized
through the <emphasis>AddMenu</emphasis> and 
<emphasis>AddButton</emphasis> method. Ex:

<variablelist>
  <varlistentry>
    <term>/gui/addMenu</term>
    <listitem>
    test Test
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>/gui/addButton</term>
    <listitem>
    test Init /run/initialize
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>/gui/addButton</term>
    <listitem>
    test "Set gun" "/control/execute gun.g4m"
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>/gui/addButton</term>
    <listitem>
    test "Run one event" "/run/beamOn 1"
    </listitem>
  </varlistentry>
</variablelist>
</para>

<para>
<emphasis>G4UIXm</emphasis> runs on Unix/Linux with Motif. <emphasis>G4UIXaw</emphasis>, 
less user friendly, runs on Unix with Athena widgets. <emphasis>G4UIQt</emphasis> run 
everywhere with Qt.
<emphasis>G4UIWin32</emphasis> runs on Windows.
</para>

</sect3>


<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToSetUpInter.DescInter.G4UIGAG">
<title>
<emphasis>G4UIGAG</emphasis> and <emphasis>G4UIGainServer</emphasis> classes
</title>

<para>
They are the front-end classes of Geant4 which make connection with their
respective graphical user interfaces, GAG (Geant4 Adaptive GUI) via pipe, and Gain
(Geant4 adaptive interface for network) via sockets. While GAG must run on the same 
system (Windows or Unixen) as a Geant4 application, Gain can run on a
remote system (Windows, Linux, etc.) in which JRE (Java Runtime
Environment) is installed. A Geant4 application is invoked on a Unix
(Linux) system and behaves as a network server. It opens a port,
waiting the connection from the Gain. Gain is capable to connect to
multiple Geant4 "servers" on Unixen systems at different
institutes.
</para>

<para>
Client GUIs, GAG and Gain have almost similar look-and-feel. So,
GAG's functionalities are briefly explained here. 
Please refer to the URL previously mentioned for details.
</para>

<para>
Using GAG, user
can select a command, set its parameters and execute it. It is adaptive, in the sense that it
reflects the internal states of Geant4 that is a state machine. So, GAG  always provides users with
the Geant4 commands which may be added, deleted, enabled or disabled during a session. GAG does nothing by itself but to play an intermediate between user and 
 an executable simulation program via pipes. Geant4's
front-end class <emphasis>G4UIGAG</emphasis> must be instantiated to 
communicate with GAG. GAG runs on Linux and Windows.  MOMO.jar can be run by a command;
</para>

<informalexample>
<programlisting>
   %java -jar  $G4INSTALL/environments/MOMO/MOMO.jar
</programlisting>
</informalexample>

<para>
GAG has following functions.

<variablelist>
  <varlistentry>
    <term>GAG Menu:</term>
    <listitem>
    The menus are to choose and run a Geant4 executable file, to kill or exit
    a Geant4 process and to exit GAG. Upon the normal exit or an
    unexpected death of the Geant4 process, GAG window are
    automatically reset to run another Geant4 executable.    
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>Geant4 Command tree:</term>
    <listitem>
    Upon the establishment of the pipe connection with the Geant4 process, GAG displays
    the command menu, using expandable tree browser whose look and feel is similar to
    a file browser. Disabled commands are shown in opaque. GAG
    doesn't display commands that are just below the root of
    the command hierarchy. Direct type-in field is available for such
    input. Guidance of command categories and commands are displayed
    upon focusing. GAG has a command history function. User can
    re-execute a command with old parameters, edit the history, or save
    the history to create a macro file.
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>Command Parameter panel:</term>
    <listitem>
    GAG's parameter panel is the user-friendliest part. It displays parameter 
    name, its guidance, its type(s) (integer, double, Boolean or string), 
    omittable, default value(s), expression(s) of its range and candidate list(s)
    (for example, of units). Range check is done by intercoms and
    the error message from it is shown in the pop-up dialog box. When a
    parameter component has a candidate list, a list box is
    automatically displayed . When a file is requested by a command,
    the file chooser is available.
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>Logging:</term>
    <listitem>
    Log can be redirected to the terminal (xterm or cygwin
    window) from which GAG is invoked. It can be interrupted as will,
    in the middle of a long session of execution. Log can be saved to a
    file independent of the above redirection . GAG displays warning or
    error messages from Geant4 in a pop-up warning widget.
    </listitem>
  </varlistentry>
</variablelist>
</para>

</sect3>
</sect2>


<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.HowToSetUpInter.BuildLib">
<title>
Building the Interface Libraries
</title>

<para>
The libraries that do not depend on external packages are created by default,
using Geant4 configure scripts. 
They include <emphasis>G4UIterminal</emphasis>, <emphasis>G4UItcsh</emphasis>
and <emphasis>G4UIGAG</emphasis> in libraries <emphasis>libG4UIbasic.a/so</emphasis> and
<emphasis>libG4UIGAG.a/so</emphasis>. <emphasis>G4UIGainServer.o</emphasis> is packed in
the <emphasis>libG4UIGAG</emphasis>.
</para>

<para>
To make the libraries of <emphasis>G4UIXm</emphasis>, <emphasis>G4UIXaw</emphasis>,
 <emphasis>G4UIQt</emphasis> and
<emphasis>G4UIWin32</emphasis> , respective environment variables
<emphasis role="bold">G4UI_BUILD_XM_SESSION</emphasis>, 
<emphasis role="bold">G4UI_BUILD_XAW_SESSION</emphasis>,
<emphasis role="bold">G4UI_BUILD_QT_SESSION</emphasis> and
<emphasis role="bold">G4UI_BUILD_WIN32_SESSION</emphasis> must be set
explicitly before creating libraries.
</para>

<para>
If the environment variable <emphasis role="bold">G4UI_NONE</emphasis> is
set, no interface libraries are built at all.
</para>

<para>
The scheme of building the user interface libraries is
specified in "$G4INSTALL/config/G4UI_BUILD.gmk" makefile and the
dependencies on the external packages are specified in
"$G4INSTALL/config/interactivity.gmk".
</para>

</sect2>

<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.HowToSetUpInter.HowToUseInter">
<title>
How to Use the Interface in Your Application
</title>

<para>
To use a given interface
(<literal>G4UIxxx</literal> where <literal>xxx = terminal,Xm, Xaw, Win32, Qt, 
GAG, GainServer</literal>) in your program, there are two ways.

<itemizedlist spacing="compact">
   <listitem> Calling G4UIxxx directly :
   <informalexample>
   <programlisting>
   #include "G4Uixxx.hh"
// to instantiate a session of your choice and start the session
   G4UIsession* session = new G4UIxxx;
   session-&gt;SessionStart();
// the line next to the "SessionStart" is necessary to finish the session
   delete session;
   </programlisting>
   </informalexample>

   If you want to select a session type according to your environment variable,
   the code can be:

   <informalexample>
   <programlisting>
// to include the class definition in the main program:
   #if defined(G4UI_USE_TCSH)
     #include "G4UIterminal.hh"
     #include "G4UItcsh.hh"
   #elif defined(G4UI_USE_XM)
     #include "G4UIXm.hh"
   ....
   #endif

   #if defined(G4UI_USE_TCSH)
     session = new G4UITerminal(new G4UItcsh);
   #elif defined(G4UI_USE_XM)
     session = new G4UIXm(argc,argv);
   #elif ...
  </programlisting>
  </informalexample>

   Note : For a tcsh session, the second line must be 
   <informalexample>
   <programlisting>
      G4UIsession* session = new G4UIterminal(new G4UItcsh);
   </programlisting>
   </informalexample>

If the user wants to deactivate the default signal handler (soft abort)
raised by "Ctr-C", the false flag can be set in the second argument 
of the <emphasis>G4UIterminal</emphasis> constructor like;

<informalexample>
<programlisting>
   G4UIsession* session = new G4UIterminal(new G4UItcsh, false).
</programlisting>
</informalexample>
   </listitem>


   <listitem>Using <emphasis>G4UIExecutive</emphasis>
   (implemented in all novice examples) :

   The above code is rather troublesome. 
   This is more convenient way for choosing a session type.
     <informalexample>
     <programlisting>
// to include the class definition in the main program:
   #ifdef G4UI_USE
     #include "G4UIExecutive.hh"
   #endif
// to instantiate a session of your choice and start the session
   #ifdef G4UI_USE
     G4UIExecutive* ui = new G4UIExecutive(argc,argv);
     ui-&gt;SessionStart();
// the line next to the "SessionStart" is necessary to finish the session
     delete ui;
   #endif
     </programlisting>
     </informalexample>
   </listitem>
</itemizedlist>
</para>


<para>
A corresponding environment variable must be preset 
to select a given interface.
But some of them are set by defaults for your convenience.

<itemizedlist spacing="compact">
   <listitem><para>
   <emphasis>G4UIterminal</emphasis>, <emphasis>G4UItcsh</emphasis>, 
   <emphasis>G4UIGAG</emphasis> and <emphasis>G4UIGainServer</emphasis> 
   can be used without setting any environment
   variables. Sessions not needing external packages or libraries are
   always built (see "G4UI_BUILD.gmk") and linked, so the user can
   instantiate one of these sessions without rebuilding the libraries
   and without setting any environment variables. 
   <!--For backwards
   compatibility with user code, as typified by geant4/examples main
   programs, the C-pre-processor variables corresponding to the
   original environment variables for the above three (i.e.,
   <emphasis role="bold">G4UI_USE_TERMINAL</emphasis>, 
   <emphasis role="bold">G4UI_USE_TCSH</emphasis> and
   <emphasis role="bold">G4UI_USE_GAG</emphasis> ) are set. However, 
   if he/she sets no environment variables, then the C-pre-processor variable
   <emphasis role="bold">G4UI_USE_TERMINAL</emphasis> is set by default, 
   although there is no need to use it.-->
   </para></listitem>
   <listitem><para>
   The environment variable <emphasis role="bold">G4UI_USE_XM</emphasis>, 
<emphasis role="bold">G4UI_USE_QT</emphasis>,   <emphasis role="bold">G4UI_USE_XAW</emphasis> or
   <emphasis role="bold">G4UI_USE_WIN32</emphasis> must be set to use the 
   respective interface. The file "$G4INSTALL/config/G4UI_USE.gmk"
   resolves their dependencies on external packages.
   </para></listitem>
   <listitem><para>
   If the environment variable <emphasis role="bold">G4UI_NONE</emphasis> is
   set, no external libraries are selected. Also, for your convenience, if any
   <emphasis role="bold">G4UI_USE_XXX</emphasis> environment variable is set, 
   then the corresponding C-pre-processor flag is also set. However, if the
   environment variable <emphasis role="bold">G4UI_NONE</emphasis> is set, 
   no C-pre-processor flags are set.
   </para></listitem>
</itemizedlist>
</para>

</sect2>
</sect1>