root/trunk/RBRapier/RBRapier/Formats/SVG/SVGSkin/SVGItems/Styled.py

#!/usr/bin/env python
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##~ License 
##~ 
##- The RuneBlade Foundation library is intended to ease some 
##- aspects of writing intricate Jabber, XML, and User Interface (wxPython, etc.) 
##- applications, while providing the flexibility to modularly change the 
##- architecture. Enjoy.
##~ 
##~ Copyright (C) 2002  TechGame Networks, LLC.
##~ 
##~ This library is free software; you can redistribute it and/or
##~ modify it under the terms of the BSD style License as found in the 
##~ LICENSE file included with this distribution.
##~ 
##~ TechGame Networks, LLC can be reached at:
##~ 3578 E. Hartsel Drive #211
##~ Colorado Springs, Colorado, USA, 80920
##~
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Imports 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

import warnings
from RBFoundation.XMLUtilityFunctions import ColorStringToRGB
from Common import TransformableSVGItem

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Definitions 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class StyledSVGItem(TransformableSVGItem):
    def InterpretSettings(self, settings):
        TransformableSVGItem.InterpretSettings(self, settings)

        stylelist = self._asStyleList(settings.get('style', ''))
        explicit_styles = [(n, settings[n].strip()) for n in self.explicit_styles_mapping if n in settings]
        styledict = self._asStyleDict(stylelist, explicit_styles)
        self.object.SetStyle(styledict)

    #~ helpers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def _asString(self, value):
        return str(value)

    def _asColor(self, color):
        """
        Valid color strings:
            color="none"
            color="black" # constant color lookup
            color="#ff0088"
            color="#f08"
            color="rgb(255, 0, 136)"
            color="rgb(1.0, 0.0, 0.53125)"
        """
        if isinstance(color, (type(None), int, long, tuple)):
            result = color
        elif color == 'currentColor':
            result = 'currentColor'
        elif color.startswith('url'):
            warnings.warn('TODO: implement color url')
            result = None
        elif not color:
            result = None
        else:
            result = ColorStringToRGB(color)
        return result 

    def _asOpacity(self, opacity):
        result = float(opacity)
        if not (0. <= result <= 1.):
            raise ValueError, "Opacity value must be in the range of [0.0, 1.0], but was %r (%r)" % (opacity, result)
        return result

    def _asDashArray(self, dasharray):
        if not isinstance(dasharray, (list, tuple)):
            dasharray = dasharray.split(',') or dasharray.split()
            dasharray = [x.strip() for x in dasharray]
        else:
            dasharray = list(dasharray)
        if len(dasharray) & 1:
            # dasharray is odd -- repeat to make it even, according to SVG book
            dasharray *= 2
        return dasharray

    def _asStyleList(self, style):
        result = []
        for entry in filter(None, style.split(';')):
            name, value = entry.split(':', 1) 
            result.append((name.strip(), value.strip()))
        return result

    def _asStyleDict(self, *stylesIn):
        styledict = {}
        map(styledict.update, map(dict, stylesIn))
        mapping = self.explicit_styles_mapping
        for name, value in styledict.iteritems():
            mappingFn = mapping.get(name, None)
            if mappingFn is not None:
                styledict[name] = mappingFn(self, value)
        return styledict

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Conversion Mappings
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    explicit_styles_mapping = {
        "color": _asColor,

        "stroke": _asColor,
        "stroke-opacity": _asOpacity,
        #"stroke-width": TransformableSVGItem._asCoord,
        #"stroke-dasharray": _asDashArray,
        #"stroke-linecap": _asString,
        #"stroke-linejoin": _asString,
        #"stroke-meterlimit": _asString,

        "fill": _asColor,
        "fill-opacity": _asOpacity,
        "fill-rule": _asString,
        }