MaxOS::console::FramebufferConsole Class Reference

Handles the printing of characters and strings to the screen using a framebuffer. More...

#include <framebuffer.h>

Inheritance diagram for MaxOS::console::FramebufferConsole:

Public Member Functions
	FramebufferConsole (multiboot_tag_framebuffer *framebuffer_info)
	Constructs a new VESA Boot Console object, initializing the console area for text output.
uint16_t	width () final
	Gets the width of the console.
uint16_t	height () final
	Gets the height of the console.
void	finish () const
	Cleans up the boot console.
void	put_character (uint16_t x, uint16_t y, char) final
	Places a character at the specified location.
void	set_foreground_color (uint16_t x, uint16_t y, common::ConsoleColour) final
	Sets the foreground color at the specified location.
void	set_background_color (uint16_t x, uint16_t y, common::ConsoleColour) final
	Sets the background color at the specified location.
void	scroll_up (uint16_t left, uint16_t top, uint16_t width, uint16_t height, common::ConsoleColour foreground, common::ConsoleColour background, char fill) final
	Scrolls the console up by 1 line.
char	get_character (uint16_t x, uint16_t y) final
	Gets the character at the specified location.
common::ConsoleColour	get_foreground_color (uint16_t x, uint16_t y) final
	Gets the foreground color at the specified location.
common::ConsoleColour	get_background_color (uint16_t x, uint16_t y) final
	Gets the background color at the specified location.
Public Member Functions inherited from MaxOS::console::Console
virtual void	put_character (uint16_t x, uint16_t y, char c, common::ConsoleColour foreground, common::ConsoleColour background)
	Put a character on the console with a given foreground and background color.
virtual void	put_string (uint16_t x, uint16_t y, string string, common::ConsoleColour foreground=common::ConsoleColour::LightGrey, common::ConsoleColour background=common::ConsoleColour::Black)
	Put a string on the console.
virtual void	scroll_up ()
	Scroll the entire console up by 1 line.
virtual void	clear ()
virtual void	clear (uint16_t left, uint16_t top, uint16_t width, uint16_t height, common::ConsoleColour foreground=common::ConsoleColour::LightGrey, common::ConsoleColour background=common::ConsoleColour::Black, char fill=' ')
	Clear an area of the console.
virtual void	invert_colors (uint16_t x, uint16_t y)
	Invert the colors of a character on the console.

Static Public Member Functions
static void	print_logo (bool is_panic=false)
	Prints the logo to the center of the screen.
static void	update_progress_bar (uint8_t percentage)
	Updates the progress bar.

Public Attributes
ConsoleStream *	cout
	The boot console output stream.

Detailed Description

Handles the printing of characters and strings to the screen using a framebuffer.

Definition at line 295 of file framebuffer.h.

Constructor & Destructor Documentation

FramebufferConsole()

FramebufferConsole::FramebufferConsole ( multiboot_tag_framebuffer *  framebuffer_info )

explicit

Constructs a new VESA Boot Console object, initializing the console area for text output.

Parameters

framebuffer_info

The frame buffer to draw text onto

Definition at line 25 of file framebuffer.cpp.

