UI Elements do not go through register_factory
[gregoa/zavai.git] / 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, label = None):
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         if label is not None: self.labels[name] = label
60
61         if name.startswith("menu."):
62             self.add_to_menu(name)
63
64     def register_factory(self, name, fac, label = None):
65         """Register an object factory at the given path.
66
67         Name the path to this object, like "menu.gps.monitor".
68         """
69         if name in self.factories:
70             return KeyError("Factory %s is already registered", name)
71         zavai.info("Registering factory", name)
72         self.factories[name] = fac
73         if label is not None: self.labels[name] = label
74
75     def register_action(self, name, obj):
76         """Register an object at the given path.
77
78         Name the path to this object, like "menu.gps.monitor".
79         """
80         if name in self.objects:
81             return KeyError("%s is already registered", name)
82         zavai.info("Registering action", name)
83         self.objects[name] = obj
84
85         if name.startswith("menu."):
86             parent = get_parent(name)
87             if parent is not None:
88                 zavai.info("Add action to menu", name, parent)
89                 menu = self.menu(parent)
90                 if isinstance(obj, gtk.ToggleAction):
91                     menu.add_child(zavai.ToggleButton(self, name, action=obj))
92                 else:
93                     menu.add_child(zavai.LinkButton(self, name, action=obj))
94
95     def add_to_menu(self, name):
96         "Add the applet with the given name to the menu structure"
97         parent = get_parent(name)
98         if parent is not None:
99             zavai.info("Add to menu", name, parent)
100             menu = self.menu(parent)
101             menu.add_child(zavai.LinkButton(self, name, self.label(name)))
102
103     def label(self, name):
104         "Return the label for the object with the given name"
105         res = self.labels.get(name)
106         if res is not None:
107             return res
108         return default_label(name)
109
110     def resource(self, name):
111         """Get a resource from the registry.
112
113         If no resource exists at `name` but there is a factory, instantiate the
114         object using the factory.
115
116         If not even a factory exists at `name`, returns None.
117         """
118         res = self.objects.get(name, None)
119         if res is None:
120             fac = self.factories.get(name, None)
121             if fac is not None:
122                 res = self.objects[name] = fac(self, name)
123         return res
124
125     def menu(self, name):
126         """Get a menu resource, automatically creating it if it is missing.
127
128         Menus are created automatically linked to a parent menu, according to
129         the hierarchy in `name`.
130         """
131         res = self.resource(name)
132         if res is None:
133             # Check if it is a toplevel menu
134             if name.startswith("menu."):
135                 parent = get_parent(name[5:])
136                 if parent is not None:
137                     parent = "menu." + parent
138             else:
139                 parent = get_parent(name)
140
141             res = zavai.Menu(self, name, parent)
142             self.register(name, res)
143         return res
144
145     def shutdown(self):
146         """Shut down all objects in this Registry.
147
148         After shutting down, all objects cannot be used anymore"""
149         for o in self.objects.itervalues():
150             if isinstance(o, Resource):
151                 o.shutdown()
152         self.objects.clear()
153
154 class Resource(object):
155     def shutdown(self):
156         """Shut down this resource.
157
158         Normally one does nothing here, but it is important to give resources a
159         chance to do cleanup when the program quits.
160
161         This can be used for tasks like closing the tags on a GPX track,
162         releasing a FSO resource, restoring mixer settings and so on.
163         """
164         pass