"""" A library for importing .ufo files and their descendants. Refer to http://unifiedfontobject.com for the UFO specification. The UFOReader and UFOWriter classes support versions 1 and 2 of the specification. Up and down conversion functions are also supplied in this library. These conversion functions are only necessary if conversion without loading the UFO data into a set of objects is desired. These functions are: convertUFOFormatVersion1ToFormatVersion2 convertUFOFormatVersion2ToFormatVersion1 Two sets that list the font info attribute names for the two fontinfo.plist formats are available for external use. These are: fontInfoAttributesVersion1 fontInfoAttributesVersion2 A set listing the fontinfo.plist attributes that were deprecated in version 2 is available for external use: deprecatedFontInfoAttributesVersion2 A function, validateFontInfoVersion2ValueForAttribute, that does some basic validation on values for a fontinfo.plist value is available for external use. Two value conversion functions are availble for converting fontinfo.plist values between the possible format versions. convertFontInfoValueForAttributeFromVersion1ToVersion2 convertFontInfoValueForAttributeFromVersion2ToVersion1 """ import os import shutil from cStringIO import StringIO import calendar import codecs from copy import deepcopy from robofab.plistlib import readPlist, writePlist from robofab.glifLib import GlyphSet, READ_MODE, WRITE_MODE try: set except NameError: from sets import Set as set __all__ = [ "makeUFOPath" "UFOLibError", "UFOReader", "UFOWriter", "convertUFOFormatVersion1ToFormatVersion2", "convertUFOFormatVersion2ToFormatVersion1", "fontInfoAttributesVersion1", "fontInfoAttributesVersion2", "deprecatedFontInfoAttributesVersion2", "validateFontInfoVersion2ValueForAttribute", "convertFontInfoValueForAttributeFromVersion1ToVersion2", "convertFontInfoValueForAttributeFromVersion2ToVersion1" ] class UFOLibError(Exception): pass # ---------- # File Names # ---------- DEFAULT_GLYPHS_DIRNAME = "glyphs" DATA_DIRNAME = "data" IMAGES_DIRNAME = "images" METAINFO_FILENAME = "metainfo.plist" FONTINFO_FILENAME = "fontinfo.plist" LIB_FILENAME = "lib.plist" GROUPS_FILENAME = "groups.plist" KERNING_FILENAME = "kerning.plist" FEATURES_FILENAME = "features.fea" LAYERCONTENTS_FILENAME = "layercontents.plist" LAYERINFO_FILENAME = "layerinfo.plist" supportedUFOFormatVersions = [1, 2, 3] # --------------------------- # Format Conversion Functions # --------------------------- def convertUFOFormatVersion1ToFormatVersion2(inPath, outPath=None): """ Function for converting a version format 1 UFO to version format 2. inPath should be a path to a UFO. outPath is the path where the new UFO should be written. If outPath is not given, the inPath will be used and, therefore, the UFO will be converted in place. Otherwise, if outPath is specified, nothing must exist at that path. """ if outPath is None: outPath = inPath if inPath != outPath and os.path.exists(outPath): raise UFOLibError("A file already exists at %s." % outPath) # use a reader for loading most of the data reader = UFOReader(inPath) if reader.formatVersion == 2: raise UFOLibError("The UFO at %s is already format version 2." % inPath) groups = reader.readGroups() kerning = reader.readKerning() libData = reader.readLib() # read the info data manually and convert infoPath = os.path.join(inPath, FONTINFO_FILENAME) if not os.path.exists(infoPath): infoData = {} else: infoData = readPlist(infoPath) infoData = _convertFontInfoDataVersion1ToVersion2(infoData) # if the paths are the same, only need to change the # fontinfo and meta info files. infoPath = os.path.join(outPath, FONTINFO_FILENAME) if inPath == outPath: metaInfoPath = os.path.join(inPath, METAINFO_FILENAME) metaInfo = dict( creator="org.robofab.ufoLib", formatVersion=2 ) writePlistAtomically(metaInfo, metaInfoPath) writePlistAtomically(infoData, infoPath) # otherwise write everything. else: writer = UFOWriter(outPath, formatVersion=2) writer.writeGroups(groups) writer.writeKerning(kerning) writer.writeLib(libData) # write the info manually writePlistAtomically(infoData, infoPath) # copy the glyph tree inGlyphs = os.path.join(inPath, DEFAULT_GLYPHS_DIRNAME) outGlyphs = os.path.join(outPath, DEFAULT_GLYPHS_DIRNAME) if os.path.exists(inGlyphs): shutil.copytree(inGlyphs, outGlyphs) def convertUFOFormatVersion2ToFormatVersion1(inPath, outPath=None): """ Function for converting a version format 2 UFO to version format 1. inPath should be a path to a UFO. outPath is the path where the new UFO should be written. If outPath is not given, the inPath will be used and, therefore, the UFO will be converted in place. Otherwise, if outPath is specified, nothing must exist at that path. """ if outPath is None: outPath = inPath if inPath != outPath and os.path.exists(outPath): raise UFOLibError("A file already exists at %s." % outPath) # use a reader for loading most of the data reader = UFOReader(inPath) if reader.formatVersion == 1: raise UFOLibError("The UFO at %s is already format version 1." % inPath) groups = reader.readGroups() kerning = reader.readKerning() libData = reader.readLib() # read the info data manually and convert infoPath = os.path.join(inPath, FONTINFO_FILENAME) if not os.path.exists(infoPath): infoData = {} else: infoData = readPlist(infoPath) infoData = _convertFontInfoDataVersion2ToVersion1(infoData) # if the paths are the same, only need to change the # fontinfo, metainfo and feature files. infoPath = os.path.join(outPath, FONTINFO_FILENAME) if inPath == outPath: metaInfoPath = os.path.join(inPath, METAINFO_FILENAME) metaInfo = dict( creator="org.robofab.ufoLib", formatVersion=1 ) writePlistAtomically(metaInfo, metaInfoPath) writePlistAtomically(infoData, infoPath) featuresPath = os.path.join(inPath, FEATURES_FILENAME) if os.path.exists(featuresPath): os.remove(featuresPath) # otherwise write everything. else: writer = UFOWriter(outPath, formatVersion=1) writer.writeGroups(groups) writer.writeKerning(kerning) writer.writeLib(libData) # write the info manually writePlistAtomically(infoData, infoPath) # copy the glyph tree inGlyphs = os.path.join(inPath, DEFAULT_GLYPHS_DIRNAME) outGlyphs = os.path.join(outPath, DEFAULT_GLYPHS_DIRNAME) if os.path.exists(inGlyphs): shutil.copytree(inGlyphs, outGlyphs) # ---------- # UFO Reader # ---------- class UFOReader(object): """Read the various components of the .ufo.""" def __init__(self, path): self._path = path self.readMetaInfo() # properties def _get_formatVersion(self): return self._formatVersion formatVersion = property(_get_formatVersion, doc="The format version of the UFO. This is determined by reading metainfo.plist during __init__.") # support methods def _checkForFile(self, path): if not os.path.exists(path): return False else: return True def readBytesFromPath(self, path, encoding=None): """ Returns the bytes in the file at the given path. The path must be relative to the UFO path. Returns None if the file does not exist. An encoding may be passed if needed. """ path = os.path.join(self._path, path) if not self._checkForFile(path): return None f = codecs.open(path, READ_MODE, encoding=encoding) data = f.read() f.close() return data def getReadFileForPath(self, path, encoding=None): """ Returns a file (or file-like) object for the file at the given path. The path must be relative to the UFO path. Returns None if the file does not exist. An encoding may be passed if needed. Note: The caller is responsible for closing the open file. """ path = os.path.join(self._path, path) if not self._checkForFile(path): return None f = codecs.open(path, READ_MODE, encoding=encoding) return f # metainfo.plist def readMetaInfo(self): """ Read metainfo.plist. Only used for internal operations. """ path = os.path.join(self._path, METAINFO_FILENAME) if not self._checkForFile(path): raise UFOLibError("metainfo.plist is missing in %s. This file is required." % self._path) # should there be a blind try/except with a UFOLibError # raised in except here (and elsewhere)? It would be nice to # provide external callers with a single exception to catch. data = readPlist(path) formatVersion = data["formatVersion"] if formatVersion not in supportedUFOFormatVersions: raise UFOLibError("Unsupported UFO format (%d) in %s." % (formatVersion, self._path)) self._formatVersion = formatVersion # groups.plist def readGroups(self): """ Read groups.plist. Returns a dict. """ path = os.path.join(self._path, GROUPS_FILENAME) if not self._checkForFile(path): return {} return readPlist(path) # fontinfo.plist def readInfo(self, info): """ Read fontinfo.plist. It requires an object that allows setting attributes with names that follow the fontinfo.plist version 2 specification. This will write the attributes defined in the file into the object. """ # load the file and return if there is no file path = os.path.join(self._path, FONTINFO_FILENAME) if not self._checkForFile(path): return infoDict = readPlist(path) infoDataToSet = {} # version 1 if self._formatVersion == 1: for attr in fontInfoAttributesVersion1: value = infoDict.get(attr) if value is not None: infoDataToSet[attr] = value infoDataToSet = _convertFontInfoDataVersion1ToVersion2(infoDataToSet) # version 2 elif self._formatVersion == 2: for attr, dataValidationDict in _fontInfoAttributesVersion2ValueData.items(): value = infoDict.get(attr) if value is None: continue infoDataToSet[attr] = value # version 3 elif self._formatVersion == 3: for attr, dataValidationDict in _fontInfoAttributesVersion3ValueData.items(): value = infoDict.get(attr) if value is None: continue infoDataToSet[attr] = value # unsupported version else: raise NotImplementedError # validate data if self._formatVersion < 3: infoDataToSet = _validateInfoVersion2Data(infoDataToSet) elif self._formatVersion == 3: infoDataToSet = _validateInfoVersion3Data(infoDataToSet) # populate the object for attr, value in infoDataToSet.items(): try: setattr(info, attr, value) except AttributeError: raise UFOLibError("The supplied info object does not support setting a necessary attribute (%s)." % attr) # kerning.plist def readKerning(self): """ Read kerning.plist. Returns a dict. """ path = os.path.join(self._path, KERNING_FILENAME) if not self._checkForFile(path): return {} kerningNested = readPlist(path) kerning = {} for left in kerningNested: for right in kerningNested[left]: value = kerningNested[left][right] kerning[left, right] = value return kerning # lib.plist def readLib(self): """ Read lib.plist. Returns a dict. """ path = os.path.join(self._path, LIB_FILENAME) if not self._checkForFile(path): return {} return readPlist(path) # features.fea def readFeatures(self): """ Read features.fea. Returns a string. """ path = os.path.join(self._path, FEATURES_FILENAME) if not self._checkForFile(path): return "" f = open(path, READ_MODE) text = f.read() f.close() return text # glyph sets & layers def _readLayerContents(self): """ Private utility for reading layercontents.plist. """ path = os.path.join(self._path, LAYERCONTENTS_FILENAME) # XXX the spec does not address if layercontents.plist is required if # the only layer is the default layer. if not self._checkForFile(path): return [] return readPlist(path) def getLayerNames(self): """ Get the ordered layer names from layercontents.plist. """ layerContents = self._readLayerContents() layerNames = [layerName for layerName, directoryName in layerContents] return layerNames def getDefaultLayerName(self): """ Get the default layer name from layercontents.plist. """ # XXX the default glyphs layer name is not defined in the spec yet. # public.foreground seems like the logical name but it needs to be discussed. layerContents = self._readLayerContents() for layerName, layerDirectory in layerContents: if layerDirectory == DEFAULT_DEFAULT_GLYPHS_DIRNAME: return layerName # The default layer is not defined in the UFO. # XXX Should this error be raised when layercontents.plist is first read? raise UFOLibError("The default layer is not defined in layercontents.plist.") def getGlyphSet(self, layerName=None): """ Return the GlyphSet associated with the glyphs directory mapped to layerName in the UFO. If layerName is not provided, the name retrieved with getDefaultLayerName will be used. """ if layerName is None: layerName = self.getDefaultLayerName() directory = None layerContents = self._readLayerContents() for storedLayerName, storedLayerDirectory in layerContents: if layerName == storedLayerName: directory = storedLayerDirectory break if directory is None: raise UFOLibError("No glyphs directory is mapped to \"%s\"." % layerName) glyphsPath = os.path.join(self._path, directory) return GlyphSet(glyphsPath) def getCharacterMapping(self): """ Return a dictionary that maps unicode values (ints) to lists of glyph names. """ glyphsPath = os.path.join(self._path, DEFAULT_GLYPHS_DIRNAME) glyphSet = GlyphSet(glyphsPath) allUnicodes = glyphSet.getUnicodes() cmap = {} for glyphName, unicodes in allUnicodes.iteritems(): for code in unicodes: if code in cmap: cmap[code].append(glyphName) else: cmap[code] = [glyphName] return cmap # /data def getDataDirectoryListing(self, maxDepth=100): """ Returns a list of all files and directories in the data directory. The returned paths will be relative to the UFO. This will not list directory names, only file names. Thus, empty directories will be skipped. The maxDepth argument sets the maximum number of sub-directories that are allowed. """ path = os.path.join(self._path, DATA_DIRNAME) if not self._checkForFile(path): return [] listing = self._getDirectoryListing(path, maxDepth=maxDepth) return listing def _getDirectoryListing(self, path, depth=0, maxDepth=100): if depth > maxDepth: raise UFOLibError("Maximum recusion depth reached.") result = [] for fileName in os.listdir(path): p = os.path.join(path, fileName) if os.path.isdir(p): result += self._getDirectoryListing(p, depth=depth+1, maxDepth=maxDepth) else: p = os.path.relpath(p, self._path) result.append(p) return result # ---------- # UFO Writer # ---------- class UFOWriter(object): """Write the various components of the .ufo.""" def __init__(self, path, formatVersion=3, fileCreator="org.robofab.ufoLib"): if formatVersion not in supportedUFOFormatVersions: raise UFOLibError("Unsupported UFO format (%d)." % formatVersion) self._path = path self._formatVersion = formatVersion self._fileCreator = fileCreator self._writeMetaInfo() # handle down conversion if formatVersion < 3: # remove all glyph sets except the default for fileName in os.listdir(path): if fileName.startswith("glyphs."): p = os.path.join(path, fileName) self._removePath(p) # remove layercontents.plist p = os.path.join(path, LAYERCONTENTS_FILENAME) self._removePath(p) # remove glyphs/layerinfo.plist # XXX should glifLib handle this one? p = os.path.join(path, DEFAULT_GLYPHS_DIRNAME, LAYERINFO_FILENAME) self._removePath(p) # remove /images p = os.path.join(path, IMAGES_DIRNAME) self._removePath(p) # remove /data p = os.path.join(path, DATA_DIRNAME) self._removePath(p) if formatVersion < 2: # remove features.fea p = os.path.join(path, FEATURES_FILENAME) self._removePath(p) ## read the existing layer contents #if formatVersion >= 3: # p = os.path.join(layercontents) # properties def _get_formatVersion(self): return self._formatVersion formatVersion = property(_get_formatVersion, doc="The format version of the UFO. This is set into metainfo.plist during __init__.") def _get_fileCreator(self): return self._fileCreator fileCreator = property(_get_fileCreator, doc="The file creator of the UFO. This is set into metainfo.plist during __init__.") # support methods def _removePath(self, path): if os.path.exists(path): if os.path.isdir(path): shutil.rmtree(path) else: os.remove(path) def _makeDirectory(self, subDirectory=None): path = self._path if subDirectory: path = os.path.join(self._path, subDirectory) if not os.path.exists(path): os.makedirs(path) return path def _buildDirectoryTree(self, path): directory, fileName = os.path.split(path) directoryTree = [] while directory: directory, d = os.path.split(directory) directoryTree.append(d) directoryTree.reverse() built = "" for d in directoryTree: d = os.path.join(built, d) p = os.path.join(self._path, d) if not os.path.exists(p): os.mkdir(p) built = d def _removeEmptyDirectoriesForPath(self, directory): absoluteDirectory = os.path.join(self._path, directory) if not len(os.listdir(absoluteDirectory)): shutil.rmtree(absoluteDirectory) else: return directory = os.path.dirname(directory) if directory: self._removeEmptyDirectoriesForPath(directory) def writeBytesToPath(self, path, bytes, encoding=None): """ Write bytes to path. If needed, the directory tree for the given path will be built. The path must be relative to the UFO. An encoding may be passed if needed. """ if self._formatVersion < 2: raise UFOLibError("The data directory is not allowed in UFO Format Version %d." % self.formatVersion) self._buildDirectoryTree(path) path = os.path.join(self._path, path) writeFileAtomically(bytes, path, encoding=encoding) def getFileObjectForPath(self, path, encoding=None): """ Creates a write mode file object at path. If needed, the directory tree for the given path will be built. The path must be relative to the UFO. An encoding may be passed if needed. Note: The caller is responsible for closing the open file. """ if self._formatVersion < 2: raise UFOLibError("The data directory is not allowed in UFO Format Version %d." % self.formatVersion) self._buildDirectoryTree(path) path = os.path.join(self._path, path) return codecs.open(path, WRITE_MODE, encoding=encoding) def removeFileForPath(self, path): """ Remove the file (or directory) at path. The path must be relative to the UFO. This is only allowed for files in the data and image directories. """ # make sure that only data or images is being changed d = path parts = [] while d: d, p = os.path.split(d) if p: parts.append(p) if parts[-1] not in ("images", "data"): raise UFOLibError("Removing \"%s\" is not legal." % path) # remove the file originalPath = path path = os.path.join(self._path, path) if not os.path.exists(path): raise UFOLibError("The file %s does not exist." % path) if os.path.isdir(path): shutil.rmtree(path) else: os.remove(path) # remove any directories that are now empty self._removeEmptyDirectoriesForPath(os.path.dirname(originalPath)) # metainfo.plist def _writeMetaInfo(self): self._makeDirectory() path = os.path.join(self._path, METAINFO_FILENAME) metaInfo = dict( creator=self._fileCreator, formatVersion=self._formatVersion ) writePlistAtomically(metaInfo, path) # groups.plist def writeGroups(self, groups): """ Write groups.plist. This method requires a dict of glyph groups as an argument. """ self._makeDirectory() path = os.path.join(self._path, GROUPS_FILENAME) groupsNew = {} for key, value in groups.items(): groupsNew[key] = list(value) if groupsNew: writePlistAtomically(groupsNew, path) elif os.path.exists(path): os.remove(path) # fontinfo.plist def writeInfo(self, info): """ Write info.plist. This method requires an object that supports getting attributes that follow the fontinfo.plist version 2 specification. Attributes will be taken from the given object and written into the file. """ self._makeDirectory() path = os.path.join(self._path, FONTINFO_FILENAME) # gather version 3 data infoData = {} for attr in _fontInfoAttributesVersion3ValueData.keys(): if hasattr(info, attr): try: value = getattr(info, attr) except AttributeError: raise UFOLibError("The supplied info object does not support getting a necessary attribute (%s)." % attr) if value is None: continue infoData[attr] = value # down convert data if necessary and validate if self._formatVersion == 3: infoData = _validateInfoVersion3Data(infoData) elif self._formatVersion == 2: infoData = _convertFontInfoDataVersion3ToVersion2(infoData) infoData = _validateInfoVersion2Data(infoData) elif self._formatVersion == 1: infoData = _convertFontInfoDataVersion3ToVersion2(infoData) infoData = _validateInfoVersion2Data(infoData) infoData = _convertFontInfoDataVersion2ToVersion1(infoData) # write file writePlistAtomically(infoData, path) # kerning.plist def writeKerning(self, kerning): """ Write kerning.plist. This method requires a dict of kerning pairs as an argument. """ self._makeDirectory() path = os.path.join(self._path, KERNING_FILENAME) kerningDict = {} for left, right in kerning.keys(): value = kerning[left, right] if not left in kerningDict: kerningDict[left] = {} kerningDict[left][right] = value if kerningDict: writePlistAtomically(kerningDict, path) elif os.path.exists(path): os.remove(path) # lib.plist def writeLib(self, libDict): """ Write lib.plist. This method requires a lib dict as an argument. """ self._makeDirectory() path = os.path.join(self._path, LIB_FILENAME) if libDict: writePlistAtomically(libDict, path) elif os.path.exists(path): os.remove(path) # features.fea def writeFeatures(self, features): """ Write features.fea. This method requires a features string as an argument. """ if self._formatVersion == 1: raise UFOLibError("features.fea is not allowed in UFO Format Version 1.") self._makeDirectory() path = os.path.join(self._path, FEATURES_FILENAME) writeFileAtomically(features, path) # glyph sets & layers def makeGlyphPath(self, layerName): """ Make the glyphs directory in the .ufo. Returns the path of the directory created. """ glyphDir = self._makeDirectory(DEFAULT_GLYPHS_DIRNAME) return glyphDir def getGlyphSet(self, glyphNameToFileNameFunc=None): """ Return the GlyphSet associated with the glyphs directory in the .ufo. """ return GlyphSet(self.makeGlyphPath(), glyphNameToFileNameFunc) # ---------------- # Helper Functions # ---------------- def makeUFOPath(path): """ Return a .ufo pathname. >>> makeUFOPath("/directory/something.ext") '/directory/something.ufo' >>> makeUFOPath("/directory/something.another.thing.ext") '/directory/something.another.thing.ufo' """ dir, name = os.path.split(path) name = ".".join([".".join(name.split(".")[:-1]), "ufo"]) return os.path.join(dir, name) def writePlistAtomically(obj, path): """ Write a plist for "obj" to "path". Do this sort of atomically, making it harder to cause corrupt files, for example when writePlist encounters an error halfway during write. This also checks to see if text matches the text that is already in the file at path. If so, the file is not rewritten so that the modification date is preserved. """ f = StringIO() writePlist(obj, f) data = f.getvalue() writeFileAtomically(data, path) def writeFileAtomically(text, path, encoding=None): """ Write text into a file at path. Do this sort of atomically making it harder to cause corrupt files. This also checks to see if text matches the text that is already in the file at path. If so, the file is not rewritten so that the modification date is preserved. An encoding may be passed if needed. """ if os.path.exists(path): f = codecs.open(path, READ_MODE, encoding=encoding) oldText = f.read() f.close() if text == oldText: return # if the text is empty, remove the existing file if not text: os.remove(path) if text: f = codecs.open(path, WRITE_MODE, encoding=encoding) f.write(text) f.close() # ---------------------- # fontinfo.plist Support # ---------------------- # Version Validators # There is no version 1 validator and there shouldn't be. # The version 1 spec was very loose and there were numerous # cases of invalid values. def validateFontInfoVersion2ValueForAttribute(attr, value): """ This performs very basic validation of the value for attribute following the UFO 2 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. """ dataValidationDict = _fontInfoAttributesVersion2ValueData[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 == _fontInfoTypeValidator: isValidValue = validator(value, valueType) else: isValidValue = validator(value) return isValidValue def _validateInfoVersion2Data(infoData): validInfoData = {} for attr, value in infoData.items(): isValidValue = validateFontInfoVersion2ValueForAttribute(attr, value) if not isValidValue: raise UFOLibError("Invalid value for attribute %s (%s)." % (attr, repr(value))) else: validInfoData[attr] = value return infoData def validateFontInfoVersion3ValueForAttribute(attr, value): """ This performs very basic validation of the value for attribute following the UFO 2 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. """ dataValidationDict = _fontInfoAttributesVersion3ValueData[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 == _fontInfoTypeValidator: isValidValue = validator(value, valueType) else: isValidValue = validator(value) return isValidValue def _validateInfoVersion3Data(infoData): validInfoData = {} for attr, value in infoData.items(): isValidValue = validateFontInfoVersion3ValueForAttribute(attr, value) if not isValidValue: raise UFOLibError("Invalid value for attribute %s (%s)." % (attr, repr(value))) else: validInfoData[attr] = value # handle the kerning prefixes specially if not _fontInfoKerningPrefixesValidator(infoData): raise UFOLibError("Invalid kerning prefixes.") return infoData # Data Validators def _fontInfoTypeValidator(value, typ): """ Generic. (Added at version 2.) """ return isinstance(value, typ) def _fontInfoIntListValidator(values, validValues): """ Generic. (Added at version 2.) """ if not isinstance(values, (list, tuple)): return False valuesSet = set(values) validValuesSet = set(validValues) if len(valuesSet - validValuesSet) > 0: return False for value in values: if not isinstance(value, int): return False return True def _fontInfoNonNegativeIntValidator(value): """ Generic. (Added at version 3.) """ if not isinstance(value, int): return False if value < 0: return False return True def _fontInfoNonNegativeNumberValidator(value): """ Generic. (Added at version 3.) """ if not isinstance(value, (int, float)): return False if value < 0: return False return True def _fontInfoDictValidator(value, prototype): """ Generic. (Added at version 3.) """ # not a dict if not isinstance(value, dict): return False # missing required keys for key, (typ, required) in prototype.items(): if not required: continue if key not in value: return False # unknown keys for key in value.keys(): if key not in prototype: return False # incorrect types for key, v in value.items(): prototypeType = prototype[key][0] if not isinstance(v, prototypeType): return False return True def _fontInfoStyleMapStyleNameValidator(value): """ Version 2+. """ options = ["regular", "italic", "bold", "bold italic"] return value in options def _fontInfoOpenTypeGaspRangeRecordsValidator(value): """ Version 3+. """ if not isinstance(value, list): return False if len(value) == 0: return False validBehaviors = [0, 1, 2, 3] dictPrototype = dict(rangeMaxPPEM=(int, True), rangeGaspBehavior=(list, True)) ppemOrder = [] for rangeRecord in value: if not _fontInfoDictValidator(rangeRecord, dictPrototype): return False ppem = rangeRecord["rangeMaxPPEM"] behavior = rangeRecord["rangeGaspBehavior"] ppemValidity = _fontInfoNonNegativeIntValidator(ppem) if not ppemValidity: return False behaviorValidity = _fontInfoIntListValidator(behavior, validBehaviors) if not behaviorValidity: return False ppemOrder.append(ppem) if ppemOrder != sorted(ppemOrder): return False if ppemOrder[-1] != 0xFFFF: return False return True def _fontInfoOpenTypeHeadCreatedValidator(value): """ Version 2+. """ # format: 0000/00/00 00:00:00 if not isinstance(value, basestring): return False # basic formatting if not len(value) == 19: return False if value.count(" ") != 1: return False date, time = value.split(" ") if date.count("/") != 2: return False if time.count(":") != 2: return False # date year, month, day = date.split("/") if len(year) != 4: return False if len(month) != 2: return False if len(day) != 2: return False try: year = int(year) month = int(month) day = int(day) except ValueError: return False if month < 1 or month > 12: return False monthMaxDay = calendar.monthrange(year, month) if month > monthMaxDay: return False # time hour, minute, second = time.split(":") if len(hour) != 2: return False if len(minute) != 2: return False if len(second) != 2: return False try: hour = int(hour) minute = int(minute) second = int(second) except ValueError: return False if hour < 0 or hour > 23: return False if minute < 0 or minute > 59: return False if second < 0 or second > 59: return True # fallback return True def _fontInfoOpenTypeNameRecordsValidator(value): """ Version 3+. """ if not isinstance(value, list): return False validKeys = set(["nameID", "platformID", "encodingID", "languageID", "string"]) dictPrototype = dict(nameID=(int, True), platformID=(int, True), encodingID=(int, True), languageID=(int, True), string=(basestring, True)) seenRecords = [] for nameRecord in value: if not _fontInfoDictValidator(nameRecord, dictPrototype): return False recordKey = (nameRecord["nameID"], nameRecord["platformID"], nameRecord["encodingID"], nameRecord["languageID"]) if recordKey in seenRecords: return False seenRecords.append(recordKey) return True def _fontInfoOpenTypeOS2WeightClassValidator(value): """ Version 2+. """ if not isinstance(value, int): return False if value < 0: return False return True def _fontInfoOpenTypeOS2WidthClassValidator(value): """ Version 2+. """ if not isinstance(value, int): return False if value < 1: return False if value > 9: return False return True def _fontInfoVersion2OpenTypeOS2PanoseValidator(values): """ Version 2. """ if not isinstance(values, (list, tuple)): return False if len(values) != 10: return False for value in values: if not isinstance(value, int): return False # XXX further validation? return True def _fontInfoVersion3OpenTypeOS2PanoseValidator(values): """ Version 3+. """ if not isinstance(values, (list, tuple)): return False if len(values) != 10: return False for value in values: if not isinstance(value, int): return False if value < 0: return False # XXX further validation? return True def _fontInfoOpenTypeOS2FamilyClassValidator(values): """ Version 2+. """ if not isinstance(values, (list, tuple)): return False if len(values) != 2: return False for value in values: if not isinstance(value, int): return False classID, subclassID = values if classID < 0 or classID > 14: return False if subclassID < 0 or subclassID > 15: return False return True def _fontInfoPostscriptBluesValidator(values): """ Version 2+. """ if not isinstance(values, (list, tuple)): return False if len(values) > 14: return False if len(values) % 2: return False for value in values: if not isinstance(value, (int, float)): return False return True def _fontInfoPostscriptOtherBluesValidator(values): """ Version 2+. """ if not isinstance(values, (list, tuple)): return False if len(values) > 10: return False if len(values) % 2: return False for value in values: if not isinstance(value, (int, float)): return False return True def _fontInfoPostscriptStemsValidator(values): """ Version 2+. """ if not isinstance(values, (list, tuple)): return False if len(values) > 12: return False for value in values: if not isinstance(value, (int, float)): return False return True def _fontInfoPostscriptWindowsCharacterSetValidator(value): """ Version 2+. """ validValues = range(1, 21) if value not in validValues: return False return True def _fontInfoWOFFMetadataUniqueIDValidator(value): """ Version 3+. """ dictPrototype = dict(id=(basestring, True)) if not _fontInfoDictValidator(value, dictPrototype): return False return True def _fontInfoWOFFMetadataVendorValidator(value): """ Version 3+. """ dictPrototype = {"name" : (basestring, True), "url" : (basestring, False), "dir" : (basestring, False), "class" : (basestring, False)} if not _fontInfoDictValidator(value, dictPrototype): return False if "dir" in value and value.get("dir") not in ("ltr", "rtl"): return False return True def _fontInfoWOFFMetadataCreditsValidator(value): """ Version 3+. """ dictPrototype = dict(credits=(list, True)) if not _fontInfoDictValidator(value, dictPrototype): return False if not len(value["credits"]): return False dictPrototype = {"name" : (basestring, True), "url" : (basestring, False), "role" : (basestring, False), "dir" : (basestring, False), "class" : (basestring, False)} for credit in value["credits"]: if not _fontInfoDictValidator(credit, dictPrototype): return False if "dir" in credit and credit.get("dir") not in ("ltr", "rtl"): return False return True def _fontInfoWOFFMetadataDescriptionValidator(value): """ Version 3+. """ dictPrototype = dict(url=(basestring, False), text=(list, True)) if not _fontInfoDictValidator(value, dictPrototype): return False for text in value["text"]: if not _fontInfoWOFFMetadataTextValue(text): return False return True def _fontInfoWOFFMetadataLicenseValidator(value): """ Version 3+. """ dictPrototype = dict(url=(basestring, False), text=(list, False), id=(basestring, False)) if not _fontInfoDictValidator(value, dictPrototype): return False if "text" in value: for text in value["text"]: if not _fontInfoWOFFMetadataTextValue(text): return False return True def _fontInfoWOFFMetadataTrademarkValidator(value): """ Version 3+. """ dictPrototype = dict(text=(list, True)) if not _fontInfoDictValidator(value, dictPrototype): return False for text in value["text"]: if not _fontInfoWOFFMetadataTextValue(text): return False return True def _fontInfoWOFFMetadataCopyrightValidator(value): """ Version 3+. """ dictPrototype = dict(text=(list, True)) if not _fontInfoDictValidator(value, dictPrototype): return False for text in value["text"]: if not _fontInfoWOFFMetadataTextValue(text): return False return True def _fontInfoWOFFMetadataLicenseeValidator(value): """ Version 3+. """ dictPrototype = {"name" : (basestring, True), "dir" : (basestring, False), "class" : (basestring, False)} if not _fontInfoDictValidator(value, dictPrototype): return False if "dir" in value and value.get("dir") not in ("ltr", "rtl"): return False return True def _fontInfoWOFFMetadataTextValue(value): """ Version 3+. """ dictPrototype = {"text" : (basestring, True), "language" : (basestring, False), "dir" : (basestring, False), "class" : (basestring, False)} if not _fontInfoDictValidator(value, dictPrototype): return False if "dir" in value and value.get("dir") not in ("ltr", "rtl"): return False return True def _fontInfoWOFFMetadataExtensionsValidator(value): """ Version 3+. """ if not isinstance(value, list): return False if not value: return False for extension in value: if not _fontInfoWOFFMetadataExtensionValidator(extension): return False return True def _fontInfoWOFFMetadataExtensionValidator(value): """ Version 3+. """ dictPrototype = dict(names=(list, False), items=(list, True)) if not _fontInfoDictValidator(value, dictPrototype): return False if "names" in value: for name in value["names"]: if not _fontInfoWOFFMetadataExtensionNameValidator(name): return False for item in value["items"]: if not _fontInfoWOFFMetadataExtensionItemValidator(item): return False return True def _fontInfoWOFFMetadataExtensionItemValidator(value): """ Version 3+. """ dictPrototype = dict(id=(basestring, False), names=(list, True), values=(list, True)) if not _fontInfoDictValidator(value, dictPrototype): return False for name in value["names"]: if not _fontInfoWOFFMetadataExtensionNameValidator(name): return False for value in value["values"]: if not _fontInfoWOFFMetadataExtensionValueValidator(name): return False return True def _fontInfoWOFFMetadataExtensionNameValidator(value): """ Version 3+. """ dictPrototype = {"text" : (basestring, True), "language" : (basestring, False), "dir" : (basestring, False), "class" : (basestring, False)} if not _fontInfoDictValidator(value, dictPrototype): return False return True def _fontInfoWOFFMetadataExtensionValueValidator(value): """ Version 3+. """ dictPrototype = {"text" : (basestring, True), "language" : (basestring, False), "dir" : (basestring, False), "class" : (basestring, False)} if not _fontInfoDictValidator(value, dictPrototype): return False return True def _fontInfoKerningPrefixesValidator(info): """ Version 3+. """ prefix1 = info.get("firstKerningGroupPrefix") prefix2 = info.get("secondKerningGroupPrefix") # both are None if prefix1 is None and prefix2 is None: return True # one is None if prefix1 is None and prefix2 is not None: return False if prefix2 is None and prefix1 is not None: return False # they are the same if prefix1 == prefix2: return False # one starts with the other if prefix1.startswith(prefix2): return False if prefix2.startswith(prefix1): return False return True def _fontInfoKerningPrefixValidator(value): """ Version 3+. """ if not isinstance(value, basestring): return False if not len(value): return False return True # Value Options _fontInfoOpenTypeHeadFlagsOptions = range(0, 14) _fontInfoOpenTypeOS2SelectionOptions = [1, 2, 3, 4] _fontInfoOpenTypeOS2UnicodeRangesOptions = range(0, 128) _fontInfoOpenTypeOS2CodePageRangesOptions = range(0, 64) _fontInfoOpenTypeOS2TypeOptions = [0, 1, 2, 3, 8, 9] # Version Attribute Definitions # This defines the attributes, types and, in some # cases the possible values, that can exist is # fontinfo.plist. fontInfoAttributesVersion1 = set([ "familyName", "styleName", "fullName", "fontName", "menuName", "fontStyle", "note", "versionMajor", "versionMinor", "year", "copyright", "notice", "trademark", "license", "licenseURL", "createdBy", "designer", "designerURL", "vendorURL", "unitsPerEm", "ascender", "descender", "capHeight", "xHeight", "defaultWidth", "slantAngle", "italicAngle", "widthName", "weightName", "weightValue", "fondName", "otFamilyName", "otStyleName", "otMacName", "msCharSet", "fondID", "uniqueID", "ttVendor", "ttUniqueID", "ttVersion", ]) _fontInfoAttributesVersion2ValueData = { "familyName" : dict(type=basestring), "styleName" : dict(type=basestring), "styleMapFamilyName" : dict(type=basestring), "styleMapStyleName" : dict(type=basestring, valueValidator=_fontInfoStyleMapStyleNameValidator), "versionMajor" : dict(type=int), "versionMinor" : dict(type=int), "year" : dict(type=int), "copyright" : dict(type=basestring), "trademark" : dict(type=basestring), "unitsPerEm" : dict(type=(int, float)), "descender" : dict(type=(int, float)), "xHeight" : dict(type=(int, float)), "capHeight" : dict(type=(int, float)), "ascender" : dict(type=(int, float)), "italicAngle" : dict(type=(float, int)), "note" : dict(type=basestring), "openTypeHeadCreated" : dict(type=basestring, valueValidator=_fontInfoOpenTypeHeadCreatedValidator), "openTypeHeadLowestRecPPEM" : dict(type=(int, float)), "openTypeHeadFlags" : dict(type="integerList", valueValidator=_fontInfoIntListValidator, valueOptions=_fontInfoOpenTypeHeadFlagsOptions), "openTypeHheaAscender" : dict(type=(int, float)), "openTypeHheaDescender" : dict(type=(int, float)), "openTypeHheaLineGap" : dict(type=(int, float)), "openTypeHheaCaretSlopeRise" : dict(type=int), "openTypeHheaCaretSlopeRun" : dict(type=int), "openTypeHheaCaretOffset" : dict(type=(int, float)), "openTypeNameDesigner" : dict(type=basestring), "openTypeNameDesignerURL" : dict(type=basestring), "openTypeNameManufacturer" : dict(type=basestring), "openTypeNameManufacturerURL" : dict(type=basestring), "openTypeNameLicense" : dict(type=basestring), "openTypeNameLicenseURL" : dict(type=basestring), "openTypeNameVersion" : dict(type=basestring), "openTypeNameUniqueID" : dict(type=basestring), "openTypeNameDescription" : dict(type=basestring), "openTypeNamePreferredFamilyName" : dict(type=basestring), "openTypeNamePreferredSubfamilyName" : dict(type=basestring), "openTypeNameCompatibleFullName" : dict(type=basestring), "openTypeNameSampleText" : dict(type=basestring), "openTypeNameWWSFamilyName" : dict(type=basestring), "openTypeNameWWSSubfamilyName" : dict(type=basestring), "openTypeOS2WidthClass" : dict(type=int, valueValidator=_fontInfoOpenTypeOS2WidthClassValidator), "openTypeOS2WeightClass" : dict(type=int, valueValidator=_fontInfoOpenTypeOS2WeightClassValidator), "openTypeOS2Selection" : dict(type="integerList", valueValidator=_fontInfoIntListValidator, valueOptions=_fontInfoOpenTypeOS2SelectionOptions), "openTypeOS2VendorID" : dict(type=basestring), "openTypeOS2Panose" : dict(type="integerList", valueValidator=_fontInfoVersion2OpenTypeOS2PanoseValidator), "openTypeOS2FamilyClass" : dict(type="integerList", valueValidator=_fontInfoOpenTypeOS2FamilyClassValidator), "openTypeOS2UnicodeRanges" : dict(type="integerList", valueValidator=_fontInfoIntListValidator, valueOptions=_fontInfoOpenTypeOS2UnicodeRangesOptions), "openTypeOS2CodePageRanges" : dict(type="integerList", valueValidator=_fontInfoIntListValidator, valueOptions=_fontInfoOpenTypeOS2CodePageRangesOptions), "openTypeOS2TypoAscender" : dict(type=(int, float)), "openTypeOS2TypoDescender" : dict(type=(int, float)), "openTypeOS2TypoLineGap" : dict(type=(int, float)), "openTypeOS2WinAscent" : dict(type=(int, float)), "openTypeOS2WinDescent" : dict(type=(int, float)), "openTypeOS2Type" : dict(type="integerList", valueValidator=_fontInfoIntListValidator, valueOptions=_fontInfoOpenTypeOS2TypeOptions), "openTypeOS2SubscriptXSize" : dict(type=(int, float)), "openTypeOS2SubscriptYSize" : dict(type=(int, float)), "openTypeOS2SubscriptXOffset" : dict(type=(int, float)), "openTypeOS2SubscriptYOffset" : dict(type=(int, float)), "openTypeOS2SuperscriptXSize" : dict(type=(int, float)), "openTypeOS2SuperscriptYSize" : dict(type=(int, float)), "openTypeOS2SuperscriptXOffset" : dict(type=(int, float)), "openTypeOS2SuperscriptYOffset" : dict(type=(int, float)), "openTypeOS2StrikeoutSize" : dict(type=(int, float)), "openTypeOS2StrikeoutPosition" : dict(type=(int, float)), "openTypeVheaVertTypoAscender" : dict(type=(int, float)), "openTypeVheaVertTypoDescender" : dict(type=(int, float)), "openTypeVheaVertTypoLineGap" : dict(type=(int, float)), "openTypeVheaCaretSlopeRise" : dict(type=int), "openTypeVheaCaretSlopeRun" : dict(type=int), "openTypeVheaCaretOffset" : dict(type=(int, float)), "postscriptFontName" : dict(type=basestring), "postscriptFullName" : dict(type=basestring), "postscriptSlantAngle" : dict(type=(float, int)), "postscriptUniqueID" : dict(type=int), "postscriptUnderlineThickness" : dict(type=(int, float)), "postscriptUnderlinePosition" : dict(type=(int, float)), "postscriptIsFixedPitch" : dict(type=bool), "postscriptBlueValues" : dict(type="integerList", valueValidator=_fontInfoPostscriptBluesValidator), "postscriptOtherBlues" : dict(type="integerList", valueValidator=_fontInfoPostscriptOtherBluesValidator), "postscriptFamilyBlues" : dict(type="integerList", valueValidator=_fontInfoPostscriptBluesValidator), "postscriptFamilyOtherBlues" : dict(type="integerList", valueValidator=_fontInfoPostscriptOtherBluesValidator), "postscriptStemSnapH" : dict(type="integerList", valueValidator=_fontInfoPostscriptStemsValidator), "postscriptStemSnapV" : dict(type="integerList", valueValidator=_fontInfoPostscriptStemsValidator), "postscriptBlueFuzz" : dict(type=(int, float)), "postscriptBlueShift" : dict(type=(int, float)), "postscriptBlueScale" : dict(type=(float, int)), "postscriptForceBold" : dict(type=bool), "postscriptDefaultWidthX" : dict(type=(int, float)), "postscriptNominalWidthX" : dict(type=(int, float)), "postscriptWeightName" : dict(type=basestring), "postscriptDefaultCharacter" : dict(type=basestring), "postscriptWindowsCharacterSet" : dict(type=int, valueValidator=_fontInfoPostscriptWindowsCharacterSetValidator), "macintoshFONDFamilyID" : dict(type=int), "macintoshFONDName" : dict(type=basestring), } fontInfoAttributesVersion2 = set(_fontInfoAttributesVersion2ValueData.keys()) _fontInfoAttributesVersion3ValueData = deepcopy(_fontInfoAttributesVersion2ValueData) _fontInfoAttributesVersion3ValueData.update({ "versionMinor" : dict(type=int, valueValidator=_fontInfoNonNegativeIntValidator), "unitsPerEm" : dict(type=(int, float), valueValidator=_fontInfoNonNegativeNumberValidator), "openTypeHeadLowestRecPPEM" : dict(type=(int, float), valueValidator=_fontInfoNonNegativeNumberValidator), "openTypeOS2Panose" : dict(type="integerList", valueValidator=_fontInfoVersion3OpenTypeOS2PanoseValidator), "openTypeOS2WinAscent" : dict(type=(int, float), valueValidator=_fontInfoNonNegativeNumberValidator), "openTypeOS2WinDescent" : dict(type=(int, float), valueValidator=_fontInfoNonNegativeNumberValidator), "openTypeGaspRangeRecords" : dict(type="dictList", valueValidator=_fontInfoOpenTypeGaspRangeRecordsValidator), "openTypeNameRecords" : dict(type="dictList", valueValidator=_fontInfoOpenTypeNameRecordsValidator), "woffMajorVersion" : dict(type=int, valueValidator=_fontInfoNonNegativeIntValidator), "woffMinorVersion" : dict(type=int, valueValidator=_fontInfoNonNegativeIntValidator), "woffMetadataUniqueID" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataUniqueIDValidator), "woffMetadataVendor" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataVendorValidator), "woffMetadataCredits" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataCreditsValidator), "woffMetadataDescription" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataDescriptionValidator), "woffMetadataLicense" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataLicenseValidator), "woffMetadataCopyright" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataCopyrightValidator), "woffMetadataTrademark" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataTrademarkValidator), "woffMetadataLicensee" : dict(type=dict, valueValidator=_fontInfoWOFFMetadataLicenseeValidator), "woffMetadataExtensions" : dict(type=list, valueValidator=_fontInfoWOFFMetadataExtensionsValidator), "firstKerningGroupPrefix" : dict(type=basestring, valueValidator=_fontInfoKerningPrefixValidator), "secondKerningGroupPrefix" : dict(type=basestring, valueValidator=_fontInfoKerningPrefixValidator), }) # insert the type validator for all attrs that # have no defined validator. for attr, dataDict in _fontInfoAttributesVersion2ValueData.items(): if "valueValidator" not in dataDict: dataDict["valueValidator"] = _fontInfoTypeValidator for attr, dataDict in _fontInfoAttributesVersion3ValueData.items(): if "valueValidator" not in dataDict: dataDict["valueValidator"] = _fontInfoTypeValidator # Version Conversion Support # These are used from converting from version 1 # to version 2 or vice-versa. def _flipDict(d): flipped = {} for key, value in d.items(): flipped[value] = key return flipped _fontInfoAttributesVersion1To2 = { "menuName" : "styleMapFamilyName", "designer" : "openTypeNameDesigner", "designerURL" : "openTypeNameDesignerURL", "createdBy" : "openTypeNameManufacturer", "vendorURL" : "openTypeNameManufacturerURL", "license" : "openTypeNameLicense", "licenseURL" : "openTypeNameLicenseURL", "ttVersion" : "openTypeNameVersion", "ttUniqueID" : "openTypeNameUniqueID", "notice" : "openTypeNameDescription", "otFamilyName" : "openTypeNamePreferredFamilyName", "otStyleName" : "openTypeNamePreferredSubfamilyName", "otMacName" : "openTypeNameCompatibleFullName", "weightName" : "postscriptWeightName", "weightValue" : "openTypeOS2WeightClass", "ttVendor" : "openTypeOS2VendorID", "uniqueID" : "postscriptUniqueID", "fontName" : "postscriptFontName", "fondID" : "macintoshFONDFamilyID", "fondName" : "macintoshFONDName", "defaultWidth" : "postscriptDefaultWidthX", "slantAngle" : "postscriptSlantAngle", "fullName" : "postscriptFullName", # require special value conversion "fontStyle" : "styleMapStyleName", "widthName" : "openTypeOS2WidthClass", "msCharSet" : "postscriptWindowsCharacterSet" } _fontInfoAttributesVersion2To1 = _flipDict(_fontInfoAttributesVersion1To2) deprecatedFontInfoAttributesVersion2 = set(_fontInfoAttributesVersion1To2.keys()) _fontStyle1To2 = { 64 : "regular", 1 : "italic", 32 : "bold", 33 : "bold italic" } _fontStyle2To1 = _flipDict(_fontStyle1To2) # Some UFO 1 files have 0 _fontStyle1To2[0] = "regular" _widthName1To2 = { "Ultra-condensed" : 1, "Extra-condensed" : 2, "Condensed" : 3, "Semi-condensed" : 4, "Medium (normal)" : 5, "Semi-expanded" : 6, "Expanded" : 7, "Extra-expanded" : 8, "Ultra-expanded" : 9 } _widthName2To1 = _flipDict(_widthName1To2) # FontLab's default width value is "Normal". # Many format version 1 UFOs will have this. _widthName1To2["Normal"] = 5 # FontLab has an "All" width value. In UFO 1 # move this up to "Normal". _widthName1To2["All"] = 5 # "medium" appears in a lot of UFO 1 files. _widthName1To2["medium"] = 5 # "Medium" appears in a lot of UFO 1 files. _widthName1To2["Medium"] = 5 _msCharSet1To2 = { 0 : 1, 1 : 2, 2 : 3, 77 : 4, 128 : 5, 129 : 6, 130 : 7, 134 : 8, 136 : 9, 161 : 10, 162 : 11, 163 : 12, 177 : 13, 178 : 14, 186 : 15, 200 : 16, 204 : 17, 222 : 18, 238 : 19, 255 : 20 } _msCharSet2To1 = _flipDict(_msCharSet1To2) def convertFontInfoValueForAttributeFromVersion1ToVersion2(attr, value): """ Convert value from version 1 to version 2 format. Returns the new attribute name and the converted value. If the value is None, None will be returned for the new value. """ # convert floats to ints if possible if isinstance(value, float): if int(value) == value: value = int(value) if value is not None: if attr == "fontStyle": v = _fontStyle1To2.get(value) if v is None: raise UFOLibError("Cannot convert value (%s) for attribute %s." % (repr(value), attr)) value = v elif attr == "widthName": v = _widthName1To2.get(value) if v is None: raise UFOLibError("Cannot convert value (%s) for attribute %s." % (repr(value), attr)) value = v elif attr == "msCharSet": v = _msCharSet1To2.get(value) if v is None: raise UFOLibError("Cannot convert value (%s) for attribute %s." % (repr(value), attr)) value = v attr = _fontInfoAttributesVersion1To2.get(attr, attr) return attr, value def convertFontInfoValueForAttributeFromVersion2ToVersion1(attr, value): """ Convert value from version 2 to version 1 format. Returns the new attribute name and the converted value. If the value is None, None will be returned for the new value. """ if value is not None: if attr == "styleMapStyleName": value = _fontStyle2To1.get(value) elif attr == "openTypeOS2WidthClass": value = _widthName2To1.get(value) elif attr == "postscriptWindowsCharacterSet": value = _msCharSet2To1.get(value) attr = _fontInfoAttributesVersion2To1.get(attr, attr) return attr, value def _convertFontInfoDataVersion1ToVersion2(data): converted = {} for attr, value in data.items(): # FontLab gives -1 for the weightValue # for fonts wil no defined value. Many # format version 1 UFOs will have this. if attr == "weightValue" and value == -1: continue newAttr, newValue = convertFontInfoValueForAttributeFromVersion1ToVersion2(attr, value) # skip if the attribute is not part of version 2 if newAttr not in fontInfoAttributesVersion2: continue # catch values that can't be converted if value is None: raise UFOLibError("Cannot convert value (%s) for attribute %s." % (repr(value), newAttr)) # store converted[newAttr] = newValue return converted def _convertFontInfoDataVersion2ToVersion1(data): converted = {} for attr, value in data.items(): newAttr, newValue = convertFontInfoValueForAttributeFromVersion2ToVersion1(attr, value) # only take attributes that are registered for version 1 if newAttr not in fontInfoAttributesVersion1: continue # catch values that can't be converted if value is None: raise UFOLibError("Cannot convert value (%s) for attribute %s." % (repr(value), newAttr)) # store converted[newAttr] = newValue return converted def _convertFontInfoDataVersion3ToVersion2(data): converted = {} for attr, value in data.items(): # only take attributes that are registered for version 2 if attr not in fontInfoAttributesVersion2: continue # store converted[attr] = value return converted if __name__ == "__main__": import doctest doctest.testmod()