{
 
    // Save the framebuffer info
    s_framebuffer_info  = framebuffer_info;
    m_framebuffer_bpp   = s_framebuffer_info->common.framebuffer_bpp;
    m_framebuffer_pitch = s_framebuffer_info->common.framebuffer_pitch;
    m_framebuffer_size  = s_framebuffer_info->common.framebuffer_height * m_framebuffer_pitch;
    Logger::DEBUG() << "Framebuffer: bpp=" << m_framebuffer_bpp << ", pitch=" << m_framebuffer_pitch << ", size=" << m_framebuffer_size << "\n";
 
    // Map the frame buffer into the higher half
    auto physical_address = (uint64_t) s_framebuffer_info->common.framebuffer_addr;
    m_framebuffer_address = (uint64_t *) PhysicalMemoryManager::to_dm_region(physical_address);
    PhysicalMemoryManager::s_current_manager->map_area((physical_address_t *) physical_address, m_framebuffer_address, m_framebuffer_size, WRITE | PRESENT);
 
    // Reserve the physical memory
    size_t pages = PhysicalMemoryManager::size_to_frames(m_framebuffer_size);
    PhysicalMemoryManager::s_current_manager->reserve(s_framebuffer_info->common.framebuffer_addr, pages, "Framebuffer");
 
    // Log info
    Logger::DEBUG() << "Framebuffer address: physical=0x" << (uint64_t) physical_address << ", virtual=0x" << (uint64_t) m_framebuffer_address << "\n";
    Logger::DEBUG() << "Framebuffer mapped: 0x" << (uint64_t) m_framebuffer_address << " - 0x" << (uint64_t) (m_framebuffer_address + m_framebuffer_size) << " (pages: " << pages << ")\n";
 
    // Prepare the console
    m_video_memory_meta = (uint16_t*) MemoryManager::kmalloc(width() * height() * sizeof(uint16_t));
    FramebufferConsole::clear();
    print_logo();
 
    // Set up the output area
    m_console_area = new ConsoleArea(this, 0, 0, width() / 2 - 25, height(), ConsoleColour::DarkGrey, ConsoleColour::Black);
    cout = new ConsoleStream(m_console_area);
 
    // Only log to the screen when debugging
#ifndef NDEBUG
    Logger::active_logger()->add_log_writer(cout);
    Logger::INFO() << "Console Stream set up \n";
#endif
}

References MaxOS::Logger::active_logger(), MaxOS::Logger::add_log_writer(), MaxOS::console::Console::clear(), multiboot_tag_framebuffer::common, cout, MaxOS::Logger::DEBUG(), multiboot_tag_framebuffer_common::framebuffer_addr, multiboot_tag_framebuffer_common::framebuffer_bpp, multiboot_tag_framebuffer_common::framebuffer_height, multiboot_tag_framebuffer_common::framebuffer_pitch, height(), MaxOS::Logger::INFO(), MaxOS::memory::MemoryManager::kmalloc(), MaxOS::memory::PhysicalMemoryManager::map_area(), MaxOS::memory::PRESENT, print_logo(), MaxOS::memory::PhysicalMemoryManager::reserve(), MaxOS::memory::PhysicalMemoryManager::s_current_manager, MaxOS::memory::PhysicalMemoryManager::size_to_frames(), MaxOS::memory::PhysicalMemoryManager::to_dm_region(), width(), and MaxOS::memory::WRITE.

Member Function Documentation

finish()

void FramebufferConsole::finish

(

)

const

Cleans up the boot console.

Definition at line 379 of file framebuffer.cpp.

                                      {
 
    // Done
    Logger::HEADER() << "MaxOS Kernel Successfully Booted\n" << ANSI_COLOURS[ANSIColour::Reset];
    cout->set_cursor(0, 0);
    Logger::active_logger()->disable_log_writer(cout);
}

References MaxOS::Logger::active_logger(), cout, MaxOS::Logger::disable_log_writer(), MaxOS::Logger::HEADER(), and MaxOS::console::ConsoleStream::set_cursor().

Referenced by kernel_main().

get_background_color()

ConsoleColour FramebufferConsole::get_background_color ( uint16_t  x, uint16_t  y  )

finalvirtual

Gets the background color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate

Returns

The background color at the specified location or black if the coordinates are out of bounds

Reimplemented from MaxOS::console::Console.

Definition at line 259 of file framebuffer.cpp.

                                                                             {
 
    if(CPU::panic_lock.is_locked())
        return ConsoleColour::Red;
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return ConsoleColour::Black;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Return the background color at the offset, by masking the background color with the current background color (bits 12-15)
    return (ConsoleColour) ((m_video_memory_meta[offset] & 0xF000) >> 12);
}

References height(), MaxOS::system::CPU::panic_lock, and width().

Referenced by put_character(), and scroll_up().

get_character()

