1 #!/usr/bin/env python
2 """
3 inkex.py
4 A helper module for creating Inkscape extensions
6 Copyright (C) 2005,2007 Aaron Spike, aaron@ekips.org
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.
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.
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
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 }
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]+)?)')
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
61 def uutounit(val, unit):
62 return val/uuconv[unit]
64 try:
65 from lxml import etree
66 except:
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'))
69 def debug(what):
70 sys.stderr.write(str(what) + "\n")
71 return what
73 def errormsg(msg):
74 """Intended for end-user-visible error messages.
76 (Currently just writes to stderr with an appended newline, but could do
77 something better in future: e.g. could add markup to distinguish error
78 messages from status messages or debugging output.)
80 Note that this should always be combined with translation:
82 import gettext
83 _ = gettext.gettext
84 ...
85 inkex.errormsg(_("This extension requires two selected paths."))
86 """
87 sys.stderr.write((str(msg) + "\n").encode("UTF-8"))
89 def check_inkbool(option, opt, value):
90 if str(value).capitalize() == 'True':
91 return True
92 elif str(value).capitalize() == 'False':
93 return False
94 else:
95 raise optparse.OptionValueError("option %s: invalid inkbool value: %s" % (opt, value))
97 def addNS(tag, ns=None):
98 val = tag
99 if ns!=None and len(ns)>0 and NSS.has_key(ns) and len(tag)>0 and tag[0]!='{':
100 val = "{%s}%s" % (NSS[ns], tag)
101 return val
103 class InkOption(optparse.Option):
104 TYPES = optparse.Option.TYPES + ("inkbool",)
105 TYPE_CHECKER = copy.copy(optparse.Option.TYPE_CHECKER)
106 TYPE_CHECKER["inkbool"] = check_inkbool
108 class Effect:
109 """A class for creating Inkscape SVG Effects"""
111 def __init__(self, *args, **kwargs):
112 self.document=None
113 self.ctx=None
114 self.selected={}
115 self.doc_ids={}
116 self.options=None
117 self.args=None
118 self.OptionParser = optparse.OptionParser(usage="usage: %prog [options] SVGfile",option_class=InkOption)
119 self.OptionParser.add_option("--id",
120 action="append", type="string", dest="ids", default=[],
121 help="id attribute of object to manipulate")
123 def effect(self):
124 pass
126 def getoptions(self,args=sys.argv[1:]):
127 """Collect command line arguments"""
128 self.options, self.args = self.OptionParser.parse_args(args)
130 def parse(self,file=None):
131 """Parse document in specified file or on stdin"""
132 try:
133 try:
134 stream = open(file,'r')
135 except:
136 stream = open(self.svg_file,'r')
137 except:
138 stream = sys.stdin
139 self.document = etree.parse(stream)
140 stream.close()
142 def getposinlayer(self):
143 #defaults
144 self.current_layer = self.document.getroot()
145 self.view_center = (0.0,0.0)
147 layerattr = self.document.xpath('//sodipodi:namedview/@inkscape:current-layer', namespaces=NSS)
148 if layerattr:
149 layername = layerattr[0]
150 layer = self.document.xpath('//svg:g[@id="%s"]' % layername, namespaces=NSS)
151 if layer:
152 self.current_layer = layer[0]
154 xattr = self.document.xpath('//sodipodi:namedview/@inkscape:cx', namespaces=NSS)
155 yattr = self.document.xpath('//sodipodi:namedview/@inkscape:cy', namespaces=NSS)
156 doc_height = unittouu(self.document.getroot().get('height'))
157 if xattr and yattr:
158 x = xattr[0]
159 y = yattr[0]
160 if x and y:
161 self.view_center = (float(x), doc_height - float(y)) # FIXME: y-coordinate flip, eliminate it when it's gone in Inkscape
163 def getselected(self):
164 """Collect selected nodes"""
165 for i in self.options.ids:
166 path = '//*[@id="%s"]' % i
167 for node in self.document.xpath(path, namespaces=NSS):
168 self.selected[i] = node
170 def getElementById(self, id):
171 path = '//*[@id="%s"]' % id
172 el_list = self.document.xpath(path, namespaces=NSS)
173 if el_list:
174 return el_list[0]
175 else:
176 return None
178 def getdocids(self):
179 docIdNodes = self.document.xpath('//@id', namespaces=NSS)
180 for m in docIdNodes:
181 self.doc_ids[m] = 1
183 def getNamedView(self):
184 return self.document.xpath('//sodipodi:namedview', namespaces=NSS)[0]
186 def createGuide(self, posX, posY, angle):
187 atts = {
188 'position': str(posX)+','+str(posY),
189 'orientation': str(sin(radians(angle)))+','+str(-cos(radians(angle)))
190 }
191 guide = etree.SubElement(
192 self.getNamedView(),
193 addNS('guide','sodipodi'), atts )
194 return guide
196 def output(self):
197 """Serialize document into XML on stdout"""
198 self.document.write(sys.stdout)
200 def affect(self, args=sys.argv[1:], output=True):
201 """Affect an SVG document with a callback effect"""
202 self.svg_file = args[-1]
203 self.getoptions(args)
204 self.parse()
205 self.getposinlayer()
206 self.getselected()
207 self.getdocids()
208 self.effect()
209 if output: self.output()
211 def uniqueId(self, old_id, make_new_id = True):
212 new_id = old_id
213 if make_new_id:
214 while new_id in self.doc_ids:
215 new_id += random.choice('0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
216 self.doc_ids[new_id] = 1
217 return new_id
219 def xpathSingle(self, path):
220 try:
221 retval = self.document.xpath(path, namespaces=NSS)[0]
222 except:
223 errormsg(_("No matching node for expression: %s") % path)
224 retval = None
225 return retval
228 # vim: expandtab shiftwidth=4 tabstop=8 softtabstop=4 encoding=utf-8 textwidth=99