1 #Copyright (C) 2008 Codethink Ltd
3 #This library is free software; you can redistribute it and/or
4 #modify it under the terms of the GNU Lesser General Public
5 #License version 2 as published by the Free Software Foundation.
7 #This program is distributed in the hope that it will be useful,
8 #but WITHOUT ANY WARRANTY; without even the implied warranty of
9 #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 #GNU General Public License for more details.
11 #You should have received a copy of the GNU Lesser General Public License
12 #along with this program; if not, write to the Free Software
13 #Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 from accessiblecache import AccessibleCache
18 from desktop import Desktop
19 from factory import accessible_factory
20 from event import Event as _Event
26 "TestApplicationCache",
29 #------------------------------------------------------------------------------
31 class TestApplicationCache(object):
33 Test application store, accesses a single application.
35 The store object acts as a central class for creating accessible objects.
36 It interfaces with the ATSPI registry to keep account of all accessible
37 applications. It contains the accessible cache objects from each application.
39 @registry: Each accessible cache object must have a reference to the registry
40 object to send update events.
42 @connection: D-Bus connection used to access applications.
44 @bus_name: The test store only accesses one accessible application, this is its
48 def __init__(self, registry, connection, bus_name):
49 self._connection = connection
51 self.application_list = [bus_name]
52 self.application_cache = {bus_name:AccessibleCache(registry, connection, bus_name)}
54 def get_cache_data(self, app_name, acc_path):
56 Returns the cache tuple for the given application and accessible
57 object path. Throws an IndexError if the cache data is not found.
59 return self.application_cache[app_name][acc_path]
61 def create_application(self, app_name):
63 Creates an accessible object for the root of the application
64 available at the given D-Bus name.
66 cls = accessible_factory.get_accessible_class(interfaces.ATSPI_APPLICATION)
67 return cls(app_name, self.application_cache[app_name].root, self, interfaces.ATSPI_APPLICATION)
69 def create_accessible(self, app_name, acc_path, interface, dbus_object=None):
71 Creates an accessible object.
73 @app_name: D-Bus name of the application where the accessible object resides.
75 @acc_path: D-Bus path of the object within the application.
77 @interface: D-Bus interface of the requested object. A different accessible object
78 class will be created depending on this. Making the function much like
79 an accessible object factory.
81 @dbus_object: If a D-Bus object already exists for the accessible object it can be
82 provided here so that another one is not created.
84 # An acc_path of '/' implies the desktop object, whatever the app_name.
88 cls = accessible_factory.get_accessible_class(interface)
89 return cls(app_name, acc_path, self, interface, dbus_object=dbus_object)
94 D-Bus connection used by the store.
96 return self._connection
98 #------------------------------------------------------------------------------
100 class ApplicationCache(object):
102 Test application store, accesses a single application.
104 The store object acts as a central class for creating accessible objects.
105 It interfaces with the ATSPI registry to keep account of all accessible
106 applications. It contains the accessible cache objects from each application.
108 @registry: Each accessible cache object must have a reference to the registry
109 object to send update events.
111 @connection: D-Bus connection used to access applications.
113 @bus_name: The test store only accesses one accessible application, this is its
117 _REGISTRY_PATH = '/org/freedesktop/atspi/registry'
118 _REGISTRY_INTERFACE = 'org.freedesktop.atspi.Registry'
119 _REGISTRY_NAME = 'org.freedesktop.atspi.Registry'
121 # An accessible path of '/' implies the desktop object, whatever the application name.
124 _APPLICATIONS_ADD = 1
125 _APPLICATIONS_REMOVE = 0
127 def __init__(self, registry, connection):
128 self._connection = connection
129 self._registry = registry
131 self.application_list = []
132 self.application_cache = {}
134 self._regsig = connection.add_signal_receiver(self.update_handler,
135 dbus_interface=ApplicationCache._REGISTRY_INTERFACE,
136 signal_name="updateApplications")
138 obj = connection.get_object(ApplicationCache._REGISTRY_NAME,
139 ApplicationCache._REGISTRY_PATH,
141 self._app_register = dbus.Interface(obj, ApplicationCache._REGISTRY_INTERFACE)
143 self.application_list.extend(self._app_register.getApplications())
145 def update_handler (self, update_type, bus_name):
146 if update_type == ApplicationCache._APPLICATIONS_ADD:
147 #TODO Check that app does not already exist
148 self.application_list.append(bus_name)
149 self.application_cache[bus_name] = AccessibleCache(self._registry, self._connection, bus_name)
151 ApplicationCache._DESKTOP_PATH,
152 ApplicationCache._REGISTRY_NAME,
153 "org.freedesktop.atspi.Event.Object",
156 elif update_type == ApplicationCache._APPLICATIONS_REMOVE:
157 #TODO Fail safely if app does not exist
158 self.application_list.remove(bus_name)
159 del(self.application_cache[bus_name])
161 ApplicationCache._DESKTOP_PATH,
162 ApplicationCache._REGISTRY_NAME,
163 "org.freedesktop.atspi.Event.Object",
167 self._registry._notifyChildrenChange(event)
169 def get_cache_data(self, app_name, acc_path):
171 Returns the cache tuple for the given application and accessible
172 object path. Throws an IndexError if the cache data is not found.
174 return self.application_cache[app_name][acc_path]
176 def create_application(self, app_name):
178 Creates an accessible object for the root of the application
179 available at the given D-Bus name.
181 cls = accessible_factory.get_accessible_class(interfaces.ATSPI_APPLICATION)
182 return cls(app_name, self.application_cache[app_name].root, self, interfaces.ATSPI_APPLICATION)
184 def create_accessible(self, app_name, acc_path, interface, dbus_object=None):
186 Creates an accessible object.
188 @app_name: D-Bus name of the application where the accessible object resides.
190 @acc_path: D-Bus path of the object within the application.
192 @interface: D-Bus interface of the requested object. A different accessible object
193 class will be created depending on this. Making the function much like
194 an accessible object factory.
196 @dbus_object: If a D-Bus object already exists for the accessible object it can be
197 provided here so that another one is not created.
199 if acc_path == ApplicationCache._DESKTOP_PATH:
202 cls = accessible_factory.get_accessible_class(interface)
203 return cls(app_name, acc_path, self, interface, dbus_object=dbus_object)
206 def connection(self):
208 D-Bus connection used by the store.
210 return self._connection
212 #END----------------------------------------------------------------------------