ladybird/Kernel/Graphics/Console/FramebufferConsole.h

/*
 * Copyright (c) 2021, Liav A. <liavalb@hotmail.co.il>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/RefCounted.h>
#include <AK/Types.h>
#include <Kernel/Graphics/Console/Console.h>
#include <Kernel/PhysicalAddress.h>

namespace Kernel::Graphics {
class FramebufferConsole final : public Console {
public:
    static NonnullRefPtr<FramebufferConsole> initialize(PhysicalAddress, size_t width, size_t height, size_t pitch);

    virtual size_t bytes_per_base_glyph() const override;
    virtual size_t chars_per_line() const override;

    virtual size_t max_column() const override { return m_width / 8; }
    virtual size_t max_row() const override { return m_height / 8; }

    virtual bool is_hardware_paged_capable() const override { return false; }
    virtual bool has_hardware_cursor() const override { return false; }

    virtual void set_cursor(size_t x, size_t y) override;
    virtual void hide_cursor() override;
    virtual void show_cursor() override;

    virtual void clear(size_t x, size_t y, size_t length) const override;
    virtual void write(size_t x, size_t y, char ch, Color background, Color foreground) const override;
    virtual void write(size_t x, size_t y, String cstring, Color background, Color foreground) const override;
    virtual void write(size_t x, size_t y, char ch) const override;
    virtual void write(size_t x, size_t y, String) const override;
    virtual void write(char ch) const override;

    virtual void enable() override;
    virtual void disable() override;

protected:
    void clear_glyph(size_t x, size_t y) const;
    FramebufferConsole(PhysicalAddress, size_t width, size_t height, size_t pitch);
    OwnPtr<Region> m_framebuffer_region;
    PhysicalAddress m_framebuffer_address;
    size_t m_pitch;
    mutable SpinLock<u8> m_lock;
};
}