Kernel: Move font code to its own library LibFont

This commit is contained in:
2024-05-31 10:47:05 +03:00
parent ae3ae6fd0e
commit 0501f3bd99
11 changed files with 155 additions and 85 deletions

View File

@@ -29,7 +29,6 @@ set(KERNEL_SOURCES
kernel/Device/NullDevice.cpp
kernel/Device/ZeroDevice.cpp
kernel/Errors.cpp
kernel/Font.cpp
kernel/FS/DevFS/FileSystem.cpp
kernel/FS/Ext2/FileSystem.cpp
kernel/FS/Ext2/Inode.cpp
@@ -149,6 +148,10 @@ set(LIBELF_SOURCES
../LibELF/LibELF/LoadableELF.cpp
)
set(LIBFONT_SOURCES
../LibFont/Font.cpp
)
set(LIBINPUT_SOURCE
../LibInput/KeyboardLayout.cpp
../LibInput/KeyEvent.cpp
@@ -160,6 +163,7 @@ set(KERNEL_SOURCES
${BAN_SOURCES}
${KLIBC_SOURCES}
${LIBELF_SOURCES}
${LIBFONT_SOURCES}
${LIBINPUT_SOURCE}
)

View File

@@ -1,35 +0,0 @@
#pragma once
#include <BAN/HashMap.h>
#include <BAN/Span.h>
#include <BAN/StringView.h>
namespace Kernel
{
class Font
{
public:
static BAN::ErrorOr<Font> load(BAN::StringView);
static BAN::ErrorOr<Font> prefs();
uint32_t width() const { return m_width; }
uint32_t height() const { return m_height; }
uint32_t pitch() const { return m_pitch; }
bool has_glyph(uint32_t) const;
const uint8_t* glyph(uint32_t) const;
private:
static BAN::ErrorOr<Font> parse_psf1(BAN::Span<const uint8_t>);
static BAN::ErrorOr<Font> parse_psf2(BAN::Span<const uint8_t>);
private:
BAN::HashMap<uint32_t, uint32_t> m_glyph_offsets;
BAN::Vector<uint8_t> m_glyph_data;
uint32_t m_width = 0;
uint32_t m_height = 0;
uint32_t m_pitch = 0;
};
}

View File

@@ -16,7 +16,7 @@ namespace Kernel
public:
void set_termios(const termios& termios) { m_termios = termios; }
termios get_termios() const { return m_termios; }
virtual void set_font(const Font&) {};
virtual void set_font(const LibFont::Font&) {};
void set_foreground_pgrp(pid_t pgrp) { m_foreground_pgrp = pgrp; }
pid_t foreground_pgrp() const { return m_foreground_pgrp; }

View File

@@ -1,61 +1,66 @@
#pragma once
#include <kernel/Font.h>
#include <LibFont/Font.h>
#include <stdint.h>
class TerminalDriver
namespace Kernel
{
public:
struct Color
class TerminalDriver
{
constexpr Color(uint32_t rgb)
: rgb(rgb)
{ }
constexpr Color(uint8_t r, uint8_t g, uint8_t b)
: rgb(((uint32_t)r << 16) | ((uint32_t)g << 8) | b)
{ }
uint8_t red() const { return (rgb >> 0x10) & 0xFF; }
uint8_t green() const { return (rgb >> 0x08) & 0xFF; }
uint8_t blue() const { return (rgb >> 0x00) & 0xFF; }
uint32_t rgb;
public:
struct Color
{
constexpr Color(uint32_t rgb)
: rgb(rgb)
{ }
constexpr Color(uint8_t r, uint8_t g, uint8_t b)
: rgb(((uint32_t)r << 16) | ((uint32_t)g << 8) | b)
{ }
uint8_t red() const { return (rgb >> 0x10) & 0xFF; }
uint8_t green() const { return (rgb >> 0x08) & 0xFF; }
uint8_t blue() const { return (rgb >> 0x00) & 0xFF; }
uint32_t rgb;
};
public:
TerminalDriver() : m_font(MUST(LibFont::Font::prefs())) {}
virtual ~TerminalDriver() {}
virtual uint32_t width() const = 0;
virtual uint32_t height() const = 0;
virtual void putchar_at(uint16_t, uint32_t, uint32_t, Color, Color) = 0;
virtual void clear(Color) = 0;
virtual void set_cursor_position(uint32_t, uint32_t) = 0;
void set_font(const LibFont::Font& font) { m_font = font; };
const LibFont::Font& font() const { return m_font; }
private:
LibFont::Font m_font;
};
public:
TerminalDriver() : m_font(MUST(Kernel::Font::prefs())) {}
virtual ~TerminalDriver() {}
virtual uint32_t width() const = 0;
virtual uint32_t height() const = 0;
namespace TerminalColor
{
static constexpr TerminalDriver::Color BLACK = 0x000000;
static constexpr TerminalDriver::Color BLUE = 0x0000AA;
static constexpr TerminalDriver::Color GREEN = 0x00AA00;
static constexpr TerminalDriver::Color CYAN = 0x00AAAA;
static constexpr TerminalDriver::Color RED = 0xAA0000;
static constexpr TerminalDriver::Color MAGENTA = 0xAA00AA;
static constexpr TerminalDriver::Color YELLOW = 0xAA5500;
static constexpr TerminalDriver::Color WHITE = 0xAAAAAA;
virtual void putchar_at(uint16_t, uint32_t, uint32_t, Color, Color) = 0;
virtual void clear(Color) = 0;
static constexpr TerminalDriver::Color BRIGHT_BLACK = 0x555555;
static constexpr TerminalDriver::Color BRIGHT_BLUE = 0x5555FF;
static constexpr TerminalDriver::Color BRIGHT_GREEN = 0x55FF55;
static constexpr TerminalDriver::Color BRIGHT_CYAN = 0x55FFFF;
static constexpr TerminalDriver::Color BRIGHT_RED = 0xFF5555;
static constexpr TerminalDriver::Color BRIGHT_MAGENTA = 0xFF55FF;
static constexpr TerminalDriver::Color BRIGHT_YELLOW = 0xFFFF55;
static constexpr TerminalDriver::Color BRIGHT_WHITE = 0xFFFFFF;
}
virtual void set_cursor_position(uint32_t, uint32_t) = 0;
void set_font(const Kernel::Font& font) { m_font = font; };
const Kernel::Font& font() const { return m_font; }
private:
Kernel::Font m_font;
};
namespace TerminalColor
{
static constexpr TerminalDriver::Color BLACK = 0x000000;
static constexpr TerminalDriver::Color BLUE = 0x0000AA;
static constexpr TerminalDriver::Color GREEN = 0x00AA00;
static constexpr TerminalDriver::Color CYAN = 0x00AAAA;
static constexpr TerminalDriver::Color RED = 0xAA0000;
static constexpr TerminalDriver::Color MAGENTA = 0xAA00AA;
static constexpr TerminalDriver::Color YELLOW = 0xAA5500;
static constexpr TerminalDriver::Color WHITE = 0xAAAAAA;
static constexpr TerminalDriver::Color BRIGHT_BLACK = 0x555555;
static constexpr TerminalDriver::Color BRIGHT_BLUE = 0x5555FF;
static constexpr TerminalDriver::Color BRIGHT_GREEN = 0x55FF55;
static constexpr TerminalDriver::Color BRIGHT_CYAN = 0x55FFFF;
static constexpr TerminalDriver::Color BRIGHT_RED = 0xFF5555;
static constexpr TerminalDriver::Color BRIGHT_MAGENTA = 0xFF55FF;
static constexpr TerminalDriver::Color BRIGHT_YELLOW = 0xFFFF55;
static constexpr TerminalDriver::Color BRIGHT_WHITE = 0xFFFFFF;
}

View File

@@ -15,7 +15,7 @@ namespace Kernel
public:
static BAN::ErrorOr<BAN::RefPtr<VirtualTTY>> create(TerminalDriver*);
virtual void set_font(const Font&) override;
virtual void set_font(const LibFont::Font&) override;
virtual uint32_t height() const override { return m_height; }
virtual uint32_t width() const override { return m_width; }

View File

@@ -8,7 +8,7 @@
#include <ctype.h>
extern TerminalDriver* g_terminal_driver;
extern Kernel::TerminalDriver* g_terminal_driver;
namespace Debug
{
@@ -68,6 +68,8 @@ namespace Debug
void putchar(char ch)
{
using namespace Kernel;
if (Kernel::Serial::has_devices())
return Kernel::Serial::putchar_any(ch);
if (Kernel::TTY::is_initialized())

View File

@@ -1,257 +0,0 @@
#include <BAN/Endianness.h>
#include <BAN/ScopeGuard.h>
#include <BAN/UTF8.h>
#include <kernel/Font.h>
#include <kernel/FS/VirtualFileSystem.h>
#include <kernel/Process.h>
#include <fcntl.h>
#define PSF1_MAGIC0 0x36
#define PSF1_MAGIC1 0x04
#define PSF1_MODE512 0x01
#define PSF1_MODEHASTAB 0x02
#define PSF1_MODEHASSEQ 0x04
#define PSF1_STARTSEQ 0xFFFE
#define PSF1_SEPARATOR 0xFFFF
#define PSF2_MAGIC0 0x72
#define PSF2_MAGIC1 0xB5
#define PSF2_MAGIC2 0x4A
#define PSF2_MAGIC3 0x86
#define PSF2_HAS_UNICODE_TABLE 0x01
#define PSF2_STARTSEQ 0xFE
#define PSF2_SEPARATOR 0xFF
extern uint8_t _binary_font_prefs_psf_start[];
extern uint8_t _binary_font_prefs_psf_end[];
namespace Kernel
{
BAN::ErrorOr<Font> Font::prefs()
{
size_t font_data_size = _binary_font_prefs_psf_end - _binary_font_prefs_psf_start;
BAN::Span<const uint8_t> font_data(_binary_font_prefs_psf_start, font_data_size);
return parse_psf1(font_data);
}
BAN::ErrorOr<Font> Font::load(BAN::StringView path)
{
auto inode = TRY(VirtualFileSystem::get().file_from_absolute_path({ 0, 0, 0, 0 }, path, O_RDONLY)).inode;
BAN::Vector<uint8_t> file_data;
TRY(file_data.resize(inode->size()));
TRY(inode->read(0, file_data.span()));
if (file_data.size() < 4)
return BAN::Error::from_error_code(ErrorCode::Font_FileTooSmall);
if (file_data[0] == PSF1_MAGIC0 && file_data[1] == PSF1_MAGIC1)
return TRY(parse_psf1(file_data.span()));
if (file_data[0] == PSF2_MAGIC0 && file_data[1] == PSF2_MAGIC1 && file_data[2] == PSF2_MAGIC2 && file_data[3] == PSF2_MAGIC3)
return TRY(parse_psf2(file_data.span()));
return BAN::Error::from_error_code(ErrorCode::Font_Unsupported);
}
BAN::ErrorOr<Font> Font::parse_psf1(BAN::Span<const uint8_t> font_data)
{
if (font_data.size() < 4)
return BAN::Error::from_error_code(ErrorCode::Font_FileTooSmall);
struct PSF1Header
{
uint8_t magic[2];
uint8_t mode;
uint8_t char_size;
};
const PSF1Header& header = *(const PSF1Header*)font_data.data();
uint32_t glyph_count = header.mode & PSF1_MODE512 ? 512 : 256;
uint32_t glyph_size = header.char_size;
uint32_t glyph_data_size = glyph_size * glyph_count;
if (font_data.size() < sizeof(PSF1Header) + glyph_data_size)
return BAN::Error::from_error_code(ErrorCode::Font_FileTooSmall);
BAN::Vector<uint8_t> glyph_data;
TRY(glyph_data.resize(glyph_data_size));
memcpy(glyph_data.data(), font_data.data() + sizeof(PSF1Header), glyph_data_size);
BAN::HashMap<uint32_t, uint32_t> glyph_offsets;
TRY(glyph_offsets.reserve(glyph_count));
bool codepoint_redef = false;
bool codepoint_sequence = false;
if (header.mode & (PSF1_MODEHASTAB | PSF1_MODEHASSEQ))
{
uint32_t current_index = sizeof(PSF1Header) + glyph_data_size;
uint32_t glyph_index = 0;
while (current_index < font_data.size())
{
uint16_t lo = font_data[current_index];
uint16_t hi = font_data[current_index + 1];
uint16_t codepoint = (hi << 8) | lo;
if (codepoint == PSF1_STARTSEQ)
{
codepoint_sequence = true;
break;
}
else if (codepoint == PSF1_SEPARATOR)
{
glyph_index++;
}
else
{
if (glyph_offsets.contains(codepoint))
codepoint_redef = true;
else
TRY(glyph_offsets.insert(codepoint, glyph_index * glyph_size));
}
current_index += 2;
}
}
else
{
for (uint32_t i = 0; i < glyph_count; i++)
TRY(glyph_offsets.insert(i, i * glyph_size));
}
if (codepoint_redef)
dwarnln("Font contsins multiple definitions for same codepoint(s)");
if (codepoint_sequence)
dwarnln("Font contains codepoint sequences (not supported)");
Font result;
result.m_glyph_offsets = BAN::move(glyph_offsets);
result.m_glyph_data = BAN::move(glyph_data);
result.m_width = 8;
result.m_height = header.char_size;
result.m_pitch = 1;
return result;
}
BAN::ErrorOr<Font> Font::parse_psf2(BAN::Span<const uint8_t> font_data)
{
struct PSF2Header
{
uint8_t magic[4];
BAN::LittleEndian<uint32_t> version;
BAN::LittleEndian<uint32_t> header_size;
BAN::LittleEndian<uint32_t> flags;
BAN::LittleEndian<uint32_t> glyph_count;
BAN::LittleEndian<uint32_t> glyph_size;
BAN::LittleEndian<uint32_t> height;
BAN::LittleEndian<uint32_t> width;
};
if (font_data.size() < sizeof(PSF2Header))
return BAN::Error::from_error_code(ErrorCode::Font_FileTooSmall);
const PSF2Header& header = *(const PSF2Header*)font_data.data();
uint32_t glyph_data_size = header.glyph_count * header.glyph_size;
if (font_data.size() < glyph_data_size + header.header_size)
return BAN::Error::from_error_code(ErrorCode::Font_FileTooSmall);
BAN::Vector<uint8_t> glyph_data;
TRY(glyph_data.resize(glyph_data_size));
memcpy(glyph_data.data(), font_data.data() + header.header_size, glyph_data_size);
BAN::HashMap<uint32_t, uint32_t> glyph_offsets;
TRY(glyph_offsets.reserve(400));
bool invalid_utf = false;
bool codepoint_redef = false;
bool codepoint_sequence = false;
uint8_t bytes[4] {};
uint32_t byte_index = 0;
if (header.flags & PSF2_HAS_UNICODE_TABLE)
{
uint32_t glyph_index = 0;
for (uint32_t i = glyph_data_size + header.header_size; i < font_data.size(); i++)
{
uint8_t byte = font_data[i];
if (byte == PSF2_STARTSEQ)
{
codepoint_sequence = true;
break;
}
else if (byte == PSF2_SEPARATOR)
{
if (byte_index)
{
invalid_utf = true;
byte_index = 0;
}
glyph_index++;
}
else
{
ASSERT(byte_index < 4);
bytes[byte_index++] = byte;
uint32_t len = BAN::UTF8::byte_length(bytes[0]);
if (len == 0)
{
invalid_utf = true;
byte_index = 0;
}
else if (len == byte_index)
{
uint32_t codepoint = BAN::UTF8::to_codepoint(bytes);
if (codepoint == BAN::UTF8::invalid)
invalid_utf = true;
else if (glyph_offsets.contains(codepoint))
codepoint_redef = true;
else
TRY(glyph_offsets.insert(codepoint, glyph_index * header.glyph_size));
byte_index = 0;
}
}
}
}
else
{
for (uint32_t i = 0; i < header.glyph_count; i++)
TRY(glyph_offsets.insert(i, i * header.glyph_size));
}
if (invalid_utf)
dwarnln("Font contains invalid UTF-8 codepoint(s)");
if (codepoint_redef)
dwarnln("Font contains multiple definitions for same codepoint(s)");
if (codepoint_sequence)
dwarnln("Font contains codepoint sequences (not supported)");
Font result;
result.m_glyph_offsets = BAN::move(glyph_offsets);
result.m_glyph_data = BAN::move(glyph_data);
result.m_width = header.width;
result.m_height = header.height;
result.m_pitch = header.glyph_size / header.height;
return result;
}
bool Font::has_glyph(uint32_t codepoint) const
{
return m_glyph_offsets.contains(codepoint);
}
const uint8_t* Font::glyph(uint32_t codepoint) const
{
return m_glyph_data.data() + m_glyph_offsets[codepoint];
}
}

View File

@@ -62,7 +62,7 @@ namespace Kernel
m_terminal_driver->clear(m_background);
}
void VirtualTTY::set_font(const Kernel::Font& font)
void VirtualTTY::set_font(const LibFont::Font& font)
{
m_terminal_driver->set_font(font);

View File

@@ -77,7 +77,7 @@ static void parse_command_line()
}
}
TerminalDriver* g_terminal_driver = nullptr;
Kernel::TerminalDriver* g_terminal_driver = nullptr;
static void init2(void*);