fontio.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2020 Melissa LeBlanc-Williams for Adafruit Industries
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22 """
  23 `fontio`
  24 ================================================================================
  25
  26 fontio for Blinka
  27
  28 **Software and Dependencies:**
  29
  30 * Adafruit Blinka:
  31   https://github.com/adafruit/Adafruit_Blinka/releases
  32
  33 * Author(s): Melissa LeBlanc-Williams
  34
  35 """
  36
  37 from PIL import ImageFont
  38 from displayio import Bitmap
  39
  40 __version__ = "0.0.0-auto.0"
  41 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  42
  43
  44 class BuiltinFont:
  45     """Simulate a font built into CircuitPython"""
  46     def __init__(self):
  47         self._font = ImageFont.load_default()
  48         ascii_chars = ""
  49         for character in range(0x20, 0x7F):
  50             ascii_chars += chr(character)
  51         self._font.getmask(ascii_chars)
  52         bmp_size = self._font.getsize(ascii_chars)
  53         self._bitmap = Bitmap(bmp_size[0], bmp_size[1], 2)
  54         ascii_mask = self._font.getmask(ascii_chars, mode="1")
  55         for x in range(bmp_size[0]):
  56             for y in range(bmp_size[1]):
  57                 self._bitmap[x, y] = 1 if ascii_mask.getpixel((x, y)) else 0
  58
  59     def _get_glyph_index(self, charcode):
  60         if 0x20 <= charcode <= 0x7E:
  61             return charcode - 0x20
  62         return None
  63
  64     def get_bounding_box(self):
  65         """Returns the maximum bounds of all glyphs in the font in
  66         a tuple of two values: width, height.
  67         """
  68         return self._font.getsize("M")
  69
  70     def get_glyph(self, codepoint):
  71         """Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available."""
  72         bounding_box = self._font.getsize(chr(codepoint))
  73         return Glyph(
  74             bitmap=self._bitmap,
  75             tile_index=self._get_glyph_index(codepoint),
  76             width=bounding_box[0],
  77             height=bounding_box[1],
  78             dx=0,
  79             dy=0,
  80             shift_x=0,
  81             shift_y=0,
  82         )
  83
  84     @property
  85     def bitmap(self):
  86         """Bitmap containing all font glyphs starting with ASCII and followed by unicode. Use
  87         `get_glyph` in most cases. This is useful for use with `displayio.TileGrid` and
  88         `terminalio.Terminal`.
  89         """
  90         return self._bitmap
  91
  92
  93 class Glyph:
  94     """Storage of glyph info"""
  95     def __init__(self, *, bitmap, tile_index, width, height, dx, dy, shift_x, shift_y):
  96         self.bitmap = bitmap
  97         self.width = width
  98         self.height = height
  99         self.dx = dx
 100         self.dy = dy
 101         self.shift_x = shift_x
 102         self.shift_y = shift_y
 103         self.tile_index = tile_index