char FramebufferConsole::get_character ( uint16_t  x, uint16_t  y  )

finalvirtual

Gets the character at the specified location.

Parameters

x	The x coordinate
y	The y coordinate

Returns

The character at the specified location or a space if the coordinates are out of bounds

Reimplemented from MaxOS::console::Console.

Definition at line 216 of file framebuffer.cpp.

                                                             {
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return ' ';
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Return the character at the offset, by masking the character with the current character (last 8 bits)
    return (char) (m_video_memory_meta[offset] & 0x00FF);
}

References height(), and width().

get_foreground_color()

ConsoleColour FramebufferConsole::get_foreground_color ( uint16_t  x, uint16_t  y  )

finalvirtual

Gets the foreground color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate

Returns

The foreground color at the specified location or white if the coordinates are out of bounds

Reimplemented from MaxOS::console::Console.

Definition at line 236 of file framebuffer.cpp.

                                                                             {
 
    if(CPU::panic_lock.is_locked())
        return ConsoleColour::White;
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return ConsoleColour::White;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Return the foreground color at the offset, by masking the foreground color with the current foreground color (bits 8-11)
    return (ConsoleColour) ((m_video_memory_meta[offset] & 0x0F00) >> 8);
}

References height(), MaxOS::system::CPU::panic_lock, and width().

Referenced by put_character(), and scroll_up().

height()

uint16_t FramebufferConsole::height ( )

finalvirtual

Gets the height of the console.

Returns

The height of the console in characters

Reimplemented from MaxOS::console::Console.

Definition at line 80 of file framebuffer.cpp.

                                    {
    return s_framebuffer_info->common.framebuffer_height / FONT_HEIGHT;
}

References multiboot_tag_framebuffer::common, MaxOS::console::FONT_HEIGHT, and multiboot_tag_framebuffer_common::framebuffer_height.

Referenced by FramebufferConsole(), get_background_color(), get_character(), get_foreground_color(), put_character(), scroll_up(), set_background_color(), and set_foreground_color().

print_logo()

void FramebufferConsole::print_logo ( bool  is_panic = false )

static

Prints the logo to the center of the screen.

Parameters

is_panic

Whether to print the kernel panic logo or the normal logo

Definition at line 280 of file framebuffer.cpp.

                                                 {
 
    // Load the logo
    const char* logo = is_panic ? header_data_kp : header_data;
    auto address = PhysicalMemoryManager::to_dm_region(s_framebuffer_info->common.framebuffer_addr);
    auto bpp = s_framebuffer_info->common.framebuffer_bpp;
 
    // Find the center of the screen
    uint32_t screen_width = s_framebuffer_info->common.framebuffer_width;
    uint32_t screen_height = s_framebuffer_info->common.framebuffer_height;
    uint32_t center_x = screen_width / 2;
    uint32_t center_y = screen_height / 2 - 80;
 
    // Fill the screen with the logo colour
    auto col = GraphicsContext::colour_to_int(Colour(is_panic ? ConsoleColour::Red : ConsoleColour::Black), bpp);
    memset(address, col, screen_width * screen_height * (bpp / 8));
 
    // Draw the logo
    for(uint32_t logo_y = 0; logo_y < LOGO_HEIGHT; ++logo_y) {
        for(uint32_t logo_x = 0; logo_x < LOGO_WIDTH; ++logo_x) {
 
            // Get the pixel from the logo
            uint8_t pixel[3] = { 0 };
            LOGO_HEADER_PIXEL(logo, pixel)
 
            // Draw the pixel
            auto col = GraphicsContext::colour_to_int(common::Colour(pixel[0], pixel[1], pixel[2]), bpp);
            put_pixel(center_x - LOGO_WIDTH / 2 + logo_x, center_y - LOGO_HEIGHT / 2 + logo_y, col);
        }
    }
 
    update_progress_bar(0);
}

