wxGUI: add experimental option to exit GRASS shell from GUI session

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@66917 15284696-431f-4ddb-bdfa-cd5b030d7da7

gui/wxpython/lmgr/frame.py

@@ -84,9 +84,10 @@ class GMFrame(wx.Frame):
     commands, tree widget page for managing map layers.
     """
     def __init__(self, parent, id = wx.ID_ANY, title = None,
-                 workspace = None,
+                 workspace = None, shellPid = None,
                  size = globalvar.GM_WINDOW_SIZE, style = wx.DEFAULT_FRAME_STYLE, **kwargs):
         self.parent    = parent
+        self._shellPid = shellPid         # process id of shell running on the background
         if title:
             self.baseTitle = title
         else:
@@ -2203,6 +2204,9 @@ class GMFrame(wx.Frame):
 
     def OnCloseWindow(self, event):
         """Cleanup when wxGUI is quitted"""
+        self._closeWindow()
+        
+    def _closeWindow(self):
         # save command protocol if actived
         if self.goutput.btnCmdProtocol.GetValue():
             self.goutput.CmdProtocolSave()
@@ -2250,10 +2254,19 @@ class GMFrame(wx.Frame):
         self.OnDisplayCloseAll()
         
         self.notebookLayers.DeleteAllPages()
-        
         self._auimgr.UnInit()
         self.Destroy()
         
+    def OnCloseWindowExitGRASS(self, event):
+        """Close wxGUI and exit GRASS shell."""
+        self._closeWindow()
+        if self._shellPid:
+            Debug.msg(1, "Exiting shell with pid={}".format(self._shellPid))
+            import signal
+            os.kill(self._shellPid, signal.SIGTERM)
+        else:
+            grass.warning(_("Unable to exit GRASS shell: unknown PID"))
+        
     def MsgNoLayerSelected(self):
         """Show dialog message 'No layer selected'"""
         wx.MessageBox(parent = self,

gui/wxpython/wxgui.py

@@ -35,13 +35,15 @@ except ImportError:
 
 
 class GMApp(wx.App):
-    def __init__(self, workspace = None):
+    def __init__(self, workspace=None, shellPid=None):
         """ Main GUI class.
 
         :param workspace: path to the workspace file
+        :param shellPid: process id of shell running on background
         """
         self.workspaceFile = workspace
-
+        self._shellPid = shellPid
+        
         # call parent class initializer
         wx.App.__init__(self, False)
 
@@ -77,8 +79,8 @@ class GMApp(wx.App):
 
         # create and show main frame
         from lmgr.frame import GMFrame
-        mainframe = GMFrame(parent = None, id = wx.ID_ANY,
-                            workspace = self.workspaceFile)
+        mainframe = GMFrame(parent=None, id=wx.ID_ANY,
+                            workspace=self.workspaceFile, shellPid=self._shellPid)
 
         mainframe.Show()
         self.SetTopWindow(mainframe)
@@ -97,18 +99,24 @@ def printHelp():
 
 def process_opt(opts, args):
     """ Process command-line arguments"""
-    workspaceFile = None
+    workspaceFile = shellPid = None
     for o, a in opts:
         if o in ("-h", "--help"):
             printHelp()
 
-        if o in ("-w", "--workspace"):
+        elif o in ("-w", "--workspace"):
             if a != '':
                 workspaceFile = str(a)
             else:
                 workspaceFile = args.pop(0)
 
-    return (workspaceFile,)
+        elif o in ("-p", "--pid"):
+            if a != '':
+                shellPid = int(a)
+            else:
+                shellPid = int(args.pop(0))
+
+    return (workspaceFile, shellPid)
 
 
 def main(argv = None):
@@ -118,18 +126,17 @@ def main(argv = None):
     try:
         try:
             opts, args = getopt.getopt(argv[1:], "hw:",
-                                       ["help", "workspace"])
+                                       ["help", "workspace", "pid"])
         except getopt.error as msg:
             raise Usage(msg)
-
     except Usage as err:
         print >> sys.stderr, err.msg
         print >> sys.stderr, "for help use --help"
         printHelp()
-
-    workspaceFile = process_opt(opts, args)[0]
-
-    app = GMApp(workspaceFile)
+    
+    workspaceFile, shellPid = process_opt(opts, args)
+    app = GMApp(workspaceFile, shellPid)
+    
     # suppress wxPython logs
     q = wx.LogNull()
     set_raise_on_error(True)

gui/wxpython/xml/toolboxes.xml

@@ -41,6 +41,7 @@
       <separator/>
       <wxgui-item name="LaunchScript"/>
       <separator/>
+      <wxgui-item name="CloseGUI"/>
       <wxgui-item name="Quit"/>
     </items>
   </toolbox>

gui/wxpython/xml/wxgui_items.xml

@@ -62,10 +62,16 @@
     <handler>OnRunScript</handler>
     <description>Launches script file.</description>
   </wxgui-item>
-  <wxgui-item name="Quit">
-    <label>Exit GUI</label>
+  <wxgui-item name="CloseGUI">
+    <label>Close GUI</label>
     <handler>OnCloseWindow</handler>
-    <description>Quit the GRASS wxGUI session.</description>
+    <description>Quit wxGUI session.</description>
+    <shortcut>Ctrl+W</shortcut>
+  </wxgui-item>
+  <wxgui-item name="Quit">
+    <label>Quit GRASS GIS</label>
+    <handler>OnCloseWindowExitGRASS</handler>
+    <description>Quit wxGUI session and exit GRASS shell.</description>
     <shortcut>Ctrl+Q</shortcut>
     <wx-id>ID_EXIT</wx-id>
   </wxgui-item>

lib/init/grass.py

@@ -1338,7 +1338,7 @@ def run_batch_job(batch_job):
     return returncode
 
 
-def start_gui(grass_gui):
+def start_gui(grass_gui, shell_pid=None):
     """Start specified GUI
 
     :param grass_gui: GUI name (allowed values: 'wxpython')
