inkstitch/lib/extensions/base.py

230 wiersze
7.7 KiB
Python
Czysty Zwykły widok Historia

import json
2019-04-10 15:42:49 +00:00
import os
import re
2020-05-16 21:01:00 +00:00
from collections import MutableMapping
from copy import deepcopy
from stringcase import snakecase
2020-05-16 21:01:00 +00:00
import inkex
from ..commands import is_command, layer_commands
from ..elements import EmbroideryElement, nodes_to_elements
2020-05-16 21:01:00 +00:00
from ..elements.clone import is_clone, is_embroiderable_clone
2018-08-22 01:43:09 +00:00
from ..i18n import _
from ..svg import generate_unique_id
2020-05-16 21:01:00 +00:00
from ..svg.tags import (CONNECTOR_TYPE, EMBROIDERABLE_TAGS, INKSCAPE_GROUPMODE,
2020-05-27 16:39:04 +00:00
NOT_EMBROIDERABLE_TAGS, SVG_DEFS_TAG, SVG_GROUP_TAG,
SVG_PATH_TAG)
2018-04-14 01:23:00 +00:00
SVG_METADATA_TAG = inkex.addNS("metadata", "svg")
def strip_namespace(tag):
"""Remove xml namespace from a tag name.
>>> {http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd}namedview
<<< namedview
"""
match = re.match(r'^\{[^}]+\}(.+)$', tag)
2018-04-14 01:23:00 +00:00
if match:
return match.group(1)
else:
return tag
class InkStitchMetadata(MutableMapping):
"""Helper class to get and set inkstitch-specific metadata attributes.
Operates on a document and acts like a dict. Setting an item adds or
updates a metadata element in the document. Getting an item retrieves
a metadata element's text contents or None if an element by that name
doesn't exist.
"""
def __init__(self, document):
self.document = document
self.metadata = self._get_or_create_metadata()
def _get_or_create_metadata(self):
metadata = self.document.find(SVG_METADATA_TAG)
if metadata is None:
2018-04-17 00:17:07 +00:00
metadata = inkex.etree.SubElement(self.document.getroot(), SVG_METADATA_TAG)
# move it so that it goes right after the first element, sodipodi:namedview
self.document.getroot().remove(metadata)
self.document.getroot().insert(1, metadata)
2018-04-14 01:23:00 +00:00
return metadata
# Because this class inherints from MutableMapping, all we have to do is
# implement these five methods and we get a full dict-like interface.
def __setitem__(self, name, value):
2018-04-21 20:23:13 +00:00
item = self._find_item(name)
item.text = json.dumps(value)
2018-04-14 01:23:00 +00:00
2018-06-10 01:23:21 +00:00
def _find_item(self, name, create=True):
2018-04-14 01:23:00 +00:00
tag = inkex.addNS(name, "inkstitch")
item = self.metadata.find(tag)
2018-06-10 01:23:21 +00:00
if item is None and create:
2018-04-14 01:23:00 +00:00
item = inkex.etree.SubElement(self.metadata, tag)
return item
def __getitem__(self, name):
item = self._find_item(name)
try:
return json.loads(item.text)
except (ValueError, TypeError):
return None
2018-04-14 01:23:00 +00:00
def __delitem__(self, name):
2018-06-10 01:23:21 +00:00
item = self._find_item(name, create=False)
2018-04-14 01:23:00 +00:00
2018-06-10 01:23:21 +00:00
if item is not None:
2018-04-14 01:23:00 +00:00
self.metadata.remove(item)
def __iter__(self):
for child in self.metadata:
if child.prefix == "inkstitch":
yield strip_namespace(child.tag)
def __len__(self):
i = 0
2018-04-14 01:23:00 +00:00
for i, item in enumerate(self):
pass
return i + 1
class InkstitchExtension(inkex.Effect):
"""Base class for Inkstitch extensions. Not intended for direct use."""
@classmethod
def name(cls):
return snakecase(cls.__name__)
def hide_all_layers(self):
for g in self.document.getroot().findall(SVG_GROUP_TAG):
if g.get(INKSCAPE_GROUPMODE) == "layer":
g.set("style", "display:none")
def ensure_current_layer(self):
# if no layer is selected, inkex defaults to the root, which isn't
# particularly useful
if self.current_layer is self.document.getroot():
try:
self.current_layer = self.document.xpath(".//svg:g[@inkscape:groupmode='layer']", namespaces=inkex.NSS)[0]
except IndexError:
# No layers at all?? Fine, we'll stick with the default.
pass
def no_elements_error(self):
2018-08-22 00:32:50 +00:00
if self.selected:
# l10n This was previously: "No embroiderable paths selected."
inkex.errormsg(_("Ink/Stitch doesn't know how to work with any of the objects you've selected.") + "\n")
2018-08-22 00:32:50 +00:00
else:
inkex.errormsg(_("There are no objects in the entire document that Ink/Stitch knows how to work with.") + "\n")
2020-05-16 21:01:00 +00:00
inkex.errormsg(_("Tip: Select some objects and use Path -> Object to Path to convert them to paths.") + "\n")
2020-05-16 21:01:00 +00:00
def descendants(self, node, selected=False, troubleshoot=False): # noqa: C901
nodes = []
element = EmbroideryElement(node)
2018-08-01 01:00:30 +00:00
if element.has_command('ignore_object'):
2018-07-25 02:15:28 +00:00
return []
2018-08-17 02:50:34 +00:00
if node.tag == SVG_GROUP_TAG and node.get(INKSCAPE_GROUPMODE) == "layer":
if len(list(layer_commands(node, "ignore_layer"))):
2018-08-17 02:50:34 +00:00
return []
if element.has_style('display') and element.get_style('display') is None:
return []
if node.tag == SVG_DEFS_TAG:
return []
2020-05-16 21:01:00 +00:00
# command connectors with a fill color set, will glitch into the elements list
if is_command(node) or node.get(CONNECTOR_TYPE):
return[]
2018-08-17 02:50:34 +00:00
if self.selected:
if node.get("id") in self.selected:
selected = True
else:
# if the user didn't select anything that means we process everything
selected = True
for child in node:
2020-05-16 21:01:00 +00:00
nodes.extend(self.descendants(child, selected, troubleshoot))
2020-05-16 21:01:00 +00:00
if selected:
2020-05-27 16:39:04 +00:00
if (node.tag in EMBROIDERABLE_TAGS or is_embroiderable_clone(node)) and not (node.tag == SVG_PATH_TAG and not node.get('d', '')):
2020-05-16 21:01:00 +00:00
nodes.append(node)
2020-05-27 16:39:04 +00:00
elif troubleshoot and (node.tag in NOT_EMBROIDERABLE_TAGS or node.tag in EMBROIDERABLE_TAGS or is_clone(node)):
2020-05-16 21:01:00 +00:00
nodes.append(node)
return nodes
2020-05-16 21:01:00 +00:00
def get_nodes(self, troubleshoot=False):
return self.descendants(self.document.getroot(), troubleshoot=troubleshoot)
2020-05-16 21:01:00 +00:00
def get_elements(self, troubleshoot=False):
self.elements = nodes_to_elements(self.get_nodes(troubleshoot))
if self.elements:
return True
2020-05-16 21:01:00 +00:00
if not troubleshoot:
self.no_elements_error()
2020-05-16 21:01:00 +00:00
return False
def elements_to_patches(self, elements):
patches = []
for element in elements:
if patches:
last_patch = patches[-1]
else:
last_patch = None
patches.extend(element.embroider(last_patch))
return patches
2018-04-13 00:05:01 +00:00
2018-04-14 01:23:00 +00:00
def get_inkstitch_metadata(self):
return InkStitchMetadata(self.document)
2018-06-13 02:15:32 +00:00
def get_base_file_name(self):
svg_filename = self.document.getroot().get(inkex.addNS('docname', 'sodipodi'), "embroidery.svg")
2019-04-10 15:42:49 +00:00
return os.path.splitext(svg_filename)[0]
2018-06-13 02:15:32 +00:00
def uniqueId(self, prefix, make_new_id=True):
"""Override inkex.Effect.uniqueId with a nicer naming scheme."""
return generate_unique_id(self.document, prefix)
2018-04-13 00:05:01 +00:00
def parse(self):
"""Override inkex.Effect.parse to add Ink/Stitch xml namespace"""
2018-04-13 00:05:01 +00:00
# SVG parsers don't actually look for anything at this URL. They just
# care that it's unique. That defines a "namespace" of element and
# attribute names to disambiguate conflicts with element and
# attribute names other XML namespaces.
# call the superclass's method first
inkex.Effect.parse(self)
2018-12-16 01:21:41 +00:00
# Add the inkstitch namespace to the SVG. The inkstitch namespace is
# added to inkex.NSS in ../svg/tags.py at import time.
# The below is the only way I could find to add a namespace to an
# existing element tree at the top without getting ugly prefixes like "ns0".
2018-04-14 01:23:00 +00:00
inkex.etree.cleanup_namespaces(self.document,
2018-04-13 00:05:01 +00:00
top_nsmap=inkex.NSS,
keep_ns_prefixes=inkex.NSS.keys())
2018-04-24 19:41:39 +00:00
self.original_document = deepcopy(self.document)