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

Conversation

typoman
Copy link

@typoman typoman commented Oct 24, 2022

No description provided.

@google-cla
Copy link

google-cla bot commented Oct 24, 2022

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@@ -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>

@@ -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.

@khaledhosny
Copy link
Collaborator

FWIW, Glyphs app supports multiple exit/entry pairs (e.g. exit_1/entry_1 etc.) and we want to eventually support this, so it should be kept in mind when designing API now so we do}t have to do breaking changes later or awkward workarounds.

@anthrotype
Copy link
Member

multiple exit/entry pairs (e.g. exit_1/entry_1 etc.)

how do these works?

@khaledhosny
Copy link
Collaborator

multiple exit/entry pairs (e.g. exit_1/entry_1 etc.)

how do these works?

I don’t know yet (that is the eventually bit). It is on my radar, but I don’t currently have a font that need this (I had one, but I painstakingly forced it to use a single exit/entry pair when I ported it from FontForge to Glyphs, before Glyphs app had this).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants