MaxOS::drivers::console::ConsoleStream Class Reference

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

#include <console.h>

Inheritance diagram for MaxOS::drivers::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.
Public Member Functions inherited from MaxOS::common::OutputStream
	OutputStream ()
	Constructs an OutputStream object that uses strings as the underlying data type.
virtual void	line_feed ()
	Writes a newline to the output stream.
virtual void	carriage_return ()
	Writes a carriage return to the output stream.
virtual void	clear ()
	Clears the output stream.
void	write (string string_to_write) override
	Writes a string to the output stream.
void	write (const char *string_to_write)
	Writes a string to the output stream.
virtual void	write_int (int int_to_write)
	Writes an integer to the output stream.
virtual void	write_hex (uint64_t hex_to_write)
	Writes a hex to the output stream.
OutputStream &	operator<< (string string_to_write) override
	Writes a string to the output stream.
OutputStream &	operator<< (const char *string_to_write)
	Writes a string to the output stream.
OutputStream &	operator<< (int int_to_write)
	Writes a integer to the output stream.
OutputStream &	operator<< (uint64_t hex_to_write)
	Writes a hexadecimal to the output stream.
OutputStream &	operator<< (char char_to_write)
	Writes a character to the output stream.
Public Member Functions inherited from MaxOS::common::GenericOutputStream< string >
	GenericOutputStream ()
	__________________________________________Templates__________________________________________________///
	~GenericOutputStream ()
	Destructor of the GenericOutputStream class.
void	on_stream_read (string) override
	Writes the date that was read from the input stream to the output stream.
void	on_end_of_stream (GenericInputStream< string > *) override
	Close the stream and remove it from the list of streams when the end of the stream is reached.
virtual void	write (string)
	write an element to the stream.
virtual void	close ()
	Close the stream.
virtual GenericOutputStream< string > &	operator<< (string)
	Overload the << operator to write an element to the stream.
Public Member Functions inherited from MaxOS::common::InputStreamProcessor< Type, ProcessorType >
	InputStreamProcessor ()
	Creates a new InputStreamProcessor.
	InputStreamProcessor (InputStreamEventHandler< ProcessorType > *generic_stream_event_handler)
	Creates a new InputStreamProcessor.
	~InputStreamProcessor ()
	Destroys the InputStreamProcessor.
void	on_end_of_stream (GenericInputStream< Type > *stream) override
	Called when a stream has finished. Passes the event on to the handlers and then removes the stream from the array of streams.
Public Member Functions inherited from MaxOS::common::InputStreamEventHandler< Type >
	InputStreamEventHandler ()
	_______________________________________________TEMPLATES_________________________________________________________________///
	~InputStreamEventHandler ()
	Destroys the InputStreamProcessor and disconnects it from all streams.
Public Member Functions inherited from MaxOS::common::GenericInputStream< ProcessorType >
	GenericInputStream ()
	Creates a new GenericInputStream.
	GenericInputStream (InputStreamEventHandler< ProcessorType > *)
	Creates a new GenericInputStream and connects it to the handler.
	~GenericInputStream ()
	Destroys the GenericInputStream and disconnects all handlers.
void	connect_input_stream_event_handler (InputStreamEventHandler< ProcessorType > *)
	Adds a inputStreamEventHandler to the list of internetProtocolHandlers.
void	disconnect_input_stream_event_handler (InputStreamEventHandler< ProcessorType > *)
	Removes a handler from the list of handlers.

Additional Inherited Members
Protected Attributes inherited from MaxOS::common::InputStreamEventHandler< Type >
common::Vector< GenericInputStream< Type > * >	m_generic_input_streams
	List of streams being observed by this handler.
Protected Attributes inherited from MaxOS::common::GenericInputStream< ProcessorType >
common::Vector< InputStreamEventHandler< ProcessorType > * >	m_input_stream_event_handlers
	List of streams being observed by this handler.

Detailed Description

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

Definition at line 91 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 424 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 510 of file console.cpp.

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

Referenced by MaxOS::drivers::console::VESABootConsole::finish().

write_char()

void ConsoleStream::write_char ( char  c )

overridevirtual

write a character to the console stream

Parameters

c	The character to write

Reimplemented from MaxOS::common::OutputStream.

Definition at line 436 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::drivers::console::Console::height(), MaxOS::common::OutputStream::line_feed(), MaxOS::drivers::console::Console::put_character(), MaxOS::drivers::console::Console::scroll_up(), MaxOS::drivers::console::Console::width(), MaxOS::common::OutputStream::write(), 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/drivers/console/console.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/drivers/console/console.cpp