1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2009, 2013 The FreeBSD Foundation 5 * 6 * This software was developed by Ed Schouten under sponsorship from the 7 * FreeBSD Foundation. 8 * 9 * Portions of this software were developed by Oleksandr Rybalko 10 * under sponsorship from the FreeBSD Foundation. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * $FreeBSD$ 34 */ 35 36 #ifndef _SYS_FONT_H_ 37 #define _SYS_FONT_H_ 38 39 #include <sys/queue.h> 40 41 /* 42 * Fonts. 43 * 44 * Fonts support normal and bold weights, and single and double width glyphs. 45 * Mapping tables are used to map Unicode points to glyphs. They are sorted by 46 * code point, and vtfont_lookup() uses this to perform a binary search. Each 47 * font has four mapping tables: two weights times two halves (left/single, 48 * right). When a character is not present in a bold map the glyph from the 49 * normal map is used. When no glyph is available, it uses glyph 0, which is 50 * normally equal to U+FFFD. 51 */ 52 53 enum vfnt_map_type { 54 VFNT_MAP_NORMAL = 0, /* Normal font. */ 55 VFNT_MAP_NORMAL_RIGHT, /* Normal font right hand. */ 56 VFNT_MAP_BOLD, /* Bold font. */ 57 VFNT_MAP_BOLD_RIGHT, /* Bold font right hand. */ 58 VFNT_MAPS /* Number of maps. */ 59 }; 60 61 struct font_info { 62 int32_t fi_checksum; 63 uint32_t fi_width; 64 uint32_t fi_height; 65 uint32_t fi_bitmap_size; 66 uint32_t fi_map_count[VFNT_MAPS]; 67 }; 68 69 struct vfnt_map { 70 uint32_t vfm_src; 71 uint16_t vfm_dst; 72 uint16_t vfm_len; 73 } __packed; 74 typedef struct vfnt_map vfnt_map_t; 75 76 struct vt_font { 77 vfnt_map_t *vf_map[VFNT_MAPS]; 78 uint8_t *vf_bytes; 79 uint32_t vf_height; 80 uint32_t vf_width; 81 uint32_t vf_map_count[VFNT_MAPS]; 82 uint32_t vf_refcount; 83 }; 84 85 typedef struct vt_font_bitmap_data { 86 uint32_t vfbd_width; 87 uint32_t vfbd_height; 88 uint32_t vfbd_compressed_size; 89 uint32_t vfbd_uncompressed_size; 90 uint8_t *vfbd_compressed_data; 91 struct vt_font *vfbd_font; 92 } vt_font_bitmap_data_t; 93 94 typedef enum { 95 FONT_AUTO, /* This font is loaded by software */ 96 FONT_MANUAL, /* This font is loaded manually by user */ 97 FONT_BUILTIN, /* This font was built in at compile time */ 98 FONT_RELOAD /* This font is marked to be re-read from file */ 99 } FONT_FLAGS; 100 101 struct fontlist { 102 char *font_name; 103 FONT_FLAGS font_flags; 104 vt_font_bitmap_data_t *font_data; 105 vt_font_bitmap_data_t *(*font_load)(char *); 106 STAILQ_ENTRY(fontlist) font_next; 107 }; 108 109 typedef STAILQ_HEAD(font_list, fontlist) font_list_t; 110 111 #define FONT_HEADER_MAGIC "VFNT0002" 112 struct font_header { 113 uint8_t fh_magic[8]; 114 uint8_t fh_width; 115 uint8_t fh_height; 116 uint16_t fh_pad; 117 uint32_t fh_glyph_count; 118 uint32_t fh_map_count[VFNT_MAPS]; 119 } __packed; 120 121 #endif /* !_SYS_FONT_H_ */ 122