Fast and reasonably complete (framebuffer) terminal emulator (Zig fork)
pci.express
1/* Copyright (C) 2022-2025 mintsuki and contributors.
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain the above copyright notice,
7 * this list of conditions and the following disclaimer.
8 *
9 * 2. Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
17 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 * POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef FLANTERM_FB_H
27#define FLANTERM_FB_H 1
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33#include <stdint.h>
34#include <stddef.h>
35#include <stdbool.h>
36
37#include "../flanterm.h"
38
39#define FLANTERM_FB_FONT_GLYPHS 256
40
41struct flanterm_fb_char {
42 uint32_t c;
43 uint32_t fg;
44 uint32_t bg;
45};
46
47struct flanterm_fb_queue_item {
48 size_t x, y;
49 struct flanterm_fb_char c;
50};
51
52struct flanterm_fb_context {
53 struct flanterm_context term;
54
55 void (*plot_char)(struct flanterm_context *ctx, struct flanterm_fb_char *c, size_t x, size_t y);
56
57 size_t font_width;
58 size_t font_height;
59 size_t glyph_width;
60 size_t glyph_height;
61
62 size_t font_scale_x;
63 size_t font_scale_y;
64
65 size_t offset_x, offset_y;
66
67 volatile uint32_t *framebuffer;
68 size_t pitch;
69 size_t width;
70 size_t height;
71 size_t bpp;
72
73 uint8_t red_mask_size, red_mask_shift;
74 uint8_t green_mask_size, green_mask_shift;
75 uint8_t blue_mask_size, blue_mask_shift;
76
77 size_t font_bits_size;
78 uint8_t *font_bits;
79 size_t font_bool_size;
80 bool *font_bool;
81
82 uint32_t ansi_colours[8];
83 uint32_t ansi_bright_colours[8];
84 uint32_t default_fg, default_bg;
85 uint32_t default_fg_bright, default_bg_bright;
86
87 size_t canvas_size;
88 uint32_t *canvas;
89
90 size_t grid_size;
91 size_t queue_size;
92 size_t map_size;
93
94 struct flanterm_fb_char *grid;
95
96 struct flanterm_fb_queue_item *queue;
97 size_t queue_i;
98
99 struct flanterm_fb_queue_item **map;
100
101 uint32_t text_fg;
102 uint32_t text_bg;
103 size_t cursor_x;
104 size_t cursor_y;
105
106 uint32_t saved_state_text_fg;
107 uint32_t saved_state_text_bg;
108 size_t saved_state_cursor_x;
109 size_t saved_state_cursor_y;
110
111 size_t old_cursor_x;
112 size_t old_cursor_y;
113};
114
115struct flanterm_context *flanterm_fb_init(
116 /* If _malloc and _free are nulled, use the bump allocated instance (1 use only). */
117 void *(*_malloc)(size_t),
118 void (*_free)(void *, size_t),
119 uint32_t *framebuffer, size_t width, size_t height, size_t pitch,
120 uint8_t red_mask_size, uint8_t red_mask_shift,
121 uint8_t green_mask_size, uint8_t green_mask_shift,
122 uint8_t blue_mask_size, uint8_t blue_mask_shift,
123 uint32_t *canvas, /* If nulled, no canvas. */
124 uint32_t *ansi_colours, uint32_t *ansi_bright_colours, /* If nulled, default. */
125 uint32_t *default_bg, uint32_t *default_fg, /* If nulled, default. */
126 uint32_t *default_bg_bright, uint32_t *default_fg_bright, /* If nulled, default. */
127 /* If font is null, use default font and font_width and font_height ignored. */
128 void *font, size_t font_width, size_t font_height, size_t font_spacing,
129 /* If scale_x and scale_y are 0, automatically scale font based on resolution. */
130 size_t font_scale_x, size_t font_scale_y,
131 size_t margin
132);
133
134#ifdef __cplusplus
135}
136#endif
137
138#endif