remove unimplemented method declaration

[enigma2.git] / skin.py

diff --git a/skin.py b/skin.py
index f31d637bb8a15ff43b31ccb54c2669f893f502bf..07213915e404de20767e225993fc0a07364c25e3 100644 (file)
--- a/skin.py
+++ b/skin.py
@@ -1,6 +1,13 @@
-from enigma import *

 import xml.dom.minidom
 import xml.dom.minidom

-from xml.dom import EMPTY_NAMESPACE
+from os import path
+
+from enigma import eSize, ePoint, gFont, eWindow, eLabel, ePixmap, eWindowStyleManager, \
+       loadPNG, addFont, gRGB, eWindowStyleSkinned
+
+from Components.config import ConfigSubsection, ConfigText, config
+from Components.Converter.Converter import Converter
+from Tools.Directories import resolveFilename, SCOPE_SKIN, SCOPE_SKIN_IMAGE, SCOPE_FONTS
+from Tools.Import import my_import

 
 from Tools.XMLTools import elementsWithTag, mergeText
 
 
 from Tools.XMLTools import elementsWithTag, mergeText
 


@@ -14,16 +21,42 @@ def dump(x, i=0):
        except:
                None
 
        except:
                None
 

-# read the skin
-try:
-       # first we search in the current path
-       skinfile = file('data/skin.xml', 'r')
-except:
-       # if not found in the current path, we use the global datadir-path
-       skinfile = file('/usr/share/enigma2/skin.xml', 'r')
-dom = xml.dom.minidom.parseString(skinfile.read())
-skinfile.close()
+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)
+       mpath = path.dirname(filename) + "/"
+       dom_skins.append((mpath, 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, AssertionError), 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(',')


@@ -45,20 +78,29 @@ def parseColor(str):
                        raise ("color '%s' must be #aarrggbb or valid named color" % (str))
        return gRGB(int(str[1:], 0x10))
 
                        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)
        # 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)

                
                

-               skinAttributes.append((attrib, value))
+               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':
        # and set attributes
        try:
                if attrib == 'position':


@@ -66,20 +108,23 @@ def applySingleAttribute(guiObject, desktop, attrib, value):
                elif attrib == 'size':
                        guiObject.resize(parseSize(value))
                elif attrib == 'title':
                elif attrib == 'size':
                        guiObject.resize(parseSize(value))
                elif attrib == 'title':

-                       guiObject.setTitle(value)
+                       guiObject.setTitle(_(value))

                elif attrib == 'text':
                elif attrib == 'text':

-                       guiObject.setText(value)
+                       guiObject.setText(_(value))

                elif attrib == 'font':
                        guiObject.setFont(parseFont(value))
                elif attrib == 'font':
                        guiObject.setFont(parseFont(value))

+               elif attrib == 'zPosition':
+                       guiObject.setZPosition(int(value))

                elif attrib == "pixmap":
                elif attrib == "pixmap":

