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
  47     def __init__(self):
  48         self._font = ImageFont.load_default()
  49         ascii_chars = ""
  50         for character in range(0x20, 0x7F):
  51             ascii_chars += chr(character)
  52         self._font.getmask(ascii_chars)
  53         bmp_size = self._font.getsize(ascii_chars)
  54         self._bitmap = Bitmap(bmp_size[0], bmp_size[1], 2)
  55         ascii_mask = self._font.getmask(ascii_chars, mode="1")
  56         for x in range(bmp_size[0]):
  57             for y in range(bmp_size[1]):
  58                 self._bitmap[x, y] = 1 if ascii_mask.getpixel((x, y)) else 0
  59
  60     def get_bounding_box(self):
  61         """Returns the maximum bounds of all glyphs in the font in
  62         a tuple of two values: width, height.
  63         """
  64         return self._font.getsize("M")
  65
  66     def get_glyph(self, codepoint):
  67         """Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available."""
  68         if 0x20 <= codepoint <= 0x7E:
  69             glyph_index = codepoint - 0x20
  70         else:
  71             return None
  72
  73         bounding_box = self._font.getsize(chr(codepoint))
  74         width, height = bounding_box
  75         return Glyph(
  76             bitmap=self._bitmap,
  77             tile_index=glyph_index,
  78             width=width,
  79             height=height,
  80             dx=0,
  81             dy=0,
  82             shift_x=width,
  83             shift_y=0,
  84         )
  85
  86     @property
  87     def bitmap(self):
  88         """Bitmap containing all font glyphs starting with ASCII and followed by unicode. Use
  89         `get_glyph` in most cases. This is useful for use with `displayio.TileGrid` and
  90         `terminalio.Terminal`.
  91         """
  92         return self._bitmap
  93
  94
  95 # pylint: disable=too-few-public-methods, invalid-name
  96 class Glyph:
  97     """Storage of glyph info"""
  98
  99     def __init__(self, *, bitmap, tile_index, width, height, dx, dy, shift_x, shift_y):
 100         self.bitmap = bitmap
 101         self.width = width
 102         self.height = height
 103         self.dx = dx
 104         self.dy = dy
 105         self.shift_x = shift_x
 106         self.shift_y = shift_y
 107         self.tile_index = tile_index
 108
 109
 110 # pylint: enable=too-few-public-methods, invalid-name