share/extensions/inkex.py

   1 #!/usr/bin/env python
   2 """
   3 inkex.py
   4 A helper module for creating Inkscape extensions
   5
   6 Copyright (C) 2005,2007 Aaron Spike, aaron@ekips.org
   7
   8 This program is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 This program is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with this program; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21 """
  22 import sys, copy, optparse, random, re
  23 import gettext
  24 from math import *
  25 _ = gettext.gettext
  26
  27 #a dictionary of all of the xmlns prefixes in a standard inkscape doc
  28 NSS = {
  29 u'sodipodi' :u'http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd',
  30 u'cc'       :u'http://creativecommons.org/ns#',
  31 u'ccOLD'    :u'http://web.resource.org/cc/',
  32 u'svg'      :u'http://www.w3.org/2000/svg',
  33 u'dc'       :u'http://purl.org/dc/elements/1.1/',
  34 u'rdf'      :u'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
  35 u'inkscape' :u'http://www.inkscape.org/namespaces/inkscape',
  36 u'xlink'    :u'http://www.w3.org/1999/xlink',
  37 u'xml'      :u'http://www.w3.org/XML/1998/namespace'
  38 }
  39
  40 #a dictionary of unit to user unit conversion factors
  41 uuconv = {'in':90.0, 'pt':1.25, 'px':1, 'mm':3.5433070866, 'cm':35.433070866, 'm':3543.3070866,
  42           'km':3543307.0866, 'pc':15.0, 'yd':3240 , 'ft':1080}
  43 def unittouu(string):
  44     '''Returns userunits given a string representation of units in another system'''
  45     unit = re.compile('(%s)$' % '|'.join(uuconv.keys()))
  46     param = re.compile(r'(([-+]?[0-9]+(\.[0-9]*)?|[-+]?\.[0-9]+)([eE][-+]?[0-9]+)?)')
  47
  48     p = param.match(string)
  49     u = unit.search(string)
  50     if p:
  51         retval = float(p.string[p.start():p.end()])
  52     else:
  53         retval = 0.0
  54     if u:
  55         try:
  56             return retval * uuconv[u.string[u.start():u.end()]]
  57         except KeyError:
  58             pass
  59     return retval
  60
  61 def uutounit(val, unit):
  62     return val/uuconv[unit]
  63
  64 try:
  65     from lxml import etree
  66 except Exception, e:
  67     sys.exit(_("The fantastic lxml wrapper for libxml2 is required by inkex.py and therefore this extension. Please download and install the latest version from http://cheeseshop.python.org/pypi/lxml/, or install it through your package manager by a command like: sudo apt-get install python-lxml\n\nTechnical details:\n%s" % (e,)))
  68
  69
  70 def debug(what):
  71     sys.stderr.write(str(what) + "\n")
  72     return what
  73
  74 def errormsg(msg):
  75     """Intended for end-user-visible error messages.
  76
  77        (Currently just writes to stderr with an appended newline, but could do
  78        something better in future: e.g. could add markup to distinguish error
  79        messages from status messages or debugging output.)
  80
  81        Note that this should always be combined with translation:
  82
  83          import gettext
  84          _ = gettext.gettext
  85          ...
  86          inkex.errormsg(_("This extension requires two selected paths."))
  87     """
  88     sys.stderr.write((unicode(msg) + "\n").encode("UTF-8"))
  89
  90 def check_inkbool(option, opt, value):
  91     if str(value).capitalize() == 'True':
  92         return True
  93     elif str(value).capitalize() == 'False':
  94         return False
  95     else:
  96         raise optparse.OptionValueError("option %s: invalid inkbool value: %s" % (opt, value))
  97
  98 def addNS(tag, ns=None):
  99     val = tag
 100     if ns!=None and len(ns)>0 and NSS.has_key(ns) and len(tag)>0 and tag[0]!='{':
 101         val = "{%s}%s" % (NSS[ns], tag)
 102     return val
 103
 104 class InkOption(optparse.Option):
 105     TYPES = optparse.Option.TYPES + ("inkbool",)
 106     TYPE_CHECKER = copy.copy(optparse.Option.TYPE_CHECKER)
 107     TYPE_CHECKER["inkbool"] = check_inkbool
 108
 109 class Effect:
 110     """A class for creating Inkscape SVG Effects"""
 111
 112     def __init__(self, *args, **kwargs):
 113         self.document=None
 114         self.ctx=None
 115         self.selected={}
 116         self.doc_ids={}
 117         self.options=None
 118         self.args=None
 119         self.OptionParser = optparse.OptionParser(usage="usage: %prog [options] SVGfile",option_class=InkOption)
 120         self.OptionParser.add_option("--id",
 121                         action="append", type="string", dest="ids", default=[],
 122                         help="id attribute of object to manipulate")
 123
 124     def effect(self):
 125         pass
 126
 127     def getoptions(self,args=sys.argv[1:]):
 128         """Collect command line arguments"""
 129         self.options, self.args = self.OptionParser.parse_args(args)
 130
 131     def parse(self,file=None):
 132         """Parse document in specified file or on stdin"""
 133         try:
 134             try:
 135                 stream = open(file,'r')
 136             except:
 137                 stream = open(self.svg_file,'r')
 138         except:
 139             stream = sys.stdin
 140         self.document = etree.parse(stream)
 141         stream.close()
 142
 143     def getposinlayer(self):
 144         #defaults
 145         self.current_layer = self.document.getroot()
 146         self.view_center = (0.0,0.0)
 147
 148         layerattr = self.document.xpath('//sodipodi:namedview/@inkscape:current-layer', namespaces=NSS)
 149         if layerattr:
 150             layername = layerattr[0]
 151             layer = self.document.xpath('//svg:g[@id="%s"]' % layername, namespaces=NSS)
 152             if layer:
 153                 self.current_layer = layer[0]
 154
 155         xattr = self.document.xpath('//sodipodi:namedview/@inkscape:cx', namespaces=NSS)
 156         yattr = self.document.xpath('//sodipodi:namedview/@inkscape:cy', namespaces=NSS)
 157         doc_height = unittouu(self.document.getroot().get('height'))
 158         if xattr and yattr:
 159             x = xattr[0]
 160             y = yattr[0]
 161             if x and y:
 162                 self.view_center = (float(x), doc_height - float(y)) # FIXME: y-coordinate flip, eliminate it when it's gone in Inkscape
 163
 164     def getselected(self):
 165         """Collect selected nodes"""
 166         for i in self.options.ids:
 167             path = '//*[@id="%s"]' % i
 168             for node in self.document.xpath(path, namespaces=NSS):
 169                 self.selected[i] = node
 170
 171     def getElementById(self, id):
 172         path = '//*[@id="%s"]' % id
 173         el_list = self.document.xpath(path, namespaces=NSS)
 174         if el_list:
 175           return el_list[0]
 176         else:
 177           return None
 178
 179     def getParentNode(self, node):
 180         for parent in self.document.getiterator():
 181             if node in parent.getchildren():
 182                 return parent
 183                 break
 184
 185
 186     def getdocids(self):
 187         docIdNodes = self.document.xpath('//@id', namespaces=NSS)
 188         for m in docIdNodes:
 189             self.doc_ids[m] = 1
 190
 191     def getNamedView(self):
 192         return self.document.xpath('//sodipodi:namedview', namespaces=NSS)[0]
 193
 194     def createGuide(self, posX, posY, angle):
 195         atts = {
 196           'position': str(posX)+','+str(posY),
 197           'orientation': str(sin(radians(angle)))+','+str(-cos(radians(angle)))
 198           }
 199         guide = etree.SubElement(
 200                   self.getNamedView(),
 201                   addNS('guide','sodipodi'), atts )
 202         return guide
 203
 204     def output(self):
 205         """Serialize document into XML on stdout"""
 206         self.document.write(sys.stdout)
 207
 208     def affect(self, args=sys.argv[1:], output=True):
 209         """Affect an SVG document with a callback effect"""
 210         self.svg_file = args[-1]
 211         self.getoptions(args)
 212         self.parse()
 213         self.getposinlayer()
 214         self.getselected()
 215         self.getdocids()
 216         self.effect()
 217         if output: self.output()
 218
 219     def uniqueId(self, old_id, make_new_id = True):
 220         new_id = old_id
 221         if make_new_id:
 222             while new_id in self.doc_ids:
 223                 new_id += random.choice('0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
 224             self.doc_ids[new_id] = 1
 225         return new_id
 226
 227     def xpathSingle(self, path):
 228         try:
 229             retval = self.document.xpath(path, namespaces=NSS)[0]
 230         except:
 231             errormsg(_("No matching node for expression: %s") % path)
 232             retval = None
 233         return retval
 234
 235
 236 # vim: expandtab shiftwidth=4 tabstop=8 softtabstop=4 encoding=utf-8 textwidth=99