fonttools 4.60.2__cp311-cp311-win32.whl

fontTools/misc/visitor.py

@@ -0,0 +1,158 @@
+"""Generic visitor pattern implementation for Python objects."""
+
+import enum
+import weakref
+
+
+class Visitor(object):
+    defaultStop = False
+
+    _visitors = {
+        # By default we skip visiting weak references to avoid recursion
+        # issues. Users can override this by registering a visit
+        # function for weakref.ProxyType.
+        weakref.ProxyType: {None: lambda self, obj, *args, **kwargs: False}
+    }
+
+    @classmethod
+    def _register(celf, clazzes_attrs):
+        assert celf != Visitor, "Subclass Visitor instead."
+        if "_visitors" not in celf.__dict__:
+            celf._visitors = {}
+
+        def wrapper(method):
+            assert method.__name__ == "visit"
+            for clazzes, attrs in clazzes_attrs:
+                if type(clazzes) != tuple:
+                    clazzes = (clazzes,)
+                if type(attrs) == str:
+                    attrs = (attrs,)
+                for clazz in clazzes:
+                    _visitors = celf._visitors.setdefault(clazz, {})
+                    for attr in attrs:
+                        assert attr not in _visitors, (
+                            "Oops, class '%s' has visitor function for '%s' defined already."
+                            % (clazz.__name__, attr)
+                        )
+                        _visitors[attr] = method
+            return None
+
+        return wrapper
+
+    @classmethod
+    def register(celf, clazzes):
+        if type(clazzes) != tuple:
+            clazzes = (clazzes,)
+        return celf._register([(clazzes, (None,))])
+
+    @classmethod
+    def register_attr(celf, clazzes, attrs):
+        clazzes_attrs = []
+        if type(clazzes) != tuple:
+            clazzes = (clazzes,)
+        if type(attrs) == str:
+            attrs = (attrs,)
+        for clazz in clazzes:
+            clazzes_attrs.append((clazz, attrs))
+        return celf._register(clazzes_attrs)
+
+    @classmethod
+    def register_attrs(celf, clazzes_attrs):
+        return celf._register(clazzes_attrs)
+
+    @classmethod
+    def _visitorsFor(celf, thing, _default={}):
+        typ = type(thing)
+
+        for celf in celf.mro():
+            _visitors = getattr(celf, "_visitors", None)
+            if _visitors is None:
+                break
+
+            for base in typ.mro():
+                m = celf._visitors.get(base, None)
+                if m is not None:
+                    return m
+
+        return _default
+
+    def visitObject(self, obj, *args, **kwargs):
+        """Called to visit an object. This function loops over all non-private
+        attributes of the objects and calls any user-registered (via
+        ``@register_attr()`` or ``@register_attrs()``) ``visit()`` functions.
+
+        The visitor will proceed to call ``self.visitAttr()``, unless there is a
+        user-registered visit function and:
+
+        * It returns ``False``; or
+        * It returns ``None`` (or doesn't return anything) and
+          ``visitor.defaultStop`` is ``True`` (non-default).
+        """
+
+        keys = sorted(vars(obj).keys())
+        _visitors = self._visitorsFor(obj)
+        defaultVisitor = _visitors.get("*", None)
+        for key in keys:
+            if key[0] == "_":
+                continue
+            value = getattr(obj, key)
+            visitorFunc = _visitors.get(key, defaultVisitor)
+            if visitorFunc is not None:
+                ret = visitorFunc(self, obj, key, value, *args, **kwargs)
+                if ret == False or (ret is None and self.defaultStop):
+                    continue
+            self.visitAttr(obj, key, value, *args, **kwargs)
+
+    def visitAttr(self, obj, attr, value, *args, **kwargs):
+        """Called to visit an attribute of an object."""
+        self.visit(value, *args, **kwargs)
+
+    def visitList(self, obj, *args, **kwargs):
+        """Called to visit any value that is a list."""
+        for value in obj:
+            self.visit(value, *args, **kwargs)
+
+    def visitDict(self, obj, *args, **kwargs):
+        """Called to visit any value that is a dictionary."""
+        for value in obj.values():
+            self.visit(value, *args, **kwargs)
+
+    def visitLeaf(self, obj, *args, **kwargs):
+        """Called to visit any value that is not an object, list,
+        or dictionary."""
+        pass
+
+    def visit(self, obj, *args, **kwargs):
+        """This is the main entry to the visitor. The visitor will visit object
+        ``obj``.
+
+        The visitor will first determine if there is a registered (via
+        ``@register()``) visit function for the type of object. If there is, it
+        will be called, and ``(visitor, obj, *args, **kwargs)`` will be passed
+        to the user visit function.
+
+        The visitor will not recurse if there is a user-registered visit
+        function and:
+
+        * It returns ``False``; or
+        * It returns ``None`` (or doesn't return anything) and
+          ``visitor.defaultStop`` is ``True`` (non-default)
+
+        Otherwise,  the visitor will proceed to dispatch to one of
+        ``self.visitObject()``, ``self.visitList()``, ``self.visitDict()``, or
+        ``self.visitLeaf()`` (any of which can be overriden in a subclass).
+        """
+
+        visitorFunc = self._visitorsFor(obj).get(None, None)
+        if visitorFunc is not None:
+            ret = visitorFunc(self, obj, *args, **kwargs)
+            if ret == False or (ret is None and self.defaultStop):
+                return
+        if hasattr(obj, "__dict__") and not isinstance(obj, enum.Enum):
+            self.visitObject(obj, *args, **kwargs)
+        elif isinstance(obj, list):
+            self.visitList(obj, *args, **kwargs)
+        elif isinstance(obj, dict):
+            self.visitDict(obj, *args, **kwargs)
+        else:
+            self.visitLeaf(obj, *args, **kwargs)

