X-Git-Url: https://git.ayoreis.com/hackapet/Adafruit_Blinka_Displayio.git/blobdiff_plain/a3105537d2e9c087f9312b1122739772d2c37c32..HEAD:/fontio.py diff --git a/fontio.py b/fontio.py index 5e02bdb..7654f05 100644 --- a/fontio.py +++ b/fontio.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2020 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2020 Melissa LeBlanc-Williams for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT + """ `fontio` ================================================================================ @@ -34,61 +17,67 @@ fontio for Blinka """ -from PIL import ImageFont +import os +from dataclasses import dataclass +from typing import Union, Tuple, Optional from displayio import Bitmap -__version__ = "0.0.0-auto.0" +try: + from typing import Protocol +except ImportError: + from typing_extensions import Protocol + +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git" +DEFAULT_FONT = "displayio/resources/ter-u12n.bdf" + + +class FontProtocol(Protocol): + """A protocol shared by `BuiltinFont` and classes in ``adafruit_bitmap_font``""" + + def get_bounding_box(self) -> Union[Tuple[int, int], Tuple[int, int, int, int]]: + """Retrieve the maximum bounding box of any glyph in the font. + + The four element version is ``(width, height, x_offset, y_offset)``. + The two element version is ``(width, height)``, in which + ``x_offset`` and ``y_offset`` are assumed to be zero. + """ + + def get_glyph(self, codepoint: int) -> Optional["Glyph"]: + """Retrieve the Glyph for a given code point + + If the code point is not present in the font, `None` is returned. + """ + class BuiltinFont: """Simulate a font built into CircuitPython""" def __init__(self): - self._font = ImageFont.load_default() - self._generate_bitmap(0x20, 0x7E) + self._width = 0 + self._height = 0 - def _generate_bitmap(self, start_range, end_range): - char_width, char_height = self.get_bounding_box() - self._bitmap = Bitmap( - char_width * (end_range - start_range + 1), char_height, 2 + # Place import here to avoid circular import + from adafruit_bitmap_font import ( # pylint: disable=import-outside-toplevel + bitmap_font, ) - for character in range(start_range, end_range + 1): - ascii_char = chr(character) - ascii_mask = self._font.getmask(ascii_char, mode="1") - for y in range(char_height): - for x in range(char_width): - color = ascii_mask.getpixel((x, y)) - character_position = character - start_range - self._bitmap[character_position * char_width + x, y] = ( - 1 if color else 0 - ) - - def get_bounding_box(self): + + self._font = bitmap_font.load_font( + os.path.dirname(__file__) + "/" + DEFAULT_FONT + ) + + self._font.load_glyphs(set(range(0x20, 0x7F))) + + def get_bounding_box(self) -> Union[Tuple[int, int], Tuple[int, int, int, int]]: """Returns the maximum bounds of all glyphs in the font in a tuple of two values: width, height. """ - return self._font.getsize("M") + return self._font.get_bounding_box()[0:2] - def get_glyph(self, codepoint): + def get_glyph(self, codepoint: int) -> Optional["Glyph"]: """Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available.""" - if 0x20 <= codepoint <= 0x7E: - glyph_index = codepoint - 0x20 - else: - return None - - bounding_box = self._font.getsize(chr(codepoint)) - width, height = bounding_box - return Glyph( - bitmap=self._bitmap, - tile_index=glyph_index, - width=width, - height=height, - dx=0, - dy=0, - shift_x=width, - shift_y=0, - ) + return self._font.get_glyph(codepoint) @property def bitmap(self): @@ -96,22 +85,18 @@ class BuiltinFont: `get_glyph` in most cases. This is useful for use with `displayio.TileGrid` and `terminalio.Terminal`. """ - return self._bitmap + return self._font.bitmap_class -# pylint: disable=too-few-public-methods, invalid-name, too-many-arguments +@dataclass class Glyph: + # pylint: disable=invalid-name """Storage of glyph info""" - - def __init__(self, bitmap, tile_index, width, height, dx, dy, shift_x, shift_y): - self.bitmap = bitmap - self.width = width - self.height = height - self.dx = dx - self.dy = dy - self.shift_x = shift_x - self.shift_y = shift_y - self.tile_index = tile_index - - -# pylint: enable=too-few-public-methods, invalid-name, too-many-arguments + bitmap: Bitmap + tile_index: int + width: int + height: int + dx: int + dy: int + shift_x: int + shift_y: int