@@ -1348,9 +1348,14 @@ def start_gui(grass_gui):
     
     # Check for gui interface
     if grass_gui == "wxpython":
-        Popen([os.getenv('GRASS_PYTHON'), wxpath("wxgui.py")])
-
+        cmd = [os.getenv('GRASS_PYTHON'), wxpath("wxgui.py")]
+        if shell_pid:
+            cmd.append('--pid')
+            cmd.append(str(shell_pid))
+        
+        Popen(cmd)
 
+    
 def clear_screen():
     """Clear terminal"""
     if windows:
@@ -1456,10 +1461,11 @@ def csh_startup(location, location_name, mapset, grass_env_file):
     f.close()
     writefile(tcshrc, readfile(cshrc))
 
-    exit_val = call([gpath("etc", "run"), os.getenv('SHELL')])
-
+    process = Popen([gpath("etc", "run"), os.getenv('SHELL')])
+    
     os.environ['HOME'] = userhome
-    return exit_val
+    
+    return process
 
 
 def bash_startup(location, location_name, grass_env_file):
@@ -1512,29 +1518,27 @@ PROMPT_COMMAND=grass_prompt\n""" % (_("2D and 3D raster MASKs present"),
     f.write("export HOME=\"%s\"\n" % userhome) # restore user home path
 
     f.close()
-
-    exit_val = call([gpath("etc", "run"), os.getenv('SHELL')])
-
+    
+    process = Popen([gpath("etc", "run"), os.getenv('SHELL')])
+    
     os.environ['HOME'] = userhome
-    return exit_val
+    
+    return process
 
 
 def default_startup(location, location_name):
     if windows:
         os.environ['PS1'] = "GRASS %s> " % (grass_version)
         # "$ETC/run" doesn't work at all???
-        exit_val = subprocess.call([os.getenv('SHELL')])
+        process = subprocess.Popen([os.getenv('SHELL')])
         # TODO: is there a difference between this and clean_temp?
         # TODO: why this is missing in the other startups?
         cleanup_dir(os.path.join(location, ".tmp"))  # remove GUI session files from .tmp
     else:
         os.environ['PS1'] = "GRASS %s (%s):\\w > " % (grass_version, location_name)
-        exit_val = call([gpath("etc", "run"), os.getenv('SHELL')])
+        process = Popen([gpath("etc", "run"), os.getenv('SHELL')])
 
-    # TODO: this seems to be inconsistent, the other two are no fataling
-    if exit_val != 0:
-        fatal(_("Failed to start shell '%s'") % os.getenv('SHELL'))
-    return exit_val
+    return process
 
 
 def done_message():
@@ -1875,7 +1879,6 @@ def main():
         clean_temp()
         sys.exit(0)
     else:
-        start_gui(grass_gui)
         clear_screen()
         show_banner()
         say_hello()
@@ -1885,14 +1888,23 @@ def main():
             message(_("Launching <%s> GUI in the background, please wait...")
                     % grass_gui)
         if sh in ['csh', 'tcsh']:
-            csh_startup(mapset_settings.full_mapset, mapset_settings.location,
-                        mapset_settings.mapset, grass_env_file)
+            shell_process = csh_startup(mapset_settings.full_mapset,
+                                        mapset_settings.location,
+                                        mapset_settings.mapset,
+                                        grass_env_file)
         elif sh in ['bash', 'msh', 'cygwin']:
-            bash_startup(mapset_settings.full_mapset, mapset_settings.location,
-                         grass_env_file)
+            shell_process = bash_startup(mapset_settings.full_mapset,
+                                         mapset_settings.location,
+                                         grass_env_file)
         else:
-            default_startup(mapset_settings.full_mapset,
-                            mapset_settings.location)
+            shell_process = default_startup(mapset_settings.full_mapset,
+                                            mapset_settings.location)
+
+        start_gui(grass_gui, shell_process.pid)
+        exit_val = shell_process.wait()
+        if exit_val != 0:
+            warning(_("Failed to start shell '%s'") % os.getenv('SHELL'))
+        
         # here we are at the end of grass session
         clear_screen()
         # TODO: can we just register this atexit?