fontio.py

   1 # SPDX-FileCopyrightText: 2020 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4
   5 """
   6 `fontio`
   7 ================================================================================
   8
   9 fontio for Blinka
  10
  11 **Software and Dependencies:**
  12
  13 * Adafruit Blinka:
  14   https://github.com/adafruit/Adafruit_Blinka/releases
  15
  16 * Author(s): Melissa LeBlanc-Williams
  17
  18 """
  19
  20 from typing import Union, Tuple, Optional
  21 from PIL import ImageFont
  22 from displayio import Bitmap
  23 try:
  24     from typing import Protocol
  25 except ImportError:
  26     from typing_extensions import Protocol
  27
  28 __version__ = "0.0.0-auto.0"
  29 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  30
  31
  32 class FontProtocol(Protocol):
  33     """A protocol shared by `BuiltinFont` and classes in ``adafruit_bitmap_font``"""
  34
  35     def get_bounding_box(self) -> Union[Tuple[int, int], Tuple[int, int, int, int]]:
  36         """Retrieve the maximum bounding box of any glyph in the font.
  37
  38         The four element version is ``(width, height, x_offset, y_offset)``.
  39         The two element version is ``(width, height)``, in which
  40         ``x_offset`` and ``y_offset`` are assumed to be zero.
  41         """
  42
  43     def get_glyph(self, codepoint: int) -> Optional["Glyph"]:
  44         """Retrieve the Glyph for a given code point
  45
  46         If the code point is not present in the font, `None` is returned.
  47         """
  48
  49 class BuiltinFont:
  50     """Simulate a font built into CircuitPython"""
  51
  52     def __init__(self):
  53         self._font = ImageFont.load_default()
  54         self._generate_bitmap(0x20, 0x7E)
  55
  56     def _generate_bitmap(self, start_range, end_range):
  57         char_width, char_height = self.get_bounding_box()
  58         self._bitmap = Bitmap(
  59             char_width * (end_range - start_range + 1), char_height, 2
  60         )
  61         for character in range(start_range, end_range + 1):
  62             ascii_char = chr(character)
  63             ascii_mask = self._font.getmask(ascii_char, mode="1")
  64             for y in range(char_height):
  65                 for x in range(char_width):
  66                     color = ascii_mask.getpixel((x, y))
  67                     character_position = character - start_range
  68                     self._bitmap[character_position * char_width + x, y] = (
  69                         1 if color else 0
  70                     )
  71
  72     def get_bounding_box(self):
  73         """Returns the maximum bounds of all glyphs in the font in
  74         a tuple of two values: width, height.
  75         """
  76         return self._font.getsize("M")
  77
  78     def get_glyph(self, codepoint):
  79         """Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available."""
  80         if 0x20 <= codepoint <= 0x7E:
  81             glyph_index = codepoint - 0x20
  82         else:
  83             return None
  84
  85         bounding_box = self._font.getsize(chr(codepoint))
  86         width, height = bounding_box
  87         return Glyph(
  88             bitmap=self._bitmap,
  89             tile_index=glyph_index,
  90             width=width,
  91             height=height,
  92             dx=0,
  93             dy=0,
  94             shift_x=width,
  95             shift_y=0,
  96         )
  97
  98     @property
  99     def bitmap(self):
 100         """Bitmap containing all font glyphs starting with ASCII and followed by unicode. Use
 101         `get_glyph` in most cases. This is useful for use with `displayio.TileGrid` and
 102         `terminalio.Terminal`.
 103         """
 104         return self._bitmap
 105
 106
 107 # pylint: disable=too-few-public-methods, invalid-name, too-many-arguments
 108 class Glyph:
 109     """Storage of glyph info"""
 110
 111     def __init__(self, bitmap, tile_index, width, height, dx, dy, shift_x, shift_y):
 112         self.bitmap = bitmap
 113         self.width = width
 114         self.height = height
 115         self.dx = dx
 116         self.dy = dy
 117         self.shift_x = shift_x
 118         self.shift_y = shift_y
 119         self.tile_index = tile_index
 120
 121
 122 # pylint: enable=too-few-public-methods, invalid-name, too-many-arguments