incubator-nuttx/libs/libnx/nxfonts/nxfonts_getfont.c

620 lines
15 KiB
C

/****************************************************************************
* libs/libnx/nxfonts/nxfonts_getfont.c
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <stdint.h>
#include <stddef.h>
#include <debug.h>
#include <nuttx/nx/nx.h>
#include <nuttx/nx/nxfonts.h>
#include "nxfonts.h"
/****************************************************************************
* Private Data
****************************************************************************/
/* MONO */
#ifdef CONFIG_NXFONT_MONO5X8
extern const struct nx_fontpackage_s g_mono5x8_package;
#endif
/* SANS */
#ifdef CONFIG_NXFONT_SANS17X22
extern const struct nx_fontpackage_s g_sans17x22_package;
#endif
#ifdef CONFIG_NXFONT_SANS20X26
extern const struct nx_fontpackage_s g_sans20x26_package;
#endif
#ifdef CONFIG_NXFONT_SANS23X27
extern const struct nx_fontpackage_s g_sans23x27_package;
#endif
#ifdef CONFIG_NXFONT_SANS22X29
extern const struct nx_fontpackage_s g_sans22x29_package;
#endif
#ifdef CONFIG_NXFONT_SANS28X37
extern const struct nx_fontpackage_s g_sans28x37_package;
#endif
#ifdef CONFIG_NXFONT_SANS39X48
extern const struct nx_fontpackage_s g_sans39x48_package;
#endif
/* SANS-BOLD */
#ifdef CONFIG_NXFONT_SANS17X23B
extern const struct nx_fontpackage_s g_sans17x23b_package;
#endif
#ifdef CONFIG_NXFONT_SANS20X27B
extern const struct nx_fontpackage_s g_sans20x27b_package;
#endif
#ifdef CONFIG_NXFONT_SANS22X29B
extern const struct nx_fontpackage_s g_sans22x29b_package;
#endif
#ifdef CONFIG_NXFONT_SANS28X37B
extern const struct nx_fontpackage_s g_sans28x37b_package;
#endif
#ifdef CONFIG_NXFONT_SANS40X49B
extern const struct nx_fontpackage_s g_sans40x49b_package;
#endif
/* SERIF */
#ifdef CONFIG_NXFONT_SERIF22X29
extern const struct nx_fontpackage_s g_serif22x29_package;
#endif
#ifdef CONFIG_NXFONT_SERIF29X37
extern const struct nx_fontpackage_s g_serif29x37_package;
#endif
#ifdef CONFIG_NXFONT_SERIF38X48
extern const struct nx_fontpackage_s g_serif38x48_package;
#endif
/* SERIF-BOLD */
#ifdef CONFIG_NXFONT_SERIF22X28B
extern const struct nx_fontpackage_s g_serif22x28b_package;
#endif
#ifdef CONFIG_NXFONT_SERIF27X38B
extern const struct nx_fontpackage_s g_serif27x38b_package;
#endif
#ifdef CONFIG_NXFONT_SERIF38X48
extern const struct nx_fontpackage_s g_serif38x48_package;
#endif
#ifdef CONFIG_NXFONT_SERIF38X49B
extern const struct nx_fontpackage_s g_serif38x49b_package;
#endif
/* Pixel fonts */
#ifdef CONFIG_NXFONT_PIXEL_UNICODE
extern const struct nx_fontpackage_s g_pixel_unicode_package;
#endif
#ifdef CONFIG_NXFONT_PIXEL_LCD_MACHINE
extern const struct nx_fontpackage_s g_pixel_lcd_machine_package;
#endif
/* X11 misc fixed fonts */
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_4X6
extern const struct nx_fontpackage_s g_x11_misc_fixed_4x6_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_5X7
extern const struct nx_fontpackage_s g_x11_misc_fixed_5x7_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_5X8
extern const struct nx_fontpackage_s g_x11_misc_fixed_5x8_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X9
extern const struct nx_fontpackage_s g_x11_misc_fixed_6x9_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X10
extern const struct nx_fontpackage_s g_x11_misc_fixed_6x10_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X12
extern const struct nx_fontpackage_s g_x11_misc_fixed_6x12_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X13
extern const struct nx_fontpackage_s g_x11_misc_fixed_6x13_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X13B
extern const struct nx_fontpackage_s g_x11_misc_fixed_6x13b_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X13O
extern const struct nx_fontpackage_s g_x11_misc_fixed_6x13o_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X13
extern const struct nx_fontpackage_s g_x11_misc_fixed_7x13_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X13B
extern const struct nx_fontpackage_s g_x11_misc_fixed_7x13b_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X13O
extern const struct nx_fontpackage_s g_x11_misc_fixed_7x13o_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X14
extern const struct nx_fontpackage_s g_x11_misc_fixed_7x14_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X14B
extern const struct nx_fontpackage_s g_x11_misc_fixed_7x14b_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_8X13
extern const struct nx_fontpackage_s g_x11_misc_fixed_8x13_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_8X13B
extern const struct nx_fontpackage_s g_x11_misc_fixed_8x13b_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_8X13O
extern const struct nx_fontpackage_s g_x11_misc_fixed_8x13o_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X15
extern const struct nx_fontpackage_s g_x11_misc_fixed_9x15_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X15B
extern const struct nx_fontpackage_s g_x11_misc_fixed_9x15b_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X18
extern const struct nx_fontpackage_s g_x11_misc_fixed_9x18_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X18B
extern const struct nx_fontpackage_s g_x11_misc_fixed_9x18b_package;
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_10X20
extern const struct nx_fontpackage_s g_x11_misc_fixed_10x20_package;
#endif
#ifdef CONFIG_NXFONT_TOM_THUMB_4X6
extern const struct nx_fontpackage_s g_tom_thumb_4x6_package;
#endif
static FAR const struct nx_fontpackage_s *g_fontpackages[] =
{
/* MONO */
#ifdef CONFIG_NXFONT_MONO5X8
&g_mono5x8_package,
#endif
/* SANS */
#ifdef CONFIG_NXFONT_SANS17X22
&g_sans17x22_package,
#endif
#ifdef CONFIG_NXFONT_SANS20X26
&g_sans20x26_package,
#endif
#ifdef CONFIG_NXFONT_SANS23X27
&g_sans23x27_package,
#endif
#ifdef CONFIG_NXFONT_SANS22X29
&g_sans22x29_package,
#endif
#ifdef CONFIG_NXFONT_SANS28X37
&g_sans28x37_package,
#endif
#ifdef CONFIG_NXFONT_SANS39X48
&g_sans39x48_package,
#endif
/* SANS-BOLD */
#ifdef CONFIG_NXFONT_SANS17X23B
&g_sans17x23b_package,
#endif
#ifdef CONFIG_NXFONT_SANS20X27B
&g_sans20x27b_package,
#endif
#ifdef CONFIG_NXFONT_SANS22X29B
&g_sans22x29b_package,
#endif
#ifdef CONFIG_NXFONT_SANS28X37B
&g_sans28x37b_package,
#endif
#ifdef CONFIG_NXFONT_SANS40X49B
&g_sans40x49b_package,
#endif
/* SERIF */
#ifdef CONFIG_NXFONT_SERIF22X29
&g_serif22x29_package,
#endif
#ifdef CONFIG_NXFONT_SERIF29X37
&g_serif29x37_package,
#endif
#ifdef CONFIG_NXFONT_SERIF38X48
&g_serif38x48_package,
#endif
/* SERIF-BOLD */
#ifdef CONFIG_NXFONT_SERIF22X28B
&g_serif22x28b_package,
#endif
#ifdef CONFIG_NXFONT_SERIF27X38B
&g_serif27x38b_package,
#endif
#ifdef CONFIG_NXFONT_SERIF38X49B
&g_serif38x49b_package,
#endif
/* Pixel fonts */
#ifdef CONFIG_NXFONT_PIXEL_UNICODE
&g_pixel_unicode_package,
#endif
#ifdef CONFIG_NXFONT_PIXEL_LCD_MACHINE
&g_pixel_lcd_machine_package,
#endif
/* X11 misc fixed fonts */
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_4X6
&g_x11_misc_fixed_4x6_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_5X7
&g_x11_misc_fixed_5x7_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_5X8
&g_x11_misc_fixed_5x8_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X9
&g_x11_misc_fixed_6x9_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X10
&g_x11_misc_fixed_6x10_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X12
&g_x11_misc_fixed_6x12_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X13
&g_x11_misc_fixed_6x13_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X13B
&g_x11_misc_fixed_6x13b_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_6X13O
&g_x11_misc_fixed_6x13o_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X13
&g_x11_misc_fixed_7x13_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X13B
&g_x11_misc_fixed_7x13b_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X13O
&g_x11_misc_fixed_7x13o_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X14
&g_x11_misc_fixed_7x14_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_7X14B
&g_x11_misc_fixed_7x14b_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_8X13
&g_x11_misc_fixed_8x13_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_8X13B
&g_x11_misc_fixed_8x13b_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_8X13O
&g_x11_misc_fixed_8x13o_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X15
&g_x11_misc_fixed_9x15_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X15B
&g_x11_misc_fixed_9x15b_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X18
&g_x11_misc_fixed_9x18_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_9X18B
&g_x11_misc_fixed_9x18b_package,
#endif
#ifdef CONFIG_NXFONT_X11_MISC_FIXED_10X20
&g_x11_misc_fixed_10x20_package,
#endif
/* Tom Thumb mono-space 4x6 font */
#ifdef CONFIG_NXFONT_TOM_THUMB_4X6
&g_tom_thumb_4x6_package,
#endif
NULL
};
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: nxf_getglyphset
*
* Description:
* Return information about the font set contained in the selected
* character encoding.
*
* Input Parameters:
* ch: character code
* package: The selected font package
*
****************************************************************************/
static inline FAR const struct nx_fontset_s *
nxf_getglyphset(uint16_t ch, FAR const struct nx_fontpackage_s *package)
{
FAR const struct nx_fontset_s *fontset;
/* Select the 7- or 8-bit font set */
if (ch < 128)
{
/* Select the 7-bit font set */
fontset = &package->font7;
}
else if (ch < 256)
{
#if CONFIG_NXFONTS_CHARBITS >= 8
/* Select the 8-bit font set */
fontset = &package->font8;
#else
gwarn("WARNING: 8-bit font support disabled: %d\n", ch);
return NULL;
#endif
}
else
{
/* Someday, perhaps 16-bit fonts will go here */
gwarn("WARNING: 16-bit font not currently supported\n");
return NULL;
}
/* Then verify that the character actually resides in the font */
if (ch >= fontset->first && ch < fontset->first +fontset->nchars)
{
return fontset;
}
/* Too much debug output for the case of space which never resides in the
* font.
*/
if (ch != ' ' && ch != '\t' && ch != '\n' && ch != '\r')
{
gwarn("WARNING: No bitmap for code %02x\n", ch);
}
return NULL;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nxf_getfonthandle
*
* Description:
* Given a numeric font ID, return a handle that may be subsequently be
* used to access the font data sets.
*
* Input Parameters:
* fontid: Identifies the font set to get
*
****************************************************************************/
NXHANDLE nxf_getfonthandle(enum nx_fontid_e fontid)
{
FAR const struct nx_fontpackage_s **pkglist;
FAR const struct nx_fontpackage_s *package;
FAR const struct nx_fontpackage_s *defpkg = NULL;
/* Handle the default font package */
if (fontid == FONTID_DEFAULT)
{
fontid = NXFONT_DEFAULT;
}
/* Then search for the font package with this ID */
for (pkglist = g_fontpackages; *pkglist; pkglist++)
{
/* Is this the package with the matching font ID? */
package = *pkglist;
if (package->id == fontid)
{
/* Yes.. return a pointer to the package as the handle */
return (NXHANDLE)package;
}
/* No.. is it the default font? */
else if (package->id == NXFONT_DEFAULT)
{
/* Yes.. save the pointer to the default font. We will return the
* default font if the requested font cannot be found.
*/
defpkg = package;
}
}
/* Return a pointer to the default font as the handle. */
return (NXHANDLE)defpkg;
}
/****************************************************************************
* Name: nxf_getfontset
*
* Description:
* Return information about the current font set
*
* Input Parameters:
* handle: A font handle previously returned by nxf_getfonthandle
*
****************************************************************************/
FAR const struct nx_font_s *nxf_getfontset(NXHANDLE handle)
{
FAR const struct nx_fontpackage_s *package =
(FAR const struct nx_fontpackage_s *)handle;
/* Find the font package associated with this font ID */
if (package)
{
/* Found... return the font set metrics for this font package */
return &package->metrics;
}
return NULL;
}
/****************************************************************************
* Name: nxf_getbitmap
*
* Description:
* Return font bitmap information for the selected character encoding.
*
* Input Parameters:
* handle: A font handle previously returned by nxf_getfonthandle
* ch: Character code whose bitmap is requested
*
* Returned Value:
* An instance of struct nx_fontbitmap_s describing the glyph.
*
****************************************************************************/
FAR const struct nx_fontbitmap_s *nxf_getbitmap(NXHANDLE handle, uint16_t ch)
{
FAR const struct nx_fontpackage_s *package =
(FAR const struct nx_fontpackage_s *)handle;
FAR const struct nx_fontset_s *fontset;
FAR const struct nx_fontbitmap_s *bm = NULL;
/* Verify that the handle is a font package */
if (package)
{
/* Now get the fontset from the package */
fontset = nxf_getglyphset(ch, package);
if (fontset)
{
/* Then get the bitmap from the font set */
bm = &fontset->bitmap[ch - fontset->first];
}
}
return bm;
}