1 from Tools.Profile import profile, profile_final
2 profile("LOAD:ElementTree")
3 import xml.etree.cElementTree
6 profile("LOAD:enigma_skin")
7 from enigma import eSize, ePoint, gFont, eWindow, eLabel, ePixmap, eWindowStyleManager, \
8 addFont, gRGB, eWindowStyleSkinned
10 from Components.config import ConfigSubsection, ConfigText, config
11 from Components.Converter.Converter import Converter
12 from Components.Sources.Source import Source, ObsoleteSource
13 from Tools.Directories import resolveFilename, SCOPE_SKIN, SCOPE_SKIN_IMAGE, SCOPE_FONTS, SCOPE_CURRENT_SKIN, fileExists
14 from Tools.Import import my_import
15 from Tools.LoadPixmap import LoadPixmap
17 from Tools.XMLTools import elementsWithTag, mergeText
22 print " " * i + str(x)
24 for n in x.childNodes:
29 class SkinError(Exception):
30 def __init__(self, message):
31 self.message = message
40 filename = resolveFilename(SCOPE_SKIN, name)
41 mpath = path.dirname(filename) + "/"
42 dom_skins.append((mpath, xml.etree.cElementTree.parse(filename)))
44 # we do our best to always select the "right" value
45 # skins are loaded in order of priority: skin with
46 # highest priority is loaded last, usually the user-provided
49 # currently, loadSingleSkinData (colors, bordersets etc.)
50 # are applied one-after-each, in order of ascending priority.
51 # the dom_skin will keep all screens in descending priority,
52 # so the first screen found will be used.
54 # example: loadSkin("nemesis_greenline/skin.xml")
55 config.skin = ConfigSubsection()
56 config.skin.primary_skin = ConfigText(default = "skin.xml")
60 loadSkin(config.skin.primary_skin.value)
61 except (SkinError, IOError, AssertionError), err:
62 print "SKIN ERROR:", err
63 print "defaulting to standard skin..."
64 config.skin.primary_skin.value = 'skin.xml'
67 profile("LoadSkinDefault")
68 loadSkin('skin_default.xml')
69 profile("LoadSkinDefaultDone")
71 def parsePosition(str):
73 return ePoint(int(x), int(y))
77 return eSize(int(x), int(y))
80 name, size = str.split(';')
81 return gFont(name, int(size))
86 return colorNames[str]
88 raise SkinError("color '%s' must be #aarrggbb or valid named color" % (str))
89 return gRGB(int(str[1:], 0x10))
91 def collectAttributes(skinAttributes, node, skin_path_prefix=None, ignore=[]):
93 for a in node.items():
98 if attrib in ["pixmap", "pointer", "seek_pointer", "backgroundPixmap", "selectionPixmap"]:
99 value = resolveFilename(SCOPE_SKIN_IMAGE, value, path_prefix=skin_path_prefix)
101 if attrib not in ignore:
102 skinAttributes.append((attrib, value))
104 def loadPixmap(path, desktop):
106 option = path.find("#")
108 options = path[option+1:].split(',')
110 cached = "cached" in options
111 ptr = LoadPixmap(path, desktop, cached)
113 raise SkinError("pixmap file %s not found!" % (path))
116 def applySingleAttribute(guiObject, desktop, attrib, value):
119 if attrib == 'position':
120 guiObject.move(parsePosition(value))
121 elif attrib == 'size':
122 guiObject.resize(parseSize(value))
123 elif attrib == 'title':
124 guiObject.setTitle(_(value))
125 elif attrib == 'text':
126 guiObject.setText(_(value))
127 elif attrib == 'font':
128 guiObject.setFont(parseFont(value))
129 elif attrib == 'zPosition':
130 guiObject.setZPosition(int(value))
131 elif attrib in ["pixmap", "backgroundPixmap", "selectionPixmap"]:
132 ptr = loadPixmap(value, desktop) # this should already have been filename-resolved.
133 if attrib == "pixmap":
134 guiObject.setPixmap(ptr)
135 elif attrib == "backgroundPixmap":
136 guiObject.setBackgroundPicture(ptr)
137 elif attrib == "selectionPixmap":
138 guiObject.setSelectionPicture(ptr)
139 # guiObject.setPixmapFromFile(value)
140 elif attrib == "alphatest": # used by ePixmap
141 guiObject.setAlphatest(
146 elif attrib == "orientation": # used by eSlider
148 guiObject.setOrientation(
149 { "orVertical": guiObject.orVertical,
150 "orHorizontal": guiObject.orHorizontal
153 print "oprientation must be either orVertical or orHorizontal!"
154 elif attrib == "valign":
157 { "top": guiObject.alignTop,
158 "center": guiObject.alignCenter,
159 "bottom": guiObject.alignBottom
162 print "valign must be either top, center or bottom!"
163 elif attrib == "halign":
166 { "left": guiObject.alignLeft,
167 "center": guiObject.alignCenter,
168 "right": guiObject.alignRight,
169 "block": guiObject.alignBlock
172 print "halign must be either left, center, right or block!"
173 elif attrib == "flags":
174 flags = value.split(',')
177 fv = eWindow.__dict__[f]
178 guiObject.setFlag(fv)
180 print "illegal flag %s!" % f
181 elif attrib == "backgroundColor":
182 guiObject.setBackgroundColor(parseColor(value))
183 elif attrib == "backgroundColorSelected":
184 guiObject.setBackgroundColorSelected(parseColor(value))
185 elif attrib == "foregroundColor":
186 guiObject.setForegroundColor(parseColor(value))
187 elif attrib == "foregroundColorSelected":
188 guiObject.setForegroundColorSelected(parseColor(value))
189 elif attrib == "shadowColor":
190 guiObject.setShadowColor(parseColor(value))
191 elif attrib == "selectionDisabled":
192 guiObject.setSelectionEnable(0)
193 elif attrib == "transparent":
194 guiObject.setTransparent(int(value))
195 elif attrib == "borderColor":
196 guiObject.setBorderColor(parseColor(value))
197 elif attrib == "borderWidth":
198 guiObject.setBorderWidth(int(value))
199 elif attrib == "scrollbarMode":
200 guiObject.setScrollbarMode(
201 { "showOnDemand": guiObject.showOnDemand,
202 "showAlways": guiObject.showAlways,
203 "showNever": guiObject.showNever
205 elif attrib == "enableWrapAround":
206 guiObject.setWrapAround(True)
207 elif attrib == "pointer" or attrib == "seek_pointer":
208 (name, pos) = value.split(':')
209 pos = parsePosition(pos)
210 ptr = loadPixmap(name, desktop)
211 guiObject.setPointer({"pointer": 0, "seek_pointer": 1}[attrib], ptr, pos)
212 elif attrib == 'shadowOffset':
213 guiObject.setShadowOffset(parsePosition(value))
214 elif attrib == 'noWrap':
215 guiObject.setNoWrap(1)
217 raise SkinError("unsupported attribute " + attrib + "=" + value)
220 print "widget %s (%s) doesn't support attribute %s!" % ("", guiObject.__class__.__name__, attrib)
222 def applyAllAttributes(guiObject, desktop, attributes):
223 for (attrib, value) in attributes:
224 applySingleAttribute(guiObject, desktop, attrib, value)
226 def loadSingleSkinData(desktop, dom_skin, path_prefix):
227 """loads skin data like colors, windowstyle etc."""
228 skin = dom_skin.getroot()
229 assert skin.tag == "skin", "root element in skin must be 'skin'!"
231 #print "***SKIN: ", path_prefix
233 for c in skin.getiterator("output"):
234 id = int(c.get('id') or "0")
235 if id == 0: # framebuffer
236 for res in c.getiterator("resolution"):
237 xres = int(res.get("xres" or "720"))
238 yres = int(res.get("yres" or "576"))
239 bpp = int(res.get("bpp" or "32"))
241 #print "Resolution:", xres,yres,bpp
243 from enigma import gFBDC
244 i = gFBDC.getInstance()
245 i.setResolution(xres, yres)
248 # load palette (not yet implemented)
251 for c in skin.getiterator("colors"):
252 for color in c.getiterator("color"):
253 name = str(color.get("name"))
254 color = str(color.get("value"))
257 raise ("need color and name, got %s %s" % (name, color))
259 colorNames[name] = parseColor(color)
260 #print "Color:", name, color
262 for c in skin.getiterator("fonts"):
263 for font in c.getiterator("font"):
264 filename = str(font.attrib.get("filename", "<NONAME>"))
265 name = str(font.get("name", "Regular"))
266 scale = int(font.get("scale", "100"))
267 is_replacement = font.get("replacement") != ""
268 resolved_font = resolveFilename(SCOPE_FONTS, filename, path_prefix=path_prefix)
269 if not fileExists(resolved_font): #when font is not available look at current skin path
270 skin_path = resolveFilename(SCOPE_CURRENT_SKIN, filename)
271 if fileExists(skin_path):
272 resolved_font = skin_path
273 addFont(resolved_font, name, scale, is_replacement)
274 #print "Font: ", resolved_font, name, scale, is_replacement
276 for windowstyle in skin.getiterator("windowstyle"):
277 style = eWindowStyleSkinned()
278 id = int(windowstyle.attrib.get("id","0"))
280 #print "windowstyle:", id
283 font = gFont("Regular", 20)
284 offset = eSize(20, 5)
286 for title in windowstyle.getiterator("title"):
287 offset = parseSize(title.get("offset"))
288 font = parseFont(str(title.get("font")))
290 style.setTitleFont(font);
291 style.setTitleOffset(offset)
292 #print " ", font, offset
294 for borderset in windowstyle.getiterator("borderset"):
295 bsName = str(borderset.get("name"))
296 for pixmap in borderset.getiterator("pixmap"):
297 bpName = str(pixmap.get("pos"))
298 filename = str(pixmap.get("filename"))
300 png = loadPixmap(resolveFilename(SCOPE_SKIN_IMAGE, filename, path_prefix=path_prefix), desktop)
301 style.setPixmap(eWindowStyleSkinned.__dict__[bsName], eWindowStyleSkinned.__dict__[bpName], png)
302 #print " borderset:", bpName, filename
304 for color in windowstyle.getiterator("color"):
305 type = str(color.get("name"))
306 color = parseColor(color.get("color"))
309 style.setColor(eWindowStyleSkinned.__dict__["col" + type], color)
311 raise ("Unknown color %s" % (type))
314 #print " color:", type, color
316 x = eWindowStyleManager.getInstance()
317 x.setStyle(id, style)
319 def loadSkinData(desktop):
322 for (path, dom_skin) in skins:
323 loadSingleSkinData(desktop, dom_skin, path)
325 def lookupScreen(name):
326 for (path, dom_skin) in dom_skins:
327 # first, find the corresponding screen element
328 skin = dom_skin.getroot()
329 for x in skin.getiterator("screen"):
330 if x.get('name') == name:
334 def readSkin(screen, skin, names, desktop):
335 if not isinstance(names, list):
338 name = "<embedded-in-'%s'>" % screen.__class__.__name__
340 # try all skins, first existing one have priority
342 myscreen, path = lookupScreen(n)
343 if myscreen is not None:
344 # use this name for debug output
348 # otherwise try embedded skin
349 myscreen = myscreen or getattr(screen, "parsedSkin", None)
351 # try uncompiled embedded skin
352 if myscreen is None and getattr(screen, "skin", None):
353 print "Looking for embedded skin"
354 myscreen = screen.parsedSkin = xml.etree.cElementTree.fromstring(screen.skin)
356 #assert myscreen is not None, "no skin for screen '" + repr(names) + "' found!"
358 print "No skin to read..."
359 emptySkin = "<screen></screen>"
360 myscreen = screen.parsedSkin = xml.etree.cElementTree.fromstring(emptySkin)
363 screen.skinAttributes = [ ]
365 skin_path_prefix = getattr(screen, "skin_path", path)
367 collectAttributes(screen.skinAttributes, myscreen, skin_path_prefix, ignore=["name"])
369 screen.additionalWidgets = [ ]
370 screen.renderer = [ ]
372 visited_components = set()
374 # now walk all widgets
375 for widget in myscreen.getiterator("widget"):
376 # ok, we either have 1:1-mapped widgets ('old style'), or 1:n-mapped
377 # widgets (source->renderer).
379 wname = widget.get('name')
380 wsource = widget.get('source')
383 if wname is None and wsource is None:
384 print "widget has no name and no source!"
389 #print "Widget name=", wname
390 visited_components.add(wname)
392 # get corresponding 'gui' object
394 attributes = screen[wname].skinAttributes = [ ]
396 raise SkinError("component with name '" + wname + "' was not found in skin of screen '" + name + "'!")
397 #print "WARNING: component with name '" + wname + "' was not found in skin of screen '" + name + "'!"
399 # assert screen[wname] is not Source
401 # and collect attributes for this
402 collectAttributes(attributes, widget, skin_path_prefix, ignore=['name'])
404 # get corresponding source
405 #print "Widget source=", wsource
407 while True: # until we found a non-obsolete source
409 # parse our current "wsource", which might specifiy a "related screen" before the dot,
410 # for example to reference a parent, global or session-global screen.
413 # resolve all path components
414 path = wsource.split('.')
416 scr = screen.getRelatedScreen(path[0])
420 raise SkinError("specified related screen '" + wsource + "' was not found in screen '" + name + "'!")
423 # resolve the source.
424 source = scr.get(path[0])
425 if isinstance(source, ObsoleteSource):
426 # however, if we found an "obsolete source", issue warning, and resolve the real source.
427 print "WARNING: SKIN '%s' USES OBSOLETE SOURCE '%s', USE '%s' INSTEAD!" % (name, wsource, source.new_source)
428 print "OBSOLETE SOURCE WILL BE REMOVED %s, PLEASE UPDATE!" % (source.removal_date)
429 if source.description:
430 print source.description
432 wsource = source.new_source
434 # otherwise, use that source.
438 raise SkinError("source '" + wsource + "' was not found in screen '" + name + "'!")
440 wrender = widget.get('render')
443 raise SkinError("you must define a renderer with render= for source '%s'" % (wsource))
445 for converter in widget.getiterator("convert"):
446 ctype = converter.get('type')
447 assert ctype, "'convert'-tag needs a 'type'-attribute"
448 #print "Converter:", ctype
449 #parms = mergeText(converter.childNodes).strip()
451 parms = converter.text.strip()
454 #print "Params:", ctype
455 converter_class = my_import('.'.join(["Components", "Converter", ctype])).__dict__.get(ctype)
459 for i in source.downstream_elements:
460 if isinstance(i, converter_class) and i.converter_arguments == parms:
464 print "allocating new converter!"
465 c = converter_class(parms)
468 print "reused converter!"
472 renderer_class = my_import('.'.join(["Components", "Renderer", wrender])).__dict__.get(wrender)
474 renderer = renderer_class() # instantiate renderer
476 renderer.connect(source) # connect to source
477 attributes = renderer.skinAttributes = [ ]
478 collectAttributes(attributes, widget, skin_path_prefix, ignore=['render', 'source'])
480 screen.renderer.append(renderer)
482 from Components.GUIComponent import GUIComponent
483 nonvisited_components = [x for x in set(screen.keys()) - visited_components if isinstance(x, GUIComponent)]
485 assert not nonvisited_components, "the following components in %s don't have a skin entry: %s" % (name, ', '.join(nonvisited_components))
487 # now walk additional objects
488 for widget in myscreen.getchildren():
490 if widget.tag == "widget":
493 if widget.tag == "applet":
495 codeText = widget.text.strip()
501 type = widget.get('type')
503 code = compile(codeText, "skin applet", "exec")
505 if type == "onLayoutFinish":
506 screen.onLayoutFinish.append(code)
507 #print "onLayoutFinish = ", codeText
509 raise SkinError("applet type '%s' unknown!" % type)
510 #print "applet type '%s' unknown!" % type
514 class additionalWidget:
517 w = additionalWidget()
519 if widget.tag == "eLabel":
521 elif widget.tag == "ePixmap":
524 raise SkinError("unsupported stuff : %s" % widget.tag)
525 #print "unsupported stuff : %s" % widget.tag
527 w.skinAttributes = [ ]
528 collectAttributes(w.skinAttributes, widget, skin_path_prefix, ignore=['name'])
530 # applyAttributes(guiObject, widget, desktop)
531 # guiObject.thisown = 0
532 screen.additionalWidgets.append(w)