Added hooke.plugin.playlist.ApplyCommandStack and related changes.
[hooke.git] / hooke / hooke.py
index ccea160687edaa714e5bbbd15204224682104a12..c475d3acb756d42bdff14328f84990f20659fa02 100644 (file)
@@ -5,15 +5,15 @@
 #
 # This file is part of Hooke.
 #
-# Hooke is free software: you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation, either
-# version 3 of the License, or (at your option) any later version.
+# Hooke is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
 #
-# Hooke is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
+# Hooke is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
+# Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with Hooke.  If not, see
@@ -59,16 +59,19 @@ import logging.config
 import multiprocessing
 import optparse
 import os.path
+import Queue
 import unittest
 import StringIO
 import sys
 
-from . import engine as engine
+from . import version
+from . import engine
 from . import config as config_mod
-from . import playlist as playlist
+from . import playlist
 from . import plugin as plugin_mod
 from . import driver as driver_mod
-from . import ui as ui
+from . import ui
+from .compat import forking as forking  # dynamically patch multiprocessing.forking
 
 
 class Hooke (object):
@@ -88,13 +91,12 @@ class Hooke (object):
         self.load_plugins()
         self.load_drivers()
         self.load_ui()
-        self.command = engine.CommandEngine()
+        self.engine = engine.CommandEngine()
         self.playlists = playlist.NoteIndexList()
 
     def load_log(self):
         config_file = StringIO.StringIO()
         self.config.write(config_file)
-        x = config_file.getvalue()
         logging.config.fileConfig(StringIO.StringIO(config_file.getvalue()))
         # Don't attach the logger because it contains an unpicklable
         # thread.lock.  Instead, grab it directly every time you need it.
@@ -106,6 +108,8 @@ class Hooke (object):
         self.commands = []
         for plugin in self.plugins:
             self.commands.extend(plugin.commands())
+        self.command_by_name = dict(
+            [(c.name, c) for c in self.commands])
 
     def load_drivers(self):
         self.drivers = plugin_mod.load_graph(
@@ -114,8 +118,19 @@ class Hooke (object):
     def load_ui(self):
         self.ui = ui.load_ui(self.config)
 
-    def close(self):
-        self.config.write() # Does not preserve original comments
+    def close(self, save_config=False):
+        if save_config == True:
+            self.config.write()  # Does not preserve original comments
+
+    def run_command(self, command, arguments):
+        """Run the command named `command` with `arguments` using
+        :meth:`~hooke.engine.CommandEngine.run_command`.
+
+        Allows for running commands without spawning another process
+        as in :class:`HookeRunner`.
+        """
+        self.engine.run_command(self, command, arguments)
+
 
 class HookeRunner (object):
     def run(self, hooke):
@@ -152,20 +167,29 @@ class HookeRunner (object):
         command_to_ui = multiprocessing.Queue()
         manager = multiprocessing.Manager()
         command = multiprocessing.Process(name='command engine',
-            target=hooke.command.run, args=(hooke, ui_to_command, command_to_ui))
+            target=hooke.engine.run, args=(hooke, ui_to_command, command_to_ui))
         command.start()
+        hooke.engine = None  # no more need for the UI-side version.
         return (ui_to_command, command_to_ui, command)
 
     def _cleanup_run(self, ui_to_command, command_to_ui, command):
-        ui_to_command.put(ui.CloseEngine())
-        hooke = command_to_ui.get()
-        assert isinstance(hooke, Hooke)
+        log = logging.getLogger('hooke')
+        log.debug('cleanup sending CloseEngine')
+        ui_to_command.put(engine.CloseEngine())
+        hooke = None
+        while not isinstance(hooke, Hooke):
+            log.debug('cleanup waiting for Hooke instance from the engine.')
+            hooke = command_to_ui.get(block=True)
+            log.debug('cleanup got %s instance' % type(hooke))
         command.join()
         return hooke
 
 
 def main():
     p = optparse.OptionParser()
+    p.add_option(
+        '--version', dest='version', default=False, action='store_true',
+        help="Print Hooke's version information and exit.")
     p.add_option(
         '-s', '--script', dest='script', metavar='FILE',
         help='Script of command line Hooke commands to run.')
@@ -173,6 +197,16 @@ def main():
         '-c', '--command', dest='commands', metavar='COMMAND',
         action='append', default=[],
         help='Add a command line Hooke command to run.')
+    p.add_option(
+        '-p', '--persist', dest='persist', action='store_true', default=False,
+        help="Don't exit after running a script or commands.")
+    p.add_option(
+        '--save-config', dest='save_config',
+        action='store_true', default=False,
+        help="Automatically save a changed configuration on exit.")
+    p.add_option(
+        '--debug', dest='debug', action='store_true', default=False,
+        help="Enable debug logging.")
     options,arguments = p.parse_args()
     if len(arguments) > 0:
         print >> sys.stderr, 'More than 0 arguments to %s: %s' \
@@ -183,18 +217,25 @@ def main():
     hooke = Hooke(debug=__debug__)
     runner = HookeRunner()
 
+    if options.version == True:
+        print version()
+        sys.exit(0)
+    if options.debug == True:
+        hooke.config.set(
+            section='handler_hand1', option='level', value='NOTSET')
+        hooke.load_log()
     if options.script != None:
-        f = open(os.path.expanduser(options.script), 'r')
-        options.commands.extend(f.readlines())
-        f.close
+        with open(os.path.expanduser(options.script), 'r') as f:
+            options.commands.extend(f.readlines())
     if len(options.commands) > 0:
         try:
             hooke = runner.run_lines(hooke, options.commands)
         finally:
-            hooke.close()
-        sys.exit(0)
+            if options.persist == False:
+                hooke.close(save_config=options.save_config)
+                sys.exit(0)
 
     try:
         hooke = runner.run(hooke)
     finally:
-        hooke.close()
+        hooke.close(save_config=options.save_config)