add alternative seeking, currently with 5,4,6-keys instead of ok,left,right
[enigma2.git] / skin.py
diff --git a/skin.py b/skin.py
index db4812ab1bd512b0f427a28b431371fff3aea5b0..9c18fda6bfaa3a57c8006a9deecb06a5eaf6a199 100644 (file)
--- a/skin.py
+++ b/skin.py
@@ -1,6 +1,16 @@
 from enigma import *
 import xml.dom.minidom
 from xml.dom import EMPTY_NAMESPACE
 from enigma import *
 import xml.dom.minidom
 from xml.dom import EMPTY_NAMESPACE
+from Tools.Import import my_import
+import os
+
+from Components.config import ConfigSubsection, ConfigText, config
+from Components.Element import Element
+from Components.Converter.Converter import Converter
+
+from Tools.XMLTools import elementsWithTag, mergeText
+
+colorNames = dict()
 
 def dump(x, i=0):
        print " " * i + str(x)
 
 def dump(x, i=0):
        print " " * i + str(x)
@@ -10,40 +20,44 @@ def dump(x, i=0):
        except:
                None
 
        except:
                None
 
-dom = xml.dom.minidom.parseString(
-       """
-       <skin>
-               <screen name="mainMenu" position="300,100" size="300,300" title="real main menu">
-                       <widget name="okbutton" position="10,190" size="280,50" />
-                       <widget name="title" position="10,10" size="280,20" />
-                       <widget name="menu" position="10,30" size="280,140" />
-               </screen>
-               <screen name="clockDisplay" position="300,100" size="300,300">
-                       <widget name="okbutton" position="10,10" size="280,40" />
-                       <widget name="title" position="10,120" size="280,50" />
-                       <widget name="theClock" position="10,60" size="280,50" />
-               </screen>
-               <screen name="infoBar" position="80,350" size="540,150" title="InfoBar">
-                       <widget name="CurrentTime" position="10,10" size="40,30" />
-                       <widget name="ServiceName" position="50,20" size="200,30" />
-                       <widget name="Event_Now" position="100,40" size="300,30" />
-                       <widget name="Event_Next" position="100,90" size="300,30" />
-                       <widget name="Event_Now_Duration" position="440,40" size="80,30" />
-                       <widget name="Event_Next_Duration" position="440,90" size="80,30" />
-               </screen>
-               <screen name="channelSelection" position="100,80" size="500,240" title="Channel Selection">
-                       <widget name="list" position="20,50" size="300,150" />
-                       <widget name="okbutton" position="340,50" size="140,30" />
-               </screen>
-               <screen name="serviceScan" position="150,100" size="300,200" title="Service Scan">
-                       <widget name="scan_progress" position="10,10" size="280,50" />
-                       <widget name="scan_state" position="10,60" size="280,30" />
-                       <widget name="okbutton" position="10,100" size="280,40" />
-               </screen>
-       </skin>
-""")
+from Tools.Directories import resolveFilename, SCOPE_SKIN, SCOPE_SKIN_IMAGE, SCOPE_FONTS
+
+class SkinError(Exception):
+       def __init__(self, message):
+               self.message = message
+
+       def __str__(self):
+               return self.message
+
+dom_skins = [ ]
 
 
+def loadSkin(name):
+       # read the skin
+       filename = resolveFilename(SCOPE_SKIN, name)
+       path = os.path.dirname(filename) + "/"
+       dom_skins.append((path, xml.dom.minidom.parse(filename)))
 
 
+# we do our best to always select the "right" value
+# skins are loaded in order of priority: skin with
+# highest priority is loaded last, usually the user-provided
+# skin.
+
+# currently, loadSingleSkinData (colors, bordersets etc.)
+# are applied one-after-each, in order of ascending priority.
+# the dom_skin will keep all screens in descending priority,
+# so the first screen found will be used.
+
+# example: loadSkin("nemesis_greenline/skin.xml")
+config.skin = ConfigSubsection()
+config.skin.primary_skin = ConfigText(default = "skin.xml")
+
+try:
+       loadSkin(config.skin.primary_skin.value)
+except SkinError, err:
+       print "SKIN ERROR:", err
+       print "defaulting to standard skin..."
+       loadSkin('skin.xml')
+loadSkin('skin_default.xml')
 
 def parsePosition(str):
        x, y = str.split(',')
 
 def parsePosition(str):
        x, y = str.split(',')
