summaryrefslogtreecommitdiff
path: root/misc/kernsample.py
blob: cc36fbe17a6f800bca129fcdb7fc2f89973968d1 (plain)
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
#!/usr/bin/env python
# encoding: utf8
from __future__ import print_function
import os, sys, plistlib
from collections import OrderedDict
from argparse import ArgumentParser
from robofab.objects.objectsRF import OpenFont


def mapGroups(groups):  # => { glyphname => set(groupname, ...), ... }
  m = OrderedDict()
  for groupname, glyphnames in groups.iteritems():
    for glyphname in glyphnames:
      m.setdefault(glyphname, set()).add(groupname)
  return m


def _addRightnames(groups, kerning, leftname, rightnames, includeAll=True):
  if leftname in kerning:
    for rightname in kerning[leftname]:
      if rightname[0] == '@':
        for rightname2 in groups[rightname]:
          rightnames.add(rightname2)
          if not includeAll:
            # TODO: in this case, pick the one rightname that has the highest
            # ranking in glyphorder
            break
      else:
        rightnames.add(rightname)


def fmtGlyphname(glyphname, glyph=None):
  if glyph is not None and len(glyphname) == 1 and ord(glyphname[0]) == glyph.unicode:
    # literal, e.g. "A"
    return glyphname
  else:
    # named, e.g. "\Omega"
    return '/' + glyphname + ' '


def samplesForGlyphname(font, groups, groupmap, kerning, glyphname, args):
  leftGlyph = font[glyphname]  # verify it's present
  rightnames = set()

  _addRightnames(groups, kerning, glyphname, rightnames, includeAll=args.includeAllInGroup)

  if glyphname in groupmap:
    for groupname in groupmap[glyphname]:
      _addRightnames(groups, kerning, groupname, rightnames, includeAll=args.includeAllInGroup)

  rightnames = sorted(rightnames)

  out = []
  if args.formatAsUnicode:
    left = '\\u%04X' % leftGlyph.unicode
    for rightname in rightnames:
      if rightname in font:
        rightGlyph = font[rightname]
        if rightGlyph.unicode is not None:
          out.append('%s\\u%04X' % (left, rightGlyph.unicode))
  else:
    left = fmtGlyphname(glyphname, leftGlyph)
    suffix_uc = ''
    suffix_lc = ''
    if len(args.suffix) > 0:
      s = unicode(args.suffix)
      if s[0].isupper():
        suffix_uc = args.suffix
        suffix_lc = args.suffix.lower()
      else:
        suffix_uc = args.suffix.upper()
        suffix_lc = args.suffix
    for rightname in rightnames:
      if rightname in font:
        rightGlyph = None
        if len(rightname) == 1:
          rightGlyph = font[rightname]
        suffix = suffix_lc
        if unicode(rightname[0]).isupper():
          suffix = suffix_uc
        out.append('%s%s%s' % (left, fmtGlyphname(rightname, rightGlyph), suffix))

  print(' '.join(out))




def main():
  argparser = ArgumentParser(
    description='Generate kerning samples by providing the left-hand side glyph')

  argparser.add_argument(
    '-u', dest='formatAsUnicode', action='store_const', const=True, default=False,
    help='Format output as unicode escape sequences instead of glyphnames. ' +
         'E.g. "\\u2126" instead of "\\Omega"')

  argparser.add_argument(
    '-suffix', dest='suffix', metavar='<text>', type=str,
    help='Text to append after each pair')

  argparser.add_argument(
    '-all-in-groups', dest='includeAllInGroup',
    action='store_const', const=True, default=False,
    help='Include all glyphs for groups rather than just the first glyph listed.')

  argparser.add_argument(
    'fontPath', metavar='<ufofile>', type=str, help='UFO font source')

  argparser.add_argument(
    'glyphnames', metavar='<glyphname>', type=str, nargs='+',
    help='Name of glyphs to generate samples for. '+
         'You can also provide a Unicode code point using the syntax "U+XXXX"')

  args = argparser.parse_args()
  dryRun = args.dryRun

  font = OpenFont(args.fontPath)

  groupsFilename = os.path.join(args.fontPath, 'groups.plist')
  kerningFilename = os.path.join(args.fontPath, 'kerning.plist')

  groups = plistlib.readPlist(groupsFilename)   # { groupName => [glyphName] }
  kerning = plistlib.readPlist(kerningFilename) # { leftName => {rightName => kernVal} }
  groupmap = mapGroups(groups)

  # expand any unicode codepoints
  glyphnames = []
  for glyphname in args.glyphnames:
    if len(glyphname) > 2 and glyphname[:2] == 'U+':
      cp = int(glyphname[2:], 16)
      ucmap = font.getCharacterMapping()  # { 2126: ['Omega', ...], ...}
      for glyphname2 in ucmap[cp]:
        glyphnames.append(glyphname2)
    else:
      glyphnames.append(glyphname)

  for glyphname in glyphnames:
    samplesForGlyphname(font, groups, groupmap, kerning, glyphname, args)


main()