Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b0b5b55dce | |||
| 422b27b1ba | |||
| 9485d2aa24 | |||
| 8a6b7851d5 | |||
| 8ec0d6ac41 | |||
| 337b585ba0 | |||
| 95a588b0df |
@@ -760,4 +760,4 @@ const UndoSystem *
|
|||||||
Buffer::Undo() const
|
Buffer::Undo() const
|
||||||
{
|
{
|
||||||
return undo_sys_.get();
|
return undo_sys_.get();
|
||||||
}
|
}
|
||||||
|
|||||||
32
Buffer.h
32
Buffer.h
@@ -1,5 +1,37 @@
|
|||||||
/*
|
/*
|
||||||
* Buffer.h - editor buffer representing an open document
|
* Buffer.h - editor buffer representing an open document
|
||||||
|
*
|
||||||
|
* Buffer is the central document model in kte. Each Buffer represents one open file
|
||||||
|
* or scratch document and manages:
|
||||||
|
*
|
||||||
|
* - Content storage: Uses PieceTable for efficient text operations
|
||||||
|
* - Cursor state: Current position (curx_, cury_), rendered column (rx_)
|
||||||
|
* - Viewport: Scroll offsets (rowoffs_, coloffs_) for display
|
||||||
|
* - File backing: Optional association with a file on disk
|
||||||
|
* - Undo/Redo: Integrated UndoSystem for operation history
|
||||||
|
* - Syntax highlighting: Optional HighlighterEngine for language-aware coloring
|
||||||
|
* - Swap/crash recovery: Integration with SwapRecorder for journaling
|
||||||
|
* - Dirty tracking: Modification state for save prompts
|
||||||
|
*
|
||||||
|
* Key concepts:
|
||||||
|
*
|
||||||
|
* 1. Cursor coordinates:
|
||||||
|
* - (curx_, cury_): Logical character position in the document
|
||||||
|
* - rx_: Rendered column accounting for tab expansion
|
||||||
|
*
|
||||||
|
* 2. File backing:
|
||||||
|
* - Buffers can be file-backed (associated with a path) or scratch (unnamed)
|
||||||
|
* - File identity tracking detects external modifications
|
||||||
|
*
|
||||||
|
* 3. Legacy Line wrapper:
|
||||||
|
* - Buffer::Line provides a string-like interface for legacy command code
|
||||||
|
* - New code should prefer direct PieceTable operations
|
||||||
|
* - See DEVELOPER_GUIDE.md for migration guidance
|
||||||
|
*
|
||||||
|
* 4. Content access:
|
||||||
|
* - Rows(): Materialized line cache (legacy, being phased out)
|
||||||
|
* - GetLineView(): Zero-copy line access via string_view (preferred)
|
||||||
|
* - Direct PieceTable access for new editing operations
|
||||||
*/
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ project(kte)
|
|||||||
include(GNUInstallDirs)
|
include(GNUInstallDirs)
|
||||||
|
|
||||||
set(CMAKE_CXX_STANDARD 20)
|
set(CMAKE_CXX_STANDARD 20)
|
||||||
set(KTE_VERSION "1.6.4")
|
set(KTE_VERSION "1.6.6")
|
||||||
|
|
||||||
# Default to terminal-only build to avoid SDL/OpenGL dependency by default.
|
# Default to terminal-only build to avoid SDL/OpenGL dependency by default.
|
||||||
# Enable with -DBUILD_GUI=ON when SDL2/OpenGL/Freetype are available.
|
# Enable with -DBUILD_GUI=ON when SDL2/OpenGL/Freetype are available.
|
||||||
@@ -68,11 +68,19 @@ if (BUILD_GUI)
|
|||||||
endif ()
|
endif ()
|
||||||
|
|
||||||
# NCurses for terminal mode
|
# NCurses for terminal mode
|
||||||
set(CURSES_NEED_NCURSES)
|
set(CURSES_NEED_NCURSES TRUE)
|
||||||
set(CURSES_NEED_WIDE)
|
set(CURSES_NEED_WIDE TRUE)
|
||||||
find_package(Curses REQUIRED)
|
find_package(Curses REQUIRED)
|
||||||
include_directories(${CURSES_INCLUDE_DIR})
|
include_directories(${CURSES_INCLUDE_DIR})
|
||||||
|
|
||||||
|
# On Alpine Linux, CMake's FindCurses looks in wrong paths
|
||||||
|
# Manually find the correct ncurses library
|
||||||
|
if (EXISTS "/etc/alpine-release")
|
||||||
|
find_library(NCURSESW_LIB NAMES ncursesw PATHS /usr/lib /lib REQUIRED)
|
||||||
|
set(CURSES_LIBRARIES ${NCURSESW_LIB})
|
||||||
|
message(STATUS "Alpine Linux detected, using ncurses at: ${NCURSESW_LIB}")
|
||||||
|
endif ()
|
||||||
|
|
||||||
set(SYNTAX_SOURCES
|
set(SYNTAX_SOURCES
|
||||||
syntax/GoHighlighter.cc
|
syntax/GoHighlighter.cc
|
||||||
syntax/CppHighlighter.cc
|
syntax/CppHighlighter.cc
|
||||||
@@ -310,6 +318,7 @@ if (BUILD_TESTS)
|
|||||||
tests/test_swap_replay.cc
|
tests/test_swap_replay.cc
|
||||||
tests/test_swap_recovery_prompt.cc
|
tests/test_swap_recovery_prompt.cc
|
||||||
tests/test_swap_cleanup.cc
|
tests/test_swap_cleanup.cc
|
||||||
|
tests/test_swap_git_editor.cc
|
||||||
tests/test_piece_table.cc
|
tests/test_piece_table.cc
|
||||||
tests/test_search.cc
|
tests/test_search.cc
|
||||||
tests/test_search_replace_flow.cc
|
tests/test_search_replace_flow.cc
|
||||||
@@ -317,6 +326,8 @@ if (BUILD_TESTS)
|
|||||||
tests/test_reflow_indented_bullets.cc
|
tests/test_reflow_indented_bullets.cc
|
||||||
tests/test_undo.cc
|
tests/test_undo.cc
|
||||||
tests/test_visual_line_mode.cc
|
tests/test_visual_line_mode.cc
|
||||||
|
tests/test_benchmarks.cc
|
||||||
|
tests/test_migration_coverage.cc
|
||||||
|
|
||||||
# minimal engine sources required by Buffer
|
# minimal engine sources required by Buffer
|
||||||
PieceTable.cc
|
PieceTable.cc
|
||||||
|
|||||||
43
Command.cc
43
Command.cc
@@ -1109,33 +1109,34 @@ cmd_theme_set_by_name(const CommandContext &ctx)
|
|||||||
static bool
|
static bool
|
||||||
cmd_theme_set_by_name(CommandContext &ctx)
|
cmd_theme_set_by_name(CommandContext &ctx)
|
||||||
{
|
{
|
||||||
|
|
||||||
# if defined(KTE_BUILD_GUI) && defined(KTE_USE_QT)
|
# if defined(KTE_BUILD_GUI) && defined(KTE_USE_QT)
|
||||||
// Qt GUI build: schedule theme change for frontend
|
// Qt GUI build: schedule theme change for frontend
|
||||||
std::string name = ctx.arg;
|
std::string name = ctx.arg;
|
||||||
// trim spaces
|
// trim spaces
|
||||||
auto ltrim = [](std::string &s) {
|
auto ltrim = [](std::string &s) {
|
||||||
s.erase(s.begin(), std::find_if(s.begin(), s.end(), [](unsigned char ch) {
|
s.erase(s.begin(), std::find_if(s.begin(), s.end(), [](unsigned char ch) {
|
||||||
return !std::isspace(ch);
|
return !std::isspace(ch);
|
||||||
}));
|
}));
|
||||||
};
|
};
|
||||||
auto rtrim = [](std::string &s) {
|
auto rtrim = [](std::string &s) {
|
||||||
s.erase(std::find_if(s.rbegin(), s.rend(), [](unsigned char ch) {
|
s.erase(std::find_if(s.rbegin(), s.rend(), [](unsigned char ch) {
|
||||||
return !std::isspace(ch);
|
return !std::isspace(ch);
|
||||||
}).base(), s.end());
|
}).base(), s.end());
|
||||||
};
|
};
|
||||||
ltrim(name);
|
ltrim (name);
|
||||||
rtrim(name);
|
rtrim (name);
|
||||||
if (name.empty()) {
|
if (name.empty()) {
|
||||||
ctx.editor.SetStatus("theme: provide a name (e.g., nord, solarized-dark, gruvbox-light, eink)");
|
ctx.editor.SetStatus("theme: provide a name (e.g., nord, solarized-dark, gruvbox-light, eink)");
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
kte::gThemeChangeRequest = name;
|
kte::gThemeChangeRequest= name;
|
||||||
kte::gThemeChangePending = true;
|
kte::gThemeChangePending=true;
|
||||||
ctx.editor.SetStatus(std::string("Theme requested: ") + name);
|
ctx.editor.SetStatus (std::string("Theme requested: ") + name);
|
||||||
return true;
|
return true;
|
||||||
# else
|
# else
|
||||||
(void) ctx;
|
(void) ctx;
|
||||||
// No-op in terminal build
|
// No-op in terminal build
|
||||||
return true;
|
return true;
|
||||||
# endif
|
# endif
|
||||||
}
|
}
|
||||||
@@ -4990,4 +4991,4 @@ Execute(Editor &ed, const std::string &name, const std::string &arg, int count)
|
|||||||
return false;
|
return false;
|
||||||
CommandContext ctx{ed, arg, count};
|
CommandContext ctx{ed, arg, count};
|
||||||
return cmd->handler ? cmd->handler(ctx) : false;
|
return cmd->handler ? cmd->handler(ctx) : false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -164,4 +164,4 @@ void InstallDefaultCommands();
|
|||||||
// Returns true if the command executed successfully.
|
// Returns true if the command executed successfully.
|
||||||
bool Execute(Editor &ed, CommandId id, const std::string &arg = std::string(), int count = 0);
|
bool Execute(Editor &ed, CommandId id, const std::string &arg = std::string(), int count = 0);
|
||||||
|
|
||||||
bool Execute(Editor &ed, const std::string &name, const std::string &arg = std::string(), int count = 0);
|
bool Execute(Editor &ed, const std::string &name, const std::string &arg = std::string(), int count = 0);
|
||||||
|
|||||||
23
Dockerfile
Normal file
23
Dockerfile
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# Minimal Dockerfile for building and testing kte on Linux
|
||||||
|
# This container provides a build environment with all dependencies.
|
||||||
|
# Mount the source tree at /kte when running the container.
|
||||||
|
FROM alpine:3.19
|
||||||
|
|
||||||
|
# Install build dependencies
|
||||||
|
RUN apk add --no-cache \
|
||||||
|
g++ \
|
||||||
|
cmake \
|
||||||
|
make \
|
||||||
|
ncurses-dev \
|
||||||
|
sdl2-dev \
|
||||||
|
mesa-dev \
|
||||||
|
freetype-dev \
|
||||||
|
libx11-dev \
|
||||||
|
libxext-dev
|
||||||
|
|
||||||
|
# Set working directory where source will be mounted
|
||||||
|
WORKDIR /kte
|
||||||
|
|
||||||
|
# Default command: build and run tests
|
||||||
|
# Add DirectFB include path for SDL2 compatibility on Alpine
|
||||||
|
CMD ["sh", "-c", "cmake -B build -DBUILD_GUI=ON -DBUILD_TESTS=ON -DCMAKE_CXX_FLAGS='-I/usr/include/directfb' && cmake --build build --target kte && cmake --build build --target kge && cmake --build build --target kte_tests && ./build/kte_tests"]
|
||||||
31
Editor.cc
31
Editor.cc
@@ -13,9 +13,9 @@ namespace {
|
|||||||
static std::string
|
static std::string
|
||||||
buffer_bytes_via_views(const Buffer &b)
|
buffer_bytes_via_views(const Buffer &b)
|
||||||
{
|
{
|
||||||
const auto &rows = b.Rows();
|
const std::size_t nrows = b.Nrows();
|
||||||
std::string out;
|
std::string out;
|
||||||
for (std::size_t i = 0; i < rows.size(); i++) {
|
for (std::size_t i = 0; i < nrows; i++) {
|
||||||
auto v = b.GetLineView(i);
|
auto v = b.GetLineView(i);
|
||||||
out.append(v.data(), v.size());
|
out.append(v.data(), v.size());
|
||||||
}
|
}
|
||||||
@@ -198,9 +198,9 @@ Editor::OpenFile(const std::string &path, std::string &err)
|
|||||||
Buffer &cur = buffers_[curbuf_];
|
Buffer &cur = buffers_[curbuf_];
|
||||||
const bool unnamed = cur.Filename().empty() && !cur.IsFileBacked();
|
const bool unnamed = cur.Filename().empty() && !cur.IsFileBacked();
|
||||||
const bool clean = !cur.Dirty();
|
const bool clean = !cur.Dirty();
|
||||||
const auto &rows = cur.Rows();
|
const std::size_t nrows = cur.Nrows();
|
||||||
const bool rows_empty = rows.empty();
|
const bool rows_empty = (nrows == 0);
|
||||||
const bool single_empty_line = (!rows.empty() && rows.size() == 1 && rows[0].size() == 0);
|
const bool single_empty_line = (nrows == 1 && cur.GetLineView(0).size() == 0);
|
||||||
if (unnamed && clean && (rows_empty || single_empty_line)) {
|
if (unnamed && clean && (rows_empty || single_empty_line)) {
|
||||||
bool ok = cur.OpenFromFile(path, err);
|
bool ok = cur.OpenFromFile(path, err);
|
||||||
if (!ok)
|
if (!ok)
|
||||||
@@ -213,10 +213,9 @@ Editor::OpenFile(const std::string &path, std::string &err)
|
|||||||
}
|
}
|
||||||
// Setup highlighting using registry (extension + shebang)
|
// Setup highlighting using registry (extension + shebang)
|
||||||
cur.EnsureHighlighter();
|
cur.EnsureHighlighter();
|
||||||
std::string first = "";
|
std::string first = "";
|
||||||
const auto &cur_rows = cur.Rows();
|
if (cur.Nrows() > 0)
|
||||||
if (!cur_rows.empty())
|
first = cur.GetLineString(0);
|
||||||
first = static_cast<std::string>(cur_rows[0]);
|
|
||||||
std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
|
std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
|
||||||
if (!ft.empty()) {
|
if (!ft.empty()) {
|
||||||
cur.SetFiletype(ft);
|
cur.SetFiletype(ft);
|
||||||
@@ -248,11 +247,8 @@ Editor::OpenFile(const std::string &path, std::string &err)
|
|||||||
// Initialize syntax highlighting by extension + shebang via registry (v2)
|
// Initialize syntax highlighting by extension + shebang via registry (v2)
|
||||||
b.EnsureHighlighter();
|
b.EnsureHighlighter();
|
||||||
std::string first = "";
|
std::string first = "";
|
||||||
{
|
if (b.Nrows() > 0)
|
||||||
const auto &rows = b.Rows();
|
first = b.GetLineString(0);
|
||||||
if (!rows.empty())
|
|
||||||
first = static_cast<std::string>(rows[0]);
|
|
||||||
}
|
|
||||||
std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
|
std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
|
||||||
if (!ft.empty()) {
|
if (!ft.empty()) {
|
||||||
b.SetFiletype(ft);
|
b.SetFiletype(ft);
|
||||||
@@ -486,9 +482,10 @@ Editor::CloseBuffer(std::size_t index)
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if (swap_) {
|
if (swap_) {
|
||||||
// If the buffer is clean, remove its swap file when closing.
|
// Always remove swap file when closing a buffer on normal exit.
|
||||||
// (Crash recovery is unaffected: on crash, close paths are not executed.)
|
// Swap files are for crash recovery; on clean close, we don't need them.
|
||||||
swap_->Detach(&buffers_[index], !buffers_[index].Dirty());
|
// This prevents stale swap files from accumulating (e.g., when used as git editor).
|
||||||
|
swap_->Detach(&buffers_[index], true);
|
||||||
buffers_[index].SetSwapRecorder(nullptr);
|
buffers_[index].SetSwapRecorder(nullptr);
|
||||||
}
|
}
|
||||||
buffers_.erase(buffers_.begin() + static_cast<std::ptrdiff_t>(index));
|
buffers_.erase(buffers_.begin() + static_cast<std::ptrdiff_t>(index));
|
||||||
|
|||||||
37
Editor.h
37
Editor.h
@@ -1,5 +1,42 @@
|
|||||||
/*
|
/*
|
||||||
* Editor.h - top-level editor state and buffer management
|
* Editor.h - top-level editor state and buffer management
|
||||||
|
*
|
||||||
|
* Editor is the top-level coordinator in kte. It manages:
|
||||||
|
*
|
||||||
|
* - Buffer collection: Multiple open documents (buffers_), current buffer selection
|
||||||
|
* - UI state: Dimensions, status messages, prompts, search state
|
||||||
|
* - Kill ring: Shared clipboard for cut/copy/paste operations across buffers
|
||||||
|
* - Universal argument: Repeat count mechanism (C-u)
|
||||||
|
* - Mode flags: Editor modes (normal, k-command, search, prompt, etc.)
|
||||||
|
* - Swap/crash recovery: SwapManager integration for journaling
|
||||||
|
* - File operations: Opening files, managing pending opens, recovery prompts
|
||||||
|
*
|
||||||
|
* Key responsibilities:
|
||||||
|
*
|
||||||
|
* 1. Buffer lifecycle:
|
||||||
|
* - AddBuffer(): Add new buffers to the collection
|
||||||
|
* - OpenFile(): Load files into buffers
|
||||||
|
* - SwitchTo(): Change active buffer
|
||||||
|
* - CloseBuffer(): Remove buffers with dirty checks
|
||||||
|
*
|
||||||
|
* 2. UI coordination:
|
||||||
|
* - SetDimensions(): Terminal/window size for viewport calculations
|
||||||
|
* - SetStatus(): Status line messages with timestamps
|
||||||
|
* - Prompt system: Multi-step prompts for file open, buffer switch, etc.
|
||||||
|
* - Search state: Active search, query, match position, origin tracking
|
||||||
|
*
|
||||||
|
* 3. Shared editor state:
|
||||||
|
* - Kill ring: Circular buffer of killed text (max 60 entries)
|
||||||
|
* - Universal argument: C-u digit collection for command repetition
|
||||||
|
* - Mode tracking: Current input mode (normal, k-command, ESC, prompt)
|
||||||
|
*
|
||||||
|
* 4. Integration points:
|
||||||
|
* - Commands operate on Editor and current Buffer
|
||||||
|
* - Frontend (Terminal/GUI) queries Editor for rendering
|
||||||
|
* - SwapManager journals all buffer modifications
|
||||||
|
*
|
||||||
|
* Design note: Editor owns the buffer collection but doesn't directly edit content.
|
||||||
|
* Commands modify buffers through Buffer's API, and Editor coordinates the UI state.
|
||||||
*/
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
#include <cstddef>
|
#include <cstddef>
|
||||||
|
|||||||
@@ -19,4 +19,4 @@ public:
|
|||||||
|
|
||||||
// Shutdown/cleanup
|
// Shutdown/cleanup
|
||||||
virtual void Shutdown() = 0;
|
virtual void Shutdown() = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -127,4 +127,4 @@ GUIConfig::LoadFromFile(const std::string &path)
|
|||||||
}
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -30,4 +30,4 @@ public:
|
|||||||
|
|
||||||
// Load from explicit path. Returns true if file existed and was parsed.
|
// Load from explicit path. Returns true if file existed and was parsed.
|
||||||
bool LoadFromFile(const std::string &path);
|
bool LoadFromFile(const std::string &path);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -942,4 +942,4 @@ SyntaxInk(const TokenKind k)
|
|||||||
}
|
}
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|
||||||
#endif // KTE_USE_QT
|
#endif // KTE_USE_QT
|
||||||
|
|||||||
@@ -22,7 +22,9 @@ HelpText::Text()
|
|||||||
" C-k ' Toggle read-only\n"
|
" C-k ' Toggle read-only\n"
|
||||||
" C-k - Unindent region (mark required)\n"
|
" C-k - Unindent region (mark required)\n"
|
||||||
" C-k = Indent region (mark required)\n"
|
" C-k = Indent region (mark required)\n"
|
||||||
|
" C-k / Toggle visual line mode\n"
|
||||||
" C-k ; Command prompt (:\\ )\n"
|
" C-k ; Command prompt (:\\ )\n"
|
||||||
|
" C-k SPACE Toggle mark\n"
|
||||||
" C-k C-d Kill entire line\n"
|
" C-k C-d Kill entire line\n"
|
||||||
" C-k C-q Quit now (no confirm)\n"
|
" C-k C-q Quit now (no confirm)\n"
|
||||||
" C-k C-x Save and quit\n"
|
" C-k C-x Save and quit\n"
|
||||||
@@ -31,11 +33,12 @@ HelpText::Text()
|
|||||||
" C-k c Close current buffer\n"
|
" C-k c Close current buffer\n"
|
||||||
" C-k d Kill to end of line\n"
|
" C-k d Kill to end of line\n"
|
||||||
" C-k e Open file (prompt)\n"
|
" C-k e Open file (prompt)\n"
|
||||||
" C-k i New empty buffer\n"
|
|
||||||
" C-k f Flush kill ring\n"
|
" C-k f Flush kill ring\n"
|
||||||
" C-k g Jump to line\n"
|
" C-k g Jump to line\n"
|
||||||
" C-k h Show this help\n"
|
" C-k h Show this help\n"
|
||||||
|
" C-k i New empty buffer\n"
|
||||||
" C-k j Jump to mark\n"
|
" C-k j Jump to mark\n"
|
||||||
|
" C-k k Center viewport on cursor\n"
|
||||||
" C-k l Reload buffer from disk\n"
|
" C-k l Reload buffer from disk\n"
|
||||||
" C-k n Previous buffer\n"
|
" C-k n Previous buffer\n"
|
||||||
" C-k o Change working directory (prompt)\n"
|
" C-k o Change working directory (prompt)\n"
|
||||||
|
|||||||
@@ -10,4 +10,4 @@ public:
|
|||||||
// Project maintainers can customize the returned string below
|
// Project maintainers can customize the returned string below
|
||||||
// (in HelpText.cc) without touching the help command logic.
|
// (in HelpText.cc) without touching the help command logic.
|
||||||
static std::string Text();
|
static std::string Text();
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -34,4 +34,4 @@ struct LineHighlight {
|
|||||||
std::vector<HighlightSpan> spans;
|
std::vector<HighlightSpan> spans;
|
||||||
std::uint64_t version{0}; // buffer version used for this line
|
std::uint64_t version{0}; // buffer version used for this line
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -391,4 +391,4 @@ GUIFrontend::LoadGuiFont_(const char * /*path*/, const float size_px)
|
|||||||
|
|
||||||
io.Fonts->Build();
|
io.Fonts->Build();
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -33,4 +33,4 @@ private:
|
|||||||
SDL_GLContext gl_ctx_ = nullptr;
|
SDL_GLContext gl_ctx_ = nullptr;
|
||||||
int width_ = 1280;
|
int width_ = 1280;
|
||||||
int height_ = 800;
|
int height_ = 800;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -158,17 +158,17 @@ map_key(const SDL_Keycode key,
|
|||||||
ascii_key = static_cast<int>(key);
|
ascii_key = static_cast<int>(key);
|
||||||
}
|
}
|
||||||
bool ctrl2 = (mod & KMOD_CTRL) != 0;
|
bool ctrl2 = (mod & KMOD_CTRL) != 0;
|
||||||
// If user typed a literal 'C' (uppercase) or '^' as a control qualifier, keep k-prefix active
|
// If user typed a literal 'C' (uppercase) or '^' as a control qualifier, keep k-prefix active
|
||||||
// Do NOT treat lowercase 'c' as a qualifier; 'c' is a valid k-command (BufferClose).
|
// Do NOT treat lowercase 'c' as a qualifier; 'c' is a valid k-command (BufferClose).
|
||||||
if (ascii_key == 'C' || ascii_key == '^') {
|
if (ascii_key == 'C' || ascii_key == '^') {
|
||||||
k_ctrl_pending = true;
|
k_ctrl_pending = true;
|
||||||
// Keep waiting for the next suffix; show status and suppress ensuing TEXTINPUT
|
// Keep waiting for the next suffix; show status and suppress ensuing TEXTINPUT
|
||||||
if (ed)
|
if (ed)
|
||||||
ed->SetStatus("C-k C _");
|
ed->SetStatus("C-k C _");
|
||||||
suppress_textinput_once = true;
|
suppress_textinput_once = true;
|
||||||
out.hasCommand = false;
|
out.hasCommand = false;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
// Otherwise, consume the k-prefix now for the actual suffix
|
// Otherwise, consume the k-prefix now for the actual suffix
|
||||||
k_prefix = false;
|
k_prefix = false;
|
||||||
if (ascii_key != 0) {
|
if (ascii_key != 0) {
|
||||||
@@ -298,7 +298,7 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
// High-resolution trackpads can deliver fractional wheel deltas. Accumulate
|
// High-resolution trackpads can deliver fractional wheel deltas. Accumulate
|
||||||
// precise values and emit one scroll step per whole unit.
|
// precise values and emit one scroll step per whole unit.
|
||||||
float dy = 0.0f;
|
float dy = 0.0f;
|
||||||
#if SDL_VERSION_ATLEAST(2,0,18)
|
#if SDL_VERSION_ATLEAST(2, 0, 18)
|
||||||
dy = e.wheel.preciseY;
|
dy = e.wheel.preciseY;
|
||||||
#else
|
#else
|
||||||
dy = static_cast<float>(e.wheel.y);
|
dy = static_cast<float>(e.wheel.y);
|
||||||
@@ -308,7 +308,7 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
dy = -dy;
|
dy = -dy;
|
||||||
#endif
|
#endif
|
||||||
if (dy != 0.0f) {
|
if (dy != 0.0f) {
|
||||||
wheel_accum_y_ += dy;
|
wheel_accum_y_ += dy;
|
||||||
float abs_accum = wheel_accum_y_ >= 0.0f ? wheel_accum_y_ : -wheel_accum_y_;
|
float abs_accum = wheel_accum_y_ >= 0.0f ? wheel_accum_y_ : -wheel_accum_y_;
|
||||||
int steps = static_cast<int>(abs_accum);
|
int steps = static_cast<int>(abs_accum);
|
||||||
if (steps > 0) {
|
if (steps > 0) {
|
||||||
@@ -439,14 +439,12 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
}
|
}
|
||||||
|
|
||||||
// If editor universal argument is active, consume digit TEXTINPUT
|
// If editor universal argument is active, consume digit TEXTINPUT
|
||||||
if (ed_ &&ed_
|
if (ed_ && ed_
|
||||||
|
|
||||||
|
|
||||||
|
->
|
||||||
->
|
UArg() != 0
|
||||||
UArg() != 0
|
) {
|
||||||
)
|
|
||||||
{
|
|
||||||
const char *txt = e.text.text;
|
const char *txt = e.text.text;
|
||||||
if (txt && *txt) {
|
if (txt && *txt) {
|
||||||
unsigned char c0 = static_cast<unsigned char>(txt[0]);
|
unsigned char c0 = static_cast<unsigned char>(txt[0]);
|
||||||
@@ -473,16 +471,16 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
ascii_key = static_cast<int>(c0);
|
ascii_key = static_cast<int>(c0);
|
||||||
}
|
}
|
||||||
if (ascii_key != 0) {
|
if (ascii_key != 0) {
|
||||||
// Qualifier via TEXTINPUT: uppercase 'C' or '^' only
|
// Qualifier via TEXTINPUT: uppercase 'C' or '^' only
|
||||||
if (ascii_key == 'C' || ascii_key == '^') {
|
if (ascii_key == 'C' || ascii_key == '^') {
|
||||||
k_ctrl_pending_ = true;
|
k_ctrl_pending_ = true;
|
||||||
if (ed_)
|
if (ed_)
|
||||||
ed_->SetStatus("C-k C _");
|
ed_->SetStatus("C-k C _");
|
||||||
// Keep k-prefix active; do not emit a command
|
// Keep k-prefix active; do not emit a command
|
||||||
k_prefix_ = true;
|
k_prefix_ = true;
|
||||||
produced = true;
|
produced = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
// Map via k-prefix table; do not pass Ctrl for TEXTINPUT case
|
// Map via k-prefix table; do not pass Ctrl for TEXTINPUT case
|
||||||
CommandId id;
|
CommandId id;
|
||||||
bool pass_ctrl = k_ctrl_pending_;
|
bool pass_ctrl = k_ctrl_pending_;
|
||||||
@@ -608,4 +606,4 @@ ImGuiInputHandler::Poll(MappedInput &out)
|
|||||||
out = q_.front();
|
out = q_.front();
|
||||||
q_.pop();
|
q_.pop();
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -46,4 +46,4 @@ private:
|
|||||||
// command per whole step and keep the fractional remainder.
|
// command per whole step and keep the fractional remainder.
|
||||||
float wheel_accum_y_ = 0.0f;
|
float wheel_accum_y_ = 0.0f;
|
||||||
float wheel_accum_x_ = 0.0f; // reserved for future horizontal scrolling
|
float wheel_accum_x_ = 0.0f; // reserved for future horizontal scrolling
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -927,4 +927,4 @@ ImGuiRenderer::Draw(Editor &ed)
|
|||||||
ed.SetFilePickerVisible(false);
|
ed.SetFilePickerVisible(false);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,4 +11,4 @@ public:
|
|||||||
~ImGuiRenderer() override = default;
|
~ImGuiRenderer() override = default;
|
||||||
|
|
||||||
void Draw(Editor &ed) override;
|
void Draw(Editor &ed) override;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -28,4 +28,4 @@ public:
|
|||||||
// Poll for input and translate it to a command. Non-blocking.
|
// Poll for input and translate it to a command. Non-blocking.
|
||||||
// Returns true if a command is available in 'out'. Returns false if no input.
|
// Returns true if a command is available in 'out'. Returns false if no input.
|
||||||
virtual bool Poll(MappedInput &out) = 0;
|
virtual bool Poll(MappedInput &out) = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -230,4 +230,4 @@ KLookupEscCommand(const int ascii_key, CommandId &out) -> bool
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,4 +27,4 @@ KLowerAscii(const int key)
|
|||||||
if (key >= 'A' && key <= 'Z')
|
if (key >= 'A' && key <= 'Z')
|
||||||
return key + ('a' - 'A');
|
return key + ('a' - 'A');
|
||||||
return key;
|
return key;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,4 +20,4 @@ private:
|
|||||||
std::string last_pat_;
|
std::string last_pat_;
|
||||||
|
|
||||||
void build_bad_char(const std::string &pattern);
|
void build_bad_char(const std::string &pattern);
|
||||||
};
|
};
|
||||||
|
|||||||
36
PieceTable.h
36
PieceTable.h
@@ -1,5 +1,39 @@
|
|||||||
/*
|
/*
|
||||||
* PieceTable.h - Alternative to GapBuffer using a piece table representation
|
* PieceTable.h - Alternative to GapBuffer using a piece table representation
|
||||||
|
*
|
||||||
|
* PieceTable is kte's core text storage data structure. It provides efficient
|
||||||
|
* insert/delete operations without copying the entire buffer by maintaining a
|
||||||
|
* sequence of "pieces" that reference ranges in two underlying buffers:
|
||||||
|
* - original_: Initial file content (currently unused, reserved for future)
|
||||||
|
* - add_: All text added during editing
|
||||||
|
*
|
||||||
|
* Key advantages:
|
||||||
|
* - O(1) append/prepend operations (common case)
|
||||||
|
* - O(n) insert/delete at arbitrary positions (n = number of pieces, not bytes)
|
||||||
|
* - Efficient undo: just restore the piece list
|
||||||
|
* - Memory efficient: no gap buffer waste
|
||||||
|
*
|
||||||
|
* Performance characteristics:
|
||||||
|
* - Piece count grows with edit operations; automatic consolidation prevents unbounded growth
|
||||||
|
* - Materialization (Data() call) is O(total_size) but cached until next edit
|
||||||
|
* - Line index is lazily rebuilt on first line-based query after edits
|
||||||
|
* - Range and Find operations use lightweight caches for repeated queries
|
||||||
|
*
|
||||||
|
* API evolution:
|
||||||
|
* 1. Legacy API (GapBuffer compatibility):
|
||||||
|
* - Append/Prepend: Build content sequentially
|
||||||
|
* - Data(): Materialize entire buffer
|
||||||
|
*
|
||||||
|
* 2. New buffer-wide API (Phase 1):
|
||||||
|
* - Insert/Delete: Edit at arbitrary byte offsets
|
||||||
|
* - Line-based queries: LineCount, GetLine, GetLineRange
|
||||||
|
* - Position conversion: ByteOffsetToLineCol, LineColToByteOffset
|
||||||
|
* - Efficient extraction: GetRange, Find, WriteToStream
|
||||||
|
*
|
||||||
|
* Implementation notes:
|
||||||
|
* - Consolidation heuristics prevent piece fragmentation (configurable via SetConsolidationParams)
|
||||||
|
* - Thread-safe for concurrent reads (mutex protects caches and lazy rebuilds)
|
||||||
|
* - Version tracking invalidates caches on mutations
|
||||||
*/
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
#include <cstddef>
|
#include <cstddef>
|
||||||
@@ -184,4 +218,4 @@ private:
|
|||||||
mutable FindCache find_cache_;
|
mutable FindCache find_cache_;
|
||||||
|
|
||||||
mutable std::mutex mutex_;
|
mutable std::mutex mutex_;
|
||||||
};
|
};
|
||||||
@@ -123,8 +123,7 @@ protected:
|
|||||||
if (ed_ && viewport.height() > 0 && viewport.width() > 0) {
|
if (ed_ && viewport.height() > 0 && viewport.width() > 0) {
|
||||||
const Buffer *buf = ed_->CurrentBuffer();
|
const Buffer *buf = ed_->CurrentBuffer();
|
||||||
if (buf) {
|
if (buf) {
|
||||||
const auto &lines = buf->Rows();
|
const std::size_t nrows = buf->Nrows();
|
||||||
const std::size_t nrows = lines.size();
|
|
||||||
const std::size_t rowoffs = buf->Rowoffs();
|
const std::size_t rowoffs = buf->Rowoffs();
|
||||||
const std::size_t coloffs = buf->Coloffs();
|
const std::size_t coloffs = buf->Coloffs();
|
||||||
const std::size_t cy = buf->Cury();
|
const std::size_t cy = buf->Cury();
|
||||||
@@ -144,9 +143,8 @@ protected:
|
|||||||
|
|
||||||
// Iterate visible lines
|
// Iterate visible lines
|
||||||
for (std::size_t i = rowoffs, vis_idx = 0; i < last_row; ++i, ++vis_idx) {
|
for (std::size_t i = rowoffs, vis_idx = 0; i < last_row; ++i, ++vis_idx) {
|
||||||
// Materialize the Buffer::Line into a std::string for
|
// Get line as string for regex/iterator usage and general string ops.
|
||||||
// regex/iterator usage and general string ops.
|
const std::string line = buf->GetLineString(i);
|
||||||
const std::string line = static_cast<std::string>(lines[i]);
|
|
||||||
const int y = viewport.y() + static_cast<int>(vis_idx) * line_h;
|
const int y = viewport.y() + static_cast<int>(vis_idx) * line_h;
|
||||||
const int baseline = y + fm.ascent();
|
const int baseline = y + fm.ascent();
|
||||||
|
|
||||||
|
|||||||
@@ -33,4 +33,4 @@ private:
|
|||||||
QWidget *window_ = nullptr; // owned
|
QWidget *window_ = nullptr; // owned
|
||||||
int width_ = 1280;
|
int width_ = 1280;
|
||||||
int height_ = 800;
|
int height_ = 800;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -283,12 +283,11 @@ QtInputHandler::ProcessKeyEvent(const QKeyEvent &e)
|
|||||||
const bool ctrl_like = (mods & Qt::ControlModifier);
|
const bool ctrl_like = (mods & Qt::ControlModifier);
|
||||||
|
|
||||||
// 1) Universal argument digits (when active), consume digits without enqueuing commands
|
// 1) Universal argument digits (when active), consume digits without enqueuing commands
|
||||||
if (ed_ &&ed_
|
if (ed_ && ed_
|
||||||
|
|
||||||
->
|
->
|
||||||
UArg() != 0
|
UArg() != 0
|
||||||
)
|
) {
|
||||||
{
|
|
||||||
if (!(mods & (Qt::ControlModifier | Qt::AltModifier | Qt::MetaModifier))) {
|
if (!(mods & (Qt::ControlModifier | Qt::AltModifier | Qt::MetaModifier))) {
|
||||||
if (e.key() >= Qt::Key_0 && e.key() <= Qt::Key_9) {
|
if (e.key() >= Qt::Key_0 && e.key() <= Qt::Key_9) {
|
||||||
int d = e.key() - Qt::Key_0;
|
int d = e.key() - Qt::Key_0;
|
||||||
@@ -379,10 +378,9 @@ QtInputHandler::ProcessKeyEvent(const QKeyEvent &e)
|
|||||||
// ESC/meta chords: on macOS, do NOT treat Meta as ESC; only Alt (Option) should trigger.
|
// ESC/meta chords: on macOS, do NOT treat Meta as ESC; only Alt (Option) should trigger.
|
||||||
#if defined(__APPLE__)
|
#if defined(__APPLE__)
|
||||||
if (esc_meta_ || (mods & Qt::AltModifier)) {
|
if (esc_meta_ || (mods & Qt::AltModifier)) {
|
||||||
|
|
||||||
|
|
||||||
#else
|
#else
|
||||||
if (esc_meta_ || (mods & (Qt::AltModifier | Qt::MetaModifier))) {
|
if (esc_meta_ || (mods & (Qt::AltModifier | Qt::MetaModifier))) {
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
int ascii_key = 0;
|
int ascii_key = 0;
|
||||||
if (e.key() == Qt::Key_Backspace) {
|
if (e.key() == Qt::Key_Backspace) {
|
||||||
@@ -535,4 +533,4 @@ QtInputHandler::Poll(MappedInput &out)
|
|||||||
out = q_.front();
|
out = q_.front();
|
||||||
q_.pop();
|
q_.pop();
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -37,4 +37,4 @@ private:
|
|||||||
bool esc_meta_ = false; // ESC-prefix for next key
|
bool esc_meta_ = false; // ESC-prefix for next key
|
||||||
bool suppress_text_input_once_ = false; // reserved (Qt sends text in keyPressEvent)
|
bool suppress_text_input_once_ = false; // reserved (Qt sends text in keyPressEvent)
|
||||||
Editor *ed_ = nullptr;
|
Editor *ed_ = nullptr;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -73,4 +73,4 @@ QtRenderer::Draw(Editor &ed)
|
|||||||
}
|
}
|
||||||
// Request a repaint
|
// Request a repaint
|
||||||
widget_->update();
|
widget_->update();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,4 +24,4 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
QWidget *widget_ = nullptr; // not owned
|
QWidget *widget_ = nullptr; // not owned
|
||||||
};
|
};
|
||||||
|
|||||||
14
README.md
14
README.md
@@ -39,15 +39,13 @@ subject to refinement):
|
|||||||
`C-g`.
|
`C-g`.
|
||||||
- Save/Exit: `C-k s` (save), `C-k x` or `C-k C-x` (save and exit),
|
- Save/Exit: `C-k s` (save), `C-k x` or `C-k C-x` (save and exit),
|
||||||
`C-k q` (quit with confirm), `C-k C-q` (quit immediately).
|
`C-k q` (quit with confirm), `C-k C-q` (quit immediately).
|
||||||
- Editing: `C-k d` (kill to EOL), `C-k C-d` (kill line), `C-k
|
- Editing: `C-k d` (kill to EOL), `C-k C-d` (kill line), `C-w` (kill
|
||||||
BACKSPACE` (kill to BOL), `C-w` (kill region), `C-y` ( yank), `C-u`
|
region), `C-y` (yank), `C-u` (universal argument).
|
||||||
(universal argument).
|
|
||||||
- Navigation/Search: `C-s` (incremental find), `C-r` (regex search),
|
- Navigation/Search: `C-s` (incremental find), `C-r` (regex search),
|
||||||
`ESC f/b` (word next/prev), `ESC BACKSPACE` (delete previous word).
|
`ESC f/b` (word next/prev), `ESC BACKSPACE` (delete previous word).
|
||||||
- Buffers/Files: `C-k e` (open), `C-k b`/`C-k p` (switch), `C-k c`
|
- Buffers/Files: `C-k e` (open), `C-k b`/`C-k p` (switch), `C-k c`
|
||||||
(close), `C-k C-r` (reload).
|
(close), `C-k l` (reload).
|
||||||
- Misc: `C-l` (refresh), `C-g` (cancel), `C-k m` (run make), `C-k g`
|
- Misc: `C-l` (refresh), `C-g` (cancel), `C-k g` (goto line).
|
||||||
(goto line).
|
|
||||||
|
|
||||||
See `ke.md` for the canonical ke reference retained for now.
|
See `ke.md` for the canonical ke reference retained for now.
|
||||||
|
|
||||||
@@ -71,8 +69,8 @@ Dependencies by platform
|
|||||||
- Terminal (default):
|
- Terminal (default):
|
||||||
- `sudo apt-get install -y libncurses5-dev libncursesw5-dev`
|
- `sudo apt-get install -y libncurses5-dev libncursesw5-dev`
|
||||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||||
-
|
-
|
||||||
`sudo apt-get install -y libsdl2-dev libfreetype6-dev mesa-common-dev`
|
`sudo apt-get install -y libsdl2-dev libfreetype6-dev mesa-common-dev`
|
||||||
- The `mesa-common-dev` package provides OpenGL headers/libs (
|
- The `mesa-common-dev` package provides OpenGL headers/libs (
|
||||||
`libGL`).
|
`libGL`).
|
||||||
|
|
||||||
|
|||||||
@@ -10,4 +10,4 @@ public:
|
|||||||
virtual ~Renderer() = default;
|
virtual ~Renderer() = default;
|
||||||
|
|
||||||
virtual void Draw(Editor &ed) = 0;
|
virtual void Draw(Editor &ed) = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
16
Swap.cc
16
Swap.cc
@@ -25,14 +25,14 @@ constexpr std::uint32_t VERSION = 1;
|
|||||||
static std::string
|
static std::string
|
||||||
snapshot_buffer_bytes(const Buffer &b)
|
snapshot_buffer_bytes(const Buffer &b)
|
||||||
{
|
{
|
||||||
const auto &rows = b.Rows();
|
const std::size_t nrows = b.Nrows();
|
||||||
std::string out;
|
std::string out;
|
||||||
// Cheap lower bound: sum of row sizes.
|
// Cheap lower bound: sum of row sizes.
|
||||||
std::size_t approx = 0;
|
std::size_t approx = 0;
|
||||||
for (const auto &r: rows)
|
for (std::size_t i = 0; i < nrows; i++)
|
||||||
approx += r.size();
|
approx += b.GetLineView(i).size();
|
||||||
out.reserve(approx);
|
out.reserve(approx);
|
||||||
for (std::size_t i = 0; i < rows.size(); i++) {
|
for (std::size_t i = 0; i < nrows; i++) {
|
||||||
auto v = b.GetLineView(i);
|
auto v = b.GetLineView(i);
|
||||||
out.append(v.data(), v.size());
|
out.append(v.data(), v.size());
|
||||||
}
|
}
|
||||||
@@ -284,8 +284,10 @@ SwapManager::Attach(Buffer *buf)
|
|||||||
void
|
void
|
||||||
SwapManager::Detach(Buffer *buf, const bool remove_file)
|
SwapManager::Detach(Buffer *buf, const bool remove_file)
|
||||||
{
|
{
|
||||||
if (!buf)
|
if (!buf) {
|
||||||
return;
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// Write a best-effort final checkpoint before suspending and closing.
|
// Write a best-effort final checkpoint before suspending and closing.
|
||||||
// If the caller requested removal, skip the final checkpoint so the file can be deleted.
|
// If the caller requested removal, skip the final checkpoint so the file can be deleted.
|
||||||
if (!remove_file)
|
if (!remove_file)
|
||||||
@@ -297,6 +299,7 @@ SwapManager::Detach(Buffer *buf, const bool remove_file)
|
|||||||
it->second.suspended = true;
|
it->second.suspended = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
Flush(buf);
|
Flush(buf);
|
||||||
std::string path;
|
std::string path;
|
||||||
{
|
{
|
||||||
@@ -309,6 +312,7 @@ SwapManager::Detach(Buffer *buf, const bool remove_file)
|
|||||||
}
|
}
|
||||||
recorders_.erase(buf);
|
recorders_.erase(buf);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (remove_file && !path.empty()) {
|
if (remove_file && !path.empty()) {
|
||||||
(void) std::remove(path.c_str());
|
(void) std::remove(path.c_str());
|
||||||
}
|
}
|
||||||
@@ -1292,4 +1296,4 @@ SwapManager::ReplayFile(Buffer &buf, const std::string &swap_path, std::string &
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
2
Swap.h
2
Swap.h
@@ -223,4 +223,4 @@ private:
|
|||||||
std::atomic<bool> running_{false};
|
std::atomic<bool> running_{false};
|
||||||
std::thread worker_;
|
std::thread worker_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -16,4 +16,4 @@ public:
|
|||||||
|
|
||||||
virtual void OnDelete(int row, int col, std::size_t len) = 0;
|
virtual void OnDelete(int row, int col, std::size_t len) = 0;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -126,4 +126,4 @@ TerminalFrontend::Shutdown()
|
|||||||
have_old_sigint_ = false;
|
have_old_sigint_ = false;
|
||||||
}
|
}
|
||||||
endwin();
|
endwin();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -38,4 +38,4 @@ private:
|
|||||||
// Saved SIGINT handler to restore on shutdown
|
// Saved SIGINT handler to restore on shutdown
|
||||||
bool have_old_sigint_ = false;
|
bool have_old_sigint_ = false;
|
||||||
struct sigaction old_sigint_{};
|
struct sigaction old_sigint_{};
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -329,4 +329,4 @@ TerminalInputHandler::Poll(MappedInput &out)
|
|||||||
{
|
{
|
||||||
out = {};
|
out = {};
|
||||||
return decode_(out) && out.hasCommand;
|
return decode_(out) && out.hasCommand;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -34,4 +34,4 @@ private:
|
|||||||
bool mouse_selecting_ = false;
|
bool mouse_selecting_ = false;
|
||||||
|
|
||||||
Editor *ed_ = nullptr; // attached editor for uarg handling
|
Editor *ed_ = nullptr; // attached editor for uarg handling
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -615,4 +615,4 @@ TerminalRenderer::Draw(Editor &ed)
|
|||||||
}
|
}
|
||||||
|
|
||||||
refresh();
|
refresh();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,4 +12,4 @@ public:
|
|||||||
~TerminalRenderer() override;
|
~TerminalRenderer() override;
|
||||||
|
|
||||||
void Draw(Editor &ed) override;
|
void Draw(Editor &ed) override;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -35,4 +35,4 @@ TestFrontend::Step(Editor &ed, bool &running)
|
|||||||
|
|
||||||
|
|
||||||
void
|
void
|
||||||
TestFrontend::Shutdown() {}
|
TestFrontend::Shutdown() {}
|
||||||
|
|||||||
@@ -34,4 +34,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
TestInputHandler input_{};
|
TestInputHandler input_{};
|
||||||
TestRenderer renderer_{};
|
TestRenderer renderer_{};
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -27,4 +27,4 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
std::queue<MappedInput> queue_;
|
std::queue<MappedInput> queue_;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -29,4 +29,4 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
std::size_t draw_count_ = 0;
|
std::size_t draw_count_ = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -20,4 +20,4 @@ struct UndoNode {
|
|||||||
UndoNode *parent = nullptr; // previous state; null means pre-first-edit
|
UndoNode *parent = nullptr; // previous state; null means pre-first-edit
|
||||||
UndoNode *child = nullptr; // next in current timeline
|
UndoNode *child = nullptr; // next in current timeline
|
||||||
UndoNode *next = nullptr; // redo branch
|
UndoNode *next = nullptr; // redo branch
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -60,4 +60,4 @@ private:
|
|||||||
std::size_t block_size_;
|
std::size_t block_size_;
|
||||||
std::vector<std::unique_ptr<UndoNode[]> > blocks_;
|
std::vector<std::unique_ptr<UndoNode[]> > blocks_;
|
||||||
std::stack<UndoNode *> available_;
|
std::stack<UndoNode *> available_;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -452,4 +452,4 @@ UndoSystem::debug_log(const char *op) const
|
|||||||
#else
|
#else
|
||||||
(void) op;
|
(void) op;
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|||||||
41
UndoSystem.h
41
UndoSystem.h
@@ -1,3 +1,44 @@
|
|||||||
|
/*
|
||||||
|
* UndoSystem.h - undo/redo system with tree-based branching
|
||||||
|
*
|
||||||
|
* UndoSystem manages the undo/redo history for a Buffer. It provides:
|
||||||
|
*
|
||||||
|
* - Tree-based undo: Multiple redo branches at each node (not just linear history)
|
||||||
|
* - Atomic grouping: Multiple operations can be undone/redone as a single step
|
||||||
|
* - Dirty tracking: Marks when buffer matches last saved state
|
||||||
|
* - Efficient storage: Nodes stored in UndoTree, operations applied to Buffer
|
||||||
|
*
|
||||||
|
* Key concepts:
|
||||||
|
*
|
||||||
|
* 1. Undo tree structure:
|
||||||
|
* - Each edit creates a node in the tree
|
||||||
|
* - Undo moves up the tree (toward root)
|
||||||
|
* - Redo moves down the tree (toward leaves)
|
||||||
|
* - Multiple redo branches preserved (not lost on new edits after undo)
|
||||||
|
*
|
||||||
|
* 2. Operation lifecycle:
|
||||||
|
* - Begin(type): Start recording an operation (insert/delete)
|
||||||
|
* - Append(text): Add content to the pending operation
|
||||||
|
* - commit(): Finalize and add to undo tree
|
||||||
|
* - discard_pending(): Cancel without recording
|
||||||
|
*
|
||||||
|
* 3. Atomic grouping:
|
||||||
|
* - BeginGroup()/EndGroup(): Bracket multiple operations
|
||||||
|
* - All operations in a group share the same group_id
|
||||||
|
* - Undo/redo treats the entire group as one step
|
||||||
|
*
|
||||||
|
* 4. Integration with Buffer:
|
||||||
|
* - UndoSystem holds a reference to its owning Buffer
|
||||||
|
* - apply() executes undo/redo by calling Buffer's editing methods
|
||||||
|
* - Buffer's dirty flag updated automatically
|
||||||
|
*
|
||||||
|
* Usage pattern:
|
||||||
|
* undo_system.Begin(UndoType::Insert);
|
||||||
|
* undo_system.Append("text");
|
||||||
|
* undo_system.commit(); // Now undoable
|
||||||
|
*
|
||||||
|
* See also: UndoTree.h (storage), UndoNode.h (node structure)
|
||||||
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
#include <string_view>
|
#include <string_view>
|
||||||
#include <cstddef>
|
#include <cstddef>
|
||||||
|
|||||||
@@ -7,4 +7,4 @@ struct UndoTree {
|
|||||||
UndoNode *current = nullptr; // current state of buffer
|
UndoNode *current = nullptr; // current state of buffer
|
||||||
UndoNode *saved = nullptr; // points to node matching last save (for dirty flag)
|
UndoNode *saved = nullptr; // points to node matching last save (for dirty flag)
|
||||||
UndoNode *pending = nullptr; // in-progress batch (detached)
|
UndoNode *pending = nullptr; // in-progress batch (detached)
|
||||||
};
|
};
|
||||||
|
|||||||
28
docker-build.sh
Executable file
28
docker-build.sh
Executable file
@@ -0,0 +1,28 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# Helper script to test Linux builds using Docker/Podman
|
||||||
|
# This script mounts the current source tree into a Linux container,
|
||||||
|
# builds kte in terminal-only mode, and runs the test suite.
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Detect whether to use docker or podman
|
||||||
|
if command -v docker &> /dev/null; then
|
||||||
|
CONTAINER_CMD="docker"
|
||||||
|
elif command -v podman &> /dev/null; then
|
||||||
|
CONTAINER_CMD="podman"
|
||||||
|
else
|
||||||
|
echo "Error: Neither docker nor podman found in PATH"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
IMAGE_NAME="kte-linux"
|
||||||
|
|
||||||
|
# Check if image exists, if not, build it
|
||||||
|
if ! $CONTAINER_CMD image inspect "$IMAGE_NAME" &> /dev/null; then
|
||||||
|
echo "Building $IMAGE_NAME image..."
|
||||||
|
$CONTAINER_CMD build -t "$IMAGE_NAME" .
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Run the container with the current directory mounted
|
||||||
|
echo "Running Linux build and tests..."
|
||||||
|
$CONTAINER_CMD run --rm -v "$(pwd):/kte" "$IMAGE_NAME"
|
||||||
245
docs/BENCHMARKS.md
Normal file
245
docs/BENCHMARKS.md
Normal file
@@ -0,0 +1,245 @@
|
|||||||
|
# kte Benchmarking and Testing Guide
|
||||||
|
|
||||||
|
This document describes the benchmarking infrastructure and testing
|
||||||
|
improvements added to ensure high performance and correctness of core
|
||||||
|
operations.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The kte test suite now includes comprehensive benchmarks and migration
|
||||||
|
coverage tests to:
|
||||||
|
|
||||||
|
- Measure performance of core operations (PieceTable, Buffer, syntax
|
||||||
|
highlighting)
|
||||||
|
- Ensure no performance regressions from refactorings
|
||||||
|
- Validate correctness of API migrations (Buffer::Rows() →
|
||||||
|
GetLineString/GetLineView)
|
||||||
|
- Provide performance baselines for future optimizations
|
||||||
|
|
||||||
|
## Running Tests
|
||||||
|
|
||||||
|
### All Tests (including benchmarks)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cmake --build cmake-build-debug --target kte_tests && ./cmake-build-debug/kte_tests
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test Organization
|
||||||
|
|
||||||
|
- **58 existing tests**: Core functionality, undo/redo, swap recovery,
|
||||||
|
search, etc.
|
||||||
|
- **15 benchmark tests**: Performance measurements for critical
|
||||||
|
operations
|
||||||
|
- **30 migration coverage tests**: Edge cases and correctness validation
|
||||||
|
|
||||||
|
Total: **98 tests**
|
||||||
|
|
||||||
|
## Benchmark Results
|
||||||
|
|
||||||
|
### Buffer Iteration Patterns (5,000 lines)
|
||||||
|
|
||||||
|
| Pattern | Time | Speedup vs Rows() |
|
||||||
|
|-----------------------------------------|---------|-------------------|
|
||||||
|
| `Rows()` + iteration | 3.1 ms | 1.0x (baseline) |
|
||||||
|
| `Nrows()` + `GetLineString()` | 1.9 ms | **1.7x faster** |
|
||||||
|
| `Nrows()` + `GetLineView()` (zero-copy) | 0.28 ms | **11x faster** |
|
||||||
|
|
||||||
|
**Key Insight**: `GetLineView()` provides zero-copy access and is
|
||||||
|
dramatically faster than materializing the entire rows cache.
|
||||||
|
|
||||||
|
### PieceTable Operations (10,000 lines)
|
||||||
|
|
||||||
|
| Operation | Time |
|
||||||
|
|-----------------------------|---------|
|
||||||
|
| Sequential inserts (10K) | 2.1 ms |
|
||||||
|
| Random inserts (5K) | 32.9 ms |
|
||||||
|
| `GetLine()` sequential | 4.7 ms |
|
||||||
|
| `GetLineRange()` sequential | 1.3 ms |
|
||||||
|
|
||||||
|
### Buffer Operations
|
||||||
|
|
||||||
|
| Operation | Time |
|
||||||
|
|--------------------------------------|---------|
|
||||||
|
| `Nrows()` (1M calls) | 13.0 ms |
|
||||||
|
| `GetLineString()` (10K lines) | 4.8 ms |
|
||||||
|
| `GetLineView()` (10K lines) | 1.6 ms |
|
||||||
|
| `Rows()` materialization (10K lines) | 6.2 ms |
|
||||||
|
|
||||||
|
### Syntax Highlighting
|
||||||
|
|
||||||
|
| Operation | Time | Notes |
|
||||||
|
|------------------------------------|---------|----------------|
|
||||||
|
| C++ highlighting (~1000 lines) | 2.0 ms | First pass |
|
||||||
|
| HighlighterEngine cache population | 19.9 ms | |
|
||||||
|
| HighlighterEngine cache hits | 0.52 ms | **38x faster** |
|
||||||
|
|
||||||
|
### Large File Performance
|
||||||
|
|
||||||
|
| Operation | Time |
|
||||||
|
|---------------------------------|---------|
|
||||||
|
| Insert 50K lines | 0.53 ms |
|
||||||
|
| Iterate 50K lines (GetLineView) | 2.7 ms |
|
||||||
|
| Random access (10K accesses) | 1.8 ms |
|
||||||
|
|
||||||
|
## API Differences: GetLineString vs GetLineView
|
||||||
|
|
||||||
|
Understanding the difference between these APIs is critical:
|
||||||
|
|
||||||
|
### `GetLineString(row)`
|
||||||
|
|
||||||
|
- Returns: `std::string` (copy)
|
||||||
|
- Content: Line text **without** trailing newline
|
||||||
|
- Use case: When you need to modify the string or store it
|
||||||
|
- Example: `"hello"` for line `"hello\n"`
|
||||||
|
|
||||||
|
### `GetLineView(row)`
|
||||||
|
|
||||||
|
- Returns: `std::string_view` (zero-copy)
|
||||||
|
- Content: Raw line range **including** trailing newline
|
||||||
|
- Use case: Read-only access, maximum performance
|
||||||
|
- Example: `"hello\n"` for line `"hello\n"`
|
||||||
|
- **Warning**: View becomes invalid after buffer modifications
|
||||||
|
|
||||||
|
### `Rows()`
|
||||||
|
|
||||||
|
- Returns: `std::vector<Buffer::Line>&` (materialized cache)
|
||||||
|
- Content: Lines **without** trailing newlines
|
||||||
|
- Use case: Legacy code, being phased out
|
||||||
|
- Performance: Slower due to materialization overhead
|
||||||
|
|
||||||
|
## Migration Coverage Tests
|
||||||
|
|
||||||
|
The `test_migration_coverage.cc` file provides 30 tests covering:
|
||||||
|
|
||||||
|
### Edge Cases
|
||||||
|
|
||||||
|
- Empty buffers
|
||||||
|
- Single lines (with/without newlines)
|
||||||
|
- Very long lines (10,000 characters)
|
||||||
|
- Many empty lines (1,000 newlines)
|
||||||
|
|
||||||
|
### Consistency
|
||||||
|
|
||||||
|
- `GetLineString()` vs `GetLineView()` vs `Rows()`
|
||||||
|
- Consistency after edits (insert, delete, split, join)
|
||||||
|
|
||||||
|
### Boundary Conditions
|
||||||
|
|
||||||
|
- First line access
|
||||||
|
- Last line access
|
||||||
|
- Line range boundaries
|
||||||
|
|
||||||
|
### Special Characters
|
||||||
|
|
||||||
|
- Tabs, carriage returns, null bytes
|
||||||
|
- Unicode (UTF-8 multibyte characters)
|
||||||
|
|
||||||
|
### Stress Tests
|
||||||
|
|
||||||
|
- Large files (10,000 lines)
|
||||||
|
- Many small operations (100+ inserts)
|
||||||
|
- Alternating insert/delete patterns
|
||||||
|
|
||||||
|
### Regression Tests
|
||||||
|
|
||||||
|
- Shebang detection pattern (Editor.cc)
|
||||||
|
- Empty buffer check pattern (Editor.cc)
|
||||||
|
- Syntax highlighter pattern (all highlighters)
|
||||||
|
- Swap snapshot pattern (Swap.cc)
|
||||||
|
|
||||||
|
## Performance Recommendations
|
||||||
|
|
||||||
|
Based on benchmark results:
|
||||||
|
|
||||||
|
1. **Prefer `GetLineView()` for read-only access**
|
||||||
|
- 11x faster than `Rows()` for iteration
|
||||||
|
- Zero-copy, minimal overhead
|
||||||
|
- Use immediately (view invalidates on edit)
|
||||||
|
|
||||||
|
2. **Use `GetLineString()` when you need a copy**
|
||||||
|
- Still 1.7x faster than `Rows()`
|
||||||
|
- Safe to store and modify
|
||||||
|
- Strips trailing newlines automatically
|
||||||
|
|
||||||
|
3. **Avoid `Rows()` in hot paths**
|
||||||
|
- Materializes entire line cache
|
||||||
|
- Slower for large files
|
||||||
|
- Being phased out (legacy API)
|
||||||
|
|
||||||
|
4. **Cache `Nrows()` in tight loops**
|
||||||
|
- Very fast (13ms for 1M calls)
|
||||||
|
- But still worth caching in inner loops
|
||||||
|
|
||||||
|
5. **Leverage HighlighterEngine caching**
|
||||||
|
- 38x speedup on cache hits
|
||||||
|
- Automatically invalidates on edits
|
||||||
|
- Prefetch viewport for smooth scrolling
|
||||||
|
|
||||||
|
## Adding New Benchmarks
|
||||||
|
|
||||||
|
To add a new benchmark:
|
||||||
|
|
||||||
|
1. Add a `TEST(Benchmark_YourName)` in `tests/test_benchmarks.cc`
|
||||||
|
2. Use `BenchmarkTimer` to measure critical sections:
|
||||||
|
```cpp
|
||||||
|
{
|
||||||
|
BenchmarkTimer timer("Operation description");
|
||||||
|
// ... code to benchmark ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
3. Print section headers with `std::cout` for clarity
|
||||||
|
4. Use `ASSERT_EQ` or `EXPECT_TRUE` to validate results
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
TEST(Benchmark_MyOperation) {
|
||||||
|
std::cout << "\n=== My Operation Benchmark ===\n";
|
||||||
|
|
||||||
|
// Setup
|
||||||
|
Buffer buf;
|
||||||
|
std::string data = generate_test_data();
|
||||||
|
buf.insert_text(0, 0, data);
|
||||||
|
|
||||||
|
std::size_t result = 0;
|
||||||
|
{
|
||||||
|
BenchmarkTimer timer("My operation on 10K lines");
|
||||||
|
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
|
||||||
|
result += my_operation(buf, i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
EXPECT_TRUE(result > 0);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Continuous Performance Monitoring
|
||||||
|
|
||||||
|
Run benchmarks regularly to detect regressions:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run tests and save output
|
||||||
|
./cmake-build-debug/kte_tests > benchmark_results.txt
|
||||||
|
|
||||||
|
# Compare with baseline
|
||||||
|
diff benchmark_baseline.txt benchmark_results.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Look for:
|
||||||
|
|
||||||
|
- Significant time increases (>20%) in any benchmark
|
||||||
|
- New operations that are slower than expected
|
||||||
|
- Cache effectiveness degradation
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
The benchmark suite provides:
|
||||||
|
|
||||||
|
- **Performance validation**: Ensures migrations don't regress
|
||||||
|
performance
|
||||||
|
- **Optimization guidance**: Identifies fastest APIs for each use case
|
||||||
|
- **Regression detection**: Catches performance issues early
|
||||||
|
- **Documentation**: Demonstrates correct API usage patterns
|
||||||
|
|
||||||
|
All 98 tests pass with 0 failures, confirming both correctness and
|
||||||
|
performance of the migrated codebase.
|
||||||
652
docs/DEVELOPER_GUIDE.md
Normal file
652
docs/DEVELOPER_GUIDE.md
Normal file
@@ -0,0 +1,652 @@
|
|||||||
|
# kte Developer Guide
|
||||||
|
|
||||||
|
Welcome to kte development! This guide will help you understand the
|
||||||
|
codebase, make changes, and contribute effectively.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
1. [Architecture Overview](#architecture-overview)
|
||||||
|
2. [Core Components](#core-components)
|
||||||
|
3. [Code Organization](#code-organization)
|
||||||
|
4. [Building and Testing](#building-and-testing)
|
||||||
|
5. [Making Changes](#making-changes)
|
||||||
|
6. [Code Style](#code-style)
|
||||||
|
7. [Common Tasks](#common-tasks)
|
||||||
|
|
||||||
|
## Architecture Overview
|
||||||
|
|
||||||
|
kte follows a clean separation of concerns with three main layers:
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────┐
|
||||||
|
│ Frontend Layer (Terminal/ImGui/Qt) │
|
||||||
|
│ - TerminalFrontend / ImGuiFrontend │
|
||||||
|
│ - InputHandler + Renderer interfaces │
|
||||||
|
└─────────────────────────────────────────┘
|
||||||
|
↓
|
||||||
|
┌─────────────────────────────────────────┐
|
||||||
|
│ Command Layer │
|
||||||
|
│ - Command registry and execution │
|
||||||
|
│ - All editing operations │
|
||||||
|
└─────────────────────────────────────────┘
|
||||||
|
↓
|
||||||
|
┌─────────────────────────────────────────┐
|
||||||
|
│ Core Model Layer │
|
||||||
|
│ - Editor (top-level state) │
|
||||||
|
│ - Buffer (document model) │
|
||||||
|
│ - PieceTable (text storage) │
|
||||||
|
│ - UndoSystem (undo/redo) │
|
||||||
|
│ - SwapManager (crash recovery) │
|
||||||
|
└─────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
### Design Principles
|
||||||
|
|
||||||
|
- **Frontend Independence**: Core editing logic is independent of UI.
|
||||||
|
Frontends implement `Frontend`, `InputHandler`, and `Renderer`
|
||||||
|
interfaces.
|
||||||
|
- **Command Pattern**: All editing operations go through the command
|
||||||
|
system, enabling consistent undo/redo and testing.
|
||||||
|
- **Piece Table**: Efficient text storage using a piece table data
|
||||||
|
structure that avoids copying large buffers.
|
||||||
|
- **Lazy Materialization**: Text is materialized on-demand to minimize
|
||||||
|
memory allocations.
|
||||||
|
|
||||||
|
## Core Components
|
||||||
|
|
||||||
|
### Editor (`Editor.h/.cc`)
|
||||||
|
|
||||||
|
The top-level editor state container. Manages:
|
||||||
|
|
||||||
|
- Multiple buffers
|
||||||
|
- Editor modes (normal, k-command prefix, prompts)
|
||||||
|
- Kill ring (clipboard history)
|
||||||
|
- Universal argument state
|
||||||
|
- Search state
|
||||||
|
- Status messages
|
||||||
|
- Swap file management
|
||||||
|
|
||||||
|
**Key Insight**: Editor is primarily a state holder with many
|
||||||
|
getter/setter pairs. It doesn't contain editing logic - that's in
|
||||||
|
commands.
|
||||||
|
|
||||||
|
### Buffer (`Buffer.h/.cc`)
|
||||||
|
|
||||||
|
Represents an open document. Manages:
|
||||||
|
|
||||||
|
- File I/O (open, save, external modification detection)
|
||||||
|
- Cursor position and viewport offsets
|
||||||
|
- Mark (selection start point)
|
||||||
|
- Visual line mode state
|
||||||
|
- Syntax highlighting integration
|
||||||
|
- Undo system integration
|
||||||
|
- Swap recording integration
|
||||||
|
|
||||||
|
**Key Insight**: Buffer wraps a PieceTable and provides a higher-level
|
||||||
|
interface. The nested `Buffer::Line` class is a legacy wrapper that has
|
||||||
|
been largely phased out in favor of direct PieceTable operations.
|
||||||
|
|
||||||
|
**Line Access APIs**: Buffer provides three ways to access line content:
|
||||||
|
|
||||||
|
- `GetLineView(row)` - Zero-copy `string_view` (fastest, 11x faster than
|
||||||
|
Rows())
|
||||||
|
- `GetLineString(row)` - Returns `std::string` copy (1.7x faster than
|
||||||
|
Rows())
|
||||||
|
- `Rows()` - Materializes all lines into cache (legacy, avoid in new
|
||||||
|
code)
|
||||||
|
|
||||||
|
See `docs/BENCHMARKS.md` for detailed performance analysis and usage
|
||||||
|
guidance.
|
||||||
|
|
||||||
|
### PieceTable (`PieceTable.h/.cc`)
|
||||||
|
|
||||||
|
The core text storage data structure. Provides:
|
||||||
|
|
||||||
|
- Efficient insert/delete operations without copying entire buffer
|
||||||
|
- Line-based queries (line count, get line, line ranges)
|
||||||
|
- Position conversion (byte offset ↔ line/column)
|
||||||
|
- Substring extraction
|
||||||
|
- Search functionality
|
||||||
|
- Automatic consolidation to prevent piece fragmentation
|
||||||
|
|
||||||
|
**Key Insight**: PieceTable uses lazy materialization - the full text is
|
||||||
|
only assembled when `Data()` is called. Most operations work directly on
|
||||||
|
the piece list.
|
||||||
|
|
||||||
|
### UndoSystem (`UndoSystem.h/.cc`, `UndoTree.h/.cc`, `UndoNode.h/.cc`)
|
||||||
|
|
||||||
|
Implements undo/redo with a tree structure supporting:
|
||||||
|
|
||||||
|
- Linear undo/redo
|
||||||
|
- Branching history (future enhancement)
|
||||||
|
- Checkpointing and compaction
|
||||||
|
- Memory-efficient node pooling
|
||||||
|
|
||||||
|
**Key Insight**: The undo system records operations at the PieceTable
|
||||||
|
level, not at the command level.
|
||||||
|
|
||||||
|
### Command System (`Command.h/.cc`)
|
||||||
|
|
||||||
|
All editing operations are implemented as commands:
|
||||||
|
|
||||||
|
- File operations (save, open, close)
|
||||||
|
- Navigation (move cursor, page up/down, word movement)
|
||||||
|
- Editing (insert, delete, kill, yank)
|
||||||
|
- Search and replace
|
||||||
|
- Buffer management
|
||||||
|
- Configuration (syntax, theme, font)
|
||||||
|
|
||||||
|
**Key Insight**: `Command.cc` is currently a monolithic 5000-line file.
|
||||||
|
This is the biggest maintainability challenge in the codebase.
|
||||||
|
|
||||||
|
### Frontend Abstraction
|
||||||
|
|
||||||
|
Three interfaces define the frontend contract:
|
||||||
|
|
||||||
|
- **Frontend** (`Frontend.h`): Top-level lifecycle (Init/Step/Shutdown)
|
||||||
|
- **InputHandler** (`InputHandler.h`): Converts UI events to commands
|
||||||
|
- **Renderer** (`Renderer.h`): Draws the editor state
|
||||||
|
|
||||||
|
Implementations:
|
||||||
|
|
||||||
|
- **Terminal**: ncurses-based (`TerminalFrontend`,
|
||||||
|
`TerminalInputHandler`, `TerminalRenderer`)
|
||||||
|
- **ImGui**: Dear ImGui-based (`ImGuiFrontend`, `ImGuiInputHandler`,
|
||||||
|
`ImGuiRenderer`)
|
||||||
|
- **Qt**: Qt-based (`QtFrontend`, `QtInputHandler`, `QtRenderer`)
|
||||||
|
- **Test**: Programmatic testing (`TestFrontend`, `TestInputHandler`,
|
||||||
|
`TestRenderer`)
|
||||||
|
|
||||||
|
## Code Organization
|
||||||
|
|
||||||
|
### Directory Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
kte/
|
||||||
|
├── *.h, *.cc # Core implementation (root level)
|
||||||
|
├── main.cc # Entry point
|
||||||
|
├── docs/ # Documentation
|
||||||
|
│ ├── ke.md # Original ke editor reference (keybindings)
|
||||||
|
│ ├── swap.md # Swap file design
|
||||||
|
│ ├── syntax.md # Syntax highlighting
|
||||||
|
│ ├── themes.md # Theme system
|
||||||
|
│ └── plans/ # Design documents
|
||||||
|
├── tests/ # Test suite
|
||||||
|
│ ├── Test.h # Minimal test framework
|
||||||
|
│ ├── TestRunner.cc # Test runner
|
||||||
|
│ └── test_*.cc # Individual test files
|
||||||
|
├── syntax/ # Syntax highlighting engines
|
||||||
|
├── fonts/ # Embedded fonts for GUI
|
||||||
|
├── themes/ # Color themes
|
||||||
|
└── ext/ # External dependencies (imgui)
|
||||||
|
```
|
||||||
|
|
||||||
|
### File Naming Conventions
|
||||||
|
|
||||||
|
- Headers: `ComponentName.h`
|
||||||
|
- Implementation: `ComponentName.cc`
|
||||||
|
- Tests: `test_feature_name.cc`
|
||||||
|
|
||||||
|
### Key Files by Size
|
||||||
|
|
||||||
|
Large files that may need attention:
|
||||||
|
|
||||||
|
- `Command.cc` (4995 lines) - **Needs refactoring**: Consider splitting
|
||||||
|
into logical groups
|
||||||
|
- `Swap.cc` (1300 lines) - Crash recovery system (migrated to direct
|
||||||
|
PieceTable operations)
|
||||||
|
- `QtFrontend.cc` (985 lines) - Qt integration
|
||||||
|
- `ImGuiRenderer.cc` (930 lines) - ImGui rendering
|
||||||
|
- `PieceTable.cc` (800 lines) - Core data structure
|
||||||
|
- `Buffer.cc` (763 lines) - Document model
|
||||||
|
|
||||||
|
## Building and Testing
|
||||||
|
|
||||||
|
### Build System
|
||||||
|
|
||||||
|
kte uses CMake with multiple build profiles:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Debug build (terminal only)
|
||||||
|
cmake -S . -B cmake-build-debug -DCMAKE_BUILD_TYPE=Debug
|
||||||
|
cmake --build cmake-build-debug
|
||||||
|
|
||||||
|
# Release build with GUI
|
||||||
|
cmake -S . -B cmake-build-release -DCMAKE_BUILD_TYPE=Release -DBUILD_GUI=ON
|
||||||
|
cmake --build cmake-build-release
|
||||||
|
|
||||||
|
# Build specific target
|
||||||
|
cmake --build cmake-build-debug --target kte_tests
|
||||||
|
```
|
||||||
|
|
||||||
|
### CMake Targets
|
||||||
|
|
||||||
|
- `kte` - Terminal editor executable
|
||||||
|
- `kge` - GUI editor executable (when `BUILD_GUI=ON`)
|
||||||
|
- `kte_tests` - Test suite
|
||||||
|
- `imgui` - Dear ImGui library (when `BUILD_GUI=ON`)
|
||||||
|
|
||||||
|
### Running Tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Build and run all tests
|
||||||
|
cmake --build cmake-build-debug --target kte_tests && ./cmake-build-debug/kte_tests
|
||||||
|
|
||||||
|
# Run tests with verbose output
|
||||||
|
./cmake-build-debug/kte_tests
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test Organization
|
||||||
|
|
||||||
|
The test suite uses a minimal custom framework (`Test.h`):
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
TEST(TestName) {
|
||||||
|
// Test body
|
||||||
|
ASSERT_EQ(actual, expected);
|
||||||
|
ASSERT_TRUE(condition);
|
||||||
|
EXPECT_TRUE(condition); // Non-fatal
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Test files by category:
|
||||||
|
|
||||||
|
- **Core Data Structures**:
|
||||||
|
- `test_piece_table.cc` - PieceTable operations, line indexing,
|
||||||
|
random edits
|
||||||
|
- `test_buffer_rows.cc` - Buffer row operations
|
||||||
|
- `test_buffer_io.cc` - File I/O (open, save, SaveAs)
|
||||||
|
|
||||||
|
- **Editing Operations**:
|
||||||
|
- `test_command_semantics.cc` - Command execution
|
||||||
|
- `test_kkeymap.cc` - Keybinding system
|
||||||
|
- `test_visual_line_mode.cc` - Visual line selection
|
||||||
|
|
||||||
|
- **Search and Replace**:
|
||||||
|
- `test_search.cc` - Search functionality
|
||||||
|
- `test_search_replace_flow.cc` - Interactive search/replace
|
||||||
|
|
||||||
|
- **Text Reflow**:
|
||||||
|
- `test_reflow_paragraph.cc` - Paragraph reformatting
|
||||||
|
- `test_reflow_indented_bullets.cc` - Indented list handling
|
||||||
|
|
||||||
|
- **Undo System**:
|
||||||
|
- `test_undo.cc` - Undo/redo operations
|
||||||
|
|
||||||
|
- **Swap Files** (Crash Recovery):
|
||||||
|
- `test_swap_recorder.cc` - Recording operations
|
||||||
|
- `test_swap_writer.cc` - Writing swap files
|
||||||
|
- `test_swap_replay.cc` - Replaying operations
|
||||||
|
- `test_swap_recovery_prompt.cc` - Recovery UI
|
||||||
|
- `test_swap_cleanup.cc` - Cleanup logic
|
||||||
|
- `test_swap_git_editor.cc` - Git editor integration
|
||||||
|
|
||||||
|
- **Performance and Migration**:
|
||||||
|
- `test_benchmarks.cc` - Performance benchmarks for core operations
|
||||||
|
- `test_migration_coverage.cc` - Buffer::Line migration validation
|
||||||
|
|
||||||
|
- **Integration Tests**:
|
||||||
|
- `test_daily_workflows.cc` - Real-world editing scenarios
|
||||||
|
- `test_daily_driver_harness.cc` - Workflow test infrastructure
|
||||||
|
|
||||||
|
**Total**: 98 tests across 22 test files. See `docs/BENCHMARKS.md` for
|
||||||
|
performance benchmark results.
|
||||||
|
|
||||||
|
### Docker/Podman for Linux Builds
|
||||||
|
|
||||||
|
A minimal `Dockerfile` is provided for **testing Linux builds** without
|
||||||
|
requiring a native Linux system. The Dockerfile creates a build
|
||||||
|
environment container with all necessary dependencies. Your source tree
|
||||||
|
is mounted into the container at runtime, allowing you to test
|
||||||
|
compilation and run tests on Linux.
|
||||||
|
|
||||||
|
**Important**: This is intended for testing Linux builds, not for
|
||||||
|
running
|
||||||
|
kte locally. The container expects the source tree to be mounted when
|
||||||
|
run.
|
||||||
|
|
||||||
|
This is particularly useful for:
|
||||||
|
|
||||||
|
- **macOS/Windows developers** testing Linux compatibility
|
||||||
|
- **CI/CD pipelines** ensuring cross-platform builds
|
||||||
|
- **Reproducible builds** with a known Alpine Linux 3.19 environment
|
||||||
|
|
||||||
|
#### Prerequisites
|
||||||
|
|
||||||
|
Install Docker or Podman:
|
||||||
|
|
||||||
|
- **macOS**: `brew install podman` (Docker Desktop also works)
|
||||||
|
- **Linux**: Use your distribution's package manager
|
||||||
|
- **Windows**: Docker Desktop or Podman Desktop
|
||||||
|
|
||||||
|
If using Podman on macOS, start the VM:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
podman machine init
|
||||||
|
podman machine start
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Building the Docker Image
|
||||||
|
|
||||||
|
The Dockerfile installs all build dependencies including GUI support (
|
||||||
|
g++ 13.2.1, CMake 3.27.8, ncurses-dev, SDL2, OpenGL/Mesa, Freetype). It
|
||||||
|
does not copy or build the source code.
|
||||||
|
|
||||||
|
From the project root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Build the environment image
|
||||||
|
docker build -t kte-linux .
|
||||||
|
|
||||||
|
# Or with Podman
|
||||||
|
podman build -t kte-linux .
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Testing Linux Builds
|
||||||
|
|
||||||
|
Mount your source tree and run the build + tests:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Build and test (default command)
|
||||||
|
docker run --rm -v "$(pwd):/kte" kte-linux
|
||||||
|
|
||||||
|
# Expected output: "98 tests passed, 0 failed"
|
||||||
|
```
|
||||||
|
|
||||||
|
The default command builds both `kte` (terminal) and `kge` (GUI)
|
||||||
|
executables with full GUI support (`-DBUILD_GUI=ON`) and runs the
|
||||||
|
complete test suite.
|
||||||
|
|
||||||
|
#### Custom Build Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Open a shell in the build environment
|
||||||
|
docker run --rm -it -v "$(pwd):/kte" kte-linux /bin/bash
|
||||||
|
|
||||||
|
# Then inside the container:
|
||||||
|
cmake -B build -DBUILD_GUI=ON -DBUILD_TESTS=ON
|
||||||
|
cmake --build build --target kte # Terminal version
|
||||||
|
cmake --build build --target kge # GUI version
|
||||||
|
cmake --build build --target kte_tests
|
||||||
|
./build/kte_tests
|
||||||
|
|
||||||
|
# Or run kte directly
|
||||||
|
./build/kte --help
|
||||||
|
|
||||||
|
# Terminal-only build (smaller, faster)
|
||||||
|
cmake -B build -DBUILD_GUI=OFF -DBUILD_TESTS=ON
|
||||||
|
cmake --build build --target kte
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Running kte Interactively
|
||||||
|
|
||||||
|
To test kte's terminal UI on Linux:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run kte with a file from your host system
|
||||||
|
docker run --rm -it -v "$(pwd):/kte" kte-linux sh -c "cmake -B build -DBUILD_GUI=OFF && cmake --build build --target kte && ./build/kte README.md"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### CI/CD Integration
|
||||||
|
|
||||||
|
Example GitHub Actions workflow:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Test Linux Build
|
||||||
|
run: |
|
||||||
|
docker build -t kte-linux .
|
||||||
|
docker run --rm -v "${{ github.workspace }}:/kte" kte-linux
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Troubleshooting
|
||||||
|
|
||||||
|
**"Cannot connect to Podman socket"** (macOS):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
podman machine start
|
||||||
|
```
|
||||||
|
|
||||||
|
**"Permission denied"** (Linux):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Add your user to the docker group
|
||||||
|
sudo usermod -aG docker $USER
|
||||||
|
# Log out and back in
|
||||||
|
```
|
||||||
|
|
||||||
|
**Build fails with ncurses errors**:
|
||||||
|
The Dockerfile explicitly installs `ncurses-dev` (wide-character
|
||||||
|
ncurses). If you modify the Dockerfile, ensure this dependency remains.
|
||||||
|
|
||||||
|
**"No such file or directory" errors**:
|
||||||
|
Ensure you're mounting the source tree with `-v "$(pwd):/kte"` when
|
||||||
|
running the container.
|
||||||
|
|
||||||
|
### Writing Tests
|
||||||
|
|
||||||
|
When adding new functionality:
|
||||||
|
|
||||||
|
1. **Add a test first** - Write a failing test that demonstrates the
|
||||||
|
desired behavior
|
||||||
|
2. **Use descriptive names** - Test names should explain what's being
|
||||||
|
validated
|
||||||
|
3. **Test edge cases** - Empty buffers, EOF, beginning of file, etc.
|
||||||
|
4. **Use TestFrontend** - For integration tests, use the programmatic
|
||||||
|
test frontend
|
||||||
|
|
||||||
|
Example test structure:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
TEST(Feature_Behavior_Scenario) {
|
||||||
|
// Setup
|
||||||
|
Buffer buf;
|
||||||
|
buf.insert_text(0, 0, "test content\n");
|
||||||
|
|
||||||
|
// Exercise
|
||||||
|
buf.delete_text(0, 5, 4);
|
||||||
|
|
||||||
|
// Verify
|
||||||
|
ASSERT_EQ(buf.GetLineString(0), std::string("test\n"));
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Making Changes
|
||||||
|
|
||||||
|
### Development Workflow
|
||||||
|
|
||||||
|
1. **Understand the change scope**:
|
||||||
|
- Pure UI change? → Modify frontend only
|
||||||
|
- New editing operation? → Add command in `Command.cc`
|
||||||
|
- Core data structure? → Modify `PieceTable` or `Buffer`
|
||||||
|
|
||||||
|
2. **Find relevant code**:
|
||||||
|
- Use `git grep` or IDE search to find similar functionality
|
||||||
|
- Check `Command.cc` for existing command patterns
|
||||||
|
- Look at tests to understand expected behavior
|
||||||
|
|
||||||
|
3. **Make the change**:
|
||||||
|
- Follow existing code style (see below)
|
||||||
|
- Add or update tests
|
||||||
|
- Update documentation if needed
|
||||||
|
|
||||||
|
4. **Test thoroughly**:
|
||||||
|
- Run the full test suite
|
||||||
|
- Manually test in both terminal and GUI (if applicable)
|
||||||
|
- Test edge cases (empty files, large files, EOF, etc.)
|
||||||
|
|
||||||
|
### Common Pitfalls
|
||||||
|
|
||||||
|
- **Don't modify `Buffer::Rows()` directly** - Use the PieceTable API (
|
||||||
|
`insert_text`, `delete_text`, etc.) to ensure undo and swap recording
|
||||||
|
work correctly.
|
||||||
|
- **Prefer efficient line access** - Use `GetLineView()` for read-only
|
||||||
|
access (11x faster than `Rows()`), or `GetLineString()` when you need
|
||||||
|
a copy. Avoid `Rows()` in new code.
|
||||||
|
- **Remember to invalidate caches** - If you modify PieceTable
|
||||||
|
internals, ensure line index and materialization caches are
|
||||||
|
invalidated.
|
||||||
|
- **Cursor visibility** - After editing operations, call
|
||||||
|
`ensure_cursor_visible()` to update viewport offsets.
|
||||||
|
- **Undo boundaries** - Use `buf.Undo()->BeginGroup()` and `EndGroup()`
|
||||||
|
to group related operations.
|
||||||
|
- **GetLineView() lifetime** - The returned `string_view` is only valid
|
||||||
|
until the next buffer modification. Use immediately or copy to
|
||||||
|
`std::string`.
|
||||||
|
|
||||||
|
## Code Style
|
||||||
|
|
||||||
|
kte uses C++20 with these conventions:
|
||||||
|
|
||||||
|
### Naming
|
||||||
|
|
||||||
|
- **Classes/Structs**: `PascalCase` (e.g., `PieceTable`, `Buffer`)
|
||||||
|
- **Functions/Methods**: `PascalCase` (e.g., `GetLine`, `Insert`)
|
||||||
|
- **Variables**: `snake_case` with trailing underscore for members (
|
||||||
|
e.g., `total_size_`, `line_index_`)
|
||||||
|
- **Constants**: `snake_case` or `UPPER_CASE` depending on context
|
||||||
|
- **Private members**: Trailing underscore (e.g., `pieces_`, `dirty_`)
|
||||||
|
|
||||||
|
### Formatting
|
||||||
|
|
||||||
|
- **Indentation**: Tabs (width 8 in most files, but follow existing
|
||||||
|
style)
|
||||||
|
- **Braces**: Opening brace on same line for functions, control
|
||||||
|
structures
|
||||||
|
- **Line length**: No strict limit, but keep reasonable (~100-120 chars)
|
||||||
|
- **Includes**: Group by category (system, external, project) with blank
|
||||||
|
lines between
|
||||||
|
|
||||||
|
### Comments
|
||||||
|
|
||||||
|
- **File headers**: Brief description of the file's purpose
|
||||||
|
- **Function comments**: Explain non-obvious behavior, not what the code
|
||||||
|
obviously does
|
||||||
|
- **Inline comments**: Explain *why*, not *what*
|
||||||
|
- **TODO comments**: Use `TODO:` prefix for future work
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
// Consolidate small pieces to prevent fragmentation.
|
||||||
|
// This is a heuristic: we only consolidate when piece count exceeds
|
||||||
|
// a threshold, and we cap the bytes processed per consolidation run.
|
||||||
|
void maybeConsolidate() {
|
||||||
|
if (pieces_.size() < piece_limit_)
|
||||||
|
return;
|
||||||
|
// ... implementation
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common Tasks
|
||||||
|
|
||||||
|
### Adding a New Command
|
||||||
|
|
||||||
|
1. **Define the command function** in `Command.cc`:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
bool cmd_my_feature(CommandContext &ctx) {
|
||||||
|
Editor &ed = ctx.ed;
|
||||||
|
Buffer *buf = ed.CurrentBuffer();
|
||||||
|
if (!buf) return false;
|
||||||
|
|
||||||
|
// Implement the command
|
||||||
|
buf->insert_text(buf->Cury(), buf->Curx(), "text");
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Register the command** in `InstallDefaultCommands()`:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
CommandRegistry::Register({
|
||||||
|
CommandId::MyFeature,
|
||||||
|
"my-feature",
|
||||||
|
"Description of what it does",
|
||||||
|
cmd_my_feature
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Add keybinding** in the appropriate `InputHandler` (e.g.,
|
||||||
|
`TerminalInputHandler.cc`).
|
||||||
|
|
||||||
|
4. **Write tests** in `tests/test_command_semantics.cc` or a new test
|
||||||
|
file.
|
||||||
|
|
||||||
|
### Adding a New Frontend
|
||||||
|
|
||||||
|
1. **Implement the three interfaces**:
|
||||||
|
- `Frontend` - Lifecycle management
|
||||||
|
- `InputHandler` - Event → Command translation
|
||||||
|
- `Renderer` - Draw the editor state
|
||||||
|
|
||||||
|
2. **Study existing implementations**:
|
||||||
|
- `TerminalFrontend` - Simplest, good starting point
|
||||||
|
- `ImGuiFrontend` - More complex, shows GUI patterns
|
||||||
|
|
||||||
|
3. **Register in `main.cc`** to make it selectable.
|
||||||
|
|
||||||
|
### Modifying the PieceTable
|
||||||
|
|
||||||
|
The PieceTable is performance-critical. When making changes:
|
||||||
|
|
||||||
|
1. **Understand the piece list** - Each piece references a range in
|
||||||
|
either `original_` or `add_` buffer
|
||||||
|
2. **Maintain invariants**:
|
||||||
|
- `total_size_` must match sum of piece lengths
|
||||||
|
- Line index must be invalidated on content changes
|
||||||
|
- Version must increment on mutations
|
||||||
|
3. **Test thoroughly** - Use `test_piece_table.cc` random edit test as a
|
||||||
|
reference model
|
||||||
|
4. **Profile if needed** - Large file performance is a key goal
|
||||||
|
|
||||||
|
### Adding Syntax Highlighting
|
||||||
|
|
||||||
|
1. **Create a new highlighter** in `syntax/` directory:
|
||||||
|
- Inherit from `HighlighterEngine`
|
||||||
|
- Implement `HighlightLine()` method
|
||||||
|
|
||||||
|
2. **Register in `HighlighterRegistry`** (
|
||||||
|
`syntax/HighlighterRegistry.cc`)
|
||||||
|
|
||||||
|
3. **Add file extension mapping** in the registry
|
||||||
|
|
||||||
|
4. **Test with sample files** of that language
|
||||||
|
|
||||||
|
### Debugging Tips
|
||||||
|
|
||||||
|
- **Use the test frontend** - Write a test that reproduces the issue
|
||||||
|
- **Enable assertions** - Build in Debug mode
|
||||||
|
- **Check swap files** - Look in `/tmp/kte-swap-*` for recorded
|
||||||
|
operations
|
||||||
|
- **Print debugging** - Use `std::cerr` (stdout is used by ncurses)
|
||||||
|
- **GDB/LLDB** - Standard debuggers work fine with kte
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
- **Read the code** - kte is designed to be understandable; follow the
|
||||||
|
data flow
|
||||||
|
- **Check existing tests** - Tests often show how to use APIs correctly
|
||||||
|
- **Look at git history** - See how similar features were implemented
|
||||||
|
- **Read design docs** - Check `docs/plans/` for design rationale
|
||||||
|
|
||||||
|
## Future Improvements
|
||||||
|
|
||||||
|
Areas where the codebase could be improved:
|
||||||
|
|
||||||
|
1. **Split Command.cc** - Break into logical groups (editing,
|
||||||
|
navigation, file ops, etc.)
|
||||||
|
2. **Complete Buffer::Line migration** - A few legacy editing functions
|
||||||
|
in Command.cc still use `Buffer::Rows()` directly (see lines 86-90
|
||||||
|
comment)
|
||||||
|
3. **Add more inline documentation** - Especially for complex algorithms
|
||||||
|
4. **Improve test coverage** - Add more edge case tests (current: 98
|
||||||
|
tests)
|
||||||
|
5. **Performance profiling** - Continue monitoring performance with
|
||||||
|
benchmark suite
|
||||||
|
6. **API documentation** - Consider adding Doxygen-style comments
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Welcome aboard! Start small, read the code, and don't hesitate to ask
|
||||||
|
questions.
|
||||||
@@ -11884,4 +11884,4 @@ static const unsigned int DefaultFontRegularCompressedData[72616 / 4] =
|
|||||||
0x0070a96e,
|
0x0070a96e,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5586,4 +5586,4 @@ static const unsigned int DefaultFontBoldCompressedData[32380 / 4] =
|
|||||||
0x0e01060e, 0xff01b82a, 0x8d04b085,
|
0x0e01060e, 0xff01b82a, 0x8d04b085,
|
||||||
0x440002b1, 0x066405b3, 0x00444400, 0x01000000, 0x00000000, 0xfacafa05, 0x00004aa6,
|
0x440002b1, 0x066405b3, 0x00444400, 0x01000000, 0x00000000, 0xfacafa05, 0x00004aa6,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5918,4 +5918,4 @@ static const unsigned int DefaultFontRegularCompressedData[34064 / 4] =
|
|||||||
0x20080082, 0x01060eb3, 0x01b82a0e,
|
0x20080082, 0x01060eb3, 0x01b82a0e,
|
||||||
0x04b085ff, 0x0002b18d, 0x6405b344, 0x44440006, 0x00000000, 0x00000001, 0xccfa0500, 0x0030ee4f,
|
0x04b085ff, 0x0002b18d, 0x6405b344, 0x44440006, 0x00000000, 0x00000001, 0xccfa0500, 0x0030ee4f,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2851,4 +2851,4 @@ static const unsigned int DefaultFontRegularCompressedData[68288 / 4] =
|
|||||||
0x820a2003, 0x421e20c3, 0x18821057,
|
0x820a2003, 0x421e20c3, 0x18821057,
|
||||||
0x21830284, 0xdeda0024, 0x0d83c5d7, 0xa48ad12b, 0x0000001e, 0xa48ad100, 0x62fa051e, 0x00a176d4,
|
0x21830284, 0xdeda0024, 0x0d83c5d7, 0xa48ad12b, 0x0000001e, 0xa48ad100, 0x62fa051e, 0x00a176d4,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -37,4 +37,4 @@ Font::Load(const float size) const
|
|||||||
|
|
||||||
io.Fonts->Build();
|
io.Fonts->Build();
|
||||||
}
|
}
|
||||||
} // namespace kte::Fonts
|
} // namespace kte::Fonts
|
||||||
|
|||||||
@@ -119,4 +119,4 @@ private:
|
|||||||
|
|
||||||
|
|
||||||
void InstallDefaultFonts();
|
void InstallDefaultFonts();
|
||||||
}
|
}
|
||||||
|
|||||||
25743
fonts/Go.h
25743
fonts/Go.h
File diff suppressed because it is too large
Load Diff
@@ -13671,4 +13671,4 @@ static const unsigned int DefaultFontItalicCompressedData[84884 / 4] =
|
|||||||
0x4f1aea4f, 0x0d2022dc, 0x211fdc4f,
|
0x4f1aea4f, 0x0d2022dc, 0x211fdc4f,
|
||||||
0x164f2804, 0x8b952711, 0x236f6f19, 0xfa050081, 0x0bda00e5,
|
0x164f2804, 0x8b952711, 0x236f6f19, 0xfa050081, 0x0bda00e5,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6231,4 +6231,4 @@ static const unsigned int DefaultFontRegularCompressedData[149388 / 4] =
|
|||||||
0x86382043, 0x870f8383, 0x022e2463,
|
0x86382043, 0x870f8383, 0x022e2463,
|
||||||
0x05480066, 0x599623fa, 0x00000043,
|
0x05480066, 0x599623fa, 0x00000043,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5632,4 +5632,4 @@ static const unsigned int DefaultFontRegularCompressedData[66932 / 4] =
|
|||||||
0xc6221786, 0x1788a203, 0x86008524,
|
0xc6221786, 0x1788a203, 0x86008524,
|
||||||
0x2f88e200, 0x1788a520, 0xf6ffb424, 0xfa05fa00, 0xc234b8e9,
|
0x2f88e200, 0x1788a520, 0xf6ffb424, 0xfa05fa00, 0xc234b8e9,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5737,4 +5737,4 @@ static const unsigned int DefaultFontBoldCompressedData[68920 / 4] =
|
|||||||
0x86910006, 0x03c32217, 0x241788b7, 0x00ce0085, 0x202f88e4, 0x261788b5, 0x00ebffb4, 0x050000fe, 0x877646fa,
|
0x86910006, 0x03c32217, 0x241788b7, 0x00ce0085, 0x202f88e4, 0x261788b5, 0x00ebffb4, 0x050000fe, 0x877646fa,
|
||||||
0x000000de,
|
0x000000de,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
22065
fonts/Triplicate.h
22065
fonts/Triplicate.h
File diff suppressed because it is too large
Load Diff
9
main.cc
9
main.cc
@@ -195,12 +195,11 @@ main(int argc, char *argv[])
|
|||||||
} else if (req_term) {
|
} else if (req_term) {
|
||||||
use_gui = false;
|
use_gui = false;
|
||||||
} else {
|
} else {
|
||||||
|
// Default depends on build target: kge defaults to GUI, kte to terminal
|
||||||
// Default depends on build target: kge defaults to GUI, kte to terminal
|
|
||||||
#if defined(KTE_DEFAULT_GUI)
|
#if defined(KTE_DEFAULT_GUI)
|
||||||
use_gui = true;
|
use_gui = true;
|
||||||
#else
|
#else
|
||||||
use_gui = false;
|
use_gui = false;
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
@@ -302,4 +301,4 @@ main(int argc, char *argv[])
|
|||||||
fe->Shutdown();
|
fe->Shutdown();
|
||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -60,11 +60,10 @@ CppHighlighter::HighlightLineStateful(const Buffer &buf,
|
|||||||
const LineState &prev,
|
const LineState &prev,
|
||||||
std::vector<HighlightSpan> &out) const
|
std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
|
||||||
StatefulHighlighter::LineState state = prev;
|
StatefulHighlighter::LineState state = prev;
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
return state;
|
return state;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
if (s.empty())
|
if (s.empty())
|
||||||
return state;
|
return state;
|
||||||
|
|
||||||
@@ -143,7 +142,7 @@ CppHighlighter::HighlightLineStateful(const Buffer &buf,
|
|||||||
bool closed = false;
|
bool closed = false;
|
||||||
while (j + 1 <= n) {
|
while (j + 1 <= n) {
|
||||||
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
||||||
j += 2;
|
j += 2;
|
||||||
closed = true;
|
closed = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -32,4 +32,4 @@ private:
|
|||||||
|
|
||||||
static bool is_ident_char(char c);
|
static bool is_ident_char(char c);
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -40,10 +40,9 @@ ErlangHighlighter::ErlangHighlighter()
|
|||||||
void
|
void
|
||||||
ErlangHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
ErlangHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
|
|
||||||
|
|||||||
@@ -14,4 +14,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -40,10 +40,9 @@ ForthHighlighter::ForthHighlighter()
|
|||||||
void
|
void
|
||||||
ForthHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
ForthHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
|
|
||||||
|
|||||||
@@ -14,4 +14,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -46,10 +46,9 @@ GoHighlighter::GoHighlighter()
|
|||||||
void
|
void
|
||||||
GoHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
GoHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
int bol = 0;
|
int bol = 0;
|
||||||
@@ -75,7 +74,7 @@ GoHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSp
|
|||||||
bool closed = false;
|
bool closed = false;
|
||||||
while (j + 1 <= n) {
|
while (j + 1 <= n) {
|
||||||
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
||||||
j += 2;
|
j += 2;
|
||||||
closed = true;
|
closed = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,4 +15,4 @@ private:
|
|||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
std::unordered_set<std::string> types_;
|
std::unordered_set<std::string> types_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -82,7 +82,7 @@ HighlighterEngine::GetLine(const Buffer &buf, int row, std::uint64_t buf_version
|
|||||||
// Only use cached state if it's for the current version and row still exists
|
// Only use cached state if it's for the current version and row still exists
|
||||||
if (r <= row - 1 && kv.second.version == buf_version) {
|
if (r <= row - 1 && kv.second.version == buf_version) {
|
||||||
// Validate that the cached row index is still valid in the buffer
|
// Validate that the cached row index is still valid in the buffer
|
||||||
if (r >= 0 && static_cast<std::size_t>(r) < buf.Rows().size()) {
|
if (r >= 0 && static_cast<std::size_t>(r) < buf.Nrows()) {
|
||||||
if (r > best)
|
if (r > best)
|
||||||
best = r;
|
best = r;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -87,4 +87,4 @@ private:
|
|||||||
|
|
||||||
void worker_loop() const;
|
void worker_loop() const;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -244,4 +244,4 @@ HighlighterRegistry::RegisterTreeSitter(std::string_view filetype,
|
|||||||
}, /*override_existing=*/true);
|
}, /*override_existing=*/true);
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -44,4 +44,4 @@ public:
|
|||||||
const TSLanguage * (*get_language)());
|
const TSLanguage * (*get_language)());
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -13,10 +13,9 @@ is_digit(char c)
|
|||||||
void
|
void
|
||||||
JSONHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
JSONHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
auto push = [&](int a, int b, TokenKind k) {
|
auto push = [&](int a, int b, TokenKind k) {
|
||||||
if (b > a)
|
if (b > a)
|
||||||
|
|||||||
@@ -9,4 +9,4 @@ class JSONHighlighter final : public LanguageHighlighter {
|
|||||||
public:
|
public:
|
||||||
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -48,4 +48,4 @@ public:
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -25,10 +25,9 @@ LispHighlighter::LispHighlighter()
|
|||||||
void
|
void
|
||||||
LispHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
LispHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
int bol = 0;
|
int bol = 0;
|
||||||
|
|||||||
@@ -14,4 +14,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -24,10 +24,9 @@ MarkdownHighlighter::HighlightLineStateful(const Buffer &buf, int row, const Lin
|
|||||||
std::vector<HighlightSpan> &out) const
|
std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
StatefulHighlighter::LineState state = prev;
|
StatefulHighlighter::LineState state = prev;
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return state;
|
return state;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
|
|
||||||
// Reuse in_block_comment flag as "in fenced code" state.
|
// Reuse in_block_comment flag as "in fenced code" state.
|
||||||
|
|||||||
@@ -11,4 +11,4 @@ public:
|
|||||||
LineState HighlightLineStateful(const Buffer &buf, int row, const LineState &prev,
|
LineState HighlightLineStateful(const Buffer &buf, int row, const LineState &prev,
|
||||||
std::vector<HighlightSpan> &out) const override;
|
std::vector<HighlightSpan> &out) const override;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -5,10 +5,9 @@ namespace kte {
|
|||||||
void
|
void
|
||||||
NullHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
NullHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
if (n <= 0)
|
if (n <= 0)
|
||||||
return;
|
return;
|
||||||
|
|||||||
@@ -8,4 +8,4 @@ class NullHighlighter final : public LanguageHighlighter {
|
|||||||
public:
|
public:
|
||||||
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -50,10 +50,9 @@ PythonHighlighter::HighlightLineStateful(const Buffer &buf, int row, const LineS
|
|||||||
std::vector<HighlightSpan> &out) const
|
std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
StatefulHighlighter::LineState state = prev;
|
StatefulHighlighter::LineState state = prev;
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return state;
|
return state;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
|
|
||||||
// Triple-quoted string continuation uses in_raw_string with raw_delim either "'''" or "\"\"\""
|
// Triple-quoted string continuation uses in_raw_string with raw_delim either "'''" or "\"\"\""
|
||||||
|
|||||||
@@ -17,4 +17,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -47,10 +47,9 @@ RustHighlighter::RustHighlighter()
|
|||||||
void
|
void
|
||||||
RustHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
RustHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
while (i < n) {
|
while (i < n) {
|
||||||
@@ -72,7 +71,7 @@ RustHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<Highlight
|
|||||||
bool closed = false;
|
bool closed = false;
|
||||||
while (j + 1 <= n) {
|
while (j + 1 <= n) {
|
||||||
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
||||||
j += 2;
|
j += 2;
|
||||||
closed = true;
|
closed = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,4 +15,4 @@ private:
|
|||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
std::unordered_set<std::string> types_;
|
std::unordered_set<std::string> types_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -14,10 +14,9 @@ push(std::vector<HighlightSpan> &out, int a, int b, TokenKind k)
|
|||||||
void
|
void
|
||||||
ShellHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
ShellHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
// if first non-space is '#', whole line is comment
|
// if first non-space is '#', whole line is comment
|
||||||
|
|||||||
@@ -8,4 +8,4 @@ class ShellHighlighter final : public LanguageHighlighter {
|
|||||||
public:
|
public:
|
||||||
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -47,10 +47,9 @@ SqlHighlighter::SqlHighlighter()
|
|||||||
void
|
void
|
||||||
SqlHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
SqlHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
|
|
||||||
@@ -75,7 +74,7 @@ SqlHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightS
|
|||||||
bool closed = false;
|
bool closed = false;
|
||||||
while (j + 1 <= n) {
|
while (j + 1 <= n) {
|
||||||
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
||||||
j += 2;
|
j += 2;
|
||||||
closed = true;
|
closed = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,4 +15,4 @@ private:
|
|||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
std::unordered_set<std::string> types_;
|
std::unordered_set<std::string> types_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -44,8 +44,8 @@ CreateTreeSitterHighlighter(const char *filetype,
|
|||||||
const void * (*get_lang)())
|
const void * (*get_lang)())
|
||||||
{
|
{
|
||||||
const auto *lang = reinterpret_cast<const TSLanguage *>(get_lang ? get_lang() : nullptr);
|
const auto *lang = reinterpret_cast<const TSLanguage *>(get_lang ? get_lang() : nullptr);
|
||||||
return std::make_unique < TreeSitterHighlighter > (lang, filetype ? std::string(filetype) : std::string());
|
return std::make_unique<TreeSitterHighlighter>(lang, filetype ? std::string(filetype) : std::string());
|
||||||
}
|
}
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|
||||||
#endif // KTE_ENABLE_TREESITTER
|
#endif // KTE_ENABLE_TREESITTER
|
||||||
|
|||||||
@@ -45,4 +45,4 @@ std::unique_ptr<LanguageHighlighter> CreateTreeSitterHighlighter(const char *fil
|
|||||||
const void * (*get_lang)());
|
const void * (*get_lang)());
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|
||||||
#endif // KTE_ENABLE_TREESITTER
|
#endif // KTE_ENABLE_TREESITTER
|
||||||
|
|||||||
66
tests/Test.h
66
tests/Test.h
@@ -8,49 +8,63 @@
|
|||||||
#include <sstream>
|
#include <sstream>
|
||||||
|
|
||||||
namespace ktet {
|
namespace ktet {
|
||||||
|
|
||||||
struct TestCase {
|
struct TestCase {
|
||||||
std::string name;
|
std::string name;
|
||||||
std::function<void()> fn;
|
std::function<void()> fn;
|
||||||
};
|
};
|
||||||
|
|
||||||
inline std::vector<TestCase>& registry() {
|
|
||||||
static std::vector<TestCase> r;
|
inline std::vector<TestCase> &
|
||||||
return r;
|
registry()
|
||||||
|
{
|
||||||
|
static std::vector<TestCase> r;
|
||||||
|
return r;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
struct Registrar {
|
struct Registrar {
|
||||||
Registrar(const char* name, std::function<void()> fn) {
|
Registrar(const char *name, std::function<void()> fn)
|
||||||
registry().push_back(TestCase{std::string(name), std::move(fn)});
|
{
|
||||||
}
|
registry().push_back(TestCase{std::string(name), std::move(fn)});
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// Assertions
|
// Assertions
|
||||||
struct AssertionFailure {
|
struct AssertionFailure {
|
||||||
std::string msg;
|
std::string msg;
|
||||||
};
|
};
|
||||||
|
|
||||||
inline void expect(bool cond, const char* expr, const char* file, int line) {
|
|
||||||
if (!cond) {
|
inline void
|
||||||
std::cerr << file << ":" << line << ": EXPECT failed: " << expr << "\n";
|
expect(bool cond, const char *expr, const char *file, int line)
|
||||||
}
|
{
|
||||||
|
if (!cond) {
|
||||||
|
std::cerr << file << ":" << line << ": EXPECT failed: " << expr << "\n";
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
inline void assert_true(bool cond, const char* expr, const char* file, int line) {
|
|
||||||
if (!cond) {
|
inline void
|
||||||
throw AssertionFailure{std::string(file) + ":" + std::to_string(line) + ": ASSERT failed: " + expr};
|
assert_true(bool cond, const char *expr, const char *file, int line)
|
||||||
}
|
{
|
||||||
|
if (!cond) {
|
||||||
|
throw AssertionFailure{std::string(file) + ":" + std::to_string(line) + ": ASSERT failed: " + expr};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
template<typename A, typename B>
|
template<typename A, typename B>
|
||||||
inline void assert_eq_impl(const A& a, const B& b, const char* ea, const char* eb, const char* file, int line) {
|
inline void
|
||||||
if (!(a == b)) {
|
assert_eq_impl(const A &a, const B &b, const char *ea, const char *eb, const char *file, int line)
|
||||||
std::ostringstream oss;
|
{
|
||||||
oss << file << ":" << line << ": ASSERT_EQ failed: " << ea << " == " << eb;
|
// Cast to common type to avoid signed/unsigned comparison warnings
|
||||||
throw AssertionFailure{oss.str()};
|
using Common = std::common_type_t<A, B>;
|
||||||
}
|
if (!(static_cast<Common>(a) == static_cast<Common>(b))) {
|
||||||
|
std::ostringstream oss;
|
||||||
|
oss << file << ":" << line << ": ASSERT_EQ failed: " << ea << " == " << eb;
|
||||||
|
throw AssertionFailure{oss.str()};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace ktet
|
} // namespace ktet
|
||||||
|
|
||||||
#define TEST(name) \
|
#define TEST(name) \
|
||||||
@@ -60,4 +74,4 @@ inline void assert_eq_impl(const A& a, const B& b, const char* ea, const char* e
|
|||||||
|
|
||||||
#define EXPECT_TRUE(x) ::ktet::expect((x), #x, __FILE__, __LINE__)
|
#define EXPECT_TRUE(x) ::ktet::expect((x), #x, __FILE__, __LINE__)
|
||||||
#define ASSERT_TRUE(x) ::ktet::assert_true((x), #x, __FILE__, __LINE__)
|
#define ASSERT_TRUE(x) ::ktet::assert_true((x), #x, __FILE__, __LINE__)
|
||||||
#define ASSERT_EQ(a,b) ::ktet::assert_eq_impl((a),(b), #a, #b, __FILE__, __LINE__)
|
#define ASSERT_EQ(a,b) ::ktet::assert_eq_impl((a),(b), #a, #b, __FILE__, __LINE__)
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user