fontTools/misc/xmlReader.py

@@ -0,0 +1,188 @@
+from fontTools import ttLib
+from fontTools.misc.textTools import safeEval
+from fontTools.ttLib.tables.DefaultTable import DefaultTable
+import sys
+import os
+import logging
+
+
+log = logging.getLogger(__name__)
+
+
+class TTXParseError(Exception):
+    pass
+
+
+BUFSIZE = 0x4000
+
+
+class XMLReader(object):
+    def __init__(
+        self, fileOrPath, ttFont, progress=None, quiet=None, contentOnly=False
+    ):
+        if fileOrPath == "-":
+            fileOrPath = sys.stdin
+        if not hasattr(fileOrPath, "read"):
+            self.file = open(fileOrPath, "rb")
+            self._closeStream = True
+        else:
+            # assume readable file object
+            self.file = fileOrPath
+            self._closeStream = False
+        self.ttFont = ttFont
+        self.progress = progress
+        if quiet is not None:
+            from fontTools.misc.loggingTools import deprecateArgument
+
+            deprecateArgument("quiet", "configure logging instead")
+            self.quiet = quiet
+        self.root = None
+        self.contentStack = []
+        self.contentOnly = contentOnly
+        self.stackSize = 0
+
+    def read(self, rootless=False):
+        if rootless:
+            self.stackSize += 1
+        if self.progress:
+            self.file.seek(0, 2)
+            fileSize = self.file.tell()
+            self.progress.set(0, fileSize // 100 or 1)
+            self.file.seek(0)
+        self._parseFile(self.file)
+        if self._closeStream:
+            self.close()
+        if rootless:
+            self.stackSize -= 1
+
+    def close(self):
+        self.file.close()
+
+    def _parseFile(self, file):
+        from xml.parsers.expat import ParserCreate
+
+        parser = ParserCreate()
+        parser.StartElementHandler = self._startElementHandler
+        parser.EndElementHandler = self._endElementHandler
+        parser.CharacterDataHandler = self._characterDataHandler
+
+        pos = 0
+        while True:
+            chunk = file.read(BUFSIZE)
+            if not chunk:
+                parser.Parse(chunk, 1)
+                break
+            pos = pos + len(chunk)
+            if self.progress:
+                self.progress.set(pos // 100)
+            parser.Parse(chunk, 0)
+
+    def _startElementHandler(self, name, attrs):
+        if self.stackSize == 1 and self.contentOnly:
+            # We already know the table we're parsing, skip
+            # parsing the table tag and continue to
+            # stack '2' which begins parsing content
+            self.contentStack.append([])
+            self.stackSize = 2
+            return
+        stackSize = self.stackSize
+        self.stackSize = stackSize + 1
+        subFile = attrs.get("src")
+        if subFile is not None:
+            if hasattr(self.file, "name"):
+                # if file has a name, get its parent directory
+                dirname = os.path.dirname(self.file.name)
+            else:
+                # else fall back to using the current working directory
+                dirname = os.getcwd()
+            subFile = os.path.join(dirname, subFile)
+        if not stackSize:
+            if name != "ttFont":
+                raise TTXParseError("illegal root tag: %s" % name)
+            if self.ttFont.reader is None and not self.ttFont.tables:
+                sfntVersion = attrs.get("sfntVersion")
+                if sfntVersion is not None:
+                    if len(sfntVersion) != 4:
+                        sfntVersion = safeEval('"' + sfntVersion + '"')
+                    self.ttFont.sfntVersion = sfntVersion
+            self.contentStack.append([])
+        elif stackSize == 1:
+            if subFile is not None:
+                subReader = XMLReader(subFile, self.ttFont, self.progress)
+                subReader.read()
+                self.contentStack.append([])
+                return
+            tag = ttLib.xmlToTag(name)
+            msg = "Parsing '%s' table..." % tag
+            if self.progress:
+                self.progress.setLabel(msg)
+            log.info(msg)
+            if tag == "GlyphOrder":
+                tableClass = ttLib.GlyphOrder
+            elif "ERROR" in attrs or ("raw" in attrs and safeEval(attrs["raw"])):
+                tableClass = DefaultTable
+            else:
+                tableClass = ttLib.getTableClass(tag)
+                if tableClass is None:
+                    tableClass = DefaultTable
+            if tag == "loca" and tag in self.ttFont:
+                # Special-case the 'loca' table as we need the
+                #    original if the 'glyf' table isn't recompiled.
+                self.currentTable = self.ttFont[tag]
+            else:
+                self.currentTable = tableClass(tag)
+                self.ttFont[tag] = self.currentTable
+            self.contentStack.append([])
+        elif stackSize == 2 and subFile is not None:
+            subReader = XMLReader(subFile, self.ttFont, self.progress, contentOnly=True)
+            subReader.read()
+            self.contentStack.append([])
+            self.root = subReader.root
+        elif stackSize == 2:
+            self.contentStack.append([])
+            self.root = (name, attrs, self.contentStack[-1])
+        else:
+            l = []
+            self.contentStack[-1].append((name, attrs, l))
+            self.contentStack.append(l)
+
+    def _characterDataHandler(self, data):
+        if self.stackSize > 1:
+            # parser parses in chunks, so we may get multiple calls
+            # for the same text node; thus we need to append the data
+            # to the last item in the content stack:
+            # https://github.com/fonttools/fonttools/issues/2614
+            if (
+                data != "\n"
+                and self.contentStack[-1]
+                and isinstance(self.contentStack[-1][-1], str)
+                and self.contentStack[-1][-1] != "\n"
+            ):
+                self.contentStack[-1][-1] += data
+            else:
+                self.contentStack[-1].append(data)
+
+    def _endElementHandler(self, name):
+        self.stackSize = self.stackSize - 1
+        del self.contentStack[-1]
+        if not self.contentOnly:
+            if self.stackSize == 1:
+                self.root = None
+            elif self.stackSize == 2:
+                name, attrs, content = self.root
+                self.currentTable.fromXML(name, attrs, content, self.ttFont)
+                self.root = None
+
+
+class ProgressPrinter(object):
+    def __init__(self, title, maxval=100):
+        print(title)
+
+    def set(self, val, maxval=None):
+        pass
+
+    def increment(self, val=1):
+        pass
+
+    def setLabel(self, text):
+        print(text)

fontTools/misc/xmlWriter.py

@@ -0,0 +1,231 @@
+"""xmlWriter.py -- Simple XML authoring class"""
+
+from fontTools.misc.textTools import byteord, strjoin, tobytes, tostr
+import sys
+import os
+import string
+import logging
+import itertools
+
+INDENT = "  "
+TTX_LOG = logging.getLogger("fontTools.ttx")
+REPLACEMENT = "?"
+ILLEGAL_XML_CHARS = dict.fromkeys(
+    itertools.chain(
+        range(0x00, 0x09),
+        (0x0B, 0x0C),
+        range(0x0E, 0x20),
+        range(0xD800, 0xE000),
+        (0xFFFE, 0xFFFF),
+    ),
+    REPLACEMENT,
+)
+
+
+class XMLWriter(object):
+    def __init__(
+        self,
+        fileOrPath,
+        indentwhite=INDENT,
+        idlefunc=None,
+        encoding="utf_8",
+        newlinestr="\n",
+    ):
+        if encoding.lower().replace("-", "").replace("_", "") != "utf8":
+            raise Exception("Only UTF-8 encoding is supported.")
+        if fileOrPath == "-":
+            fileOrPath = sys.stdout
+        if not hasattr(fileOrPath, "write"):
+            self.filename = fileOrPath
+            self.file = open(fileOrPath, "wb")
+            self._closeStream = True
+        else:
+            self.filename = None
+            # assume writable file object
+            self.file = fileOrPath
+            self._closeStream = False
+
+        # Figure out if writer expects bytes or unicodes
+        try:
+            # The bytes check should be first.  See:
+            # https://github.com/fonttools/fonttools/pull/233
+            self.file.write(b"")
+            self.totype = tobytes
+        except TypeError:
+            # This better not fail.
+            self.file.write("")
+            self.totype = tostr
+        self.indentwhite = self.totype(indentwhite)
+        if newlinestr is None:
+            self.newlinestr = self.totype(os.linesep)
+        else:
+            self.newlinestr = self.totype(newlinestr)
+        self.indentlevel = 0
+        self.stack = []
+        self.needindent = 1
+        self.idlefunc = idlefunc
+        self.idlecounter = 0
+        self._writeraw('<?xml version="1.0" encoding="UTF-8"?>')
+        self.newline()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exception_type, exception_value, traceback):
+        self.close()
+
+    def close(self):
+        if self._closeStream:
+            self.file.close()
+
+    def write(self, string, indent=True):
+        """Writes text."""
+        self._writeraw(escape(string), indent=indent)
+
+    def writecdata(self, string):
+        """Writes text in a CDATA section."""
+        self._writeraw("<![CDATA[" + string + "]]>")
+
+    def write8bit(self, data, strip=False):
+        """Writes a bytes() sequence into the XML, escaping
+        non-ASCII bytes.  When this is read in xmlReader,
+        the original bytes can be recovered by encoding to
+        'latin-1'."""
+        self._writeraw(escape8bit(data), strip=strip)
+
+    def write_noindent(self, string):
+        """Writes text without indentation."""
+        self._writeraw(escape(string), indent=False)
+
+    def _writeraw(self, data, indent=True, strip=False):
+        """Writes bytes, possibly indented."""
+        if indent and self.needindent:
+            self.file.write(self.indentlevel * self.indentwhite)
+            self.needindent = 0
+        s = self.totype(data, encoding="utf_8")
+        if strip:
+            s = s.strip()
+        self.file.write(s)
+
+    def newline(self):
+        self.file.write(self.newlinestr)
+        self.needindent = 1
+        idlecounter = self.idlecounter
+        if not idlecounter % 100 and self.idlefunc is not None:
+            self.idlefunc()
+        self.idlecounter = idlecounter + 1
+
+    def comment(self, data):
+        data = escape(data)
+        lines = data.split("\n")
+        self._writeraw("<!-- " + lines[0])
+        for line in lines[1:]:
+            self.newline()
+            self._writeraw("     " + line)
+        self._writeraw(" -->")
+
+    def simpletag(self, _TAG_, *args, **kwargs):
+        attrdata = self.stringifyattrs(*args, **kwargs)
+        data = "<%s%s/>" % (_TAG_, attrdata)
+        self._writeraw(data)
+
+    def begintag(self, _TAG_, *args, **kwargs):
+        attrdata = self.stringifyattrs(*args, **kwargs)
+        data = "<%s%s>" % (_TAG_, attrdata)
+        self._writeraw(data)
+        self.stack.append(_TAG_)
+        self.indent()
+
+    def endtag(self, _TAG_):
+        assert self.stack and self.stack[-1] == _TAG_, "nonmatching endtag"
+        del self.stack[-1]
+        self.dedent()
+        data = "</%s>" % _TAG_
+        self._writeraw(data)
+
+    def dumphex(self, data):
+        linelength = 16
+        hexlinelength = linelength * 2
+        chunksize = 8
+        for i in range(0, len(data), linelength):
+            hexline = hexStr(data[i : i + linelength])
+            line = ""
+            white = ""
+            for j in range(0, hexlinelength, chunksize):
+                line = line + white + hexline[j : j + chunksize]
+                white = " "
+            self._writeraw(line)
+            self.newline()
+
+    def indent(self):
+        self.indentlevel = self.indentlevel + 1
+
+    def dedent(self):
+        assert self.indentlevel > 0
+        self.indentlevel = self.indentlevel - 1
+
+    def stringifyattrs(self, *args, **kwargs):
+        if kwargs:
+            assert not args
+            attributes = sorted(kwargs.items())
+        elif args:
+            assert len(args) == 1
+            attributes = args[0]
+        else:
+            return ""
+        data = ""
+        for attr, value in attributes:
+            if not isinstance(value, (bytes, str)):
+                value = str(value)
+            data = data + ' %s="%s"' % (attr, escapeattr(value))
+        return data
+
+
+def escape(data):
+    """Escape characters not allowed in `XML 1.0 <https://www.w3.org/TR/xml/#NT-Char>`_."""
+    data = tostr(data, "utf_8")
+    data = data.replace("&", "&amp;")
+    data = data.replace("<", "&lt;")
+    data = data.replace(">", "&gt;")
+    data = data.replace("\r", "&#13;")
+
+    newData = data.translate(ILLEGAL_XML_CHARS)
+    if newData != data:
+        maxLen = 10
+        preview = repr(data)
+        if len(data) > maxLen:
+            preview = repr(data[:maxLen])[1:-1] + "..."
+        TTX_LOG.warning(
+            "Illegal XML character(s) found; replacing offending " "string %r with %r",
+            preview,
+            REPLACEMENT,
+        )
+    return newData
+
+
+def escapeattr(data):
+    data = escape(data)
+    data = data.replace('"', "&quot;")
+    return data
+
+
+def escape8bit(data):
+    """Input is Unicode string."""
+
+    def escapechar(c):
+        n = ord(c)
+        if 32 <= n <= 127 and c not in "<&>":
+            return c
+        else:
+            return "&#" + repr(n) + ";"
+
+    return strjoin(map(escapechar, data.decode("latin-1")))
+
+
+def hexStr(s):
+    h = string.hexdigits
+    r = ""
+    for c in s:
+        i = byteord(c)
+        r = r + h[(i >> 4) & 0xF] + h[i & 0xF]
+    return r