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_H
27#define FLANTERM_H 1
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33#include <stddef.h>
34#include <stdint.h>
35#include <stdbool.h>
36
37#define FLANTERM_MAX_ESC_VALUES 16
38
39#define FLANTERM_CB_DEC 10
40#define FLANTERM_CB_BELL 20
41#define FLANTERM_CB_PRIVATE_ID 30
42#define FLANTERM_CB_STATUS_REPORT 40
43#define FLANTERM_CB_POS_REPORT 50
44#define FLANTERM_CB_KBD_LEDS 60
45#define FLANTERM_CB_MODE 70
46#define FLANTERM_CB_LINUX 80
47
48#define FLANTERM_OOB_OUTPUT_OCRNL (1 << 0)
49#define FLANTERM_OOB_OUTPUT_OFDEL (1 << 1)
50#define FLANTERM_OOB_OUTPUT_OFILL (1 << 2)
51#define FLANTERM_OOB_OUTPUT_OLCUC (1 << 3)
52#define FLANTERM_OOB_OUTPUT_ONLCR (1 << 4)
53#define FLANTERM_OOB_OUTPUT_ONLRET (1 << 5)
54#define FLANTERM_OOB_OUTPUT_ONOCR (1 << 6)
55#define FLANTERM_OOB_OUTPUT_OPOST (1 << 7)
56
57struct flanterm_context {
58 /* internal use */
59
60 size_t tab_size;
61 bool autoflush;
62 bool cursor_enabled;
63 bool scroll_enabled;
64 bool control_sequence;
65 bool escape;
66 bool osc;
67 bool osc_escape;
68 bool rrr;
69 bool discard_next;
70 bool bold;
71 bool bg_bold;
72 bool reverse_video;
73 bool dec_private;
74 bool insert_mode;
75 uint64_t code_point;
76 size_t unicode_remaining;
77 uint8_t g_select;
78 uint8_t charsets[2];
79 size_t current_charset;
80 size_t escape_offset;
81 size_t esc_values_i;
82 size_t saved_cursor_x;
83 size_t saved_cursor_y;
84 size_t current_primary;
85 size_t current_bg;
86 size_t scroll_top_margin;
87 size_t scroll_bottom_margin;
88 uint32_t esc_values[FLANTERM_MAX_ESC_VALUES];
89 uint64_t oob_output;
90 bool saved_state_bold;
91 bool saved_state_bg_bold;
92 bool saved_state_reverse_video;
93 size_t saved_state_current_charset;
94 size_t saved_state_current_primary;
95 size_t saved_state_current_bg;
96
97 /* to be set by backend */
98
99 size_t rows, cols;
100
101 void (*raw_putchar)(struct flanterm_context *, uint8_t c);
102 void (*clear)(struct flanterm_context *, bool move);
103 void (*set_cursor_pos)(struct flanterm_context *, size_t x, size_t y);
104 void (*get_cursor_pos)(struct flanterm_context *, size_t *x, size_t *y);
105 void (*set_text_fg)(struct flanterm_context *, size_t fg);
106 void (*set_text_bg)(struct flanterm_context *, size_t bg);
107 void (*set_text_fg_bright)(struct flanterm_context *, size_t fg);
108 void (*set_text_bg_bright)(struct flanterm_context *, size_t bg);
109 void (*set_text_fg_rgb)(struct flanterm_context *, uint32_t fg);
110 void (*set_text_bg_rgb)(struct flanterm_context *, uint32_t bg);
111 void (*set_text_fg_default)(struct flanterm_context *);
112 void (*set_text_bg_default)(struct flanterm_context *);
113 void (*set_text_fg_default_bright)(struct flanterm_context *);
114 void (*set_text_bg_default_bright)(struct flanterm_context *);
115 void (*move_character)(struct flanterm_context *, size_t new_x, size_t new_y, size_t old_x, size_t old_y);
116 void (*scroll)(struct flanterm_context *);
117 void (*revscroll)(struct flanterm_context *);
118 void (*swap_palette)(struct flanterm_context *);
119 void (*save_state)(struct flanterm_context *);
120 void (*restore_state)(struct flanterm_context *);
121 void (*double_buffer_flush)(struct flanterm_context *);
122 void (*full_refresh)(struct flanterm_context *);
123 void (*deinit)(struct flanterm_context *, void (*)(void *, size_t));
124
125 /* to be set by client */
126
127 void (*callback)(struct flanterm_context *, uint64_t, uint64_t, uint64_t, uint64_t);
128};
129
130void flanterm_context_reinit(struct flanterm_context *ctx);
131void flanterm_write(struct flanterm_context *ctx, const char *buf, size_t count);
132
133#ifdef __cplusplus
134}
135#endif
136
137#endif