vsf_fbcon.h

Go to the documentation of this file.

#ifndef __VSF_FBCON_H__
#define __VSF_FBCON_H__
 
/*============================ INCLUDES ======================================*/
 
#include "component/ui/vsf_ui_cfg.h"
 
#if VSF_USE_UI == ENABLED
 
#include "component/ui/disp/vsf_disp.h"
#include "service/simple_stream/vsf_simple_stream.h"
 
#if     defined(__VSF_FBCON_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_FBCON_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#ifndef VSF_FBCON_CFG_FONT_WIDTH
#   define VSF_FBCON_CFG_FONT_WIDTH         8
#endif
#ifndef VSF_FBCON_CFG_FONT_HEIGHT
#   define VSF_FBCON_CFG_FONT_HEIGHT        16
#endif
 
#ifndef VSF_FBCON_CFG_TAB_WIDTH
#   define VSF_FBCON_CFG_TAB_WIDTH          8
#endif
 
// Maximum rows supported by the dirty-row bitmask (uint32_t)
#define VSF_FBCON_MAX_ROWS                  32
 
/*============================ TYPES =========================================*/
 
vsf_class(vsf_fbcon_t) {
    public_member(
        vk_disp_t *disp;            // display device, MUST be set before init
        vsf_stream_t *stream;       // input byte stream, MUST be set before init
    )
    private_member(
        bool disp_ready;
        volatile bool refresh_busy;
        uint32_t dirty_rows;        // bitmask of rows that need refresh
 
        void *line_buf;             // one-text-row pixel buffer
 
        int cols, rows;
        int cursor_x, cursor_y;
 
        uint8_t ansi_state;
        uint8_t ansi_buf[16];
        uint8_t ansi_idx;
        uint8_t ansi_params[4];
        uint8_t ansi_param_count;
 
        uint8_t cur_fg;             // palette index (0-15)
        uint8_t cur_bg;             // palette index (0-15)
        bool cur_bold;
        bool cur_reverse;
 
        uint32_t palette[16];       // format-specific pixel values
 
        struct {
            uint8_t ch;
            uint8_t fg;             // palette index
            uint8_t bg;             // palette index
        } *char_grid;
    )
};
 
/*============================ GLOBAL VARIABLES ==============================*/
 
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vsf_fbcon_init(vsf_fbcon_t *fbcon);
 
extern void vsf_fbcon_fini(vsf_fbcon_t *fbcon);
 
#ifdef __cplusplus
}
#endif
 
#endif  // VSF_USE_UI
#endif  // __VSF_FBCON_H__