zavai/registry.py

   1 # registry - zavai resource registry
   2 #
   3 # Copyright (C) 2009  Enrico Zini <enrico@enricozini.org>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18
  19 import zavai
  20 import gtk
  21
  22 def get_parent(s):
  23     "Get the parent name for s"
  24     pos = s.rfind(".")
  25     if pos == -1: return None
  26     res = s[:pos]
  27     if res == "menu": return None
  28     return res
  29
  30 def default_label(s):
  31     "Compute a default label given the last element of a path"
  32     pos = s.rfind(".")
  33     if pos == -1: return s.capitalize()
  34     return s[pos+1:].capitalize()
  35
  36
  37 class Registry(object):
  38     """Collection of resources.
  39
  40     Various factories can be registered by name on the registry. Then when an
  41     object is requested for the first time, it is created using the factory.
  42     When it is requested again, the existing object is reused.
  43     """
  44
  45     def __init__(self):
  46         self.factories = dict()
  47         self.objects = dict()
  48         self.labels = dict()
  49
  50     def register(self, name, obj):
  51         """Register an object at the given path.
  52
  53         Name the path to this object, like "menu.gps.monitor".
  54         """
  55         if name in self.objects:
  56             return KeyError("%s is already registered", name)
  57         zavai.info("Registering", name)
  58         self.objects[name] = obj
  59
  60         if name.startswith("menu."):
  61             self.add_to_menu(name)
  62
  63     def register_factory(self, name, fac, label = None):
  64         """Register an object factory at the given path.
  65
  66         Name the path to this object, like "menu.gps.monitor".
  67         """
  68         if name in self.factories:
  69             return KeyError("Factory %s is already registered", name)
  70         zavai.info("Registering factory", name)
  71         self.factories[name] = fac
  72         if label is not None: self.labels[name] = label
  73
  74     def add_to_menu(self, name):
  75         "Add the applet with the given name to the menu structure"
  76         parent = get_parent(name)
  77         if parent is not None:
  78             zavai.info("Add to menu", name, parent)
  79             menu = self.menu(parent)
  80
  81             obj = self.resource(name)
  82             if isinstance(obj, gtk.ToggleAction):
  83                 menu.add_child(zavai.ToggleButton(self, name, action=obj))
  84             elif isinstance(obj, gtk.Action):
  85                 menu.add_child(zavai.LinkButton(self, name, action=obj))
  86             else:
  87                 menu.add_child(zavai.LinkButton(self, name, self.label(name)))
  88
  89     def label(self, name):
  90         "Return the label for the object with the given name"
  91         res = self.labels.get(name)
  92         if res is not None:
  93             return res
  94         try:
  95             obj = self.resource(name)
  96             return obj.props.label
  97         except:
  98             return default_label(name)
  99
 100     def resource(self, name):
 101         """Get a resource from the registry.
 102
 103         If no resource exists at `name` but there is a factory, instantiate the
 104         object using the factory.
 105
 106         If not even a factory exists at `name`, returns None.
 107         """
 108         res = self.objects.get(name, None)
 109         if res is None:
 110             fac = self.factories.get(name, None)
 111             if fac is not None:
 112                 res = self.objects[name] = fac(self, name)
 113         return res
 114
 115     def menu(self, name):
 116         """Get a menu resource, automatically creating it if it is missing.
 117
 118         Menus are created automatically linked to a parent menu, according to
 119         the hierarchy in `name`.
 120         """
 121         res = self.resource(name)
 122         if res is None:
 123             # Check if it is a toplevel menu
 124             if name.startswith("menu."):
 125                 parent = get_parent(name[5:])
 126                 if parent is not None:
 127                     parent = "menu." + parent
 128             else:
 129                 parent = get_parent(name)
 130
 131             res = zavai.Menu(self, name, parent)
 132             self.register(name, res)
 133         return res
 134
 135     def shutdown(self):
 136         """Shut down all objects in this Registry.
 137
 138         After shutting down, all objects cannot be used anymore"""
 139         for o in self.objects.itervalues():
 140             if isinstance(o, Resource):
 141                 o.shutdown()
 142         self.objects.clear()
 143
 144 class Resource(object):
 145     def shutdown(self):
 146         """Shut down this resource.
 147
 148         Normally one does nothing here, but it is important to give resources a
 149         chance to do cleanup when the program quits.
 150
 151         This can be used for tasks like closing the tags on a GPX track,
 152         releasing a FSO resource, restoring mixer settings and so on.
 153         """
 154         pass