-                       ptr = gPixmapPtr()
-                       if loadPNG(ptr, value):
-                               raise "loading PNG failed!"
-                       x = ptr
-                       ptr = ptr.__deref__()
+                       ptr = loadPixmap(value) # this should already have been filename-resolved.

                        desktop.makeCompatiblePixmap(ptr)
                        guiObject.setPixmap(ptr)
                        # guiObject.setPixmapFromFile(value)
                        desktop.makeCompatiblePixmap(ptr)
                        guiObject.setPixmap(ptr)
                        # 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(
                elif attrib == "orientation": # used by eSlider
                        try:
                                guiObject.setOrientation(


@@ -119,8 +164,36 @@ def applySingleAttribute(guiObject, desktop, attrib, value):
                        guiObject.setBackgroundColor(parseColor(value))
                elif attrib == "foregroundColor":
                        guiObject.setForegroundColor(parseColor(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)
+                       guiObject.setPointer({"pointer": 0, "seek_pointer": 1}[attrib], ptr, pos)
+               elif attrib == 'shadowOffset':
+                       guiObject.setShadowOffset(parsePosition(value))
+               elif attrib == 'noWrap':
+                       guiObject.setNoWrap(1)
+               else:
+                       raise "unsupported attribute " + attrib + "=" + value

        except int:
 # AttributeError:
                print "widget %s (%s) doesn't support attribute %s!" % ("", guiObject.__class__.__name__, attrib)
        except int:
 # AttributeError:
                print "widget %s (%s) doesn't support attribute %s!" % ("", guiObject.__class__.__name__, attrib)


@@ -129,16 +202,10 @@ def applyAllAttributes(guiObject, desktop, attributes):
        for (attrib, value) in attributes:
                applySingleAttribute(guiObject, desktop, attrib, value)
 
        for (attrib, value) in attributes:
                applySingleAttribute(guiObject, desktop, attrib, value)
 

-def loadSkin(desktop):
-       print "loading skin..."
-       
-       def getPNG(x):
-               g = gPixmapPtr()
-               loadPNG(g, x)
-               g = g.grabRef()
-               return g
+def loadSingleSkinData(desktop, dom_skin, path_prefix):
+       """loads skin data like colors, windowstyle etc."""

        
        

-       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"):
        assert skin.tagName == "skin", "root element in skin must be 'skin'!"
        
        for c in elementsWithTag(skin.childNodes, "colors"):


@@ -151,11 +218,28 @@ def loadSkin(desktop):
                                
                        colorNames[name] = parseColor(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()
        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)

                
                

-               style.setTitleFont(gFont("Arial", 13));
-               style.setTitleOffset(eSize(3, 3));
+               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 borderset in elementsWithTag(windowstyle.childNodes, "borderset"):
                        bsName = str(borderset.getAttribute("name"))


@@ -163,7 +247,7 @@ def loadSkin(desktop):
                                bpName = str(pixmap.getAttribute("pos"))
                                filename = str(pixmap.getAttribute("filename"))
                                
                                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)
                                
                                # adapt palette
                                desktop.makeCompatiblePixmap(png)


@@ -178,42 +262,120 @@ def loadSkin(desktop):
                        except:
                                raise ("Unknown color %s" % (type))
                        
                        except:
                                raise ("Unknown color %s" % (type))
                        

-               x = eWindowStyleManagerPtr()
-               eWindowStyleManager.getInstance(x)
-               x.setStyle(style)
+               x = eWindowStyleManager.getInstance()
+               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):
 
 def readSkin(screen, skin, name, desktop):

-       myscreen = None

        
        

-       # first, find the corresponding screen element
-       skin = dom.childNodes[0]
+       myscreen, path = lookupScreen(name)
+       
+       # 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 = [ ]
 
        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.additionalWidgets = [ ]

+       screen.renderer = [ ]
+       
+       visited_components = set()

        
        # now walk all widgets
        for widget in elementsWithTag(myscreen.childNodes, "widget"):
        
        # 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')
                wname = widget.getAttribute('name')

-               if wname == None:
-                       print "widget has no name!"
-                       continue
+               wsource = widget.getAttribute('source')

                
                

-               # 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 is None and wsource is None:
+                       print "widget has no name and no source!"
+                       continue

                
                

-               collectAttributes(attributes, widget)
+               if wname:
+                       visited_components.add(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)
+
+       from Components.GUIComponent import GUIComponent
+       nonvisited_components = [x for x in set(screen.keys()) - visited_components if isinstance(x, GUIComponent)]
+       
+       assert not nonvisited_components, "the following components in %s don't have a skin entry: %s" % (name, ', '.join(nonvisited_components))

 
        # now walk additional objects
        for widget in elementsWithTag(myscreen.childNodes, lambda x: x != "widget"):
 
        # now walk additional objects
        for widget in elementsWithTag(myscreen.childNodes, lambda x: x != "widget"):


@@ -226,7 +388,7 @@ def readSkin(screen, skin, name, desktop):
                        if type == "onLayoutFinish":
                                screen.onLayoutFinish.append(code)
                        else:
                        if type == "onLayoutFinish":
                                screen.onLayoutFinish.append(code)
                        else:

-                               raise str("applet type '%s' unknown!" % type)
+                               raise SkinError("applet type '%s' unknown!" % type)

                        
                        continue
                
                        
                        continue
                


@@ -240,10 +402,10 @@ def readSkin(screen, skin, name, desktop):
                elif widget.tagName == "ePixmap":
                        w.widget = ePixmap
                else:
                elif widget.tagName == "ePixmap":
                        w.widget = ePixmap
                else:

-                       raise str("unsupported stuff : %s" % widget.tagName)
+                       raise SkinError("unsupported stuff : %s" % widget.tagName)

                
                w.skinAttributes = [ ]
                
                w.skinAttributes = [ ]

-               collectAttributes(w.skinAttributes, widget)
+               collectAttributes(w.skinAttributes, widget, skin_path_prefix, ignore=['name'])

                
                # applyAttributes(guiObject, widget, desktop)
                # guiObject.thisown = 0
                
                # applyAttributes(guiObject, widget, desktop)
                # guiObject.thisown = 0