Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it possible to have custom name for anchors in cursFeatureWriter. #672

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Lib/ufo2ft/featureWriters/cursFeatureWriter.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ class CursFeatureWriter(BaseFeatureWriter):

tableTag = "GPOS"
features = frozenset(["curs"])
entry = "entry"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe better to have an options dict so you don't need to subclass to modify entry/exit anchor names, you simply pass the desired names to the default constructor as keyword arguments:

class CursFeatureWriter(BaseFeatureWriter):
    ...
    options = dict(entry="entry", exit="exit")    

Then you make an instance of CursFeatureWriter(entry="foobar", exit="baz")

KernFeatureWriter has a similar thing for ignoreMarks:

options = dict(ignoreMarks=True, quantization=1)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parent BaseFeatureWriters automatically turns that options dict attribute of the class into a self.options namespace, see

options = dict(self.__class__.options)
for k in kwargs:
if k not in options:
raise TypeError("unsupported keyword argument: %r" % k)
options[k] = kwargs[k]
self.options = SimpleNamespace(**options)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an additional advantange of using options dict, is that the custom entry/exit anchor names can be encoded as options directly in the featureWriters lib key.

<dict>
    <key>com.github.googlei18n.ufo2ft.featureWriters</key>
    <array>
        <dict>
            <key>class</key>
            <string>CursFeatureWriter</string>
            <key>options</key>
            <dict>
                <key>entry</key>
                <string>foobar</string>
                <key>exit</key>
                <string>baz</string>
            </dict>
        </dict>
    </array>
</dict>

exit = "exit"

def _makeCursiveFeature(self):
cmap = self.makeUnicodeToGlyphNameMapping()
Expand Down Expand Up @@ -97,9 +99,9 @@ def _makeCursiveStatements(self, glyphs):
for anchor in glyph.anchors:
if entryAnchor and exitAnchor:
break
if anchor.name == "entry":
if anchor.name == self.entry:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you use the options dict like I suggested above, you can then use these as self.options.entry or self.options.exit etc.

entryAnchor = ast.Anchor(x=otRound(anchor.x), y=otRound(anchor.y))
elif anchor.name == "exit":
elif anchor.name == self.exit:
exitAnchor = ast.Anchor(x=otRound(anchor.x), y=otRound(anchor.y))

# A glyph can have only one of the cursive anchors (e.g. if it
Expand Down