MaxOS::console::ConsoleStream Class Reference

A stream that can be used to write to a console. More...

#include <console.h>

Inheritance diagram for MaxOS::console::ConsoleStream:

Public Member Functions
	ConsoleStream (Console *)
	Construct a new Console Stream object.
void	write_char (char c) override
	write a character to the console stream
void	set_cursor (uint16_t x, uint16_t y)
	Set the m_position of the cursor.

Detailed Description

A stream that can be used to write to a console.

Definition at line 92 of file console.h.

Constructor & Destructor Documentation

ConsoleStream()

ConsoleStream::ConsoleStream ( Console *  console )

explicit

Construct a new Console Stream object.

Parameters

console

The console to create the stream on

Definition at line 423 of file console.cpp.

        : m_console(console) {
 
}

Member Function Documentation

set_cursor()

void ConsoleStream::set_cursor	(	uint16_t	x,
		uint16_t	y
	)

Set the m_position of the cursor.

Parameters

x	The x coordinate of the cursor
y	The y coordinate of the cursor

Definition at line 509 of file console.cpp.

                                                     {
 
    // Set the x and y coordinates
    m_cursor_x = x;
    m_cursor_y = y;
}

Referenced by MaxOS::console::FramebufferConsole::finish().

write_char()

void ConsoleStream::write_char ( char  c )

override

write a character to the console stream

Parameters

c	The character to write

Definition at line 435 of file console.cpp.

                                     {
 
    uint16_t spaces = 0;
 
    // If the character placement is more than the width of the console go on a new line
    if(m_cursor_x >= m_console->width() && c != '\n') {
        line_feed();
        write("             ");
    }
 
    // Check if the character is an ANSI escape code
    if(c == '\033') is_ansi = true;
 
    // Handle the character
    switch(c) {
        // New line
        case '\n':
            // Go to the next line, if it is more than what the console can fit then scroll
            if(++m_cursor_y >= m_console->height()) {
                m_console->scroll_up();
 
                // Ensure there is space at the bottom to write
                m_cursor_y = m_console->height() - 1;
            }
 
            // don't break here, we want to go to the next case because of the \r
            [[fallthrough]];
 
            // Carriage return
        case '\r':
            m_cursor_x = 0;
            break;
 
            // End of string
        case '\0':
            break;
 
            // Backspace
        case '\b':
            m_cursor_x--;
            break;
 
            // Tab
        case '\t':
 
            // Pad with spaces until a tab is reached
            spaces = 8 - (m_cursor_x % 8);
            for(uint16_t i = 0; i < spaces; i++)
                write_char(' ');        //TODO: Recursive, dont
            break;
 
        default:
            // Put the character on the console
            m_console->put_character(m_cursor_x, m_cursor_y, c);
 
            // Increment the x coordinate (ANSI aren't rendered)
            if(!is_ansi)
                m_cursor_x++;
 
            break;
 
    }
 
    // Check if the ANSI code is complete
    if(c == 'm') is_ansi = false;
 
}

References MaxOS::console::Console::height(), MaxOS::console::Console::put_character(), MaxOS::console::Console::scroll_up(), MaxOS::console::Console::width(), and write_char().

Referenced by write_char().

---

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

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