diff --git a/CHANGELOG.md b/CHANGELOG.md index b8e60d42..6ac1b3b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # A changelog for the lib/hyperglot language database and CLI tool (dd.mm.yyyy) +## 0.6.4 (WIP) +- FIX: Fixed an issue where trying to log missing shaping glyphs would crash in `FontChecker` + ## 0.6.3 (08.04.2024) - FIX: Set correct default values for `Language.status` and `Orthography.preferred_as_group` and provide validation and tests for these. - TWEAK: Deprecated plain list `SUPPORTLEVELS, VALIDITYLEVELS, STATUSES, ORTHOGRAPHY_STATUSES` and replaced them with `SupportLevel, LanguageValidity, LanguageStatus, OrthographyStatus` enums throughout the code base. The deprecated values will be removed in the next minor version. diff --git a/lib/hyperglot/checker.py b/lib/hyperglot/checker.py index 66c4add4..55a5d799 100644 --- a/lib/hyperglot/checker.py +++ b/lib/hyperglot/checker.py @@ -273,6 +273,8 @@ def supports_language( f"{language} missing {len(base_missing)} base characters" ) + # Proceed with shaping checks (for output) even when font is + # already found not supporting a language! if shaping: joining_errors, mark_errors = self._check_shaping( ort, "base", marks, decomposed @@ -295,7 +297,12 @@ def supports_language( # Validation if len(joining_errors) > 0 or len(mark_errors) > 0: supported = False - logging.info(f"{language} missing base shaping for") + msg = [f"{language} missing base shaping for: "] + if len(mark_errors) > 0: + msg.append("- mark attachment: " + " ".join(mark_errors)) + if len(joining_errors) > 0: + msg.append("- joining shapes: " + " ".join(joining_errors)) + logging.info("\n".join(msg)) # If an orthography has no "auxiliary" we consider it supported on # "auxiliary" level, too. @@ -320,6 +327,8 @@ def supports_language( supported = False logging.info(f"{language} missing {len(aux_missing)} 'aux'") + # Proceed with shaping checks (for output) even when font is + # already found not supporting a language! if shaping: joining_errors, mark_errors = self._check_shaping( ort, "auxiliary", marks, decomposed diff --git a/lib/hyperglot/shaper.py b/lib/hyperglot/shaper.py index cb0a9f67..fe80263d 100644 --- a/lib/hyperglot/shaper.py +++ b/lib/hyperglot/shaper.py @@ -34,7 +34,6 @@ def shape(self, text): "kern": True, "mark": True, "mkmk": True, - # Explicitly opt out of these so they do not interfere with basic # shaping/joining "liga": False, @@ -42,7 +41,6 @@ def shape(self, text): "rclt": False, "calt": False, "salt": False, - # Others should get detected by script of the input, e.g. for # Arabic or Indic, so we do not explicitly opt in } @@ -72,7 +70,7 @@ def names_for_codepoints(self, codepoints: Iterable[int]) -> List: """ Helper for better debug messages with font glyph names instead of gids. """ - return [self.font.get_glyph_name(m) for m in codepoints] + return [str(self.font.get_glyph_name(m)) for m in codepoints] @lru_cache def check_joining(self, unicode: int) -> bool: @@ -198,18 +196,15 @@ def check_mark_attachment(self, input: str) -> bool: if not uni.category(c).startswith("M") } - missing_from_font = [] + missing_from_font = 0 missing_positioning = [] for glyph_info, glyph_position in data: if glyph_info.codepoint in non_marks.keys(): continue # No such glyph in the font. - # For regular check runs this should never trigger, since character - # sets are checked first. - # TODO maybe this should even be a raised Exception? - if glyph_info.codepoint == 0: - missing_from_font.append(glyph_info.codepoint) + if glyph_info.codepoint == 0 or self.font.get_glyph_name(glyph_info.codepoint) is None: + missing_from_font = missing_from_font + 1 continue # This appears to be a unpositioned mark! @@ -217,18 +212,20 @@ def check_mark_attachment(self, input: str) -> bool: missing_positioning.append(glyph_info.codepoint) continue - if missing_from_font != []: - names = ", ".join(self.names_for_codepoints(missing_from_font)) + if missing_from_font != 0: log.debug( - f"Mark shaping for '{input}' is missing for font glyph names '{names}'" + f"Mark shaping for '{input}' failed, " + "missing %d %s" + % ( + missing_from_font, + "glyphs" if missing_from_font > 1 else "glyph", + ) ) return False if missing_positioning != []: names = ", ".join(self.names_for_codepoints(missing_positioning)) - log.debug( - f"Mark positioning for '{input}' failed for font glyph names '{names}'" - ) + log.debug(f"Mark positioning for '{input}' failed, glyph names: '{names}'") return False return True diff --git a/tests/Roboto/LICENSE.txt b/tests/Roboto/LICENSE.txt new file mode 100644 index 00000000..75b52484 --- /dev/null +++ b/tests/Roboto/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/tests/Roboto/Roboto-Black.ttf b/tests/Roboto/Roboto-Black.ttf new file mode 100644 index 00000000..0112e7da Binary files /dev/null and b/tests/Roboto/Roboto-Black.ttf differ diff --git a/tests/test_checker.py b/tests/test_checker.py index d7e99d87..0c3a1fb6 100644 --- a/tests/test_checker.py +++ b/tests/test_checker.py @@ -9,6 +9,7 @@ from hyperglot.parse import character_list_from_string, parse_font_chars, parse_marks from hyperglot.checker import CharsetChecker, FontChecker + # Just a most simple placeholder charset ascii = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" @@ -20,6 +21,7 @@ "tests/plex-4.0.2/IBM-Plex-Sans-Arabic/fonts/complete/otf/IBMPlexSansArabic-Regular-without-medi-fina.otf" ) # noqa eczar = os.path.abspath("tests/Eczar-v1.004/otf/Eczar-Regular.otf") +roboto = os.path.abspath("tests/Roboto/Roboto-Black.ttf") testfont = os.path.abspath("tests/HyperglotTestFont-Regular.ttf") @@ -411,3 +413,9 @@ def test_checker_joining(caplog): # acm, because it is missing two dozen checker.supports_language("acm", report_joining=1) assert len(caplog.records) == 0 + + +def test_font_checker_logging_names(): + # Make sure not to choke on missing glyph names (refactored shaper code) + checker = FontChecker(roboto) + checker.get_supported_languages()