References MaxOS::common::GraphicsContext::colour_to_int(), multiboot_tag_framebuffer::common, multiboot_tag_framebuffer_common::framebuffer_addr, multiboot_tag_framebuffer_common::framebuffer_bpp, multiboot_tag_framebuffer_common::framebuffer_height, multiboot_tag_framebuffer_common::framebuffer_width, LOGO_HEADER_PIXEL, LOGO_HEIGHT, LOGO_WIDTH, MaxOS::memory::PhysicalMemoryManager::to_dm_region(), and update_progress_bar().

Referenced by FramebufferConsole(), and MaxOS::system::CPU::prepare_for_panic().

put_character()

void FramebufferConsole::put_character ( uint16_t  x, uint16_t  y, char  c  )

finalvirtual

Places a character at the specified location.

Parameters

x	The x coordinate
y	The y coordinate
c	The character to place

Reimplemented from MaxOS::console::Console.

Definition at line 91 of file framebuffer.cpp.

                                                                     {
 
    // Parse any ansi codes
    if(c == '\033') {
 
        // Store the character
        ansi_code_length = 0;
        ansi_code[ansi_code_length++] = c;
 
        // Do not draw the escape character
        return;
    }
 
    if(ansi_code_length < 8) {
 
        // Add the character to the ANSI code
        ansi_code[ansi_code_length++] = c;
 
        // If the ANSI code is complete
        if(c == 'm') {
            ansi_code[ansi_code_length] = '\0';
            ansi_code_length = -1;
 
            if(strcmp("\033[0m", ansi_code) == 0) {
                m_foreground_color = ConsoleColour::Uninitialised;
                m_background_color = ConsoleColour::Uninitialised;
                return;
            }
 
            // Get the colour from the ANSI code
            const Colour colour(ansi_code);
 
            // Set the colour
            bool foreground = ansi_code[4] == '3';
            if(foreground)
                m_foreground_color = colour.to_console_colour();
            else
                m_background_color = colour.to_console_colour();
 
        }
 
        // Do not draw the escape character
        return;
    }
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return;
 
    // Set the character at the offset, by masking the character with the current character (last 8 bits)
    int offset = (y * width() + x);
    m_video_memory_meta[offset] = (m_video_memory_meta[offset] & 0xFF00) | (uint16_t) c;
 
    // Convert the char into a string
    char s[] = " ";
    s[0] = c;
 
    // Get the colour as a number
    Colour foreground = m_foreground_color == ConsoleColour::Uninitialised ? Colour(get_foreground_color(x, y)) : Colour(m_foreground_color);
    Colour background = m_background_color == ConsoleColour::Uninitialised ? Colour(get_background_color(x, y)) : Colour(m_background_color);
    auto fg = GraphicsContext::colour_to_int(foreground, m_framebuffer_bpp);
    auto bg = GraphicsContext::colour_to_int(background, m_framebuffer_bpp);
 
    // Draw the text from top to bottom
    for(int y_bit_map_offset = 0; y_bit_map_offset < FONT_WIDTH; y_bit_map_offset++) {
        for(int x_bit_map_offset = 0; x_bit_map_offset < FONT_HEIGHT - (2 * FONT_PADDING); ++x_bit_map_offset) {
 
            // Get the character
            uint8_t character = c;
 
            // Draw the pixel
            bool set = AMIGA_FONT[(uint16_t) character * 8 + y_bit_map_offset] & (128 >> (x_bit_map_offset % 8));
            put_pixel(x * 8 + x_bit_map_offset, y * FONT_HEIGHT + y_bit_map_offset, set ? fg : bg);
 
        }
    }
}

References MaxOS::common::GraphicsContext::colour_to_int(), MaxOS::console::FONT_HEIGHT, MaxOS::console::FONT_PADDING, MaxOS::console::FONT_WIDTH, get_background_color(), get_foreground_color(), height(), and width().

scroll_up()

void FramebufferConsole::scroll_up ( uint16_t  left, uint16_t  top, uint16_t  width, uint16_t  height, common::ConsoleColour  foreground, common::ConsoleColour  background, char  fill  )

finalvirtual

