inkstitch/lib/extensions/letters_to_font.py

# Authors: see git history
#
# Copyright (c) 2021 Authors
# Licensed under the GNU GPL version 3.0 or later.  See the file LICENSE for details.

import os
from html import escape, unescape
from pathlib import Path

import inkex
from inkex import errormsg

from ..commands import ensure_symbol
from ..i18n import _
from ..stitch_plan import generate_stitch_plan
from ..svg import get_correction_transform
from ..svg.tags import INKSCAPE_GROUPMODE, INKSCAPE_LABEL, SVG_PATH_TAG
from .base import InkstitchExtension


class LettersToFont(InkstitchExtension):
    '''
    This extension will create a json file to store a custom directory path for additional user fonts
    '''
    def __init__(self, *args, **kwargs):
        InkstitchExtension.__init__(self, *args, **kwargs)
        self.arg_parser.add_argument("--notebook")
        self.arg_parser.add_argument("-d", "--font-dir", type=str, default="", dest="font_dir")
        self.arg_parser.add_argument("-f", "--file-format", type=str, default="", dest="file_format")
        self.arg_parser.add_argument("-c", "--import-commands", type=str, default="params", dest="import_commands")

    def effect(self):
        font_dir = self.options.font_dir
        file_format = self.options.file_format

        if not os.path.isdir(font_dir):
            errormsg(_("Font directory not found. Please specify an existing directory."))

        glyphs = list(Path(font_dir).rglob(file_format))
        if not glyphs:
            glyphs = list(Path(font_dir).rglob(file_format.lower()))

        document = self.document.getroot()
        group = None
        for glyph in glyphs:
            letter = self.get_glyph_element(glyph)
            label = unescape(letter.get(INKSCAPE_LABEL, ' ')).split('.')[0][-1]
            label = f"GlyphLayer-{ label }"
            group = inkex.Group(attrib={
                INKSCAPE_LABEL: label,
                INKSCAPE_GROUPMODE: "layer",
                "transform": get_correction_transform(document, child=True)
            })

            # remove color block groups if we import without commands
            # there will only be one object per color block anyway
            if self.options.import_commands == "none":
                for element in letter.iter(SVG_PATH_TAG):
                    group.insert(0, element)
            else:
                group.insert(0, letter)

            document.insert(0, group)
            group.set('style', 'display:none')

        # We found no glyphs, no need to proceed
        if group is None:
            return

        # users may be confused if they get an empty document
        # make last letter visible again
        group.set('style', None)

        if self.options.import_commands == "symbols":
            # In most cases trims are inserted with the imported letters.
            # Let's make sure the trim symbol exists in the defs section
            ensure_symbol(document, 'trim')

        self.insert_baseline()

    def get_glyph_element(self, glyph):
        stitch_plan = generate_stitch_plan(str(glyph), self.options.import_commands)
        # we received a stitch plan wrapped in an svg document, we only need the stitch_plan group
        # this group carries the name of the file, so we can search for it.
        label = os.path.basename(glyph)
        search_string = f'.//*[@inkscape:label="{ escape(label) }"]'
        stitch_plan = stitch_plan.xpath(search_string, namespaces=inkex.NSS)[0]
        stitch_plan.attrib.pop(INKSCAPE_GROUPMODE)
        stitch_plan.label = label
        return stitch_plan

    def insert_baseline(self):
        self.svg.namedview.add_guide(position=0.0, name="baseline")