Spaces:
Running
Running
File size: 72,053 Bytes
b72ab63 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 |
"""
glifLib.py -- Generic module for reading and writing the .glif format.
More info about the .glif format (GLyphInterchangeFormat) can be found here:
http://unifiedfontobject.org
The main class in this module is GlyphSet. It manages a set of .glif files
in a folder. It offers two ways to read glyph data, and one way to write
glyph data. See the class doc string for details.
"""
from __future__ import annotations
import logging
import enum
from warnings import warn
from collections import OrderedDict
import fs
import fs.base
import fs.errors
import fs.osfs
import fs.path
from fontTools.misc.textTools import tobytes
from fontTools.misc import plistlib
from fontTools.pens.pointPen import AbstractPointPen, PointToSegmentPen
from fontTools.ufoLib.errors import GlifLibError
from fontTools.ufoLib.filenames import userNameToFileName
from fontTools.ufoLib.validators import (
genericTypeValidator,
colorValidator,
guidelinesValidator,
anchorsValidator,
identifierValidator,
imageValidator,
glyphLibValidator,
)
from fontTools.misc import etree
from fontTools.ufoLib import _UFOBaseIO, UFOFormatVersion
from fontTools.ufoLib.utils import numberTypes, _VersionTupleEnumMixin
__all__ = [
"GlyphSet",
"GlifLibError",
"readGlyphFromString",
"writeGlyphToString",
"glyphNameToFileName",
]
logger = logging.getLogger(__name__)
# ---------
# Constants
# ---------
CONTENTS_FILENAME = "contents.plist"
LAYERINFO_FILENAME = "layerinfo.plist"
class GLIFFormatVersion(tuple, _VersionTupleEnumMixin, enum.Enum):
FORMAT_1_0 = (1, 0)
FORMAT_2_0 = (2, 0)
@classmethod
def default(cls, ufoFormatVersion=None):
if ufoFormatVersion is not None:
return max(cls.supported_versions(ufoFormatVersion))
return super().default()
@classmethod
def supported_versions(cls, ufoFormatVersion=None):
if ufoFormatVersion is None:
# if ufo format unspecified, return all the supported GLIF formats
return super().supported_versions()
# else only return the GLIF formats supported by the given UFO format
versions = {cls.FORMAT_1_0}
if ufoFormatVersion >= UFOFormatVersion.FORMAT_3_0:
versions.add(cls.FORMAT_2_0)
return frozenset(versions)
# workaround for py3.11, see https://github.com/fonttools/fonttools/pull/2655
GLIFFormatVersion.__str__ = _VersionTupleEnumMixin.__str__
# ------------
# Simple Glyph
# ------------
class Glyph:
"""
Minimal glyph object. It has no glyph attributes until either
the draw() or the drawPoints() method has been called.
"""
def __init__(self, glyphName, glyphSet):
self.glyphName = glyphName
self.glyphSet = glyphSet
def draw(self, pen, outputImpliedClosingLine=False):
"""
Draw this glyph onto a *FontTools* Pen.
"""
pointPen = PointToSegmentPen(
pen, outputImpliedClosingLine=outputImpliedClosingLine
)
self.drawPoints(pointPen)
def drawPoints(self, pointPen):
"""
Draw this glyph onto a PointPen.
"""
self.glyphSet.readGlyph(self.glyphName, self, pointPen)
# ---------
# Glyph Set
# ---------
class GlyphSet(_UFOBaseIO):
"""
GlyphSet manages a set of .glif files inside one directory.
GlyphSet's constructor takes a path to an existing directory as it's
first argument. Reading glyph data can either be done through the
readGlyph() method, or by using GlyphSet's dictionary interface, where
the keys are glyph names and the values are (very) simple glyph objects.
To write a glyph to the glyph set, you use the writeGlyph() method.
The simple glyph objects returned through the dict interface do not
support writing, they are just a convenient way to get at the glyph data.
"""
glyphClass = Glyph
def __init__(
self,
path,
glyphNameToFileNameFunc=None,
ufoFormatVersion=None,
validateRead=True,
validateWrite=True,
expectContentsFile=False,
):
"""
'path' should be a path (string) to an existing local directory, or
an instance of fs.base.FS class.
The optional 'glyphNameToFileNameFunc' argument must be a callback
function that takes two arguments: a glyph name and a list of all
existing filenames (if any exist). It should return a file name
(including the .glif extension). The glyphNameToFileName function
is called whenever a file name is created for a given glyph name.
``validateRead`` will validate read operations. Its default is ``True``.
``validateWrite`` will validate write operations. Its default is ``True``.
``expectContentsFile`` will raise a GlifLibError if a contents.plist file is
not found on the glyph set file system. This should be set to ``True`` if you
are reading an existing UFO and ``False`` if you create a fresh glyph set.
"""
try:
ufoFormatVersion = UFOFormatVersion(ufoFormatVersion)
except ValueError as e:
from fontTools.ufoLib.errors import UnsupportedUFOFormat
raise UnsupportedUFOFormat(
f"Unsupported UFO format: {ufoFormatVersion!r}"
) from e
if hasattr(path, "__fspath__"): # support os.PathLike objects
path = path.__fspath__()
if isinstance(path, str):
try:
filesystem = fs.osfs.OSFS(path)
except fs.errors.CreateFailed:
raise GlifLibError("No glyphs directory '%s'" % path)
self._shouldClose = True
elif isinstance(path, fs.base.FS):
filesystem = path
try:
filesystem.check()
except fs.errors.FilesystemClosed:
raise GlifLibError("the filesystem '%s' is closed" % filesystem)
self._shouldClose = False
else:
raise TypeError(
"Expected a path string or fs object, found %s" % type(path).__name__
)
try:
path = filesystem.getsyspath("/")
except fs.errors.NoSysPath:
# network or in-memory FS may not map to the local one
path = str(filesystem)
# 'dirName' is kept for backward compatibility only, but it's DEPRECATED
# as it's not guaranteed that it maps to an existing OSFS directory.
# Client could use the FS api via the `self.fs` attribute instead.
self.dirName = fs.path.parts(path)[-1]
self.fs = filesystem
# if glyphSet contains no 'contents.plist', we consider it empty
self._havePreviousFile = filesystem.exists(CONTENTS_FILENAME)
if expectContentsFile and not self._havePreviousFile:
raise GlifLibError(f"{CONTENTS_FILENAME} is missing.")
# attribute kept for backward compatibility
self.ufoFormatVersion = ufoFormatVersion.major
self.ufoFormatVersionTuple = ufoFormatVersion
if glyphNameToFileNameFunc is None:
glyphNameToFileNameFunc = glyphNameToFileName
self.glyphNameToFileName = glyphNameToFileNameFunc
self._validateRead = validateRead
self._validateWrite = validateWrite
self._existingFileNames: set[str] | None = None
self._reverseContents = None
self.rebuildContents()
def rebuildContents(self, validateRead=None):
"""
Rebuild the contents dict by loading contents.plist.
``validateRead`` will validate the data, by default it is set to the
class's ``validateRead`` value, can be overridden.
"""
if validateRead is None:
validateRead = self._validateRead
contents = self._getPlist(CONTENTS_FILENAME, {})
# validate the contents
if validateRead:
invalidFormat = False
if not isinstance(contents, dict):
invalidFormat = True
else:
for name, fileName in contents.items():
if not isinstance(name, str):
invalidFormat = True
if not isinstance(fileName, str):
invalidFormat = True
elif not self.fs.exists(fileName):
raise GlifLibError(
"%s references a file that does not exist: %s"
% (CONTENTS_FILENAME, fileName)
)
if invalidFormat:
raise GlifLibError("%s is not properly formatted" % CONTENTS_FILENAME)
self.contents = contents
self._existingFileNames = None
self._reverseContents = None
def getReverseContents(self):
"""
Return a reversed dict of self.contents, mapping file names to
glyph names. This is primarily an aid for custom glyph name to file
name schemes that want to make sure they don't generate duplicate
file names. The file names are converted to lowercase so we can
reliably check for duplicates that only differ in case, which is
important for case-insensitive file systems.
"""
if self._reverseContents is None:
d = {}
for k, v in self.contents.items():
d[v.lower()] = k
self._reverseContents = d
return self._reverseContents
def writeContents(self):
"""
Write the contents.plist file out to disk. Call this method when
you're done writing glyphs.
"""
self._writePlist(CONTENTS_FILENAME, self.contents)
# layer info
def readLayerInfo(self, info, validateRead=None):
"""
``validateRead`` will validate the data, by default it is set to the
class's ``validateRead`` value, can be overridden.
"""
if validateRead is None:
validateRead = self._validateRead
infoDict = self._getPlist(LAYERINFO_FILENAME, {})
if validateRead:
if not isinstance(infoDict, dict):
raise GlifLibError("layerinfo.plist is not properly formatted.")
infoDict = validateLayerInfoVersion3Data(infoDict)
# populate the object
for attr, value in infoDict.items():
try:
setattr(info, attr, value)
except AttributeError:
raise GlifLibError(
"The supplied layer info object does not support setting a necessary attribute (%s)."
% attr
)
def writeLayerInfo(self, info, validateWrite=None):
"""
``validateWrite`` will validate the data, by default it is set to the
class's ``validateWrite`` value, can be overridden.
"""
if validateWrite is None:
validateWrite = self._validateWrite
if self.ufoFormatVersionTuple.major < 3:
raise GlifLibError(
"layerinfo.plist is not allowed in UFO %d."
% self.ufoFormatVersionTuple.major
)
# gather data
infoData = {}
for attr in layerInfoVersion3ValueData.keys():
if hasattr(info, attr):
try:
value = getattr(info, attr)
except AttributeError:
raise GlifLibError(
"The supplied info object does not support getting a necessary attribute (%s)."
% attr
)
if value is None or (attr == "lib" and not value):
continue
infoData[attr] = value
if infoData:
# validate
if validateWrite:
infoData = validateLayerInfoVersion3Data(infoData)
# write file
self._writePlist(LAYERINFO_FILENAME, infoData)
elif self._havePreviousFile and self.fs.exists(LAYERINFO_FILENAME):
# data empty, remove existing file
self.fs.remove(LAYERINFO_FILENAME)
def getGLIF(self, glyphName):
"""
Get the raw GLIF text for a given glyph name. This only works
for GLIF files that are already on disk.
This method is useful in situations when the raw XML needs to be
read from a glyph set for a particular glyph before fully parsing
it into an object structure via the readGlyph method.
Raises KeyError if 'glyphName' is not in contents.plist, or
GlifLibError if the file associated with can't be found.
"""
fileName = self.contents[glyphName]
try:
return self.fs.readbytes(fileName)
except fs.errors.ResourceNotFound:
raise GlifLibError(
"The file '%s' associated with glyph '%s' in contents.plist "
"does not exist on %s" % (fileName, glyphName, self.fs)
)
def getGLIFModificationTime(self, glyphName):
"""
Returns the modification time for the GLIF file with 'glyphName', as
a floating point number giving the number of seconds since the epoch.
Return None if the associated file does not exist or the underlying
filesystem does not support getting modified times.
Raises KeyError if the glyphName is not in contents.plist.
"""
fileName = self.contents[glyphName]
return self.getFileModificationTime(fileName)
# reading/writing API
def readGlyph(self, glyphName, glyphObject=None, pointPen=None, validate=None):
"""
Read a .glif file for 'glyphName' from the glyph set. The
'glyphObject' argument can be any kind of object (even None);
the readGlyph() method will attempt to set the following
attributes on it:
width
the advance width of the glyph
height
the advance height of the glyph
unicodes
a list of unicode values for this glyph
note
a string
lib
a dictionary containing custom data
image
a dictionary containing image data
guidelines
a list of guideline data dictionaries
anchors
a list of anchor data dictionaries
All attributes are optional, in two ways:
1) An attribute *won't* be set if the .glif file doesn't
contain data for it. 'glyphObject' will have to deal
with default values itself.
2) If setting the attribute fails with an AttributeError
(for example if the 'glyphObject' attribute is read-
only), readGlyph() will not propagate that exception,
but ignore that attribute.
To retrieve outline information, you need to pass an object
conforming to the PointPen protocol as the 'pointPen' argument.
This argument may be None if you don't need the outline data.
readGlyph() will raise KeyError if the glyph is not present in
the glyph set.
``validate`` will validate the data, by default it is set to the
class's ``validateRead`` value, can be overridden.
"""
if validate is None:
validate = self._validateRead
text = self.getGLIF(glyphName)
try:
tree = _glifTreeFromString(text)
formatVersions = GLIFFormatVersion.supported_versions(
self.ufoFormatVersionTuple
)
_readGlyphFromTree(
tree,
glyphObject,
pointPen,
formatVersions=formatVersions,
validate=validate,
)
except GlifLibError as glifLibError:
# Re-raise with a note that gives extra context, describing where
# the error occurred.
fileName = self.contents[glyphName]
try:
glifLocation = f"'{self.fs.getsyspath(fileName)}'"
except fs.errors.NoSysPath:
# Network or in-memory FS may not map to a local path, so use
# the best string representation we have.
glifLocation = f"'{fileName}' from '{str(self.fs)}'"
glifLibError._add_note(
f"The issue is in glyph '{glyphName}', located in {glifLocation}."
)
raise
def writeGlyph(
self,
glyphName,
glyphObject=None,
drawPointsFunc=None,
formatVersion=None,
validate=None,
):
"""
Write a .glif file for 'glyphName' to the glyph set. The
'glyphObject' argument can be any kind of object (even None);
the writeGlyph() method will attempt to get the following
attributes from it:
width
the advance width of the glyph
height
the advance height of the glyph
unicodes
a list of unicode values for this glyph
note
a string
lib
a dictionary containing custom data
image
a dictionary containing image data
guidelines
a list of guideline data dictionaries
anchors
a list of anchor data dictionaries
All attributes are optional: if 'glyphObject' doesn't
have the attribute, it will simply be skipped.
To write outline data to the .glif file, writeGlyph() needs
a function (any callable object actually) that will take one
argument: an object that conforms to the PointPen protocol.
The function will be called by writeGlyph(); it has to call the
proper PointPen methods to transfer the outline to the .glif file.
The GLIF format version will be chosen based on the ufoFormatVersion
passed during the creation of this object. If a particular format
version is desired, it can be passed with the formatVersion argument.
The formatVersion argument accepts either a tuple of integers for
(major, minor), or a single integer for the major digit only (with
minor digit implied as 0).
An UnsupportedGLIFFormat exception is raised if the requested GLIF
formatVersion is not supported.
``validate`` will validate the data, by default it is set to the
class's ``validateWrite`` value, can be overridden.
"""
if formatVersion is None:
formatVersion = GLIFFormatVersion.default(self.ufoFormatVersionTuple)
else:
try:
formatVersion = GLIFFormatVersion(formatVersion)
except ValueError as e:
from fontTools.ufoLib.errors import UnsupportedGLIFFormat
raise UnsupportedGLIFFormat(
f"Unsupported GLIF format version: {formatVersion!r}"
) from e
if formatVersion not in GLIFFormatVersion.supported_versions(
self.ufoFormatVersionTuple
):
from fontTools.ufoLib.errors import UnsupportedGLIFFormat
raise UnsupportedGLIFFormat(
f"Unsupported GLIF format version ({formatVersion!s}) "
f"for UFO format version {self.ufoFormatVersionTuple!s}."
)
if validate is None:
validate = self._validateWrite
fileName = self.contents.get(glyphName)
if fileName is None:
if self._existingFileNames is None:
self._existingFileNames = {
fileName.lower() for fileName in self.contents.values()
}
fileName = self.glyphNameToFileName(glyphName, self._existingFileNames)
self.contents[glyphName] = fileName
self._existingFileNames.add(fileName.lower())
if self._reverseContents is not None:
self._reverseContents[fileName.lower()] = glyphName
data = _writeGlyphToBytes(
glyphName,
glyphObject,
drawPointsFunc,
formatVersion=formatVersion,
validate=validate,
)
if (
self._havePreviousFile
and self.fs.exists(fileName)
and data == self.fs.readbytes(fileName)
):
return
self.fs.writebytes(fileName, data)
def deleteGlyph(self, glyphName):
"""Permanently delete the glyph from the glyph set on disk. Will
raise KeyError if the glyph is not present in the glyph set.
"""
fileName = self.contents[glyphName]
self.fs.remove(fileName)
if self._existingFileNames is not None:
self._existingFileNames.remove(fileName.lower())
if self._reverseContents is not None:
del self._reverseContents[fileName.lower()]
del self.contents[glyphName]
# dict-like support
def keys(self):
return list(self.contents.keys())
def has_key(self, glyphName):
return glyphName in self.contents
__contains__ = has_key
def __len__(self):
return len(self.contents)
def __getitem__(self, glyphName):
if glyphName not in self.contents:
raise KeyError(glyphName)
return self.glyphClass(glyphName, self)
# quickly fetch unicode values
def getUnicodes(self, glyphNames=None):
"""
Return a dictionary that maps glyph names to lists containing
the unicode value[s] for that glyph, if any. This parses the .glif
files partially, so it is a lot faster than parsing all files completely.
By default this checks all glyphs, but a subset can be passed with glyphNames.
"""
unicodes = {}
if glyphNames is None:
glyphNames = self.contents.keys()
for glyphName in glyphNames:
text = self.getGLIF(glyphName)
unicodes[glyphName] = _fetchUnicodes(text)
return unicodes
def getComponentReferences(self, glyphNames=None):
"""
Return a dictionary that maps glyph names to lists containing the
base glyph name of components in the glyph. This parses the .glif
files partially, so it is a lot faster than parsing all files completely.
By default this checks all glyphs, but a subset can be passed with glyphNames.
"""
components = {}
if glyphNames is None:
glyphNames = self.contents.keys()
for glyphName in glyphNames:
text = self.getGLIF(glyphName)
components[glyphName] = _fetchComponentBases(text)
return components
def getImageReferences(self, glyphNames=None):
"""
Return a dictionary that maps glyph names to the file name of the image
referenced by the glyph. This parses the .glif files partially, so it is a
lot faster than parsing all files completely.
By default this checks all glyphs, but a subset can be passed with glyphNames.
"""
images = {}
if glyphNames is None:
glyphNames = self.contents.keys()
for glyphName in glyphNames:
text = self.getGLIF(glyphName)
images[glyphName] = _fetchImageFileName(text)
return images
def close(self):
if self._shouldClose:
self.fs.close()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, exc_tb):
self.close()
# -----------------------
# Glyph Name to File Name
# -----------------------
def glyphNameToFileName(glyphName, existingFileNames):
"""
Wrapper around the userNameToFileName function in filenames.py
Note that existingFileNames should be a set for large glyphsets
or performance will suffer.
"""
if existingFileNames is None:
existingFileNames = set()
return userNameToFileName(glyphName, existing=existingFileNames, suffix=".glif")
# -----------------------
# GLIF To and From String
# -----------------------
def readGlyphFromString(
aString,
glyphObject=None,
pointPen=None,
formatVersions=None,
validate=True,
):
"""
Read .glif data from a string into a glyph object.
The 'glyphObject' argument can be any kind of object (even None);
the readGlyphFromString() method will attempt to set the following
attributes on it:
width
the advance width of the glyph
height
the advance height of the glyph
unicodes
a list of unicode values for this glyph
note
a string
lib
a dictionary containing custom data
image
a dictionary containing image data
guidelines
a list of guideline data dictionaries
anchors
a list of anchor data dictionaries
All attributes are optional, in two ways:
1) An attribute *won't* be set if the .glif file doesn't
contain data for it. 'glyphObject' will have to deal
with default values itself.
2) If setting the attribute fails with an AttributeError
(for example if the 'glyphObject' attribute is read-
only), readGlyphFromString() will not propagate that
exception, but ignore that attribute.
To retrieve outline information, you need to pass an object
conforming to the PointPen protocol as the 'pointPen' argument.
This argument may be None if you don't need the outline data.
The formatVersions optional argument define the GLIF format versions
that are allowed to be read.
The type is Optional[Iterable[Tuple[int, int], int]]. It can contain
either integers (for the major versions to be allowed, with minor
digits defaulting to 0), or tuples of integers to specify both
(major, minor) versions.
By default when formatVersions is None all the GLIF format versions
currently defined are allowed to be read.
``validate`` will validate the read data. It is set to ``True`` by default.
"""
tree = _glifTreeFromString(aString)
if formatVersions is None:
validFormatVersions = GLIFFormatVersion.supported_versions()
else:
validFormatVersions, invalidFormatVersions = set(), set()
for v in formatVersions:
try:
formatVersion = GLIFFormatVersion(v)
except ValueError:
invalidFormatVersions.add(v)
else:
validFormatVersions.add(formatVersion)
if not validFormatVersions:
raise ValueError(
"None of the requested GLIF formatVersions are supported: "
f"{formatVersions!r}"
)
_readGlyphFromTree(
tree,
glyphObject,
pointPen,
formatVersions=validFormatVersions,
validate=validate,
)
def _writeGlyphToBytes(
glyphName,
glyphObject=None,
drawPointsFunc=None,
writer=None,
formatVersion=None,
validate=True,
):
"""Return .glif data for a glyph as a UTF-8 encoded bytes string."""
try:
formatVersion = GLIFFormatVersion(formatVersion)
except ValueError:
from fontTools.ufoLib.errors import UnsupportedGLIFFormat
raise UnsupportedGLIFFormat(
"Unsupported GLIF format version: {formatVersion!r}"
)
# start
if validate and not isinstance(glyphName, str):
raise GlifLibError("The glyph name is not properly formatted.")
if validate and len(glyphName) == 0:
raise GlifLibError("The glyph name is empty.")
glyphAttrs = OrderedDict(
[("name", glyphName), ("format", repr(formatVersion.major))]
)
if formatVersion.minor != 0:
glyphAttrs["formatMinor"] = repr(formatVersion.minor)
root = etree.Element("glyph", glyphAttrs)
identifiers = set()
# advance
_writeAdvance(glyphObject, root, validate)
# unicodes
if getattr(glyphObject, "unicodes", None):
_writeUnicodes(glyphObject, root, validate)
# note
if getattr(glyphObject, "note", None):
_writeNote(glyphObject, root, validate)
# image
if formatVersion.major >= 2 and getattr(glyphObject, "image", None):
_writeImage(glyphObject, root, validate)
# guidelines
if formatVersion.major >= 2 and getattr(glyphObject, "guidelines", None):
_writeGuidelines(glyphObject, root, identifiers, validate)
# anchors
anchors = getattr(glyphObject, "anchors", None)
if formatVersion.major >= 2 and anchors:
_writeAnchors(glyphObject, root, identifiers, validate)
# outline
if drawPointsFunc is not None:
outline = etree.SubElement(root, "outline")
pen = GLIFPointPen(outline, identifiers=identifiers, validate=validate)
drawPointsFunc(pen)
if formatVersion.major == 1 and anchors:
_writeAnchorsFormat1(pen, anchors, validate)
# prevent lxml from writing self-closing tags
if not len(outline):
outline.text = "\n "
# lib
if getattr(glyphObject, "lib", None):
_writeLib(glyphObject, root, validate)
# return the text
data = etree.tostring(
root, encoding="UTF-8", xml_declaration=True, pretty_print=True
)
return data
def writeGlyphToString(
glyphName,
glyphObject=None,
drawPointsFunc=None,
formatVersion=None,
validate=True,
):
"""
Return .glif data for a glyph as a string. The XML declaration's
encoding is always set to "UTF-8".
The 'glyphObject' argument can be any kind of object (even None);
the writeGlyphToString() method will attempt to get the following
attributes from it:
width
the advance width of the glyph
height
the advance height of the glyph
unicodes
a list of unicode values for this glyph
note
a string
lib
a dictionary containing custom data
image
a dictionary containing image data
guidelines
a list of guideline data dictionaries
anchors
a list of anchor data dictionaries
All attributes are optional: if 'glyphObject' doesn't
have the attribute, it will simply be skipped.
To write outline data to the .glif file, writeGlyphToString() needs
a function (any callable object actually) that will take one
argument: an object that conforms to the PointPen protocol.
The function will be called by writeGlyphToString(); it has to call the
proper PointPen methods to transfer the outline to the .glif file.
The GLIF format version can be specified with the formatVersion argument.
This accepts either a tuple of integers for (major, minor), or a single
integer for the major digit only (with minor digit implied as 0).
By default when formatVesion is None the latest GLIF format version will
be used; currently it's 2.0, which is equivalent to formatVersion=(2, 0).
An UnsupportedGLIFFormat exception is raised if the requested UFO
formatVersion is not supported.
``validate`` will validate the written data. It is set to ``True`` by default.
"""
data = _writeGlyphToBytes(
glyphName,
glyphObject=glyphObject,
drawPointsFunc=drawPointsFunc,
formatVersion=formatVersion,
validate=validate,
)
return data.decode("utf-8")
def _writeAdvance(glyphObject, element, validate):
width = getattr(glyphObject, "width", None)
if width is not None:
if validate and not isinstance(width, numberTypes):
raise GlifLibError("width attribute must be int or float")
if width == 0:
width = None
height = getattr(glyphObject, "height", None)
if height is not None:
if validate and not isinstance(height, numberTypes):
raise GlifLibError("height attribute must be int or float")
if height == 0:
height = None
if width is not None and height is not None:
etree.SubElement(
element,
"advance",
OrderedDict([("height", repr(height)), ("width", repr(width))]),
)
elif width is not None:
etree.SubElement(element, "advance", dict(width=repr(width)))
elif height is not None:
etree.SubElement(element, "advance", dict(height=repr(height)))
def _writeUnicodes(glyphObject, element, validate):
unicodes = getattr(glyphObject, "unicodes", None)
if validate and isinstance(unicodes, int):
unicodes = [unicodes]
seen = set()
for code in unicodes:
if validate and not isinstance(code, int):
raise GlifLibError("unicode values must be int")
if code in seen:
continue
seen.add(code)
hexCode = "%04X" % code
etree.SubElement(element, "unicode", dict(hex=hexCode))
def _writeNote(glyphObject, element, validate):
note = getattr(glyphObject, "note", None)
if validate and not isinstance(note, str):
raise GlifLibError("note attribute must be str")
note = note.strip()
note = "\n" + note + "\n"
etree.SubElement(element, "note").text = note
def _writeImage(glyphObject, element, validate):
image = getattr(glyphObject, "image", None)
if validate and not imageValidator(image):
raise GlifLibError(
"image attribute must be a dict or dict-like object with the proper structure."
)
attrs = OrderedDict([("fileName", image["fileName"])])
for attr, default in _transformationInfo:
value = image.get(attr, default)
if value != default:
attrs[attr] = repr(value)
color = image.get("color")
if color is not None:
attrs["color"] = color
etree.SubElement(element, "image", attrs)
def _writeGuidelines(glyphObject, element, identifiers, validate):
guidelines = getattr(glyphObject, "guidelines", [])
if validate and not guidelinesValidator(guidelines):
raise GlifLibError("guidelines attribute does not have the proper structure.")
for guideline in guidelines:
attrs = OrderedDict()
x = guideline.get("x")
if x is not None:
attrs["x"] = repr(x)
y = guideline.get("y")
if y is not None:
attrs["y"] = repr(y)
angle = guideline.get("angle")
if angle is not None:
attrs["angle"] = repr(angle)
name = guideline.get("name")
if name is not None:
attrs["name"] = name
color = guideline.get("color")
if color is not None:
attrs["color"] = color
identifier = guideline.get("identifier")
if identifier is not None:
if validate and identifier in identifiers:
raise GlifLibError("identifier used more than once: %s" % identifier)
attrs["identifier"] = identifier
identifiers.add(identifier)
etree.SubElement(element, "guideline", attrs)
def _writeAnchorsFormat1(pen, anchors, validate):
if validate and not anchorsValidator(anchors):
raise GlifLibError("anchors attribute does not have the proper structure.")
for anchor in anchors:
attrs = {}
x = anchor["x"]
attrs["x"] = repr(x)
y = anchor["y"]
attrs["y"] = repr(y)
name = anchor.get("name")
if name is not None:
attrs["name"] = name
pen.beginPath()
pen.addPoint((x, y), segmentType="move", name=name)
pen.endPath()
def _writeAnchors(glyphObject, element, identifiers, validate):
anchors = getattr(glyphObject, "anchors", [])
if validate and not anchorsValidator(anchors):
raise GlifLibError("anchors attribute does not have the proper structure.")
for anchor in anchors:
attrs = OrderedDict()
x = anchor["x"]
attrs["x"] = repr(x)
y = anchor["y"]
attrs["y"] = repr(y)
name = anchor.get("name")
if name is not None:
attrs["name"] = name
color = anchor.get("color")
if color is not None:
attrs["color"] = color
identifier = anchor.get("identifier")
if identifier is not None:
if validate and identifier in identifiers:
raise GlifLibError("identifier used more than once: %s" % identifier)
attrs["identifier"] = identifier
identifiers.add(identifier)
etree.SubElement(element, "anchor", attrs)
def _writeLib(glyphObject, element, validate):
lib = getattr(glyphObject, "lib", None)
if not lib:
# don't write empty lib
return
if validate:
valid, message = glyphLibValidator(lib)
if not valid:
raise GlifLibError(message)
if not isinstance(lib, dict):
lib = dict(lib)
# plist inside GLIF begins with 2 levels of indentation
e = plistlib.totree(lib, indent_level=2)
etree.SubElement(element, "lib").append(e)
# -----------------------
# layerinfo.plist Support
# -----------------------
layerInfoVersion3ValueData = {
"color": dict(type=str, valueValidator=colorValidator),
"lib": dict(type=dict, valueValidator=genericTypeValidator),
}
def validateLayerInfoVersion3ValueForAttribute(attr, value):
"""
This performs very basic validation of the value for attribute
following the UFO 3 fontinfo.plist specification. The results
of this should not be interpretted as *correct* for the font
that they are part of. This merely indicates that the value
is of the proper type and, where the specification defines
a set range of possible values for an attribute, that the
value is in the accepted range.
"""
if attr not in layerInfoVersion3ValueData:
return False
dataValidationDict = layerInfoVersion3ValueData[attr]
valueType = dataValidationDict.get("type")
validator = dataValidationDict.get("valueValidator")
valueOptions = dataValidationDict.get("valueOptions")
# have specific options for the validator
if valueOptions is not None:
isValidValue = validator(value, valueOptions)
# no specific options
else:
if validator == genericTypeValidator:
isValidValue = validator(value, valueType)
else:
isValidValue = validator(value)
return isValidValue
def validateLayerInfoVersion3Data(infoData):
"""
This performs very basic validation of the value for infoData
following the UFO 3 layerinfo.plist specification. The results
of this should not be interpretted as *correct* for the font
that they are part of. This merely indicates that the values
are of the proper type and, where the specification defines
a set range of possible values for an attribute, that the
value is in the accepted range.
"""
for attr, value in infoData.items():
if attr not in layerInfoVersion3ValueData:
raise GlifLibError("Unknown attribute %s." % attr)
isValidValue = validateLayerInfoVersion3ValueForAttribute(attr, value)
if not isValidValue:
raise GlifLibError(f"Invalid value for attribute {attr} ({value!r}).")
return infoData
# -----------------
# GLIF Tree Support
# -----------------
def _glifTreeFromFile(aFile):
if etree._have_lxml:
tree = etree.parse(aFile, parser=etree.XMLParser(remove_comments=True))
else:
tree = etree.parse(aFile)
root = tree.getroot()
if root.tag != "glyph":
raise GlifLibError("The GLIF is not properly formatted.")
if root.text and root.text.strip() != "":
raise GlifLibError("Invalid GLIF structure.")
return root
def _glifTreeFromString(aString):
data = tobytes(aString, encoding="utf-8")
try:
if etree._have_lxml:
root = etree.fromstring(data, parser=etree.XMLParser(remove_comments=True))
else:
root = etree.fromstring(data)
except Exception as etree_exception:
raise GlifLibError("GLIF contains invalid XML.") from etree_exception
if root.tag != "glyph":
raise GlifLibError("The GLIF is not properly formatted.")
if root.text and root.text.strip() != "":
raise GlifLibError("Invalid GLIF structure.")
return root
def _readGlyphFromTree(
tree,
glyphObject=None,
pointPen=None,
formatVersions=GLIFFormatVersion.supported_versions(),
validate=True,
):
# check the format version
formatVersionMajor = tree.get("format")
if validate and formatVersionMajor is None:
raise GlifLibError("Unspecified format version in GLIF.")
formatVersionMinor = tree.get("formatMinor", 0)
try:
formatVersion = GLIFFormatVersion(
(int(formatVersionMajor), int(formatVersionMinor))
)
except ValueError as e:
msg = "Unsupported GLIF format: %s.%s" % (
formatVersionMajor,
formatVersionMinor,
)
if validate:
from fontTools.ufoLib.errors import UnsupportedGLIFFormat
raise UnsupportedGLIFFormat(msg) from e
# warn but continue using the latest supported format
formatVersion = GLIFFormatVersion.default()
logger.warning(
"%s. Assuming the latest supported version (%s). "
"Some data may be skipped or parsed incorrectly.",
msg,
formatVersion,
)
if validate and formatVersion not in formatVersions:
raise GlifLibError(f"Forbidden GLIF format version: {formatVersion!s}")
try:
readGlyphFromTree = _READ_GLYPH_FROM_TREE_FUNCS[formatVersion]
except KeyError:
raise NotImplementedError(formatVersion)
readGlyphFromTree(
tree=tree,
glyphObject=glyphObject,
pointPen=pointPen,
validate=validate,
formatMinor=formatVersion.minor,
)
def _readGlyphFromTreeFormat1(
tree, glyphObject=None, pointPen=None, validate=None, **kwargs
):
# get the name
_readName(glyphObject, tree, validate)
# populate the sub elements
unicodes = []
haveSeenAdvance = haveSeenOutline = haveSeenLib = haveSeenNote = False
for element in tree:
if element.tag == "outline":
if validate:
if haveSeenOutline:
raise GlifLibError("The outline element occurs more than once.")
if element.attrib:
raise GlifLibError(
"The outline element contains unknown attributes."
)
if element.text and element.text.strip() != "":
raise GlifLibError("Invalid outline structure.")
haveSeenOutline = True
buildOutlineFormat1(glyphObject, pointPen, element, validate)
elif glyphObject is None:
continue
elif element.tag == "advance":
if validate and haveSeenAdvance:
raise GlifLibError("The advance element occurs more than once.")
haveSeenAdvance = True
_readAdvance(glyphObject, element)
elif element.tag == "unicode":
try:
v = element.get("hex")
v = int(v, 16)
if v not in unicodes:
unicodes.append(v)
except ValueError:
raise GlifLibError(
"Illegal value for hex attribute of unicode element."
)
elif element.tag == "note":
if validate and haveSeenNote:
raise GlifLibError("The note element occurs more than once.")
haveSeenNote = True
_readNote(glyphObject, element)
elif element.tag == "lib":
if validate and haveSeenLib:
raise GlifLibError("The lib element occurs more than once.")
haveSeenLib = True
_readLib(glyphObject, element, validate)
else:
raise GlifLibError("Unknown element in GLIF: %s" % element)
# set the collected unicodes
if unicodes:
_relaxedSetattr(glyphObject, "unicodes", unicodes)
def _readGlyphFromTreeFormat2(
tree, glyphObject=None, pointPen=None, validate=None, formatMinor=0
):
# get the name
_readName(glyphObject, tree, validate)
# populate the sub elements
unicodes = []
guidelines = []
anchors = []
haveSeenAdvance = haveSeenImage = haveSeenOutline = haveSeenLib = haveSeenNote = (
False
)
identifiers = set()
for element in tree:
if element.tag == "outline":
if validate:
if haveSeenOutline:
raise GlifLibError("The outline element occurs more than once.")
if element.attrib:
raise GlifLibError(
"The outline element contains unknown attributes."
)
if element.text and element.text.strip() != "":
raise GlifLibError("Invalid outline structure.")
haveSeenOutline = True
if pointPen is not None:
buildOutlineFormat2(
glyphObject, pointPen, element, identifiers, validate
)
elif glyphObject is None:
continue
elif element.tag == "advance":
if validate and haveSeenAdvance:
raise GlifLibError("The advance element occurs more than once.")
haveSeenAdvance = True
_readAdvance(glyphObject, element)
elif element.tag == "unicode":
try:
v = element.get("hex")
v = int(v, 16)
if v not in unicodes:
unicodes.append(v)
except ValueError:
raise GlifLibError(
"Illegal value for hex attribute of unicode element."
)
elif element.tag == "guideline":
if validate and len(element):
raise GlifLibError("Unknown children in guideline element.")
attrib = dict(element.attrib)
for attr in ("x", "y", "angle"):
if attr in attrib:
attrib[attr] = _number(attrib[attr])
guidelines.append(attrib)
elif element.tag == "anchor":
if validate and len(element):
raise GlifLibError("Unknown children in anchor element.")
attrib = dict(element.attrib)
for attr in ("x", "y"):
if attr in element.attrib:
attrib[attr] = _number(attrib[attr])
anchors.append(attrib)
elif element.tag == "image":
if validate:
if haveSeenImage:
raise GlifLibError("The image element occurs more than once.")
if len(element):
raise GlifLibError("Unknown children in image element.")
haveSeenImage = True
_readImage(glyphObject, element, validate)
elif element.tag == "note":
if validate and haveSeenNote:
raise GlifLibError("The note element occurs more than once.")
haveSeenNote = True
_readNote(glyphObject, element)
elif element.tag == "lib":
if validate and haveSeenLib:
raise GlifLibError("The lib element occurs more than once.")
haveSeenLib = True
_readLib(glyphObject, element, validate)
else:
raise GlifLibError("Unknown element in GLIF: %s" % element)
# set the collected unicodes
if unicodes:
_relaxedSetattr(glyphObject, "unicodes", unicodes)
# set the collected guidelines
if guidelines:
if validate and not guidelinesValidator(guidelines, identifiers):
raise GlifLibError("The guidelines are improperly formatted.")
_relaxedSetattr(glyphObject, "guidelines", guidelines)
# set the collected anchors
if anchors:
if validate and not anchorsValidator(anchors, identifiers):
raise GlifLibError("The anchors are improperly formatted.")
_relaxedSetattr(glyphObject, "anchors", anchors)
_READ_GLYPH_FROM_TREE_FUNCS = {
GLIFFormatVersion.FORMAT_1_0: _readGlyphFromTreeFormat1,
GLIFFormatVersion.FORMAT_2_0: _readGlyphFromTreeFormat2,
}
def _readName(glyphObject, root, validate):
glyphName = root.get("name")
if validate and not glyphName:
raise GlifLibError("Empty glyph name in GLIF.")
if glyphName and glyphObject is not None:
_relaxedSetattr(glyphObject, "name", glyphName)
def _readAdvance(glyphObject, advance):
width = _number(advance.get("width", 0))
_relaxedSetattr(glyphObject, "width", width)
height = _number(advance.get("height", 0))
_relaxedSetattr(glyphObject, "height", height)
def _readNote(glyphObject, note):
lines = note.text.split("\n")
note = "\n".join(line.strip() for line in lines if line.strip())
_relaxedSetattr(glyphObject, "note", note)
def _readLib(glyphObject, lib, validate):
assert len(lib) == 1
child = lib[0]
plist = plistlib.fromtree(child)
if validate:
valid, message = glyphLibValidator(plist)
if not valid:
raise GlifLibError(message)
_relaxedSetattr(glyphObject, "lib", plist)
def _readImage(glyphObject, image, validate):
imageData = dict(image.attrib)
for attr, default in _transformationInfo:
value = imageData.get(attr, default)
imageData[attr] = _number(value)
if validate and not imageValidator(imageData):
raise GlifLibError("The image element is not properly formatted.")
_relaxedSetattr(glyphObject, "image", imageData)
# ----------------
# GLIF to PointPen
# ----------------
contourAttributesFormat2 = {"identifier"}
componentAttributesFormat1 = {
"base",
"xScale",
"xyScale",
"yxScale",
"yScale",
"xOffset",
"yOffset",
}
componentAttributesFormat2 = componentAttributesFormat1 | {"identifier"}
pointAttributesFormat1 = {"x", "y", "type", "smooth", "name"}
pointAttributesFormat2 = pointAttributesFormat1 | {"identifier"}
pointSmoothOptions = {"no", "yes"}
pointTypeOptions = {"move", "line", "offcurve", "curve", "qcurve"}
# format 1
def buildOutlineFormat1(glyphObject, pen, outline, validate):
anchors = []
for element in outline:
if element.tag == "contour":
if len(element) == 1:
point = element[0]
if point.tag == "point":
anchor = _buildAnchorFormat1(point, validate)
if anchor is not None:
anchors.append(anchor)
continue
if pen is not None:
_buildOutlineContourFormat1(pen, element, validate)
elif element.tag == "component":
if pen is not None:
_buildOutlineComponentFormat1(pen, element, validate)
else:
raise GlifLibError("Unknown element in outline element: %s" % element)
if glyphObject is not None and anchors:
if validate and not anchorsValidator(anchors):
raise GlifLibError("GLIF 1 anchors are not properly formatted.")
_relaxedSetattr(glyphObject, "anchors", anchors)
def _buildAnchorFormat1(point, validate):
if point.get("type") != "move":
return None
name = point.get("name")
if name is None:
return None
x = point.get("x")
y = point.get("y")
if validate and x is None:
raise GlifLibError("Required x attribute is missing in point element.")
if validate and y is None:
raise GlifLibError("Required y attribute is missing in point element.")
x = _number(x)
y = _number(y)
anchor = dict(x=x, y=y, name=name)
return anchor
def _buildOutlineContourFormat1(pen, contour, validate):
if validate and contour.attrib:
raise GlifLibError("Unknown attributes in contour element.")
pen.beginPath()
if len(contour):
massaged = _validateAndMassagePointStructures(
contour,
pointAttributesFormat1,
openContourOffCurveLeniency=True,
validate=validate,
)
_buildOutlinePointsFormat1(pen, massaged)
pen.endPath()
def _buildOutlinePointsFormat1(pen, contour):
for point in contour:
x = point["x"]
y = point["y"]
segmentType = point["segmentType"]
smooth = point["smooth"]
name = point["name"]
pen.addPoint((x, y), segmentType=segmentType, smooth=smooth, name=name)
def _buildOutlineComponentFormat1(pen, component, validate):
if validate:
if len(component):
raise GlifLibError("Unknown child elements of component element.")
for attr in component.attrib.keys():
if attr not in componentAttributesFormat1:
raise GlifLibError("Unknown attribute in component element: %s" % attr)
baseGlyphName = component.get("base")
if validate and baseGlyphName is None:
raise GlifLibError("The base attribute is not defined in the component.")
transformation = []
for attr, default in _transformationInfo:
value = component.get(attr)
if value is None:
value = default
else:
value = _number(value)
transformation.append(value)
pen.addComponent(baseGlyphName, tuple(transformation))
# format 2
def buildOutlineFormat2(glyphObject, pen, outline, identifiers, validate):
for element in outline:
if element.tag == "contour":
_buildOutlineContourFormat2(pen, element, identifiers, validate)
elif element.tag == "component":
_buildOutlineComponentFormat2(pen, element, identifiers, validate)
else:
raise GlifLibError("Unknown element in outline element: %s" % element.tag)
def _buildOutlineContourFormat2(pen, contour, identifiers, validate):
if validate:
for attr in contour.attrib.keys():
if attr not in contourAttributesFormat2:
raise GlifLibError("Unknown attribute in contour element: %s" % attr)
identifier = contour.get("identifier")
if identifier is not None:
if validate:
if identifier in identifiers:
raise GlifLibError(
"The identifier %s is used more than once." % identifier
)
if not identifierValidator(identifier):
raise GlifLibError(
"The contour identifier %s is not valid." % identifier
)
identifiers.add(identifier)
try:
pen.beginPath(identifier=identifier)
except TypeError:
pen.beginPath()
warn(
"The beginPath method needs an identifier kwarg. The contour's identifier value has been discarded.",
DeprecationWarning,
)
if len(contour):
massaged = _validateAndMassagePointStructures(
contour, pointAttributesFormat2, validate=validate
)
_buildOutlinePointsFormat2(pen, massaged, identifiers, validate)
pen.endPath()
def _buildOutlinePointsFormat2(pen, contour, identifiers, validate):
for point in contour:
x = point["x"]
y = point["y"]
segmentType = point["segmentType"]
smooth = point["smooth"]
name = point["name"]
identifier = point.get("identifier")
if identifier is not None:
if validate:
if identifier in identifiers:
raise GlifLibError(
"The identifier %s is used more than once." % identifier
)
if not identifierValidator(identifier):
raise GlifLibError("The identifier %s is not valid." % identifier)
identifiers.add(identifier)
try:
pen.addPoint(
(x, y),
segmentType=segmentType,
smooth=smooth,
name=name,
identifier=identifier,
)
except TypeError:
pen.addPoint((x, y), segmentType=segmentType, smooth=smooth, name=name)
warn(
"The addPoint method needs an identifier kwarg. The point's identifier value has been discarded.",
DeprecationWarning,
)
def _buildOutlineComponentFormat2(pen, component, identifiers, validate):
if validate:
if len(component):
raise GlifLibError("Unknown child elements of component element.")
for attr in component.attrib.keys():
if attr not in componentAttributesFormat2:
raise GlifLibError("Unknown attribute in component element: %s" % attr)
baseGlyphName = component.get("base")
if validate and baseGlyphName is None:
raise GlifLibError("The base attribute is not defined in the component.")
transformation = []
for attr, default in _transformationInfo:
value = component.get(attr)
if value is None:
value = default
else:
value = _number(value)
transformation.append(value)
identifier = component.get("identifier")
if identifier is not None:
if validate:
if identifier in identifiers:
raise GlifLibError(
"The identifier %s is used more than once." % identifier
)
if validate and not identifierValidator(identifier):
raise GlifLibError("The identifier %s is not valid." % identifier)
identifiers.add(identifier)
try:
pen.addComponent(baseGlyphName, tuple(transformation), identifier=identifier)
except TypeError:
pen.addComponent(baseGlyphName, tuple(transformation))
warn(
"The addComponent method needs an identifier kwarg. The component's identifier value has been discarded.",
DeprecationWarning,
)
# all formats
def _validateAndMassagePointStructures(
contour, pointAttributes, openContourOffCurveLeniency=False, validate=True
):
if not len(contour):
return
# store some data for later validation
lastOnCurvePoint = None
haveOffCurvePoint = False
# validate and massage the individual point elements
massaged = []
for index, element in enumerate(contour):
# not <point>
if element.tag != "point":
raise GlifLibError(
"Unknown child element (%s) of contour element." % element.tag
)
point = dict(element.attrib)
massaged.append(point)
if validate:
# unknown attributes
for attr in point.keys():
if attr not in pointAttributes:
raise GlifLibError("Unknown attribute in point element: %s" % attr)
# search for unknown children
if len(element):
raise GlifLibError("Unknown child elements in point element.")
# x and y are required
for attr in ("x", "y"):
try:
point[attr] = _number(point[attr])
except KeyError as e:
raise GlifLibError(
f"Required {attr} attribute is missing in point element."
) from e
# segment type
pointType = point.pop("type", "offcurve")
if validate and pointType not in pointTypeOptions:
raise GlifLibError("Unknown point type: %s" % pointType)
if pointType == "offcurve":
pointType = None
point["segmentType"] = pointType
if pointType is None:
haveOffCurvePoint = True
else:
lastOnCurvePoint = index
# move can only occur as the first point
if validate and pointType == "move" and index != 0:
raise GlifLibError(
"A move point occurs after the first point in the contour."
)
# smooth is optional
smooth = point.get("smooth", "no")
if validate and smooth is not None:
if smooth not in pointSmoothOptions:
raise GlifLibError("Unknown point smooth value: %s" % smooth)
smooth = smooth == "yes"
point["smooth"] = smooth
# smooth can only be applied to curve and qcurve
if validate and smooth and pointType is None:
raise GlifLibError("smooth attribute set in an offcurve point.")
# name is optional
if "name" not in element.attrib:
point["name"] = None
if openContourOffCurveLeniency:
# remove offcurves that precede a move. this is technically illegal,
# but we let it slide because there are fonts out there in the wild like this.
if massaged[0]["segmentType"] == "move":
count = 0
for point in reversed(massaged):
if point["segmentType"] is None:
count += 1
else:
break
if count:
massaged = massaged[:-count]
# validate the off-curves in the segments
if validate and haveOffCurvePoint and lastOnCurvePoint is not None:
# we only care about how many offCurves there are before an onCurve
# filter out the trailing offCurves
offCurvesCount = len(massaged) - 1 - lastOnCurvePoint
for point in massaged:
segmentType = point["segmentType"]
if segmentType is None:
offCurvesCount += 1
else:
if offCurvesCount:
# move and line can't be preceded by off-curves
if segmentType == "move":
# this will have been filtered out already
raise GlifLibError("move can not have an offcurve.")
elif segmentType == "line":
raise GlifLibError("line can not have an offcurve.")
elif segmentType == "curve":
if offCurvesCount > 2:
raise GlifLibError("Too many offcurves defined for curve.")
elif segmentType == "qcurve":
pass
else:
# unknown segment type. it'll be caught later.
pass
offCurvesCount = 0
return massaged
# ---------------------
# Misc Helper Functions
# ---------------------
def _relaxedSetattr(object, attr, value):
try:
setattr(object, attr, value)
except AttributeError:
pass
def _number(s):
"""
Given a numeric string, return an integer or a float, whichever
the string indicates. _number("1") will return the integer 1,
_number("1.0") will return the float 1.0.
>>> _number("1")
1
>>> _number("1.0")
1.0
>>> _number("a") # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
GlifLibError: Could not convert a to an int or float.
"""
try:
n = int(s)
return n
except ValueError:
pass
try:
n = float(s)
return n
except ValueError:
raise GlifLibError("Could not convert %s to an int or float." % s)
# --------------------
# Rapid Value Fetching
# --------------------
# base
class _DoneParsing(Exception):
pass
class _BaseParser:
def __init__(self):
self._elementStack = []
def parse(self, text):
from xml.parsers.expat import ParserCreate
parser = ParserCreate()
parser.StartElementHandler = self.startElementHandler
parser.EndElementHandler = self.endElementHandler
parser.Parse(text)
def startElementHandler(self, name, attrs):
self._elementStack.append(name)
def endElementHandler(self, name):
other = self._elementStack.pop(-1)
assert other == name
# unicodes
def _fetchUnicodes(glif):
"""
Get a list of unicodes listed in glif.
"""
parser = _FetchUnicodesParser()
parser.parse(glif)
return parser.unicodes
class _FetchUnicodesParser(_BaseParser):
def __init__(self):
self.unicodes = []
super().__init__()
def startElementHandler(self, name, attrs):
if (
name == "unicode"
and self._elementStack
and self._elementStack[-1] == "glyph"
):
value = attrs.get("hex")
if value is not None:
try:
value = int(value, 16)
if value not in self.unicodes:
self.unicodes.append(value)
except ValueError:
pass
super().startElementHandler(name, attrs)
# image
def _fetchImageFileName(glif):
"""
The image file name (if any) from glif.
"""
parser = _FetchImageFileNameParser()
try:
parser.parse(glif)
except _DoneParsing:
pass
return parser.fileName
class _FetchImageFileNameParser(_BaseParser):
def __init__(self):
self.fileName = None
super().__init__()
def startElementHandler(self, name, attrs):
if name == "image" and self._elementStack and self._elementStack[-1] == "glyph":
self.fileName = attrs.get("fileName")
raise _DoneParsing
super().startElementHandler(name, attrs)
# component references
def _fetchComponentBases(glif):
"""
Get a list of component base glyphs listed in glif.
"""
parser = _FetchComponentBasesParser()
try:
parser.parse(glif)
except _DoneParsing:
pass
return list(parser.bases)
class _FetchComponentBasesParser(_BaseParser):
def __init__(self):
self.bases = []
super().__init__()
def startElementHandler(self, name, attrs):
if (
name == "component"
and self._elementStack
and self._elementStack[-1] == "outline"
):
base = attrs.get("base")
if base is not None:
self.bases.append(base)
super().startElementHandler(name, attrs)
def endElementHandler(self, name):
if name == "outline":
raise _DoneParsing
super().endElementHandler(name)
# --------------
# GLIF Point Pen
# --------------
_transformationInfo = [
# field name, default value
("xScale", 1),
("xyScale", 0),
("yxScale", 0),
("yScale", 1),
("xOffset", 0),
("yOffset", 0),
]
class GLIFPointPen(AbstractPointPen):
"""
Helper class using the PointPen protocol to write the <outline>
part of .glif files.
"""
def __init__(self, element, formatVersion=None, identifiers=None, validate=True):
if identifiers is None:
identifiers = set()
self.formatVersion = GLIFFormatVersion(formatVersion)
self.identifiers = identifiers
self.outline = element
self.contour = None
self.prevOffCurveCount = 0
self.prevPointTypes = []
self.validate = validate
def beginPath(self, identifier=None, **kwargs):
attrs = OrderedDict()
if identifier is not None and self.formatVersion.major >= 2:
if self.validate:
if identifier in self.identifiers:
raise GlifLibError(
"identifier used more than once: %s" % identifier
)
if not identifierValidator(identifier):
raise GlifLibError(
"identifier not formatted properly: %s" % identifier
)
attrs["identifier"] = identifier
self.identifiers.add(identifier)
self.contour = etree.SubElement(self.outline, "contour", attrs)
self.prevOffCurveCount = 0
def endPath(self):
if self.prevPointTypes and self.prevPointTypes[0] == "move":
if self.validate and self.prevPointTypes[-1] == "offcurve":
raise GlifLibError("open contour has loose offcurve point")
# prevent lxml from writing self-closing tags
if not len(self.contour):
self.contour.text = "\n "
self.contour = None
self.prevPointType = None
self.prevOffCurveCount = 0
self.prevPointTypes = []
def addPoint(
self, pt, segmentType=None, smooth=None, name=None, identifier=None, **kwargs
):
attrs = OrderedDict()
# coordinates
if pt is not None:
if self.validate:
for coord in pt:
if not isinstance(coord, numberTypes):
raise GlifLibError("coordinates must be int or float")
attrs["x"] = repr(pt[0])
attrs["y"] = repr(pt[1])
# segment type
if segmentType == "offcurve":
segmentType = None
if self.validate:
if segmentType == "move" and self.prevPointTypes:
raise GlifLibError(
"move occurs after a point has already been added to the contour."
)
if (
segmentType in ("move", "line")
and self.prevPointTypes
and self.prevPointTypes[-1] == "offcurve"
):
raise GlifLibError("offcurve occurs before %s point." % segmentType)
if segmentType == "curve" and self.prevOffCurveCount > 2:
raise GlifLibError("too many offcurve points before curve point.")
if segmentType is not None:
attrs["type"] = segmentType
else:
segmentType = "offcurve"
if segmentType == "offcurve":
self.prevOffCurveCount += 1
else:
self.prevOffCurveCount = 0
self.prevPointTypes.append(segmentType)
# smooth
if smooth:
if self.validate and segmentType == "offcurve":
raise GlifLibError("can't set smooth in an offcurve point.")
attrs["smooth"] = "yes"
# name
if name is not None:
attrs["name"] = name
# identifier
if identifier is not None and self.formatVersion.major >= 2:
if self.validate:
if identifier in self.identifiers:
raise GlifLibError(
"identifier used more than once: %s" % identifier
)
if not identifierValidator(identifier):
raise GlifLibError(
"identifier not formatted properly: %s" % identifier
)
attrs["identifier"] = identifier
self.identifiers.add(identifier)
etree.SubElement(self.contour, "point", attrs)
def addComponent(self, glyphName, transformation, identifier=None, **kwargs):
attrs = OrderedDict([("base", glyphName)])
for (attr, default), value in zip(_transformationInfo, transformation):
if self.validate and not isinstance(value, numberTypes):
raise GlifLibError("transformation values must be int or float")
if value != default:
attrs[attr] = repr(value)
if identifier is not None and self.formatVersion.major >= 2:
if self.validate:
if identifier in self.identifiers:
raise GlifLibError(
"identifier used more than once: %s" % identifier
)
if self.validate and not identifierValidator(identifier):
raise GlifLibError(
"identifier not formatted properly: %s" % identifier
)
attrs["identifier"] = identifier
self.identifiers.add(identifier)
etree.SubElement(self.outline, "component", attrs)
if __name__ == "__main__":
import doctest
doctest.testmod()
|