Fast and reasonably complete (framebuffer) terminal emulator (Zig fork)
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_PRIVATE_H 27#define FLANTERM_FB_PRIVATE_H 1 28 29#ifndef FLANTERM_IN_FLANTERM 30#error "Do not use fb_private.h. Use interfaces defined in fb.h only." 31#endif 32 33#include <stdint.h> 34#include <stddef.h> 35#include <stdbool.h> 36 37#ifdef __cplusplus 38extern "C" { 39#endif 40 41#define FLANTERM_FB_FONT_GLYPHS 256 42 43struct flanterm_fb_char { 44 uint32_t c; 45 uint32_t fg; 46 uint32_t bg; 47}; 48 49struct flanterm_fb_queue_item { 50 size_t x, y; 51 struct flanterm_fb_char c; 52}; 53 54struct flanterm_fb_context { 55 struct flanterm_context term; 56 57 void (*plot_char)(struct flanterm_context *ctx, struct flanterm_fb_char *c, size_t x, size_t y); 58 59 size_t font_width; 60 size_t font_height; 61 size_t glyph_width; 62 size_t glyph_height; 63 64 size_t font_scale_x; 65 size_t font_scale_y; 66 67 size_t offset_x, offset_y; 68 69 volatile uint32_t *framebuffer; 70 size_t pitch; 71 size_t width; 72 size_t height; 73 size_t bpp; 74 75 uint8_t red_mask_size, red_mask_shift; 76 uint8_t green_mask_size, green_mask_shift; 77 uint8_t blue_mask_size, blue_mask_shift; 78 79 size_t font_bits_size; 80 uint8_t *font_bits; 81 size_t font_bool_size; 82 bool *font_bool; 83 84 uint32_t ansi_colours[8]; 85 uint32_t ansi_bright_colours[8]; 86 uint32_t default_fg, default_bg; 87 uint32_t default_fg_bright, default_bg_bright; 88 89 size_t canvas_size; 90 uint32_t *canvas; 91 92 size_t grid_size; 93 size_t queue_size; 94 size_t map_size; 95 96 struct flanterm_fb_char *grid; 97 98 struct flanterm_fb_queue_item *queue; 99 size_t queue_i; 100 101 struct flanterm_fb_queue_item **map; 102 103 uint32_t text_fg; 104 uint32_t text_bg; 105 size_t cursor_x; 106 size_t cursor_y; 107 108 uint32_t saved_state_text_fg; 109 uint32_t saved_state_text_bg; 110 size_t saved_state_cursor_x; 111 size_t saved_state_cursor_y; 112 113 size_t old_cursor_x; 114 size_t old_cursor_y; 115}; 116 117#ifdef __cplusplus 118} 119#endif 120 121#endif