f13ec9ca5ee37533a159b7b385a968a625c241d3
[openblackhole/openblackhole-enigma2.git] / skin.py
1 from enigma import *
2 import xml.dom.minidom
3 from xml.dom import EMPTY_NAMESPACE
4 from Tools.Import import my_import
5 import os
6
7 from Components.config import ConfigSubsection, configElement, configText, config
8 from Components.Element import Element
9 from Components.Converter.Converter import Converter
10
11 from Tools.XMLTools import elementsWithTag, mergeText
12
13 colorNames = dict()
14
15 def dump(x, i=0):
16         print " " * i + str(x)
17         try:
18                 for n in x.childNodes:
19                         dump(n, i + 1)
20         except:
21                 None
22
23 from Tools.Directories import resolveFilename, SCOPE_SKIN, SCOPE_SKIN_IMAGE, SCOPE_FONTS
24
25 class SkinError(Exception):
26         def __init__(self, message):
27                 self.message = message
28
29         def __str__(self):
30                 return self.message
31
32 dom_skins = [ ]
33
34 def loadSkin(name):
35         # read the skin
36         filename = resolveFilename(SCOPE_SKIN, name)
37         path = os.path.dirname(filename) + "/"
38         dom_skins.append((path, xml.dom.minidom.parse(filename)))
39
40 # we do our best to always select the "right" value
41 # skins are loaded in order of priority: skin with
42 # highest priority is loaded last, usually the user-provided
43 # skin.
44
45 # currently, loadSingleSkinData (colors, bordersets etc.)
46 # are applied one-after-each, in order of ascending priority.
47 # the dom_skin will keep all screens in descending priority,
48 # so the first screen found will be used.
49
50 # example: loadSkin("nemesis_greenline/skin.xml")
51 config.skin = ConfigSubsection()
52 config.skin.primary_skin = configElement("config.skin.primary_skin", configText, "skin.xml", 0)
53
54 try:
55         loadSkin(config.skin.primary_skin.value)
56 except SkinError, err:
57         print "SKIN ERROR:", err
58         print "defaulting to standard skin..."
59         loadSkin('skin.xml')
60 loadSkin('skin_default.xml')
61
62 def parsePosition(str):
63         x, y = str.split(',')
64         return ePoint(int(x), int(y))
65
66 def parseSize(str):
67         x, y = str.split(',')
68         return eSize(int(x), int(y))
69
70 def parseFont(str):
71         name, size = str.split(';')
72         return gFont(name, int(size))
73
74 def parseColor(str):
75         if str[0] != '#':
76                 try:
77                         return colorNames[str]
78                 except:
79                         raise ("color '%s' must be #aarrggbb or valid named color" % (str))
80         return gRGB(int(str[1:], 0x10))
81
82 def collectAttributes(skinAttributes, node, skin_path_prefix=None, ignore=[]):
83         # walk all attributes
84         for p in range(node.attributes.length):
85                 a = node.attributes.item(p)
86                 
87                 # convert to string (was: unicode)
88                 attrib = str(a.name)
89                 # TODO: localization? as in e1?
90                 value = a.value.encode("utf-8")
91                 
92                 if attrib in ["pixmap", "pointer"]:
93                         value = resolveFilename(SCOPE_SKIN_IMAGE, value, path_prefix=skin_path_prefix)
94                 
95                 if attrib not in ignore:
96                         skinAttributes.append((attrib, value))
97
98 def loadPixmap(path):
99         ptr = loadPNG(path)
100         if ptr is None:
101                 raise "pixmap file %s not found!" % (path)
102         return ptr
103
104 def applySingleAttribute(guiObject, desktop, attrib, value):
105         # and set attributes
106         try:
107                 if attrib == 'position':
108                         guiObject.move(parsePosition(value))
109                 elif attrib == 'size':
110                         guiObject.resize(parseSize(value))
111                 elif attrib == 'title':
112                         guiObject.setTitle(_(value))
113                 elif attrib == 'text':
114                         guiObject.setText(value)
115                 elif attrib == 'font':
116                         guiObject.setFont(parseFont(value))
117                 elif attrib == 'zPosition':
118                         guiObject.setZPosition(int(value))
119                 elif attrib == "pixmap":
120                         ptr = loadPixmap(value) # this should already have been filename-resolved.
121                         # that __deref__ still scares me!
122                         desktop.makeCompatiblePixmap(ptr.__deref__())
123                         guiObject.setPixmap(ptr.__deref__())
124                         # guiObject.setPixmapFromFile(value)
125                 elif attrib == "alphatest": # used by ePixmap
126                         guiObject.setAlphatest(
127                                 { "on": True,
128                                   "off": False
129                                 }[value])
130                 elif attrib == "orientation": # used by eSlider
131                         try:
132                                 guiObject.setOrientation(
133                                         { "orVertical": guiObject.orVertical,
134                                                 "orHorizontal": guiObject.orHorizontal
135                                         }[value])
136                         except KeyError:
137                                 print "oprientation must be either orVertical or orHorizontal!"
138                 elif attrib == "valign":
139                         try:
140                                 guiObject.setVAlign(
141                                         { "top": guiObject.alignTop,
142                                                 "center": guiObject.alignCenter,
143                                                 "bottom": guiObject.alignBottom
144                                         }[value])
145                         except KeyError:
146                                 print "valign must be either top, center or bottom!"
147                 elif attrib == "halign":
148                         try:
149                                 guiObject.setHAlign(
150                                         { "left": guiObject.alignLeft,
151                                                 "center": guiObject.alignCenter,
152                                                 "right": guiObject.alignRight,
153                                                 "block": guiObject.alignBlock
154                                         }[value])
155                         except KeyError:
156                                 print "halign must be either left, center, right or block!"
157                 elif attrib == "flags":
158                         flags = value.split(',')
159                         for f in flags:
160                                 try:
161                                         fv = eWindow.__dict__[f]
162                                         guiObject.setFlag(fv)
163                                 except KeyError:
164                                         print "illegal flag %s!" % f
165                 elif attrib == "backgroundColor":
166                         guiObject.setBackgroundColor(parseColor(value))
167                 elif attrib == "foregroundColor":
168                         guiObject.setForegroundColor(parseColor(value))
169                 elif attrib == "shadowColor":
170                         guiObject.setShadowColor(parseColor(value))
171                 elif attrib == "selectionDisabled":
172                         guiObject.setSelectionEnable(0)
173                 elif attrib == "transparent":
174                         guiObject.setTransparent(int(value))
175                 elif attrib == "borderColor":
176                         guiObject.setBorderColor(parseColor(value))
177                 elif attrib == "borderWidth":
178                         guiObject.setBorderWidth(int(value))
179                 elif attrib == "scrollbarMode":
180                         guiObject.setScrollbarMode(
181                                 { "showOnDemand": guiObject.showOnDemand,
182                                         "showAlways": guiObject.showAlways,
183                                         "showNever": guiObject.showNever
184                                 }[value])
185                 elif attrib == "enableWrapAround":
186                         guiObject.setWrapAround(True)
187                 elif attrib == "pointer":
188                         (name, pos) = value.split(':')
189                         pos = parsePosition(pos)
190                         ptr = loadPixmap(name)
191                         desktop.makeCompatiblePixmap(ptr.__deref__())
192                         guiObject.setPointer(ptr.__deref__(), pos)
193                 elif attrib == 'shadowOffset':
194                         guiObject.setShadowOffset(parsePosition(value))
195                 else:
196                         raise "unsupported attribute " + attrib + "=" + value
197         except int:
198 # AttributeError:
199                 print "widget %s (%s) doesn't support attribute %s!" % ("", guiObject.__class__.__name__, attrib)
200
201 def applyAllAttributes(guiObject, desktop, attributes):
202         for (attrib, value) in attributes:
203                 applySingleAttribute(guiObject, desktop, attrib, value)
204
205 def loadSingleSkinData(desktop, dom_skin, path_prefix):
206         """loads skin data like colors, windowstyle etc."""
207         
208         skin = dom_skin.childNodes[0]
209         assert skin.tagName == "skin", "root element in skin must be 'skin'!"
210         
211         for c in elementsWithTag(skin.childNodes, "colors"):
212                 for color in elementsWithTag(c.childNodes, "color"):
213                         name = str(color.getAttribute("name"))
214                         color = str(color.getAttribute("value"))
215                         
216                         if not len(color):
217                                 raise ("need color and name, got %s %s" % (name, color))
218                                 
219                         colorNames[name] = parseColor(color)
220         
221         for c in elementsWithTag(skin.childNodes, "fonts"):
222                 for font in elementsWithTag(c.childNodes, "font"):
223                         filename = str(font.getAttribute("filename") or "<NONAME>")
224                         name = str(font.getAttribute("name") or "Regular")
225                         scale = int(font.getAttribute("scale") or "100")
226                         is_replacement = font.getAttribute("replacement") != ""
227                         addFont(resolveFilename(SCOPE_FONTS, filename, path_prefix=path_prefix), name, scale, is_replacement)
228         
229         for windowstyle in elementsWithTag(skin.childNodes, "windowstyle"):
230                 style = eWindowStyleSkinned()
231                 
232                 # defaults
233                 font = gFont("Regular", 20)
234                 offset = eSize(20, 5)
235                 
236                 for title in elementsWithTag(windowstyle.childNodes, "title"):
237                         offset = parseSize(title.getAttribute("offset"))
238                         font = parseFont(str(title.getAttribute("font")))
239
240                 style.setTitleFont(font);
241                 style.setTitleOffset(offset)
242                 
243                 for borderset in elementsWithTag(windowstyle.childNodes, "borderset"):
244                         bsName = str(borderset.getAttribute("name"))
245                         for pixmap in elementsWithTag(borderset.childNodes, "pixmap"):
246                                 bpName = str(pixmap.getAttribute("pos"))
247                                 filename = str(pixmap.getAttribute("filename"))
248                                 
249                                 png = loadPixmap(resolveFilename(SCOPE_SKIN_IMAGE, filename, path_prefix=path_prefix))
250                                 
251                                 # adapt palette
252                                 desktop.makeCompatiblePixmap(png.__deref__())
253                                 style.setPixmap(eWindowStyleSkinned.__dict__[bsName], eWindowStyleSkinned.__dict__[bpName], png.__deref__())
254
255                 for color in elementsWithTag(windowstyle.childNodes, "color"):
256                         type = str(color.getAttribute("name"))
257                         color = parseColor(color.getAttribute("color"))
258                         
259                         try:
260                                 style.setColor(eWindowStyleSkinned.__dict__["col" + type], color)
261                         except:
262                                 raise ("Unknown color %s" % (type))
263                         
264                 x = eWindowStyleManagerPtr()
265                 eWindowStyleManager.getInstance(x)
266                 x.setStyle(style)
267
268 def loadSkinData(desktop):
269         skins = dom_skins[:]
270         skins.reverse()
271         for (path, dom_skin) in skins:
272                 loadSingleSkinData(desktop, dom_skin, path)
273
274 def lookupScreen(name):
275         for (path, dom_skin) in dom_skins:
276                 # first, find the corresponding screen element
277                 skin = dom_skin.childNodes[0] 
278                 for x in elementsWithTag(skin.childNodes, "screen"):
279                         if x.getAttribute('name') == name:
280                                 return x, path
281         return None, None
282
283 def readSkin(screen, skin, name, desktop):
284         myscreen, path = lookupScreen(name)
285         
286         # otherwise try embedded skin
287         myscreen = myscreen or getattr(screen, "parsedSkin", None)
288         
289         # try uncompiled embedded skin
290         if myscreen is None and getattr(screen, "skin", None):
291                 myscreen = screen.parsedSkin = xml.dom.minidom.parseString(screen.skin).childNodes[0]
292         
293         assert myscreen is not None, "no skin for screen '" + name + "' found!"
294
295         screen.skinAttributes = [ ]
296         
297         skin_path_prefix = getattr(screen, "skin_path", path)
298
299         collectAttributes(screen.skinAttributes, myscreen, skin_path_prefix, ignore=["name"])
300         
301         screen.additionalWidgets = [ ]
302         screen.renderer = [ ]
303         
304         # now walk all widgets
305         for widget in elementsWithTag(myscreen.childNodes, "widget"):
306                 # ok, we either have 1:1-mapped widgets ('old style'), or 1:n-mapped 
307                 # widgets (source->renderer).
308
309                 wname = widget.getAttribute('name')
310                 wsource = widget.getAttribute('source')
311                 
312                 if wname is None and wsource is None:
313                         print "widget has no name and no source!"
314                         continue
315                 
316                 if wname:
317                         # get corresponding 'gui' object
318                         try:
319                                 attributes = screen[wname].skinAttributes = [ ]
320                         except:
321                                 raise SkinError("component with name '" + wname + "' was not found in skin of screen '" + name + "'!")
322
323 #                       assert screen[wname] is not Source
324                 
325                         # and collect attributes for this
326                         collectAttributes(attributes, widget, skin_path_prefix, ignore=['name'])
327                 elif wsource:
328                         # get corresponding source
329                         source = screen.get(wsource)
330                         if source is None:
331                                 raise SkinError("source '" + wsource + "' was not found in screen '" + name + "'!")
332                         
333                         wrender = widget.getAttribute('render')
334                         
335                         if not wrender:
336                                 raise SkinError("you must define a renderer with render= for source '%s'" % (wsource))
337                         
338                         for converter in elementsWithTag(widget.childNodes, "convert"):
339                                 ctype = converter.getAttribute('type')
340                                 assert ctype, "'convert'-tag needs a 'type'-attribute"
341                                 parms = mergeText(converter.childNodes).strip()
342                                 converter_class = my_import('.'.join(["Components", "Converter", ctype])).__dict__.get(ctype)
343                                 
344                                 c = None
345                                 
346                                 for i in source.downstream_elements:
347                                         if isinstance(i, converter_class) and i.converter_arguments == parms:
348                                                 c = i
349
350                                 if c is None:
351                                         print "allocating new converter!"
352                                         c = converter_class(parms)
353                                         c.connect(source)
354                                 else:
355                                         print "reused conveter!"
356         
357                                 source = c
358                         
359                         renderer_class = my_import('.'.join(["Components", "Renderer", wrender])).__dict__.get(wrender)
360                         
361                         renderer = renderer_class() # instantiate renderer
362                         
363                         renderer.connect(source) # connect to source
364                         attributes = renderer.skinAttributes = [ ]
365                         collectAttributes(attributes, widget, skin_path_prefix, ignore=['render', 'source'])
366                         
367                         screen.renderer.append(renderer)
368
369         # now walk additional objects
370         for widget in elementsWithTag(myscreen.childNodes, lambda x: x != "widget"):
371                 if widget.tagName == "applet":
372                         codeText = mergeText(widget.childNodes).strip()
373                         type = widget.getAttribute('type')
374
375                         code = compile(codeText, "skin applet", "exec")
376                         
377                         if type == "onLayoutFinish":
378                                 screen.onLayoutFinish.append(code)
379                         else:
380                                 raise SkinError("applet type '%s' unknown!" % type)
381                         
382                         continue
383                 
384                 class additionalWidget:
385                         pass
386                 
387                 w = additionalWidget()
388                 
389                 if widget.tagName == "eLabel":
390                         w.widget = eLabel
391                 elif widget.tagName == "ePixmap":
392                         w.widget = ePixmap
393                 else:
394                         raise SkinError("unsupported stuff : %s" % widget.tagName)
395                 
396                 w.skinAttributes = [ ]
397                 collectAttributes(w.skinAttributes, widget, skin_path_prefix, ignore=['name'])
398                 
399                 # applyAttributes(guiObject, widget, desktop)
400                 # guiObject.thisown = 0
401                 screen.additionalWidgets.append(w)