gui_display.h

Go to the documentation of this file.

// Copyright 2024-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
#include <satcat5/gui_icons.h>
#include <satcat5/log.h>
#include <satcat5/pkt_buffer.h>
#include <satcat5/polling.h>
 
namespace satcat5 {
    namespace gui {
        struct Cursor { // GCOVR_EXCL_LINE
            u16 r;      
            u16 c;      
            u32 fg;     
            u32 bg;     
 
            Cursor() = default;
            Cursor(const Cursor& t) = default;
            Cursor& operator=(const Cursor& t) = default;
        };
 
        union DrawArg {
            const void* ptr;    
            u32 color;          
            s16 scroll;         
            u32 count;          
            u16 rc[2];          
 
            DrawArg() = default;
            DrawArg(const DrawArg& t) = default;
            DrawArg& operator=(const DrawArg& t) = default;
        };
 
        class DrawCmd {
        public:
            constexpr DrawCmd()
                : m_opcode(0), m_arg1(0), m_arg2{.ptr = 0} {}
            constexpr DrawCmd(u8 opcode, u8 arg1, const DrawArg& arg2)
                : m_opcode(opcode), m_arg1(arg1), m_arg2(arg2) {}
 
            bool rc(u16 r, u16 c) const;
 
            u16 height() const;
            u16 width() const;
 
        protected:
            friend satcat5::gui::Canvas;
 
            // Shortcuts for typecasting the "m_arg2.ptr" argument.
            inline const satcat5::gui::Icon8x8* icon8() const
                { return (const Icon8x8*)m_arg2.ptr; }
            inline const satcat5::gui::Icon16x16* icon16() const
                { return (const Icon16x16*)m_arg2.ptr; }
            inline const satcat5::gui::Icon32x32* icon32() const
                { return (const Icon32x32*)m_arg2.ptr; }
 
            void update(Cursor& cursor) const;
 
            u8 m_opcode;                    // Command opcode (e.g., "draw icon")
            u8 m_arg1;                      // Argument 1 (varies by opcode)
            satcat5::gui::DrawArg m_arg2;   // Argument 2 (varies by opcode)
        };
 
        class Display {
        public:
            virtual bool draw(
                const satcat5::gui::Cursor& cursor,
                const satcat5::gui::DrawCmd& cmd) = 0;
 
            virtual bool scroll(s16 rows)   { return true; }
 
            inline u16 height() const       { return m_height; }
            inline u16 width() const        { return m_width; }
 
        protected:
            Display(u16 h, u16 w) : m_height(h), m_width(w) {}
            ~Display() {}
 
            const u16 m_height, m_width;
        };
 
        class Canvas : public satcat5::poll::OnDemand {
        public:
            explicit Canvas(satcat5::gui::Display* display);
 
            Canvas(satcat5::gui::Display* display, u8* buffer, unsigned bsize);
 
            bool color_fg(u32 color);
            bool color_bg(u32 color);
            bool cursor(u16 r, u16 c);
 
            bool clear(u32 color);
 
            bool draw_icon(const satcat5::gui::Icon8x8* icon, u8 mag = 1);
            bool draw_icon(const satcat5::gui::Icon16x16* icon, u8 mag = 1);
            bool draw_icon(const satcat5::gui::Icon32x32* icon, u8 mag = 1);
 
            bool draw_rect(u16 h, u16 w, bool fg = true);
 
            u16 draw_text(const char* msg,
                const satcat5::gui::Font8x8& font = BASIC_FONT, u8 mag = 1);
            u16 draw_text(const char* msg,
                const satcat5::gui::Font16x16& font, u8 mag = 1);
            u16 draw_text(const char* msg,
                const satcat5::gui::Font32x32& font, u8 mag = 1);
 
            u16 raw_text(const char* msg,
                const satcat5::gui::Font8x8& font = BASIC_FONT, u8 mag = 1);
            u16 raw_text(const char* msg,
                const satcat5::gui::Font16x16& font, u8 mag = 1);
            u16 raw_text(const char* msg,
                const satcat5::gui::Font32x32& font, u8 mag = 1);
 
            bool scroll(s16 rows);
 
            // Other accessors.
            inline const satcat5::gui::Cursor& cursor() const
                { return m_cursor_draw; }
            inline satcat5::gui::Display* display()
                { return m_display; }
            inline u16 height() const
                { return m_display->height(); }
            inline u16 width() const
                { return m_display->width(); }
 
        protected:
            bool cmd_retry();
            bool draw_char(char ch, const satcat5::gui::DrawCmd& cmd, u16& total_rows);
            bool draw_eol(u16 height, u16& total_rows);
            bool enqueue(const satcat5::gui::DrawCmd& cmd);
            bool execute(const satcat5::gui::DrawCmd& cmd);
            bool finalize();
            void poll_demand() override;
 
            satcat5::gui::Display* const m_display; // Pointer to display device.
            satcat5::gui::Cursor m_cursor_draw;     // Device draw position
            satcat5::gui::Cursor m_cursor_user;     // User-API draw position
            satcat5::gui::DrawCmd m_cmd_retry;      // Retry current command?
            satcat5::io::PacketBuffer m_buffer;     // Optional command queue
        };
 
        struct LogColors {
            u32 bg_text,  fg_text;
            u32 bg_error, fg_error;
            u32 bg_warn,  fg_warn;
            u32 bg_info,  fg_info;
            u32 bg_debug, fg_debug;
 
            LogColors() = default;
            LogColors(const LogColors& t) = default;
            LogColors& operator=(const LogColors& t) = default;
        };
 
        class LogToDisplay final : public satcat5::log::EventHandler {
        public:
            LogToDisplay(
                satcat5::gui::Canvas* canvas,
                const satcat5::gui::LogColors& colors,
                u16 row_min = 0, u16 row_count = 0);
 
            void log_event(s8 priority, unsigned nbytes, const char* msg) override;
 
            inline void set_colors(const satcat5::gui::LogColors& colors)
                { m_colors = colors; }
 
        protected:
            satcat5::gui::Canvas* const m_canvas;
            satcat5::gui::LogColors m_colors;
            const u16 m_row_min, m_row_count;
            u16 m_row_next;
        };
    }
}