Compare commits

...

37 Commits

Author SHA1 Message Date
23f04e4357 Add proportional fonts, edit modes, and TOML config
- Add three proportional serif fonts: Crimson Pro, ET Book, Spectral
- Fix text rendering for variable-width fonts: selection, cursor,
  mouse click mapping, search highlights, and syntax-colored text
  now use pixel-accurate measurement via ImGui::CalcTextSize()
- Add per-buffer edit mode (code/writing) with auto-detection from
  file extension (.txt, .md, .rst, .org, .tex default to writing)
- Add C-k m keybinding and :mode command to toggle edit modes
- Switch config format from INI to TOML (kge.toml), with legacy
  INI fallback; vendor toml++ v3.4.0
- New config keys: font.code and font.writing for per-mode defaults
- Add font tab completion for ImGui builds
- Add tab completion for :mode command
- Update help text, themes.md, and add CONFIG.md
- Bump version to 1.10.0

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-24 23:05:56 -07:00
0585edad9e Disable Qt build in make-app-release
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-24 21:22:11 -07:00
8712ea673d Add leuchtturm theme, font zoom, syntax palette fixes
Themes:
- Add leuchtturm theme (fountain pen ink on cream paper, brass/leather dark)
- Add per-theme syntax palettes for leuchtturm, tufte, and everforest
- Fix static inline globals giving each TU its own copy of gCurrentTheme
  and gBackgroundMode (changed to inline for proper C++17 linkage)
- :background with no args now shows current mode

Font zoom:
- CMD-=/CMD--/CMD-0 to increase/decrease/reset font size

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-24 21:17:55 -07:00
3148e16cf8 Fix multi-window architecture and swap file cleanup
Multi-window:
- Per-window ImGui contexts (fixes input, scroll, and rendering isolation)
- Per-instance scroll and mouse state in ImGuiRenderer (no more statics)
- Proper GL context activation during window destruction
- ValidateBufferIndex guards against stale curbuf_ across shared buffers
- Editor methods (CurrentBuffer, SwitchTo, CloseBuffer, etc.) use Buffers()
  accessor to respect shared buffer lists
- New windows open with an untitled buffer
- Scratch buffer reuse works in secondary windows
- CMD-w on macOS closes only the focused window
- Deferred new-window creation to avoid mid-frame ImGui context corruption

Swap file cleanup:
- SaveAs prompt handler now calls ResetJournal
- cmd_save_and_quit now calls ResetJournal
- Editor::Reset detaches all buffers before clearing
- Tests for save-and-quit and editor-reset swap cleanup

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-24 19:48:34 -07:00
34eaa72033 Bump patch version to 1.8.3
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-24 17:36:21 -07:00
f49f1698f4 Add Tufte theme with light and dark variants
Warm cream paper, near-black ink, zero rounding, minimal chrome,
restrained dark red and navy accents following Tufte's design principles.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-24 17:34:23 -07:00
f4b3188069 Forgot to bump patch version. 2026-03-17 17:28:57 -07:00
2571ab79c1 build now works on nix
1. Static linking - Added KTE_STATIC_LINK CMake option and
   disabled it in default.nix to avoid the "attempted
   static link of dynamic object" error

2. Missing include - Added <cstring> to
   test_swap_edge_cases.cc for std::memset/std::memcpy (GCC
   14 is stricter about transitive includes)
2026-03-17 17:15:16 -07:00
d768e56727 Add multi-window support to GUI with shared buffer list and improved input handling
- Introduced support for multiple windows, sharing the primary editor's buffer list.
- Added `GUIFrontend::OpenNewWindow_` for creating secondary windows with independent dimensions and input handlers.
- Redesigned `WindowState` to encapsulate per-window attributes (dimensions, renderer, input, etc.).
- Updated input processing and command execution to route events based on active window, preserving window-level states.
- Enhanced SDL2 and ImGui integration for proper context management across multiple windows.
- Increased robustness by handling window closing, resizing, and cleanup of secondary windows without affecting the primary editor.
- Updated documentation and key bindings for multi-window operations (e.g., Cmd+N / Ctrl+Shift+N).
- Version updated to 1.8.0 to reflect the major GUI enhancement.
2026-03-15 13:19:04 -07:00
11c523ad52 Bump patch version. 2026-02-26 13:27:13 -08:00
c261261e26 Initialize ErrorHandler early and ensure immediate log file creation
- Added early initialization of `ErrorHandler` in `main.cc` for robust error handling.
- Modified `ErrorHandler` to create the log file immediately, ensuring its presence in the state directory.
- Simplified conditional checks for log file operations and updated timestamp handling to use `system_clock`.
2026-02-26 13:25:57 -08:00
27dcb41857 Add ReflowUndo tests and integrate InsertRow undo support
- Added `test_reflow_undo.cc` to validate undo/redo workflows for reflow operations.
- Introduced `UndoType::InsertRow` in `UndoSystem` for tracking row insertion changes in undo history.
- Updated `UndoNode.h` and `UndoSystem.cc` to support row insertion as a standalone undo step.
- Enhanced reflow paragraph functionality to properly record undo/redo actions for both row deletion and insertion.
- Enabled legacy/extended undo tests in `test_undo.cc` for comprehensive validation.
- Updated `CMakeLists.txt` to include new test file in the build target.
2026-02-26 13:21:07 -08:00
bc3433e988 Add SmartNewline command with tests and editor integration
- Introduced `CommandId::SmartNewline` for auto-indented newlines, enhancing text editing workflows.
- Added `cmd_smart_newline` to implement indentation-aware newline logic.
- Integrated SmartNewline with keymaps, mouse/keyboard input handlers, and terminal/editor commands.
- Wrote comprehensive tests in `test_smart_newline.cc` to validate behavior for spaces, tabs, and no-indentation cases.
- Updated `Command.h` and `CMakeLists.txt` to register and build the new command.
2026-02-26 13:08:56 -08:00
690c51b0f3 MacOS: remove static linking. Bump minor version. 2026-02-19 21:00:29 -08:00
0d87bc0b25 Introduce error recovery mechanisms with retry logic and circuit breaker integration.
- Added `ErrorRecovery.cc` and `ErrorRecovery.h` for retry and circuit breaker implementations.
- Enhanced swap file handling with transient error retries and exponential backoff (e.g., ENOSPC, EDQUOT).
- Integrated circuit breaker into SwapManager to gracefully handle repeated failures, prevent system overload, and enable automatic recovery.
- Updated `DEVELOPER_GUIDE.md` with comprehensive documentation on error recovery patterns and graceful degradation strategies.
- Refined fsync, temp file creation, and swap file logic with retry-on-failure mechanisms for improved resilience.
2026-02-17 21:38:40 -08:00
daeeecb342 Standardize error handling patterns and improve ErrorHandler integration.
- Added a comprehensive error propagation standardization report detailing dominant patterns, inconsistencies, and recommended remediations (`docs/audits/error-propagation-standardization.md`).
- Integrated `ErrorHandler` into key components, including `main.cc` for robust exception reporting, and added centralized logging to a user state path.
- Introduced EINTR-safe syscall wrappers (`SyscallWrappers.h`, `.cc`) to improve resilience of file and metadata operations.
- Enhanced `DEVELOPER_GUIDE.md` with an error handling conventions section, covering pattern guidelines and best practices.
- Identified gaps in `PieceTable` and internal helpers; deferred fixes with detailed recommendations for improved memory allocation error reporting.
2026-02-17 21:25:19 -08:00
a428b204a0 Improve exception robustness.
- Introduced `test_swap_edge_cases.cc` with extensive tests for minimum payload sizes, truncated payloads, data overflows, unsupported encoding versions, CRC mismatches, and mixed valid/invalid records to ensure reliability under complex scenarios.
- Enhanced `main.cc` with a top-level exception handler to prevent data loss and ensure cleanup during unexpected failures.
2026-02-17 20:12:09 -08:00
a21409e689 Remove PID from unnamed buffer swap names. 2026-02-17 17:17:55 -08:00
b0b5b55dce Switch Docker to Alpine and build kge.
Update build environment to Alpine, enable GUI support, and refine developer guide

- Migrated Dockerfile base image from Ubuntu 22.04 to Alpine 3.19 for a smaller and faster container.
- Added dependencies for GUI support (SDL2, OpenGL/Mesa, Freetype, etc.) and updated CMake options.
- Enhanced `DEVELOPER_GUIDE.md` with new instructions for GUI builds, updated dependencies, and simplified custom build workflows.
- Addressed Alpine-specific ncurses library path issues in CMake configuration.
2026-02-17 16:53:12 -08:00
422b27b1ba Add Docker support for Linux build testing
- Introduced a `Dockerfile` for setting up a minimal Ubuntu-based build environment with required dependencies.
- Added `docker-build.sh` script to simplify Linux build and test execution using Docker or Podman.
- Updated `DEVELOPER_GUIDE.md` with instructions for using Docker/Podman for Linux builds, including CI/CD integration examples.
2026-02-17 16:35:52 -08:00
9485d2aa24 Linux fixup. 2026-02-17 16:13:28 -08:00
8a6b7851d5 Bump patch version. 2026-02-17 16:08:53 -08:00
8ec0d6ac41 Add benchmarks, migration tests, and dev guide
Add benchmarks for core operations, migration edge case tests, improved
buffer I/O tests, and developer guide

- Introduced `test_benchmarks.cc` for performance benchmarking of key
  operations in `PieceTable` and `Buffer`, including syntax highlighting
  and iteration patterns.
- Added `test_migration_coverage.cc` to provide comprehensive tests for
  migration of `Buffer::Rows()` to `PieceTable` APIs, with edge cases,
  boundary handling, and consistency checks.
- Enhanced `test_buffer_io.cc` with additional cases for save/load
  workflows, file handling, and better integration with the core API.
- Documented architectural details and core concepts in a new
  `DEVELOPER_GUIDE.md`. Highlighted design principles, code
  organization, and contribution workflows.
2026-02-17 16:08:23 -08:00
337b585ba0 Reformat code. 2026-02-17 13:44:36 -08:00
95a588b0df Add test for Git editor swap cleanup and improve swap file handling
- Added `test_swap_git_editor.cc` to verify proper swap file cleanup during Git editor workflows. Ensures no stale swap files are left after editor closure.
- Updated swap handling logic in `Editor.cc` to always remove swap files on buffer closure during normal exit, preventing accumulation of leftover files.
- Bumped version to 1.6.5 in `CMakeLists.txt`.
2026-02-17 13:10:01 -08:00
199d7a20f7 Add indented bullet reflow test, improve undo edge cases, and bump version
- Added `test_reflow_indented_bullets.cc` to verify correct reflow handling for indented bullet points.
- Enhanced undo system with additional tests for cursor adjacency, explicit grouping, branching, newline independence, and dirty-state tracking.
- Introduced external modification detection for files and required confirmation before overwrites.
- Refactored buffer save logic to use atomic writes and track on-disk identity.
- Updated CMake to include new test files and bumped version to 1.6.4.
2026-02-16 12:44:08 -08:00
44827fe53f Add mark-clearing behavior to refresh command and related test.
- Updated `Refresh` command to clear the mark when no active prompt, search, or visual-line mode is present.
- Added a new unit test verifying mark-clearing behavior for `Ctrl-G` (mapped to `Refresh`).
- Bumped version to 1.6.3 in `CMakeLists.txt`.
2026-02-14 23:05:44 -08:00
2a6ff2a862 Introduce swap journaling crash recovery system with tests.
- Added detailed journaling system (`SwapManager`) for crash recovery, including edit recording and replay.
- Integrated recovery prompts for handling swap files during file open flows.
- Implemented swap file cleanup, checkpointing, and compaction mechanisms.
- Added extensive unit tests for swap-related behaviors such as recovery prompts, file pruning, and corruption handling.
- Updated CMake to include new test files.
2026-02-13 08:45:27 -08:00
895e4ccb1e Add swap journaling and group undo/redo with extensive tests.
- Introduced SwapManager for sidecar journaling of buffer mutations, with a safe recovery mechanism.
- Added group undo/redo functionality, allowing atomic grouping of related edits.
- Implemented `SwapRecorder` and integrated it as a callback interface for mutations.
- Added unit tests for swap journaling (save/load/replay) and undo grouping.
- Refactored undo to support group tracking and ID management.
- Updated CMake to include the new tests and swap journaling logic.
2026-02-11 20:47:18 -08:00
15b350bfaa Add TestHarness infrastructure and initial smoke test
- Implemented `TestHarness` class for headless editor testing.
- Added utility methods for text insertion, editing, and querying.
- Introduced `test_daily_driver_harness` for verifying basic text buffer operations.
- Updated CMake to include the new test files.
2026-02-10 23:34:01 -08:00
cc8df36bdf Implement branching undo system with tests and updates.
- Added branching model for undo/redo, enabling multiple redo paths and branch selection.
- Updated `UndoNode` to include `parent` and refined hierarchical navigation.
- Extended `UndoSystem` with branching logic for redo operations, supporting sibling branch selection.
- Overhauled tests to validate branching behavior and tree invariants.
- Refined editor command logic for undo/redo with repeat counts and branch selection.
- Enabled test-only introspection hooks for undo tree validation.
- Updated CMake to include test definitions (`KTE_TESTS` flag).
2026-02-10 23:13:00 -08:00
1c0f04f076 Bump version to 1.6.0.
- Linear undo
- Multicursor support
- Reflow numbered lists
2026-02-10 22:41:20 -08:00
ac0eadc345 Add undo system with coalescing logic and comprehensive tests.
- Implemented robust undo system supporting coalescing of text operations (insert, backspace, delete).
- Added `UndoSystem` integration into the editor/commands pipeline.
- Wrote extensive unit tests for various undo/redo scenarios, including multiline operations, cursor preservation, and history management.
- Refactored to ensure consistent cursor behavior during undo/redo actions.
- Updated CMake to include new tests.
2026-02-10 22:39:55 -08:00
f3bdced3d4 Add visual-line mode support with tests and UI integration.
- Introduced visual-line mode for multi-line selection and edits.
- Implemented commands, rendering, and keyboard shortcuts.
- Added tests for broadcast operations in visual-line mode.
2026-02-10 22:07:13 -08:00
2551388420 Support numbered lists in reflow-paragraph.
Add `reflow-paragraph` tests for numbered lists with hanging indents and extend support for numbered list parsing and wrapping logic.
2026-02-10 21:23:20 -08:00
d2d155f211 Fix data race.
+ Add thread-safety with mutexes in `PieceTable` and `Buffer`
+ Bump version to 1.5.9
2026-01-28 01:03:58 -08:00
8634eb78f0 Refactor Init method across all frontends to include argc and argv for improved argument handling consistency. 2026-01-12 10:35:24 -08:00
152 changed files with 70613 additions and 17340 deletions

View File

@@ -1,6 +1,6 @@
# Project Guidelines # Project Guidelines
kte is Kyle's Text Editor — a simple, fast text editor written in C++17. kte is Kyle's Text Editor — a simple, fast text editor written in C++20.
It It
replaces the earlier C implementation, ke (see the ke manual in replaces the earlier C implementation, ke (see the ke manual in
`docs/ke.md`). The `docs/ke.md`). The
@@ -43,7 +43,7 @@ The file `docs/ke.md` contains the canonical reference for keybindings.
## Contributing/Development Notes ## Contributing/Development Notes
- C++ standard: C++17. - C++ standard: C++20.
- Keep dependencies minimal. - Keep dependencies minimal.
- Prefer small, focused changes that preserve kes UX unless explicitly - Prefer small, focused changes that preserve kes UX unless explicitly
changing changing
@@ -55,3 +55,4 @@ The file `docs/ke.md` contains the canonical reference for keybindings.
for now). for now).
- Inspiration: kilo, WordStar/VDE, emacs, `mg(1)`. - Inspiration: kilo, WordStar/VDE, emacs, `mg(1)`.

325
Buffer.cc
View File

@@ -7,9 +7,20 @@
#include <cstring> #include <cstring>
#include <string_view> #include <string_view>
#include <vector>
#include <fcntl.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/types.h>
#include "Buffer.h" #include "Buffer.h"
#include "SwapRecorder.h"
#include "UndoSystem.h" #include "UndoSystem.h"
#include "UndoTree.h" #include "UndoTree.h"
#include "ErrorHandler.h"
#include "SyscallWrappers.h"
#include "ErrorRecovery.h"
// For reconstructing highlighter state on copies // For reconstructing highlighter state on copies
#include "syntax/HighlighterRegistry.h" #include "syntax/HighlighterRegistry.h"
#include "syntax/NullHighlighter.h" #include "syntax/NullHighlighter.h"
@@ -23,6 +34,177 @@ Buffer::Buffer()
} }
bool
Buffer::stat_identity(const std::string &path, FileIdentity &out)
{
struct stat st{};
if (::stat(path.c_str(), &st) != 0) {
out.valid = false;
return false;
}
out.valid = true;
// Use nanosecond timestamp when available.
std::uint64_t ns = 0;
#if defined(__APPLE__)
ns = static_cast<std::uint64_t>(st.st_mtimespec.tv_sec) * 1000000000ull
+ static_cast<std::uint64_t>(st.st_mtimespec.tv_nsec);
#else
ns = static_cast<std::uint64_t>(st.st_mtim.tv_sec) * 1000000000ull
+ static_cast<std::uint64_t>(st.st_mtim.tv_nsec);
#endif
out.mtime_ns = ns;
out.size = static_cast<std::uint64_t>(st.st_size);
out.dev = static_cast<std::uint64_t>(st.st_dev);
out.ino = static_cast<std::uint64_t>(st.st_ino);
return true;
}
bool
Buffer::current_disk_identity(FileIdentity &out) const
{
if (!is_file_backed_ || filename_.empty()) {
out.valid = false;
return false;
}
return stat_identity(filename_, out);
}
bool
Buffer::ExternallyModifiedOnDisk() const
{
if (!is_file_backed_ || filename_.empty())
return false;
FileIdentity now{};
if (!current_disk_identity(now)) {
// If the file vanished, treat as modified when we previously had an identity.
return on_disk_identity_.valid;
}
if (!on_disk_identity_.valid)
return false;
return now.mtime_ns != on_disk_identity_.mtime_ns
|| now.size != on_disk_identity_.size
|| now.dev != on_disk_identity_.dev
|| now.ino != on_disk_identity_.ino;
}
void
Buffer::RefreshOnDiskIdentity()
{
FileIdentity id{};
if (current_disk_identity(id))
on_disk_identity_ = id;
}
static bool
write_all_fd(int fd, const char *data, std::size_t len, std::string &err)
{
std::size_t off = 0;
while (off < len) {
ssize_t n = ::write(fd, data + off, len - off);
if (n < 0) {
if (errno == EINTR)
continue;
err = std::string("Write failed: ") + std::strerror(errno);
return false;
}
off += static_cast<std::size_t>(n);
}
return true;
}
static void
best_effort_fsync_dir(const std::string &path)
{
try {
std::filesystem::path p(path);
std::filesystem::path dir = p.parent_path();
if (dir.empty())
return;
int dfd = kte::syscall::Open(dir.c_str(), O_RDONLY);
if (dfd < 0)
return;
(void) kte::syscall::Fsync(dfd);
(void) kte::syscall::Close(dfd);
} catch (...) {
// best-effort
}
}
static bool
atomic_write_file(const std::string &path, const char *data, std::size_t len, std::string &err)
{
// Create a temp file in the same directory so rename() is atomic.
std::filesystem::path p(path);
std::filesystem::path dir = p.parent_path();
std::string base = p.filename().string();
std::filesystem::path tmpl = dir / ("." + base + ".kte.tmp.XXXXXX");
std::string tmpl_s = tmpl.string();
// mkstemp requires a mutable buffer.
std::vector<char> buf(tmpl_s.begin(), tmpl_s.end());
buf.push_back('\0');
// Retry on transient errors for temp file creation
int fd = -1;
auto mkstemp_fn = [&]() -> bool {
// Reset buffer for each retry attempt
buf.assign(tmpl_s.begin(), tmpl_s.end());
buf.push_back('\0');
fd = kte::syscall::Mkstemp(buf.data());
return fd >= 0;
};
if (!kte::RetryOnTransientError(mkstemp_fn, kte::RetryPolicy::Aggressive(), err)) {
if (fd < 0) {
err = std::string("Failed to create temp file for save: ") + std::strerror(errno) + err;
}
return false;
}
std::string tmp_path(buf.data());
// If the destination exists, carry over its permissions.
struct stat dst_st{};
if (::stat(path.c_str(), &dst_st) == 0) {
(void) kte::syscall::Fchmod(fd, dst_st.st_mode);
}
bool ok = write_all_fd(fd, data, len, err);
if (ok) {
// Retry fsync on transient errors
auto fsync_fn = [&]() -> bool {
return kte::syscall::Fsync(fd) == 0;
};
std::string fsync_err;
if (!kte::RetryOnTransientError(fsync_fn, kte::RetryPolicy::Aggressive(), fsync_err)) {
err = std::string("fsync failed: ") + std::strerror(errno) + fsync_err;
ok = false;
}
}
(void) kte::syscall::Close(fd);
if (ok) {
if (::rename(tmp_path.c_str(), path.c_str()) != 0) {
err = std::string("rename failed: ") + std::strerror(errno);
ok = false;
}
}
if (!ok) {
(void) ::unlink(tmp_path.c_str());
return false;
}
best_effort_fsync_dir(path);
return true;
}
Buffer::Buffer(const std::string &path) Buffer::Buffer(const std::string &path)
{ {
std::string err; std::string err;
@@ -250,17 +432,46 @@ Buffer::OpenFromFile(const std::string &path, std::string &err)
std::ifstream in(norm, std::ios::in | std::ios::binary); std::ifstream in(norm, std::ios::in | std::ios::binary);
if (!in) { if (!in) {
err = "Failed to open file: " + norm; err = "Failed to open file: " + norm;
kte::ErrorHandler::Instance().Error("Buffer", err, norm);
return false; return false;
} }
// Read entire file into PieceTable as-is // Read entire file into PieceTable as-is
std::string data; std::string data;
in.seekg(0, std::ios::end); in.seekg(0, std::ios::end);
if (!in) {
err = "Failed to seek to end of file: " + norm;
kte::ErrorHandler::Instance().Error("Buffer", err, norm);
return false;
}
auto sz = in.tellg(); auto sz = in.tellg();
if (sz < 0) {
err = "Failed to get file size: " + norm;
kte::ErrorHandler::Instance().Error("Buffer", err, norm);
return false;
}
if (sz > 0) { if (sz > 0) {
data.resize(static_cast<std::size_t>(sz)); data.resize(static_cast<std::size_t>(sz));
in.seekg(0, std::ios::beg); in.seekg(0, std::ios::beg);
if (!in) {
err = "Failed to seek to beginning of file: " + norm;
kte::ErrorHandler::Instance().Error("Buffer", err, norm);
return false;
}
in.read(data.data(), static_cast<std::streamsize>(data.size())); in.read(data.data(), static_cast<std::streamsize>(data.size()));
if (!in && !in.eof()) {
err = "Failed to read file: " + norm;
kte::ErrorHandler::Instance().Error("Buffer", err, norm);
return false;
}
// Validate we read the expected number of bytes
const std::streamsize bytes_read = in.gcount();
if (bytes_read != static_cast<std::streamsize>(data.size())) {
err = "Partial read of file (expected " + std::to_string(data.size()) +
" bytes, got " + std::to_string(bytes_read) + "): " + norm;
kte::ErrorHandler::Instance().Error("Buffer", err, norm);
return false;
}
} }
content_.Clear(); content_.Clear();
if (!data.empty()) if (!data.empty())
@@ -270,6 +481,7 @@ Buffer::OpenFromFile(const std::string &path, std::string &err)
filename_ = norm; filename_ = norm;
is_file_backed_ = true; is_file_backed_ = true;
dirty_ = false; dirty_ = false;
RefreshOnDiskIdentity();
// Reset/initialize undo system for this loaded file // Reset/initialize undo system for this loaded file
if (!undo_tree_) if (!undo_tree_)
@@ -296,22 +508,18 @@ Buffer::Save(std::string &err) const
err = "Buffer is not file-backed; use SaveAs()"; err = "Buffer is not file-backed; use SaveAs()";
return false; return false;
} }
std::ofstream out(filename_, std::ios::out | std::ios::binary | std::ios::trunc); const std::size_t sz = content_.Size();
if (!out) { const char *data = sz ? content_.Data() : nullptr;
err = "Failed to open for write: " + filename_ + ". Error: " + std::string(std::strerror(errno)); if (sz && !data) {
err = "Internal error: buffer materialization failed";
return false; return false;
} }
// Stream the content directly from the piece table to avoid relying on if (!atomic_write_file(filename_, data ? data : "", sz, err)) {
// full materialization, which may yield an empty pointer when size > 0. kte::ErrorHandler::Instance().Error("Buffer", err, filename_);
if (content_.Size() > 0) {
content_.WriteToStream(out);
}
// Ensure data hits the OS buffers
out.flush();
if (!out.good()) {
err = "Write error: " + filename_ + ". Error: " + std::string(std::strerror(errno));
return false; return false;
} }
// Update observed on-disk identity after a successful save.
const_cast<Buffer *>(this)->RefreshOnDiskIdentity();
// Note: const method cannot change dirty_. Intentionally const to allow UI code // Note: const method cannot change dirty_. Intentionally const to allow UI code
// to decide when to flip dirty flag after successful save. // to decide when to flip dirty flag after successful save.
return true; return true;
@@ -340,26 +548,21 @@ Buffer::SaveAs(const std::string &path, std::string &err)
out_path = path; out_path = path;
} }
// Write to the given path const std::size_t sz = content_.Size();
std::ofstream out(out_path, std::ios::out | std::ios::binary | std::ios::trunc); const char *data = sz ? content_.Data() : nullptr;
if (!out) { if (sz && !data) {
err = "Failed to open for write: " + out_path + ". Error: " + std::string(std::strerror(errno)); err = "Internal error: buffer materialization failed";
return false; return false;
} }
// Stream content without forcing full materialization if (!atomic_write_file(out_path, data ? data : "", sz, err)) {
if (content_.Size() > 0) { kte::ErrorHandler::Instance().Error("Buffer", err, out_path);
content_.WriteToStream(out);
}
// Ensure data hits the OS buffers
out.flush();
if (!out.good()) {
err = "Write error: " + out_path + ". Error: " + std::string(std::strerror(errno));
return false; return false;
} }
filename_ = out_path; filename_ = out_path;
is_file_backed_ = true; is_file_backed_ = true;
dirty_ = false; dirty_ = false;
RefreshOnDiskIdentity();
return true; return true;
} }
@@ -390,6 +593,8 @@ Buffer::insert_text(int row, int col, std::string_view text)
if (!text.empty()) { if (!text.empty()) {
content_.Insert(off, text.data(), text.size()); content_.Insert(off, text.data(), text.size());
rows_cache_dirty_ = true; rows_cache_dirty_ = true;
if (swap_rec_)
swap_rec_->OnInsert(row, col, text);
} }
} }
@@ -412,6 +617,7 @@ Buffer::GetLineView(std::size_t row) const
void void
Buffer::ensure_rows_cache() const Buffer::ensure_rows_cache() const
{ {
std::lock_guard<std::mutex> lock(buffer_mutex_);
if (!rows_cache_dirty_) if (!rows_cache_dirty_)
return; return;
rows_.clear(); rows_.clear();
@@ -433,6 +639,21 @@ Buffer::content_LineCount_() const
} }
#if defined(KTE_TESTS)
std::string
Buffer::BytesForTests() const
{
const std::size_t sz = content_.Size();
if (sz == 0)
return std::string();
const char *data = content_.Data();
if (!data)
return std::string();
return std::string(data, data + sz);
}
#endif
void void
Buffer::delete_text(int row, int col, std::size_t len) Buffer::delete_text(int row, int col, std::size_t len)
{ {
@@ -442,6 +663,7 @@ Buffer::delete_text(int row, int col, std::size_t len)
row = 0; row = 0;
if (col < 0) if (col < 0)
col = 0; col = 0;
const std::size_t start = content_.LineColToByteOffset(static_cast<std::size_t>(row), const std::size_t start = content_.LineColToByteOffset(static_cast<std::size_t>(row),
static_cast<std::size_t>(col)); static_cast<std::size_t>(col));
std::size_t r = static_cast<std::size_t>(row); std::size_t r = static_cast<std::size_t>(row);
@@ -461,16 +683,19 @@ Buffer::delete_text(int row, int col, std::size_t len)
break; break;
// Consume newline between lines as one char, if there is a next line // Consume newline between lines as one char, if there is a next line
if (r + 1 < lc) { if (r + 1 < lc) {
if (remaining > 0) {
remaining -= 1; // the newline remaining -= 1; // the newline
r += 1; r += 1;
c = 0; c = 0;
}
} else { } else {
// At last line and still remaining: delete to EOF // At last line and still remaining: delete to EOF
std::size_t total = content_.Size(); const std::size_t total = content_.Size();
content_.Delete(start, total - start); const std::size_t actual = (total > start) ? (total - start) : 0;
if (actual == 0)
return;
content_.Delete(start, actual);
rows_cache_dirty_ = true; rows_cache_dirty_ = true;
if (swap_rec_)
swap_rec_->OnDelete(row, col, actual);
return; return;
} }
} }
@@ -478,8 +703,11 @@ Buffer::delete_text(int row, int col, std::size_t len)
// Compute end offset at (r,c) // Compute end offset at (r,c)
std::size_t end = content_.LineColToByteOffset(r, c); std::size_t end = content_.LineColToByteOffset(r, c);
if (end > start) { if (end > start) {
content_.Delete(start, end - start); const std::size_t actual = end - start;
content_.Delete(start, actual);
rows_cache_dirty_ = true; rows_cache_dirty_ = true;
if (swap_rec_)
swap_rec_->OnDelete(row, col, actual);
} }
} }
@@ -487,15 +715,18 @@ Buffer::delete_text(int row, int col, std::size_t len)
void void
Buffer::split_line(int row, const int col) Buffer::split_line(int row, const int col)
{ {
int c = col;
if (row < 0) if (row < 0)
row = 0; row = 0;
if (col < 0) if (c < 0)
row = 0; c = 0;
const std::size_t off = content_.LineColToByteOffset(static_cast<std::size_t>(row), const std::size_t off = content_.LineColToByteOffset(static_cast<std::size_t>(row),
static_cast<std::size_t>(col)); static_cast<std::size_t>(c));
const char nl = '\n'; const char nl = '\n';
content_.Insert(off, &nl, 1); content_.Insert(off, &nl, 1);
rows_cache_dirty_ = true; rows_cache_dirty_ = true;
if (swap_rec_)
swap_rec_->OnInsert(row, c, std::string_view("\n", 1));
} }
@@ -507,11 +738,14 @@ Buffer::join_lines(int row)
std::size_t r = static_cast<std::size_t>(row); std::size_t r = static_cast<std::size_t>(row);
if (r + 1 >= content_.LineCount()) if (r + 1 >= content_.LineCount())
return; return;
const int col = static_cast<int>(content_.GetLine(r).size());
// Delete the newline between line r and r+1 // Delete the newline between line r and r+1
std::size_t end_of_line = content_.LineColToByteOffset(r, std::numeric_limits<std::size_t>::max()); std::size_t end_of_line = content_.LineColToByteOffset(r, std::numeric_limits<std::size_t>::max());
// end_of_line now equals line end (clamped before newline). The newline should be exactly at this position. // end_of_line now equals line end (clamped before newline). The newline should be exactly at this position.
content_.Delete(end_of_line, 1); content_.Delete(end_of_line, 1);
rows_cache_dirty_ = true; rows_cache_dirty_ = true;
if (swap_rec_)
swap_rec_->OnDelete(row, col, 1);
} }
@@ -526,6 +760,12 @@ Buffer::insert_row(int row, const std::string_view text)
const char nl = '\n'; const char nl = '\n';
content_.Insert(off + text.size(), &nl, 1); content_.Insert(off + text.size(), &nl, 1);
rows_cache_dirty_ = true; rows_cache_dirty_ = true;
if (swap_rec_) {
// Avoid allocation: emit the row text insertion (if any) and the newline insertion.
if (!text.empty())
swap_rec_->OnInsert(row, 0, text);
swap_rec_->OnInsert(row, static_cast<int>(text.size()), std::string_view("\n", 1));
}
} }
@@ -540,9 +780,24 @@ Buffer::delete_row(int row)
auto range = content_.GetLineRange(r); // [start,end) auto range = content_.GetLineRange(r); // [start,end)
// If not last line, ensure we include the separating newline by using end as-is (which points to next line start) // If not last line, ensure we include the separating newline by using end as-is (which points to next line start)
// If last line, end may equal total_size_. We still delete [start,end) which removes the last line content. // If last line, end may equal total_size_. We still delete [start,end) which removes the last line content.
std::size_t start = range.first; const std::size_t start = range.first;
std::size_t end = range.second; const std::size_t end = range.second;
content_.Delete(start, end - start); const std::size_t actual = (end > start) ? (end - start) : 0;
if (actual == 0)
return;
content_.Delete(start, actual);
rows_cache_dirty_ = true;
if (swap_rec_)
swap_rec_->OnDelete(row, 0, actual);
}
void
Buffer::replace_all_bytes(const std::string_view bytes)
{
content_.Clear();
if (!bytes.empty())
content_.Append(bytes.data(), bytes.size());
rows_cache_dirty_ = true; rows_cache_dirty_ = true;
} }

188
Buffer.h
View File

@@ -1,11 +1,46 @@
/* /*
* 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
#include <algorithm>
#include <cstddef> #include <cstddef>
#include <filesystem>
#include <memory> #include <memory>
#include <string> #include <string>
#include <unordered_set>
#include <vector> #include <vector>
#include <string_view> #include <string_view>
@@ -14,6 +49,27 @@
#include <cstdint> #include <cstdint>
#include "syntax/HighlighterEngine.h" #include "syntax/HighlighterEngine.h"
#include "Highlight.h" #include "Highlight.h"
#include <mutex>
// Edit mode determines which font class is used for a buffer.
enum class EditMode { Code, Writing };
// Detect edit mode from a filename's extension.
inline EditMode
DetectEditMode(const std::string &filename)
{
std::string ext = std::filesystem::path(filename).extension().string();
std::transform(ext.begin(), ext.end(), ext.begin(), [](unsigned char c) {
return static_cast<char>(std::tolower(c));
});
static const std::unordered_set<std::string> writing_exts = {
".txt", ".md", ".markdown", ".rst", ".org",
".tex", ".adoc", ".asciidoc",
};
if (writing_exts.count(ext))
return EditMode::Writing;
return EditMode::Code;
}
// Forward declaration for swap journal integration // Forward declaration for swap journal integration
namespace kte { namespace kte {
@@ -41,6 +97,14 @@ public:
bool Save(std::string &err) const; // saves to existing filename; returns false if not file-backed bool Save(std::string &err) const; // saves to existing filename; returns false if not file-backed
bool SaveAs(const std::string &path, std::string &err); // saves to path and makes buffer file-backed bool SaveAs(const std::string &path, std::string &err); // saves to path and makes buffer file-backed
// External modification detection.
// Returns true if the file on disk differs from the last observed identity recorded
// on open/save.
[[nodiscard]] bool ExternallyModifiedOnDisk() const;
// Refresh the stored on-disk identity to match current stat (used after open/save).
void RefreshOnDiskIdentity();
// Accessors // Accessors
[[nodiscard]] std::size_t Curx() const [[nodiscard]] std::size_t Curx() const
{ {
@@ -369,6 +433,71 @@ public:
} }
// Visual-line selection support (multicursor/visual mode)
void VisualLineClear()
{
visual_line_active_ = false;
}
void VisualLineStart()
{
visual_line_active_ = true;
visual_line_anchor_y_ = cury_;
visual_line_active_y_ = cury_;
}
void VisualLineToggle()
{
if (visual_line_active_)
VisualLineClear();
else
VisualLineStart();
}
[[nodiscard]] bool VisualLineActive() const
{
return visual_line_active_;
}
void VisualLineSetActiveY(std::size_t y)
{
visual_line_active_y_ = y;
}
[[nodiscard]] std::size_t VisualLineStartY() const
{
return visual_line_anchor_y_ < visual_line_active_y_ ? visual_line_anchor_y_ : visual_line_active_y_;
}
[[nodiscard]] std::size_t VisualLineEndY() const
{
return visual_line_anchor_y_ < visual_line_active_y_ ? visual_line_active_y_ : visual_line_anchor_y_;
}
// In visual-line (multi-cursor) mode, the UI should highlight only the per-line
// cursor "spot" (Curx clamped to each line length), not the entire line.
[[nodiscard]] bool VisualLineSpotSelected(std::size_t y, std::size_t sx) const
{
if (!visual_line_active_)
return false;
if (y < VisualLineStartY() || y > VisualLineEndY())
return false;
std::string_view ln = GetLineView(y);
// `GetLineView()` returns the raw range, which may include a trailing '\n'.
if (!ln.empty() && ln.back() == '\n')
ln.remove_suffix(1);
const std::size_t spot = std::min(Curx(), ln.size());
return sx == spot;
}
[[nodiscard]] std::string AsString() const; [[nodiscard]] std::string AsString() const;
// Syntax highlighting integration (per-buffer) // Syntax highlighting integration (per-buffer)
@@ -378,6 +507,27 @@ public:
} }
// Edit mode (code vs writing)
[[nodiscard]] EditMode GetEditMode() const
{
return edit_mode_;
}
void SetEditMode(EditMode m)
{
edit_mode_ = m;
}
void ToggleEditMode()
{
edit_mode_ = (edit_mode_ == EditMode::Code)
? EditMode::Writing
: EditMode::Code;
}
void SetSyntaxEnabled(bool on) void SetSyntaxEnabled(bool on)
{ {
syntax_enabled_ = on; syntax_enabled_ = on;
@@ -428,6 +578,12 @@ public:
} }
[[nodiscard]] kte::SwapRecorder *SwapRecorder() const
{
return swap_rec_;
}
// Raw, low-level editing APIs used by UndoSystem apply(). // Raw, low-level editing APIs used by UndoSystem apply().
// These must NOT trigger undo recording. They also do not move the cursor. // These must NOT trigger undo recording. They also do not move the cursor.
void insert_text(int row, int col, std::string_view text); void insert_text(int row, int col, std::string_view text);
@@ -442,12 +598,36 @@ public:
void delete_row(int row); void delete_row(int row);
// Replace the entire buffer content with raw bytes.
// Intended for crash recovery (swap replay) and test harnesses.
// This does not trigger swap or undo recording.
void replace_all_bytes(std::string_view bytes);
// Undo system accessors (created per-buffer) // Undo system accessors (created per-buffer)
[[nodiscard]] UndoSystem *Undo(); [[nodiscard]] UndoSystem *Undo();
[[nodiscard]] const UndoSystem *Undo() const; [[nodiscard]] const UndoSystem *Undo() const;
#if defined(KTE_TESTS)
// Test-only: return the raw buffer bytes (including newlines) as a string.
[[nodiscard]] std::string BytesForTests() const;
#endif
private: private:
struct FileIdentity {
bool valid = false;
std::uint64_t mtime_ns = 0;
std::uint64_t size = 0;
std::uint64_t dev = 0;
std::uint64_t ino = 0;
};
[[nodiscard]] static bool stat_identity(const std::string &path, FileIdentity &out);
[[nodiscard]] bool current_disk_identity(FileIdentity &out) const;
mutable FileIdentity on_disk_identity_{};
// State mirroring original C struct (without undo_tree) // State mirroring original C struct (without undo_tree)
std::size_t curx_ = 0, cury_ = 0; // cursor position in characters std::size_t curx_ = 0, cury_ = 0; // cursor position in characters
std::size_t rx_ = 0; // render x (tabs expanded) std::size_t rx_ = 0; // render x (tabs expanded)
@@ -470,11 +650,17 @@ private:
bool read_only_ = false; bool read_only_ = false;
bool mark_set_ = false; bool mark_set_ = false;
std::size_t mark_curx_ = 0, mark_cury_ = 0; std::size_t mark_curx_ = 0, mark_cury_ = 0;
bool visual_line_active_ = false;
std::size_t visual_line_anchor_y_ = 0;
std::size_t visual_line_active_y_ = 0;
// Per-buffer undo state // Per-buffer undo state
std::unique_ptr<struct UndoTree> undo_tree_; std::unique_ptr<struct UndoTree> undo_tree_;
std::unique_ptr<UndoSystem> undo_sys_; std::unique_ptr<UndoSystem> undo_sys_;
// Edit mode (code vs writing)
EditMode edit_mode_ = EditMode::Code;
// Syntax/highlighting state // Syntax/highlighting state
std::uint64_t version_ = 0; // increment on edits std::uint64_t version_ = 0; // increment on edits
bool syntax_enabled_ = true; bool syntax_enabled_ = true;
@@ -482,4 +668,6 @@ private:
std::unique_ptr<kte::HighlighterEngine> highlighter_; std::unique_ptr<kte::HighlighterEngine> highlighter_;
// Non-owning pointer to swap recorder managed by Editor/SwapManager // Non-owning pointer to swap recorder managed by Editor/SwapManager
kte::SwapRecorder *swap_rec_ = nullptr; kte::SwapRecorder *swap_rec_ = nullptr;
mutable std::mutex buffer_mutex_;
}; };

View File

@@ -4,16 +4,17 @@ project(kte)
include(GNUInstallDirs) include(GNUInstallDirs)
set(CMAKE_CXX_STANDARD 20) set(CMAKE_CXX_STANDARD 20)
set(KTE_VERSION "1.5.8") set(KTE_VERSION "1.10.0")
# 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.
set(BUILD_GUI ON CACHE BOOL "Enable building the graphical version.") set(BUILD_GUI ON CACHE BOOL "Enable building the graphical version.")
set(KTE_USE_QT OFF CACHE BOOL "Build the QT frontend instead of ImGui.") set(KTE_USE_QT OFF CACHE BOOL "Build the QT frontend instead of ImGui.")
set(BUILD_TESTS OFF CACHE BOOL "Enable building test programs.") set(BUILD_TESTS ON CACHE BOOL "Enable building test programs.")
set(KTE_FONT_SIZE "18.0" CACHE STRING "Default font size for GUI") set(KTE_FONT_SIZE "18.0" CACHE STRING "Default font size for GUI")
option(KTE_UNDO_DEBUG "Enable undo instrumentation logs" OFF) option(KTE_UNDO_DEBUG "Enable undo instrumentation logs" OFF)
option(KTE_ENABLE_TREESITTER "Enable optional Tree-sitter highlighter adapter" OFF) option(KTE_ENABLE_TREESITTER "Enable optional Tree-sitter highlighter adapter" OFF)
option(KTE_STATIC_LINK "Enable static linking on Linux" ON)
# Optionally enable AddressSanitizer (ASan) # Optionally enable AddressSanitizer (ASan)
option(ENABLE_ASAN "Enable AddressSanitizer for builds" OFF) option(ENABLE_ASAN "Enable AddressSanitizer for builds" OFF)
@@ -39,7 +40,6 @@ if (MSVC)
add_compile_options("/W4" "$<$<CONFIG:RELEASE>:/O2>") add_compile_options("/W4" "$<$<CONFIG:RELEASE>:/O2>")
else () else ()
add_compile_options( add_compile_options(
"-static"
"-Wall" "-Wall"
"-Wextra" "-Wextra"
"-Werror" "-Werror"
@@ -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
@@ -134,6 +142,9 @@ set(COMMON_SOURCES
HelpText.cc HelpText.cc
KKeymap.cc KKeymap.cc
Swap.cc Swap.cc
ErrorHandler.cc
SyscallWrappers.cc
ErrorRecovery.cc
TerminalInputHandler.cc TerminalInputHandler.cc
TerminalRenderer.cc TerminalRenderer.cc
TerminalFrontend.cc TerminalFrontend.cc
@@ -194,6 +205,8 @@ set(FONT_HEADERS
fonts/FontList.h fonts/FontList.h
fonts/B612Mono.h fonts/B612Mono.h
fonts/BrassMono.h fonts/BrassMono.h
fonts/CrimsonPro.h
fonts/ETBook.h
fonts/BrassMonoCode.h fonts/BrassMonoCode.h
fonts/FiraCode.h fonts/FiraCode.h
fonts/Go.h fonts/Go.h
@@ -205,6 +218,7 @@ set(FONT_HEADERS
fonts/IosevkaExtended.h fonts/IosevkaExtended.h
fonts/ShareTech.h fonts/ShareTech.h
fonts/SpaceMono.h fonts/SpaceMono.h
fonts/Spectral.h
fonts/Syne.h fonts/Syne.h
fonts/Triplicate.h fonts/Triplicate.h
fonts/Unispace.h fonts/Unispace.h
@@ -274,6 +288,11 @@ endif ()
target_link_libraries(kte ${CURSES_LIBRARIES}) target_link_libraries(kte ${CURSES_LIBRARIES})
# Static linking on Linux only (macOS does not support static linking of system libraries)
if (NOT APPLE AND KTE_STATIC_LINK)
target_link_options(kte PRIVATE -static)
endif ()
if (KTE_ENABLE_TREESITTER) if (KTE_ENABLE_TREESITTER)
# Users can provide their own tree-sitter include/lib via cache variables # Users can provide their own tree-sitter include/lib via cache variables
set(TREESITTER_INCLUDE_DIR "" CACHE PATH "Path to tree-sitter include directory") set(TREESITTER_INCLUDE_DIR "" CACHE PATH "Path to tree-sitter include directory")
@@ -298,13 +317,45 @@ if (BUILD_TESTS)
add_executable(kte_tests add_executable(kte_tests
tests/TestRunner.cc tests/TestRunner.cc
tests/Test.h tests/Test.h
tests/TestHarness.h
tests/test_daily_driver_harness.cc
tests/test_daily_workflows.cc
tests/test_buffer_io.cc tests/test_buffer_io.cc
tests/test_buffer_rows.cc
tests/test_command_semantics.cc
tests/test_kkeymap.cc
tests/test_swap_recorder.cc
tests/test_swap_writer.cc
tests/test_swap_replay.cc
tests/test_swap_edge_cases.cc
tests/test_swap_recovery_prompt.cc
tests/test_swap_cleanup.cc
tests/test_swap_cleanup2.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_reflow_paragraph.cc
tests/test_reflow_indented_bullets.cc
tests/test_undo.cc
tests/test_visual_line_mode.cc
tests/test_benchmarks.cc
tests/test_migration_coverage.cc
tests/test_smart_newline.cc
tests/test_reflow_undo.cc
# minimal engine sources required by Buffer # minimal engine sources required by Buffer
PieceTable.cc PieceTable.cc
Buffer.cc Buffer.cc
Editor.cc
Command.cc
HelpText.cc
Swap.cc
ErrorHandler.cc
SyscallWrappers.cc
ErrorRecovery.cc
KKeymap.cc
SwapRecorder.h
OptimizedSearch.cc OptimizedSearch.cc
UndoNode.cc UndoNode.cc
UndoTree.cc UndoTree.cc
@@ -312,6 +363,9 @@ if (BUILD_TESTS)
${SYNTAX_SOURCES} ${SYNTAX_SOURCES}
) )
# Allow test-only introspection hooks (guarded in headers) without affecting production builds.
target_compile_definitions(kte_tests PRIVATE KTE_TESTS=1)
# Allow tests to include project headers like "Buffer.h" # Allow tests to include project headers like "Buffer.h"
target_include_directories(kte_tests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) target_include_directories(kte_tests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
@@ -324,6 +378,11 @@ if (BUILD_TESTS)
target_link_libraries(kte_tests ${TREESITTER_LIBRARY}) target_link_libraries(kte_tests ${TREESITTER_LIBRARY})
endif () endif ()
endif () endif ()
# Static linking on Linux only (macOS does not support static linking of system libraries)
if (NOT APPLE AND KTE_STATIC_LINK)
target_link_options(kte_tests PRIVATE -static)
endif ()
endif () endif ()
if (BUILD_GUI) if (BUILD_GUI)
@@ -363,6 +422,11 @@ if (BUILD_GUI)
target_link_libraries(kge ${CURSES_LIBRARIES} imgui) target_link_libraries(kge ${CURSES_LIBRARIES} imgui)
endif () endif ()
# Static linking on Linux only (macOS does not support static linking of system libraries)
if (NOT APPLE AND KTE_STATIC_LINK)
target_link_options(kge PRIVATE -static)
endif ()
# On macOS, build kge as a proper .app bundle # On macOS, build kge as a proper .app bundle
if (APPLE) if (APPLE)
# Define the icon file # Define the icon file

116
CONFIG.md Normal file
View File

@@ -0,0 +1,116 @@
# kge Configuration
kge loads configuration from `~/.config/kte/kge.toml`. If no TOML file is
found, it falls back to the legacy `kge.ini` format.
## TOML Format
```toml
[window]
fullscreen = false
columns = 80
rows = 42
[font]
# Default font and size
name = "default"
size = 18.0
# Font used in code mode (monospace)
code = "default"
# Font used in writing mode (proportional)
writing = "crimsonpro"
[appearance]
theme = "nord"
# "dark" or "light" for themes with variants
background = "dark"
[editor]
syntax = true
```
## Sections
### `[window]`
| Key | Type | Default | Description |
|--------------|------|---------|---------------------------------|
| `fullscreen` | bool | false | Start in fullscreen mode |
| `columns` | int | 80 | Initial window width in columns |
| `rows` | int | 42 | Initial window height in rows |
### `[font]`
| Key | Type | Default | Description |
|-----------|--------|--------------|------------------------------------------|
| `name` | string | "default" | Default font loaded at startup |
| `size` | float | 18.0 | Font size in pixels |
| `code` | string | "default" | Font for code mode (monospace) |
| `writing` | string | "crimsonpro" | Font for writing mode (proportional) |
### `[appearance]`
| Key | Type | Default | Description |
|--------------|--------|---------|-----------------------------------------|
| `theme` | string | "nord" | Color theme |
| `background` | string | "dark" | Background mode: "dark" or "light" |
### `[editor]`
| Key | Type | Default | Description |
|----------|------|---------|------------------------------|
| `syntax` | bool | true | Enable syntax highlighting |
## Edit Modes
kge has two edit modes that control which font is used:
- **code** — Uses the monospace font (`font.code`). Default for source files.
- **writing** — Uses the proportional font (`font.writing`). Auto-detected
for `.txt`, `.md`, `.markdown`, `.rst`, `.org`, `.tex`, `.adoc`, and
`.asciidoc` files.
Toggle with `C-k m` or `: mode [code|writing]`.
## Available Fonts
### Monospace
b612, berkeley, berkeley-bold, brassmono, brassmono-bold, brassmonocode,
brassmonocode-bold, fira, go, ibm, idealist, inconsolata, inconsolataex,
iosevka, iosevkaex, sharetech, space, syne, triplicate, unispace
### Proportional (Serif)
crimsonpro, etbook, spectral
## Available Themes
amber, eink, everforest, gruvbox, kanagawa-paper, lcars, leuchtturm, nord,
old-book, orbital, plan9, solarized, tufte, weyland-yutani, zenburn
Themes with light/dark variants: eink, gruvbox, leuchtturm, old-book,
solarized. Set `background = "light"` or use `: background light`.
## Migrating from kge.ini
If you have an existing `kge.ini`, kge will still read it but prints a
notice to stderr suggesting migration. To migrate, create `kge.toml` in the
same directory (`~/.config/kte/`) using the format above. The TOML file
takes priority when both exist.
The INI keys map to TOML as follows:
| INI key | TOML equivalent |
|---------------|--------------------------|
| `fullscreen` | `window.fullscreen` |
| `columns` | `window.columns` |
| `rows` | `window.rows` |
| `font` | `font.name` |
| `font_size` | `font.size` |
| `theme` | `appearance.theme` |
| `background` | `appearance.background` |
| `syntax` | `editor.syntax` |
New keys `font.code` and `font.writing` have no INI equivalent (the INI
parser accepts `code_font` and `writing_font` if needed).

File diff suppressed because it is too large Load Diff

View File

@@ -38,6 +38,7 @@ enum class CommandId {
// Editing // Editing
InsertText, // arg: text to insert at cursor (UTF-8, no newlines) InsertText, // arg: text to insert at cursor (UTF-8, no newlines)
Newline, // insert a newline at cursor Newline, // insert a newline at cursor
SmartNewline, // insert a newline with auto-indent (Shift-Enter)
Backspace, // delete char before cursor (may join lines) Backspace, // delete char before cursor (may join lines)
DeleteChar, // delete char at cursor (may join lines) DeleteChar, // delete char at cursor (may join lines)
KillToEOL, // delete from cursor to end of line; if at EOL, delete newline KillToEOL, // delete from cursor to end of line; if at EOL, delete newline
@@ -47,6 +48,7 @@ enum class CommandId {
MoveFileStart, // move to beginning of file MoveFileStart, // move to beginning of file
MoveFileEnd, // move to end of file MoveFileEnd, // move to end of file
ToggleMark, // toggle mark at cursor ToggleMark, // toggle mark at cursor
VisualLineModeToggle, // toggle visual-line (multicursor) mode (C-k /)
JumpToMark, // jump to mark, set mark to previous cursor JumpToMark, // jump to mark, set mark to previous cursor
KillRegion, // kill region between mark and cursor (to kill ring) KillRegion, // kill region between mark and cursor (to kill ring)
CopyRegion, // copy region to kill ring (Alt-w) CopyRegion, // copy region to kill ring (Alt-w)
@@ -109,6 +111,14 @@ enum class CommandId {
SetOption, // generic ":set key=value" (v1: filetype=<lang>) SetOption, // generic ":set key=value" (v1: filetype=<lang>)
// Viewport control // Viewport control
CenterOnCursor, // center the viewport on the current cursor line (C-k k) CenterOnCursor, // center the viewport on the current cursor line (C-k k)
// GUI: open a new editor window sharing the same buffer list
NewWindow,
// GUI: font size controls
FontZoomIn,
FontZoomOut,
FontZoomReset,
// Edit mode (code/writing)
ToggleEditMode,
}; };

23
Dockerfile Normal file
View 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"]

311
Editor.cc
View File

@@ -1,6 +1,7 @@
#include <algorithm> #include <algorithm>
#include <utility> #include <cstdio>
#include <filesystem> #include <filesystem>
#include <utility>
#include "Editor.h" #include "Editor.h"
#include "syntax/HighlighterRegistry.h" #include "syntax/HighlighterRegistry.h"
@@ -8,6 +9,41 @@
#include "syntax/NullHighlighter.h" #include "syntax/NullHighlighter.h"
namespace {
static std::string
buffer_bytes_via_views(const Buffer &b)
{
const std::size_t nrows = b.Nrows();
std::string out;
for (std::size_t i = 0; i < nrows; i++) {
auto v = b.GetLineView(i);
out.append(v.data(), v.size());
}
return out;
}
static void
apply_pending_line(Editor &ed, const std::size_t line1)
{
if (line1 == 0)
return;
Buffer *b = ed.CurrentBuffer();
if (!b)
return;
const std::size_t nrows = b->Nrows();
std::size_t line = line1 > 0 ? line1 - 1 : 0; // 1-based to 0-based
if (nrows > 0) {
if (line >= nrows)
line = nrows - 1;
} else {
line = 0;
}
b->SetCursor(0, line);
}
} // namespace
Editor::Editor() Editor::Editor()
{ {
swap_ = std::make_unique<kte::SwapManager>(); swap_ = std::make_unique<kte::SwapManager>();
@@ -33,20 +69,22 @@ Editor::SetStatus(const std::string &message)
Buffer * Buffer *
Editor::CurrentBuffer() Editor::CurrentBuffer()
{ {
if (buffers_.empty() || curbuf_ >= buffers_.size()) { auto &bufs = Buffers();
if (bufs.empty() || curbuf_ >= bufs.size()) {
return nullptr; return nullptr;
} }
return &buffers_[curbuf_]; return &bufs[curbuf_];
} }
const Buffer * const Buffer *
Editor::CurrentBuffer() const Editor::CurrentBuffer() const
{ {
if (buffers_.empty() || curbuf_ >= buffers_.size()) { const auto &bufs = Buffers();
if (bufs.empty() || curbuf_ >= bufs.size()) {
return nullptr; return nullptr;
} }
return &buffers_[curbuf_]; return &bufs[curbuf_];
} }
@@ -81,8 +119,9 @@ Editor::DisplayNameFor(const Buffer &buf) const
// Prepare list of other buffer paths // Prepare list of other buffer paths
std::vector<std::vector<std::filesystem::path> > others; std::vector<std::vector<std::filesystem::path> > others;
others.reserve(buffers_.size()); const auto &bufs = Buffers();
for (const auto &b: buffers_) { others.reserve(bufs.size());
for (const auto &b: bufs) {
if (&b == &buf) if (&b == &buf)
continue; continue;
if (b.Filename().empty()) if (b.Filename().empty())
@@ -125,62 +164,64 @@ Editor::DisplayNameFor(const Buffer &buf) const
std::size_t std::size_t
Editor::AddBuffer(const Buffer &buf) Editor::AddBuffer(const Buffer &buf)
{ {
buffers_.push_back(buf); auto &bufs = Buffers();
bufs.push_back(buf);
// Attach swap recorder // Attach swap recorder
if (swap_) { if (swap_) {
buffers_.back().SetSwapRecorder(swap_.get()); swap_->Attach(&bufs.back());
swap_->Attach(&buffers_.back()); bufs.back().SetSwapRecorder(swap_->RecorderFor(&bufs.back()));
} }
if (buffers_.size() == 1) { if (bufs.size() == 1) {
curbuf_ = 0; curbuf_ = 0;
} }
return buffers_.size() - 1; return bufs.size() - 1;
} }
std::size_t std::size_t
Editor::AddBuffer(Buffer &&buf) Editor::AddBuffer(Buffer &&buf)
{ {
buffers_.push_back(std::move(buf)); auto &bufs = Buffers();
bufs.push_back(std::move(buf));
if (swap_) { if (swap_) {
buffers_.back().SetSwapRecorder(swap_.get()); swap_->Attach(&bufs.back());
swap_->Attach(&buffers_.back()); bufs.back().SetSwapRecorder(swap_->RecorderFor(&bufs.back()));
} }
if (buffers_.size() == 1) { if (bufs.size() == 1) {
curbuf_ = 0; curbuf_ = 0;
} }
return buffers_.size() - 1; return bufs.size() - 1;
} }
bool bool
Editor::OpenFile(const std::string &path, std::string &err) Editor::OpenFile(const std::string &path, std::string &err)
{ {
// If there is exactly one unnamed, empty, clean buffer, reuse it instead // If the current buffer is an unnamed, empty, clean scratch buffer, reuse
// of creating a new one. // it instead of creating a new one.
if (buffers_.size() == 1) { auto &bufs_ref = Buffers();
Buffer &cur = buffers_[curbuf_]; if (!bufs_ref.empty() && curbuf_ < bufs_ref.size()) {
Buffer &cur = bufs_ref[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)
return false; return false;
// Ensure swap recorder is attached for this buffer // Ensure swap recorder is attached for this buffer
if (swap_) { if (swap_) {
cur.SetSwapRecorder(swap_.get());
swap_->Attach(&cur); swap_->Attach(&cur);
cur.SetSwapRecorder(swap_->RecorderFor(&cur));
swap_->NotifyFilenameChanged(cur); swap_->NotifyFilenameChanged(cur);
} }
// Setup highlighting using registry (extension + shebang) // Setup highlighting using registry (extension + shebang)
cur.EnsureHighlighter(); cur.EnsureHighlighter();
std::string first = ""; std::string first = "";
const auto &rows = cur.Rows(); if (cur.Nrows() > 0)
if (!rows.empty()) first = cur.GetLineString(0);
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()) {
cur.SetFiletype(ft); cur.SetFiletype(ft);
@@ -207,20 +248,13 @@ Editor::OpenFile(const std::string &path, std::string &err)
if (!b.OpenFromFile(path, err)) { if (!b.OpenFromFile(path, err)) {
return false; return false;
} }
if (swap_) { // NOTE: swap recorder/attach must happen after the buffer is stored in its
b.SetSwapRecorder(swap_.get()); // final location (vector) because swap manager keys off Buffer*.
// path is known, notify
swap_->Attach(&b);
swap_->NotifyFilenameChanged(b);
}
// 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);
@@ -239,6 +273,9 @@ Editor::OpenFile(const std::string &path, std::string &err)
} }
// Add as a new buffer and switch to it // Add as a new buffer and switch to it
std::size_t idx = AddBuffer(std::move(b)); std::size_t idx = AddBuffer(std::move(b));
if (swap_) {
swap_->NotifyFilenameChanged(Buffers()[idx]);
}
SwitchTo(idx); SwitchTo(idx);
// Defensive: ensure any active prompt is closed after a successful open // Defensive: ensure any active prompt is closed after a successful open
CancelPrompt(); CancelPrompt();
@@ -246,15 +283,182 @@ Editor::OpenFile(const std::string &path, std::string &err)
} }
void
Editor::RequestOpenFile(const std::string &path, const std::size_t line1)
{
PendingOpen p;
p.path = path;
p.line1 = line1;
pending_open_.push_back(std::move(p));
}
bool
Editor::HasPendingOpens() const
{
return !pending_open_.empty();
}
Editor::RecoveryPromptKind
Editor::PendingRecoveryPrompt() const
{
return pending_recovery_prompt_;
}
void
Editor::CancelRecoveryPrompt()
{
pending_recovery_prompt_ = RecoveryPromptKind::None;
pending_recovery_open_ = PendingOpen{};
pending_recovery_swap_path_.clear();
pending_recovery_replay_err_.clear();
}
bool
Editor::ResolveRecoveryPrompt(const bool yes)
{
const RecoveryPromptKind kind = pending_recovery_prompt_;
if (kind == RecoveryPromptKind::None)
return false;
const PendingOpen req = pending_recovery_open_;
const std::string swp = pending_recovery_swap_path_;
const std::string rerr_s = pending_recovery_replay_err_;
CancelRecoveryPrompt();
std::string err;
if (kind == RecoveryPromptKind::RecoverOrDiscard) {
if (yes) {
if (!OpenFile(req.path, err)) {
SetStatus(err);
return false;
}
Buffer *b = CurrentBuffer();
if (!b) {
SetStatus("Recovery failed: no buffer");
return false;
}
std::string rerr;
if (!kte::SwapManager::ReplayFile(*b, swp, rerr)) {
SetStatus("Swap recovery failed: " + rerr);
return false;
}
b->SetDirty(true);
apply_pending_line(*this, req.line1);
SetStatus("Recovered " + req.path);
return true;
}
// Discard: best-effort delete swap, then open clean.
(void) std::remove(swp.c_str());
if (!OpenFile(req.path, err)) {
SetStatus(err);
return false;
}
apply_pending_line(*this, req.line1);
SetStatus("Opened " + req.path);
return true;
}
if (kind == RecoveryPromptKind::DeleteCorruptSwap) {
if (yes) {
(void) std::remove(swp.c_str());
}
if (!OpenFile(req.path, err)) {
SetStatus(err);
return false;
}
apply_pending_line(*this, req.line1);
// Include a short hint that the swap was corrupt.
if (!rerr_s.empty()) {
SetStatus("Opened " + req.path + " (swap unreadable)");
} else {
SetStatus("Opened " + req.path);
}
return true;
}
return false;
}
bool
Editor::ProcessPendingOpens()
{
if (PromptActive())
return false;
if (pending_recovery_prompt_ != RecoveryPromptKind::None)
return false;
bool opened_any = false;
while (!pending_open_.empty()) {
PendingOpen req = std::move(pending_open_.front());
pending_open_.pop_front();
if (req.path.empty())
continue;
std::string swp = kte::SwapManager::ComputeSwapPathForFilename(req.path);
bool swp_exists = false;
try {
swp_exists = !swp.empty() && std::filesystem::exists(std::filesystem::path(swp));
} catch (...) {
swp_exists = false;
}
if (swp_exists) {
Buffer tmp;
std::string oerr;
if (tmp.OpenFromFile(req.path, oerr)) {
const std::string orig = buffer_bytes_via_views(tmp);
std::string rerr;
if (kte::SwapManager::ReplayFile(tmp, swp, rerr)) {
const std::string rec = buffer_bytes_via_views(tmp);
if (rec != orig) {
pending_recovery_prompt_ = RecoveryPromptKind::RecoverOrDiscard;
pending_recovery_open_ = req;
pending_recovery_swap_path_ = swp;
StartPrompt(PromptKind::Confirm, "Recover", "");
SetStatus("Recover swap edits for " + req.path + "? (y/N, C-g cancel)");
return opened_any;
}
} else {
pending_recovery_prompt_ = RecoveryPromptKind::DeleteCorruptSwap;
pending_recovery_open_ = req;
pending_recovery_swap_path_ = swp;
pending_recovery_replay_err_ = rerr;
StartPrompt(PromptKind::Confirm, "Swap", "");
SetStatus(
"Swap file unreadable for " + req.path +
". Delete it? (y/N, C-g cancel)");
return opened_any;
}
}
}
std::string err;
if (!OpenFile(req.path, err)) {
SetStatus(err);
opened_any = false;
continue;
}
apply_pending_line(*this, req.line1);
SetStatus("Opened " + req.path);
opened_any = true;
// Open at most one per call; frontends can call us again next frame.
break;
}
return opened_any;
}
bool bool
Editor::SwitchTo(std::size_t index) Editor::SwitchTo(std::size_t index)
{ {
if (index >= buffers_.size()) { auto &bufs = Buffers();
if (index >= bufs.size()) {
return false; return false;
} }
curbuf_ = index; curbuf_ = index;
// Robustness: ensure a valid highlighter is installed when switching buffers // Robustness: ensure a valid highlighter is installed when switching buffers
Buffer &b = buffers_[curbuf_]; Buffer &b = bufs[curbuf_];
if (b.SyntaxEnabled()) { if (b.SyntaxEnabled()) {
b.EnsureHighlighter(); b.EnsureHighlighter();
if (auto *eng = b.Highlighter()) { if (auto *eng = b.Highlighter()) {
@@ -281,14 +485,22 @@ Editor::SwitchTo(std::size_t index)
bool bool
Editor::CloseBuffer(std::size_t index) Editor::CloseBuffer(std::size_t index)
{ {
if (index >= buffers_.size()) { auto &bufs = Buffers();
if (index >= bufs.size()) {
return false; return false;
} }
buffers_.erase(buffers_.begin() + static_cast<std::ptrdiff_t>(index)); if (swap_) {
if (buffers_.empty()) { // Always remove swap file when closing a buffer on normal exit.
// Swap files are for crash recovery; on clean close, we don't need them.
// This prevents stale swap files from accumulating (e.g., when used as git editor).
swap_->Detach(&bufs[index], true);
bufs[index].SetSwapRecorder(nullptr);
}
bufs.erase(bufs.begin() + static_cast<std::ptrdiff_t>(index));
if (bufs.empty()) {
curbuf_ = 0; curbuf_ = 0;
} else if (curbuf_ >= buffers_.size()) { } else if (curbuf_ >= bufs.size()) {
curbuf_ = buffers_.size() - 1; curbuf_ = bufs.size() - 1;
} }
return true; return true;
} }
@@ -312,7 +524,12 @@ Editor::Reset()
// Reset close-confirm/save state // Reset close-confirm/save state
close_confirm_pending_ = false; close_confirm_pending_ = false;
close_after_save_ = false; close_after_save_ = false;
buffers_.clear(); auto &bufs = Buffers();
if (swap_) {
for (auto &buf : bufs)
swap_->Detach(&buf, true);
}
bufs.clear();
curbuf_ = 0; curbuf_ = 0;
} }

116
Editor.h
View File

@@ -1,9 +1,47 @@
/* /*
* 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>
#include <ctime> #include <ctime>
#include <deque>
#include <string> #include <string>
#include <vector> #include <vector>
@@ -208,6 +246,18 @@ public:
} }
void SetNewWindowRequested(bool on)
{
new_window_requested_ = on;
}
[[nodiscard]] bool NewWindowRequested() const
{
return new_window_requested_;
}
void SetQuitConfirmPending(bool on) void SetQuitConfirmPending(bool on)
{ {
quit_confirm_pending_ = on; quit_confirm_pending_ = on;
@@ -471,7 +521,7 @@ public:
// Buffers // Buffers
[[nodiscard]] std::size_t BufferCount() const [[nodiscard]] std::size_t BufferCount() const
{ {
return buffers_.size(); return Buffers().size();
} }
@@ -481,6 +531,19 @@ public:
} }
// Clamp curbuf_ to valid range. Call when the shared buffer list may
// have been modified by another editor (e.g., buffer closed in another window).
void ValidateBufferIndex()
{
const auto &bufs = Buffers();
if (bufs.empty()) {
curbuf_ = 0;
} else if (curbuf_ >= bufs.size()) {
curbuf_ = bufs.size() - 1;
}
}
Buffer *CurrentBuffer(); Buffer *CurrentBuffer();
const Buffer *CurrentBuffer() const; const Buffer *CurrentBuffer() const;
@@ -497,6 +560,30 @@ public:
bool OpenFile(const std::string &path, std::string &err); bool OpenFile(const std::string &path, std::string &err);
// Request that a file be opened. The request is processed by calling
// ProcessPendingOpens() (typically once per frontend frame).
void RequestOpenFile(const std::string &path, std::size_t line1 = 0);
// If no modal prompt is active, process queued open requests.
// Returns true if a file was opened during this call.
bool ProcessPendingOpens();
[[nodiscard]] bool HasPendingOpens() const;
// Swap recovery confirmation state. When non-None, a `PromptKind::Confirm`
// prompt is active and the user's answer should be routed to ResolveRecoveryPrompt().
enum class RecoveryPromptKind {
None = 0,
RecoverOrDiscard, // y = recover swap, else discard swap and open clean
DeleteCorruptSwap // y = delete corrupt swap, else keep it
};
[[nodiscard]] RecoveryPromptKind PendingRecoveryPrompt() const;
bool ResolveRecoveryPrompt(bool yes);
void CancelRecoveryPrompt();
// Buffer switching/closing // Buffer switching/closing
bool SwitchTo(std::size_t index); bool SwitchTo(std::size_t index);
@@ -508,13 +595,22 @@ public:
// Direct access when needed (try to prefer methods above) // Direct access when needed (try to prefer methods above)
[[nodiscard]] const std::vector<Buffer> &Buffers() const [[nodiscard]] const std::vector<Buffer> &Buffers() const
{ {
return buffers_; return shared_buffers_ ? *shared_buffers_ : buffers_;
} }
std::vector<Buffer> &Buffers() std::vector<Buffer> &Buffers()
{ {
return buffers_; return shared_buffers_ ? *shared_buffers_ : buffers_;
}
// Share another editor's buffer list. When set, this editor operates on
// the provided vector instead of its own. Pass nullptr to detach.
void SetSharedBuffers(std::vector<Buffer> *shared)
{
shared_buffers_ = shared;
curbuf_ = 0;
} }
@@ -550,6 +646,11 @@ public:
} }
private: private:
struct PendingOpen {
std::string path;
std::size_t line1{0}; // 1-based; 0 = none
};
std::size_t rows_ = 0, cols_ = 0; std::size_t rows_ = 0, cols_ = 0;
int mode_ = 0; int mode_ = 0;
int kill_ = 0; // KILL CHAIN int kill_ = 0; // KILL CHAIN
@@ -561,6 +662,7 @@ private:
bool repeatable_ = false; // whether the next command is repeatable bool repeatable_ = false; // whether the next command is repeatable
std::vector<Buffer> buffers_; std::vector<Buffer> buffers_;
std::vector<Buffer> *shared_buffers_ = nullptr; // if set, use this instead of buffers_
std::size_t curbuf_ = 0; // index into buffers_ std::size_t curbuf_ = 0; // index into buffers_
// Swap journaling manager (lifetime = editor) // Swap journaling manager (lifetime = editor)
@@ -572,6 +674,7 @@ private:
// Quit state // Quit state
bool quit_requested_ = false; bool quit_requested_ = false;
bool new_window_requested_ = false;
bool quit_confirm_pending_ = false; bool quit_confirm_pending_ = false;
bool close_confirm_pending_ = false; // awaiting y/N to save-before-close bool close_confirm_pending_ = false; // awaiting y/N to save-before-close
bool close_after_save_ = false; // if true, close buffer after successful Save/SaveAs bool close_after_save_ = false; // if true, close buffer after successful Save/SaveAs
@@ -593,6 +696,13 @@ private:
std::string prompt_text_; std::string prompt_text_;
std::string pending_overwrite_path_; std::string pending_overwrite_path_;
// Deferred open + swap recovery prompt state
std::deque<PendingOpen> pending_open_;
RecoveryPromptKind pending_recovery_prompt_ = RecoveryPromptKind::None;
PendingOpen pending_recovery_open_{};
std::string pending_recovery_swap_path_;
std::string pending_recovery_replay_err_;
// GUI-only state (safe no-op in terminal builds) // GUI-only state (safe no-op in terminal builds)
bool file_picker_visible_ = false; bool file_picker_visible_ = false;
std::string file_picker_dir_; std::string file_picker_dir_;

313
ErrorHandler.cc Normal file
View File

@@ -0,0 +1,313 @@
#include "ErrorHandler.h"
#include <chrono>
#include <ctime>
#include <iomanip>
#include <sstream>
#include <filesystem>
#include <cstdlib>
namespace fs = std::filesystem;
namespace kte {
ErrorHandler::ErrorHandler()
{
// Determine log file path: ~/.local/state/kte/error.log
const char *home = std::getenv("HOME");
if (home) {
fs::path log_dir = fs::path(home) / ".local" / "state" / "kte";
try {
if (!fs::exists(log_dir)) {
fs::create_directories(log_dir);
}
log_file_path_ = (log_dir / "error.log").string();
// Create the log file immediately so it exists in the state directory
ensure_log_file();
} catch (...) {
// If we can't create the directory, disable file logging
file_logging_enabled_ = false;
}
} else {
// No HOME, disable file logging
file_logging_enabled_ = false;
}
}
ErrorHandler::~ErrorHandler()
{
std::lock_guard<std::mutex> lg(mtx_);
if (log_file_ && log_file_->is_open()) {
log_file_->flush();
log_file_->close();
}
}
ErrorHandler &
ErrorHandler::Instance()
{
static ErrorHandler instance;
return instance;
}
void
ErrorHandler::Report(ErrorSeverity severity, const std::string &component,
const std::string &message, const std::string &context)
{
ErrorRecord record;
record.timestamp_ns = now_ns();
record.severity = severity;
record.component = component;
record.message = message;
record.context = context;
{
std::lock_guard<std::mutex> lg(mtx_);
// Add to in-memory queue
errors_.push_back(record);
while (errors_.size() > 100) {
errors_.pop_front();
}
++total_error_count_;
if (severity == ErrorSeverity::Critical) {
++critical_error_count_;
}
// Write to log file if enabled
if (file_logging_enabled_) {
write_to_log(record);
}
}
}
void
ErrorHandler::Info(const std::string &component, const std::string &message,
const std::string &context)
{
Report(ErrorSeverity::Info, component, message, context);
}
void
ErrorHandler::Warning(const std::string &component, const std::string &message,
const std::string &context)
{
Report(ErrorSeverity::Warning, component, message, context);
}
void
ErrorHandler::Error(const std::string &component, const std::string &message,
const std::string &context)
{
Report(ErrorSeverity::Error, component, message, context);
}
void
ErrorHandler::Critical(const std::string &component, const std::string &message,
const std::string &context)
{
Report(ErrorSeverity::Critical, component, message, context);
}
bool
ErrorHandler::HasErrors() const
{
std::lock_guard<std::mutex> lg(mtx_);
return !errors_.empty();
}
bool
ErrorHandler::HasCriticalErrors() const
{
std::lock_guard<std::mutex> lg(mtx_);
return critical_error_count_ > 0;
}
std::string
ErrorHandler::GetLastError() const
{
std::lock_guard<std::mutex> lg(mtx_);
if (errors_.empty())
return "";
const ErrorRecord &e = errors_.back();
std::string result = "[" + severity_to_string(e.severity) + "] ";
result += e.component;
if (!e.context.empty()) {
result += " (" + e.context + ")";
}
result += ": " + e.message;
return result;
}
std::size_t
ErrorHandler::GetErrorCount() const
{
std::lock_guard<std::mutex> lg(mtx_);
return total_error_count_;
}
std::size_t
ErrorHandler::GetErrorCount(ErrorSeverity severity) const
{
std::lock_guard<std::mutex> lg(mtx_);
std::size_t count = 0;
for (const auto &e: errors_) {
if (e.severity == severity) {
++count;
}
}
return count;
}
std::vector<ErrorHandler::ErrorRecord>
ErrorHandler::GetRecentErrors(std::size_t max_count) const
{
std::lock_guard<std::mutex> lg(mtx_);
std::vector<ErrorRecord> result;
result.reserve(std::min(max_count, errors_.size()));
// Return most recent first
auto it = errors_.rbegin();
for (std::size_t i = 0; i < max_count && it != errors_.rend(); ++i, ++it) {
result.push_back(*it);
}
return result;
}
void
ErrorHandler::ClearErrors()
{
std::lock_guard<std::mutex> lg(mtx_);
errors_.clear();
total_error_count_ = 0;
critical_error_count_ = 0;
}
void
ErrorHandler::SetFileLoggingEnabled(bool enabled)
{
std::lock_guard<std::mutex> lg(mtx_);
file_logging_enabled_ = enabled;
if (!enabled && log_file_ && log_file_->is_open()) {
log_file_->flush();
log_file_->close();
log_file_.reset();
}
}
std::string
ErrorHandler::GetLogFilePath() const
{
std::lock_guard<std::mutex> lg(mtx_);
return log_file_path_;
}
void
ErrorHandler::write_to_log(const ErrorRecord &record)
{
// Must be called with mtx_ held
if (log_file_path_.empty())
return;
ensure_log_file();
if (!log_file_ || !log_file_->is_open())
return;
// Format: [timestamp] [SEVERITY] component (context): message
std::string timestamp = format_timestamp(record.timestamp_ns);
std::string severity = severity_to_string(record.severity);
*log_file_ << "[" << timestamp << "] [" << severity << "] " << record.component;
if (!record.context.empty()) {
*log_file_ << " (" << record.context << ")";
}
*log_file_ << ": " << record.message << "\n";
log_file_->flush();
}
void
ErrorHandler::ensure_log_file()
{
// Must be called with mtx_ held
if (log_file_ && log_file_->is_open())
return;
if (log_file_path_.empty())
return;
try {
log_file_ = std::make_unique<std::ofstream>(log_file_path_,
std::ios::app | std::ios::out);
if (!log_file_->is_open()) {
log_file_.reset();
}
} catch (...) {
log_file_.reset();
}
}
std::string
ErrorHandler::format_timestamp(std::uint64_t timestamp_ns) const
{
// Convert nanoseconds to time_t (seconds)
std::time_t seconds = static_cast<std::time_t>(timestamp_ns / 1000000000ULL);
std::uint64_t nanos = timestamp_ns % 1000000000ULL;
std::tm tm_buf{};
#if defined(_WIN32)
localtime_s(&tm_buf, &seconds);
#else
localtime_r(&seconds, &tm_buf);
#endif
std::ostringstream oss;
oss << std::put_time(&tm_buf, "%Y-%m-%d %H:%M:%S");
oss << "." << std::setfill('0') << std::setw(3) << (nanos / 1000000ULL);
return oss.str();
}
std::string
ErrorHandler::severity_to_string(ErrorSeverity severity) const
{
switch (severity) {
case ErrorSeverity::Info:
return "INFO";
case ErrorSeverity::Warning:
return "WARNING";
case ErrorSeverity::Error:
return "ERROR";
case ErrorSeverity::Critical:
return "CRITICAL";
default:
return "UNKNOWN";
}
}
std::uint64_t
ErrorHandler::now_ns()
{
using namespace std::chrono;
return duration_cast<nanoseconds>(system_clock::now().time_since_epoch()).count();
}
} // namespace kte

106
ErrorHandler.h Normal file
View File

@@ -0,0 +1,106 @@
// ErrorHandler.h - Centralized error handling and logging for kte
#pragma once
#include <string>
#include <vector>
#include <deque>
#include <mutex>
#include <cstdint>
#include <memory>
#include <fstream>
namespace kte {
enum class ErrorSeverity {
Info, // Informational messages
Warning, // Non-critical issues
Error, // Errors that affect functionality but allow continuation
Critical // Critical errors that may cause data loss or crashes
};
// Centralized error handler with logging and in-memory error tracking
class ErrorHandler {
public:
struct ErrorRecord {
std::uint64_t timestamp_ns{0};
ErrorSeverity severity{ErrorSeverity::Error};
std::string component; // e.g., "SwapManager", "Buffer", "main"
std::string message;
std::string context; // e.g., filename, buffer name, operation
};
// Get the global ErrorHandler instance
static ErrorHandler &Instance();
// Report an error with severity, component, message, and optional context
void Report(ErrorSeverity severity, const std::string &component,
const std::string &message, const std::string &context = "");
// Convenience methods for common severity levels
void Info(const std::string &component, const std::string &message,
const std::string &context = "");
void Warning(const std::string &component, const std::string &message,
const std::string &context = "");
void Error(const std::string &component, const std::string &message,
const std::string &context = "");
void Critical(const std::string &component, const std::string &message,
const std::string &context = "");
// Query error state (thread-safe)
bool HasErrors() const;
bool HasCriticalErrors() const;
std::string GetLastError() const;
std::size_t GetErrorCount() const;
std::size_t GetErrorCount(ErrorSeverity severity) const;
// Get recent errors (up to max_count, most recent first)
std::vector<ErrorRecord> GetRecentErrors(std::size_t max_count = 10) const;
// Clear in-memory error history (does not affect log file)
void ClearErrors();
// Enable/disable file logging (enabled by default)
void SetFileLoggingEnabled(bool enabled);
// Get the path to the error log file
std::string GetLogFilePath() const;
private:
ErrorHandler();
~ErrorHandler();
// Non-copyable, non-movable
ErrorHandler(const ErrorHandler &) = delete;
ErrorHandler &operator=(const ErrorHandler &) = delete;
ErrorHandler(ErrorHandler &&) = delete;
ErrorHandler &operator=(ErrorHandler &&) = delete;
void write_to_log(const ErrorRecord &record);
void ensure_log_file();
std::string format_timestamp(std::uint64_t timestamp_ns) const;
std::string severity_to_string(ErrorSeverity severity) const;
static std::uint64_t now_ns();
mutable std::mutex mtx_;
std::deque<ErrorRecord> errors_; // bounded to max 100 entries
std::size_t total_error_count_{0};
std::size_t critical_error_count_{0};
bool file_logging_enabled_{true};
std::string log_file_path_;
std::unique_ptr<std::ofstream> log_file_;
};
} // namespace kte

157
ErrorRecovery.cc Normal file
View File

@@ -0,0 +1,157 @@
// ErrorRecovery.cc - Error recovery mechanisms implementation
#include "ErrorRecovery.h"
#include <mutex>
namespace kte {
CircuitBreaker::CircuitBreaker(const Config &cfg)
: config_(cfg), state_(State::Closed), failure_count_(0), success_count_(0),
last_failure_time_(std::chrono::steady_clock::time_point::min()),
state_change_time_(std::chrono::steady_clock::now()) {}
bool
CircuitBreaker::AllowRequest()
{
std::lock_guard<std::mutex> lg(mtx_);
const auto now = std::chrono::steady_clock::now();
switch (state_) {
case State::Closed:
// Normal operation, allow all requests
return true;
case State::Open: {
// Check if timeout has elapsed to transition to HalfOpen
const auto elapsed = std::chrono::duration_cast<std::chrono::seconds>(
now - state_change_time_
);
if (elapsed >= config_.open_timeout) {
TransitionTo(State::HalfOpen);
return true; // Allow one request to test recovery
}
return false; // Circuit is open, reject request
}
case State::HalfOpen:
// Allow limited requests to test recovery
return true;
}
return false;
}
void
CircuitBreaker::RecordSuccess()
{
std::lock_guard<std::mutex> lg(mtx_);
switch (state_) {
case State::Closed:
// Reset failure count on success in normal operation
failure_count_ = 0;
break;
case State::HalfOpen:
++success_count_;
if (success_count_ >= config_.success_threshold) {
// Enough successes, close the circuit
TransitionTo(State::Closed);
}
break;
case State::Open:
// Shouldn't happen (requests rejected), but handle gracefully
break;
}
}
void
CircuitBreaker::RecordFailure()
{
std::lock_guard<std::mutex> lg(mtx_);
const auto now = std::chrono::steady_clock::now();
last_failure_time_ = now;
switch (state_) {
case State::Closed:
// Check if we need to reset the failure count (window expired)
if (IsWindowExpired()) {
failure_count_ = 0;
}
++failure_count_;
if (failure_count_ >= config_.failure_threshold) {
// Too many failures, open the circuit
TransitionTo(State::Open);
}
break;
case State::HalfOpen:
// Failure during recovery test, reopen the circuit
TransitionTo(State::Open);
break;
case State::Open:
// Already open, just track the failure
++failure_count_;
break;
}
}
void
CircuitBreaker::Reset()
{
std::lock_guard<std::mutex> lg(mtx_);
TransitionTo(State::Closed);
}
void
CircuitBreaker::TransitionTo(State new_state)
{
if (state_ == new_state) {
return;
}
state_ = new_state;
state_change_time_ = std::chrono::steady_clock::now();
switch (new_state) {
case State::Closed:
failure_count_ = 0;
success_count_ = 0;
break;
case State::Open:
success_count_ = 0;
// Keep failure_count_ for diagnostics
break;
case State::HalfOpen:
success_count_ = 0;
// Keep failure_count_ for diagnostics
break;
}
}
bool
CircuitBreaker::IsWindowExpired() const
{
if (failure_count_ == 0) {
return false;
}
const auto now = std::chrono::steady_clock::now();
const auto elapsed = std::chrono::duration_cast<std::chrono::seconds>(
now - last_failure_time_
);
return elapsed >= config_.window;
}
} // namespace kte

170
ErrorRecovery.h Normal file
View File

@@ -0,0 +1,170 @@
// ErrorRecovery.h - Error recovery mechanisms for kte
#pragma once
#include <chrono>
#include <cstddef>
#include <functional>
#include <string>
#include <thread>
#include <mutex>
#include <cerrno>
namespace kte {
// Classify errno values as transient (retryable) or permanent
inline bool
IsTransientError(int err)
{
switch (err) {
case EAGAIN:
#if EAGAIN != EWOULDBLOCK
case EWOULDBLOCK:
#endif
case EBUSY:
case EIO: // I/O error (may be transient on network filesystems)
case ETIMEDOUT:
case ENOSPC: // Disk full (may become available)
case EDQUOT: // Quota exceeded (may become available)
return true;
default:
return false;
}
}
// RetryPolicy defines retry behavior for transient failures
struct RetryPolicy {
std::size_t max_attempts{3}; // Maximum retry attempts
std::chrono::milliseconds initial_delay{100}; // Initial delay before first retry
double backoff_multiplier{2.0}; // Exponential backoff multiplier
std::chrono::milliseconds max_delay{5000}; // Maximum delay between retries
// Default policy: 3 attempts, 100ms initial, 2x backoff, 5s max
static RetryPolicy Default()
{
return RetryPolicy{};
}
// Aggressive policy for critical operations: more attempts, faster retries
static RetryPolicy Aggressive()
{
return RetryPolicy{5, std::chrono::milliseconds(50), 1.5, std::chrono::milliseconds(2000)};
}
// Conservative policy for non-critical operations: fewer attempts, slower retries
static RetryPolicy Conservative()
{
return RetryPolicy{2, std::chrono::milliseconds(200), 2.5, std::chrono::milliseconds(10000)};
}
};
// Retry a function with exponential backoff for transient errors
// Returns true on success, false on permanent failure or exhausted retries
// The function `fn` should return true on success, false on failure, and set errno on failure
template<typename Func>
bool
RetryOnTransientError(Func fn, const RetryPolicy &policy, std::string &err)
{
std::size_t attempt = 0;
std::chrono::milliseconds delay = policy.initial_delay;
while (attempt < policy.max_attempts) {
++attempt;
errno = 0;
if (fn()) {
return true; // Success
}
int saved_errno = errno;
if (!IsTransientError(saved_errno)) {
// Permanent error, don't retry
return false;
}
if (attempt >= policy.max_attempts) {
// Exhausted retries
err += " (exhausted " + std::to_string(policy.max_attempts) + " retry attempts)";
return false;
}
// Sleep before retry
std::this_thread::sleep_for(delay);
// Exponential backoff
delay = std::chrono::milliseconds(
static_cast<long long>(delay.count() * policy.backoff_multiplier)
);
if (delay > policy.max_delay) {
delay = policy.max_delay;
}
}
return false;
}
// CircuitBreaker prevents repeated attempts to failing operations
// States: Closed (normal), Open (failing, reject immediately), HalfOpen (testing recovery)
class CircuitBreaker {
public:
enum class State {
Closed, // Normal operation, allow all requests
Open, // Failing, reject requests immediately
HalfOpen // Testing recovery, allow limited requests
};
struct Config {
std::size_t failure_threshold; // Failures before opening circuit
std::chrono::seconds open_timeout; // Time before attempting recovery (Open → HalfOpen)
std::size_t success_threshold; // Successes in HalfOpen before closing
std::chrono::seconds window; // Time window for counting failures
Config()
: failure_threshold(5), open_timeout(30), success_threshold(2), window(60) {}
};
explicit CircuitBreaker(const Config &cfg = Config());
// Check if operation is allowed (returns false if circuit is Open)
bool AllowRequest();
// Record successful operation
void RecordSuccess();
// Record failed operation
void RecordFailure();
// Get current state
State GetState() const
{
return state_;
}
// Get failure count in current window
std::size_t GetFailureCount() const
{
return failure_count_;
}
// Reset circuit to Closed state (for testing or manual intervention)
void Reset();
private:
void TransitionTo(State new_state);
bool IsWindowExpired() const;
Config config_;
State state_;
std::size_t failure_count_;
std::size_t success_count_;
std::chrono::steady_clock::time_point last_failure_time_;
std::chrono::steady_clock::time_point state_change_time_;
mutable std::mutex mtx_;
};
} // namespace kte

View File

@@ -12,7 +12,7 @@ public:
virtual ~Frontend() = default; virtual ~Frontend() = default;
// Initialize the frontend (create window/terminal, etc.) // Initialize the frontend (create window/terminal, etc.)
virtual bool Init(Editor &ed) = 0; virtual bool Init(int &argc, char **argv, Editor &ed) = 0;
// Execute one iteration (poll input, dispatch, draw). Set running=false to exit. // Execute one iteration (poll input, dispatch, draw). Set running=false to exit.
virtual void Step(Editor &ed, bool &running) = 0; virtual void Step(Editor &ed, bool &running) = 0;

View File

@@ -3,9 +3,29 @@
#include <fstream> #include <fstream>
#include <sstream> #include <sstream>
#include <algorithm> #include <algorithm>
#include <filesystem>
#include <iostream>
#include "GUIConfig.h" #include "GUIConfig.h"
// toml++ for TOML config parsing
#if defined(__clang__)
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Weverything"
#elif defined(__GNUC__)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wall"
# pragma GCC diagnostic ignored "-Wextra"
#endif
#include "ext/tomlplusplus/toml.hpp"
#if defined(__clang__)
# pragma clang diagnostic pop
#elif defined(__GNUC__)
# pragma GCC diagnostic pop
#endif
static void static void
trim(std::string &s) trim(std::string &s)
@@ -19,32 +39,104 @@ trim(std::string &s)
static std::string static std::string
default_config_path() config_dir()
{ {
const char *home = std::getenv("HOME"); const char *home = std::getenv("HOME");
if (!home || !*home) if (!home || !*home)
return {}; return {};
std::string path(home); return std::string(home) + "/.config/kte";
path += "/.config/kte/kge.ini";
return path;
} }
GUIConfig GUIConfig
GUIConfig::Load() GUIConfig::Load()
{ {
GUIConfig cfg; // defaults already set GUIConfig cfg;
const std::string path = default_config_path(); std::string dir = config_dir();
if (dir.empty())
return cfg;
if (!path.empty()) { // Try TOML first
cfg.LoadFromFile(path); std::string toml_path = dir + "/kge.toml";
if (cfg.LoadFromTOML(toml_path))
return cfg;
// Fall back to legacy INI
std::string ini_path = dir + "/kge.ini";
if (cfg.LoadFromINI(ini_path)) {
std::cerr << "kge: loaded legacy kge.ini; consider migrating to kge.toml\n";
return cfg;
} }
return cfg; return cfg;
} }
bool bool
GUIConfig::LoadFromFile(const std::string &path) GUIConfig::LoadFromTOML(const std::string &path)
{
if (!std::filesystem::exists(path))
return false;
toml::table tbl;
try {
tbl = toml::parse_file(path);
} catch (const toml::parse_error &err) {
std::cerr << "kge: TOML parse error in " << path << ": " << err.what() << "\n";
return false;
}
// [window]
if (auto win = tbl["window"].as_table()) {
if (auto v = (*win)["fullscreen"].value<bool>())
fullscreen = *v;
if (auto v = (*win)["columns"].value<int64_t>()) {
if (*v > 0) columns = static_cast<int>(*v);
}
if (auto v = (*win)["rows"].value<int64_t>()) {
if (*v > 0) rows = static_cast<int>(*v);
}
}
// [font]
if (auto sec = tbl["font"].as_table()) {
if (auto v = (*sec)["name"].value<std::string>())
font = *v;
if (auto v = (*sec)["size"].value<double>()) {
if (*v > 0.0) font_size = static_cast<float>(*v);
}
if (auto v = (*sec)["code"].value<std::string>())
code_font = *v;
if (auto v = (*sec)["writing"].value<std::string>())
writing_font = *v;
}
// [appearance]
if (auto sec = tbl["appearance"].as_table()) {
if (auto v = (*sec)["theme"].value<std::string>())
theme = *v;
if (auto v = (*sec)["background"].value<std::string>()) {
std::string bg = *v;
std::transform(bg.begin(), bg.end(), bg.begin(), [](unsigned char c) {
return (char) std::tolower(c);
});
if (bg == "light" || bg == "dark")
background = bg;
}
}
// [editor]
if (auto sec = tbl["editor"].as_table()) {
if (auto v = (*sec)["syntax"].value<bool>())
syntax = *v;
}
return true;
}
bool
GUIConfig::LoadFromINI(const std::string &path)
{ {
std::ifstream in(path); std::ifstream in(path);
if (!in.good()) if (!in.good())
@@ -104,6 +196,10 @@ GUIConfig::LoadFromFile(const std::string &path)
} }
} else if (key == "font") { } else if (key == "font") {
font = val; font = val;
} else if (key == "code_font") {
code_font = val;
} else if (key == "writing_font") {
writing_font = val;
} else if (key == "theme") { } else if (key == "theme") {
theme = val; theme = val;
} else if (key == "background" || key == "bg") { } else if (key == "background" || key == "bg") {

View File

@@ -1,5 +1,7 @@
/* /*
* GUIConfig - loads simple GUI configuration from $HOME/.config/kte/kge.ini * GUIConfig - loads GUI configuration from $HOME/.config/kte/kge.toml
*
* Falls back to legacy kge.ini if no TOML config is found.
*/ */
#pragma once #pragma once
@@ -22,12 +24,18 @@ public:
std::string background = "dark"; std::string background = "dark";
// Default syntax highlighting state for GUI (kge): on/off // Default syntax highlighting state for GUI (kge): on/off
// Accepts: on/off/true/false/yes/no/1/0 in the ini file. bool syntax = true;
bool syntax = true; // default: enabled
// Load from default path: $HOME/.config/kte/kge.ini // Per-mode font defaults
std::string code_font = "default";
std::string writing_font = "crimsonpro";
// Load from default paths: try kge.toml first, fall back to kge.ini
static GUIConfig Load(); static GUIConfig Load();
// Load from explicit path. Returns true if file existed and was parsed. // Load from explicit TOML path. Returns true if file existed and was parsed.
bool LoadFromFile(const std::string &path); bool LoadFromTOML(const std::string &path);
// Load from explicit INI path (legacy). Returns true if file existed and was parsed.
bool LoadFromINI(const std::string &path);
}; };

View File

@@ -312,7 +312,7 @@ namespace kte {
enum class BackgroundMode { Light, Dark }; enum class BackgroundMode { Light, Dark };
// Global background mode; default to Dark to match prior defaults // Global background mode; default to Dark to match prior defaults
static inline auto gBackgroundMode = BackgroundMode::Dark; inline auto gBackgroundMode = BackgroundMode::Dark;
// Basic theme identifier (kept minimal; some ids are aliases) // Basic theme identifier (kept minimal; some ids are aliases)
enum class ThemeId { enum class ThemeId {
@@ -330,11 +330,13 @@ enum class ThemeId {
Amber = 10, Amber = 10,
WeylandYutani = 11, WeylandYutani = 11,
Orbital = 12, Orbital = 12,
Tufte = 13,
Leuchtturm = 14,
}; };
// Current theme tracking // Current theme tracking
static inline auto gCurrentTheme = ThemeId::Nord; inline auto gCurrentTheme = ThemeId::Nord;
static inline std::size_t gCurrentThemeIndex = 6; // Nord index inline std::size_t gCurrentThemeIndex = 7; // Nord index
// Forward declarations for helpers used below // Forward declarations for helpers used below
static size_t ThemeIndexFromId(ThemeId id); static size_t ThemeIndexFromId(ThemeId id);
@@ -372,11 +374,13 @@ BackgroundModeName()
#include "themes/Everforest.h" #include "themes/Everforest.h"
#include "themes/KanagawaPaper.h" #include "themes/KanagawaPaper.h"
#include "themes/LCARS.h" #include "themes/LCARS.h"
#include "themes/Leuchtturm.h"
#include "themes/OldBook.h" #include "themes/OldBook.h"
#include "themes/Amber.h" #include "themes/Amber.h"
#include "themes/WeylandYutani.h" #include "themes/WeylandYutani.h"
#include "themes/Zenburn.h" #include "themes/Zenburn.h"
#include "themes/Orbital.h" #include "themes/Orbital.h"
#include "themes/Tufte.h"
// Theme abstraction and registry (generalized theme system) // Theme abstraction and registry (generalized theme system)
@@ -409,6 +413,28 @@ struct LCARSTheme final : Theme {
} }
}; };
struct LeuchtturmTheme final : Theme {
[[nodiscard]] const char *Name() const override
{
return "leuchtturm";
}
void Apply() const override
{
if (gBackgroundMode == BackgroundMode::Dark)
ApplyLeuchtturmDarkTheme();
else
ApplyLeuchtturmLightTheme();
}
ThemeId Id() override
{
return ThemeId::Leuchtturm;
}
};
struct EverforestTheme final : Theme { struct EverforestTheme final : Theme {
[[nodiscard]] const char *Name() const override [[nodiscard]] const char *Name() const override
{ {
@@ -488,6 +514,28 @@ struct OrbitalTheme final : Theme {
} }
}; };
struct TufteTheme final : Theme {
[[nodiscard]] const char *Name() const override
{
return "tufte";
}
void Apply() const override
{
if (gBackgroundMode == BackgroundMode::Dark)
ApplyTufteDarkTheme();
else
ApplyTufteLightTheme();
}
ThemeId Id() override
{
return ThemeId::Tufte;
}
};
struct ZenburnTheme final : Theme { struct ZenburnTheme final : Theme {
[[nodiscard]] const char *Name() const override [[nodiscard]] const char *Name() const override
{ {
@@ -657,18 +705,20 @@ ThemeRegistry()
static std::vector<std::unique_ptr<Theme> > reg; static std::vector<std::unique_ptr<Theme> > reg;
if (reg.empty()) { if (reg.empty()) {
// Alphabetical by canonical name: // Alphabetical by canonical name:
// amber, eink, everforest, gruvbox, kanagawa-paper, lcars, nord, old-book, orbital, plan9, solarized, weyland-yutani, zenburn // amber, eink, everforest, gruvbox, kanagawa-paper, lcars, leuchtturm, nord, old-book, orbital, plan9, solarized, tufte, weyland-yutani, zenburn
reg.emplace_back(std::make_unique<detail::AmberTheme>()); reg.emplace_back(std::make_unique<detail::AmberTheme>());
reg.emplace_back(std::make_unique<detail::EInkTheme>()); reg.emplace_back(std::make_unique<detail::EInkTheme>());
reg.emplace_back(std::make_unique<detail::EverforestTheme>()); reg.emplace_back(std::make_unique<detail::EverforestTheme>());
reg.emplace_back(std::make_unique<detail::GruvboxTheme>()); reg.emplace_back(std::make_unique<detail::GruvboxTheme>());
reg.emplace_back(std::make_unique<detail::KanagawaPaperTheme>()); reg.emplace_back(std::make_unique<detail::KanagawaPaperTheme>());
reg.emplace_back(std::make_unique<detail::LCARSTheme>()); reg.emplace_back(std::make_unique<detail::LCARSTheme>());
reg.emplace_back(std::make_unique<detail::LeuchtturmTheme>());
reg.emplace_back(std::make_unique<detail::NordTheme>()); reg.emplace_back(std::make_unique<detail::NordTheme>());
reg.emplace_back(std::make_unique<detail::OldBookTheme>()); reg.emplace_back(std::make_unique<detail::OldBookTheme>());
reg.emplace_back(std::make_unique<detail::OrbitalTheme>()); reg.emplace_back(std::make_unique<detail::OrbitalTheme>());
reg.emplace_back(std::make_unique<detail::Plan9Theme>()); reg.emplace_back(std::make_unique<detail::Plan9Theme>());
reg.emplace_back(std::make_unique<detail::SolarizedTheme>()); reg.emplace_back(std::make_unique<detail::SolarizedTheme>());
reg.emplace_back(std::make_unique<detail::TufteTheme>());
reg.emplace_back(std::make_unique<detail::WeylandYutaniTheme>()); reg.emplace_back(std::make_unique<detail::WeylandYutaniTheme>());
reg.emplace_back(std::make_unique<detail::ZenburnTheme>()); reg.emplace_back(std::make_unique<detail::ZenburnTheme>());
} }
@@ -845,20 +895,24 @@ ThemeIndexFromId(const ThemeId id)
return 4; return 4;
case ThemeId::LCARS: case ThemeId::LCARS:
return 5; return 5;
case ThemeId::Nord: case ThemeId::Leuchtturm:
return 6; return 6;
case ThemeId::OldBook: case ThemeId::Nord:
return 7; return 7;
case ThemeId::Orbital: case ThemeId::OldBook:
return 8; return 8;
case ThemeId::Plan9: case ThemeId::Orbital:
return 9; return 9;
case ThemeId::Solarized: case ThemeId::Plan9:
return 10; return 10;
case ThemeId::WeylandYutani: case ThemeId::Solarized:
return 11; return 11;
case ThemeId::Zenburn: case ThemeId::Tufte:
return 12; return 12;
case ThemeId::WeylandYutani:
return 13;
case ThemeId::Zenburn:
return 14;
} }
return 0; return 0;
} }
@@ -882,30 +936,144 @@ ThemeIdFromIndex(const size_t idx)
case 5: case 5:
return ThemeId::LCARS; return ThemeId::LCARS;
case 6: case 6:
return ThemeId::Nord; return ThemeId::Leuchtturm;
case 7: case 7:
return ThemeId::OldBook; return ThemeId::Nord;
case 8: case 8:
return ThemeId::Orbital; return ThemeId::OldBook;
case 9: case 9:
return ThemeId::Plan9; return ThemeId::Orbital;
case 10: case 10:
return ThemeId::Solarized; return ThemeId::Plan9;
case 11: case 11:
return ThemeId::WeylandYutani; return ThemeId::Solarized;
case 12: case 12:
return ThemeId::Tufte;
case 13:
return ThemeId::WeylandYutani;
case 14:
return ThemeId::Zenburn; return ThemeId::Zenburn;
} }
} }
// --- Syntax palette (v1): map TokenKind to ink color per current theme/background --- // --- Syntax palette (v1): map TokenKind to ink color per current theme/background ---
// Tufte palette: high-contrast, restrained color. Body text is true black on
// cream; only keywords and links get subtle color to avoid a "christmas tree."
static ImVec4
SyntaxInkTufte(const TokenKind k, const bool dark)
{
const ImVec4 ink = dark ? RGBA(0xEAE6DE) : RGBA(0x111111); // body text
const ImVec4 dim = dark ? RGBA(0x8A8680) : RGBA(0x555555); // comments
const ImVec4 red = dark ? RGBA(0xD06060) : RGBA(0x8B0000); // keywords/preproc
const ImVec4 navy = dark ? RGBA(0x7098C0) : RGBA(0x1A3A5C); // functions/links
const ImVec4 grn = dark ? RGBA(0x8AAA6E) : RGBA(0x2E5E2E); // strings
switch (k) {
case TokenKind::Keyword:
case TokenKind::Preproc:
return red;
case TokenKind::String:
case TokenKind::Char:
return grn;
case TokenKind::Comment:
return dim;
case TokenKind::Function:
return navy;
case TokenKind::Number:
case TokenKind::Constant:
return dark ? RGBA(0xC8A85A) : RGBA(0x6B4C00);
case TokenKind::Type:
return dark ? RGBA(0xBBAA90) : RGBA(0x333333);
case TokenKind::Error:
return dark ? RGBA(0xD06060) : RGBA(0xCC0000);
default:
return ink;
}
}
// Leuchtturm palette: blue-black fountain pen ink with brass and bronze accents.
// Body text is ink-colored; accents drawn from the pen metals.
static ImVec4
SyntaxInkLeuchtturm(const TokenKind k, const bool dark)
{
const ImVec4 ink = dark ? RGBA(0xE5DDD0) : RGBA(0x040720); // fountain pen ink
const ImVec4 dim = dark ? RGBA(0x7A7060) : RGBA(0x6A6558); // comments
const ImVec4 brass = dark ? RGBA(0xB8A060) : RGBA(0x504518); // patinated brass
const ImVec4 bronze= dark ? RGBA(0xC08050) : RGBA(0x5C3010); // dark bronze
const ImVec4 navy = dark ? RGBA(0x8898B0) : RGBA(0x1C2E4A); // deep navy
switch (k) {
case TokenKind::Keyword:
case TokenKind::Preproc:
return brass;
case TokenKind::String:
case TokenKind::Char:
return bronze;
case TokenKind::Comment:
return dim;
case TokenKind::Function:
return navy;
case TokenKind::Number:
case TokenKind::Constant:
return dark ? RGBA(0xA89060) : RGBA(0x483C10);
case TokenKind::Type:
return dark ? RGBA(0xC0B898) : RGBA(0x222238);
case TokenKind::Error:
return dark ? RGBA(0xD06060) : RGBA(0xA02020);
default:
return ink;
}
}
// Everforest: warm forest palette on dark green-gray (bg 0x2B3339).
// Default comment color (0x616E88) is too dim; boost it and tune others.
static ImVec4
SyntaxInkEverforest(const TokenKind k)
{
switch (k) {
case TokenKind::Keyword:
return RGBA(0xE67E80); // everforest red
case TokenKind::Type:
return RGBA(0xD699B6); // everforest purple
case TokenKind::String:
case TokenKind::Char:
return RGBA(0xA7C080); // everforest green
case TokenKind::Comment:
return RGBA(0x859289); // boosted from 0x616E88 for contrast
case TokenKind::Number:
case TokenKind::Constant:
return RGBA(0xD8A657); // everforest yellow/orange
case TokenKind::Preproc:
return RGBA(0xE69875); // everforest orange
case TokenKind::Function:
return RGBA(0x83C092); // everforest aqua
case TokenKind::Operator:
case TokenKind::Punctuation:
return RGBA(0xD3C6AA); // everforest fg
case TokenKind::Error:
return RGBA(0xE67E80);
default:
return RGBA(0xD3C6AA); // everforest fg
}
}
[[maybe_unused]] static ImVec4 [[maybe_unused]] static ImVec4
SyntaxInk(const TokenKind k) SyntaxInk(const TokenKind k)
{ {
// Basic palettes for dark/light backgrounds; tuned for Nord-ish defaults
const bool dark = (GetBackgroundMode() == BackgroundMode::Dark); const bool dark = (GetBackgroundMode() == BackgroundMode::Dark);
// Base text
// Per-theme syntax palettes
if (gCurrentTheme == ThemeId::Tufte)
return SyntaxInkTufte(k, dark);
if (gCurrentTheme == ThemeId::Leuchtturm)
return SyntaxInkLeuchtturm(k, dark);
if (gCurrentTheme == ThemeId::Everforest)
return SyntaxInkEverforest(k);
// Default palettes tuned for Nord-ish themes
const ImVec4 def = dark ? RGBA(0xD8DEE9) : RGBA(0x2E3440); const ImVec4 def = dark ? RGBA(0xD8DEE9) : RGBA(0x2E3440);
switch (k) { switch (k) {
case TokenKind::Keyword: case TokenKind::Keyword:

View File

@@ -22,21 +22,26 @@ 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-s Save\n"
" C-k C-x Save and quit\n" " C-k C-x Save and quit\n"
" C-k a Mark start of file, jump to end\n" " C-k a Mark start of file, jump to end\n"
" C-k b Switch buffer\n" " C-k b Switch buffer\n"
" 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 m Toggle edit mode (code/writing)\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"
" C-k p Next buffer\n" " C-k p Next buffer\n"
@@ -60,6 +65,10 @@ HelpText::Text()
" ESC BACKSPACE Delete previous word (Alt-Backspace)\n" " ESC BACKSPACE Delete previous word (Alt-Backspace)\n"
" ESC q Reflow paragraph\n" " ESC q Reflow paragraph\n"
"\n" "\n"
"Universal argument:\n"
" C-u Begin repeat count (then type digits); C-u alone multiplies by 4\n"
" C-u N <cmd> Repeat <cmd> N times (e.g., C-u 8 C-f moves right 8 chars)\n"
"\n"
"Control keys:\n" "Control keys:\n"
" C-a C-e Line start / end\n" " C-a C-e Line start / end\n"
" C-b C-f Move left / right\n" " C-b C-f Move left / right\n"
@@ -71,12 +80,32 @@ HelpText::Text()
" C-t Regex search & replace\n" " C-t Regex search & replace\n"
" C-h Search & replace\n" " C-h Search & replace\n"
" C-l / C-g Refresh / Cancel\n" " C-l / C-g Refresh / Cancel\n"
" C-u [digits] Universal argument (repeat count)\n"
"\n" "\n"
"Buffers:\n +HELP+ is read-only. Press C-k ' to toggle; C-k h restores it.\n" "Buffers:\n +HELP+ is read-only. Press C-k ' to toggle; C-k h restores it.\n"
"\n" "\n"
"GUI appearance (command prompt):\n" "Edit modes:\n"
" : theme NAME Set GUI theme (amber, eink, everforest, gruvbox, kanagawa-paper, lcars, nord, old-book, plan9, solarized, weyland-yutani, zenburn)\n" " code Monospace font (default for source files)\n"
" : background MODE Set background: light | dark (affects eink, gruvbox, old-book, solarized)\n" " writing Proportional font (auto for .txt, .md, .rst, .org, .tex)\n"
" C-k m or : mode [code|writing] to toggle\n"
"\n"
"GUI commands (command prompt):\n"
" : theme NAME Set theme (amber, eink, everforest, gruvbox,\n"
" kanagawa-paper, lcars, leuchtturm, nord, old-book,\n"
" orbital, plan9, solarized, tufte, weyland-yutani,\n"
" zenburn)\n"
" : background MODE Background: light | dark\n"
" : font NAME Set font (tab completes)\n"
" : font-size NUM Set font size in pixels\n"
" : mode [code|writing] Toggle or set edit mode\n"
"\n"
"Configuration:\n"
" Config file: ~/.config/kte/kge.toml (see CONFIG.md)\n"
" Legacy kge.ini is also supported.\n"
"\n"
"GUI window management:\n"
" Cmd+N (macOS) Open a new editor window sharing the same buffers\n"
" Ctrl+Shift+N (Linux) Open a new editor window sharing the same buffers\n"
" Close window Secondary windows close independently; closing the\n"
" primary window quits the editor\n"
); );
} }

View File

@@ -29,19 +29,148 @@
static auto kGlslVersion = "#version 150"; // GL 3.2 core (macOS compatible) static auto kGlslVersion = "#version 150"; // GL 3.2 core (macOS compatible)
bool // ---------------------------------------------------------------------------
GUIFrontend::Init(Editor &ed) // Helpers
// ---------------------------------------------------------------------------
static void
apply_syntax_to_buffer(Buffer *b, const GUIConfig &cfg)
{ {
// Attach editor to input handler for editor-owned features (e.g., universal argument) if (!b)
input_.Attach(&ed); return;
// editor dimensions will be initialized during the first Step() frame
// Auto-detect edit mode from file extension
if (!b->Filename().empty())
b->SetEditMode(DetectEditMode(b->Filename()));
if (cfg.syntax) {
b->SetSyntaxEnabled(true);
b->EnsureHighlighter();
if (auto *eng = b->Highlighter()) {
if (!eng->HasHighlighter()) {
std::string first_line;
const auto &rows = b->Rows();
if (!rows.empty())
first_line = static_cast<std::string>(rows[0]);
std::string ft = kte::HighlighterRegistry::DetectForPath(
b->Filename(), first_line);
if (!ft.empty()) {
eng->SetHighlighter(kte::HighlighterRegistry::CreateFor(ft));
b->SetFiletype(ft);
eng->InvalidateFrom(0);
} else {
eng->SetHighlighter(std::make_unique<kte::NullHighlighter>());
b->SetFiletype("");
eng->InvalidateFrom(0);
}
}
}
} else {
b->SetSyntaxEnabled(false);
}
}
// Update editor logical rows/cols from current ImGui metrics for a given display size.
static void
update_editor_dimensions(Editor &ed, float disp_w, float disp_h)
{
float row_h = ImGui::GetTextLineHeightWithSpacing();
float ch_w = ImGui::CalcTextSize("M").x;
if (row_h <= 0.0f)
row_h = 16.0f;
if (ch_w <= 0.0f)
ch_w = 8.0f;
const float pad_x = 6.0f;
const float pad_y = 6.0f;
float wanted_bar_h = ImGui::GetFrameHeight();
float total_avail_h = std::max(0.0f, disp_h - 2.0f * pad_y);
float actual_avail_h = std::floor((total_avail_h - wanted_bar_h) / row_h) * row_h;
auto content_rows = static_cast<std::size_t>(std::max(0.0f, std::floor(actual_avail_h / row_h)));
std::size_t rows = content_rows + 1;
float avail_w = std::max(0.0f, disp_w - 2.0f * pad_x);
std::size_t cols = static_cast<std::size_t>(std::max(1.0f, std::floor(avail_w / ch_w)));
if (rows != ed.Rows() || cols != ed.Cols()) {
ed.SetDimensions(rows, cols);
}
}
// ---------------------------------------------------------------------------
// SetupImGuiStyle_ — apply theme, fonts, and flags to the current ImGui context
// ---------------------------------------------------------------------------
void
GUIFrontend::SetupImGuiStyle_()
{
ImGuiIO &io = ImGui::GetIO();
// Disable imgui.ini for secondary windows (primary sets its own path in Init)
io.IniFilename = nullptr;
io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;
io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad;
ImGui::StyleColorsDark();
if (config_.background == "light")
kte::SetBackgroundMode(kte::BackgroundMode::Light);
else
kte::SetBackgroundMode(kte::BackgroundMode::Dark);
kte::ApplyThemeByName(config_.theme);
// Load fonts into this context's font atlas.
// Font registry is global and already populated by Init; just load into this atlas.
if (!kte::Fonts::FontRegistry::Instance().LoadFont(config_.font, (float) config_.font_size)) {
LoadGuiFont_(nullptr, (float) config_.font_size);
}
}
// ---------------------------------------------------------------------------
// Destroy a single window's ImGui context + SDL/GL resources
// ---------------------------------------------------------------------------
void
GUIFrontend::DestroyWindowResources_(WindowState &ws)
{
if (ws.imgui_ctx) {
// Must activate this window's GL context before shutting down the
// OpenGL3 backend, otherwise it deletes another context's resources.
if (ws.window && ws.gl_ctx)
SDL_GL_MakeCurrent(ws.window, ws.gl_ctx);
ImGui::SetCurrentContext(ws.imgui_ctx);
ImGui_ImplOpenGL3_Shutdown();
ImGui_ImplSDL2_Shutdown();
ImGui::DestroyContext(ws.imgui_ctx);
ws.imgui_ctx = nullptr;
}
if (ws.gl_ctx) {
SDL_GL_DeleteContext(ws.gl_ctx);
ws.gl_ctx = nullptr;
}
if (ws.window) {
SDL_DestroyWindow(ws.window);
ws.window = nullptr;
}
}
bool
GUIFrontend::Init(int &argc, char **argv, Editor &ed)
{
(void) argc;
(void) argv;
// Load GUI configuration (fullscreen, columns/rows, font size, theme, background)
config_ = GUIConfig::Load();
if (SDL_Init(SDL_INIT_VIDEO | SDL_INIT_TIMER) != 0) { if (SDL_Init(SDL_INIT_VIDEO | SDL_INIT_TIMER) != 0) {
return false; return false;
} }
// Load GUI configuration (fullscreen, columns/rows, font size, theme, background)
GUIConfig cfg = GUIConfig::Load();
// GL attributes for core profile // GL attributes for core profile
SDL_GL_SetAttribute(SDL_GL_CONTEXT_FLAGS, 0); SDL_GL_SetAttribute(SDL_GL_CONTEXT_FLAGS, 0);
SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE); SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE);
@@ -54,159 +183,114 @@ GUIFrontend::Init(Editor &ed)
// Compute desired window size from config // Compute desired window size from config
Uint32 win_flags = SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI; Uint32 win_flags = SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI;
if (cfg.fullscreen) { int init_w = 1280, init_h = 800;
// "Fullscreen": fill the usable bounds of the primary display. if (config_.fullscreen) {
// On macOS, do NOT use true fullscreen so the menu/status bar remains visible.
SDL_Rect usable{}; SDL_Rect usable{};
if (SDL_GetDisplayUsableBounds(0, &usable) == 0) { if (SDL_GetDisplayUsableBounds(0, &usable) == 0) {
width_ = usable.w; init_w = usable.w;
height_ = usable.h; init_h = usable.h;
} }
#if !defined(__APPLE__) #if !defined(__APPLE__)
// Non-macOS: desktop fullscreen uses the current display resolution.
win_flags |= SDL_WINDOW_FULLSCREEN_DESKTOP; win_flags |= SDL_WINDOW_FULLSCREEN_DESKTOP;
#endif #endif
} else { } else {
// Windowed: width = columns * font_size, height = (rows * 2) * font_size int w = config_.columns * static_cast<int>(config_.font_size);
int w = cfg.columns * static_cast<int>(cfg.font_size); int h = config_.rows * static_cast<int>(config_.font_size * 1.2);
int h = cfg.rows * static_cast<int>(cfg.font_size * 1.2);
// As a safety, clamp to display usable bounds if retrievable
SDL_Rect usable{}; SDL_Rect usable{};
if (SDL_GetDisplayUsableBounds(0, &usable) == 0) { if (SDL_GetDisplayUsableBounds(0, &usable) == 0) {
w = std::min(w, usable.w); w = std::min(w, usable.w);
h = std::min(h, usable.h); h = std::min(h, usable.h);
} }
width_ = std::max(320, w); init_w = std::max(320, w);
height_ = std::max(200, h); init_h = std::max(200, h);
} }
SDL_SetHint(SDL_HINT_VIDEO_ALLOW_SCREENSAVER, "1"); SDL_SetHint(SDL_HINT_VIDEO_ALLOW_SCREENSAVER, "1");
window_ = SDL_CreateWindow( SDL_Window *win = SDL_CreateWindow(
"kge - kyle's graphical editor " KTE_VERSION_STR, "kge - kyle's graphical editor " KTE_VERSION_STR,
SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED,
width_, height_, init_w, init_h,
win_flags); win_flags);
if (!window_) { if (!win) {
return false; return false;
} }
SDL_EnableScreenSaver(); SDL_EnableScreenSaver();
#if defined(__APPLE__) #if defined(__APPLE__)
// macOS: when "fullscreen" is requested, position the window at the if (config_.fullscreen) {
// top-left of the usable display area to mimic fullscreen while keeping
// the system menu bar visible.
if (cfg.fullscreen) {
SDL_Rect usable{}; SDL_Rect usable{};
if (SDL_GetDisplayUsableBounds(0, &usable) == 0) { if (SDL_GetDisplayUsableBounds(0, &usable) == 0) {
SDL_SetWindowPosition(window_, usable.x, usable.y); SDL_SetWindowPosition(win, usable.x, usable.y);
} }
} }
#endif #endif
gl_ctx_ = SDL_GL_CreateContext(window_); SDL_GLContext gl_ctx = SDL_GL_CreateContext(win);
if (!gl_ctx_) if (!gl_ctx) {
SDL_DestroyWindow(win);
return false; return false;
SDL_GL_MakeCurrent(window_, gl_ctx_); }
SDL_GL_MakeCurrent(win, gl_ctx);
SDL_GL_SetSwapInterval(1); // vsync SDL_GL_SetSwapInterval(1); // vsync
// Create primary ImGui context
IMGUI_CHECKVERSION(); IMGUI_CHECKVERSION();
ImGui::CreateContext(); ImGuiContext *imgui_ctx = ImGui::CreateContext();
ImGuiIO &io = ImGui::GetIO(); ImGuiIO &io = ImGui::GetIO();
// Set custom ini filename path to ~/.config/kte/imgui.ini // Set custom ini filename path to ~/.config/kte/imgui.ini
if (const char *home = std::getenv("HOME")) { if (const char *home = std::getenv("HOME")) {
namespace fs = std::filesystem; namespace fs = std::filesystem;
fs::path config_dir = fs::path(home) / ".config" / "kte"; fs::path config_dir = fs::path(home) / ".config" / "kte";
std::error_code ec; std::error_code ec;
if (!fs::exists(config_dir)) { if (!fs::exists(config_dir)) {
fs::create_directories(config_dir, ec); fs::create_directories(config_dir, ec);
} }
if (fs::exists(config_dir)) { if (fs::exists(config_dir)) {
static std::string ini_path = (config_dir / "imgui.ini").string(); static std::string ini_path = (config_dir / "imgui.ini").string();
io.IniFilename = ini_path.c_str(); io.IniFilename = ini_path.c_str();
} }
} }
io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard; // Enable Keyboard Controls io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;
io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad; // Enable Gamepad Controls io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad;
ImGui::StyleColorsDark(); ImGui::StyleColorsDark();
// Apply background mode and selected theme (default: Nord). Can be changed at runtime via commands. if (config_.background == "light")
if (cfg.background == "light")
kte::SetBackgroundMode(kte::BackgroundMode::Light); kte::SetBackgroundMode(kte::BackgroundMode::Light);
else else
kte::SetBackgroundMode(kte::BackgroundMode::Dark); kte::SetBackgroundMode(kte::BackgroundMode::Dark);
kte::ApplyThemeByName(cfg.theme); kte::ApplyThemeByName(config_.theme);
// Apply default syntax highlighting preference from GUI config to the current buffer apply_syntax_to_buffer(ed.CurrentBuffer(), config_);
if (Buffer *b = ed.CurrentBuffer()) {
if (cfg.syntax) {
b->SetSyntaxEnabled(true);
// Ensure a highlighter is available if possible
b->EnsureHighlighter();
if (auto *eng = b->Highlighter()) {
if (!eng->HasHighlighter()) {
// Try detect from filename and first line; fall back to cpp or existing filetype
std::string first_line;
const auto &rows = b->Rows();
if (!rows.empty())
first_line = static_cast<std::string>(rows[0]);
std::string ft = kte::HighlighterRegistry::DetectForPath(
b->Filename(), first_line);
if (!ft.empty()) {
eng->SetHighlighter(kte::HighlighterRegistry::CreateFor(ft));
b->SetFiletype(ft);
eng->InvalidateFrom(0);
} else {
// Unknown/unsupported -> install a null highlighter to keep syntax enabled
eng->SetHighlighter(std::make_unique<kte::NullHighlighter>());
b->SetFiletype("");
eng->InvalidateFrom(0);
}
}
}
} else {
b->SetSyntaxEnabled(false);
}
}
if (!ImGui_ImplSDL2_InitForOpenGL(window_, gl_ctx_)) if (!ImGui_ImplSDL2_InitForOpenGL(win, gl_ctx))
return false; return false;
if (!ImGui_ImplOpenGL3_Init(kGlslVersion)) if (!ImGui_ImplOpenGL3_Init(kGlslVersion))
return false; return false;
// Cache initial window size; logical rows/cols will be computed in Step() once a valid ImGui frame exists // Cache initial window size
int w, h; int w, h;
SDL_GetWindowSize(window_, &w, &h); SDL_GetWindowSize(win, &w, &h);
width_ = w; init_w = w;
height_ = h; init_h = h;
#if defined(__APPLE__) #if defined(__APPLE__)
// Workaround: On macOS Retina when starting maximized, we sometimes get a
// subtle input vs draw alignment mismatch until the first manual resize.
// Nudge the window size by 1px and back to trigger a proper internal
// recomputation, without visible impact.
if (w > 1 && h > 1) { if (w > 1 && h > 1) {
SDL_SetWindowSize(window_, w - 1, h - 1); SDL_SetWindowSize(win, w - 1, h - 1);
SDL_SetWindowSize(window_, w, h); SDL_SetWindowSize(win, w, h);
// Update cached size in case backend reports immediately SDL_GetWindowSize(win, &w, &h);
SDL_GetWindowSize(window_, &w, &h); init_w = w;
width_ = w; init_h = h;
height_ = h;
} }
#endif #endif
// Install embedded fonts into registry and load configured font // Install embedded fonts
kte::Fonts::InstallDefaultFonts(); kte::Fonts::InstallDefaultFonts();
// Initialize font atlas using configured font name and size; fallback to embedded default helper if (!kte::Fonts::FontRegistry::Instance().LoadFont(config_.font, (float) config_.font_size)) {
if (!kte::Fonts::FontRegistry::Instance().LoadFont(cfg.font, (float) cfg.font_size)) { LoadGuiFont_(nullptr, (float) config_.font_size);
LoadGuiFont_(nullptr, (float) cfg.font_size); kte::Fonts::FontRegistry::Instance().RequestLoadFont("default", (float) config_.font_size);
// Record defaults in registry so subsequent size changes have a base
kte::Fonts::FontRegistry::Instance().RequestLoadFont("default", (float) cfg.font_size);
std::string n; std::string n;
float s = 0.0f; float s = 0.0f;
if (kte::Fonts::FontRegistry::Instance().ConsumePendingFontRequest(n, s)) { if (kte::Fonts::FontRegistry::Instance().ConsumePendingFontRequest(n, s)) {
@@ -214,6 +298,90 @@ GUIFrontend::Init(Editor &ed)
} }
} }
// Build primary WindowState
auto ws = std::make_unique<WindowState>();
ws->window = win;
ws->gl_ctx = gl_ctx;
ws->imgui_ctx = imgui_ctx;
ws->width = init_w;
ws->height = init_h;
// The primary window's editor IS the editor passed in from main; we don't
// use ws->editor for the primary — instead we keep a pointer to &ed.
// We store a sentinel: window index 0 uses the external editor reference.
// To keep things simple, attach input to the passed-in editor.
ws->input.Attach(&ed);
windows_.push_back(std::move(ws));
return true;
}
bool
GUIFrontend::OpenNewWindow_(Editor &primary)
{
Uint32 win_flags = SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI;
int w = windows_[0]->width;
int h = windows_[0]->height;
SDL_Window *win = SDL_CreateWindow(
"kge - kyle's graphical editor " KTE_VERSION_STR,
SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED,
w, h,
win_flags);
if (!win)
return false;
SDL_GLContext gl_ctx = SDL_GL_CreateContext(win);
if (!gl_ctx) {
SDL_DestroyWindow(win);
return false;
}
SDL_GL_MakeCurrent(win, gl_ctx);
SDL_GL_SetSwapInterval(1);
// Each window gets its own ImGui context — ImGui requires exactly one
// NewFrame/Render cycle per context per frame.
ImGuiContext *imgui_ctx = ImGui::CreateContext();
ImGui::SetCurrentContext(imgui_ctx);
SetupImGuiStyle_();
if (!ImGui_ImplSDL2_InitForOpenGL(win, gl_ctx)) {
ImGui::DestroyContext(imgui_ctx);
SDL_GL_DeleteContext(gl_ctx);
SDL_DestroyWindow(win);
return false;
}
if (!ImGui_ImplOpenGL3_Init(kGlslVersion)) {
ImGui_ImplSDL2_Shutdown();
ImGui::DestroyContext(imgui_ctx);
SDL_GL_DeleteContext(gl_ctx);
SDL_DestroyWindow(win);
return false;
}
auto ws = std::make_unique<WindowState>();
ws->window = win;
ws->gl_ctx = gl_ctx;
ws->imgui_ctx = imgui_ctx;
ws->width = w;
ws->height = h;
// Secondary editor shares the primary's buffer list
ws->editor.SetSharedBuffers(&primary.Buffers());
ws->editor.SetDimensions(primary.Rows(), primary.Cols());
// Open a new untitled buffer and switch to it in the new window.
ws->editor.AddBuffer(Buffer());
ws->editor.SwitchTo(ws->editor.BufferCount() - 1);
ws->input.Attach(&ws->editor);
windows_.push_back(std::move(ws));
// Restore primary context
ImGui::SetCurrentContext(windows_[0]->imgui_ctx);
SDL_GL_MakeCurrent(windows_[0]->window, windows_[0]->gl_ctx);
return true; return true;
} }
@@ -221,134 +389,251 @@ GUIFrontend::Init(Editor &ed)
void void
GUIFrontend::Step(Editor &ed, bool &running) GUIFrontend::Step(Editor &ed, bool &running)
{ {
// --- Event processing ---
// SDL events carry a window ID. Route each event to the correct window's
// ImGui context (for ImGui_ImplSDL2_ProcessEvent) and input handler.
SDL_Event e; SDL_Event e;
while (SDL_PollEvent(&e)) { while (SDL_PollEvent(&e)) {
ImGui_ImplSDL2_ProcessEvent(&e); // Determine which window this event belongs to
Uint32 event_win_id = 0;
switch (e.type) { switch (e.type) {
case SDL_QUIT:
running = false;
break;
case SDL_WINDOWEVENT: case SDL_WINDOWEVENT:
if (e.window.event == SDL_WINDOWEVENT_SIZE_CHANGED) { event_win_id = e.window.windowID;
width_ = e.window.data1; break;
height_ = e.window.data2; case SDL_KEYDOWN:
} case SDL_KEYUP:
event_win_id = e.key.windowID;
break;
case SDL_TEXTINPUT:
event_win_id = e.text.windowID;
break;
case SDL_MOUSEBUTTONDOWN:
case SDL_MOUSEBUTTONUP:
event_win_id = e.button.windowID;
break;
case SDL_MOUSEWHEEL:
event_win_id = e.wheel.windowID;
break;
case SDL_MOUSEMOTION:
event_win_id = e.motion.windowID;
break; break;
default: default:
break; break;
} }
// Map input to commands
input_.ProcessSDLEvent(e); if (e.type == SDL_QUIT) {
running = false;
break;
} }
// Apply pending font change before starting a new frame // Find the target window and route the event to its ImGui context
WindowState *target = nullptr;
std::size_t target_idx = 0;
if (event_win_id != 0) {
for (std::size_t i = 0; i < windows_.size(); ++i) {
if (SDL_GetWindowID(windows_[i]->window) == event_win_id) {
target = windows_[i].get();
target_idx = i;
break;
}
}
}
if (target && target->imgui_ctx) {
// Set this window's ImGui context so ImGui_ImplSDL2_ProcessEvent
// updates the correct IO state.
ImGui::SetCurrentContext(target->imgui_ctx);
ImGui_ImplSDL2_ProcessEvent(&e);
}
if (e.type == SDL_WINDOWEVENT) {
if (e.window.event == SDL_WINDOWEVENT_CLOSE) {
if (target) {
if (target_idx == 0) {
running = false;
} else {
target->alive = false;
}
}
} else if (e.window.event == SDL_WINDOWEVENT_SIZE_CHANGED) {
if (target) {
target->width = e.window.data1;
target->height = e.window.data2;
}
}
}
// Route input events to the correct window's input handler
if (target) {
target->input.ProcessSDLEvent(e);
}
}
if (!running)
return;
// --- Apply pending font change (to all contexts) ---
{ {
std::string fname; std::string fname;
float fsize = 0.0f; float fsize = 0.0f;
if (kte::Fonts::FontRegistry::Instance().ConsumePendingFontRequest(fname, fsize)) { if (kte::Fonts::FontRegistry::Instance().ConsumePendingFontRequest(fname, fsize)) {
if (!fname.empty() && fsize > 0.0f) { if (!fname.empty() && fsize > 0.0f) {
for (auto &ws : windows_) {
if (!ws->alive || !ws->imgui_ctx)
continue;
ImGui::SetCurrentContext(ws->imgui_ctx);
SDL_GL_MakeCurrent(ws->window, ws->gl_ctx);
kte::Fonts::FontRegistry::Instance().LoadFont(fname, fsize); kte::Fonts::FontRegistry::Instance().LoadFont(fname, fsize);
// Recreate backend font texture ImGui_ImplOpenGL3_DestroyFontsTexture();
ImGui_ImplOpenGL3_CreateFontsTexture();
}
}
}
}
// --- Step each window ---
// We iterate by index because OpenNewWindow_ may append to windows_.
for (std::size_t wi = 0; wi < windows_.size(); ++wi) {
WindowState &ws = *windows_[wi];
if (!ws.alive)
continue;
Editor &wed = (wi == 0) ? ed : ws.editor;
// Shared buffer list may have been modified by another window.
wed.ValidateBufferIndex();
// Activate this window's GL and ImGui contexts
SDL_GL_MakeCurrent(ws.window, ws.gl_ctx);
ImGui::SetCurrentContext(ws.imgui_ctx);
// Start a new ImGui frame
ImGui_ImplOpenGL3_NewFrame();
ImGui_ImplSDL2_NewFrame(ws.window);
ImGui::NewFrame();
// Update editor dimensions
{
ImGuiIO &io = ImGui::GetIO();
float disp_w = io.DisplaySize.x > 0 ? io.DisplaySize.x : static_cast<float>(ws.width);
float disp_h = io.DisplaySize.y > 0 ? io.DisplaySize.y : static_cast<float>(ws.height);
update_editor_dimensions(wed, disp_w, disp_h);
}
// Allow deferred opens
wed.ProcessPendingOpens();
// Ensure newly opened buffers get syntax + edit mode detection
apply_syntax_to_buffer(wed.CurrentBuffer(), config_);
// Drain input queue
for (;;) {
MappedInput mi;
if (!ws.input.Poll(mi))
break;
if (mi.hasCommand) {
if (mi.id == CommandId::NewWindow) {
// Open a new window; handled after this loop
wed.SetNewWindowRequested(true);
} else if (mi.id == CommandId::FontZoomIn ||
mi.id == CommandId::FontZoomOut ||
mi.id == CommandId::FontZoomReset) {
auto &fr = kte::Fonts::FontRegistry::Instance();
float cur = fr.CurrentFontSize();
if (cur <= 0.0f) cur = config_.font_size;
float next = cur;
if (mi.id == CommandId::FontZoomIn)
next = std::min(cur + 2.0f, 72.0f);
else if (mi.id == CommandId::FontZoomOut)
next = std::max(cur - 2.0f, 8.0f);
else
next = config_.font_size; // reset to config default
if (next != cur)
fr.RequestLoadFont(fr.CurrentFontName(), next);
} else {
const std::string before = wed.KillRingHead();
Execute(wed, mi.id, mi.arg, mi.count);
const std::string after = wed.KillRingHead();
if (after != before && !after.empty()) {
SDL_SetClipboardText(after.c_str());
}
}
}
}
if (wi == 0 && wed.QuitRequested()) {
running = false;
}
// Switch font based on current buffer's edit mode
{
Buffer *cur = wed.CurrentBuffer();
if (cur) {
auto &fr = kte::Fonts::FontRegistry::Instance();
const std::string &expected =
(cur->GetEditMode() == EditMode::Writing)
? config_.writing_font
: config_.code_font;
if (fr.CurrentFontName() != expected && fr.HasFont(expected)) {
float sz = fr.CurrentFontSize();
if (sz <= 0.0f) sz = config_.font_size;
fr.LoadFont(expected, sz);
ImGui_ImplOpenGL3_DestroyFontsTexture(); ImGui_ImplOpenGL3_DestroyFontsTexture();
ImGui_ImplOpenGL3_CreateFontsTexture(); ImGui_ImplOpenGL3_CreateFontsTexture();
} }
} }
} }
// Start a new ImGui frame BEFORE processing commands so dimensions are correct // Draw
ImGui_ImplOpenGL3_NewFrame(); ws.renderer.Draw(wed);
ImGui_ImplSDL2_NewFrame(window_);
ImGui::NewFrame();
// Update editor logical rows/cols using current ImGui metrics and display size
{
ImGuiIO &io = ImGui::GetIO();
float row_h = ImGui::GetTextLineHeightWithSpacing();
float ch_w = ImGui::CalcTextSize("M").x;
if (row_h <= 0.0f)
row_h = 16.0f;
if (ch_w <= 0.0f)
ch_w = 8.0f;
// Prefer ImGui IO display size; fall back to cached SDL window size
float disp_w = io.DisplaySize.x > 0 ? io.DisplaySize.x : static_cast<float>(width_);
float disp_h = io.DisplaySize.y > 0 ? io.DisplaySize.y : static_cast<float>(height_);
// Account for the GUI window padding and the status bar height used in ImGuiRenderer.
const float pad_x = 6.0f;
const float pad_y = 6.0f;
// Use the same logic as ImGuiRenderer for available height and status bar reservation.
float wanted_bar_h = ImGui::GetFrameHeight();
float total_avail_h = std::max(0.0f, disp_h - 2.0f * pad_y);
float actual_avail_h = std::floor((total_avail_h - wanted_bar_h) / row_h) * row_h;
// Visible content rows inside the scroll child
auto content_rows = static_cast<std::size_t>(std::max(0.0f, std::floor(actual_avail_h / row_h)));
// Editor::Rows includes the status line; add 1 back for it.
std::size_t rows = content_rows + 1;
float avail_w = std::max(0.0f, disp_w - 2.0f * pad_x);
std::size_t cols = static_cast<std::size_t>(std::max(1.0f, std::floor(avail_w / ch_w)));
// Only update if changed to avoid churn
if (rows != ed.Rows() || cols != ed.Cols()) {
ed.SetDimensions(rows, cols);
}
}
// Execute pending mapped inputs (drain queue) AFTER dimensions are updated
for (;;) {
MappedInput mi;
if (!input_.Poll(mi))
break;
if (mi.hasCommand) {
// Track kill ring before and after to sync GUI clipboard when it changes
const std::string before = ed.KillRingHead();
Execute(ed, mi.id, mi.arg, mi.count);
const std::string after = ed.KillRingHead();
if (after != before && !after.empty()) {
// Update the system clipboard to mirror the kill ring head in GUI
SDL_SetClipboardText(after.c_str());
}
}
}
if (ed.QuitRequested()) {
running = false;
}
// No runtime font UI; always use embedded font.
// Draw editor UI
renderer_.Draw(ed);
// Render // Render
ImGui::Render(); ImGui::Render();
int display_w, display_h; int display_w, display_h;
SDL_GL_GetDrawableSize(window_, &display_w, &display_h); SDL_GL_GetDrawableSize(ws.window, &display_w, &display_h);
glViewport(0, 0, display_w, display_h); glViewport(0, 0, display_w, display_h);
glClearColor(0.1f, 0.1f, 0.11f, 1.0f); glClearColor(0.1f, 0.1f, 0.11f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT); glClear(GL_COLOR_BUFFER_BIT);
ImGui_ImplOpenGL3_RenderDrawData(ImGui::GetDrawData()); ImGui_ImplOpenGL3_RenderDrawData(ImGui::GetDrawData());
SDL_GL_SwapWindow(window_); SDL_GL_SwapWindow(ws.window);
}
// Handle deferred new-window requests (must happen outside the render loop
// to avoid corrupting an in-progress ImGui frame).
for (std::size_t wi = 0; wi < windows_.size(); ++wi) {
Editor &wed = (wi == 0) ? ed : windows_[wi]->editor;
if (wed.NewWindowRequested()) {
wed.SetNewWindowRequested(false);
OpenNewWindow_(ed);
}
}
// Remove dead secondary windows
for (auto it = windows_.begin() + 1; it != windows_.end();) {
if (!(*it)->alive) {
DestroyWindowResources_(**it);
it = windows_.erase(it);
} else {
++it;
}
}
// Restore primary context
if (!windows_.empty()) {
ImGui::SetCurrentContext(windows_[0]->imgui_ctx);
SDL_GL_MakeCurrent(windows_[0]->window, windows_[0]->gl_ctx);
}
} }
void void
GUIFrontend::Shutdown() GUIFrontend::Shutdown()
{ {
ImGui_ImplOpenGL3_Shutdown(); // Destroy all windows (secondary first, then primary)
ImGui_ImplSDL2_Shutdown(); for (auto it = windows_.rbegin(); it != windows_.rend(); ++it) {
ImGui::DestroyContext(); DestroyWindowResources_(**it);
if (gl_ctx_) {
SDL_GL_DeleteContext(gl_ctx_);
gl_ctx_ = nullptr;
}
if (window_) {
SDL_DestroyWindow(window_);
window_ = nullptr;
} }
windows_.clear();
SDL_Quit(); SDL_Quit();
} }
@@ -362,7 +647,6 @@ GUIFrontend::LoadGuiFont_(const char * /*path*/, const float size_px)
ImFontConfig config; ImFontConfig config;
config.MergeMode = false; config.MergeMode = false;
// Load Basic Latin + Latin Supplement
io.Fonts->AddFontFromMemoryCompressedTTF( io.Fonts->AddFontFromMemoryCompressedTTF(
kte::Fonts::DefaultFontData, kte::Fonts::DefaultFontData,
kte::Fonts::DefaultFontSize, kte::Fonts::DefaultFontSize,
@@ -370,7 +654,6 @@ GUIFrontend::LoadGuiFont_(const char * /*path*/, const float size_px)
&config, &config,
io.Fonts->GetGlyphRangesDefault()); io.Fonts->GetGlyphRangesDefault());
// Merge Greek and Mathematical symbols from IosevkaExtended
config.MergeMode = true; config.MergeMode = true;
static const ImWchar extended_ranges[] = { static const ImWchar extended_ranges[] = {
0x0370, 0x03FF, // Greek and Coptic 0x0370, 0x03FF, // Greek and Coptic

View File

@@ -2,13 +2,18 @@
* GUIFrontend - couples ImGuiInputHandler + GUIRenderer and owns SDL2/ImGui lifecycle * GUIFrontend - couples ImGuiInputHandler + GUIRenderer and owns SDL2/ImGui lifecycle
*/ */
#pragma once #pragma once
#include <memory>
#include <vector>
#include "Frontend.h" #include "Frontend.h"
#include "GUIConfig.h" #include "GUIConfig.h"
#include "ImGuiInputHandler.h" #include "ImGuiInputHandler.h"
#include "ImGuiRenderer.h" #include "ImGuiRenderer.h"
#include "Editor.h"
struct SDL_Window; struct SDL_Window;
struct ImGuiContext;
typedef void *SDL_GLContext; typedef void *SDL_GLContext;
class GUIFrontend final : public Frontend { class GUIFrontend final : public Frontend {
@@ -17,20 +22,38 @@ public:
~GUIFrontend() override = default; ~GUIFrontend() override = default;
bool Init(Editor &ed) override; bool Init(int &argc, char **argv, Editor &ed) override;
void Step(Editor &ed, bool &running) override; void Step(Editor &ed, bool &running) override;
void Shutdown() override; void Shutdown() override;
private: private:
// Per-window state — each window owns its own ImGui context so that
// NewFrame/Render cycles are fully independent (ImGui requires exactly
// one NewFrame per Render per context).
struct WindowState {
SDL_Window *window = nullptr;
SDL_GLContext gl_ctx = nullptr;
ImGuiContext *imgui_ctx = nullptr;
ImGuiInputHandler input{};
ImGuiRenderer renderer{};
Editor editor{};
int width = 1280;
int height = 800;
bool alive = true;
};
// Open a new secondary window sharing the primary editor's buffer list.
// Returns false if window creation fails.
bool OpenNewWindow_(Editor &primary);
// Initialize fonts and theme for a given ImGui context (must be current).
void SetupImGuiStyle_();
static void DestroyWindowResources_(WindowState &ws);
static bool LoadGuiFont_(const char *path, float size_px); static bool LoadGuiFont_(const char *path, float size_px);
GUIConfig config_{}; GUIConfig config_{};
ImGuiInputHandler input_{}; // Primary window (index 0 in windows_); created during Init.
ImGuiRenderer renderer_{}; std::vector<std::unique_ptr<WindowState> > windows_;
SDL_Window *window_ = nullptr;
SDL_GLContext gl_ctx_ = nullptr;
int width_ = 1280;
int height_ = 800;
}; };

View File

@@ -125,7 +125,11 @@ map_key(const SDL_Keycode key,
case SDLK_KP_ENTER: case SDLK_KP_ENTER:
k_prefix = false; k_prefix = false;
k_ctrl_pending = false; k_ctrl_pending = false;
if (mod & KMOD_SHIFT) {
out = {true, CommandId::SmartNewline, "", 0};
} else {
out = {true, CommandId::Newline, "", 0}; out = {true, CommandId::Newline, "", 0};
}
return true; return true;
case SDLK_ESCAPE: case SDLK_ESCAPE:
k_prefix = false; k_prefix = false;
@@ -333,6 +337,38 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
SDL_Keymod mods = SDL_Keymod(e.key.keysym.mod); SDL_Keymod mods = SDL_Keymod(e.key.keysym.mod);
const SDL_Keycode key = e.key.keysym.sym; const SDL_Keycode key = e.key.keysym.sym;
// New window: Cmd+N (macOS) or Ctrl+Shift+N (Linux/Windows)
{
const bool gui_n = (mods & KMOD_GUI) && !(mods & KMOD_CTRL) && (key == SDLK_n);
const bool ctrl_sn = (mods & KMOD_CTRL) && (mods & KMOD_SHIFT) && (key == SDLK_n);
if (gui_n || ctrl_sn) {
std::lock_guard<std::mutex> lk(mu_);
q_.push(MappedInput{true, CommandId::NewWindow, std::string(), 0});
suppress_text_input_once_ = true;
return true;
}
}
// Font zoom: Cmd+=/Cmd+-/Cmd+0 (macOS) or Ctrl+=/Ctrl+-/Ctrl+0
if ((mods & (KMOD_CTRL | KMOD_GUI)) && !(mods & KMOD_SHIFT)) {
bool is_zoom = true;
CommandId zoom_cmd = CommandId::FontZoomIn;
if (key == SDLK_EQUALS || key == SDLK_PLUS)
zoom_cmd = CommandId::FontZoomIn;
else if (key == SDLK_MINUS)
zoom_cmd = CommandId::FontZoomOut;
else if (key == SDLK_0)
zoom_cmd = CommandId::FontZoomReset;
else
is_zoom = false;
if (is_zoom) {
std::lock_guard<std::mutex> lk(mu_);
q_.push(MappedInput{true, zoom_cmd, std::string(), 0});
suppress_text_input_once_ = true;
return true;
}
}
// Handle Paste: Ctrl+V (Windows/Linux) or Cmd+V (macOS) // Handle Paste: Ctrl+V (Windows/Linux) or Cmd+V (macOS)
// Note: SDL defines letter keycodes in lowercase only (e.g., SDLK_v). Shift does not change keycode. // Note: SDL defines letter keycodes in lowercase only (e.g., SDLK_v). Shift does not change keycode.
if ((mods & (KMOD_CTRL | KMOD_GUI)) && (key == SDLK_v)) { if ((mods & (KMOD_CTRL | KMOD_GUI)) && (key == SDLK_v)) {

View File

@@ -76,19 +76,16 @@ ImGuiRenderer::Draw(Editor &ed)
// Two-way sync between Buffer::Rowoffs and ImGui scroll position: // Two-way sync between Buffer::Rowoffs and ImGui scroll position:
// - If command layer changed Buffer::Rowoffs since last frame, drive ImGui scroll from it. // - If command layer changed Buffer::Rowoffs since last frame, drive ImGui scroll from it.
// - Otherwise, propagate ImGui scroll to Buffer::Rowoffs so command layer has an up-to-date view. // - Otherwise, propagate ImGui scroll to Buffer::Rowoffs so command layer has an up-to-date view.
static long prev_buf_rowoffs = -1; // previous frame's Buffer::Rowoffs
static long prev_buf_coloffs = -1; // previous frame's Buffer::Coloffs
const long buf_rowoffs = static_cast<long>(buf->Rowoffs()); const long buf_rowoffs = static_cast<long>(buf->Rowoffs());
const long buf_coloffs = static_cast<long>(buf->Coloffs()); const long buf_coloffs = static_cast<long>(buf->Coloffs());
// Detect programmatic change (e.g., page_down command changed rowoffs) // Detect programmatic change (e.g., page_down command changed rowoffs)
// Use SetNextWindowScroll BEFORE BeginChild to set initial scroll position // Use SetNextWindowScroll BEFORE BeginChild to set initial scroll position
if (prev_buf_rowoffs >= 0 && buf_rowoffs != prev_buf_rowoffs) { if (prev_buf_rowoffs_ >= 0 && buf_rowoffs != prev_buf_rowoffs_) {
float target_y = static_cast<float>(buf_rowoffs) * row_h; float target_y = static_cast<float>(buf_rowoffs) * row_h;
ImGui::SetNextWindowScroll(ImVec2(-1.0f, target_y)); ImGui::SetNextWindowScroll(ImVec2(-1.0f, target_y));
} }
if (prev_buf_coloffs >= 0 && buf_coloffs != prev_buf_coloffs) { if (prev_buf_coloffs_ >= 0 && buf_coloffs != prev_buf_coloffs_) {
float target_x = static_cast<float>(buf_coloffs) * space_w; float target_x = static_cast<float>(buf_coloffs) * space_w;
float target_y = static_cast<float>(buf_rowoffs) * row_h; float target_y = static_cast<float>(buf_rowoffs) * row_h;
ImGui::SetNextWindowScroll(ImVec2(target_x, target_y)); ImGui::SetNextWindowScroll(ImVec2(target_x, target_y));
@@ -116,25 +113,22 @@ ImGuiRenderer::Draw(Editor &ed)
// Synchronize buffer offsets from ImGui scroll if user scrolled manually // Synchronize buffer offsets from ImGui scroll if user scrolled manually
bool forced_scroll = false; bool forced_scroll = false;
{ {
static float prev_scroll_y = -1.0f; // previous frame's ImGui scroll Y in pixels
static float prev_scroll_x = -1.0f; // previous frame's ImGui scroll X in pixels
const long scroll_top = static_cast<long>(scroll_y / row_h); const long scroll_top = static_cast<long>(scroll_y / row_h);
const long scroll_left = static_cast<long>(scroll_x / space_w); const long scroll_left = static_cast<long>(scroll_x / space_w);
// Check if rowoffs was programmatically changed this frame // Check if rowoffs was programmatically changed this frame
if (prev_buf_rowoffs >= 0 && buf_rowoffs != prev_buf_rowoffs) { if (prev_buf_rowoffs_ >= 0 && buf_rowoffs != prev_buf_rowoffs_) {
forced_scroll = true; forced_scroll = true;
} }
// If user scrolled (not programmatic), update buffer offsets accordingly // If user scrolled (not programmatic), update buffer offsets accordingly
if (prev_scroll_y >= 0.0f && scroll_y != prev_scroll_y && !forced_scroll) { if (prev_scroll_y_ >= 0.0f && scroll_y != prev_scroll_y_ && !forced_scroll) {
if (Buffer *mbuf = const_cast<Buffer *>(buf)) { if (Buffer *mbuf = const_cast<Buffer *>(buf)) {
mbuf->SetOffsets(static_cast<std::size_t>(std::max(0L, scroll_top)), mbuf->SetOffsets(static_cast<std::size_t>(std::max(0L, scroll_top)),
mbuf->Coloffs()); mbuf->Coloffs());
} }
} }
if (prev_scroll_x >= 0.0f && scroll_x != prev_scroll_x && !forced_scroll) { if (prev_scroll_x_ >= 0.0f && scroll_x != prev_scroll_x_ && !forced_scroll) {
if (Buffer *mbuf = const_cast<Buffer *>(buf)) { if (Buffer *mbuf = const_cast<Buffer *>(buf)) {
mbuf->SetOffsets(mbuf->Rowoffs(), mbuf->SetOffsets(mbuf->Rowoffs(),
static_cast<std::size_t>(std::max(0L, scroll_left))); static_cast<std::size_t>(std::max(0L, scroll_left)));
@@ -142,92 +136,170 @@ ImGuiRenderer::Draw(Editor &ed)
} }
// Update trackers for next frame // Update trackers for next frame
prev_scroll_y = scroll_y; prev_scroll_y_ = scroll_y;
prev_scroll_x = scroll_x; prev_scroll_x_ = scroll_x;
} }
prev_buf_rowoffs = buf_rowoffs; prev_buf_rowoffs_ = buf_rowoffs;
prev_buf_coloffs = buf_coloffs; prev_buf_coloffs_ = buf_coloffs;
// Cache current horizontal offset in rendered columns for click handling // Cache current horizontal offset in rendered columns for click handling
const std::size_t coloffs_now = buf->Coloffs(); const std::size_t coloffs_now = buf->Coloffs();
// Handle mouse click before rendering to avoid dependent on drawn items // Mark selection state (mark -> cursor), in source coordinates
if (ImGui::IsWindowHovered() && ImGui::IsMouseClicked(ImGuiMouseButton_Left)) { bool sel_active = false;
std::size_t sel_sy = 0, sel_sx = 0, sel_ey = 0, sel_ex = 0;
if (buf->MarkSet()) {
sel_sy = buf->MarkCury();
sel_sx = buf->MarkCurx();
sel_ey = buf->Cury();
sel_ex = buf->Curx();
if (sel_sy > sel_ey || (sel_sy == sel_ey && sel_sx > sel_ex)) {
std::swap(sel_sy, sel_ey);
std::swap(sel_sx, sel_ex);
}
sel_active = !(sel_sy == sel_ey && sel_sx == sel_ex);
}
// Visual-line selection: full-line highlight range
const bool vsel_active = buf->VisualLineActive();
const std::size_t vsel_sy = vsel_active ? buf->VisualLineStartY() : 0;
const std::size_t vsel_ey = vsel_active ? buf->VisualLineEndY() : 0;
// (mouse_selecting__ is a member variable)
auto mouse_pos_to_buf = [&]() -> std::pair<std::size_t, std::size_t> {
ImVec2 mp = ImGui::GetIO().MousePos; ImVec2 mp = ImGui::GetIO().MousePos;
// Compute content-relative position accounting for scroll // Convert mouse pos to buffer row
// mp.y - child_window_pos.y gives us pixels from top of child window
// Adding scroll_y gives us pixels from top of content (buffer row 0)
float content_y = (mp.y - child_window_pos.y) + scroll_y; float content_y = (mp.y - child_window_pos.y) + scroll_y;
long by_l = static_cast<long>(content_y / row_h); long by_l = static_cast<long>(content_y / row_h);
if (by_l < 0) if (by_l < 0)
by_l = 0; by_l = 0;
// Convert to buffer row
std::size_t by = static_cast<std::size_t>(by_l); std::size_t by = static_cast<std::size_t>(by_l);
if (by >= lines.size()) { if (by >= lines.size())
if (!lines.empty()) by = lines.empty() ? 0 : (lines.size() - 1);
by = lines.size() - 1;
else
by = 0;
}
// Compute click X position relative to left edge of child window (in pixels) if (lines.empty())
// This gives us the visual offset from the start of displayed content return {0, 0};
// Expand tabs for the clicked line
std::string line_clicked = static_cast<std::string>(lines[by]);
const std::size_t tabw = 8;
std::string click_expanded;
click_expanded.reserve(line_clicked.size() + 16);
std::size_t click_rx = 0;
// Map: source column -> expanded column
std::vector<std::size_t> src_to_exp;
src_to_exp.reserve(line_clicked.size() + 1);
for (std::size_t ci = 0; ci < line_clicked.size(); ++ci) {
src_to_exp.push_back(click_rx);
if (line_clicked[ci] == '\t') {
std::size_t adv = (tabw - (click_rx % tabw));
click_expanded.append(adv, ' ');
click_rx += adv;
} else {
click_expanded.push_back(line_clicked[ci]);
click_rx += 1;
}
}
src_to_exp.push_back(click_rx); // past-end position
// Pixel x relative to the line start (accounting for scroll)
float visual_x = mp.x - child_window_pos.x; float visual_x = mp.x - child_window_pos.x;
if (visual_x < 0.0f) if (visual_x < 0.0f)
visual_x = 0.0f; visual_x = 0.0f;
// Add scroll offset in pixels
visual_x += scroll_x;
// Convert visual pixel offset to rendered column, then add coloffs_now // Find the source column whose expanded position is closest
// to get the absolute rendered column in the buffer // to the click pixel, using actual text measurement.
std::size_t clicked_rx = static_cast<std::size_t>(visual_x / space_w) + coloffs_now;
// Empty buffer guard: if there are no lines yet, just move to 0:0
if (lines.empty()) {
Execute(ed, CommandId::MoveCursorTo, std::string("0:0"));
} else {
// Convert rendered column (clicked_rx) to source column accounting for tabs
std::string line_clicked = static_cast<std::string>(lines[by]);
const std::size_t tabw = 8;
// Iterate through source columns, computing rendered position, to find closest match
std::size_t rx = 0; // rendered column position
std::size_t best_col = 0; std::size_t best_col = 0;
float best_dist = std::numeric_limits<float>::infinity(); float best_dist = std::numeric_limits<float>::infinity();
float clicked_rx_f = static_cast<float>(clicked_rx); for (std::size_t ci = 0; ci <= line_clicked.size(); ++ci) {
std::size_t exp_col = src_to_exp[ci];
for (std::size_t i = 0; i <= line_clicked.size(); ++i) { float px = 0.0f;
// Check current position if (exp_col > 0 && !click_expanded.empty()) {
float dist = std::fabs(clicked_rx_f - static_cast<float>(rx)); std::size_t end = std::min(click_expanded.size(), exp_col);
px = ImGui::CalcTextSize(click_expanded.c_str(),
click_expanded.c_str() + end).x;
}
float dist = std::fabs(visual_x - px);
if (dist < best_dist) { if (dist < best_dist) {
best_dist = dist; best_dist = dist;
best_col = i; best_col = ci;
} }
}
return {by, best_col};
};
// Advance to next position if not at end // Mouse-driven selection: set mark on double-click or drag, update cursor on any press/drag
if (i < line_clicked.size()) { if (ImGui::IsWindowHovered() && ImGui::IsMouseClicked(ImGuiMouseButton_Left)) {
if (line_clicked[i] == '\t') { mouse_selecting_ = true;
rx += (tabw - (rx % tabw)); auto [by, bx] = mouse_pos_to_buf();
} else {
rx += 1;
}
}
}
// Dispatch absolute buffer coordinates (row:col)
char tmp[64]; char tmp[64];
std::snprintf(tmp, sizeof(tmp), "%zu:%zu", by, best_col); std::snprintf(tmp, sizeof(tmp), "%zu:%zu", by, bx);
Execute(ed, CommandId::MoveCursorTo, std::string(tmp));
// Only set mark on double click.
// Dragging will also set the mark if not already set (handled below).
if (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left)) {
if (Buffer *mbuf = const_cast<Buffer *>(buf)) {
mbuf->SetMark(bx, by);
}
}
}
if (mouse_selecting_ && ImGui::IsWindowHovered() && ImGui::IsMouseDown(ImGuiMouseButton_Left)) {
auto [by, bx] = mouse_pos_to_buf();
// If we are dragging (mouse moved while down), ensure mark is set to start selection
if (ImGui::IsMouseDragging(ImGuiMouseButton_Left, 1.0f)) {
if (Buffer *mbuf = const_cast<Buffer *>(buf)) {
if (!mbuf->MarkSet()) {
// We'd need to convert click_pos to buf coords, but it's complex here.
// Setting it to where the cursor was *before* we started moving it
// in this frame is a good approximation, or just using current.
mbuf->SetMark(mbuf->Curx(), mbuf->Cury());
}
}
}
char tmp[64];
std::snprintf(tmp, sizeof(tmp), "%zu:%zu", by, bx);
Execute(ed, CommandId::MoveCursorTo, std::string(tmp)); Execute(ed, CommandId::MoveCursorTo, std::string(tmp));
} }
if (mouse_selecting_ && ImGui::IsMouseReleased(ImGuiMouseButton_Left)) {
mouse_selecting_ = false;
} }
for (std::size_t i = rowoffs; i < lines.size(); ++i) { for (std::size_t i = rowoffs; i < lines.size(); ++i) {
// Capture the screen position before drawing the line // Capture the screen position before drawing the line
ImVec2 line_pos = ImGui::GetCursorScreenPos(); ImVec2 line_pos = ImGui::GetCursorScreenPos();
std::string line = static_cast<std::string>(lines[i]); std::string line = static_cast<std::string>(lines[i]);
// Expand tabs to spaces with width=8 and apply horizontal scroll offset // Expand tabs to spaces with width=8
const std::size_t tabw = 8; const std::size_t tabw = 8;
std::string expanded; std::string expanded;
expanded.reserve(line.size() + 16); expanded.reserve(line.size() + 16);
std::size_t rx_abs_draw = 0; // rendered column for drawing std::size_t rx_abs_draw = 0;
for (std::size_t src = 0; src < line.size(); ++src) {
char c = line[src];
if (c == '\t') {
std::size_t adv = (tabw - (rx_abs_draw % tabw));
expanded.append(adv, ' ');
rx_abs_draw += adv;
} else {
expanded.push_back(c);
rx_abs_draw += 1;
}
}
// Helper: convert a rendered column position to pixel x offset
// relative to the visible line start, using actual text measurement
// so proportional fonts render correctly.
auto rx_to_px = [&](std::size_t rx_col) -> float {
if (rx_col <= coloffs_now)
return 0.0f;
std::size_t start = coloffs_now;
std::size_t end = std::min(expanded.size(), rx_col);
if (start >= expanded.size() || end <= start)
return 0.0f;
return ImGui::CalcTextSize(expanded.c_str() + start,
expanded.c_str() + end).x;
};
// Compute search highlight ranges for this line in source indices // Compute search highlight ranges for this line in source indices
bool search_mode = ed.SearchActive() && !ed.SearchQuery().empty(); bool search_mode = ed.SearchActive() && !ed.SearchQuery().empty();
std::vector<std::pair<std::size_t, std::size_t> > hl_src_ranges; std::vector<std::pair<std::size_t, std::size_t> > hl_src_ranges;
@@ -282,10 +354,8 @@ ImGuiRenderer::Draw(Editor &ed)
// Apply horizontal scroll offset // Apply horizontal scroll offset
if (rx_end <= coloffs_now) if (rx_end <= coloffs_now)
continue; // fully left of view continue; // fully left of view
std::size_t vx0 = (rx_start > coloffs_now) ? (rx_start - coloffs_now) : 0; ImVec2 p0 = ImVec2(line_pos.x + rx_to_px(rx_start), line_pos.y);
std::size_t vx1 = rx_end - coloffs_now; ImVec2 p1 = ImVec2(line_pos.x + rx_to_px(rx_end),
ImVec2 p0 = ImVec2(line_pos.x + static_cast<float>(vx0) * space_w, line_pos.y);
ImVec2 p1 = ImVec2(line_pos.x + static_cast<float>(vx1) * space_w,
line_pos.y + line_h); line_pos.y + line_h);
// Choose color: current match stronger // Choose color: current match stronger
bool is_current = has_current && sx == cur_x && ex == cur_end; bool is_current = has_current && sx == cur_x && ex == cur_end;
@@ -295,19 +365,63 @@ ImGuiRenderer::Draw(Editor &ed)
ImGui::GetWindowDrawList()->AddRectFilled(p0, p1, col); ImGui::GetWindowDrawList()->AddRectFilled(p0, p1, col);
} }
} }
// Emit entire line to an expanded buffer (tabs -> spaces)
for (std::size_t src = 0; src < line.size(); ++src) {
char c = line[src];
if (c == '\t') {
std::size_t adv = (tabw - (rx_abs_draw % tabw));
expanded.append(adv, ' ');
rx_abs_draw += adv;
} else {
expanded.push_back(c);
rx_abs_draw += 1;
}
}
// Draw selection background (over search highlight; under text)
if (sel_active) {
bool line_has = false;
std::size_t sx = 0, ex = 0;
if (i < sel_sy || i > sel_ey) {
line_has = false;
} else if (sel_sy == sel_ey) {
sx = sel_sx;
ex = sel_ex;
line_has = ex > sx;
} else if (i == sel_sy) {
sx = sel_sx;
ex = line.size();
line_has = ex > sx;
} else if (i == sel_ey) {
sx = 0;
ex = std::min(sel_ex, line.size());
line_has = ex > sx;
} else {
sx = 0;
ex = line.size();
line_has = ex > sx;
}
if (line_has) {
std::size_t rx_start = src_to_rx(sx);
std::size_t rx_end = src_to_rx(ex);
if (rx_end > coloffs_now) {
ImVec2 p0 = ImVec2(line_pos.x + rx_to_px(rx_start),
line_pos.y);
ImVec2 p1 = ImVec2(line_pos.x + rx_to_px(rx_end),
line_pos.y + line_h);
ImU32 col = ImGui::GetColorU32(ImGuiCol_TextSelectedBg);
ImGui::GetWindowDrawList()->AddRectFilled(p0, p1, col);
}
}
}
if (vsel_active && i >= vsel_sy && i <= vsel_ey) {
// Visual-line (multi-cursor) mode: highlight only the per-line cursor spot.
const std::size_t spot_sx = std::min(buf->Curx(), line.size());
const std::size_t rx_start = src_to_rx(spot_sx);
std::size_t rx_end = rx_start;
if (spot_sx < line.size()) {
rx_end = src_to_rx(spot_sx + 1);
} else {
// EOL spot: draw a 1-cell highlight just past the last character.
rx_end = rx_start + 1;
}
if (rx_end > coloffs_now) {
ImVec2 p0 = ImVec2(line_pos.x + rx_to_px(rx_start),
line_pos.y);
ImVec2 p1 = ImVec2(line_pos.x + rx_to_px(rx_end),
line_pos.y + line_h);
ImU32 col = ImGui::GetColorU32(ImGuiCol_TextSelectedBg);
ImGui::GetWindowDrawList()->AddRectFilled(p0, p1, col);
}
}
// Draw syntax-colored runs (text above background highlights) // Draw syntax-colored runs (text above background highlights)
if (buf->SyntaxEnabled() && buf->Highlighter() && buf->Highlighter()->HasHighlighter()) { if (buf->SyntaxEnabled() && buf->Highlighter() && buf->Highlighter()->HasHighlighter()) {
kte::LineHighlight lh = buf->Highlighter()->GetLine( kte::LineHighlight lh = buf->Highlighter()->GetLine(
@@ -359,10 +473,9 @@ ImGuiRenderer::Draw(Editor &ed)
std::size_t draw_end = std::min<std::size_t>(rx_e, expanded.size()); std::size_t draw_end = std::min<std::size_t>(rx_e, expanded.size());
if (draw_end <= draw_start) if (draw_end <= draw_start)
continue; continue;
// Screen position is relative to coloffs_now // Screen position via actual text measurement
std::size_t screen_x = draw_start - coloffs_now;
ImU32 col = ImGui::GetColorU32(kte::SyntaxInk(sp.k)); ImU32 col = ImGui::GetColorU32(kte::SyntaxInk(sp.k));
ImVec2 p = ImVec2(line_pos.x + static_cast<float>(screen_x) * space_w, ImVec2 p = ImVec2(line_pos.x + rx_to_px(draw_start),
line_pos.y); line_pos.y);
ImGui::GetWindowDrawList()->AddText( ImGui::GetWindowDrawList()->AddText(
p, col, expanded.c_str() + draw_start, expanded.c_str() + draw_end); p, col, expanded.c_str() + draw_start, expanded.c_str() + draw_end);
@@ -386,28 +499,8 @@ ImGuiRenderer::Draw(Editor &ed)
// Draw a visible cursor indicator on the current line // Draw a visible cursor indicator on the current line
if (i == cy) { if (i == cy) {
// Compute rendered X (rx) from source column with tab expansion std::size_t rx_abs = src_to_rx(cx);
std::size_t rx_abs = 0; float cursor_px = rx_to_px(rx_abs);
for (std::size_t k = 0; k < std::min(cx, line.size()); ++k) {
if (line[k] == '\t')
rx_abs += (tabw - (rx_abs % tabw));
else
rx_abs += 1;
}
// Convert to viewport x by subtracting horizontal col offset
std::size_t rx_viewport = (rx_abs > coloffs_now) ? (rx_abs - coloffs_now) : 0;
// For proportional fonts (Linux GUI), avoid accumulating drift by computing
// the exact pixel width of the expanded substring up to the cursor.
// expanded contains the line with tabs expanded to spaces and is what we draw.
float cursor_px = 0.0f;
if (rx_viewport > 0 && coloffs_now < expanded.size()) {
std::size_t start = coloffs_now;
std::size_t end = std::min(expanded.size(), start + rx_viewport);
// Measure substring width in pixels
ImVec2 sz = ImGui::CalcTextSize(expanded.c_str() + start,
expanded.c_str() + end);
cursor_px = sz.x;
}
ImVec2 p0 = ImVec2(line_pos.x + cursor_px, line_pos.y); ImVec2 p0 = ImVec2(line_pos.x + cursor_px, line_pos.y);
ImVec2 p1 = ImVec2(p0.x + space_w, p0.y + line_h); ImVec2 p1 = ImVec2(p0.x + space_w, p0.y + line_h);
ImU32 col = IM_COL32(200, 200, 255, 128); // soft highlight ImU32 col = IM_COL32(200, 200, 255, 128); // soft highlight
@@ -453,29 +546,40 @@ ImGuiRenderer::Draw(Editor &ed)
last_row = first_row + vis_rows - 1; last_row = first_row + vis_rows - 1;
} }
// Horizontal scroll: ensure cursor column is visible // Horizontal scroll: ensure cursor is visible (pixel-based for proportional fonts)
long vis_cols = static_cast<long>(std::round(child_w_actual / space_w)); float cursor_px_abs = 0.0f;
if (vis_cols < 1)
vis_cols = 1;
long first_col = static_cast<long>(scroll_x_now / space_w);
long last_col = first_col + vis_cols - 1;
std::size_t cursor_rx = 0;
if (cy < lines.size()) { if (cy < lines.size()) {
std::string cur_line = static_cast<std::string>(lines[cy]); std::string cur_line = static_cast<std::string>(lines[cy]);
const std::size_t tabw = 8; const std::size_t tabw = 8;
for (std::size_t i = 0; i < cx && i < cur_line.size(); ++i) { // Expand tabs for cursor line to measure pixel position
if (cur_line[i] == '\t') { std::string cur_expanded;
cursor_rx += tabw - (cursor_rx % tabw); cur_expanded.reserve(cur_line.size() + 16);
std::size_t cur_rx = 0;
for (std::size_t ci = 0; ci < cur_line.size(); ++ci) {
if (cur_line[ci] == '\t') {
std::size_t adv = tabw - (cur_rx % tabw);
cur_expanded.append(adv, ' ');
cur_rx += adv;
} else { } else {
cur_expanded.push_back(cur_line[ci]);
cur_rx += 1;
}
}
// Compute rendered column of cursor
std::size_t cursor_rx = 0;
for (std::size_t ci = 0; ci < cx && ci < cur_line.size(); ++ci) {
if (cur_line[ci] == '\t')
cursor_rx += tabw - (cursor_rx % tabw);
else
cursor_rx += 1; cursor_rx += 1;
} }
std::size_t exp_end = std::min(cur_expanded.size(), cursor_rx);
if (exp_end > 0)
cursor_px_abs = ImGui::CalcTextSize(cur_expanded.c_str(),
cur_expanded.c_str() + exp_end).x;
} }
} if (cursor_px_abs < scroll_x_now || cursor_px_abs > scroll_x_now + child_w_actual) {
long cxr = static_cast<long>(cursor_rx); float target_x = cursor_px_abs - (child_w_actual / 2.0f);
if (cxr < first_col || cxr > last_col) {
float target_x = static_cast<float>(cxr) * space_w;
target_x -= (child_w_actual / 2.0f);
if (target_x < 0.f) if (target_x < 0.f)
target_x = 0.f; target_x = 0.f;
float max_x = ImGui::GetScrollMaxX(); float max_x = ImGui::GetScrollMaxX();
@@ -836,12 +940,8 @@ ImGuiRenderer::Draw(Editor &ed)
ed.SetFilePickerDir(e.path.string()); ed.SetFilePickerDir(e.path.string());
} else if (!e.is_dir && ImGui::IsMouseClicked(ImGuiMouseButton_Left)) { } else if (!e.is_dir && ImGui::IsMouseClicked(ImGuiMouseButton_Left)) {
// Open file on single click // Open file on single click
std::string err; ed.RequestOpenFile(e.path.string());
if (!ed.OpenFile(e.path.string(), err)) { (void) ed.ProcessPendingOpens();
ed.SetStatus(std::string("open: ") + err);
} else {
ed.SetStatus(std::string("Opened: ") + e.name);
}
ed.SetFilePickerVisible(false); ed.SetFilePickerVisible(false);
} }
} }

View File

@@ -11,4 +11,13 @@ public:
~ImGuiRenderer() override = default; ~ImGuiRenderer() override = default;
void Draw(Editor &ed) override; void Draw(Editor &ed) override;
private:
// Per-window scroll tracking for two-way sync between Buffer offsets and ImGui scroll.
// These must be per-instance (not static) so each window maintains independent state.
long prev_buf_rowoffs_ = -1;
long prev_buf_coloffs_ = -1;
float prev_scroll_y_ = -1.0f;
float prev_scroll_x_ = -1.0f;
bool mouse_selecting_ = false;
}; };

View File

@@ -17,6 +17,9 @@ KLookupKCommand(const int ascii_key, const bool ctrl, CommandId &out) -> bool
case 'd': case 'd':
out = CommandId::KillLine; out = CommandId::KillLine;
return true; return true;
case 's':
out = CommandId::Save;
return true;
case 'q': case 'q':
out = CommandId::QuitNow; out = CommandId::QuitNow;
return true; return true;
@@ -42,6 +45,9 @@ KLookupKCommand(const int ascii_key, const bool ctrl, CommandId &out) -> bool
case 'a': case 'a':
out = CommandId::MarkAllAndJumpEnd; out = CommandId::MarkAllAndJumpEnd;
return true; return true;
case ' ': // C-k SPACE
out = CommandId::ToggleMark;
return true;
case 'i': case 'i':
out = CommandId::BufferNew; // C-k i new empty buffer out = CommandId::BufferNew; // C-k i new empty buffer
return true; return true;
@@ -78,6 +84,9 @@ KLookupKCommand(const int ascii_key, const bool ctrl, CommandId &out) -> bool
case 'l': case 'l':
out = CommandId::ReloadBuffer; out = CommandId::ReloadBuffer;
return true; return true;
case 'm':
out = CommandId::ToggleEditMode;
return true;
case 'n': case 'n':
out = CommandId::BufferPrev; out = CommandId::BufferPrev;
return true; return true;
@@ -114,6 +123,9 @@ KLookupKCommand(const int ascii_key, const bool ctrl, CommandId &out) -> bool
case '=': case '=':
out = CommandId::IndentRegion; out = CommandId::IndentRegion;
return true; return true;
case '/':
out = CommandId::VisualLineModeToggle;
return true;
case ';': case ';':
out = CommandId::CommandPromptStart; // C-k ; : generic command prompt out = CommandId::CommandPromptStart; // C-k ; : generic command prompt
return true; return true;
@@ -217,6 +229,10 @@ KLookupEscCommand(const int ascii_key, CommandId &out) -> bool
case 'q': case 'q':
out = CommandId::ReflowParagraph; // Esc q (reflow paragraph) out = CommandId::ReflowParagraph; // Esc q (reflow paragraph)
return true; return true;
case '\n':
case '\r':
out = CommandId::SmartNewline; // Shift+Enter (some terminals send this as Alt+Enter sequences)
return true;
default: default:
break; break;
} }

View File

@@ -273,6 +273,7 @@ PieceTable::addPieceFront(Source src, std::size_t start, std::size_t len)
void void
PieceTable::materialize() const PieceTable::materialize() const
{ {
std::lock_guard<std::mutex> lock(mutex_);
if (!dirty_) { if (!dirty_) {
return; return;
} }
@@ -348,6 +349,7 @@ PieceTable::coalesceNeighbors(std::size_t index)
void void
PieceTable::InvalidateLineIndex() const PieceTable::InvalidateLineIndex() const
{ {
std::lock_guard<std::mutex> lock(mutex_);
line_index_dirty_ = true; line_index_dirty_ = true;
} }
@@ -355,22 +357,29 @@ PieceTable::InvalidateLineIndex() const
void void
PieceTable::RebuildLineIndex() const PieceTable::RebuildLineIndex() const
{ {
if (!line_index_dirty_) std::lock_guard<std::mutex> lock(mutex_);
if (!line_index_dirty_) {
return; return;
}
line_index_.clear(); line_index_.clear();
line_index_.push_back(0); line_index_.push_back(0);
std::size_t pos = 0; std::size_t pos = 0;
for (const auto &pc: pieces_) { for (const auto &pc: pieces_) {
const std::string &src = pc.src == Source::Original ? original_ : add_; const std::string &src = pc.src == Source::Original ? original_ : add_;
const char *base = src.data() + static_cast<std::ptrdiff_t>(pc.start); const char *base = src.data() + static_cast<std::ptrdiff_t>(pc.start);
for (std::size_t j = 0; j < pc.len; ++j) { for (std::size_t j = 0; j < pc.len; ++j) {
if (base[j] == '\n') { if (base[j] == '\n') {
// next line starts after the newline // next line starts after the newline
line_index_.push_back(pos + j + 1); line_index_.push_back(pos + j + 1);
} }
} }
pos += pc.len; pos += pc.len;
} }
line_index_dirty_ = false; line_index_dirty_ = false;
} }
@@ -692,14 +701,18 @@ PieceTable::GetRange(std::size_t byte_offset, std::size_t len) const
len = total_size_ - byte_offset; len = total_size_ - byte_offset;
// Fast path: return cached value if version/offset/len match // Fast path: return cached value if version/offset/len match
{
std::lock_guard<std::mutex> lock(mutex_);
if (range_cache_.valid && range_cache_.version == version_ && if (range_cache_.valid && range_cache_.version == version_ &&
range_cache_.off == byte_offset && range_cache_.len == len) { range_cache_.off == byte_offset && range_cache_.len == len) {
return range_cache_.data; return range_cache_.data;
} }
}
std::string out; std::string out;
out.reserve(len); out.reserve(len);
if (!dirty_) { if (!dirty_) {
std::lock_guard<std::mutex> lock(mutex_);
// Already materialized; slice directly // Already materialized; slice directly
out.assign(materialized_.data() + static_cast<std::ptrdiff_t>(byte_offset), len); out.assign(materialized_.data() + static_cast<std::ptrdiff_t>(byte_offset), len);
} else { } else {
@@ -723,11 +736,14 @@ PieceTable::GetRange(std::size_t byte_offset, std::size_t len) const
} }
// Update cache // Update cache
{
std::lock_guard<std::mutex> lock(mutex_);
range_cache_.valid = true; range_cache_.valid = true;
range_cache_.version = version_; range_cache_.version = version_;
range_cache_.off = byte_offset; range_cache_.off = byte_offset;
range_cache_.len = len; range_cache_.len = len;
range_cache_.data = out; range_cache_.data = out;
}
return out; return out;
} }
@@ -739,15 +755,21 @@ PieceTable::Find(const std::string &needle, std::size_t start) const
return start <= total_size_ ? start : std::numeric_limits<std::size_t>::max(); return start <= total_size_ ? start : std::numeric_limits<std::size_t>::max();
if (start > total_size_) if (start > total_size_)
return std::numeric_limits<std::size_t>::max(); return std::numeric_limits<std::size_t>::max();
{
std::lock_guard<std::mutex> lock(mutex_);
if (find_cache_.valid && if (find_cache_.valid &&
find_cache_.version == version_ && find_cache_.version == version_ &&
find_cache_.needle == needle && find_cache_.needle == needle &&
find_cache_.start == start) { find_cache_.start == start) {
return find_cache_.result; return find_cache_.result;
} }
}
materialize(); materialize();
auto pos = materialized_.find(needle, start); std::size_t pos;
{
std::lock_guard<std::mutex> lock(mutex_);
pos = materialized_.find(needle, start);
if (pos == std::string::npos) if (pos == std::string::npos)
pos = std::numeric_limits<std::size_t>::max(); pos = std::numeric_limits<std::size_t>::max();
// Update cache // Update cache
@@ -756,6 +778,7 @@ PieceTable::Find(const std::string &needle, std::size_t start) const
find_cache_.needle = needle; find_cache_.needle = needle;
find_cache_.start = start; find_cache_.start = start;
find_cache_.result = pos; find_cache_.result = pos;
}
return pos; return pos;
} }
@@ -764,6 +787,9 @@ void
PieceTable::WriteToStream(std::ostream &out) const PieceTable::WriteToStream(std::ostream &out) const
{ {
// Stream the content piece-by-piece without forcing full materialization // Stream the content piece-by-piece without forcing full materialization
// No lock needed for original_ and add_ if they are not being modified.
// Since this is a const method and kte's piece table isn't modified by multiple threads
// (only queried), we just iterate pieces_.
for (const auto &p: pieces_) { for (const auto &p: pieces_) {
if (p.len == 0) if (p.len == 0)
continue; continue;

View File

@@ -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>
@@ -8,6 +42,7 @@
#include <ostream> #include <ostream>
#include <vector> #include <vector>
#include <limits> #include <limits>
#include <mutex>
class PieceTable { class PieceTable {
@@ -181,4 +216,6 @@ private:
mutable RangeCache range_cache_; mutable RangeCache range_cache_;
mutable FindCache find_cache_; mutable FindCache find_cache_;
mutable std::mutex mutex_;
}; };

View File

@@ -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();
@@ -658,10 +656,8 @@ private:
} // namespace } // namespace
bool bool
GUIFrontend::Init(Editor &ed) GUIFrontend::Init(int &argc, char **argv, Editor &ed)
{ {
int argc = 0;
char **argv = nullptr;
app_ = new QApplication(argc, argv); app_ = new QApplication(argc, argv);
window_ = new MainWindow(input_); window_ = new MainWindow(input_);
@@ -777,6 +773,9 @@ GUIFrontend::Step(Editor &ed, bool &running)
if (app_) if (app_)
app_->processEvents(); app_->processEvents();
// Allow deferred opens (including swap recovery prompts) to run.
ed.ProcessPendingOpens();
// Drain input queue // Drain input queue
for (;;) { for (;;) {
MappedInput mi; MappedInput mi;
@@ -803,14 +802,8 @@ GUIFrontend::Step(Editor &ed, bool &running)
const QStringList files = dlg.selectedFiles(); const QStringList files = dlg.selectedFiles();
if (!files.isEmpty()) { if (!files.isEmpty()) {
const QString fp = files.front(); const QString fp = files.front();
std::string err; ed.RequestOpenFile(fp.toStdString());
if (ed.OpenFile(fp.toStdString(), err)) { (void) ed.ProcessPendingOpens();
ed.SetStatus(std::string("Opened: ") + fp.toStdString());
} else if (!err.empty()) {
ed.SetStatus(std::string("Open failed: ") + err);
} else {
ed.SetStatus("Open failed");
}
// Update picker dir for next time // Update picker dir for next time
QFileInfo info(fp); QFileInfo info(fp);
ed.SetFilePickerDir(info.dir().absolutePath().toStdString()); ed.SetFilePickerDir(info.dir().absolutePath().toStdString());

View File

@@ -18,7 +18,7 @@ public:
~GUIFrontend() override = default; ~GUIFrontend() override = default;
bool Init(Editor &ed) override; bool Init(int &argc, char **argv, Editor &ed) override;
void Step(Editor &ed, bool &running) override; void Step(Editor &ed, bool &running) override;

View File

@@ -287,8 +287,7 @@ QtInputHandler::ProcessKeyEvent(const QKeyEvent &e)
-> ->
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) {

View File

@@ -32,27 +32,27 @@ Project Goals
Keybindings Keybindings
----------- -----------
kte maintains kes command model while internals evolve. Highlights (subject to refinement): kte maintains kes command model while internals evolve. Highlights (
subject to refinement):
- Kcommand prefix: `C-k` enters kcommand mode; exit with `ESC` or - Kcommand prefix: `C-k` enters kcommand mode; exit with `ESC` or
`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.
Build and Run Build and Run
------------- -------------
Prerequisites: C++17 compiler, CMake, and ncurses development headers/libs. Prerequisites: C++20 compiler, CMake, and ncurses development
headers/libs.
Dependencies by platform Dependencies by platform
------------------------ ------------------------
@@ -62,30 +62,38 @@ Dependencies by platform
- `brew install ncurses` - `brew install ncurses`
- Optional GUI (enable with `-DBUILD_GUI=ON`): - Optional GUI (enable with `-DBUILD_GUI=ON`):
- `brew install sdl2 freetype` - `brew install sdl2 freetype`
- OpenGL is provided by the system framework on macOS; no package needed. - OpenGL is provided by the system framework on macOS; no
package needed.
- Debian/Ubuntu - Debian/Ubuntu
- 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` -
- The `mesa-common-dev` package provides OpenGL headers/libs (`libGL`). `sudo apt-get install -y libsdl2-dev libfreetype6-dev mesa-common-dev`
- The `mesa-common-dev` package provides OpenGL headers/libs (
`libGL`).
- NixOS/Nix - NixOS/Nix
- Terminal (default): - Terminal (default):
- Ad-hoc shell: `nix-shell -p cmake gcc ncurses` - Ad-hoc shell: `nix-shell -p cmake gcc ncurses`
- Optional GUI (enable with `-DBUILD_GUI=ON`): - Optional GUI (enable with `-DBUILD_GUI=ON`):
- Ad-hoc shell: `nix-shell -p cmake gcc ncurses SDL2 freetype libGL` - Ad-hoc shell:
- With flakes/devshell (example `flake.nix` inputs not provided): include `nix-shell -p cmake gcc ncurses SDL2 freetype libGL`
`ncurses` for TUI, and `SDL2`, `freetype`, `libGL` for GUI in your devShell. - With flakes/devshell (example `flake.nix` inputs not provided):
include
`ncurses` for TUI, and `SDL2`, `freetype`, `libGL` for GUI in your
devShell.
Notes Notes
----- -----
- The GUI is OFF by default to keep SDL/OpenGL/Freetype optional. Enable it by - The GUI is OFF by default to keep SDL/OpenGL/Freetype optional. Enable
it by
configuring with `-DBUILD_GUI=ON` and ensuring the GUI deps above are configuring with `-DBUILD_GUI=ON` and ensuring the GUI deps above are
installed for your platform. installed for your platform.
- If you previously configured with GUI ON and want to disable it, reconfigure - If you previously configured with GUI ON and want to disable it,
reconfigure
the build directory with `-DBUILD_GUI=OFF`. the build directory with `-DBUILD_GUI=OFF`.
Example build: Example build:
@@ -113,7 +121,8 @@ built as `kge`) or request the GUI from `kte`:
GUI build example GUI build example
----------------- -----------------
To build with the optional GUI (after installing the GUI dependencies listed above): To build with the optional GUI (after installing the GUI dependencies
listed above):
``` ```
cmake -S . -B cmake-build-debug -DCMAKE_BUILD_TYPE=Debug -DBUILD_GUI=ON cmake -S . -B cmake-build-debug -DCMAKE_BUILD_TYPE=Debug -DBUILD_GUI=ON

1308
Swap.cc

File diff suppressed because it is too large Load Diff

174
Swap.h
View File

@@ -7,11 +7,16 @@
#include <string_view> #include <string_view>
#include <vector> #include <vector>
#include <unordered_map> #include <unordered_map>
#include <memory>
#include <mutex> #include <mutex>
#include <condition_variable> #include <condition_variable>
#include <deque>
#include <thread> #include <thread>
#include <atomic> #include <atomic>
#include "SwapRecorder.h"
#include "ErrorRecovery.h"
class Buffer; class Buffer;
namespace kte { namespace kte {
@@ -29,50 +34,88 @@ struct SwapConfig {
// Grouping and durability knobs (stage 1 defaults) // Grouping and durability knobs (stage 1 defaults)
unsigned flush_interval_ms{200}; // group small writes unsigned flush_interval_ms{200}; // group small writes
unsigned fsync_interval_ms{1000}; // at most once per second unsigned fsync_interval_ms{1000}; // at most once per second
};
// Lightweight interface that Buffer can call without depending on full manager impl // Checkpoint/compaction knobs (stage 2 defaults)
class SwapRecorder { // A checkpoint is a full snapshot of the buffer content written as a CHKPT record.
public: // Compaction rewrites the swap file to contain just the latest checkpoint.
virtual ~SwapRecorder() = default; std::size_t checkpoint_bytes{1024 * 1024}; // request checkpoint after this many queued edit-bytes
unsigned checkpoint_interval_ms{60000}; // request checkpoint at least this often while editing
std::size_t compact_bytes{8 * 1024 * 1024}; // compact on checkpoint once journal grows beyond this
virtual void RecordInsert(Buffer &buf, int row, int col, std::string_view text) = 0; // Cleanup / retention (best-effort)
bool prune_on_startup{true};
virtual void RecordDelete(Buffer &buf, int row, int col, std::size_t len) = 0; unsigned prune_max_age_days{30};
std::size_t prune_max_files{2048};
virtual void RecordSplit(Buffer &buf, int row, int col) = 0;
virtual void RecordJoin(Buffer &buf, int row) = 0;
virtual void NotifyFilenameChanged(Buffer &buf) = 0;
virtual void SetSuspended(Buffer &buf, bool on) = 0;
}; };
// SwapManager manages sidecar swap files and a single background writer thread. // SwapManager manages sidecar swap files and a single background writer thread.
class SwapManager final : public SwapRecorder { class SwapManager final {
public: public:
SwapManager(); SwapManager();
~SwapManager() override; ~SwapManager();
// Attach a buffer to begin journaling. Safe to call multiple times; idempotent. // Attach a buffer to begin journaling. Safe to call multiple times; idempotent.
void Attach(Buffer *buf); void Attach(Buffer *buf);
// Detach and close journal. // Detach and close journal.
void Detach(Buffer *buf); // If remove_file is true, the swap file is deleted after closing.
// Intended for clean shutdown/close flows.
void Detach(Buffer *buf, bool remove_file = false);
// SwapRecorder: Notify that the buffer's filename changed (e.g., SaveAs) // Reset (truncate-by-delete) the journal for a buffer after a clean save.
void NotifyFilenameChanged(Buffer &buf) override; // Best-effort: closes the current fd, deletes the swap file, and resumes recording.
void ResetJournal(Buffer &buf);
// SwapRecorder // Best-effort pruning of old swap files under the swap directory.
void RecordInsert(Buffer &buf, int row, int col, std::string_view text) override; // Never touches non-`.swp` files.
void PruneSwapDir();
void RecordDelete(Buffer &buf, int row, int col, std::size_t len) override; // Block until all currently queued records have been written.
// If buf is non-null, flushes all records (stage 1) but is primarily intended
// for tests and shutdown.
void Flush(Buffer *buf = nullptr);
void RecordSplit(Buffer &buf, int row, int col) override; // Request a full-content checkpoint record for one buffer (or all buffers if buf is null).
// This is best-effort and asynchronous; call Flush() if you need it written before continuing.
void Checkpoint(Buffer *buf = nullptr);
void RecordJoin(Buffer &buf, int row) override;
void SetConfig(const SwapConfig &cfg)
{
std::lock_guard<std::mutex> lg(mtx_);
cfg_ = cfg;
cv_.notify_one();
}
// Obtain a per-buffer recorder adapter that emits records for that buffer.
// The returned pointer is owned by the SwapManager and remains valid until
// Detach(buf) or SwapManager destruction.
SwapRecorder *RecorderFor(Buffer *buf);
// Notify that the buffer's filename changed (e.g., SaveAs)
void NotifyFilenameChanged(Buffer &buf);
// Replay a swap journal into an already-open buffer.
// On success, the buffer content reflects all valid journal records.
// On failure (corrupt/truncated/invalid), the buffer is left in whatever
// state results from applying records up to the failure point; callers should
// treat this as a recovery failure and surface `err`.
static bool ReplayFile(Buffer &buf, const std::string &swap_path, std::string &err);
// Compute the swap path for a file-backed buffer by filename.
// Returns empty string if filename is empty.
static std::string ComputeSwapPathForFilename(const std::string &filename);
// Test-only hook to keep swap path logic centralized.
// (Avoid duplicating naming rules in unit tests.)
#ifdef KTE_TESTS
static std::string ComputeSwapPathForTests(const Buffer &buf)
{
return ComputeSidecarPath(buf);
}
#endif
// RAII guard to suspend recording for internal operations // RAII guard to suspend recording for internal operations
class SuspendGuard { class SuspendGuard {
@@ -88,17 +131,58 @@ public:
}; };
// Per-buffer toggle // Per-buffer toggle
void SetSuspended(Buffer &buf, bool on) override; void SetSuspended(Buffer &buf, bool on);
// Error reporting for background thread
struct SwapError {
std::uint64_t timestamp_ns{0};
std::string message;
std::string buffer_name; // filename or "<unnamed>"
};
// Query error state (thread-safe)
bool HasErrors() const;
std::string GetLastError() const;
std::size_t GetErrorCount() const;
private: private:
class BufferRecorder final : public SwapRecorder {
public:
BufferRecorder(SwapManager &m, Buffer &b) : m_(m), buf_(b) {}
void OnInsert(int row, int col, std::string_view bytes) override;
void OnDelete(int row, int col, std::size_t len) override;
private:
SwapManager &m_;
Buffer &buf_;
};
void RecordInsert(Buffer &buf, int row, int col, std::string_view text);
void RecordDelete(Buffer &buf, int row, int col, std::size_t len);
void RecordSplit(Buffer &buf, int row, int col);
void RecordJoin(Buffer &buf, int row);
void RecordCheckpoint(Buffer &buf, bool urgent_flush);
void maybe_request_checkpoint(Buffer &buf, std::size_t approx_edit_bytes);
struct JournalCtx { struct JournalCtx {
std::string path; std::string path;
void *file{nullptr}; // FILE*
int fd{-1}; int fd{-1};
bool header_ok{false}; bool header_ok{false};
bool suspended{false}; bool suspended{false};
std::uint64_t last_flush_ns{0}; std::uint64_t last_flush_ns{0};
std::uint64_t last_fsync_ns{0}; std::uint64_t last_fsync_ns{0};
std::uint64_t last_chkpt_ns{0};
std::uint64_t edit_bytes_since_chkpt{0};
std::uint64_t approx_size_bytes{0};
}; };
struct Pending { struct Pending {
@@ -106,26 +190,36 @@ private:
SwapRecType type{SwapRecType::INS}; SwapRecType type{SwapRecType::INS};
std::vector<std::uint8_t> payload; // framed payload only std::vector<std::uint8_t> payload; // framed payload only
bool urgent_flush{false}; bool urgent_flush{false};
std::uint64_t seq{0};
}; };
// Helpers // Helpers
static std::string ComputeSidecarPath(const Buffer &buf); static std::string ComputeSidecarPath(const Buffer &buf);
static std::string ComputeSidecarPathForFilename(const std::string &filename);
static std::uint64_t now_ns(); static std::uint64_t now_ns();
static bool ensure_parent_dir(const std::string &path); static bool ensure_parent_dir(const std::string &path);
static bool write_header(JournalCtx &ctx); static std::string SwapDirRoot();
static bool open_ctx(JournalCtx &ctx); static bool write_header(int fd);
static bool open_ctx(JournalCtx &ctx, const std::string &path, std::string &err);
static void close_ctx(JournalCtx &ctx); static void close_ctx(JournalCtx &ctx);
static bool compact_to_checkpoint(JournalCtx &ctx, const std::vector<std::uint8_t> &chkpt_record,
std::string &err);
static std::uint32_t crc32(const std::uint8_t *data, std::size_t len, std::uint32_t seed = 0); static std::uint32_t crc32(const std::uint8_t *data, std::size_t len, std::uint32_t seed = 0);
static void put_varu64(std::vector<std::uint8_t> &out, std::uint64_t v); static void put_le32(std::vector<std::uint8_t> &out, std::uint32_t v);
static void put_u24(std::uint8_t dst[3], std::uint32_t v); static void put_le64(std::uint8_t dst[8], std::uint64_t v);
static void put_u24_le(std::uint8_t dst[3], std::uint32_t v);
void enqueue(Pending &&p); void enqueue(Pending &&p);
@@ -133,13 +227,27 @@ private:
void process_one(const Pending &p); void process_one(const Pending &p);
// Error reporting helper (called from writer thread)
void report_error(const std::string &message, Buffer *buf = nullptr);
// State // State
SwapConfig cfg_{}; SwapConfig cfg_{};
std::unordered_map<Buffer *, JournalCtx> journals_; std::unordered_map<Buffer *, JournalCtx> journals_;
std::mutex mtx_; std::unordered_map<Buffer *, std::unique_ptr<BufferRecorder> > recorders_;
mutable std::mutex mtx_;
std::condition_variable cv_; std::condition_variable cv_;
std::vector<Pending> queue_; std::vector<Pending> queue_;
std::uint64_t next_seq_{0};
std::uint64_t last_processed_{0};
std::uint64_t inflight_{0};
std::atomic<bool> running_{false}; std::atomic<bool> running_{false};
std::thread worker_; std::thread worker_;
// Error tracking (protected by mtx_)
std::deque<SwapError> errors_; // bounded to max 100 entries
std::size_t total_error_count_{0};
// Circuit breaker for swap operations (protected by mtx_)
CircuitBreaker circuit_breaker_;
}; };
} // namespace kte } // namespace kte

19
SwapRecorder.h Normal file
View File

@@ -0,0 +1,19 @@
// SwapRecorder.h - minimal swap journal recording interface for Buffer mutations
#pragma once
#include <cstddef>
#include <string_view>
namespace kte {
// SwapRecorder is a tiny, non-blocking callback interface.
// Implementations must return quickly; Buffer calls these hooks after a
// mutation succeeds.
class SwapRecorder {
public:
virtual ~SwapRecorder() = default;
virtual void OnInsert(int row, int col, std::string_view bytes) = 0;
virtual void OnDelete(int row, int col, std::size_t len) = 0;
};
} // namespace kte

76
SyscallWrappers.cc Normal file
View File

@@ -0,0 +1,76 @@
#include "SyscallWrappers.h"
#include <fcntl.h>
#include <unistd.h>
#include <sys/stat.h>
#include <cerrno>
#include <cstdlib>
namespace kte {
namespace syscall {
int
Open(const char *path, int flags, mode_t mode)
{
int fd;
do {
fd = ::open(path, flags, mode);
} while (fd == -1 && errno == EINTR);
return fd;
}
int
Close(int fd)
{
int ret;
do {
ret = ::close(fd);
} while (ret == -1 && errno == EINTR);
return ret;
}
int
Fsync(int fd)
{
int ret;
do {
ret = ::fsync(fd);
} while (ret == -1 && errno == EINTR);
return ret;
}
int
Fstat(int fd, struct stat *buf)
{
int ret;
do {
ret = ::fstat(fd, buf);
} while (ret == -1 && errno == EINTR);
return ret;
}
int
Fchmod(int fd, mode_t mode)
{
int ret;
do {
ret = ::fchmod(fd, mode);
} while (ret == -1 && errno == EINTR);
return ret;
}
int
Mkstemp(char *template_str)
{
int fd;
do {
fd = ::mkstemp(template_str);
} while (fd == -1 && errno == EINTR);
return fd;
}
} // namespace syscall
} // namespace kte

47
SyscallWrappers.h Normal file
View File

@@ -0,0 +1,47 @@
// SyscallWrappers.h - EINTR-safe syscall wrappers for kte
#pragma once
#include <string>
#include <cstddef>
#include <sys/stat.h>
namespace kte {
namespace syscall {
// EINTR-safe wrapper for open(2).
// Returns file descriptor on success, -1 on failure (errno set).
// Automatically retries on EINTR.
int Open(const char *path, int flags, mode_t mode = 0);
// EINTR-safe wrapper for close(2).
// Returns 0 on success, -1 on failure (errno set).
// Automatically retries on EINTR.
// Note: Some systems may not restart close() on EINTR, but we retry anyway
// as recommended by POSIX.1-2008.
int Close(int fd);
// EINTR-safe wrapper for fsync(2).
// Returns 0 on success, -1 on failure (errno set).
// Automatically retries on EINTR.
int Fsync(int fd);
// EINTR-safe wrapper for fstat(2).
// Returns 0 on success, -1 on failure (errno set).
// Automatically retries on EINTR.
int Fstat(int fd, struct stat *buf);
// EINTR-safe wrapper for fchmod(2).
// Returns 0 on success, -1 on failure (errno set).
// Automatically retries on EINTR.
int Fchmod(int fd, mode_t mode);
// EINTR-safe wrapper for mkstemp(3).
// Returns file descriptor on success, -1 on failure (errno set).
// Automatically retries on EINTR.
// Note: template_str must be a mutable buffer ending in "XXXXXX".
int Mkstemp(char *template_str);
// Note: rename(2) and unlink(2) are not wrapped because they operate on
// filesystem metadata and typically complete atomically without EINTR.
// If interrupted, they either succeed or fail without partial state.
} // namespace syscall
} // namespace kte

View File

@@ -8,8 +8,10 @@
bool bool
TerminalFrontend::Init(Editor &ed) TerminalFrontend::Init(int &argc, char **argv, Editor &ed)
{ {
(void) argc;
(void) argv;
// Ensure Control keys reach the app: disable XON/XOFF and dsusp/susp bindings (e.g., ^S/^Q, ^Y on macOS) // Ensure Control keys reach the app: disable XON/XOFF and dsusp/susp bindings (e.g., ^S/^Q, ^Y on macOS)
{ {
struct termios tio{}; struct termios tio{};
@@ -92,6 +94,9 @@ TerminalFrontend::Step(Editor &ed, bool &running)
} }
ed.SetDimensions(static_cast<std::size_t>(r), static_cast<std::size_t>(c)); ed.SetDimensions(static_cast<std::size_t>(r), static_cast<std::size_t>(c));
// Allow deferred opens (including swap recovery prompts) to run.
ed.ProcessPendingOpens();
MappedInput mi; MappedInput mi;
if (input_.Poll(mi)) { if (input_.Poll(mi)) {
if (mi.hasCommand) { if (mi.hasCommand) {

View File

@@ -21,7 +21,7 @@ public:
// Adjust if your terminal needs a different threshold. // Adjust if your terminal needs a different threshold.
static constexpr int kEscDelayMs = 50; static constexpr int kEscDelayMs = 50;
bool Init(Editor &ed) override; bool Init(int &argc, char **argv, Editor &ed) override;
void Step(Editor &ed, bool &running) override; void Step(Editor &ed, bool &running) override;

View File

@@ -3,6 +3,7 @@
#include "TerminalInputHandler.h" #include "TerminalInputHandler.h"
#include "KKeymap.h" #include "KKeymap.h"
#include "Command.h"
#include "Editor.h" #include "Editor.h"
namespace { namespace {
@@ -23,6 +24,7 @@ map_key_to_command(const int ch,
bool &k_prefix, bool &k_prefix,
bool &esc_meta, bool &esc_meta,
bool &k_ctrl_pending, bool &k_ctrl_pending,
bool &mouse_selecting,
Editor *ed, Editor *ed,
MappedInput &out) MappedInput &out)
{ {
@@ -54,13 +56,41 @@ map_key_to_command(const int ch,
} }
#endif #endif
// React to left button click/press // React to left button click/press
if (ev.bstate & (BUTTON1_CLICKED | BUTTON1_PRESSED | BUTTON1_RELEASED)) { if (ed && (ev.bstate & (BUTTON1_CLICKED | BUTTON1_PRESSED | BUTTON1_RELEASED |
REPORT_MOUSE_POSITION))) {
char buf[64]; char buf[64];
// Use screen coordinates; command handler will translate via offsets // Use screen coordinates; command handler will translate via offsets
std::snprintf(buf, sizeof(buf), "@%d:%d", ev.y, ev.x); std::snprintf(buf, sizeof(buf), "@%d:%d", ev.y, ev.x);
out = {true, CommandId::MoveCursorTo, std::string(buf), 0}; const bool pressed = (ev.bstate & (BUTTON1_PRESSED | BUTTON1_CLICKED)) != 0;
const bool released = (ev.bstate & BUTTON1_RELEASED) != 0;
const bool moved = (ev.bstate & REPORT_MOUSE_POSITION) != 0;
if (pressed) {
mouse_selecting = true;
Execute(*ed, CommandId::MoveCursorTo, std::string(buf));
// We don't set the mark on simple click anymore in ncurses either,
// to be consistent. ncurses doesn't easily support double-click
// or drag-threshold in a platform-independent way here,
// but we can at least only set mark on MOVED.
out.hasCommand = false;
return true; return true;
} }
if (mouse_selecting && moved) {
if (Buffer *b = ed->CurrentBuffer()) {
if (!b->MarkSet()) {
// Set mark at CURRENT cursor position (which is where we were before this move)
b->SetMark(b->Curx(), b->Cury());
}
}
Execute(*ed, CommandId::MoveCursorTo, std::string(buf));
out.hasCommand = false;
return true;
}
if (released) {
mouse_selecting = false;
out.hasCommand = false;
return true;
}
}
} }
// No actionable mouse event // No actionable mouse event
out.hasCommand = false; out.hasCommand = false;
@@ -292,6 +322,7 @@ TerminalInputHandler::decode_(MappedInput &out)
ch, ch,
k_prefix_, esc_meta_, k_prefix_, esc_meta_,
k_ctrl_pending_, k_ctrl_pending_,
mouse_selecting_,
ed_, ed_,
out); out);
if (!consumed) if (!consumed)

View File

@@ -30,5 +30,8 @@ private:
// Simple meta (ESC) state for ESC sequences like ESC b/f // Simple meta (ESC) state for ESC sequences like ESC b/f
bool esc_meta_ = false; bool esc_meta_ = false;
// Mouse drag selection state
bool mouse_selecting_ = false;
Editor *ed_ = nullptr; // attached editor for uarg handling Editor *ed_ = nullptr; // attached editor for uarg handling
}; };

View File

@@ -107,11 +107,80 @@ TerminalRenderer::Draw(Editor &ed)
const std::size_t cur_mx = has_current ? ed.SearchMatchX() : 0; const std::size_t cur_mx = has_current ? ed.SearchMatchX() : 0;
const std::size_t cur_my = has_current ? ed.SearchMatchY() : 0; const std::size_t cur_my = has_current ? ed.SearchMatchY() : 0;
const std::size_t cur_mend = has_current ? (ed.SearchMatchX() + ed.SearchMatchLen()) : 0; const std::size_t cur_mend = has_current ? (ed.SearchMatchX() + ed.SearchMatchLen()) : 0;
bool hl_on = false;
bool cur_on = false; // Mark selection (mark -> cursor), in source coordinates
bool sel_active = false;
std::size_t sel_sy = 0, sel_sx = 0, sel_ey = 0, sel_ex = 0;
if (buf->MarkSet()) {
sel_sy = buf->MarkCury();
sel_sx = buf->MarkCurx();
sel_ey = buf->Cury();
sel_ex = buf->Curx();
if (sel_sy > sel_ey || (sel_sy == sel_ey && sel_sx > sel_ex)) {
std::swap(sel_sy, sel_ey);
std::swap(sel_sx, sel_ex);
}
sel_active = !(sel_sy == sel_ey && sel_sx == sel_ex);
}
// Visual-line selection: full-line selection range
const bool vsel_active = buf->VisualLineActive();
const std::size_t vsel_sy = vsel_active ? buf->VisualLineStartY() : 0;
const std::size_t vsel_ey = vsel_active ? buf->VisualLineEndY() : 0;
auto is_src_in_mark_sel = [&](std::size_t y, std::size_t sx) -> bool {
if (!sel_active)
return false;
if (y < sel_sy || y > sel_ey)
return false;
if (sel_sy == sel_ey)
return sx >= sel_sx && sx < sel_ex;
if (y == sel_sy)
return sx >= sel_sx;
if (y == sel_ey)
return sx < sel_ex;
return true;
};
int written = 0; int written = 0;
if (li < lines.size()) { if (li < lines.size()) {
std::string line = static_cast<std::string>(lines[li]); std::string line = static_cast<std::string>(lines[li]);
const bool vsel_on_line = vsel_active && li >= vsel_sy && li <= vsel_ey;
const std::size_t vsel_spot_src = vsel_on_line
? std::min(buf->Curx(), line.size())
: 0;
const bool vsel_spot_is_eol = vsel_on_line && vsel_spot_src == line.size();
std::size_t vsel_line_rx = 0;
if (vsel_spot_is_eol) {
// Compute the rendered (column) width of the line so we can highlight a
// single cell at EOL when the spot falls beyond the last character.
std::size_t rc = 0;
std::size_t si = 0;
while (si < line.size()) {
wchar_t wch = L' ';
int wch_len = 1;
std::mbstate_t state = std::mbstate_t();
size_t res = std::mbrtowc(&wch, &line[si], line.size() - si, &state);
if (res == (size_t) -1 || res == (size_t) -2) {
wch = static_cast<unsigned char>(line[si]);
wch_len = 1;
} else if (res == 0) {
wch = L'\0';
wch_len = 1;
} else {
wch_len = static_cast<int>(res);
}
if (wch == L'\t') {
constexpr std::size_t tab_width = 8;
const std::size_t next_tab = tab_width - (rc % tab_width);
rc += next_tab;
} else {
int w = wcwidth(wch);
if (w < 0)
w = 1;
rc += static_cast<std::size_t>(w);
}
si += static_cast<std::size_t>(wch_len);
}
vsel_line_rx = rc;
}
src_i = 0; src_i = 0;
render_col = 0; render_col = 0;
// Syntax highlighting: fetch per-line spans (sanitized copy) // Syntax highlighting: fetch per-line spans (sanitized copy)
@@ -156,27 +225,21 @@ TerminalRenderer::Draw(Editor &ed)
} }
return kte::TokenKind::Default; return kte::TokenKind::Default;
}; };
auto apply_token_attr = [&](kte::TokenKind k) { auto token_attr = [&](kte::TokenKind k) -> attr_t {
// Map to simple attributes; search highlight uses A_STANDOUT which takes precedence below
attrset(A_NORMAL);
switch (k) { switch (k) {
case kte::TokenKind::Keyword: case kte::TokenKind::Keyword:
case kte::TokenKind::Type: case kte::TokenKind::Type:
case kte::TokenKind::Constant: case kte::TokenKind::Constant:
case kte::TokenKind::Function: case kte::TokenKind::Function:
attron(A_BOLD); return A_BOLD;
break;
case kte::TokenKind::Comment: case kte::TokenKind::Comment:
attron(A_DIM); return A_DIM;
break;
case kte::TokenKind::String: case kte::TokenKind::String:
case kte::TokenKind::Char: case kte::TokenKind::Char:
case kte::TokenKind::Number: case kte::TokenKind::Number:
// standout a bit using A_UNDERLINE if available return A_UNDERLINE;
attron(A_UNDERLINE);
break;
default: default:
break; return 0;
} }
}; };
while (written < cols) { while (written < cols) {
@@ -218,36 +281,27 @@ TerminalRenderer::Draw(Editor &ed)
} }
// Now render visible spaces // Now render visible spaces
while (next_tab > 0 && written < cols) { while (next_tab > 0 && written < cols) {
bool in_mark = is_src_in_mark_sel(li, src_i);
bool in_vsel =
vsel_on_line && !vsel_spot_is_eol && src_i ==
vsel_spot_src;
bool in_sel = in_mark || in_vsel;
bool in_hl = search_mode && is_src_in_hl(src_i); bool in_hl = search_mode && is_src_in_hl(src_i);
bool in_cur = bool in_cur =
has_current && li == cur_my && src_i >= cur_mx has_current && li == cur_my && src_i >= cur_mx
&& src_i < cur_mend; &&
// Toggle highlight attributes src_i < cur_mend;
int attr = 0; attr_t a = A_NORMAL;
a |= token_attr(token_at(src_i));
if (in_sel) {
a |= A_REVERSE;
} else {
if (in_hl) if (in_hl)
attr |= A_STANDOUT; a |= A_STANDOUT;
if (in_cur) if (in_cur)
attr |= A_BOLD; a |= A_BOLD;
if ((attr & A_STANDOUT) && !hl_on) {
attron(A_STANDOUT);
hl_on = true;
}
if (!(attr & A_STANDOUT) && hl_on) {
attroff(A_STANDOUT);
hl_on = false;
}
if ((attr & A_BOLD) && !cur_on) {
attron(A_BOLD);
cur_on = true;
}
if (!(attr & A_BOLD) && cur_on) {
attroff(A_BOLD);
cur_on = false;
}
// Apply syntax attribute only if not in search highlight
if (!in_hl) {
apply_token_attr(token_at(src_i));
} }
attrset(a);
addch(' '); addch(' ');
++written; ++written;
++render_col; ++render_col;
@@ -281,34 +335,36 @@ TerminalRenderer::Draw(Editor &ed)
break; break;
} }
bool in_mark = from_src && is_src_in_mark_sel(li, src_i);
bool in_vsel = false;
if (vsel_on_line) {
if (from_src) {
in_vsel = !vsel_spot_is_eol && src_i == vsel_spot_src;
} else {
in_vsel = vsel_spot_is_eol && render_col == vsel_line_rx;
}
}
bool in_sel = in_mark || in_vsel;
bool in_hl = search_mode && from_src && is_src_in_hl(src_i); bool in_hl = search_mode && from_src && is_src_in_hl(src_i);
bool in_cur = bool in_cur = has_current && li == cur_my && from_src && src_i >= cur_mx &&
has_current && li == cur_my && from_src && src_i >= cur_mx && src_i < src_i < cur_mend;
cur_mend; attr_t a = A_NORMAL;
if (in_hl && !hl_on) { if (from_src)
attron(A_STANDOUT); a |= token_attr(token_at(src_i));
hl_on = true; if (in_sel) {
} a |= A_REVERSE;
if (!in_hl && hl_on) { } else {
attroff(A_STANDOUT); if (in_hl)
hl_on = false; a |= A_STANDOUT;
} if (in_cur)
if (in_cur && !cur_on) { a |= A_BOLD;
attron(A_BOLD);
cur_on = true;
}
if (!in_cur && cur_on) {
attroff(A_BOLD);
cur_on = false;
}
if (!in_hl && from_src) {
apply_token_attr(token_at(src_i));
} }
attrset(a);
if (from_src) { if (from_src) {
cchar_t cch; cchar_t cch;
wchar_t warr[2] = {wch, L'\0'}; wchar_t warr[2] = {wch, L'\0'};
setcchar(&cch, warr, A_NORMAL, 0, nullptr); setcchar(&cch, warr, 0, 0, nullptr);
add_wch(&cch); add_wch(&cch);
} else { } else {
addch(' '); addch(' ');
@@ -322,14 +378,6 @@ TerminalRenderer::Draw(Editor &ed)
break; break;
} }
} }
if (hl_on) {
attroff(A_STANDOUT);
hl_on = false;
}
if (cur_on) {
attroff(A_BOLD);
cur_on = false;
}
attrset(A_NORMAL); attrset(A_NORMAL);
clrtoeol(); clrtoeol();
} }

View File

@@ -4,8 +4,10 @@
bool bool
TestFrontend::Init(Editor &ed) TestFrontend::Init(int &argc, char **argv, Editor &ed)
{ {
(void) argc;
(void) argv;
ed.SetDimensions(24, 80); ed.SetDimensions(24, 80);
return true; return true;
} }
@@ -14,6 +16,9 @@ TestFrontend::Init(Editor &ed)
void void
TestFrontend::Step(Editor &ed, bool &running) TestFrontend::Step(Editor &ed, bool &running)
{ {
// Allow deferred opens (including swap recovery prompts) to run.
ed.ProcessPendingOpens();
MappedInput mi; MappedInput mi;
if (input_.Poll(mi)) { if (input_.Poll(mi)) {
if (mi.hasCommand) { if (mi.hasCommand) {

View File

@@ -13,7 +13,7 @@ public:
~TestFrontend() override = default; ~TestFrontend() override = default;
bool Init(Editor &ed) override; bool Init(int &argc, char **argv, Editor &ed) override;
void Step(Editor &ed, bool &running) override; void Step(Editor &ed, bool &running) override;

View File

@@ -9,13 +9,16 @@ enum class UndoType : std::uint8_t {
Paste, Paste,
Newline, Newline,
DeleteRow, DeleteRow,
InsertRow,
}; };
struct UndoNode { struct UndoNode {
UndoType type{}; UndoType type{};
int row{}; int row{};
int col{}; int col{};
std::uint64_t group_id = 0; // 0 means ungrouped; non-zero means undo/redo as an atomic group
std::string text; std::string text;
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
}; };

View File

@@ -20,6 +20,7 @@ public:
available_.pop(); available_.pop();
// Node comes zeroed; ensure links are reset // Node comes zeroed; ensure links are reset
node->text.clear(); node->text.clear();
node->parent = nullptr;
node->child = nullptr; node->child = nullptr;
node->next = nullptr; node->next = nullptr;
node->row = node->col = 0; node->row = node->col = 0;
@@ -34,6 +35,7 @@ public:
return; return;
// Clear heavy fields to free memory held by strings // Clear heavy fields to free memory held by strings
node->text.clear(); node->text.clear();
node->parent = nullptr;
node->child = nullptr; node->child = nullptr;
node->next = nullptr; node->next = nullptr;
node->row = node->col = 0; node->row = node->col = 0;

View File

@@ -8,69 +8,264 @@ UndoSystem::UndoSystem(Buffer &owner, UndoTree &tree)
: buf_(&owner), tree_(tree) {} : buf_(&owner), tree_(tree) {}
std::uint64_t
UndoSystem::BeginGroup()
{
// Ensure any pending typed run is sealed so the group is a distinct undo step.
commit();
if (active_group_id_ == 0)
active_group_id_ = next_group_id_++;
return active_group_id_;
}
void
UndoSystem::EndGroup()
{
commit();
active_group_id_ = 0;
}
void void
UndoSystem::Begin(UndoType type) UndoSystem::Begin(UndoType type)
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented if (!buf_)
(void) type; return;
const int row = static_cast<int>(buf_->Cury());
const int col = static_cast<int>(buf_->Curx());
// Some operations should always be standalone undo steps.
const bool always_standalone = (type == UndoType::Newline || type == UndoType::DeleteRow || type ==
UndoType::InsertRow);
if (always_standalone) {
commit();
}
if (tree_.pending) {
if (tree_.pending->type == type) {
// Typed-run coalescing rules.
switch (type) {
case UndoType::Insert:
case UndoType::Paste: {
// Cursor must be at the end of the pending insert.
if (tree_.pending->row == row
&& col == tree_.pending->col + static_cast<int>(tree_.pending->text.size())) {
pending_mode_ = PendingAppendMode::Append;
return;
}
break;
}
case UndoType::Delete: {
if (tree_.pending->row == row) {
// Two common delete shapes:
// 1) backspace-run: cursor moves left each time (so new col is pending.col - 1)
// 2) delete-run: cursor stays, always deleting at the same col
if (col == tree_.pending->col) {
pending_mode_ = PendingAppendMode::Append;
return;
}
if (col + 1 == tree_.pending->col) {
// Extend a backspace run to the left; update the start column now.
tree_.pending->col = col;
pending_mode_ = PendingAppendMode::Prepend;
return;
}
}
break;
}
case UndoType::Newline:
case UndoType::DeleteRow:
case UndoType::InsertRow:
break;
}
}
// Can't coalesce: seal the previous pending step.
commit();
}
// Start a new pending node.
tree_.pending = new UndoNode{};
tree_.pending->type = type;
tree_.pending->row = row;
tree_.pending->col = col;
tree_.pending->group_id = active_group_id_;
tree_.pending->text.clear();
tree_.pending->parent = nullptr;
tree_.pending->child = nullptr;
tree_.pending->next = nullptr;
pending_mode_ = PendingAppendMode::Append;
} }
void void
UndoSystem::Append(char ch) UndoSystem::Append(char ch)
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented if (!tree_.pending)
(void) ch; return;
if (pending_mode_ == PendingAppendMode::Prepend) {
tree_.pending->text.insert(tree_.pending->text.begin(), ch);
} else {
tree_.pending->text.push_back(ch);
}
} }
void void
UndoSystem::Append(std::string_view text) UndoSystem::Append(std::string_view text)
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented if (!tree_.pending)
(void) text; return;
if (text.empty())
return;
if (pending_mode_ == PendingAppendMode::Prepend) {
tree_.pending->text.insert(0, text.data(), text.size());
} else {
tree_.pending->text.append(text.data(), text.size());
}
} }
void void
UndoSystem::commit() UndoSystem::commit()
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented if (!tree_.pending)
return;
// Drop empty text batches for text-based operations.
if ((tree_.pending->type == UndoType::Insert || tree_.pending->type == UndoType::Delete
|| tree_.pending->type == UndoType::Paste)
&& tree_.pending->text.empty()) {
delete tree_.pending;
tree_.pending = nullptr;
pending_mode_ = PendingAppendMode::Append;
return;
}
if (!tree_.root) {
tree_.root = tree_.pending;
tree_.pending->parent = nullptr;
tree_.current = tree_.pending;
} else if (!tree_.current) {
// We are at the "pre-first-edit" state (undo past the first node).
// In branching history, preserve the existing root chain as an alternate branch.
tree_.pending->parent = nullptr;
tree_.pending->next = tree_.root;
tree_.root = tree_.pending;
tree_.current = tree_.pending;
} else {
// Branching semantics: attach as a new redo branch under current.
// Make the new edit the active child by inserting it at the head.
tree_.pending->parent = tree_.current;
if (!tree_.current->child) {
tree_.current->child = tree_.pending;
} else {
tree_.pending->next = tree_.current->child;
tree_.current->child = tree_.pending;
}
tree_.current = tree_.pending;
}
tree_.pending = nullptr;
pending_mode_ = PendingAppendMode::Append;
update_dirty_flag();
} }
void void
UndoSystem::undo() UndoSystem::undo()
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented // Seal any in-progress typed run before undo.
commit();
if (!tree_.current)
return;
debug_log("undo");
const std::uint64_t gid = tree_.current->group_id;
do {
UndoNode *node = tree_.current;
apply(node, -1);
tree_.current = node->parent;
} while (gid != 0 && tree_.current && tree_.current->group_id == gid);
update_dirty_flag();
} }
void void
UndoSystem::redo() UndoSystem::redo(int branch_index)
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented commit();
UndoNode **head = nullptr;
if (!tree_.current) {
head = &tree_.root;
} else {
head = &tree_.current->child;
}
if (!head || !*head)
return;
if (branch_index < 0)
branch_index = 0;
// Select the Nth sibling from the branch list and make it the active head.
UndoNode *prev = nullptr;
UndoNode *sel = *head;
for (int i = 0; i < branch_index && sel; ++i) {
prev = sel;
sel = sel->next;
}
if (!sel)
return;
if (prev) {
prev->next = sel->next;
sel->next = *head;
*head = sel;
}
debug_log("redo");
UndoNode *node = *head;
const std::uint64_t gid = node->group_id;
apply(node, +1);
tree_.current = node;
while (gid != 0 && tree_.current && tree_.current->child
&& tree_.current->child->group_id == gid) {
UndoNode *child = tree_.current->child;
apply(child, +1);
tree_.current = child;
}
update_dirty_flag();
} }
void void
UndoSystem::mark_saved() UndoSystem::mark_saved()
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented commit();
tree_.saved = tree_.current;
update_dirty_flag();
} }
void void
UndoSystem::discard_pending() UndoSystem::discard_pending()
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented if (tree_.pending) {
delete tree_.pending;
tree_.pending = nullptr;
}
pending_mode_ = PendingAppendMode::Append;
} }
void void
UndoSystem::clear() UndoSystem::clear()
{ {
// STUB: Undo system incomplete - disabled until it can be properly implemented discard_pending();
free_node(tree_.root);
tree_.root = nullptr;
tree_.current = nullptr;
tree_.saved = nullptr;
active_group_id_ = 0;
next_group_id_ = 1;
update_dirty_flag();
} }
@@ -79,34 +274,55 @@ UndoSystem::apply(const UndoNode *node, int direction)
{ {
if (!node) if (!node)
return; return;
// Cursor positioning: keep the point at a sensible location after undo/redo.
// Low-level Buffer edit primitives do not move the cursor.
switch (node->type) { switch (node->type) {
case UndoType::Insert: case UndoType::Insert:
case UndoType::Paste: case UndoType::Paste:
if (direction > 0) { if (direction > 0) {
buf_->insert_text(node->row, node->col, node->text); buf_->insert_text(node->row, node->col, node->text);
buf_->SetCursor(static_cast<std::size_t>(node->col + node->text.size()),
static_cast<std::size_t>(node->row));
} else { } else {
buf_->delete_text(node->row, node->col, node->text.size()); buf_->delete_text(node->row, node->col, node->text.size());
buf_->SetCursor(static_cast<std::size_t>(node->col), static_cast<std::size_t>(node->row));
} }
break; break;
case UndoType::Delete: case UndoType::Delete:
if (direction > 0) { if (direction > 0) {
buf_->delete_text(node->row, node->col, node->text.size()); buf_->delete_text(node->row, node->col, node->text.size());
buf_->SetCursor(static_cast<std::size_t>(node->col), static_cast<std::size_t>(node->row));
} else { } else {
buf_->insert_text(node->row, node->col, node->text); buf_->insert_text(node->row, node->col, node->text);
buf_->SetCursor(static_cast<std::size_t>(node->col + node->text.size()),
static_cast<std::size_t>(node->row));
} }
break; break;
case UndoType::Newline: case UndoType::Newline:
if (direction > 0) { if (direction > 0) {
buf_->split_line(node->row, node->col); buf_->split_line(node->row, node->col);
buf_->SetCursor(0, static_cast<std::size_t>(node->row + 1));
} else { } else {
buf_->join_lines(node->row); buf_->join_lines(node->row);
buf_->SetCursor(static_cast<std::size_t>(node->col), static_cast<std::size_t>(node->row));
} }
break; break;
case UndoType::DeleteRow: case UndoType::DeleteRow:
if (direction > 0) { if (direction > 0) {
buf_->delete_row(node->row); buf_->delete_row(node->row);
buf_->SetCursor(0, static_cast<std::size_t>(node->row));
} else { } else {
buf_->insert_row(node->row, node->text); buf_->insert_row(node->row, node->text);
buf_->SetCursor(0, static_cast<std::size_t>(node->row));
}
break;
case UndoType::InsertRow:
if (direction > 0) {
buf_->insert_row(node->row, node->text);
buf_->SetCursor(0, static_cast<std::size_t>(node->row));
} else {
buf_->delete_row(node->row);
buf_->SetCursor(0, static_cast<std::size_t>(node->row));
} }
break; break;
} }
@@ -206,6 +422,8 @@ UndoSystem::type_str(UndoType t)
return "Newline"; return "Newline";
case UndoType::DeleteRow: case UndoType::DeleteRow:
return "DeleteRow"; return "DeleteRow";
case UndoType::InsertRow:
return "InsertRow";
} }
return "?"; return "?";
} }

View File

@@ -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>
@@ -12,6 +53,12 @@ class UndoSystem {
public: public:
explicit UndoSystem(Buffer &owner, UndoTree &tree); explicit UndoSystem(Buffer &owner, UndoTree &tree);
// Begin an atomic group: subsequent committed nodes with the same group_id will be
// undone/redone as a single step. Returns the active group id.
std::uint64_t BeginGroup();
void EndGroup();
void Begin(UndoType type); void Begin(UndoType type);
void Append(char ch); void Append(char ch);
@@ -22,7 +69,10 @@ public:
void undo(); void undo();
void redo(); // Redo the current node's active child branch.
// If `branch_index` > 0, selects that redo sibling (0-based) and makes it active.
// When current is null (pre-first-edit), branches are selected among `tree_.root` siblings.
void redo(int branch_index = 0);
void mark_saved(); void mark_saved();
@@ -32,7 +82,20 @@ public:
void UpdateBufferReference(Buffer &new_buf); void UpdateBufferReference(Buffer &new_buf);
#if defined(KTE_TESTS)
// Test-only introspection hook.
const UndoTree &TreeForTests() const
{
return tree_;
}
#endif
private: private:
enum class PendingAppendMode : std::uint8_t {
Append,
Prepend,
};
void apply(const UndoNode *node, int direction); // +1 redo, -1 undo void apply(const UndoNode *node, int direction); // +1 redo, -1 undo
void free_node(UndoNode *node); void free_node(UndoNode *node);
@@ -48,6 +111,11 @@ private:
void update_dirty_flag(); void update_dirty_flag();
PendingAppendMode pending_mode_ = PendingAppendMode::Append;
std::uint64_t active_group_id_ = 0;
std::uint64_t next_group_id_ = 1;
Buffer *buf_; Buffer *buf_;
UndoTree &tree_; UndoTree &tree_;
}; };

View File

@@ -48,6 +48,7 @@ stdenv.mkDerivation {
"-DBUILD_GUI=${if graphical then "ON" else "OFF"}" "-DBUILD_GUI=${if graphical then "ON" else "OFF"}"
"-DKTE_USE_QT=${if graphical-qt then "ON" else "OFF"}" "-DKTE_USE_QT=${if graphical-qt then "ON" else "OFF"}"
"-DCMAKE_BUILD_TYPE=Debug" "-DCMAKE_BUILD_TYPE=Debug"
"-DKTE_STATIC_LINK=OFF"
]; ];
installPhase = '' installPhase = ''

28
docker-build.sh Executable file
View 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
View 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.

1138
docs/DEVELOPER_GUIDE.md Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,549 @@
# Error Propagation Standardization Report
**Project:** kte (Kyle's Text Editor)
**Date:** 2026-02-17
**Auditor:** Error Propagation Standardization Review
**Language:** C++20
---
## Executive Summary
This report documents the standardization of error propagation patterns
across the kte codebase. Following the implementation of centralized
error handling (ErrorHandler), this audit identifies inconsistencies in
error propagation and provides concrete remediation recommendations.
**Key Findings:**
- **Dominant Pattern**: `bool + std::string &err` is used consistently
in Buffer and SwapManager for I/O operations
- **Inconsistencies**: PieceTable has no error reporting mechanism; some
internal helpers lack error propagation
- **Standard Chosen**: `bool + std::string &err` pattern (C++20 project,
std::expected not available)
- **Documentation**: Comprehensive error handling conventions added to
DEVELOPER_GUIDE.md
**Overall Assessment**: The codebase has a **solid foundation** with the
`bool + err` pattern used consistently in critical I/O paths. Primary
gaps are in PieceTable memory allocation error handling and some
internal helper functions.
---
## 1. CURRENT STATE ANALYSIS
### 1.1 Error Propagation Patterns Found
#### Pattern 1: `bool + std::string &err` (Dominant)
**Usage**: File I/O, swap operations, resource allocation
**Examples**:
- `Buffer::OpenFromFile(const std::string &path, std::string &err)` (
Buffer.h:72)
- `Buffer::Save(std::string &err)` (Buffer.h:74)
- `Buffer::SaveAs(const std::string &path, std::string &err)` (Buffer.h:
75)
- `Editor::OpenFile(const std::string &path, std::string &err)` (
Editor.h:536)
-
`SwapManager::ReplayFile(Buffer &buf, const std::string &swap_path, std::string &err)` (
Swap.h:104)
-
`SwapManager::open_ctx(JournalCtx &ctx, const std::string &path, std::string &err)` (
Swap.h:208)
-
`SwapManager::compact_to_checkpoint(JournalCtx &ctx, const std::vector<std::uint8_t> &chkpt_record, std::string &err)` (
Swap.h:212-213)
**Assessment**: ✅ **Excellent** - Consistent, well-implemented,
integrated with ErrorHandler
#### Pattern 2: `void` (State Changes)
**Usage**: Setters, cursor movement, flag toggles, internal state
modifications
**Examples**:
- `Buffer::SetCursor(std::size_t x, std::size_t y)` (Buffer.h:348)
- `Buffer::SetDirty(bool d)` (Buffer.h:368)
- `Buffer::SetMark(std::size_t x, std::size_t y)` (Buffer.h:387)
- `Buffer::insert_text(int row, int col, std::string_view text)` (
Buffer.h:545)
- `Buffer::delete_text(int row, int col, std::size_t len)` (Buffer.h:
547)
- `Editor::SetStatus(const std::string &msg)` (Editor.h:various)
**Assessment**: ✅ **Appropriate** - These operations are infallible
state changes
#### Pattern 3: `bool` without error parameter (Control Flow)
**Usage**: Validation checks, control flow decisions
**Examples**:
- `Editor::ProcessPendingOpens()` (Editor.h:544)
- `Editor::ResolveRecoveryPrompt(bool yes)` (Editor.h:558)
- `Editor::SwitchTo(std::size_t index)` (Editor.h:563)
- `Editor::CloseBuffer(std::size_t index)` (Editor.h:565)
**Assessment**: ✅ **Appropriate** - Success/failure is sufficient for
control flow
#### Pattern 4: No Error Reporting (PieceTable)
**Usage**: Memory allocation, text manipulation
**Examples**:
- `void PieceTable::Reserve(std::size_t newCapacity)` (PieceTable.h:71)
- `void PieceTable::Append(const char *s, std::size_t len)` (
PieceTable.h:75)
-
`void PieceTable::Insert(std::size_t byte_offset, const char *text, std::size_t len)` (
PieceTable.h:118)
- `char *PieceTable::Data()` (PieceTable.h:89-93) - returns nullptr on
allocation failure
**Assessment**: ⚠️ **Gap** - Memory allocation failures are not reported
---
## 2. STANDARDIZATION DECISION
### 2.1 Chosen Pattern: `bool + std::string &err`
**Rationale**:
1. **C++20 Project**: `std::expected` (C++23) is not available
2. **Existing Adoption**: Already used consistently in Buffer,
SwapManager, Editor for I/O operations
3. **Clear Semantics**: `bool` return indicates success/failure, `err`
provides details
4. **ErrorHandler Integration**: Works seamlessly with centralized error
logging
5. **Zero Overhead**: No exceptions, no dynamic allocation for error
paths
6. **Testability**: Easy to verify error messages in unit tests
**Alternative Considered**: `std::expected<T, std::string>` (C++23)
- **Rejected**: Requires C++23, would require major refactoring, not
available in current toolchain
### 2.2 Pattern Selection Guidelines
| Operation Type | Pattern | Example |
|---------------------|---------------------------|-----------------------------------------------------------------------------------|
| File I/O | `bool + std::string &err` | `Buffer::Save(std::string &err)` |
| Syscalls | `bool + std::string &err` | `open_ctx(JournalCtx &ctx, const std::string &path, std::string &err)` |
| Resource Allocation | `bool + std::string &err` | Future: `PieceTable::Reserve(std::size_t cap, std::string &err)` |
| Parsing/Validation | `bool + std::string &err` | `SwapManager::ReplayFile(Buffer &buf, const std::string &path, std::string &err)` |
| State Changes | `void` | `Buffer::SetCursor(std::size_t x, std::size_t y)` |
| Control Flow | `bool` (no err) | `Editor::SwitchTo(std::size_t index)` |
---
## 3. INCONSISTENCIES AND GAPS
### 3.1 PieceTable Memory Allocation (Severity: 6/10)
**Finding**: PieceTable methods that allocate memory (`Reserve`,
`Append`, `Insert`, `Data`) do not report allocation failures.
**Impact**:
- Memory allocation failures are silent
- `Data()` returns `nullptr` on failure, but callers may not check
- Large file operations could fail without user notification
**Evidence**:
```cpp
// PieceTable.h:71
void Reserve(std::size_t newCapacity); // No error reporting
// PieceTable.h:89-93
char *Data(); // Returns nullptr on allocation failure
```
**Remediation Priority**: **Medium** - Memory allocation failures are
rare on modern systems, but should be handled for robustness
**Recommended Fix**:
**Option 1: Add error parameter to fallible operations** (Preferred)
```cpp
// PieceTable.h
bool Reserve(std::size_t newCapacity, std::string &err);
bool Append(const char *s, std::size_t len, std::string &err);
bool Insert(std::size_t byte_offset, const char *text, std::size_t len, std::string &err);
// Returns nullptr on failure; check with HasMaterializationError()
char *Data();
bool HasMaterializationError() const;
std::string GetMaterializationError() const;
```
**Option 2: Use exceptions for allocation failures** (Not recommended)
PieceTable could throw `std::bad_alloc` on allocation failures, but this
conflicts with the project's error handling philosophy and would require
exception handling throughout the codebase.
**Option 3: Status quo with improved documentation** (Minimal change)
Document that `Data()` can return `nullptr` and callers must check. Add
assertions in debug builds.
```cpp
// PieceTable.h
// Returns pointer to materialized buffer, or nullptr if materialization fails.
// Callers MUST check for nullptr before dereferencing.
char *Data();
```
**Recommendation**: **Option 3** for now (document + assertions), *
*Option 1** if memory allocation errors become a concern in production.
### 3.2 Internal Helper Functions (Severity: 4/10)
**Finding**: Some internal helper functions in Swap.cc and Buffer.cc use
`bool` returns without error parameters.
**Examples**:
```cpp
// Swap.cc:562
static bool ensure_parent_dir(const std::string &path); // No error details
// Swap.cc:579
static bool write_header(int fd); // No error details
// Buffer.cc:101
static bool write_all_fd(int fd, const char *data, std::size_t len, std::string &err); // ✅ Good
```
**Impact**: Limited - These are internal helpers called by functions
that do report errors
**Remediation Priority**: **Low** - Callers already provide error
context
**Recommended Fix**: Add error parameters to internal helpers for
consistency
```cpp
// Swap.cc
static bool ensure_parent_dir(const std::string &path, std::string &err);
static bool write_header(int fd, std::string &err);
```
**Status**: **Deferred** - Low priority, callers already provide
adequate error context
### 3.3 Editor Control Flow Methods (Severity: 2/10)
**Finding**: Editor methods like `SwitchTo()`, `CloseBuffer()` return
`bool` without error details.
**Assessment**: ✅ **Appropriate** - These are control flow decisions
where success/failure is sufficient
**Remediation**: **None needed** - Current pattern is correct for this
use case
---
## 4. ERRORHANDLER INTEGRATION STATUS
### 4.1 Components with ErrorHandler Integration
**Buffer** (Buffer.cc)
- `OpenFromFile()` - Reports file open, seek, read errors
- `Save()` - Reports write errors
- `SaveAs()` - Reports write errors
**SwapManager** (Swap.cc)
- `report_error()` - All swap file errors reported
- Background thread errors captured and logged
- Errno captured for all syscalls
**main** (main.cc)
- Top-level exception handler reports Critical errors
- Both `std::exception` and unknown exceptions captured
### 4.2 Components Without ErrorHandler Integration
⚠️ **PieceTable** (PieceTable.cc)
- No error reporting mechanism
- Memory allocation failures are silent
⚠️ **Editor** (Editor.cc)
- File operations delegate to Buffer (✅ covered)
- Control flow methods don't need error reporting (✅ appropriate)
⚠️ **Command** (Command.cc)
- Commands use `Editor::SetStatus()` for user-facing messages
- No ErrorHandler integration for command failures
- **Assessment**: Commands are user-initiated actions; status messages
are appropriate
---
## 5. DOCUMENTATION STATUS
### 5.1 Error Handling Conventions (DEVELOPER_GUIDE.md)
**Added comprehensive section** covering:
- Three standard error propagation patterns
- Pattern selection guidelines with decision tree
- ErrorHandler integration requirements
- Code examples for file I/O, syscalls, background threads, top-level
handlers
- Anti-patterns and best practices
- Error log location and format
- Migration guide for updating existing code
**Location**: `docs/DEVELOPER_GUIDE.md` section 7
### 5.2 API Documentation
⚠️ **Gap**: Individual function documentation in headers could be
improved
**Recommendation**: Add brief comments to public APIs documenting error
behavior
```cpp
// Buffer.h
// Opens a file and loads its content into the buffer.
// Returns false on failure; err contains detailed error message.
// Errors are logged to ErrorHandler.
bool OpenFromFile(const std::string &path, std::string &err);
```
---
## 6. REMEDIATION RECOMMENDATIONS
### 6.1 High Priority (Severity 7-10)
**None identified** - Critical error handling gaps were addressed in
previous sessions:
- ✅ Top-level exception handler added (Severity 9/10)
- ✅ Background thread error reporting added (Severity 9/10)
- ✅ File I/O error checking added (Severity 8/10)
- ✅ Errno capture added to swap operations (Severity 7/10)
- ✅ Centralized error handling implemented (Severity 7/10)
### 6.2 Medium Priority (Severity 4-6)
#### 6.2.1 PieceTable Memory Allocation Error Handling (Severity: 6/10)
**Action**: Document that `Data()` can return `nullptr` and add debug
assertions
**Implementation**:
```cpp
// PieceTable.h
// Returns pointer to materialized buffer, or nullptr if materialization fails
// due to memory allocation error. Callers MUST check for nullptr.
char *Data();
// PieceTable.cc
char *PieceTable::Data() {
materialize();
assert(materialized_ != nullptr && "PieceTable materialization failed");
return materialized_;
}
```
**Effort**: Low (documentation + assertions)
**Risk**: Low (no API changes)
**Timeline**: Next maintenance cycle
#### 6.2.2 Add Error Parameters to Internal Helpers (Severity: 4/10)
**Action**: Add `std::string &err` parameters to `ensure_parent_dir()`
and `write_header()`
**Implementation**:
```cpp
// Swap.cc
static bool ensure_parent_dir(const std::string &path, std::string &err) {
try {
fs::path p(path);
fs::path dir = p.parent_path();
if (dir.empty())
return true;
if (!fs::exists(dir))
fs::create_directories(dir);
return true;
} catch (const std::exception &e) {
err = std::string("Failed to create directory: ") + e.what();
return false;
} catch (...) {
err = "Failed to create directory: unknown error";
return false;
}
}
```
**Effort**: Low (update 2 functions + call sites)
**Risk**: Low (internal helpers only)
**Timeline**: Next maintenance cycle
### 6.3 Low Priority (Severity 1-3)
#### 6.3.1 Add Function-Level Error Documentation (Severity: 3/10)
**Action**: Add brief comments to public APIs documenting error behavior
**Effort**: Medium (many functions to document)
**Risk**: None (documentation only)
**Timeline**: Ongoing as code is touched
#### 6.3.2 Add ErrorHandler Integration to Commands (Severity: 2/10)
**Action**: Consider logging command failures to ErrorHandler for
diagnostics
**Assessment**: **Not recommended** - Commands are user-initiated
actions; status messages are more appropriate than error logs
---
## 7. TESTING RECOMMENDATIONS
### 7.1 Error Handling Test Coverage
**Current State**:
- ✅ Swap file error handling tested (test_swap_edge_cases.cc)
- ✅ Buffer I/O error handling tested (test_buffer_io.cc)
- ⚠️ PieceTable allocation failure testing missing
**Recommendations**:
1. **Add PieceTable allocation failure tests** (if Option 1 from 3.1 is
implemented)
2. **Add ErrorHandler query tests** - Verify error logging and retrieval
3. **Add errno capture tests** - Verify errno is captured correctly in
syscall failures
### 7.2 Test Examples
```cpp
// test_error_handler.cc
TEST(ErrorHandler, LogsErrorsWithContext) {
ErrorHandler::Instance().Error("TestComponent", "Test error", "test.txt");
EXPECT_TRUE(ErrorHandler::Instance().HasErrors());
EXPECT_EQ(ErrorHandler::Instance().GetErrorCount(), 1);
std::string last = ErrorHandler::Instance().GetLastError();
EXPECT_TRUE(last.find("Test error") != std::string::npos);
EXPECT_TRUE(last.find("test.txt") != std::string::npos);
}
// test_piece_table.cc (if Option 1 implemented)
TEST(PieceTable, ReportsAllocationFailure) {
PieceTable pt;
std::string err;
// Attempt to allocate huge buffer
bool ok = pt.Reserve(SIZE_MAX, err);
EXPECT_FALSE(ok);
EXPECT_FALSE(err.empty());
}
```
---
## 8. MIGRATION CHECKLIST
For developers updating existing code to follow error handling
conventions:
- [ ] Identify all error-prone operations (file I/O, syscalls,
allocations)
- [ ] Add `std::string &err` parameter if not present
- [ ] Clear `err` at function start: `err.clear();`
- [ ] Capture `errno` immediately after syscall failures:
`int saved_errno = errno;`
- [ ] Build detailed error messages with context (paths, operation
details)
- [ ] Call `ErrorHandler::Instance().Error()` at all error sites
- [ ] Return `false` on failure, `true` on success
- [ ] Update all call sites to handle the error parameter
- [ ] Write unit tests that verify error handling
- [ ] Update function documentation to describe error behavior
---
## 9. SUMMARY AND NEXT STEPS
### 9.1 Achievements
**Standardized on `bool + std::string &err` pattern** for error-prone
operations
**Documented comprehensive error handling conventions** in
DEVELOPER_GUIDE.md
**Identified and prioritized remaining gaps** (PieceTable, internal
helpers)
**Integrated ErrorHandler** into Buffer, SwapManager, and main
**Established clear pattern selection guidelines** for future
development
### 9.2 Remaining Work
**Medium Priority**:
1. Document PieceTable `Data()` nullptr behavior and add assertions
2. Add error parameters to internal helper functions
**Low Priority**:
3. Add function-level error documentation to public APIs
4. Add ErrorHandler query tests
### 9.3 Conclusion
The kte codebase has achieved **strong error handling consistency** with
the `bool + std::string &err` pattern used uniformly across critical I/O
paths. The centralized ErrorHandler provides comprehensive logging and
UI integration. Remaining gaps are minor and primarily affect edge
cases (memory allocation failures) that are rare in practice.
**Overall Grade**: **B+ (8.5/10)**
**Strengths**:
- Consistent error propagation in Buffer and SwapManager
- Comprehensive ErrorHandler integration
- Excellent documentation in DEVELOPER_GUIDE.md
- Errno capture for all syscalls
- Top-level exception handling
**Areas for Improvement**:
- PieceTable memory allocation error handling
- Internal helper function error propagation
- Function-level API documentation
The error handling infrastructure is **production-ready** and provides a
solid foundation for reliable operation and debugging.

View File

@@ -12,11 +12,14 @@ Goals
Model overview Model overview
-------------- --------------
Per open buffer, maintain a sidecar swap journal next to the file: Per open buffer, maintain a swap journal in a per-user state directory:
- Path: `.<basename>.kte.swp` in the same directory as the file (for - Path: `$XDG_STATE_HOME/kte/swap/<encoded-path>.swp` (or
unnamed/unsaved buffers, use a persession temp dir like `~/.local/state/kte/swap/...`)
`$TMPDIR/kte/` with a random UUID). where `<encoded-path>` is the file path with separators replaced (e.g.
`/home/kyle/tmp/test.txt``home!kyle!tmp!test.txt.swp`).
Unnamed/unsaved
buffers use a unique `unnamed-<pid>-<counter>.swp` name.
- Format: appendonly journal of editing operations with periodic - Format: appendonly journal of editing operations with periodic
checkpoints. checkpoints.
- Crash safety: only append, fsync as per policy; checkpoint via - Crash safety: only append, fsync as per policy; checkpoint via
@@ -84,7 +87,7 @@ Recovery flow
On opening a file: On opening a file:
1. Detect swap sidecar `.<basename>.kte.swp`. 1. Detect swap journal `$XDG_STATE_HOME/kte/swap/<encoded-path>.swp`.
2. Validate header, iterate records verifying CRCs. 2. Validate header, iterate records verifying CRCs.
3. Compare recorded original file identity against actual file; if 3. Compare recorded original file identity against actual file; if
mismatch, warn user but allow recovery (content wins). mismatch, warn user but allow recovery (content wins).
@@ -98,7 +101,7 @@ Stability & corruption mitigation
--------------------------------- ---------------------------------
- Appendonly with perrecord CRC32 guards against torn writes. - Appendonly with perrecord CRC32 guards against torn writes.
- Atomic checkpoint rotation: write `.<basename>.kte.swp.tmp`, fsync, - Atomic checkpoint rotation: write `<encoded-path>.swp.tmp`, fsync,
then rename over old `.swp`. then rename over old `.swp`.
- Size caps: rotate or compact when `.swp` exceeds a threshold (e.g., - Size caps: rotate or compact when `.swp` exceeds a threshold (e.g.,
64128 MB). Compaction creates a fresh file with a single checkpoint. 64128 MB). Compaction creates a fresh file with a single checkpoint.
@@ -117,8 +120,8 @@ Security considerations
Interoperability & UX Interoperability & UX
--------------------- ---------------------
- Use a distinctive extension `.kte.swp` to avoid conflicts with other - Use a distinctive directory (`$XDG_STATE_HOME/kte/swap`) to avoid
editors. conflicts with other editors `.swp` conventions.
- Status bar indicator when swap is active; commands to purge/compact. - Status bar indicator when swap is active; commands to purge/compact.
- On save: do not delete swap immediately; keep until the buffer is - On save: do not delete swap immediately; keep until the buffer is
clean and idle for a short grace period (allows undo of accidental clean and idle for a short grace period (allows undo of accidental

237
docs/swap.md Normal file
View File

@@ -0,0 +1,237 @@
# Swap journaling (crash recovery)
kte has a small “swap” system: an append-only per-buffer journal that
records edits so they can be replayed after a crash.
This document describes the **currently implemented** swap system (stage
2), as implemented in `Swap.h` / `Swap.cc`.
## What it is (and what it is not)
- The swap file is a **journal of editing operations** (currently
inserts, deletes, and periodic full-buffer checkpoints).
- It is written by a **single background writer thread** owned by
`kte::SwapManager`.
- It is intended for **best-effort crash recovery**.
kte automatically deletes/resets swap journals after a **clean save**
and when
closing a clean buffer, so old swap files do not accumulate under normal
workflows. A best-effort prune also runs at startup to remove very old
swap
files.
## Automatic recovery prompt
When kte opens a file-backed buffer, it checks whether a corresponding
swap journal exists.
- If a swap file exists and replay succeeds *and* produces different
content than what is currently on disk, kte prompts:
```text
Recover swap edits for <path>? (y/N, C-g cancel)
```
- `y`: open the file and apply swap replay (buffer becomes dirty)
- `Enter` (default) / any non-`y`: delete the swap file (
best-effort)
and open the file normally
- `C-g`: cancel opening the file
- If a swap file exists but is unreadable/corrupt, kte prompts:
```text
Swap file unreadable for <path>. Delete it? (y/N, C-g cancel)
```
- `y`: delete the swap file (best-effort) and open the file normally
- `Enter` (default): keep the swap file and open the file normally
- `C-g`: cancel opening the file
## Where swap files live
Swap files are stored under an XDG-style per-user *state* directory:
- If `XDG_STATE_HOME` is set and non-empty:
- `$XDG_STATE_HOME/kte/swap/…`
- Otherwise, if `HOME` is set:
- `~/.local/state/kte/swap/…`
- Last resort fallback:
- `<system-temp>/kte/state/kte/swap/…` (via
`std::filesystem::temp_directory_path()`)
Swap files are always created with permissions `0600`.
### Swap file naming
For file-backed buffers, the swap filename is derived from the buffers
path:
1. Take a canonical-ish path key (`std::filesystem::weakly_canonical`,
else `absolute`, else the raw `Buffer::Filename()`).
2. Encode it so its human-identifiable:
- Strip one leading path separator (`/` or `\\`)
- Replace path separators (`/` and `\\`) with `!`
- Append `.swp`
Example:
```text
/home/kyle/tmp/test.txt -> home!kyle!tmp!test.txt.swp
```
If the resulting name would be long (over ~200 characters), kte falls
back to a shorter stable name:
```text
<basename>.<fnv1a64(path-key-as-hex)>.swp
```
For unnamed/unsaved buffers, kte uses:
```text
unnamed-<pid>-<counter>.swp
```
## Lifecycle (when swap is written)
`kte::SwapManager` is owned by `Editor` (see `Editor.cc`). Buffers are
attached for journaling when they are added/opened.
- `SwapManager::Attach(Buffer*)` starts tracking a buffer and
establishes its swap path.
- `Buffer` emits swap events from its low-level edit APIs:
- `Buffer::insert_text()` calls `SwapRecorder::OnInsert()`
- `Buffer::delete_text()` calls `SwapRecorder::OnDelete()`
- `Buffer::split_line()` / `join_lines()` are represented as
insert/delete of `\n` (they do **not** emit `SPLIT`/`JOIN` records
in stage 1).
- `SwapManager::Detach(Buffer*)` flushes queued records, `fsync()`s, and
closes the journal.
- On `Save As` / filename changes,
`SwapManager::NotifyFilenameChanged(Buffer&)` closes the existing
journal and switches to a new path.
- Note: the old swap file is currently left on disk (no
cleanup/rotation yet).
## Durability and performance
Swap writing is best-effort and asynchronous:
- Records are queued from the UI/editing thread(s).
- A background writer thread wakes at least every
`SwapConfig::flush_interval_ms` (default `200ms`) to write any queued
records.
- `fsync()` is throttled to at most once per
`SwapConfig::fsync_interval_ms` (default `1000ms`) per open swap file.
- `SwapManager::Flush()` blocks until the queue is fully written; it is
primarily used by tests and shutdown paths.
If a crash happens while writing, the swap file may end with a partial
record. Replay detects truncation/CRC mismatch and fails safely.
## On-disk format (v1)
The file is:
1. A fixed-size 64-byte header
2. Followed by a stream of records
All multi-byte integers in the swap file are **little-endian**.
### Header (64 bytes)
Layout (stage 1):
- `magic` (8 bytes): `KTE_SWP\0`
- `version` (`u32`): currently `1`
- `flags` (`u32`): currently `0`
- `created_time` (`u64`): Unix seconds
- remaining bytes are reserved/padding (currently zeroed)
### Record framing
Each record is:
```text
[type: u8][len: u24][payload: len bytes][crc32: u32]
```
- `len` is a 24-bit little-endian length of the payload (`0..0xFFFFFF`).
- `crc32` is computed over the 4-byte record header (`type + len`)
followed by the payload bytes.
### Record types
Type codes are defined in `SwapRecType` (`Swap.h`). Stage 1 primarily
emits:
- `INS` (`1`): insert bytes at `(row, col)`
- `DEL` (`2`): delete `len` bytes at `(row, col)`
Other type codes exist for forward compatibility (`SPLIT`, `JOIN`,
`META`, `CHKPT`), but are not produced by the current `SwapRecorder`
interface.
### Payload encoding (v1)
Every payload starts with:
```text
[encver: u8]
```
Currently `encver` must be `1`.
#### `INS` payload (encver = 1)
```text
[encver: u8 = 1]
[row: u32]
[col: u32]
[nbytes:u32]
[bytes: nbytes]
```
#### `DEL` payload (encver = 1)
```text
[encver: u8 = 1]
[row: u32]
[col: u32]
[len: u32]
```
`row`/`col` are 0-based and are interpreted the same way as
`Buffer::insert_text()` / `Buffer::delete_text()`.
## Replay / recovery
Swap replay is implemented as a low-level API:
-
`bool kte::SwapManager::ReplayFile(Buffer &buf, const std::string &swap_path, std::string &err)`
Behavior:
- The caller supplies an **already-open** `Buffer` (typically loaded
from the on-disk file) and a swap path.
- `ReplayFile()` validates header magic/version, then iterates records.
- On a truncated file or CRC mismatch, it returns `false` and sets
`err`.
- On unknown record types, it ignores them (forward compatibility).
- On failure, the buffer may have had a prefix of records applied;
callers should treat this as “recovery failed”.
Important: if the buffer is currently attached to a `SwapManager`, you
should suspend/disable recording during replay (or detach first),
otherwise replayed edits would be re-journaled.
## Tests
Swap behavior and format are validated by unit tests:
- `tests/test_swap_writer.cc` (header, permissions, record CRC framing)
- `tests/test_swap_replay.cc` (record replay and truncation handling)

View File

@@ -23,29 +23,34 @@ Current themes (alphabetically):
- **gruvbox** — Retro groove color scheme (light/dark variants) - **gruvbox** — Retro groove color scheme (light/dark variants)
- **kanagawa-paper** — Inspired by traditional Japanese art - **kanagawa-paper** — Inspired by traditional Japanese art
- **lcars** — Star Trek LCARS interface style - **lcars** — Star Trek LCARS interface style
- **leuchtturm** — Modern, clean theme (light/dark variants)
- **nord** — Arctic, north-bluish color palette - **nord** — Arctic, north-bluish color palette
- **old-book** — Sepia-toned vintage book aesthetic (light/dark - **old-book** — Sepia-toned vintage book aesthetic (light/dark
variants) variants)
- **orbital** — Space-themed dark palette - **orbital** — Space-themed dark palette
- **plan9** — Minimalist Plan 9 from Bell Labs inspired - **plan9** — Minimalist Plan 9 from Bell Labs inspired
- **solarized** — Ethan Schoonover's Solarized (light/dark variants) - **solarized** — Ethan Schoonover's Solarized (light/dark variants)
- **tufte** — Edward Tufte-inspired minimalist theme (light/dark variants)
- **weyland-yutani** — Alien franchise corporate aesthetic - **weyland-yutani** — Alien franchise corporate aesthetic
- **zenburn** — Low-contrast, easy-on-the-eyes theme - **zenburn** — Low-contrast, easy-on-the-eyes theme
Configuration Configuration
------------- -------------
Themes are configured via `$HOME/.config/kte/kge.ini`: Themes are configured via `$HOME/.config/kte/kge.toml`:
```ini ```toml
theme = nord [appearance]
background = dark theme = "nord"
background = "dark"
``` ```
- `theme` — The theme name (e.g., "nord", "gruvbox", "solarized") - `theme` — The theme name (e.g., "nord", "gruvbox", "solarized")
- `background` — Either "dark" or "light" (for themes supporting both - `background` — Either "dark" or "light" (for themes supporting both
variants) variants)
Legacy `kge.ini` format is also supported (see CONFIG.md).
Themes can also be switched at runtime using the `:theme <name>` Themes can also be switched at runtime using the `:theme <name>`
command. command.

17748
ext/tomlplusplus/toml.hpp Normal file

File diff suppressed because it is too large Load Diff

1768
fonts/CrimsonPro.h Normal file

File diff suppressed because it is too large Load Diff

1203
fonts/ETBook.h Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -3,6 +3,8 @@
#include "BerkeleyMono.h" #include "BerkeleyMono.h"
#include "BrassMono.h" #include "BrassMono.h"
#include "BrassMonoCode.h" #include "BrassMonoCode.h"
#include "CrimsonPro.h"
#include "ETBook.h"
#include "FiraCode.h" #include "FiraCode.h"
#include "Go.h" #include "Go.h"
#include "IBMPlexMono.h" #include "IBMPlexMono.h"
@@ -13,6 +15,7 @@
#include "IosevkaExtended.h" #include "IosevkaExtended.h"
#include "ShareTech.h" #include "ShareTech.h"
#include "SpaceMono.h" #include "SpaceMono.h"
#include "Spectral.h"
#include "Syne.h" #include "Syne.h"
#include "Triplicate.h" #include "Triplicate.h"
#include "Unispace.h" #include "Unispace.h"

View File

@@ -45,6 +45,16 @@ InstallDefaultFonts()
BrassMonoCode::DefaultFontBoldCompressedData, BrassMonoCode::DefaultFontBoldCompressedData,
BrassMonoCode::DefaultFontBoldCompressedSize BrassMonoCode::DefaultFontBoldCompressedSize
)); ));
FontRegistry::Instance().Register(std::make_unique<Font>(
"crimsonpro",
CrimsonPro::DefaultFontRegularCompressedData,
CrimsonPro::DefaultFontRegularCompressedSize
));
FontRegistry::Instance().Register(std::make_unique<Font>(
"etbook",
ETBook::DefaultFontRegularCompressedData,
ETBook::DefaultFontRegularCompressedSize
));
FontRegistry::Instance().Register(std::make_unique<Font>( FontRegistry::Instance().Register(std::make_unique<Font>(
"fira", "fira",
FiraCode::DefaultFontRegularCompressedData, FiraCode::DefaultFontRegularCompressedData,
@@ -95,6 +105,11 @@ InstallDefaultFonts()
SpaceMono::DefaultFontRegularCompressedData, SpaceMono::DefaultFontRegularCompressedData,
SpaceMono::DefaultFontRegularCompressedSize SpaceMono::DefaultFontRegularCompressedSize
)); ));
FontRegistry::Instance().Register(std::make_unique<Font>(
"spectral",
Spectral::DefaultFontRegularCompressedData,
Spectral::DefaultFontRegularCompressedSize
));
FontRegistry::Instance().Register(std::make_unique<Font>( FontRegistry::Instance().Register(std::make_unique<Font>(
"syne", "syne",
Syne::DefaultFontRegularCompressedData, Syne::DefaultFontRegularCompressedData,

View File

@@ -1,10 +1,12 @@
#pragma once #pragma once
#include <algorithm>
#include <cassert> #include <cassert>
#include <memory> #include <memory>
#include <mutex> #include <mutex>
#include <string> #include <string>
#include <unordered_map> #include <unordered_map>
#include <vector>
#include "Font.h" #include "Font.h"
@@ -87,6 +89,19 @@ public:
} }
// Return all registered font names (sorted)
std::vector<std::string> FontNames() const
{
std::lock_guard lock(mutex_);
std::vector<std::string> names;
names.reserve(fonts_.size());
for (const auto &[name, _] : fonts_)
names.push_back(name);
std::sort(names.begin(), names.end());
return names;
}
// Current font name/size as last successfully loaded via LoadFont() // Current font name/size as last successfully loaded via LoadFont()
std::string CurrentFontName() const std::string CurrentFontName() const
{ {

25719
fonts/Go.h

File diff suppressed because it is too large Load Diff

3227
fonts/Spectral.h Normal file

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

24
kge.toml.example Normal file
View File

@@ -0,0 +1,24 @@
# kge configuration
# Place at ~/.config/kte/kge.toml
[window]
fullscreen = false
columns = 80
rows = 42
[font]
# Default font and size
name = "default"
size = 18.0
# Font used in code mode (monospace)
code = "default"
# Font used in writing mode (proportional) — for .txt, .md, .rst, .org, .tex, etc.
writing = "crimsonpro"
[appearance]
theme = "nord"
# "dark" or "light" for themes with variants
background = "dark"
[editor]
syntax = true

59
main.cc
View File

@@ -20,6 +20,7 @@
#include "Editor.h" #include "Editor.h"
#include "Frontend.h" #include "Frontend.h"
#include "TerminalFrontend.h" #include "TerminalFrontend.h"
#include "ErrorHandler.h"
#if defined(KTE_BUILD_GUI) #if defined(KTE_BUILD_GUI)
#if defined(KTE_USE_QT) #if defined(KTE_USE_QT)
@@ -112,10 +113,13 @@ RunStressHighlighter(unsigned seconds)
int int
main(int argc, const char *argv[]) main(int argc, char *argv[])
{ {
std::setlocale(LC_ALL, ""); std::setlocale(LC_ALL, "");
// Ensure the error handler (and its log file) is initialised early.
kte::ErrorHandler::Instance();
Editor editor; Editor editor;
// CLI parsing using getopt_long // CLI parsing using getopt_long
@@ -136,7 +140,7 @@ main(int argc, const char *argv[])
int opt; int opt;
int long_index = 0; int long_index = 0;
unsigned stress_seconds = 0; unsigned stress_seconds = 0;
while ((opt = getopt_long(argc, const_cast<char *const *>(argv), "gthV", long_opts, &long_index)) != -1) { while ((opt = getopt_long(argc, argv, "gthV", long_opts, &long_index)) != -1) {
switch (opt) { switch (opt) {
case 'g': case 'g':
req_gui = true; req_gui = true;
@@ -181,10 +185,13 @@ main(int argc, const char *argv[])
return RunStressHighlighter(stress_seconds); return RunStressHighlighter(stress_seconds);
} }
// Top-level exception handler to prevent data loss and ensure cleanup
try {
// Determine frontend // Determine frontend
#if !defined(KTE_BUILD_GUI) #if !defined(KTE_BUILD_GUI)
if (req_gui) { if (req_gui) {
std::cerr << "kte: GUI not built. Reconfigure with -DBUILD_GUI=ON and required deps installed." << std::cerr << "kte: GUI not built. Reconfigure with -DBUILD_GUI=ON and required deps installed."
<<
std::endl; std::endl;
return 2; return 2;
} }
@@ -195,6 +202,9 @@ main(int argc, const 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;
@@ -207,6 +217,9 @@ main(int argc, const char *argv[])
// Open files passed on the CLI; support +N to jump to line N in the next file. // Open files passed on the CLI; support +N to jump to line N in the next file.
// If no files are provided, create an empty buffer. // If no files are provided, create an empty buffer.
if (optind < argc) { if (optind < argc) {
// Seed a scratch buffer so the UI has something to show while deferred opens
// (and potential swap recovery prompts) are processed.
editor.AddBuffer(Buffer());
std::size_t pending_line = 0; // 0 = no pending line std::size_t pending_line = 0; // 0 = no pending line
for (int i = optind; i < argc; ++i) { for (int i = optind; i < argc; ++i) {
const char *arg = argv[i]; const char *arg = argv[i];
@@ -242,29 +255,9 @@ main(int argc, const char *argv[])
// Fall through: not a +number, treat as filename starting with '+' // Fall through: not a +number, treat as filename starting with '+'
} }
std::string err;
const std::string path = arg; const std::string path = arg;
if (!editor.OpenFile(path, err)) { editor.RequestOpenFile(path, pending_line);
editor.SetStatus("open: " + err); pending_line = 0; // consumed (if set)
std::cerr << "kte: " << err << "\n";
} else if (pending_line > 0) {
// Apply pending +N to the just-opened (current) buffer
if (Buffer *b = editor.CurrentBuffer()) {
std::size_t nrows = b->Nrows();
std::size_t line = pending_line > 0 ? pending_line - 1 : 0;
// 1-based to 0-based
if (nrows > 0) {
if (line >= nrows)
line = nrows - 1;
} else {
line = 0;
}
b->SetCursor(0, line);
// Do not force viewport offsets here; the frontend/renderer
// will establish dimensions and normalize visibility on first draw.
}
pending_line = 0; // consumed
}
} }
// If we ended with a pending +N but no subsequent file, ignore it. // If we ended with a pending +N but no subsequent file, ignore it.
} else { } else {
@@ -303,7 +296,7 @@ main(int argc, const char *argv[])
} }
#endif #endif
if (!fe->Init(editor)) { if (!fe->Init(argc, argv, editor)) {
std::cerr << "kte: failed to initialize frontend" << std::endl; std::cerr << "kte: failed to initialize frontend" << std::endl;
return 1; return 1;
} }
@@ -318,4 +311,18 @@ main(int argc, const char *argv[])
fe->Shutdown(); fe->Shutdown();
return 0; return 0;
} catch (const std::exception &e) {
std::string msg = std::string("Unhandled exception: ") + e.what();
kte::ErrorHandler::Instance().Critical("main", msg);
std::cerr << "\n*** FATAL ERROR ***\n"
<< "kte encountered an unhandled exception: " << e.what() << "\n"
<< "The editor will now exit. Any unsaved changes may be recovered from swap files.\n";
return 1;
} catch (...) {
kte::ErrorHandler::Instance().Critical("main", "Unknown exception");
std::cerr << "\n*** FATAL ERROR ***\n"
<< "kte encountered an unknown exception.\n"
<< "The editor will now exit. Any unsaved changes may be recovered from swap files.\n";
return 1;
}
} }

View File

@@ -15,20 +15,18 @@ sha256sum kge.app.zip
open . open .
cd .. cd ..
mkdir -p cmake-build-release-qt # Qt build disabled — ImGui frontend is the primary GUI.
cmake -S . -B cmake-build-release-qt -DBUILD_GUI=ON -DKTE_USE_QT=ON -DCMAKE_BUILD_TYPE=Release -DENABLE_ASAN=OFF # mkdir -p cmake-build-release-qt
# cmake -S . -B cmake-build-release-qt -DBUILD_GUI=ON -DKTE_USE_QT=ON -DCMAKE_BUILD_TYPE=Release -DENABLE_ASAN=OFF
cd cmake-build-release-qt #
make clean # cd cmake-build-release-qt
rm -fr kge.app* kge-qt.app* # make clean
make # rm -fr kge.app* kge-qt.app*
mv -f kge.app kge-qt.app # make
# Use the same Qt's macdeployqt as used for building; ensure it overwrites in-bundle paths # mv -f kge.app kge-qt.app
macdeployqt kge-qt.app -always-overwrite -verbose=3 # macdeployqt kge-qt.app -always-overwrite -verbose=3
# cmake -DAPP_BUNDLE="$(pwd)/kge-qt.app" -P "${PWD%/*}/cmake/fix_bundle.cmake"
# Run CMake BundleUtilities fixup to internalize non-Qt dylibs and rewrite install names # zip -r kge-qt.app.zip kge-qt.app
cmake -DAPP_BUNDLE="$(pwd)/kge-qt.app" -P "${PWD%/*}/cmake/fix_bundle.cmake" # sha256sum kge-qt.app.zip
zip -r kge-qt.app.zip kge-qt.app # open .
sha256sum kge-qt.app.zip # cd ..
open .
cd ..

View File

@@ -22,5 +22,6 @@ fi
git tag "${KTE_VERSION}" git tag "${KTE_VERSION}"
git push && git push --tags git push && git push --tags
git push github && git push github --tags
( ./make-app-release ) ( ./make-app-release )

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;
} }

View File

@@ -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)

View File

@@ -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;

View File

@@ -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.

View File

@@ -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;

View File

@@ -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 "\"\"\""

View File

@@ -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) {

View File

@@ -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

View File

@@ -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;

View File

@@ -8,19 +8,23 @@
#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() {
inline std::vector<TestCase> &
registry()
{
static std::vector<TestCase> r; static std::vector<TestCase> r;
return 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)});
} }
}; };
@@ -30,27 +34,37 @@ struct AssertionFailure {
std::string msg; std::string msg;
}; };
inline void expect(bool cond, const char* expr, const char* file, int line) {
inline void
expect(bool cond, const char *expr, const char *file, int line)
{
if (!cond) { if (!cond) {
std::cerr << file << ":" << line << ": EXPECT failed: " << expr << "\n"; std::cerr << file << ":" << line << ": EXPECT failed: " << expr << "\n";
} }
} }
inline void assert_true(bool cond, const char* expr, const char* file, int line) {
inline void
assert_true(bool cond, const char *expr, const char *file, int line)
{
if (!cond) { if (!cond) {
throw AssertionFailure{std::string(file) + ":" + std::to_string(line) + ": ASSERT failed: " + expr}; 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)
{
// Cast to common type to avoid signed/unsigned comparison warnings
using Common = std::common_type_t<A, B>;
if (!(static_cast<Common>(a) == static_cast<Common>(b))) {
std::ostringstream oss; std::ostringstream oss;
oss << file << ":" << line << ": ASSERT_EQ failed: " << ea << " == " << eb; oss << file << ":" << line << ": ASSERT_EQ failed: " << ea << " == " << eb;
throw AssertionFailure{oss.str()}; throw AssertionFailure{oss.str()};
} }
} }
} // namespace ktet } // namespace ktet
#define TEST(name) \ #define TEST(name) \

138
tests/TestHarness.h Normal file
View File

@@ -0,0 +1,138 @@
// TestHarness.h - small helper layer for driving kte headlessly in tests
#pragma once
#include <cstddef>
#include <string>
#include <string_view>
#include "Buffer.h"
#include "Command.h"
#include "Editor.h"
namespace ktet {
inline void
InstallDefaultCommandsOnce()
{
static bool installed = false;
if (!installed) {
InstallDefaultCommands();
installed = true;
}
}
class TestHarness {
public:
TestHarness()
{
InstallDefaultCommandsOnce();
editor_.SetDimensions(24, 80);
Buffer b;
b.SetVirtualName("+TEST+");
editor_.AddBuffer(std::move(b));
}
Editor &
EditorRef()
{
return editor_;
}
Buffer &
Buf()
{
return *editor_.CurrentBuffer();
}
[[nodiscard]] const Buffer &
Buf() const
{
return *editor_.CurrentBuffer();
}
bool
Exec(CommandId id, const std::string &arg = std::string(), int ucount = 0)
{
if (ucount > 0) {
editor_.SetUniversalArg(1, ucount);
} else {
editor_.UArgClear();
}
return Execute(editor_, id, arg);
}
bool
InsertText(std::string_view text)
{
if (text.find('\n') != std::string_view::npos || text.find('\r') != std::string_view::npos)
return false;
return Exec(CommandId::InsertText, std::string(text));
}
void
TypeText(std::string_view text)
{
for (char ch: text) {
if (ch == '\n') {
Exec(CommandId::Newline);
} else if (ch == '\r') {
// ignore
} else {
Exec(CommandId::InsertText, std::string(1, ch));
}
}
}
[[nodiscard]] std::string
Text() const
{
const auto &rows = Buf().Rows();
std::string out;
for (std::size_t i = 0; i < rows.size(); ++i) {
out += static_cast<std::string>(rows[i]);
if (i + 1 < rows.size())
out.push_back('\n');
}
return out;
}
[[nodiscard]] std::string
Line(std::size_t y) const
{
return Buf().GetLineString(y);
}
bool
SaveAs(const std::string &path, std::string &err)
{
return Buf().SaveAs(path, err);
}
bool
Undo(int ucount = 0)
{
return Exec(CommandId::Undo, std::string(), ucount);
}
bool
Redo(int ucount = 0)
{
return Exec(CommandId::Redo, std::string(), ucount);
}
private:
Editor editor_;
};
} // namespace ktet

View File

@@ -2,7 +2,10 @@
#include <iostream> #include <iostream>
#include <chrono> #include <chrono>
int main() {
int
main()
{
using namespace std::chrono; using namespace std::chrono;
auto &reg = ktet::registry(); auto &reg = ktet::registry();
std::cout << "kte unit tests: " << reg.size() << " test(s)\n"; std::cout << "kte unit tests: " << reg.size() << " test(s)\n";

411
tests/test_benchmarks.cc Normal file
View File

@@ -0,0 +1,411 @@
/*
* test_benchmarks.cc - Performance benchmarks for core kte operations
*
* This file measures the performance of critical operations to ensure
* that migrations and refactorings don't introduce performance regressions.
*
* Benchmarks cover:
* - PieceTable operations (insert, delete, GetLine, GetLineRange)
* - Buffer operations (Nrows, GetLineString, GetLineView)
* - Iteration patterns (comparing old Rows() vs new GetLineString/GetLineView)
* - Syntax highlighting on large files
*
* Each benchmark reports execution time in milliseconds.
*/
#include "Test.h"
#include "Buffer.h"
#include "PieceTable.h"
#include "syntax/CppHighlighter.h"
#include "syntax/HighlighterEngine.h"
#include <chrono>
#include <iostream>
#include <random>
#include <sstream>
#include <string>
#include <vector>
namespace {
// Benchmark timing utility
class BenchmarkTimer {
public:
BenchmarkTimer(const char *name) : name_(name), start_(std::chrono::high_resolution_clock::now()) {}
~BenchmarkTimer()
{
auto end = std::chrono::high_resolution_clock::now();
auto duration = std::chrono::duration_cast<std::chrono::microseconds>(end - start_);
double ms = duration.count() / 1000.0;
std::cout << " [BENCH] " << name_ << ": " << ms << " ms\n";
}
private:
const char *name_;
std::chrono::high_resolution_clock::time_point start_;
};
// Generate test data
std::string
generate_large_file(std::size_t num_lines, std::size_t avg_line_length)
{
std::mt19937 rng(42);
std::string result;
result.reserve(num_lines * (avg_line_length + 1));
for (std::size_t i = 0; i < num_lines; ++i) {
std::size_t line_len = avg_line_length + (rng() % 20) - 10; // ±10 chars variation
for (std::size_t j = 0; j < line_len; ++j) {
char c = 'a' + (rng() % 26);
result.push_back(c);
}
result.push_back('\n');
}
return result;
}
std::string
generate_cpp_code(std::size_t num_lines)
{
std::ostringstream oss;
oss << "#include <iostream>\n";
oss << "#include <vector>\n";
oss << "#include <string>\n\n";
oss << "namespace test {\n";
for (std::size_t i = 0; i < num_lines / 10; ++i) {
oss << "class TestClass" << i << " {\n";
oss << "public:\n";
oss << " void method" << i << "() {\n";
oss << " // Comment line\n";
oss << " int x = " << i << ";\n";
oss << " std::string s = \"test string\";\n";
oss << " for (int j = 0; j < 100; ++j) {\n";
oss << " x += j;\n";
oss << " }\n";
oss << " }\n";
oss << "};\n\n";
}
oss << "} // namespace test\n";
return oss.str();
}
} // anonymous namespace
// ============================================================================
// PieceTable Benchmarks
// ============================================================================
TEST (Benchmark_PieceTable_Sequential_Inserts)
{
std::cout << "\n=== PieceTable Sequential Insert Benchmark ===\n";
PieceTable pt;
const std::size_t num_ops = 10000;
const char *text = "line\n";
const std::size_t text_len = 5;
{
BenchmarkTimer timer("10K sequential inserts at end");
for (std::size_t i = 0; i < num_ops; ++i) {
pt.Insert(pt.Size(), text, text_len);
}
}
ASSERT_EQ(pt.LineCount(), num_ops + 1); // +1 for final empty line
}
TEST (Benchmark_PieceTable_Random_Inserts)
{
std::cout << "\n=== PieceTable Random Insert Benchmark ===\n";
PieceTable pt;
const std::size_t num_ops = 5000;
const char *text = "xyz\n";
const std::size_t text_len = 4;
std::mt19937 rng(123);
// Pre-populate with some content
std::string initial = generate_large_file(1000, 50);
pt.Insert(0, initial.data(), initial.size());
{
BenchmarkTimer timer("5K random inserts");
for (std::size_t i = 0; i < num_ops; ++i) {
std::size_t pos = rng() % (pt.Size() + 1);
pt.Insert(pos, text, text_len);
}
}
}
TEST (Benchmark_PieceTable_GetLine_Sequential)
{
std::cout << "\n=== PieceTable GetLine Sequential Benchmark ===\n";
PieceTable pt;
std::string data = generate_large_file(10000, 80);
pt.Insert(0, data.data(), data.size());
std::size_t total_chars = 0;
{
BenchmarkTimer timer("GetLine on 10K lines (sequential)");
for (std::size_t i = 0; i < pt.LineCount(); ++i) {
std::string line = pt.GetLine(i);
total_chars += line.size();
}
}
EXPECT_TRUE(total_chars > 0);
}
TEST (Benchmark_PieceTable_GetLineRange_Sequential)
{
std::cout << "\n=== PieceTable GetLineRange Sequential Benchmark ===\n";
PieceTable pt;
std::string data = generate_large_file(10000, 80);
pt.Insert(0, data.data(), data.size());
std::size_t total_ranges = 0;
{
BenchmarkTimer timer("GetLineRange on 10K lines (sequential)");
for (std::size_t i = 0; i < pt.LineCount(); ++i) {
auto range = pt.GetLineRange(i);
total_ranges += (range.second - range.first);
}
}
EXPECT_TRUE(total_ranges > 0);
}
// ============================================================================
// Buffer Benchmarks
// ============================================================================
TEST (Benchmark_Buffer_Nrows_Repeated_Calls)
{
std::cout << "\n=== Buffer Nrows Benchmark ===\n";
Buffer buf;
std::string data = generate_large_file(10000, 80);
buf.insert_text(0, 0, data);
std::size_t sum = 0;
{
BenchmarkTimer timer("1M calls to Nrows()");
for (int i = 0; i < 1000000; ++i) {
sum += buf.Nrows();
}
}
EXPECT_TRUE(sum > 0);
}
TEST (Benchmark_Buffer_GetLineString_Sequential)
{
std::cout << "\n=== Buffer GetLineString Sequential Benchmark ===\n";
Buffer buf;
std::string data = generate_large_file(10000, 80);
buf.insert_text(0, 0, data);
std::size_t total_chars = 0;
{
BenchmarkTimer timer("GetLineString on 10K lines");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
std::string line = buf.GetLineString(i);
total_chars += line.size();
}
}
EXPECT_TRUE(total_chars > 0);
}
TEST (Benchmark_Buffer_GetLineView_Sequential)
{
std::cout << "\n=== Buffer GetLineView Sequential Benchmark ===\n";
Buffer buf;
std::string data = generate_large_file(10000, 80);
buf.insert_text(0, 0, data);
std::size_t total_chars = 0;
{
BenchmarkTimer timer("GetLineView on 10K lines");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
auto view = buf.GetLineView(i);
total_chars += view.size();
}
}
EXPECT_TRUE(total_chars > 0);
}
TEST (Benchmark_Buffer_Rows_Materialization)
{
std::cout << "\n=== Buffer Rows() Materialization Benchmark ===\n";
Buffer buf;
std::string data = generate_large_file(10000, 80);
buf.insert_text(0, 0, data);
std::size_t total_chars = 0;
{
BenchmarkTimer timer("Rows() materialization + iteration on 10K lines");
const auto &rows = buf.Rows();
for (std::size_t i = 0; i < rows.size(); ++i) {
total_chars += rows[i].size();
}
}
EXPECT_TRUE(total_chars > 0);
}
TEST (Benchmark_Buffer_Iteration_Comparison)
{
std::cout << "\n=== Buffer Iteration Pattern Comparison ===\n";
Buffer buf;
std::string data = generate_large_file(5000, 80);
buf.insert_text(0, 0, data);
std::size_t sum1 = 0, sum2 = 0, sum3 = 0;
// Pattern 1: Old style with Rows()
{
BenchmarkTimer timer("Pattern 1: Rows() + iteration");
const auto &rows = buf.Rows();
for (std::size_t i = 0; i < rows.size(); ++i) {
sum1 += rows[i].size();
}
}
// Pattern 2: New style with GetLineString
{
BenchmarkTimer timer("Pattern 2: Nrows() + GetLineString");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
sum2 += buf.GetLineString(i).size();
}
}
// Pattern 3: New style with GetLineView (zero-copy)
{
BenchmarkTimer timer("Pattern 3: Nrows() + GetLineView (zero-copy)");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
sum3 += buf.GetLineView(i).size();
}
}
// sum1 and sum2 should match (both strip newlines)
ASSERT_EQ(sum1, sum2);
// sum3 includes newlines, so it will be larger
EXPECT_TRUE(sum3 > sum2);
}
// ============================================================================
// Syntax Highlighting Benchmarks
// ============================================================================
TEST (Benchmark_Syntax_CppHighlighter_Large_File)
{
std::cout << "\n=== Syntax Highlighting Benchmark ===\n";
Buffer buf;
std::string cpp_code = generate_cpp_code(1000);
buf.insert_text(0, 0, cpp_code);
buf.EnsureHighlighter();
auto highlighter = std::make_unique<kte::CppHighlighter>();
std::size_t total_spans = 0;
{
BenchmarkTimer timer("C++ highlighting on ~1000 lines");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
std::vector<kte::HighlightSpan> spans;
highlighter->HighlightLine(buf, static_cast<int>(i), spans);
total_spans += spans.size();
}
}
EXPECT_TRUE(total_spans > 0);
}
TEST (Benchmark_Syntax_HighlighterEngine_Cached)
{
std::cout << "\n=== HighlighterEngine Cache Benchmark ===\n";
Buffer buf;
std::string cpp_code = generate_cpp_code(1000);
buf.insert_text(0, 0, cpp_code);
buf.EnsureHighlighter();
auto *engine = buf.Highlighter();
if (engine) {
engine->SetHighlighter(std::make_unique<kte::CppHighlighter>());
// First pass: populate cache
{
BenchmarkTimer timer("First pass (cache population)");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
engine->GetLine(buf, static_cast<int>(i), buf.Version());
}
}
// Second pass: use cache
{
BenchmarkTimer timer("Second pass (cache hits)");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
engine->GetLine(buf, static_cast<int>(i), buf.Version());
}
}
}
}
// ============================================================================
// Large File Stress Tests
// ============================================================================
TEST (Benchmark_Large_File_50K_Lines)
{
std::cout << "\n=== Large File (50K lines) Benchmark ===\n";
Buffer buf;
std::string data = generate_large_file(50000, 80);
{
BenchmarkTimer timer("Insert 50K lines");
buf.insert_text(0, 0, data);
}
ASSERT_EQ(buf.Nrows(), (std::size_t) 50001); // +1 for final line
std::size_t total = 0;
{
BenchmarkTimer timer("Iterate 50K lines with GetLineView");
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
total += buf.GetLineView(i).size();
}
}
EXPECT_TRUE(total > 0);
}
TEST (Benchmark_Random_Access_Pattern)
{
std::cout << "\n=== Random Access Pattern Benchmark ===\n";
Buffer buf;
std::string data = generate_large_file(10000, 80);
buf.insert_text(0, 0, data);
std::mt19937 rng(456);
std::size_t total = 0;
{
BenchmarkTimer timer("10K random line accesses with GetLineView");
for (int i = 0; i < 10000; ++i) {
std::size_t line = rng() % buf.Nrows();
total += buf.GetLineView(line).size();
}
}
EXPECT_TRUE(total > 0);
}

View File

@@ -1,15 +1,36 @@
/*
* test_buffer_io.cc - Tests for Buffer file I/O operations
*
* This file validates the Buffer's file handling capabilities, which are
* critical for a text editor. Buffer manages the relationship between
* in-memory content and files on disk.
*
* Key functionality tested:
* - SaveAs() creates a new file and makes the buffer file-backed
* - Save() writes to the existing file (requires file-backed buffer)
* - OpenFromFile() loads existing files or creates empty buffers for new files
* - The dirty flag is properly managed across save operations
*
* These tests demonstrate the Buffer I/O contract that commands rely on.
* When adding new file operations, follow these patterns.
*/
#include "Test.h" #include "Test.h"
#include <fstream> #include <fstream>
#include <cstdio> #include <cstdio>
#include <string> #include <string>
#include "Buffer.h" #include "Buffer.h"
static std::string read_all(const std::string &path) {
static std::string
read_all(const std::string &path)
{
std::ifstream in(path, std::ios::binary); std::ifstream in(path, std::ios::binary);
return std::string((std::istreambuf_iterator<char>(in)), std::istreambuf_iterator<char>()); return std::string((std::istreambuf_iterator<char>(in)), std::istreambuf_iterator<char>());
} }
TEST(Buffer_SaveAs_and_Save_new_file) {
TEST (Buffer_SaveAs_and_Save_new_file)
{
const std::string path = "./.kte_ut_buffer_io_1.tmp"; const std::string path = "./.kte_ut_buffer_io_1.tmp";
std::remove(path.c_str()); std::remove(path.c_str());
@@ -34,7 +55,9 @@ TEST(Buffer_SaveAs_and_Save_new_file) {
std::remove(path.c_str()); std::remove(path.c_str());
} }
TEST(Buffer_Save_after_Open_existing) {
TEST (Buffer_Save_after_Open_existing)
{
const std::string path = "./.kte_ut_buffer_io_2.tmp"; const std::string path = "./.kte_ut_buffer_io_2.tmp";
std::remove(path.c_str()); std::remove(path.c_str());
{ {
@@ -57,7 +80,9 @@ TEST(Buffer_Save_after_Open_existing) {
std::remove(path.c_str()); std::remove(path.c_str());
} }
TEST(Buffer_Open_nonexistent_then_SaveAs) {
TEST (Buffer_Open_nonexistent_then_SaveAs)
{
const std::string path = "./.kte_ut_buffer_io_3.tmp"; const std::string path = "./.kte_ut_buffer_io_3.tmp";
std::remove(path.c_str()); std::remove(path.c_str());

142
tests/test_buffer_rows.cc Normal file
View File

@@ -0,0 +1,142 @@
#include "Test.h"
#include "Buffer.h"
#include <algorithm>
#include <limits>
#include <string>
#include <vector>
static std::vector<std::string>
split_lines_preserve_trailing_empty(const std::string &s)
{
std::vector<std::string> out;
std::size_t start = 0;
for (std::size_t i = 0; i <= s.size(); i++) {
if (i == s.size() || s[i] == '\n') {
out.push_back(s.substr(start, i - start));
start = i + 1;
}
}
if (out.empty())
out.push_back(std::string());
return out;
}
static std::vector<std::size_t>
line_starts_for(const std::string &s)
{
std::vector<std::size_t> starts;
starts.push_back(0);
for (std::size_t i = 0; i < s.size(); i++) {
if (s[i] == '\n')
starts.push_back(i + 1);
}
return starts;
}
static std::size_t
ref_linecol_to_offset(const std::string &s, std::size_t row, std::size_t col)
{
auto starts = line_starts_for(s);
if (starts.empty())
return 0;
if (row >= starts.size())
return s.size();
std::size_t start = starts[row];
std::size_t end = (row + 1 < starts.size()) ? starts[row + 1] : s.size();
if (end > start && s[end - 1] == '\n')
end -= 1; // clamp before trailing newline
return start + std::min(col, end - start);
}
static void
check_buffer_matches_model(const Buffer &b, const std::string &model)
{
auto expected_lines = split_lines_preserve_trailing_empty(model);
const auto &rows = b.Rows();
ASSERT_EQ(rows.size(), expected_lines.size());
ASSERT_EQ(b.Nrows(), rows.size());
auto starts = line_starts_for(model);
ASSERT_EQ(starts.size(), expected_lines.size());
std::string via_views;
for (std::size_t i = 0; i < rows.size(); i++) {
ASSERT_EQ(std::string(rows[i]), expected_lines[i]);
ASSERT_EQ(b.GetLineString(i), expected_lines[i]);
std::size_t exp_start = starts[i];
std::size_t exp_end = (i + 1 < starts.size()) ? starts[i + 1] : model.size();
auto r = b.GetLineRange(i);
ASSERT_EQ(r.first, exp_start);
ASSERT_EQ(r.second, exp_end);
auto v = b.GetLineView(i);
ASSERT_EQ(std::string(v), model.substr(exp_start, exp_end - exp_start));
via_views.append(v.data(), v.size());
}
ASSERT_EQ(via_views, model);
}
TEST(Buffer_RowsCache_MultiLineEdits_StayConsistent)
{
Buffer b;
std::string model;
check_buffer_matches_model(b, model);
// Insert text and newlines in a few different ways.
b.insert_text(0, 0, std::string("abc"));
model.insert(0, "abc");
check_buffer_matches_model(b, model);
b.split_line(0, 1); // a\nbc
model.insert(ref_linecol_to_offset(model, 0, 1), "\n");
check_buffer_matches_model(b, model);
b.insert_text(1, 2, std::string("X")); // a\nbcX
model.insert(ref_linecol_to_offset(model, 1, 2), "X");
check_buffer_matches_model(b, model);
b.join_lines(0); // abcX
{
std::size_t off = ref_linecol_to_offset(model, 0, std::numeric_limits<std::size_t>::max());
if (off < model.size() && model[off] == '\n')
model.erase(off, 1);
}
check_buffer_matches_model(b, model);
// Insert a multi-line segment in one shot.
b.insert_text(0, 2, std::string("\n123\nxyz"));
model.insert(ref_linecol_to_offset(model, 0, 2), "\n123\nxyz");
check_buffer_matches_model(b, model);
// Delete spanning across a newline.
b.delete_text(0, 1, 5);
{
std::size_t start = ref_linecol_to_offset(model, 0, 1);
std::size_t actual = std::min<std::size_t>(5, model.size() - start);
model.erase(start, actual);
}
check_buffer_matches_model(b, model);
// Insert/delete whole rows.
b.insert_row(1, std::string_view("ROW"));
model.insert(ref_linecol_to_offset(model, 1, 0), "ROW\n");
check_buffer_matches_model(b, model);
b.delete_row(1);
{
auto starts = line_starts_for(model);
if (1 < (int) starts.size()) {
std::size_t start = starts[1];
std::size_t end = (2 < starts.size()) ? starts[2] : model.size();
model.erase(start, end - start);
}
}
check_buffer_matches_model(b, model);
}

View File

@@ -0,0 +1,110 @@
#include "Test.h"
#include "TestHarness.h"
using ktet::TestHarness;
TEST(CommandSemantics_KillToEOL_KillChain_And_Yank)
{
TestHarness h;
Editor &ed = h.EditorRef();
Buffer &b = h.Buf();
b.insert_text(0, 0, std::string("abc\ndef"));
b.SetCursor(1, 0); // a|bc
ed.KillRingClear();
ed.SetKillChain(false);
ASSERT_TRUE(h.Exec(CommandId::KillToEOL));
ASSERT_EQ(h.Text(), std::string("a\ndef"));
ASSERT_EQ(ed.KillRingHead(), std::string("bc"));
// At EOL, KillToEOL kills the newline (join).
ASSERT_TRUE(h.Exec(CommandId::KillToEOL));
ASSERT_EQ(h.Text(), std::string("adef"));
ASSERT_EQ(ed.KillRingHead(), std::string("bc\n"));
// Yank pastes the kill ring head and breaks the kill chain.
ASSERT_TRUE(h.Exec(CommandId::Yank));
ASSERT_EQ(h.Text(), std::string("abc\ndef"));
ASSERT_EQ(ed.KillRingHead(), std::string("bc\n"));
ASSERT_EQ(ed.KillChain(), false);
}
TEST(CommandSemantics_ToggleMark_JumpToMark)
{
TestHarness h;
Buffer &b = h.Buf();
b.insert_text(0, 0, std::string("hello"));
b.SetCursor(2, 0);
ASSERT_EQ(b.MarkSet(), false);
ASSERT_TRUE(h.Exec(CommandId::ToggleMark));
ASSERT_EQ(b.MarkSet(), true);
ASSERT_EQ(b.MarkCurx(), (std::size_t) 2);
ASSERT_EQ(b.MarkCury(), (std::size_t) 0);
b.SetCursor(4, 0);
ASSERT_TRUE(h.Exec(CommandId::JumpToMark));
ASSERT_EQ(b.Curx(), (std::size_t) 2);
ASSERT_EQ(b.Cury(), (std::size_t) 0);
// Jump-to-mark swaps: mark becomes previous cursor.
ASSERT_EQ(b.MarkSet(), true);
ASSERT_EQ(b.MarkCurx(), (std::size_t) 4);
ASSERT_EQ(b.MarkCury(), (std::size_t) 0);
}
TEST(CommandSemantics_CtrlGRefresh_ClearsMark_WhenNothingElseToCancel)
{
TestHarness h;
Buffer &b = h.Buf();
b.insert_text(0, 0, std::string("hello"));
b.SetCursor(2, 0);
ASSERT_EQ(b.MarkSet(), false);
ASSERT_TRUE(h.Exec(CommandId::ToggleMark));
ASSERT_EQ(b.MarkSet(), true);
// C-g is mapped to Refresh; when there's no prompt/search/visual-line mode to cancel,
// it should clear the mark.
ASSERT_TRUE(h.Exec(CommandId::Refresh));
ASSERT_EQ(b.MarkSet(), false);
}
TEST(CommandSemantics_CopyRegion_And_KillRegion)
{
TestHarness h;
Editor &ed = h.EditorRef();
Buffer &b = h.Buf();
b.insert_text(0, 0, std::string("hello world"));
b.SetCursor(0, 0);
ed.KillRingClear();
ed.SetKillChain(false);
// Copy "hello" (region [0,5)).
ASSERT_TRUE(h.Exec(CommandId::ToggleMark));
b.SetCursor(5, 0);
ASSERT_TRUE(h.Exec(CommandId::CopyRegion));
ASSERT_EQ(ed.KillRingHead(), std::string("hello"));
ASSERT_EQ(b.MarkSet(), false);
ASSERT_EQ(h.Text(), std::string("hello world"));
// Kill "world" (region [6,11)).
ed.SetKillChain(false);
b.SetCursor(6, 0);
ASSERT_TRUE(h.Exec(CommandId::ToggleMark));
b.SetCursor(11, 0);
ASSERT_TRUE(h.Exec(CommandId::KillRegion));
ASSERT_EQ(ed.KillRingHead(), std::string("world"));
ASSERT_EQ(b.MarkSet(), false);
ASSERT_EQ(h.Text(), std::string("hello "));
}

View File

@@ -0,0 +1,12 @@
#include "Test.h"
#include "tests/TestHarness.h"
TEST(DailyDriverHarness_Smoke_CanCreateBufferAndInsertText)
{
ktet::TestHarness h;
ASSERT_TRUE(h.InsertText("hello"));
ASSERT_EQ(h.Line(0), std::string("hello"));
}

View File

@@ -0,0 +1,191 @@
/*
* test_daily_workflows.cc - Integration tests for real-world editing scenarios
*
* This file demonstrates end-to-end testing of kte functionality by simulating
* complete user workflows without requiring a UI. Tests execute commands directly
* through the command system, validating that the entire stack (Editor, Buffer,
* PieceTable, UndoSystem, SwapManager) works together correctly.
*
* Key workflows tested:
* - Open file → Edit → Save: Basic editing lifecycle
* - Multi-buffer management: Opening, switching, and closing multiple files
* - Crash recovery: Swap file recording and replay after simulated crash
*
* These tests are valuable examples for developers because they show:
* 1. How to test complex interactions without a frontend
* 2. How commands compose to implement user workflows
* 3. How to verify end-to-end behavior including file I/O and crash recovery
*
* When adding new features, consider adding integration tests here to validate
* that they work correctly in realistic scenarios.
*/
#include "Test.h"
#include "Command.h"
#include "Editor.h"
#include "tests/TestHarness.h" // for ktet::InstallDefaultCommandsOnce
#include <cstdio>
#include <filesystem>
#include <fstream>
#include <string>
static void
write_file_bytes(const std::string &path, const std::string &bytes)
{
std::ofstream out(path, std::ios::binary | std::ios::trunc);
out.write(bytes.data(), (std::streamsize) bytes.size());
}
static std::string
read_file_bytes(const std::string &path)
{
std::ifstream in(path, std::ios::binary);
return std::string((std::istreambuf_iterator<char>(in)), std::istreambuf_iterator<char>());
}
static std::string
buffer_bytes_via_views(const Buffer &b)
{
const auto &rows = b.Rows();
std::string out;
for (std::size_t i = 0; i < rows.size(); i++) {
auto v = b.GetLineView(i);
out.append(v.data(), v.size());
}
return out;
}
TEST (DailyWorkflow_OpenEditSave_Transcript)
{
ktet::InstallDefaultCommandsOnce();
const std::string path = "./.kte_ut_daily_open_edit_save.txt";
std::remove(path.c_str());
write_file_bytes(path, "one\n");
const std::string npath = std::filesystem::canonical(path).string();
Editor ed;
ed.SetDimensions(24, 80);
// Seed an empty buffer so OpenFile can reuse it.
{
Buffer scratch;
ed.AddBuffer(std::move(scratch));
}
std::string err;
ASSERT_TRUE(ed.OpenFile(path, err));
ASSERT_TRUE(ed.CurrentBuffer() != nullptr);
ASSERT_EQ(ed.CurrentBuffer()->Filename(), npath);
// Append two new lines via commands (no UI).
ASSERT_TRUE(Execute(ed, CommandId::MoveFileEnd));
ASSERT_TRUE(Execute(ed, CommandId::InsertText, "two"));
ASSERT_TRUE(Execute(ed, CommandId::Newline));
ASSERT_TRUE(Execute(ed, CommandId::InsertText, "three"));
ASSERT_TRUE(Execute(ed, CommandId::Save));
ASSERT_TRUE(ed.CurrentBuffer() != nullptr);
ASSERT_EQ(read_file_bytes(npath), buffer_bytes_via_views(*ed.CurrentBuffer()));
std::remove(path.c_str());
std::remove(npath.c_str());
}
TEST (DailyWorkflow_MultiBufferSwitchClose_Transcript)
{
ktet::InstallDefaultCommandsOnce();
const std::string p1 = "./.kte_ut_daily_buf_1.txt";
const std::string p2 = "./.kte_ut_daily_buf_2.txt";
std::remove(p1.c_str());
std::remove(p2.c_str());
write_file_bytes(p1, "aaa\n");
write_file_bytes(p2, "bbb\n");
const std::string np1 = std::filesystem::canonical(p1).string();
const std::string np2 = std::filesystem::canonical(p2).string();
Editor ed;
ed.SetDimensions(24, 80);
{
Buffer scratch;
ed.AddBuffer(std::move(scratch));
}
std::string err;
ASSERT_TRUE(ed.OpenFile(p1, err));
ASSERT_TRUE(ed.OpenFile(p2, err));
ASSERT_EQ(ed.BufferCount(), (std::size_t) 2);
ASSERT_TRUE(ed.CurrentBuffer() != nullptr);
ASSERT_EQ(ed.CurrentBuffer()->Filename(), np2);
// Switch back and forth.
ASSERT_TRUE(Execute(ed, CommandId::BufferPrev));
ASSERT_EQ(ed.CurrentBuffer()->Filename(), np1);
ASSERT_TRUE(Execute(ed, CommandId::BufferNext));
ASSERT_EQ(ed.CurrentBuffer()->Filename(), np2);
// Close current buffer (p2); ensure we land on p1.
ASSERT_TRUE(Execute(ed, CommandId::BufferClose));
ASSERT_EQ(ed.BufferCount(), (std::size_t) 1);
ASSERT_TRUE(ed.CurrentBuffer() != nullptr);
ASSERT_EQ(ed.CurrentBuffer()->Filename(), np1);
std::remove(p1.c_str());
std::remove(p2.c_str());
std::remove(np1.c_str());
std::remove(np2.c_str());
}
TEST (DailyWorkflow_CrashRecovery_SwapReplay_Transcript)
{
ktet::InstallDefaultCommandsOnce();
const std::string path = "./.kte_ut_daily_swap_recover.txt";
std::remove(path.c_str());
write_file_bytes(path, "base\nline2\n");
Editor ed;
ed.SetDimensions(24, 80);
{
Buffer scratch;
ed.AddBuffer(std::move(scratch));
}
std::string err;
ASSERT_TRUE(ed.OpenFile(path, err));
Buffer *buf = ed.CurrentBuffer();
ASSERT_TRUE(buf != nullptr);
// Make unsaved edits through command execution.
ASSERT_TRUE(Execute(ed, CommandId::MoveFileStart));
ASSERT_TRUE(Execute(ed, CommandId::InsertText, "X"));
ASSERT_TRUE(Execute(ed, CommandId::MoveDown));
ASSERT_TRUE(Execute(ed, CommandId::MoveHome));
ASSERT_TRUE(Execute(ed, CommandId::InsertText, "ZZ"));
ASSERT_TRUE(Execute(ed, CommandId::MoveFileEnd));
ASSERT_TRUE(Execute(ed, CommandId::InsertText, "TAIL"));
// Ensure journal is durable and capture expected bytes.
ed.Swap()->Flush(buf);
const std::string swap_path = kte::SwapManager::ComputeSwapPathForTests(*buf);
const std::string expected = buffer_bytes_via_views(*buf);
// "Crash": reopen from disk (original file content) into a fresh Buffer and replay.
Buffer recovered;
ASSERT_TRUE(recovered.OpenFromFile(path, err));
ASSERT_TRUE(kte::SwapManager::ReplayFile(recovered, swap_path, err));
ASSERT_EQ(buffer_bytes_via_views(recovered), expected);
// Cleanup.
ed.Swap()->Detach(buf);
std::remove(path.c_str());
std::remove(swap_path.c_str());
}

84
tests/test_kkeymap.cc Normal file
View File

@@ -0,0 +1,84 @@
#include "Test.h"
#include "KKeymap.h"
#include <ncurses.h>
TEST(KKeymap_KPrefix_CanonicalChords)
{
CommandId id{};
// From docs/ke.md (K-commands)
ASSERT_TRUE(KLookupKCommand('s', false, id));
ASSERT_EQ(id, CommandId::Save);
ASSERT_TRUE(KLookupKCommand('s', true, id)); // C-k C-s
ASSERT_EQ(id, CommandId::Save);
ASSERT_TRUE(KLookupKCommand('d', false, id));
ASSERT_EQ(id, CommandId::KillToEOL);
ASSERT_TRUE(KLookupKCommand('d', true, id)); // C-k C-d
ASSERT_EQ(id, CommandId::KillLine);
ASSERT_TRUE(KLookupKCommand(' ', false, id)); // C-k SPACE
ASSERT_EQ(id, CommandId::ToggleMark);
ASSERT_TRUE(KLookupKCommand('j', false, id));
ASSERT_EQ(id, CommandId::JumpToMark);
ASSERT_TRUE(KLookupKCommand('f', false, id));
ASSERT_EQ(id, CommandId::FlushKillRing);
ASSERT_TRUE(KLookupKCommand('y', false, id));
ASSERT_EQ(id, CommandId::Yank);
// Unknown should not map
ASSERT_EQ(KLookupKCommand('Z', false, id), false);
}
TEST(KKeymap_CtrlChords_CanonicalChords)
{
CommandId id{};
// From docs/ke.md (other keybindings)
ASSERT_TRUE(KLookupCtrlCommand('n', id));
ASSERT_EQ(id, CommandId::MoveDown);
ASSERT_TRUE(KLookupCtrlCommand('p', id));
ASSERT_EQ(id, CommandId::MoveUp);
ASSERT_TRUE(KLookupCtrlCommand('f', id));
ASSERT_EQ(id, CommandId::MoveRight);
ASSERT_TRUE(KLookupCtrlCommand('b', id));
ASSERT_EQ(id, CommandId::MoveLeft);
ASSERT_TRUE(KLookupCtrlCommand('w', id));
ASSERT_EQ(id, CommandId::KillRegion);
ASSERT_TRUE(KLookupCtrlCommand('y', id));
ASSERT_EQ(id, CommandId::Yank);
ASSERT_EQ(KLookupCtrlCommand('z', id), false);
}
TEST(KKeymap_EscChords_CanonicalChords)
{
CommandId id{};
// From docs/ke.md (ESC bindings)
ASSERT_TRUE(KLookupEscCommand('b', id));
ASSERT_EQ(id, CommandId::WordPrev);
ASSERT_TRUE(KLookupEscCommand('f', id));
ASSERT_EQ(id, CommandId::WordNext);
ASSERT_TRUE(KLookupEscCommand('d', id));
ASSERT_EQ(id, CommandId::DeleteWordNext);
ASSERT_TRUE(KLookupEscCommand('q', id));
ASSERT_EQ(id, CommandId::ReflowParagraph);
ASSERT_TRUE(KLookupEscCommand('w', id));
ASSERT_EQ(id, CommandId::CopyRegion);
// ESC BACKSPACE
ASSERT_TRUE(KLookupEscCommand(KEY_BACKSPACE, id));
ASSERT_EQ(id, CommandId::DeleteWordPrev);
ASSERT_EQ(KLookupEscCommand('z', id), false);
}

View File

@@ -0,0 +1,448 @@
/*
* test_migration_coverage.cc - Edge case tests for Buffer::Line migration
*
* This file provides comprehensive test coverage for the migration from
* Buffer::Rows() to direct PieceTable operations using Nrows(), GetLineString(),
* and GetLineView().
*
* Tests cover:
* - Edge cases: empty buffers, single lines, very long lines
* - Boundary conditions: first line, last line, out-of-bounds
* - Consistency: GetLineString vs GetLineView vs Rows()
* - Performance: large files, many small operations
* - Correctness: special characters, newlines, unicode
*/
#include "Test.h"
#include "Buffer.h"
#include <string>
#include <vector>
// ============================================================================
// Edge Case Tests
// ============================================================================
TEST (Migration_EmptyBuffer_Nrows)
{
Buffer buf;
ASSERT_EQ(buf.Nrows(), (std::size_t) 1); // Empty buffer has 1 logical line
}
TEST (Migration_EmptyBuffer_GetLineString)
{
Buffer buf;
ASSERT_EQ(buf.GetLineString(0), std::string(""));
}
TEST (Migration_EmptyBuffer_GetLineView)
{
Buffer buf;
auto view = buf.GetLineView(0);
ASSERT_EQ(view.size(), (std::size_t) 0);
ASSERT_EQ(std::string(view), std::string(""));
}
TEST (Migration_SingleLine_NoNewline)
{
Buffer buf;
buf.insert_text(0, 0, std::string("hello"));
ASSERT_EQ(buf.Nrows(), (std::size_t) 1);
ASSERT_EQ(buf.GetLineString(0), std::string("hello"));
ASSERT_EQ(std::string(buf.GetLineView(0)), std::string("hello"));
}
TEST (Migration_SingleLine_WithNewline)
{
Buffer buf;
buf.insert_text(0, 0, std::string("hello\n"));
ASSERT_EQ(buf.Nrows(), (std::size_t) 2); // Line + empty line after newline
ASSERT_EQ(buf.GetLineString(0), std::string("hello"));
ASSERT_EQ(buf.GetLineString(1), std::string(""));
}
TEST (Migration_MultipleLines_TrailingNewline)
{
Buffer buf;
buf.insert_text(0, 0, std::string("line1\nline2\nline3\n"));
ASSERT_EQ(buf.Nrows(), (std::size_t) 4); // 3 lines + empty line
ASSERT_EQ(buf.GetLineString(0), std::string("line1"));
ASSERT_EQ(buf.GetLineString(1), std::string("line2"));
ASSERT_EQ(buf.GetLineString(2), std::string("line3"));
ASSERT_EQ(buf.GetLineString(3), std::string(""));
}
TEST (Migration_MultipleLines_NoTrailingNewline)
{
Buffer buf;
buf.insert_text(0, 0, std::string("line1\nline2\nline3"));
ASSERT_EQ(buf.Nrows(), (std::size_t) 3);
ASSERT_EQ(buf.GetLineString(0), std::string("line1"));
ASSERT_EQ(buf.GetLineString(1), std::string("line2"));
ASSERT_EQ(buf.GetLineString(2), std::string("line3"));
}
TEST (Migration_VeryLongLine)
{
Buffer buf;
std::string long_line(10000, 'x');
buf.insert_text(0, 0, long_line);
ASSERT_EQ(buf.Nrows(), (std::size_t) 1);
ASSERT_EQ(buf.GetLineString(0), long_line);
ASSERT_EQ(buf.GetLineString(0).size(), (std::size_t) 10000);
}
TEST (Migration_ManyEmptyLines)
{
Buffer buf;
std::string many_newlines(1000, '\n');
buf.insert_text(0, 0, many_newlines);
ASSERT_EQ(buf.Nrows(), (std::size_t) 1001); // 1000 newlines = 1001 lines
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
ASSERT_EQ(buf.GetLineString(i), std::string(""));
}
}
// ============================================================================
// Consistency Tests: GetLineString vs GetLineView vs Rows()
// ============================================================================
TEST (Migration_Consistency_AllMethods)
{
Buffer buf;
buf.insert_text(0, 0, std::string("abc\n123\nxyz"));
const auto &rows = buf.Rows();
ASSERT_EQ(buf.Nrows(), rows.size());
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
std::string via_string = buf.GetLineString(i);
std::string via_rows = std::string(rows[i]);
// GetLineString and Rows() both strip newlines
ASSERT_EQ(via_string, via_rows);
// GetLineView includes the raw range (with newlines if present)
// Just verify it's accessible
(void) buf.GetLineView(i);
}
}
TEST (Migration_Consistency_AfterEdits)
{
Buffer buf;
buf.insert_text(0, 0, std::string("line1\nline2\nline3\n"));
// Edit: insert in middle
buf.insert_text(1, 2, std::string("XX"));
const auto &rows = buf.Rows();
ASSERT_EQ(buf.Nrows(), rows.size());
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
// GetLineString and Rows() both strip newlines
ASSERT_EQ(buf.GetLineString(i), std::string(rows[i]));
}
// Edit: delete line
buf.delete_row(1);
const auto &rows2 = buf.Rows();
ASSERT_EQ(buf.Nrows(), rows2.size());
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
ASSERT_EQ(buf.GetLineString(i), std::string(rows2[i]));
}
}
// ============================================================================
// Boundary Tests
// ============================================================================
TEST (Migration_FirstLine_Access)
{
Buffer buf;
buf.insert_text(0, 0, std::string("first\nsecond\nthird"));
ASSERT_EQ(buf.GetLineString(0), std::string("first"));
// GetLineView includes newline: "first\n"
auto view0 = buf.GetLineView(0);
EXPECT_TRUE(view0.size() >= 5); // at least "first"
}
TEST (Migration_LastLine_Access)
{
Buffer buf;
buf.insert_text(0, 0, std::string("first\nsecond\nthird"));
std::size_t last = buf.Nrows() - 1;
ASSERT_EQ(buf.GetLineString(last), std::string("third"));
ASSERT_EQ(std::string(buf.GetLineView(last)), std::string("third"));
}
TEST (Migration_GetLineRange_Boundaries)
{
Buffer buf;
buf.insert_text(0, 0, std::string("abc\n123\nxyz"));
// First line
auto r0 = buf.GetLineRange(0);
ASSERT_EQ(r0.first, (std::size_t) 0);
ASSERT_EQ(r0.second, (std::size_t) 4); // "abc\n"
// Last line
std::size_t last = buf.Nrows() - 1;
(void) buf.GetLineRange(last); // Verify it doesn't crash
ASSERT_EQ(buf.GetLineString(last), std::string("xyz"));
}
// ============================================================================
// Special Characters and Unicode
// ============================================================================
TEST (Migration_SpecialChars_Tabs)
{
Buffer buf;
buf.insert_text(0, 0, std::string("line\twith\ttabs"));
ASSERT_EQ(buf.GetLineString(0), std::string("line\twith\ttabs"));
ASSERT_EQ(std::string(buf.GetLineView(0)), std::string("line\twith\ttabs"));
}
TEST (Migration_SpecialChars_CarriageReturn)
{
Buffer buf;
buf.insert_text(0, 0, std::string("line\rwith\rcr"));
ASSERT_EQ(buf.GetLineString(0), std::string("line\rwith\rcr"));
}
TEST (Migration_SpecialChars_NullBytes)
{
Buffer buf;
std::string with_null = "abc";
with_null.push_back('\0');
with_null += "def";
buf.insert_text(0, 0, with_null);
ASSERT_EQ(buf.GetLineString(0).size(), (std::size_t) 7);
ASSERT_EQ(buf.GetLineView(0).size(), (std::size_t) 7);
}
TEST (Migration_Unicode_BasicMultibyte)
{
Buffer buf;
std::string utf8 = "Hello 世界 🌍";
buf.insert_text(0, 0, utf8);
ASSERT_EQ(buf.GetLineString(0), utf8);
ASSERT_EQ(std::string(buf.GetLineView(0)), utf8);
}
// ============================================================================
// Large File Tests
// ============================================================================
TEST (Migration_LargeFile_10K_Lines)
{
Buffer buf;
std::string data;
for (int i = 0; i < 10000; ++i) {
data += "Line " + std::to_string(i) + "\n";
}
buf.insert_text(0, 0, data);
ASSERT_EQ(buf.Nrows(), (std::size_t) 10001); // +1 for final empty line
// Spot check some lines
ASSERT_EQ(buf.GetLineString(0), std::string("Line 0"));
ASSERT_EQ(buf.GetLineString(5000), std::string("Line 5000"));
ASSERT_EQ(buf.GetLineString(9999), std::string("Line 9999"));
ASSERT_EQ(buf.GetLineString(10000), std::string(""));
}
TEST (Migration_LargeFile_Iteration_Consistency)
{
Buffer buf;
std::string data;
for (int i = 0; i < 1000; ++i) {
data += "Line " + std::to_string(i) + "\n";
}
buf.insert_text(0, 0, data);
// Iterate with GetLineString (strips newlines, must add back)
std::string reconstructed1;
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
if (i > 0) {
reconstructed1 += '\n';
}
reconstructed1 += buf.GetLineString(i);
}
// Iterate with GetLineView (includes newlines)
std::string reconstructed2;
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
auto view = buf.GetLineView(i);
reconstructed2.append(view.data(), view.size());
}
// GetLineView should match original exactly
ASSERT_EQ(reconstructed2, data);
// GetLineString reconstruction should match (without final empty line)
EXPECT_TRUE(reconstructed1.size() > 0);
}
// ============================================================================
// Stress Tests: Many Small Operations
// ============================================================================
TEST (Migration_Stress_ManySmallInserts)
{
Buffer buf;
buf.insert_text(0, 0, std::string("start\n"));
for (int i = 0; i < 100; ++i) {
buf.insert_text(1, 0, std::string("x"));
}
ASSERT_EQ(buf.Nrows(), (std::size_t) 2);
ASSERT_EQ(buf.GetLineString(0), std::string("start"));
ASSERT_EQ(buf.GetLineString(1).size(), (std::size_t) 100);
// Verify consistency
const auto &rows = buf.Rows();
ASSERT_EQ(buf.GetLineString(1), std::string(rows[1]));
}
TEST (Migration_Stress_ManyLineInserts)
{
Buffer buf;
for (int i = 0; i < 500; ++i) {
buf.insert_row(buf.Nrows() - 1, std::string_view("line"));
}
ASSERT_EQ(buf.Nrows(), (std::size_t) 501); // 500 + initial empty line
for (std::size_t i = 0; i < 500; ++i) {
ASSERT_EQ(buf.GetLineString(i), std::string("line"));
}
}
TEST (Migration_Stress_AlternatingInsertDelete)
{
Buffer buf;
buf.insert_text(0, 0, std::string("a\nb\nc\nd\ne\n"));
for (int i = 0; i < 50; ++i) {
std::size_t nrows = buf.Nrows();
if (nrows > 2) {
buf.delete_row(1);
}
buf.insert_row(1, std::string_view("new"));
}
// Verify consistency after many operations
const auto &rows = buf.Rows();
ASSERT_EQ(buf.Nrows(), rows.size());
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
// GetLineString and Rows() both strip newlines
ASSERT_EQ(buf.GetLineString(i), std::string(rows[i]));
}
}
// ============================================================================
// Regression Tests: Specific Migration Scenarios
// ============================================================================
TEST (Migration_Shebang_Detection)
{
// Test the pattern used in Editor.cc for shebang detection
Buffer buf;
buf.insert_text(0, 0, std::string("#!/usr/bin/env python3\nprint('hello')"));
ASSERT_EQ(buf.Nrows(), (std::size_t) 2);
std::string first_line = "";
if (buf.Nrows() > 0) {
first_line = buf.GetLineString(0);
}
ASSERT_EQ(first_line, std::string("#!/usr/bin/env python3"));
}
TEST (Migration_EmptyBufferCheck_Pattern)
{
// Test the pattern used in Editor.cc for empty buffer detection
Buffer buf;
const std::size_t nrows = buf.Nrows();
const bool rows_empty = (nrows == 0);
const bool single_empty_line = (nrows == 1 && buf.GetLineView(0).size() == 0);
ASSERT_EQ(rows_empty, false);
ASSERT_EQ(single_empty_line, true);
}
TEST (Migration_SyntaxHighlighter_Pattern)
{
// Test the pattern used in syntax highlighters
Buffer buf;
buf.insert_text(0, 0, std::string("int main() {\n return 0;\n}"));
for (std::size_t row = 0; row < buf.Nrows(); ++row) {
// This is the pattern used in all migrated highlighters
if (row >= buf.Nrows()) {
break; // Should never happen
}
std::string line = buf.GetLineString(row);
// Successfully accessed line - size() is always valid for std::string
}
}
TEST (Migration_SwapSnapshot_Pattern)
{
// Test the pattern used in Swap.cc for buffer snapshots
Buffer buf;
buf.insert_text(0, 0, std::string("line1\nline2\nline3\n"));
const std::size_t nrows = buf.Nrows();
std::string snapshot;
for (std::size_t i = 0; i < nrows; ++i) {
auto view = buf.GetLineView(i);
snapshot.append(view.data(), view.size());
}
EXPECT_TRUE(snapshot.size() > 0);
ASSERT_EQ(snapshot, std::string("line1\nline2\nline3\n"));
}

View File

@@ -1,8 +1,59 @@
/*
* test_piece_table.cc - Tests for the PieceTable data structure
*
* This file validates the core text storage mechanism used by kte.
* PieceTable provides efficient insert/delete operations without copying
* the entire buffer, using a list of "pieces" that reference ranges in
* original and add buffers.
*
* Key functionality tested:
* - Insert/delete operations maintain correct content
* - Line counting and line-based queries work correctly
* - Position conversion (byte offset ↔ line/column) is accurate
* - Random edits against a reference model (string) produce identical results
*
* The random edit test is particularly important - it performs hundreds of
* random insertions and deletions, comparing PieceTable results against a
* simple std::string to ensure correctness under all conditions.
*/
#include "Test.h" #include "Test.h"
#include "PieceTable.h" #include "PieceTable.h"
#include <algorithm>
#include <array>
#include <random>
#include <string> #include <string>
#include <vector>
TEST(PieceTable_Insert_Delete_LineCount) {
static std::vector<std::size_t>
LineStartsFor(const std::string &s)
{
std::vector<std::size_t> starts;
starts.push_back(0);
for (std::size_t i = 0; i < s.size(); i++) {
if (s[i] == '\n')
starts.push_back(i + 1);
}
return starts;
}
static std::string
LineContentFor(const std::string &s, std::size_t line_num)
{
auto starts = LineStartsFor(s);
if (starts.empty() || line_num >= starts.size())
return std::string();
std::size_t start = starts[line_num];
std::size_t end = (line_num + 1 < starts.size()) ? starts[line_num + 1] : s.size();
if (end > start && s[end - 1] == '\n')
end -= 1;
return s.substr(start, end - start);
}
TEST (PieceTable_Insert_Delete_LineCount)
{
PieceTable pt; PieceTable pt;
// start empty // start empty
ASSERT_EQ(pt.Size(), (std::size_t) 0); ASSERT_EQ(pt.Size(), (std::size_t) 0);
@@ -27,7 +78,9 @@ TEST(PieceTable_Insert_Delete_LineCount) {
ASSERT_EQ(pt.GetLine(1), std::string("xyz")); ASSERT_EQ(pt.GetLine(1), std::string("xyz"));
} }
TEST(PieceTable_LineCol_Conversions) {
TEST (PieceTable_LineCol_Conversions)
{
PieceTable pt; PieceTable pt;
std::string s = "hello\nworld\n"; // two lines with trailing NL std::string s = "hello\nworld\n"; // two lines with trailing NL
pt.Insert(0, s.data(), s.size()); pt.Insert(0, s.data(), s.size());
@@ -47,3 +100,100 @@ TEST(PieceTable_LineCol_Conversions) {
ASSERT_EQ(lc1.first, (std::size_t) 1); ASSERT_EQ(lc1.first, (std::size_t) 1);
ASSERT_EQ(lc1.second, (std::size_t) 0); ASSERT_EQ(lc1.second, (std::size_t) 0);
} }
TEST (PieceTable_ReferenceModel_RandomEdits_Deterministic)
{
PieceTable pt;
std::string model;
std::mt19937 rng(0xC0FFEEu);
const std::vector<std::string> corpus = {
"a",
"b",
"c",
"xyz",
"123",
"\n",
"!\n",
"foo\nbar",
"end\n",
};
auto check_invariants = [&](const char *where) {
(void) where;
ASSERT_EQ(pt.Size(), model.size());
ASSERT_EQ(pt.GetRange(0, pt.Size()), model);
auto starts = LineStartsFor(model);
ASSERT_EQ(pt.LineCount(), starts.size());
// Spot-check a few line ranges and contents.
std::size_t last = starts.empty() ? (std::size_t) 0 : (starts.size() - 1);
std::size_t mid = (starts.size() > 2) ? (std::size_t) 1 : last;
const std::array<std::size_t, 3> probe_lines = {(std::size_t) 0, last, mid};
for (auto line: probe_lines) {
if (starts.empty())
break;
if (line >= starts.size())
continue;
std::size_t exp_start = starts[line];
std::size_t exp_end = (line + 1 < starts.size()) ? starts[line + 1] : model.size();
auto r = pt.GetLineRange(line);
ASSERT_EQ(r.first, exp_start);
ASSERT_EQ(r.second, exp_end);
ASSERT_EQ(pt.GetLine(line), LineContentFor(model, line));
}
// Round-trips for a few offsets.
const std::vector<std::size_t> probe_offsets = {
0,
model.size() / 2,
model.size(),
};
for (auto off: probe_offsets) {
auto lc = pt.ByteOffsetToLineCol(off);
auto back = pt.LineColToByteOffset(lc.first, lc.second);
ASSERT_EQ(back, off);
}
};
check_invariants("initial");
for (int step = 0; step < 250; step++) {
bool do_insert = model.empty() || ((rng() % 3u) != 0u); // bias toward insert
if (do_insert) {
const std::string &ins = corpus[rng() % corpus.size()];
std::size_t pos = model.empty() ? 0 : (rng() % (model.size() + 1));
pt.Insert(pos, ins.data(), ins.size());
model.insert(pos, ins);
} else {
std::size_t pos = rng() % model.size();
std::size_t max = std::min<std::size_t>(8, model.size() - pos);
std::size_t len = 1 + (rng() % max);
pt.Delete(pos, len);
model.erase(pos, len);
}
// Also validate GetRange on a small random window when non-empty.
if (!model.empty()) {
std::size_t off = rng() % model.size();
std::size_t max = std::min<std::size_t>(16, model.size() - off);
std::size_t len = 1 + (rng() % max);
ASSERT_EQ(pt.GetRange(off, len), model.substr(off, len));
}
check_invariants("step");
}
// Full line-by-line range verification at the end.
auto starts = LineStartsFor(model);
for (std::size_t line = 0; line < starts.size(); line++) {
std::size_t exp_start = starts[line];
std::size_t exp_end = (line + 1 < starts.size()) ? starts[line + 1] : model.size();
auto r = pt.GetLineRange(line);
ASSERT_EQ(r.first, exp_start);
ASSERT_EQ(r.second, exp_end);
ASSERT_EQ(pt.GetLine(line), LineContentFor(model, line));
}
}

View File

@@ -0,0 +1,78 @@
#include "Test.h"
#include "Buffer.h"
#include "Command.h"
#include "Editor.h"
#include <iostream>
#include <string>
static std::string
to_string_rows(const Buffer &buf)
{
std::string out;
for (const auto &r: buf.Rows()) {
out += static_cast<std::string>(r);
out.push_back('\n');
}
return out;
}
TEST(ReflowParagraph_IndentedBullets_PreserveStructure)
{
InstallDefaultCommands();
Editor ed;
ed.SetDimensions(24, 80);
Buffer b;
// Test the example from the issue: indented list items should not be merged
const std::string initial =
"+ something at the top\n"
" + something indented\n"
"+ the next line\n";
b.insert_text(0, 0, initial);
// Put cursor on first item
b.SetCursor(0, 0);
ed.AddBuffer(std::move(b));
Buffer *buf = ed.CurrentBuffer();
ASSERT_TRUE(buf != nullptr);
// Use a width that's larger than all lines (so no wrapping should occur)
const int width = 80;
ASSERT_TRUE(Execute(ed, std::string("reflow-paragraph"), std::string(), width));
const auto &rows = buf->Rows();
const std::string result = to_string_rows(*buf);
// We should have 3 lines (plus possibly a trailing empty line)
ASSERT_TRUE(rows.size() >= 3);
// Check that the structure is preserved
std::string line0 = static_cast<std::string>(rows[0]);
std::string line1 = static_cast<std::string>(rows[1]);
std::string line2 = static_cast<std::string>(rows[2]);
// First line should start with "+ "
EXPECT_TRUE(line0.rfind("+ ", 0) == 0);
EXPECT_TRUE(line0.find("something at the top") != std::string::npos);
// Second line should start with " + " (two spaces, then +)
EXPECT_TRUE(line1.rfind(" + ", 0) == 0);
EXPECT_TRUE(line1.find("something indented") != std::string::npos);
// Third line should start with "+ "
EXPECT_TRUE(line2.rfind("+ ", 0) == 0);
EXPECT_TRUE(line2.find("the next line") != std::string::npos);
// The indented line should NOT be merged with the first line
EXPECT_TRUE(line0.find("indented") == std::string::npos);
// Debug output if something goes wrong
if (line0.rfind("+ ", 0) != 0 || line1.rfind(" + ", 0) != 0 || line2.rfind("+ ", 0) != 0) {
std::cerr << "Reflow did not preserve indented bullet structure:\n" << result << "\n";
}
}

View File

@@ -0,0 +1,102 @@
#include "Test.h"
#include "Buffer.h"
#include "Command.h"
#include "Editor.h"
#include <iostream>
#include <string>
static std::string
to_string_rows(const Buffer &buf)
{
std::string out;
for (const auto &r: buf.Rows()) {
out += static_cast<std::string>(r);
out.push_back('\n');
}
return out;
}
TEST(ReflowParagraph_NumberedList_HangingIndent)
{
InstallDefaultCommands();
Editor ed;
ed.SetDimensions(24, 80);
Buffer b;
// Two list items in one paragraph (no blank lines).
// Second line of each item already uses a hanging indent.
const std::string initial =
"1. one two three four five six seven eight nine ten eleven\n"
" twelve thirteen fourteen\n"
"10. alpha beta gamma delta epsilon zeta eta theta iota kappa lambda\n"
" mu nu xi omicron\n";
b.insert_text(0, 0, initial);
// Put cursor on first item
b.SetCursor(0, 0);
ed.AddBuffer(std::move(b));
Buffer *buf = ed.CurrentBuffer();
ASSERT_TRUE(buf != nullptr);
const int width = 25;
ASSERT_TRUE(Execute(ed, std::string("reflow-paragraph"), std::string(), width));
const auto &rows = buf->Rows();
ASSERT_TRUE(!rows.empty());
const std::string dump = to_string_rows(*buf);
// Find the start of the second item.
bool any_too_long = false;
std::size_t idx_10 = rows.size();
for (std::size_t i = 0; i < rows.size(); ++i) {
const std::string line = static_cast<std::string>(rows[i]);
if (static_cast<int>(line.size()) > width)
any_too_long = true;
if (line.rfind("10. ", 0) == 0) {
idx_10 = i;
break;
}
}
ASSERT_TRUE(idx_10 < rows.size());
if (any_too_long) {
std::cerr << "Reflow produced a line longer than width=" << width << "\n";
std::cerr << to_string_rows(*buf) << "\n";
}
EXPECT_TRUE(!any_too_long);
// Item 1: first line has "1. ", continuation lines have 3 spaces.
for (std::size_t i = 0; i < idx_10; ++i) {
const std::string line = static_cast<std::string>(rows[i]);
if (i == 0) {
ASSERT_TRUE(line.rfind("1. ", 0) == 0);
} else {
ASSERT_TRUE(line.rfind(" ", 0) == 0);
ASSERT_TRUE(line.rfind("1. ", 0) != 0);
}
}
// Item 10: first line has "10. ", continuation lines have 4 spaces.
ASSERT_TRUE(static_cast<std::string>(rows[idx_10]).rfind("10. ", 0) == 0);
bool bad_10 = false;
for (std::size_t i = idx_10 + 1; i < rows.size(); ++i) {
const std::string line = static_cast<std::string>(rows[i]);
if (line.empty())
break; // paragraph terminator / trailing empty line
if (line.rfind(" ", 0) != 0)
bad_10 = true;
if (line.rfind("10. ", 0) == 0)
bad_10 = true;
}
if (bad_10) {
std::cerr << "Unexpected prefix in reflow output:\n" << dump << "\n";
}
ASSERT_TRUE(!bad_10);
// Debug helper if something goes wrong (kept as a string for easy inspection).
EXPECT_TRUE(!to_string_rows(*buf).empty());
}

69
tests/test_reflow_undo.cc Normal file
View File

@@ -0,0 +1,69 @@
#include "Test.h"
#include "Buffer.h"
#include "Command.h"
#include "Editor.h"
#include "UndoSystem.h"
#include <string>
static std::string
to_string_rows(const Buffer &buf)
{
std::string out;
for (const auto &r: buf.Rows()) {
out += static_cast<std::string>(r);
out.push_back('\n');
}
return out;
}
TEST (ReflowUndo)
{
InstallDefaultCommands();
Editor ed;
ed.SetDimensions(24, 80);
Buffer b;
const std::string initial =
"This is a very long line that should be reflowed into multiple lines to see if undo works correctly.\n";
b.insert_text(0, 0, initial);
b.SetCursor(0, 0);
// Commit initial insertion so it's its own undo step
if (auto *u = b.Undo())
u->commit();
ed.AddBuffer(std::move(b));
Buffer *buf = ed.CurrentBuffer();
ASSERT_TRUE(buf != nullptr);
const std::string original_dump = to_string_rows(*buf);
// Reflow with small width
const int width = 20;
ASSERT_TRUE(Execute(ed, "reflow-paragraph", "", width));
const std::string reflowed_dump = to_string_rows(*buf);
ASSERT_TRUE(reflowed_dump != original_dump);
ASSERT_TRUE(buf->Rows().size() > 1);
// Undo reflow
ASSERT_TRUE(Execute(ed, "undo", "", 1));
const std::string after_undo_dump = to_string_rows(*buf);
if (after_undo_dump != original_dump) {
fprintf(stderr, "Undo failed.\nExpected:\n%s\nGot:\n%s\n", original_dump.c_str(),
after_undo_dump.c_str());
}
EXPECT_TRUE(after_undo_dump == original_dump);
// Redo reflow
ASSERT_TRUE(Execute(ed, "redo", "", 1));
const std::string after_redo_dump = to_string_rows(*buf);
EXPECT_TRUE(after_redo_dump == reflowed_dump);
}

View File

@@ -3,22 +3,32 @@
#include <string> #include <string>
#include <vector> #include <vector>
static std::vector<std::size_t> ref_find_all(const std::string &text, const std::string &pat) {
static std::vector<std::size_t>
ref_find_all(const std::string &text, const std::string &pat)
{
std::vector<std::size_t> res; std::vector<std::size_t> res;
if (pat.empty()) return res; if (pat.empty())
return res;
std::size_t from = 0; std::size_t from = 0;
while (true) { while (true) {
auto p = text.find(pat, from); auto p = text.find(pat, from);
if (p == std::string::npos) break; if (p == std::string::npos)
break;
res.push_back(p); res.push_back(p);
from = p + pat.size(); from = p + pat.size();
} }
return res; return res;
} }
TEST(OptimizedSearch_basic_cases) {
TEST(OptimizedSearch_basic_cases)
{
OptimizedSearch os; OptimizedSearch os;
struct Case { std::string text; std::string pat; } cases[] = { struct Case {
std::string text;
std::string pat;
} cases[] = {
{"", ""}, {"", ""},
{"", "a"}, {"", "a"},
{"a", ""}, {"a", ""},

View File

@@ -0,0 +1,129 @@
#include "Test.h"
#include "tests/TestHarness.h"
using ktet::TestHarness;
// These tests intentionally drive the prompt-based search/replace UI headlessly
// via `Execute(Editor&, CommandId, ...)` to lock down behavior without ncurses.
TEST(SearchFlow_FindStart_Success_LeavesCursorOnMatch_And_ClearsSearchState)
{
TestHarness h;
Editor &ed = h.EditorRef();
Buffer &b = h.Buf();
b.insert_text(0, 0, "abc def abc");
b.SetCursor(0, 0);
b.SetOffsets(0, 0);
// Keep a mark set to ensure search doesn't clobber it.
b.SetMark(0, 0);
ASSERT_TRUE(b.MarkSet());
ASSERT_TRUE(h.Exec(CommandId::FindStart));
ASSERT_TRUE(ed.PromptActive());
ASSERT_EQ(ed.CurrentPromptKind(), Editor::PromptKind::Search);
ASSERT_TRUE(ed.SearchActive());
// Typing into the prompt uses InsertText and should jump to the first match.
ASSERT_TRUE(h.Exec(CommandId::InsertText, "def"));
ASSERT_EQ(b.Cury(), (std::size_t) 0);
ASSERT_EQ(b.Curx(), (std::size_t) 4);
// Enter (Newline) accepts the prompt and ends incremental search.
ASSERT_TRUE(h.Exec(CommandId::Newline));
ASSERT_TRUE(!ed.PromptActive());
ASSERT_TRUE(!ed.SearchActive());
ASSERT_TRUE(b.MarkSet());
}
TEST(SearchFlow_FindStart_NotFound_RestoresOrigin_And_ClearsSearchState)
{
TestHarness h;
Editor &ed = h.EditorRef();
Buffer &b = h.Buf();
b.insert_text(0, 0, "hello world\nsecond line\n");
b.SetCursor(3, 0);
b.SetOffsets(1, 2);
const std::size_t ox = b.Curx();
const std::size_t oy = b.Cury();
const std::size_t orow = b.Rowoffs();
const std::size_t ocol = b.Coloffs();
ASSERT_TRUE(h.Exec(CommandId::FindStart));
ASSERT_TRUE(ed.PromptActive());
ASSERT_TRUE(ed.SearchActive());
// Not-found should restore cursor/viewport to the saved origin while still in prompt.
ASSERT_TRUE(h.Exec(CommandId::InsertText, "zzzz"));
ASSERT_EQ(b.Curx(), ox);
ASSERT_EQ(b.Cury(), oy);
ASSERT_EQ(b.Rowoffs(), orow);
ASSERT_EQ(b.Coloffs(), ocol);
ASSERT_TRUE(h.Exec(CommandId::Newline));
ASSERT_TRUE(!ed.PromptActive());
ASSERT_TRUE(!ed.SearchActive());
}
TEST(SearchFlow_SearchReplace_EmptyFind_DoesNotMutateBuffer_And_ClearsState)
{
TestHarness h;
Editor &ed = h.EditorRef();
Buffer &b = h.Buf();
b.insert_text(0, 0, "abc abc\n");
b.SetCursor(0, 0);
const std::string before = h.Text();
ASSERT_TRUE(h.Exec(CommandId::SearchReplace));
ASSERT_TRUE(ed.PromptActive());
ASSERT_EQ(ed.CurrentPromptKind(), Editor::PromptKind::ReplaceFind);
// Accept empty find -> proceed to ReplaceWith.
ASSERT_TRUE(h.Exec(CommandId::Newline));
ASSERT_TRUE(ed.PromptActive());
ASSERT_EQ(ed.CurrentPromptKind(), Editor::PromptKind::ReplaceWith);
// Provide replacement and accept -> should cancel due to empty find.
ASSERT_TRUE(h.Exec(CommandId::InsertText, "X"));
ASSERT_TRUE(h.Exec(CommandId::Newline));
ASSERT_TRUE(!ed.PromptActive());
ASSERT_TRUE(!ed.SearchActive());
ASSERT_EQ(h.Text(), before);
}
TEST(SearchFlow_RegexFind_InvalidPattern_FailsSafely_And_ClearsStateOnEnter)
{
TestHarness h;
Editor &ed = h.EditorRef();
Buffer &b = h.Buf();
b.insert_text(0, 0, "abc\ndef\n");
b.SetCursor(1, 0);
b.SetOffsets(0, 0);
const std::size_t ox = b.Curx();
const std::size_t oy = b.Cury();
ASSERT_TRUE(h.Exec(CommandId::RegexFindStart));
ASSERT_TRUE(ed.PromptActive());
ASSERT_EQ(ed.CurrentPromptKind(), Editor::PromptKind::RegexSearch);
// Invalid regex should not crash; cursor should remain at origin due to no matches.
ASSERT_TRUE(h.Exec(CommandId::InsertText, "("));
ASSERT_EQ(b.Curx(), ox);
ASSERT_EQ(b.Cury(), oy);
ASSERT_TRUE(h.Exec(CommandId::Newline));
ASSERT_TRUE(!ed.PromptActive());
ASSERT_TRUE(!ed.SearchActive());
}

View File

@@ -0,0 +1,79 @@
#include "Test.h"
#include "Buffer.h"
#include "Editor.h"
#include "Command.h"
#include <string>
TEST (SmartNewline_AutoIndent)
{
Editor editor;
InstallDefaultCommands();
Buffer &buf = editor.Buffers().emplace_back();
// Set up initial state: " line1"
buf.insert_text(0, 0, " line1");
buf.SetCursor(7, 0); // At end of line
// Execute SmartNewline
bool ok = Execute(editor, CommandId::SmartNewline);
ASSERT_TRUE(ok);
// Should have two lines now
ASSERT_EQ(buf.Nrows(), 2);
// Line 0 remains " line1"
ASSERT_EQ(buf.GetLineString(0), " line1");
// Line 1 should have " " (two spaces)
ASSERT_EQ(buf.GetLineString(1), " ");
// Cursor should be at (2, 1)
ASSERT_EQ(buf.Curx(), 2);
ASSERT_EQ(buf.Cury(), 1);
}
TEST (SmartNewline_TabIndent)
{
Editor editor;
InstallDefaultCommands();
Buffer &buf = editor.Buffers().emplace_back();
// Set up initial state: "\tline1"
buf.insert_text(0, 0, "\tline1");
buf.SetCursor(6, 0); // At end of line
// Execute SmartNewline
bool ok = Execute(editor, CommandId::SmartNewline);
ASSERT_TRUE(ok);
// Should have two lines now
ASSERT_EQ(buf.Nrows(), 2);
// Line 1 should have "\t"
ASSERT_EQ(buf.GetLineString(1), "\t");
// Cursor should be at (1, 1)
ASSERT_EQ(buf.Curx(), 1);
ASSERT_EQ(buf.Cury(), 1);
}
TEST (SmartNewline_NoIndent)
{
Editor editor;
InstallDefaultCommands();
Buffer &buf = editor.Buffers().emplace_back();
// Set up initial state: "line1"
buf.insert_text(0, 0, "line1");
buf.SetCursor(5, 0); // At end of line
// Execute SmartNewline
bool ok = Execute(editor, CommandId::SmartNewline);
ASSERT_TRUE(ok);
// Should have two lines now
ASSERT_EQ(buf.Nrows(), 2);
// Line 1 should be empty
ASSERT_EQ(buf.GetLineString(1), "");
// Cursor should be at (0, 1)
ASSERT_EQ(buf.Curx(), 0);
ASSERT_EQ(buf.Cury(), 1);
}

131
tests/test_swap_cleanup.cc Normal file
View File

@@ -0,0 +1,131 @@
#include "Test.h"
#include "Command.h"
#include "Editor.h"
#include "tests/TestHarness.h" // for ktet::InstallDefaultCommandsOnce
#include <cstdio>
#include <cstdlib>
#include <filesystem>
#include <fstream>
#include <string>
#include <unistd.h>
namespace fs = std::filesystem;
static void
write_file_bytes(const std::string &path, const std::string &bytes)
{
std::ofstream out(path, std::ios::binary | std::ios::trunc);
out.write(bytes.data(), (std::streamsize) bytes.size());
}
TEST(SwapCleanup_ResetJournalOnSave)
{
ktet::InstallDefaultCommandsOnce();
const fs::path xdg_root = fs::temp_directory_path() /
(std::string("kte_ut_xdg_state_swap_cleanup_") + std::to_string((int) ::getpid()));
fs::remove_all(xdg_root);
fs::create_directories(xdg_root);
const char *old_xdg_p = std::getenv("XDG_STATE_HOME");
const std::string old_xdg = old_xdg_p ? std::string(old_xdg_p) : std::string();
const std::string xdg_s = xdg_root.string();
setenv("XDG_STATE_HOME", xdg_s.c_str(), 1);
const std::string path = (xdg_root / "work" / "file.txt").string();
fs::create_directories((xdg_root / "work"));
std::remove(path.c_str());
write_file_bytes(path, "base\n");
Editor ed;
ed.SetDimensions(24, 80);
// Seed scratch buffer so OpenFile can reuse it.
ed.AddBuffer(Buffer());
std::string err;
ASSERT_TRUE(ed.OpenFile(path, err));
Buffer *b = ed.CurrentBuffer();
ASSERT_TRUE(b != nullptr);
// Edit to ensure swap is created.
ASSERT_TRUE(Execute(ed, CommandId::MoveFileStart));
ASSERT_TRUE(Execute(ed, CommandId::InsertText, "X"));
ASSERT_TRUE(b->Dirty());
ed.Swap()->Flush(b);
const std::string swp = kte::SwapManager::ComputeSwapPathForTests(*b);
ASSERT_TRUE(fs::exists(swp));
// Save should reset/delete the journal.
ASSERT_TRUE(Execute(ed, CommandId::Save));
ed.Swap()->Flush(b);
ASSERT_TRUE(!fs::exists(swp));
// Subsequent edits should recreate a fresh swap.
ASSERT_TRUE(Execute(ed, CommandId::InsertText, "Y"));
ed.Swap()->Flush(b);
ASSERT_TRUE(fs::exists(swp));
// Cleanup.
ed.Swap()->Detach(b);
std::remove(path.c_str());
std::remove(swp.c_str());
if (!old_xdg.empty())
setenv("XDG_STATE_HOME", old_xdg.c_str(), 1);
else
unsetenv("XDG_STATE_HOME");
fs::remove_all(xdg_root);
}
TEST(SwapCleanup_PruneSwapDir_ByAge)
{
const fs::path xdg_root = fs::temp_directory_path() /
(std::string("kte_ut_xdg_state_swap_prune_") + std::to_string((int) ::getpid()));
fs::remove_all(xdg_root);
fs::create_directories(xdg_root);
const char *old_xdg_p = std::getenv("XDG_STATE_HOME");
const std::string old_xdg = old_xdg_p ? std::string(old_xdg_p) : std::string();
const std::string xdg_s = xdg_root.string();
setenv("XDG_STATE_HOME", xdg_s.c_str(), 1);
const fs::path swapdir = xdg_root / "kte" / "swap";
fs::create_directories(swapdir);
const fs::path oldp = swapdir / "old.swp";
const fs::path newp = swapdir / "new.swp";
const fs::path keep = swapdir / "note.txt";
write_file_bytes(oldp.string(), "x");
write_file_bytes(newp.string(), "y");
write_file_bytes(keep.string(), "z");
// Make old.swp look old (2 days ago) and new.swp recent.
std::error_code ec;
fs::last_write_time(oldp, fs::file_time_type::clock::now() - std::chrono::hours(48), ec);
fs::last_write_time(newp, fs::file_time_type::clock::now(), ec);
kte::SwapManager sm;
kte::SwapConfig cfg;
cfg.prune_on_startup = false;
cfg.prune_max_age_days = 1;
cfg.prune_max_files = 0; // disable count-based pruning for this test
sm.SetConfig(cfg);
sm.PruneSwapDir();
ASSERT_TRUE(!fs::exists(oldp));
ASSERT_TRUE(fs::exists(newp));
ASSERT_TRUE(fs::exists(keep));
// Cleanup.
std::remove(newp.string().c_str());
std::remove(keep.string().c_str());
if (!old_xdg.empty())
setenv("XDG_STATE_HOME", old_xdg.c_str(), 1);
else
unsetenv("XDG_STATE_HOME");
fs::remove_all(xdg_root);
}

Some files were not shown because too many files have changed in this diff Show More