real mute volume on lowest volume level .. but not show the mute symbol
[enigma2.git] / skin.py
diff --git a/skin.py b/skin.py
index 9e2784c8df9b09c8ab39e8b556a73e36cc12c4ab..52b55360ed61e344c284386f3b21dd2cef7a7d57 100644 (file)
--- a/skin.py
+++ b/skin.py
@@ -1,6 +1,12 @@
 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
 
@@ -14,149 +20,44 @@ def dump(x, i=0):
        except:
                None
 
-dom = xml.dom.minidom.parseString(
-       """<skin>
-       
-               <colors>
-                       <color name="white"     value="#ffffff" />
-                       <color name="black"     value="#000000" />
-                       <color name="dark"      value="#20294a6b" />
-                       
-                       <color name="red"               value="#ff0000" />
-                       <color name="green"     value="#00ff00" />
-                       <color name="blue"              value="#0000ff" />
-                       <color name="yellow"    value="#c0c000" />
-               </colors>
-               <windowstyle type="skinned">
-                       <color name="Background" color="#4075a7" />
-                       <color name="LabelForeground" color="#ffffff" />
-                       <color name="ListboxBackground" color="#4075a7" />
-                       <color name="ListboxForeground" color="#ffffff" />
-                       <color name="ListboxSelectedBackground" color="#404080" />
-                       <color name="ListboxSelectedForeground" color="#ffffff" />
-                       <color name="ListboxMarkedBackground" color="#ff0000" />
-                       <color name="ListboxMarkedForeground" color="#ffffff" />
-                       <borderset name="bsWindow">
-                               <pixmap pos="bpTopLeft"     filename="data/b_w_tl.png" />
-                               <pixmap pos="bpTop"         filename="data/b_w_t.png"  />
-                               <pixmap pos="bpTopRight"    filename="data/b_w_tr.png" />
-                               <pixmap pos="bpLeft"        filename="data/b_w_l.png"  />
-                               <pixmap pos="bpRight"       filename="data/b_w_r.png"  />
-                               <pixmap pos="bpBottomLeft"  filename="data/b_w_bl.png" />
-                               <pixmap pos="bpBottom"      filename="data/b_w_b.png"  />
-                               <pixmap pos="bpBottomRight" filename="data/b_w_br.png" />
-                       </borderset>
-               </windowstyle> """ """
-               <screen name="Menu" position="300,100" size="300,200" title="real main menu">
-<!--                   <widget name="okbutton" position="10,190" size="280,50" font="Arial;20" valign="center" halign="center" />-->
-                       <widget name="title" position="10,10" size="280,20" />
-                       <widget name="menu" position="10,30" size="280,200" />
-               </screen>
-               <screen name="ScartLoopThrough" position="0,0" size="720,576">
-               </screen>
-               <screen name="HarddiskSelection" position="140,165" size="360,100">
-                       <widget name="hddlist" position="20,10" size="320,80" />
-               </screen>
-               <screen name="HarddiskSetup" position="140,165" size="360,100">
-                       <widget name="model" position="20,10" size="300,20" />
-                       <widget name="capacity" position="20,30" size="300,20" />
-                       <widget name="bus" position="20,50" size="300,20" />
-                       <widget name="initialize" position="40,80" size="75,20" font="Arial;20" backgroundColor="red" />
-               </screen>
-               <screen name="Setup" position="140,125" size="460,220" title="Setup">
-                       <widget name="config" position="10,30" size="420,120" />
-                       <widget name="ok" position="140,180" size="38,20" font="Arial;20" backgroundColor="green" />
-                       <widget name="cancel" position="240,180" size="70,20" font="Arial;20" backgroundColor="red" />
-               </screen>
-               <screen name="About" position="140,125" size="360,200" title="Setup">
-                       <widget name="text" position="10,30" size="420,40" font="Arial;20"/>
-                       <widget name="tuner" position="10,80" size="420,20"/>
-                       <widget name="tunerA" position="10,100" size="420,20"/>
-                       <widget name="tunerB" position="10,120" size="420,20"/>
-                       <widget name="hdd" position="10,150" size="420,20"/>
-                       <widget name="hddA" position="10,170" size="420,20"/>
-               </screen>
-               <screen name="configOSD" position="140,125" size="460,350" title="OSD Settings">
-                       <widget name="okbutton" position="20,245" size="205,40" />
-                       <widget name="txt_alpha" position="20,20" size="110,20" />
-                       <widget name="sld_alpha" position="150,20" size="290,20" />
-                       <widget name="txt_brightness" position="20,60" size="120,20" />
-                       <widget name="sld_brightness" position="150,20" size="290,20" />
-                       <widget name="txt_gamma" position="20,100" size="120,20" />
-                       <widget name="sld_gamma" position="150,100" size="290,20" />
-               </screen>
-               <screen name="configTest" position="300,100" size="300,300" title="config menu">
-                       <widget name="config" position="10,30" size="420,220" />
-               </screen>
-               <screen name="TimerEditList" position="160,100" size="420,430" title="Timer Editor">
-                       <widget name="timerlist" position="10,30" size="400,300" />
-               </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" flags="wfNoBorder" position="0,380" size="720,148" title="InfoBar">
-                       <ePixmap position="0,0" size="720,148" pixmap="data/info-bg.png" />
-                       
-                       <widget name="ServiceName" position="69,25" size="427,26" valign="center" font="Arial;22" backgroundColor="#101258" />
-                       <widget name="CurrentTime" position="575,10" size="90,30" backgroundColor="dark" font="Arial;19" />
-                       <widget name="Volume" position="575,45" size="100,5" backgroundColor="dark" />
-                       <widget name="Event_Now" position="273,68" size="282,30" font="Arial;22" backgroundColor="dark" />
-                       <widget name="Event_Next" position="273,98" size="282,30" font="Arial;22" backgroundColor="dark" />
-                       <widget name="Event_Now_Duration" position="555,68" size="70,26" font="Arial;22" backgroundColor="dark" />
-                       <widget name="Event_Next_Duration" position="555,98" size="70,26" font="Arial;22" backgroundColor="dark" />
-<!--                   <eLabel position="70,0" size="300,30" text=".oO skin Oo." font="Arial;20" /> -->
-               </screen>
-               <screen name="ChannelSelection" position="90,100" size="560,420" title="Channel Selection">
-                       <widget name="list" position="0,50" size="560,320" />
-<!--                   <widget name="okbutton" position="340,50" size="140,30" />-->
-                       <widget name="key_red" position="0,0" size="140,40" backgroundColor="red" />
-                       <widget name="key_green" position="140,0" size="140,40" backgroundColor="green" />
-                       <widget name="key_yellow" position="280,0" size="140,40" backgroundColor="yellow" />
-                       <widget name="key_blue" position="420,0" size="140,40" backgroundColor="blue" />
-               </screen>
-               <screen name="MovieSelection" position="150,100" size="400,420" title="Select-a-movie">
-                       <widget name="list" position="0,50" size="400,300" />
-               </screen>
-               <screen name="ServiceScan" position="150,100" size="300,90" title="Service Scan">
-                       <widget name="scan_progress" position="10,10" size="300,20" />
-                       <widget name="scan_state" position="10,40" size="280,30" />
-               </screen>
-               <screen name="TimerEdit" position="70,100" size="590,335" title="Timer Edit">
-                       <widget name="description" position="10,10" size="580,40" font="Arial;25" />
-                       <widget name="lbegin" position="405,102" size="103,30" font="Arial;25" foregroundColor="red" />
-                       <widget name="lend" position="405,158" size="103,30" font="Arial;25" foregroundColor="green" />
-                       <widget name="begin" position="508,105" size="72,35" font="Arial;25" />
-                       <widget name="end" position="508,150" size="72,35" font="Arial;25" />
-                       <widget name="apply" position="10,240" size="250,35" />
-               </screen>
-               <screen name="MessageBox" position="0,300" size="720,10" title="Message">
-                       <widget name="text" position="0,0" size="500,0" font="Arial;25" />
-                       <applet type="onLayoutFinish">
-# this should be factored out into some helper code, but currently demonstrated applets.
-from enigma import eSize, ePoint
-
-orgwidth = self.instance.size().width()
-orgpos = self.instance.position()
-textsize = self["text"].getSize()
-
-# y size still must be fixed in font stuff...
-textsize = (textsize[0], textsize[1] + 20)
-wsize = (textsize[0] + 20, textsize[1] + 20)
-
-# resize 
-self.instance.resize(eSize(*wsize))
-
-# resize label
-self["text"].instance.resize(eSize(*textsize))
-
-# center window
-newwidth = wsize[0]
-self.instance.move(ePoint(orgpos.x() + (orgwidth - newwidth)/2, orgpos.y()))
-                       </applet>
-               </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, IOError), err:
+       print "SKIN ERROR:", err
+       print "defaulting to standard skin..."
+       loadSkin('skin.xml')
+loadSkin('skin_default.xml')
 
 def parsePosition(str):
        x, y = str.split(',')
@@ -178,20 +79,29 @@ def parseColor(str):
                        raise ("color '%s' must be #aarrggbb or valid named color" % (str))
        return gRGB(int(str[1:], 0x10))
 
-def collectAttributes(skinAttributes, node):
+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)
-               # TODO: proper UTF8 translation?! (for value)
                # TODO: localization? as in e1?
-               value = str(a.value)
+               value = a.value.encode("utf-8")
                
-               skinAttributes.append((attrib, value))
+               if attrib in ["pixmap", "pointer", "seek_pointer"]:
+                       value = resolveFilename(SCOPE_SKIN_IMAGE, value, path_prefix=skin_path_prefix)
+               
+               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):           
+def applySingleAttribute(guiObject, desktop, attrib, value):
        # and set attributes
        try:
                if attrib == 'position':
@@ -199,20 +109,32 @@ def applySingleAttribute(guiObject, desktop, attrib, value):
                elif attrib == 'size':
                        guiObject.resize(parseSize(value))
                elif attrib == 'title':
-                       guiObject.setTitle(value)
+                       guiObject.setTitle(_(value))
                elif attrib == 'text':
-                       guiObject.setText(value)
+                       guiObject.setText(_(value))
                elif attrib == 'font':
                        guiObject.setFont(parseFont(value))
+               elif attrib == 'zPosition':
+                       guiObject.setZPosition(int(value))
                elif attrib == "pixmap":
-                       ptr = gPixmapPtr()
-                       if loadPNG(ptr, value):
-                               raise "loading PNG failed!"
-                       x = ptr
-                       ptr = ptr.__deref__()
-                       desktop.makeCompatiblePixmap(ptr)
-                       guiObject.setPixmap(ptr)
+                       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(
@@ -244,8 +166,34 @@ def applySingleAttribute(guiObject, desktop, attrib, value):
                        guiObject.setBackgroundColor(parseColor(value))
                elif attrib == "foregroundColor":
                        guiObject.setForegroundColor(parseColor(value))
-               elif attrib != 'name':
-                       print "unsupported attribute " + attrib + "=" + 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)
@@ -254,16 +202,10 @@ def applyAllAttributes(guiObject, desktop, attributes):
        for (attrib, value) in attributes:
                applySingleAttribute(guiObject, desktop, attrib, value)
 
-def loadSkin(desktop):
-       print "loading skin..."
+def loadSingleSkinData(desktop, dom_skin, path_prefix):
+       """loads skin data like colors, windowstyle etc."""
        
-       def getPNG(x):
-               g = gPixmapPtr()
-               loadPNG(g, x)
-               g = g.grabRef()
-               return g
-       
-       skin = dom.childNodes[0]
+       skin = dom_skin.childNodes[0]
        assert skin.tagName == "skin", "root element in skin must be 'skin'!"
        
        for c in elementsWithTag(skin.childNodes, "colors"):
@@ -276,8 +218,28 @@ def loadSkin(desktop):
                                
                        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"))
@@ -285,11 +247,11 @@ def loadSkin(desktop):
                                bpName = str(pixmap.getAttribute("pos"))
                                filename = str(pixmap.getAttribute("filename"))
                                
-                               png = getPNG(filename)
+                               png = loadPixmap(resolveFilename(SCOPE_SKIN_IMAGE, filename, path_prefix=path_prefix))
                                
                                # adapt palette
-                               desktop.makeCompatiblePixmap(png)
-                               style.setPixmap(eWindowStyleSkinned.__dict__[bsName], eWindowStyleSkinned.__dict__[bpName], png)
+                               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"))
@@ -302,40 +264,108 @@ def loadSkin(desktop):
                        
                x = eWindowStyleManagerPtr()
                eWindowStyleManager.getInstance(x)
-               x.setStyle(style)
+               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 readSkin(screen, skin, name, desktop):
-       myscreen = None
+       myscreen, path = lookupScreen(name)
        
-       # first, find the corresponding screen element
-       skin = dom.childNodes[0]
+       # otherwise try embedded skin
+       myscreen = myscreen or getattr(screen, "parsedSkin", None)
        
-       for x in elementsWithTag(skin.childNodes, "screen"):
-               if x.getAttribute('name') == name:
-                       myscreen = x
-       del skin
+       # 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 = [ ]
-       collectAttributes(screen.skinAttributes, myscreen)
+       
+       skin_path_prefix = getattr(screen, "skin_path", path)
+
+       collectAttributes(screen.skinAttributes, myscreen, skin_path_prefix, ignore=["name"])
        
        screen.additionalWidgets = [ ]
+       screen.renderer = [ ]
        
        # now walk all widgets
        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')
-               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
                
-               # get corresponding gui object
-               try:
-                       attributes = screen[wname].skinAttributes = [ ]
-               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
                
-               collectAttributes(attributes, widget)
+                       # 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"):
@@ -348,7 +378,7 @@ def readSkin(screen, skin, name, desktop):
                        if type == "onLayoutFinish":
                                screen.onLayoutFinish.append(code)
                        else:
-                               raise str("applet type '%s' unknown!" % type)
+                               raise SkinError("applet type '%s' unknown!" % type)
                        
                        continue
                
@@ -362,12 +392,11 @@ def readSkin(screen, skin, name, desktop):
                elif widget.tagName == "ePixmap":
                        w.widget = ePixmap
                else:
-                       raise str("unsupported stuff : %s" % widget.tagName)
+                       raise SkinError("unsupported stuff : %s" % widget.tagName)
                
                w.skinAttributes = [ ]
-               collectAttributes(w.skinAttributes, widget)
+               collectAttributes(w.skinAttributes, widget, skin_path_prefix, ignore=['name'])
                
                # applyAttributes(guiObject, widget, desktop)
                # guiObject.thisown = 0
-               print screen.additionalWidgets
                screen.additionalWidgets.append(w)