1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
#
# Kiwi: a Framework and Enhanced Widgets for Python
#
# Copyright (C) 2005 Async Open Source
#
# This library 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 2.1 of the License, or (at your option) any later version.
#
# This library 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 this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA
#
# Author(s): Lorenzo Gil Sanchez <lgs@sicem.biz>
# Johan Dahlin <jdahlin@async.com.br>
#
import struct
import sys
import gobject
from kiwi.python import ClassInittableObject
def list_properties(gtype, parent=True):
"""
Return a list of all properties for GType gtype, excluding
properties in parent classes
"""
pspecs = gobject.list_properties(gtype)
if parent:
return pspecs
parent = gobject.type_parent(gtype)
parent_pspecs = gobject.list_properties(parent)
return [pspec for pspec in pspecs
if pspec not in parent_pspecs]
class PropertyObject(ClassInittableObject):
"""
I am an object which maps GObject properties to attributes
To be able to use me, you must also subclass a gobject.
"""
_default_values = {}
def __init__(self, **kwargs):
self._attributes = {}
if not isinstance(self, gobject.GObject):
raise TypeError("%r must be a GObject subclass" % self)
defaults = self._default_values.copy()
for kwarg in kwargs:
if not kwarg in defaults:
raise TypeError("Unknown keyword argument: %s" % kwarg)
defaults.update(kwargs)
for name, value in defaults.items():
self._set(name, value)
def __class_init__(cls, namespace):
# Do not try to register gobject subclasses
# If you try to instantiate an object you'll get a warning,
# So it is safe to ignore here.
if not issubclass(cls, gobject.GObject):
return
# The default value for enum GParamSpecs (returned by list_properties)
# lacks the enum wrapper so save a reference to the value, it needs to
# be done here because when we register the GType pygtk removes the
# attribute __gproperties__. It's fixed in PyGTK CVS, so it can be
# remove when we can depend on PyGTK 2.8
pytypes = {}
for prop_name, value in namespace.get('__gproperties__', {}).items():
if gobject.type_is_a(value[0], gobject.GEnum):
prop_name = prop_name.replace('-', '_')
pytypes[prop_name] = value[3]
# Register the type, here so don't have to do it explicitly, it
# can be removed in PyGTK 2.8, since it does this magic for us.
type_register(cls)
# Create python properties for gobject properties, store all
# the values in self._attributes, so do_set/get_property
# can access them. Using set property for attribute assignments
# allows us to add hooks (notify::attribute) when they change.
default_values = {}
for pspec in list_properties(cls, parent=False):
prop_name = pspec.name.replace('-', '_')
p = property(lambda self, n=prop_name: self._attributes[n],
lambda self, v, n=prop_name: self.set_property(n, v))
setattr(cls, prop_name, p)
# PyGTK 2.7.1-2.8.0 bugfix
if not hasattr(pspec, 'default_value'):
default_value = None
else:
default_value = pspec.default_value
# Resolve an integer to a real enum
if gobject.type_is_a(pspec.value_type, gobject.GEnum):
pyenum = pytypes[prop_name]
default_value = pyenum.__enum_values__[default_value]
default_values[prop_name] = default_value
cls._default_values.update(default_values)
__class_init__ = classmethod(__class_init__)
def _set(self, name, value):
func = getattr(self, 'prop_set_%s' % name, None)
if callable(func) and func:
value = func(value)
self._attributes[name] = value
def _get(self, name):
func = getattr(self, 'prop_get_%s' % name, None)
if callable(func) and func:
return func()
return self._attributes[name]
def get_attribute_names(self):
return self._attributes.keys()
def is_default_value(self, attr, value):
return self._default_values[attr] == value
def do_set_property(self, pspec, value):
prop_name = pspec.name.replace('-', '_')
self._set(prop_name, value)
def do_get_property(self, pspec):
prop_name = pspec.name.replace('-', '_')
return self._get(prop_name)
def gsignal(name, *args, **kwargs):
"""
Add a GObject signal to the current object.
@param name: name of the signal
@type name: string
@param args: types for signal parameters,
if the first one is a string 'override', the signal will be
overridden and must therefor exists in the parent GObject.
@keyword flags: One of the following:
- gobject.SIGNAL_RUN_FIRST
- gobject.SIGNAL_RUN_LAST
- gobject.SIGNAL_RUN_CLEANUP
- gobject.SIGNAL_NO_RECURSE
- gobject.SIGNAL_DETAILED
- gobject.SIGNAL_ACTION
- gobject.SIGNAL_NO_HOOKS
@keyword retval: return value in signal callback
"""
frame = sys._getframe(1)
try:
locals = frame.f_locals
finally:
del frame
if not '__gsignals__' in locals:
dict = locals['__gsignals__'] = {}
else:
dict = locals['__gsignals__']
if args and args[0] == 'override':
dict[name] = 'override'
else:
flags = kwargs.get('flags', gobject.SIGNAL_RUN_FIRST)
retval = kwargs.get('retval', None)
dict[name] = (flags, retval, args)
def _max(c):
return (1 << (8 * struct.calcsize(c)-1))-1
_MAX_INT = int(_max('i'))
_MAX_FLOAT = float(_max('f'))
_MAX_LONG = long(_max('l'))
def gproperty(name, type, *args, **kwargs):
"""
Add a GObject property to the current object.
@param name: name of property
@type name: string
@param type: type of property
@type type: type
@keyword default: default value
@keyword nick: short description
@keyword blurb: long description
@keyword minimum: minimum allowed value (only for int, float, long)
@keyword maximum: maximum allowed value (only for int, float, long)
@keyword flags: parameter flags, one of:
- PARAM_READABLE
- PARAM_READWRITE
- PARAM_WRITABLE
- PARAM_CONSTRUCT
- PARAM_CONSTRUCT_ONLY
- PARAM_LAX_VALIDATION
"""
frame = sys._getframe(1)
try:
locals = frame.f_locals
finally:
del frame
nick = kwargs.get('nick', name)
blurb = kwargs.get('blurb', '')
args = [type, nick, blurb]
if type == str:
args.append(kwargs.get('default', ''))
elif type == int:
args.append(kwargs.get('minimum', 0))
args.append(kwargs.get('maximum', _MAX_INT))
args.append(kwargs.get('default', 0))
elif type == float:
args.append(kwargs.get('minimum', 0.0))
args.append(kwargs.get('maximum', _MAX_FLOAT))
args.append(kwargs.get('default', 0.0))
elif type == long:
args.append(kwargs.get('minimum', 0L))
args.append(kwargs.get('maximum', _MAX_LONG))
args.append(kwargs.get('default', 0L))
elif type == bool:
args.append(kwargs.get('default', True))
elif gobject.type_is_a(type, gobject.GEnum):
default = kwargs.get('default')
if default is None:
raise TypeError("enum properties needs a default value")
elif not isinstance(default, type):
raise TypeError("enum value %s must be an instance of %r" %
(default, type))
args.append(default)
elif type == object:
pass
args.append(kwargs.get('flags', gobject.PARAM_READWRITE))
if not '__gproperties__' in locals:
dict = locals['__gproperties__'] = {}
else:
dict = locals['__gproperties__']
dict[name] = tuple(args)
def type_register(gtype):
"""Register the type, but only if it's not already registered
@param gtype: the class to register
"""
# copied from gobjectmodule.c:_wrap_type_register
if (getattr(gtype, '__gtype__', None) !=
getattr(gtype.__base__, '__gtype__', None)):
return False
gobject.type_register(gtype)
return True
|