Scrolls the console up by 1 line.

Parameters

left	The left coordinate of the area to scroll
top	The top coordinate of the area to scroll
width	The width of the area to scroll
height	The height of the area to scroll
foreground	The foreground color of the new line
background	The background color of the new line
fill	The character to fill the new line with

Reimplemented from MaxOS::console::Console.

Definition at line 326 of file framebuffer.cpp.

                                                                           {
 
 
    // Get the framebuffer info
    uint64_t framebuffer_width = s_framebuffer_info->common.framebuffer_width;
    uint64_t framebuffer_bpp = m_framebuffer_bpp; // in bits per pixel
    uint64_t bytes_per_pixel = framebuffer_bpp / 8;
    uint64_t framebuffer_pitch = framebuffer_width * bytes_per_pixel;
 
    uint16_t line_height = FONT_HEIGHT;
 
    // Region conversions
    uint16_t region_pixel_y = top * line_height;
    uint16_t region_pixel_height = height * line_height;
    uint16_t region_pixel_left = left * FONT_WIDTH;
    uint16_t region_pixel_width = width * FONT_WIDTH;
    size_t row_bytes = region_pixel_width * bytes_per_pixel;
 
    // Decide the colour of the pixel
    ConsoleColour to_set_foreground = get_foreground_color(left, top + height - 1);
    ConsoleColour to_set_background = get_background_color(left, top + height - 1);
    uint32_t fill_value = GraphicsContext::colour_to_int(Colour(to_set_background), m_framebuffer_bpp);
 
    // Scroll the region upward by one text line
    for(uint16_t row = 0; row < region_pixel_height - line_height; row++) {
        uint8_t* src = (uint8_t*)m_framebuffer_address + (region_pixel_y + row + line_height) * framebuffer_pitch + region_pixel_left * bytes_per_pixel;
        uint8_t* dest = (uint8_t*)m_framebuffer_address + (region_pixel_y + row) * framebuffer_pitch + region_pixel_left * bytes_per_pixel;
        memmove(dest, src, row_bytes);
    }
 
    // Clear the last line of the region
    uint16_t clear_start_y = region_pixel_y + region_pixel_height - line_height;
    for(uint16_t row = 0; row < line_height; row++) {
        auto row_add = (uint32_t*) ((uint8_t*)m_framebuffer_address + (clear_start_y + row) * framebuffer_pitch + region_pixel_left * 4);
        for(uint16_t col = 0; col < region_pixel_width; col++) {
            row_add[col] = fill_value;
        }
    }
 
    //Update any per-pixel colour metadata
    uint16_t text_row = top + height - 1;
    for(uint16_t x = left; x < left + width; x++) {
        set_foreground_color(x, text_row, to_set_foreground);
        set_background_color(x, text_row, to_set_background);
    }
}

References MaxOS::common::GraphicsContext::colour_to_int(), multiboot_tag_framebuffer::common, MaxOS::console::FONT_HEIGHT, MaxOS::console::FONT_WIDTH, multiboot_tag_framebuffer_common::framebuffer_width, get_background_color(), get_foreground_color(), height(), set_background_color(), set_foreground_color(), and width().

set_background_color()

void FramebufferConsole::set_background_color ( uint16_t  x, uint16_t  y, common::ConsoleColour  background  )

finalvirtual

Sets the background color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate
background	The background color

Reimplemented from MaxOS::console::Console.

Definition at line 196 of file framebuffer.cpp.

                                                                                                    {
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Set the background color at the offset, by masking the background color with the current background color (bits 12-15)
    m_video_memory_meta[offset] = (m_video_memory_meta[offset] & 0x0FFF) | ((uint16_t) background << 12);
}

References height(), and width().

Referenced by scroll_up().

set_foreground_color()

void FramebufferConsole::set_foreground_color ( uint16_t  x, uint16_t  y, common::ConsoleColour  foreground  )

finalvirtual

Sets the foreground color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate
foreground	The foreground color

Reimplemented from MaxOS::console::Console.

