[outlineCompiler] Respecr keepGlyphOrder lib key when re-ordering space

This is mainly so that glyphsLib can potentially use it to map
GlyphsApp’s “Keep GlyphOrder” custom parameter.

Lib/ufo2ft/constants.py

@@ -25,6 +25,7 @@ class CFFOptimization(IntEnum):
 USE_PRODUCTION_NAMES = UFO2FT_PREFIX + "useProductionNames"
 GLYPHS_DONT_USE_PRODUCTION_NAMES = GLYPHS_PREFIX + "Don't use Production Names"
 KEEP_GLYPH_NAMES = UFO2FT_PREFIX + "keepGlyphNames"
+KEEP_GLYPH_ORDER_KEY = UFO2FT_PREFIX + "keepGlyphOrder"
 
 COLOR_LAYERS_KEY = UFO2FT_PREFIX + "colorLayers"
 COLOR_PALETTES_KEY = UFO2FT_PREFIX + "colorPalettes"

Lib/ufo2ft/featureWriters/baseFeatureWriter.py

@@ -315,7 +315,7 @@ def getOrderedGlyphSet(self):
             font,
             skipExportGlyphs=set(font.lib.get("public.skipExportGlyphs", [])),
         )
-        glyphOrder = makeOfficialGlyphOrder(glyphSet, font.glyphOrder)
+        glyphOrder = makeOfficialGlyphOrder(glyphSet, font.glyphOrder, font)
         return OrderedDict((gn, glyphSet[gn]) for gn in glyphOrder)
 
     def compileGSUB(self):

Lib/ufo2ft/outlineCompiler.py

@@ -307,7 +307,7 @@ def makeOfficialGlyphOrder(self, glyphOrder):
         may override this method to handle the order creation
         in a different way if desired.
         """
-        return makeOfficialGlyphOrder(self.allGlyphs, glyphOrder)
+        return makeOfficialGlyphOrder(self.allGlyphs, glyphOrder, self.ufo)
 
     # --------------
     # Table Builders

Lib/ufo2ft/util.py

@@ -18,14 +18,18 @@
 from fontTools.pens.reverseContourPen import ReverseContourPen
 from fontTools.pens.transformPen import TransformPen
 
-from ufo2ft.constants import OPENTYPE_CATEGORIES_KEY, UNICODE_SCRIPT_ALIASES
+from ufo2ft.constants import (
+    KEEP_GLYPH_ORDER_KEY,
+    OPENTYPE_CATEGORIES_KEY,
+    UNICODE_SCRIPT_ALIASES,
+)
 from ufo2ft.errors import InvalidDesignSpaceData, InvalidFontData
 from ufo2ft.fontInfoData import getAttrWithFallback
 
 logger = logging.getLogger(__name__)
 
 
-def makeOfficialGlyphOrder(font, glyphOrder=None):
+def makeOfficialGlyphOrder(font, glyphOrder=None, ufo=None):
     """Make the final glyph order for 'font'.
 
     If glyphOrder is None, try getting the font.glyphOrder list.
@@ -34,14 +38,16 @@ def makeOfficialGlyphOrder(font, glyphOrder=None):
     If ".notdef" glyph is present in the font, force this to always be
     the first glyph (at index 0).
     """
+    if ufo is None:
+        ufo = font
     if glyphOrder is None:
         glyphOrder = getattr(font, "glyphOrder", ())
     names = set(font.keys())
     order = []
     if ".notdef" in names:
         names.remove(".notdef")
         order.append(".notdef")
-    if "space" in names:
+    if "space" in names and not ufo.lib.get(KEEP_GLYPH_ORDER_KEY, False):
         names.remove("space")
         order.append("space")
     for name in glyphOrder:

tests/outlineCompiler_test.py

@@ -21,6 +21,7 @@
     GLYPHS_MATH_CONSTANTS_KEY,
     GLYPHS_MATH_EXTENDED_SHAPE_KEY,
     GLYPHS_MATH_VARIANTS_KEY,
+    KEEP_GLYPH_ORDER_KEY,
     OPENTYPE_POST_UNDERLINE_POSITION_KEY,
     SPARSE_OTF_MASTER_TABLES,
     SPARSE_TTF_MASTER_TABLES,
@@ -761,6 +762,34 @@ def test_compile_strange_glyph_order(self, quadufo):
         compiler.compile()
         assert compiler.otf.getGlyphOrder() == EXPECTED_ORDER
 
+    def test_compile_keep_glyph_order(self, quadufo):
+        """Move space and .notdef to end of glyph ids
+        ufo2ft always space second, unless KEEP_GLYPH_ORDER_KEY
+        is True.
+        """
+        NEW_ORDER = ["b", "a", "c", "d", "space", ".notdef"]
+        EXPECTED_ORDER = [
+            ".notdef",
+            "b",
+            "a",
+            "c",
+            "d",
+            "space",
+            "e",
+            "f",
+            "g",
+            "h",
+            "i",
+            "j",
+            "k",
+            "l",
+        ]
+        quadufo.lib["public.glyphOrder"] = NEW_ORDER
+        quadufo.lib[KEEP_GLYPH_ORDER_KEY] = True
+        compiler = OutlineTTFCompiler(quadufo)
+        compiler.compile()
+        assert compiler.otf.getGlyphOrder() == EXPECTED_ORDER
+
 
 class NamesTest:
     @pytest.mark.parametrize(