@@ -53,54 +67,336 @@ def parseSize(str):
        x, y = str.split(',')
        return eSize(int(x), int(y))
 
        x, y = str.split(',')
        return eSize(int(x), int(y))
 
-def applyAttributes(guiObject, node):
+def parseFont(str):
+       name, size = str.split(';')
+       return gFont(name, int(size))
+
+def parseColor(str):
+       if str[0] != '#':
+               try:
+                       return colorNames[str]
+               except:
+                       raise ("color '%s' must be #aarrggbb or valid named color" % (str))
+       return gRGB(int(str[1:], 0x10))
+
+def collectAttributes(skinAttributes, node, skin_path_prefix=None, ignore=[]):
        # walk all attributes
        for p in range(node.attributes.length):
                a = node.attributes.item(p)
                
                # convert to string (was: unicode)
                attrib = str(a.name)
        # walk all attributes
        for p in range(node.attributes.length):
                a = node.attributes.item(p)
                
                # convert to string (was: unicode)
                attrib = str(a.name)
-               # TODO: proper UTF8 translation?! (for value)
                # TODO: localization? as in e1?
                # TODO: localization? as in e1?
-               value = str(a.value)
+               value = a.value.encode("utf-8")
+               
+               if attrib in ["pixmap", "pointer", "seek_pointer"]:
+                       value = resolveFilename(SCOPE_SKIN_IMAGE, value, path_prefix=skin_path_prefix)
                
                
-               # and set attributes
+               if attrib not in ignore:
+                       skinAttributes.append((attrib, value))
+
+def loadPixmap(path):
+       ptr = loadPNG(path)
+       if ptr is None:
+               raise "pixmap file %s not found!" % (path)
+       return ptr
+
+def applySingleAttribute(guiObject, desktop, attrib, value):
+       # and set attributes
+       try:
                if attrib == 'position':
                        guiObject.move(parsePosition(value))
                elif attrib == 'size':
                        guiObject.resize(parseSize(value))
                elif attrib == 'title':
                if attrib == 'position':
                        guiObject.move(parsePosition(value))
                elif attrib == 'size':
                        guiObject.resize(parseSize(value))
                elif attrib == 'title':