Definition at line 176 of file framebuffer.cpp.

                                                                                                    {
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Set the foreground color at the offset, by masking the foreground color with the current foreground color (bits 8-11)
    m_video_memory_meta[offset] = (m_video_memory_meta[offset] & 0xF0FF) | ((uint16_t) foreground << 8);
}

References height(), and width().

Referenced by scroll_up().

update_progress_bar()

void FramebufferConsole::update_progress_bar ( uint8_t  percentage )

static

Updates the progress bar.

Parameters

percentage

The percentage to update the progress bar to (0-100)

Definition at line 392 of file framebuffer.cpp.

                                                               {
 
    // Not ready
    if(!s_framebuffer_info)
        return;
 
    // Check bounds
    if(percentage > 100)
        percentage = 100;
 
    uint8_t progress_height = 15;
    uint8_t progress_spacing = 20;
    uint8_t progress_width_cull = 40;
 
    // Find the center of the screen
    uint32_t right_x = (s_framebuffer_info->common.framebuffer_width / 2) - LOGO_WIDTH / 2;
    uint32_t bottom_y = (s_framebuffer_info->common.framebuffer_height / 2 - 80) - LOGO_HEIGHT / 2;
 
    // Find the bounds
    uint32_t start_x = progress_width_cull;
    uint32_t start_y = LOGO_HEIGHT + progress_spacing;
    uint32_t end_x = LOGO_WIDTH - progress_width_cull;
    uint32_t end_y = LOGO_HEIGHT + progress_height + progress_spacing;
 
    // Draw the progress bar
    for(uint32_t progress_y = start_y; progress_y < end_y; ++progress_y) {
        for(uint32_t progress_x = start_x; progress_x < end_x; ++progress_x) {
 
            // Check if drawing border
            bool is_border = (progress_y == start_y) || (progress_y == end_y - 1) ||
                             (progress_x == start_x) || (progress_x == end_x - 1);
 
            // Only draw the border if it is the first time drawing it
            is_border = is_border && percentage == 0;
 
            // If it is not within the percentage, skip it
            uint32_t logo_progress_width = LOGO_WIDTH * percentage / 100;
            if(progress_x > logo_progress_width && !is_border)
                continue;
 
            // Draw the pixel
            auto col = GraphicsContext::colour_to_int(Colour(0xFF, 0xFF, 0xFF), s_framebuffer_info->common.framebuffer_bpp);
            put_pixel(right_x + progress_x, bottom_y + progress_y, col);
 
        }
    }
}

References MaxOS::common::GraphicsContext::colour_to_int(), multiboot_tag_framebuffer::common, multiboot_tag_framebuffer_common::framebuffer_bpp, multiboot_tag_framebuffer_common::framebuffer_height, multiboot_tag_framebuffer_common::framebuffer_width, LOGO_HEIGHT, and LOGO_WIDTH.

Referenced by print_logo(), and MaxOS::Logger::set_log_level().

width()

uint16_t FramebufferConsole::width ( )

finalvirtual

Gets the width of the console.

Returns

The width of the console in characters

Reimplemented from MaxOS::console::Console.

Definition at line 71 of file framebuffer.cpp.

                                   {
    return s_framebuffer_info->common.framebuffer_width / FONT_WIDTH;       // 8 pixels per character
}

References multiboot_tag_framebuffer::common, MaxOS::console::FONT_WIDTH, and multiboot_tag_framebuffer_common::framebuffer_width.

Referenced by FramebufferConsole(), get_background_color(), get_character(), get_foreground_color(), put_character(), scroll_up(), set_background_color(), and set_foreground_color().

Member Data Documentation

cout

ConsoleStream* MaxOS::console::FramebufferConsole::cout

The boot console output stream.

Definition at line 322 of file framebuffer.h.

Referenced by finish(), and FramebufferConsole().

---

The documentation for this class was generated from the following files:

• /home/runner/work/MaxOS/MaxOS/kernel/include/console/framebuffer.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/console/framebuffer.cpp