-# 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`
================================================================================
"""
-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()
- ascii_chars = ""
- for character in range(0x20, 0x7F):
- ascii_chars += chr(character)
- self._font.getmask(ascii_chars)
- bmp_size = self._font.getsize(ascii_chars)
- self._bitmap = Bitmap(bmp_size[0], bmp_size[1], 2)
- ascii_mask = self._font.getmask(ascii_chars, mode="1")
- for x in range(bmp_size[0]):
- for y in range(bmp_size[1]):
- self._bitmap[x, y] = 1 if ascii_mask.getpixel((x, y)) else 0
-
- def _get_glyph_index(self, charcode):
- if 0x20 <= charcode <= 0x7E:
- return charcode - 0x20
- return None
-
- def get_bounding_box(self):
+ self._width = 0
+ self._height = 0
+
+ # Place import here to avoid circular import
+ from adafruit_bitmap_font import ( # pylint: disable=import-outside-toplevel
+ bitmap_font,
+ )
+
+ 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."""
- bounding_box = self._font.getsize(chr(codepoint))
- return Glyph(
- bitmap=self._bitmap,
- tile_index=self._get_glyph_index(codepoint),
- width=bounding_box[0],
- height=bounding_box[1],
- dx=0,
- dy=0,
- shift_x=0,
- shift_y=0,
- )
+ return self._font.get_glyph(codepoint)
@property
def bitmap(self):
`get_glyph` in most cases. This is useful for use with `displayio.TileGrid` and
`terminalio.Terminal`.
"""
- return self._bitmap
+ return self._font.bitmap_class
+@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
+ bitmap: Bitmap
+ tile_index: int
+ width: int
+ height: int
+ dx: int
+ dy: int
+ shift_x: int
+ shift_y: int
projects / hackapet / Adafruit_Blinka_Displayio.git / blobdiff