-                       guiObject.setTitle(value)
-               elif attrib != 'name':
-                       print "unsupported attribute " + attrib + "=" + value
+                       guiObject.setTitle(_(value))
+               elif attrib == 'text':
+                       guiObject.setText(_(value))
+               elif attrib == 'font':
+                       guiObject.setFont(parseFont(value))
+               elif attrib == 'zPosition':
+                       guiObject.setZPosition(int(value))
+               elif attrib == "pixmap":
+                       ptr = loadPixmap(value) # this should already have been filename-resolved.
+                       # that __deref__ still scares me!
+                       desktop.makeCompatiblePixmap(ptr.__deref__())
+                       guiObject.setPixmap(ptr.__deref__())
+                       # guiObject.setPixmapFromFile(value)
+               elif attrib == "alphatest": # used by ePixmap
+                       guiObject.setAlphatest(
+                               { "on": True,
+                                 "off": False
+                               }[value])
+               elif attrib == "orientation": # used by eSlider
+                       try:
+                               guiObject.setOrientation(
+                                       { "orVertical": guiObject.orVertical,
+                                               "orHorizontal": guiObject.orHorizontal
+                                       }[value])
+                       except KeyError:
+                               print "oprientation must be either orVertical or orHorizontal!"
+               elif attrib == "valign":
+                       try:
+                               guiObject.setVAlign(
+                                       { "top": guiObject.alignTop,
+                                               "center": guiObject.alignCenter,
+                                               "bottom": guiObject.alignBottom
+                                       }[value])
+                       except KeyError:
+                               print "valign must be either top, center or bottom!"
+               elif attrib == "halign":
+                       try:
+                               guiObject.setHAlign(
+                                       { "left": guiObject.alignLeft,
+                                               "center": guiObject.alignCenter,
+                                               "right": guiObject.alignRight,
+                                               "block": guiObject.alignBlock
+                                       }[value])
+                       except KeyError:
+                               print "halign must be either left, center, right or block!"
+               elif attrib == "flags":
+                       flags = value.split(',')
+                       for f in flags:
+                               try:
+                                       fv = eWindow.__dict__[f]
+                                       guiObject.setFlag(fv)
+                               except KeyError:
+                                       print "illegal flag %s!" % f
+               elif attrib == "backgroundColor":
+                       guiObject.setBackgroundColor(parseColor(value))
+               elif attrib == "foregroundColor":
+                       guiObject.setForegroundColor(parseColor(value))
+               elif attrib == "shadowColor":
+                       guiObject.setShadowColor(parseColor(value))
+               elif attrib == "selectionDisabled":
+                       guiObject.setSelectionEnable(0)
+               elif attrib == "transparent":
+                       guiObject.setTransparent(int(value))
+               elif attrib == "borderColor":
+                       guiObject.setBorderColor(parseColor(value))
+               elif attrib == "borderWidth":
+                       guiObject.setBorderWidth(int(value))
+               elif attrib == "scrollbarMode":
+                       guiObject.setScrollbarMode(
+                               { "showOnDemand": guiObject.showOnDemand,
+                                       "showAlways": guiObject.showAlways,
+                                       "showNever": guiObject.showNever
+                               }[value])
+               elif attrib == "enableWrapAround":
+                       guiObject.setWrapAround(True)
+               elif attrib == "pointer" or attrib == "seek_pointer":
+                       (name, pos) = value.split(':')
+                       pos = parsePosition(pos)
+                       ptr = loadPixmap(name)
+                       desktop.makeCompatiblePixmap(ptr.__deref__())
+                       guiObject.setPointer({"pointer": 0, "seek_pointer": 1}[attrib], ptr.__deref__(), pos)
+               elif attrib == 'shadowOffset':
+                       guiObject.setShadowOffset(parsePosition(value))
+               else:
+                       raise "unsupported attribute " + attrib + "=" + value
+       except int:
+# AttributeError:
+               print "widget %s (%s) doesn't support attribute %s!" % ("", guiObject.__class__.__name__, attrib)
+
+def applyAllAttributes(guiObject, desktop, attributes):
+       for (attrib, value) in attributes:
+               applySingleAttribute(guiObject, desktop, attrib, value)
+
+def loadSingleSkinData(desktop, dom_skin, path_prefix):
+       """loads skin data like colors, windowstyle etc."""
+       
+       skin = dom_skin.childNodes[0]
+       assert skin.tagName == "skin", "root element in skin must be 'skin'!"
+       
+       for c in elementsWithTag(skin.childNodes, "colors"):
+               for color in elementsWithTag(c.childNodes, "color"):
+                       name = str(color.getAttribute("name"))
+                       color = str(color.getAttribute("value"))
+                       
+                       if not len(color):
+                               raise ("need color and name, got %s %s" % (name, color))
+                               
+                       colorNames[name] = parseColor(color)
+       
+       for c in elementsWithTag(skin.childNodes, "fonts"):
+               for font in elementsWithTag(c.childNodes, "font"):
+                       filename = str(font.getAttribute("filename") or "<NONAME>")
+                       name = str(font.getAttribute("name") or "Regular")
+                       scale = int(font.getAttribute("scale") or "100")
+                       is_replacement = font.getAttribute("replacement") != ""
+                       addFont(resolveFilename(SCOPE_FONTS, filename, path_prefix=path_prefix), name, scale, is_replacement)
+       
+       for windowstyle in elementsWithTag(skin.childNodes, "windowstyle"):
+               style = eWindowStyleSkinned()
+               id = int(windowstyle.getAttribute("id") or "0")
+               
+               # defaults
+               font = gFont("Regular", 20)
+               offset = eSize(20, 5)
+               
+               for title in elementsWithTag(windowstyle.childNodes, "title"):
+                       offset = parseSize(title.getAttribute("offset"))
+                       font = parseFont(str(title.getAttribute("font")))
+
+               style.setTitleFont(font);
+               style.setTitleOffset(offset)
+               
+               for borderset in elementsWithTag(windowstyle.childNodes, "borderset"):
+                       bsName = str(borderset.getAttribute("name"))
+                       for pixmap in elementsWithTag(borderset.childNodes, "pixmap"):
+                               bpName = str(pixmap.getAttribute("pos"))
+                               filename = str(pixmap.getAttribute("filename"))
+                               
+                               png = loadPixmap(resolveFilename(SCOPE_SKIN_IMAGE, filename, path_prefix=path_prefix))
+                               
+                               # adapt palette
+                               desktop.makeCompatiblePixmap(png.__deref__())
+                               style.setPixmap(eWindowStyleSkinned.__dict__[bsName], eWindowStyleSkinned.__dict__[bpName], png.__deref__())
+
+               for color in elementsWithTag(windowstyle.childNodes, "color"):
+                       type = str(color.getAttribute("name"))
+                       color = parseColor(color.getAttribute("color"))
+                       
+                       try:
+                               style.setColor(eWindowStyleSkinned.__dict__["col" + type], color)
+                       except:
+                               raise ("Unknown color %s" % (type))
+                       
+               x = eWindowStyleManagerPtr()
+               eWindowStyleManager.getInstance(x)
+               x.setStyle(id, style)
+
+def loadSkinData(desktop):
+       skins = dom_skins[:]
+       skins.reverse()
+       for (path, dom_skin) in skins:
+               loadSingleSkinData(desktop, dom_skin, path)
+
+def lookupScreen(name):
+       for (path, dom_skin) in dom_skins:
+               # first, find the corresponding screen element
+               skin = dom_skin.childNodes[0] 
+               for x in elementsWithTag(skin.childNodes, "screen"):
+                       if x.getAttribute('name') == name:
+                               return x, path
+       return None, None
 
 
-def applyGUIskin(screen, parent, skin, name):
+def readSkin(screen, skin, name, desktop):
+       myscreen, path = lookupScreen(name)
        
        
-       myscreen = None
+       # otherwise try embedded skin
+       myscreen = myscreen or getattr(screen, "parsedSkin", None)
        
        
-       # first, find the corresponding screen element
-       skin = dom.getElementsByTagName("skin")[0]
-       screens = skin.getElementsByTagName("screen")
-       del skin
-       for x in screens:
-               if x.getAttribute('name') == name:
-                       myscreen = x
+       # try uncompiled embedded skin
+       if myscreen is None and getattr(screen, "skin", None):
+               myscreen = screen.parsedSkin = xml.dom.minidom.parseString(screen.skin).childNodes[0]
        
        
-       assert myscreen != None, "no skin for screen '" + name + "' found!"
+       assert myscreen is not None, "no skin for screen '" + name + "' found!"
+
+       screen.skinAttributes = [ ]
+       
+       skin_path_prefix = getattr(screen, "skin_path", path)
+
+       collectAttributes(screen.skinAttributes, myscreen, skin_path_prefix, ignore=["name"])
        
        
-       applyAttributes(parent, myscreen)
+       screen.additionalWidgets = [ ]
+       screen.renderer = [ ]
        
        # now walk all widgets
        
        # now walk all widgets
-       for widget in myscreen.getElementsByTagName("widget"):
+       for widget in elementsWithTag(myscreen.childNodes, "widget"):
+               # ok, we either have 1:1-mapped widgets ('old style'), or 1:n-mapped 
+               # widgets (source->renderer).
+
                wname = widget.getAttribute('name')
                wname = widget.getAttribute('name')
-               if wname == None:
-                       print "widget has no name!"
+               wsource = widget.getAttribute('source')
+               
+               if wname is None and wsource is None:
+                       print "widget has no name and no source!"
                        continue
                
                        continue
                
-               # get corresponding gui object
-               try:
-                       guiObject = screen[wname].instance
-               except:
-                       raise str("component with name '" + wname + "' was not found in skin of screen '" + name + "'!")
+               if wname:
+                       # get corresponding 'gui' object
+                       try:
+                               attributes = screen[wname].skinAttributes = [ ]
+                       except:
+                               raise SkinError("component with name '" + wname + "' was not found in skin of screen '" + name + "'!")
+
+#                      assert screen[wname] is not Source
+               
+                       # and collect attributes for this
+                       collectAttributes(attributes, widget, skin_path_prefix, ignore=['name'])
+               elif wsource:
+                       # get corresponding source
+                       source = screen.get(wsource)
+                       if source is None:
+                               raise SkinError("source '" + wsource + "' was not found in screen '" + name + "'!")
+                       
+                       wrender = widget.getAttribute('render')
+                       
+                       if not wrender:
+                               raise SkinError("you must define a renderer with render= for source '%s'" % (wsource))
+                       
+                       for converter in elementsWithTag(widget.childNodes, "convert"):
+                               ctype = converter.getAttribute('type')
+                               assert ctype, "'convert'-tag needs a 'type'-attribute"
+                               parms = mergeText(converter.childNodes).strip()
+                               converter_class = my_import('.'.join(["Components", "Converter", ctype])).__dict__.get(ctype)
+                               
+                               c = None
+                               
+                               for i in source.downstream_elements:
+                                       if isinstance(i, converter_class) and i.converter_arguments == parms:
+                                               c = i
+
+                               if c is None:
+                                       print "allocating new converter!"
+                                       c = converter_class(parms)
+                                       c.connect(source)
+                               else:
+                                       print "reused conveter!"
+       
+                               source = c
+                       
+                       renderer_class = my_import('.'.join(["Components", "Renderer", wrender])).__dict__.get(wrender)
+                       
+                       renderer = renderer_class() # instantiate renderer
+                       
+                       renderer.connect(source) # connect to source
+                       attributes = renderer.skinAttributes = [ ]
+                       collectAttributes(attributes, widget, skin_path_prefix, ignore=['render', 'source'])
+                       
+                       screen.renderer.append(renderer)
+
+       # now walk additional objects
+       for widget in elementsWithTag(myscreen.childNodes, lambda x: x != "widget"):
+               if widget.tagName == "applet":
+                       codeText = mergeText(widget.childNodes).strip()
+                       type = widget.getAttribute('type')
+
+                       code = compile(codeText, "skin applet", "exec")
+                       
+                       if type == "onLayoutFinish":
+                               screen.onLayoutFinish.append(code)
+                       else:
+                               raise SkinError("applet type '%s' unknown!" % type)
+                       
+                       continue
+               
+               class additionalWidget:
+                       pass
+               
+               w = additionalWidget()
+               
+               if widget.tagName == "eLabel":
+                       w.widget = eLabel
+               elif widget.tagName == "ePixmap":
+                       w.widget = ePixmap
+               else:
+                       raise SkinError("unsupported stuff : %s" % widget.tagName)
+               
+               w.skinAttributes = [ ]
+               collectAttributes(w.skinAttributes, widget, skin_path_prefix, ignore=['name'])
                
                
-               applyAttributes(guiObject, widget)
+               # applyAttributes(guiObject, widget, desktop)
+               # guiObject.thisown = 0
+               screen.additionalWidgets.append(w)