Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 690c51b0f3 | |||
| 0d87bc0b25 | |||
| daeeecb342 | |||
| a428b204a0 | |||
| a21409e689 | |||
| b0b5b55dce | |||
| 422b27b1ba | |||
| 9485d2aa24 | |||
| 8a6b7851d5 | |||
| 8ec0d6ac41 | |||
| 337b585ba0 | |||
| 95a588b0df | |||
| 199d7a20f7 | |||
| 44827fe53f | |||
| 2a6ff2a862 |
275
Buffer.cc
275
Buffer.cc
@@ -7,10 +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 "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"
|
||||||
@@ -24,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;
|
||||||
@@ -251,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())
|
||||||
@@ -271,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_)
|
||||||
@@ -297,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;
|
||||||
@@ -341,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;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -437,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)
|
||||||
{
|
{
|
||||||
@@ -575,6 +792,16 @@ Buffer::delete_row(int row)
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
// Undo system accessors
|
// Undo system accessors
|
||||||
UndoSystem *
|
UndoSystem *
|
||||||
Buffer::Undo()
|
Buffer::Undo()
|
||||||
|
|||||||
70
Buffer.h
70
Buffer.h
@@ -1,5 +1,37 @@
|
|||||||
/*
|
/*
|
||||||
* Buffer.h - editor buffer representing an open document
|
* Buffer.h - editor buffer representing an open document
|
||||||
|
*
|
||||||
|
* Buffer is the central document model in kte. Each Buffer represents one open file
|
||||||
|
* or scratch document and manages:
|
||||||
|
*
|
||||||
|
* - Content storage: Uses PieceTable for efficient text operations
|
||||||
|
* - Cursor state: Current position (curx_, cury_), rendered column (rx_)
|
||||||
|
* - Viewport: Scroll offsets (rowoffs_, coloffs_) for display
|
||||||
|
* - File backing: Optional association with a file on disk
|
||||||
|
* - Undo/Redo: Integrated UndoSystem for operation history
|
||||||
|
* - Syntax highlighting: Optional HighlighterEngine for language-aware coloring
|
||||||
|
* - Swap/crash recovery: Integration with SwapRecorder for journaling
|
||||||
|
* - Dirty tracking: Modification state for save prompts
|
||||||
|
*
|
||||||
|
* Key concepts:
|
||||||
|
*
|
||||||
|
* 1. Cursor coordinates:
|
||||||
|
* - (curx_, cury_): Logical character position in the document
|
||||||
|
* - rx_: Rendered column accounting for tab expansion
|
||||||
|
*
|
||||||
|
* 2. File backing:
|
||||||
|
* - Buffers can be file-backed (associated with a path) or scratch (unnamed)
|
||||||
|
* - File identity tracking detects external modifications
|
||||||
|
*
|
||||||
|
* 3. Legacy Line wrapper:
|
||||||
|
* - Buffer::Line provides a string-like interface for legacy command code
|
||||||
|
* - New code should prefer direct PieceTable operations
|
||||||
|
* - See DEVELOPER_GUIDE.md for migration guidance
|
||||||
|
*
|
||||||
|
* 4. Content access:
|
||||||
|
* - Rows(): Materialized line cache (legacy, being phased out)
|
||||||
|
* - GetLineView(): Zero-copy line access via string_view (preferred)
|
||||||
|
* - Direct PieceTable access for new editing operations
|
||||||
*/
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
@@ -42,6 +74,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
|
||||||
{
|
{
|
||||||
@@ -494,6 +534,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);
|
||||||
@@ -508,12 +554,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)
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ project(kte)
|
|||||||
include(GNUInstallDirs)
|
include(GNUInstallDirs)
|
||||||
|
|
||||||
set(CMAKE_CXX_STANDARD 20)
|
set(CMAKE_CXX_STANDARD 20)
|
||||||
set(KTE_VERSION "1.6.1")
|
set(KTE_VERSION "1.7.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.
|
||||||
@@ -39,7 +39,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 +67,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 +141,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
|
||||||
@@ -274,6 +284,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)
|
||||||
|
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")
|
||||||
@@ -308,12 +323,19 @@ if (BUILD_TESTS)
|
|||||||
tests/test_swap_recorder.cc
|
tests/test_swap_recorder.cc
|
||||||
tests/test_swap_writer.cc
|
tests/test_swap_writer.cc
|
||||||
tests/test_swap_replay.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_git_editor.cc
|
||||||
tests/test_piece_table.cc
|
tests/test_piece_table.cc
|
||||||
tests/test_search.cc
|
tests/test_search.cc
|
||||||
tests/test_search_replace_flow.cc
|
tests/test_search_replace_flow.cc
|
||||||
tests/test_reflow_paragraph.cc
|
tests/test_reflow_paragraph.cc
|
||||||
|
tests/test_reflow_indented_bullets.cc
|
||||||
tests/test_undo.cc
|
tests/test_undo.cc
|
||||||
tests/test_visual_line_mode.cc
|
tests/test_visual_line_mode.cc
|
||||||
|
tests/test_benchmarks.cc
|
||||||
|
tests/test_migration_coverage.cc
|
||||||
|
|
||||||
# minimal engine sources required by Buffer
|
# minimal engine sources required by Buffer
|
||||||
PieceTable.cc
|
PieceTable.cc
|
||||||
@@ -322,6 +344,9 @@ if (BUILD_TESTS)
|
|||||||
Command.cc
|
Command.cc
|
||||||
HelpText.cc
|
HelpText.cc
|
||||||
Swap.cc
|
Swap.cc
|
||||||
|
ErrorHandler.cc
|
||||||
|
SyscallWrappers.cc
|
||||||
|
ErrorRecovery.cc
|
||||||
KKeymap.cc
|
KKeymap.cc
|
||||||
SwapRecorder.h
|
SwapRecorder.h
|
||||||
OptimizedSearch.cc
|
OptimizedSearch.cc
|
||||||
@@ -346,6 +371,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)
|
||||||
|
target_link_options(kte_tests PRIVATE -static)
|
||||||
|
endif ()
|
||||||
endif ()
|
endif ()
|
||||||
|
|
||||||
if (BUILD_GUI)
|
if (BUILD_GUI)
|
||||||
@@ -385,6 +415,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)
|
||||||
|
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
|
||||||
|
|||||||
163
Command.cc
163
Command.cc
@@ -618,6 +618,8 @@ cmd_save(CommandContext &ctx)
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
buf->SetDirty(false);
|
buf->SetDirty(false);
|
||||||
|
if (auto *sm = ctx.editor.Swap())
|
||||||
|
sm->ResetJournal(*buf);
|
||||||
ctx.editor.SetStatus("Saved " + buf->Filename());
|
ctx.editor.SetStatus("Saved " + buf->Filename());
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
@@ -627,11 +629,22 @@ cmd_save(CommandContext &ctx)
|
|||||||
ctx.editor.SetStatus("Save as: ");
|
ctx.editor.SetStatus("Save as: ");
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
// External modification detection: if the on-disk file changed since we last observed it,
|
||||||
|
// require confirmation before overwriting.
|
||||||
|
if (buf->ExternallyModifiedOnDisk()) {
|
||||||
|
ctx.editor.StartPrompt(Editor::PromptKind::Confirm, "Overwrite", "");
|
||||||
|
ctx.editor.SetPendingOverwritePath(buf->Filename());
|
||||||
|
ctx.editor.SetStatus(
|
||||||
|
std::string("File changed on disk: overwrite '") + buf->Filename() + "'? (y/N)");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
if (!buf->Save(err)) {
|
if (!buf->Save(err)) {
|
||||||
ctx.editor.SetStatus(err);
|
ctx.editor.SetStatus(err);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
buf->SetDirty(false);
|
buf->SetDirty(false);
|
||||||
|
if (auto *sm = ctx.editor.Swap())
|
||||||
|
sm->ResetJournal(*buf);
|
||||||
ctx.editor.SetStatus("Saved " + buf->Filename());
|
ctx.editor.SetStatus("Saved " + buf->Filename());
|
||||||
if (auto *u = buf->Undo())
|
if (auto *u = buf->Undo())
|
||||||
u->mark_saved();
|
u->mark_saved();
|
||||||
@@ -686,6 +699,10 @@ cmd_save_as(CommandContext &ctx)
|
|||||||
ctx.editor.SetStatus(err);
|
ctx.editor.SetStatus(err);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
if (auto *sm = ctx.editor.Swap()) {
|
||||||
|
sm->NotifyFilenameChanged(*buf);
|
||||||
|
sm->ResetJournal(*buf);
|
||||||
|
}
|
||||||
ctx.editor.SetStatus("Saved as " + ctx.arg);
|
ctx.editor.SetStatus("Saved as " + ctx.arg);
|
||||||
if (auto *u = buf->Undo())
|
if (auto *u = buf->Undo())
|
||||||
u->mark_saved();
|
u->mark_saved();
|
||||||
@@ -789,6 +806,7 @@ cmd_refresh(CommandContext &ctx)
|
|||||||
ctx.editor.SetCloseConfirmPending(false);
|
ctx.editor.SetCloseConfirmPending(false);
|
||||||
ctx.editor.SetCloseAfterSave(false);
|
ctx.editor.SetCloseAfterSave(false);
|
||||||
ctx.editor.ClearPendingOverwritePath();
|
ctx.editor.ClearPendingOverwritePath();
|
||||||
|
ctx.editor.CancelRecoveryPrompt();
|
||||||
ctx.editor.CancelPrompt();
|
ctx.editor.CancelPrompt();
|
||||||
ctx.editor.SetStatus("Canceled");
|
ctx.editor.SetStatus("Canceled");
|
||||||
return true;
|
return true;
|
||||||
@@ -808,6 +826,14 @@ cmd_refresh(CommandContext &ctx)
|
|||||||
ctx.editor.SetStatus("Find canceled");
|
ctx.editor.SetStatus("Find canceled");
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
// If nothing else to cancel, treat C-g/refresh as a mark clear (ke behavior).
|
||||||
|
if (Buffer *buf = ctx.editor.CurrentBuffer()) {
|
||||||
|
if (buf->MarkSet()) {
|
||||||
|
buf->ClearMark();
|
||||||
|
ctx.editor.SetStatus("Mark cleared");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
// Otherwise just a hint; renderer will redraw
|
// Otherwise just a hint; renderer will redraw
|
||||||
ctx.editor.SetStatus("");
|
ctx.editor.SetStatus("");
|
||||||
return true;
|
return true;
|
||||||
@@ -1083,33 +1109,34 @@ cmd_theme_set_by_name(const CommandContext &ctx)
|
|||||||
static bool
|
static bool
|
||||||
cmd_theme_set_by_name(CommandContext &ctx)
|
cmd_theme_set_by_name(CommandContext &ctx)
|
||||||
{
|
{
|
||||||
|
|
||||||
# if defined(KTE_BUILD_GUI) && defined(KTE_USE_QT)
|
# if defined(KTE_BUILD_GUI) && defined(KTE_USE_QT)
|
||||||
// Qt GUI build: schedule theme change for frontend
|
// Qt GUI build: schedule theme change for frontend
|
||||||
std::string name = ctx.arg;
|
std::string name = ctx.arg;
|
||||||
// trim spaces
|
// trim spaces
|
||||||
auto ltrim = [](std::string &s) {
|
auto ltrim = [](std::string &s) {
|
||||||
s.erase(s.begin(), std::find_if(s.begin(), s.end(), [](unsigned char ch) {
|
s.erase(s.begin(), std::find_if(s.begin(), s.end(), [](unsigned char ch) {
|
||||||
return !std::isspace(ch);
|
return !std::isspace(ch);
|
||||||
}));
|
}));
|
||||||
};
|
};
|
||||||
auto rtrim = [](std::string &s) {
|
auto rtrim = [](std::string &s) {
|
||||||
s.erase(std::find_if(s.rbegin(), s.rend(), [](unsigned char ch) {
|
s.erase(std::find_if(s.rbegin(), s.rend(), [](unsigned char ch) {
|
||||||
return !std::isspace(ch);
|
return !std::isspace(ch);
|
||||||
}).base(), s.end());
|
}).base(), s.end());
|
||||||
};
|
};
|
||||||
ltrim(name);
|
ltrim (name);
|
||||||
rtrim(name);
|
rtrim (name);
|
||||||
if (name.empty()) {
|
if (name.empty()) {
|
||||||
ctx.editor.SetStatus("theme: provide a name (e.g., nord, solarized-dark, gruvbox-light, eink)");
|
ctx.editor.SetStatus("theme: provide a name (e.g., nord, solarized-dark, gruvbox-light, eink)");
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
kte::gThemeChangeRequest = name;
|
kte::gThemeChangeRequest= name;
|
||||||
kte::gThemeChangePending = true;
|
kte::gThemeChangePending=true;
|
||||||
ctx.editor.SetStatus(std::string("Theme requested: ") + name);
|
ctx.editor.SetStatus (std::string("Theme requested: ") + name);
|
||||||
return true;
|
return true;
|
||||||
# else
|
# else
|
||||||
(void) ctx;
|
(void) ctx;
|
||||||
// No-op in terminal build
|
// No-op in terminal build
|
||||||
return true;
|
return true;
|
||||||
# endif
|
# endif
|
||||||
}
|
}
|
||||||
@@ -2441,7 +2468,6 @@ cmd_newline(CommandContext &ctx)
|
|||||||
ctx.editor.SetSearchIndex(-1);
|
ctx.editor.SetSearchIndex(-1);
|
||||||
return true;
|
return true;
|
||||||
} else if (kind == Editor::PromptKind::OpenFile) {
|
} else if (kind == Editor::PromptKind::OpenFile) {
|
||||||
std::string err;
|
|
||||||
// Expand "~" to the user's home directory
|
// Expand "~" to the user's home directory
|
||||||
auto expand_user_path = [](const std::string &in) -> std::string {
|
auto expand_user_path = [](const std::string &in) -> std::string {
|
||||||
if (!in.empty() && in[0] == '~') {
|
if (!in.empty() && in[0] == '~') {
|
||||||
@@ -2458,14 +2484,19 @@ cmd_newline(CommandContext &ctx)
|
|||||||
value = expand_user_path(value);
|
value = expand_user_path(value);
|
||||||
if (value.empty()) {
|
if (value.empty()) {
|
||||||
ctx.editor.SetStatus("Open canceled (empty)");
|
ctx.editor.SetStatus("Open canceled (empty)");
|
||||||
} else if (!ctx.editor.OpenFile(value, err)) {
|
|
||||||
ctx.editor.SetStatus(err.empty() ? std::string("Failed to open ") + value : err);
|
|
||||||
} else {
|
} else {
|
||||||
ctx.editor.SetStatus(std::string("Opened ") + value);
|
ctx.editor.RequestOpenFile(value);
|
||||||
// Center the view on the cursor (e.g. if the buffer restored a cursor position)
|
const bool opened = ctx.editor.ProcessPendingOpens();
|
||||||
cmd_center_on_cursor(ctx);
|
if (ctx.editor.PromptActive()) {
|
||||||
// Close the prompt so subsequent typing edits the buffer, not the prompt
|
// A recovery confirmation prompt was started.
|
||||||
ctx.editor.CancelPrompt();
|
return true;
|
||||||
|
}
|
||||||
|
if (opened) {
|
||||||
|
// Center the view on the cursor (e.g. if the buffer restored a cursor position)
|
||||||
|
cmd_center_on_cursor(ctx);
|
||||||
|
// Close the prompt so subsequent typing edits the buffer, not the prompt
|
||||||
|
ctx.editor.CancelPrompt();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
} else if (kind == Editor::PromptKind::BufferSwitch) {
|
} else if (kind == Editor::PromptKind::BufferSwitch) {
|
||||||
// Resolve to a buffer index by exact match against path or basename;
|
// Resolve to a buffer index by exact match against path or basename;
|
||||||
@@ -2575,11 +2606,19 @@ cmd_newline(CommandContext &ctx)
|
|||||||
}
|
}
|
||||||
if (yes) {
|
if (yes) {
|
||||||
std::string err;
|
std::string err;
|
||||||
if (!buf->SaveAs(target, err)) {
|
const bool is_same_target = (buf->Filename() == target) && buf->IsFileBacked();
|
||||||
|
const bool ok = is_same_target ? buf->Save(err) : buf->SaveAs(target, err);
|
||||||
|
if (!ok) {
|
||||||
ctx.editor.SetStatus(err);
|
ctx.editor.SetStatus(err);
|
||||||
} else {
|
} else {
|
||||||
buf->SetDirty(false);
|
buf->SetDirty(false);
|
||||||
ctx.editor.SetStatus("Saved as " + target);
|
if (auto *sm = ctx.editor.Swap()) {
|
||||||
|
if (!is_same_target)
|
||||||
|
sm->NotifyFilenameChanged(*buf);
|
||||||
|
sm->ResetJournal(*buf);
|
||||||
|
}
|
||||||
|
ctx.editor.SetStatus(
|
||||||
|
is_same_target ? ("Saved " + target) : ("Saved as " + target));
|
||||||
if (auto *u = buf->Undo())
|
if (auto *u = buf->Undo())
|
||||||
u->mark_saved();
|
u->mark_saved();
|
||||||
// If this overwrite confirm was part of a close-after-save flow, close now.
|
// If this overwrite confirm was part of a close-after-save flow, close now.
|
||||||
@@ -2612,6 +2651,16 @@ cmd_newline(CommandContext &ctx)
|
|||||||
ctx.editor.ClearPendingOverwritePath();
|
ctx.editor.ClearPendingOverwritePath();
|
||||||
// Regardless of answer, end any close-after-save pending state for safety.
|
// Regardless of answer, end any close-after-save pending state for safety.
|
||||||
ctx.editor.SetCloseAfterSave(false);
|
ctx.editor.SetCloseAfterSave(false);
|
||||||
|
} else if (ctx.editor.PendingRecoveryPrompt() != Editor::RecoveryPromptKind::None) {
|
||||||
|
bool yes = false;
|
||||||
|
if (!value.empty()) {
|
||||||
|
char c = value[0];
|
||||||
|
yes = (c == 'y' || c == 'Y');
|
||||||
|
}
|
||||||
|
(void) ctx.editor.ResolveRecoveryPrompt(yes);
|
||||||
|
ctx.editor.CancelPrompt();
|
||||||
|
// Continue any queued opens (e.g., startup argv files).
|
||||||
|
ctx.editor.ProcessPendingOpens();
|
||||||
} else if (ctx.editor.CloseConfirmPending() && buf) {
|
} else if (ctx.editor.CloseConfirmPending() && buf) {
|
||||||
bool yes = false;
|
bool yes = false;
|
||||||
if (!value.empty()) {
|
if (!value.empty()) {
|
||||||
@@ -2630,6 +2679,8 @@ cmd_newline(CommandContext &ctx)
|
|||||||
proceed_to_close = false;
|
proceed_to_close = false;
|
||||||
} else {
|
} else {
|
||||||
buf->SetDirty(false);
|
buf->SetDirty(false);
|
||||||
|
if (auto *sm = ctx.editor.Swap())
|
||||||
|
sm->ResetJournal(*buf);
|
||||||
if (auto *u = buf->Undo())
|
if (auto *u = buf->Undo())
|
||||||
u->mark_saved();
|
u->mark_saved();
|
||||||
}
|
}
|
||||||
@@ -2639,6 +2690,10 @@ cmd_newline(CommandContext &ctx)
|
|||||||
proceed_to_close = false;
|
proceed_to_close = false;
|
||||||
} else {
|
} else {
|
||||||
buf->SetDirty(false);
|
buf->SetDirty(false);
|
||||||
|
if (auto *sm = ctx.editor.Swap()) {
|
||||||
|
sm->NotifyFilenameChanged(*buf);
|
||||||
|
sm->ResetJournal(*buf);
|
||||||
|
}
|
||||||
if (auto *u = buf->Undo())
|
if (auto *u = buf->Undo())
|
||||||
u->mark_saved();
|
u->mark_saved();
|
||||||
}
|
}
|
||||||
@@ -2675,6 +2730,8 @@ cmd_newline(CommandContext &ctx)
|
|||||||
ctx.editor.SetStatus("No buffer");
|
ctx.editor.SetStatus("No buffer");
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
if (auto *u = buf->Undo())
|
||||||
|
u->commit();
|
||||||
std::size_t nrows = buf->Nrows();
|
std::size_t nrows = buf->Nrows();
|
||||||
if (nrows == 0) {
|
if (nrows == 0) {
|
||||||
buf->SetCursor(0, 0);
|
buf->SetCursor(0, 0);
|
||||||
@@ -3346,6 +3403,8 @@ cmd_move_file_start(CommandContext &ctx)
|
|||||||
Buffer *buf = ctx.editor.CurrentBuffer();
|
Buffer *buf = ctx.editor.CurrentBuffer();
|
||||||
if (!buf)
|
if (!buf)
|
||||||
return false;
|
return false;
|
||||||
|
if (auto *u = buf->Undo())
|
||||||
|
u->commit();
|
||||||
ensure_at_least_one_line(*buf);
|
ensure_at_least_one_line(*buf);
|
||||||
buf->SetCursor(0, 0);
|
buf->SetCursor(0, 0);
|
||||||
if (buf->VisualLineActive())
|
if (buf->VisualLineActive())
|
||||||
@@ -3361,6 +3420,8 @@ cmd_move_file_end(CommandContext &ctx)
|
|||||||
Buffer *buf = ctx.editor.CurrentBuffer();
|
Buffer *buf = ctx.editor.CurrentBuffer();
|
||||||
if (!buf)
|
if (!buf)
|
||||||
return false;
|
return false;
|
||||||
|
if (auto *u = buf->Undo())
|
||||||
|
u->commit();
|
||||||
ensure_at_least_one_line(*buf);
|
ensure_at_least_one_line(*buf);
|
||||||
const auto &rows = buf->Rows();
|
const auto &rows = buf->Rows();
|
||||||
std::size_t y = rows.empty() ? 0 : rows.size() - 1;
|
std::size_t y = rows.empty() ? 0 : rows.size() - 1;
|
||||||
@@ -3408,6 +3469,8 @@ cmd_jump_to_mark(CommandContext &ctx)
|
|||||||
Buffer *buf = ctx.editor.CurrentBuffer();
|
Buffer *buf = ctx.editor.CurrentBuffer();
|
||||||
if (!buf)
|
if (!buf)
|
||||||
return false;
|
return false;
|
||||||
|
if (auto *u = buf->Undo())
|
||||||
|
u->commit();
|
||||||
if (!buf->MarkSet()) {
|
if (!buf->MarkSet()) {
|
||||||
ctx.editor.SetStatus("Mark not set");
|
ctx.editor.SetStatus("Mark not set");
|
||||||
return false;
|
return false;
|
||||||
@@ -3849,6 +3912,8 @@ cmd_scroll_up(CommandContext &ctx)
|
|||||||
Buffer *buf = ctx.editor.CurrentBuffer();
|
Buffer *buf = ctx.editor.CurrentBuffer();
|
||||||
if (!buf)
|
if (!buf)
|
||||||
return false;
|
return false;
|
||||||
|
if (auto *u = buf->Undo())
|
||||||
|
u->commit();
|
||||||
ensure_at_least_one_line(*buf);
|
ensure_at_least_one_line(*buf);
|
||||||
const auto &rows = buf->Rows();
|
const auto &rows = buf->Rows();
|
||||||
std::size_t content_rows = std::max<std::size_t>(1, ctx.editor.ContentRows());
|
std::size_t content_rows = std::max<std::size_t>(1, ctx.editor.ContentRows());
|
||||||
@@ -3882,6 +3947,8 @@ cmd_scroll_down(CommandContext &ctx)
|
|||||||
Buffer *buf = ctx.editor.CurrentBuffer();
|
Buffer *buf = ctx.editor.CurrentBuffer();
|
||||||
if (!buf)
|
if (!buf)
|
||||||
return false;
|
return false;
|
||||||
|
if (auto *u = buf->Undo())
|
||||||
|
u->commit();
|
||||||
ensure_at_least_one_line(*buf);
|
ensure_at_least_one_line(*buf);
|
||||||
const auto &rows = buf->Rows();
|
const auto &rows = buf->Rows();
|
||||||
std::size_t content_rows = std::max<std::size_t>(1, ctx.editor.ContentRows());
|
std::size_t content_rows = std::max<std::size_t>(1, ctx.editor.ContentRows());
|
||||||
@@ -4246,6 +4313,27 @@ cmd_reflow_paragraph(CommandContext &ctx)
|
|||||||
Buffer *buf = ctx.editor.CurrentBuffer();
|
Buffer *buf = ctx.editor.CurrentBuffer();
|
||||||
if (!buf)
|
if (!buf)
|
||||||
return false;
|
return false;
|
||||||
|
struct GroupGuard {
|
||||||
|
UndoSystem *u;
|
||||||
|
|
||||||
|
|
||||||
|
explicit GroupGuard(UndoSystem *u_) : u(u_)
|
||||||
|
{
|
||||||
|
if (u)
|
||||||
|
u->BeginGroup();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
~GroupGuard()
|
||||||
|
{
|
||||||
|
if (u)
|
||||||
|
u->EndGroup();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
// Reflow performs a multi-edit transformation; make it a single standalone undo/redo step.
|
||||||
|
GroupGuard guard(buf->Undo());
|
||||||
|
if (auto *u = buf->Undo())
|
||||||
|
u->commit();
|
||||||
ensure_at_least_one_line(*buf);
|
ensure_at_least_one_line(*buf);
|
||||||
auto &rows = buf->Rows();
|
auto &rows = buf->Rows();
|
||||||
std::size_t y = buf->Cury();
|
std::size_t y = buf->Cury();
|
||||||
@@ -4428,12 +4516,6 @@ cmd_reflow_paragraph(CommandContext &ctx)
|
|||||||
std::size_t j = i + 1;
|
std::size_t j = i + 1;
|
||||||
while (j <= para_end) {
|
while (j <= para_end) {
|
||||||
std::string ns = static_cast<std::string>(rows[j]);
|
std::string ns = static_cast<std::string>(rows[j]);
|
||||||
if (starts_with(ns, indent + " ")) {
|
|
||||||
content += ' ';
|
|
||||||
content += ns.substr(indent.size() + 2);
|
|
||||||
++j;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
// stop if next bullet at same indentation or different structure
|
// stop if next bullet at same indentation or different structure
|
||||||
std::string nindent;
|
std::string nindent;
|
||||||
char nmarker;
|
char nmarker;
|
||||||
@@ -4445,6 +4527,13 @@ cmd_reflow_paragraph(CommandContext &ctx)
|
|||||||
if (is_numbered_line(ns, nindent, nnmarker, nidx)) {
|
if (is_numbered_line(ns, nindent, nnmarker, nidx)) {
|
||||||
break; // next item
|
break; // next item
|
||||||
}
|
}
|
||||||
|
// Now check if it's a continuation line
|
||||||
|
if (starts_with(ns, indent + " ")) {
|
||||||
|
content += ' ';
|
||||||
|
content += ns.substr(indent.size() + 2);
|
||||||
|
++j;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
// Not a continuation and not a bullet: stop (treat as separate paragraph chunk)
|
// Not a continuation and not a bullet: stop (treat as separate paragraph chunk)
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -4902,4 +4991,4 @@ Execute(Editor &ed, const std::string &name, const std::string &arg, int count)
|
|||||||
return false;
|
return false;
|
||||||
CommandContext ctx{ed, arg, count};
|
CommandContext ctx{ed, arg, count};
|
||||||
return cmd->handler ? cmd->handler(ctx) : false;
|
return cmd->handler ? cmd->handler(ctx) : false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -164,4 +164,4 @@ void InstallDefaultCommands();
|
|||||||
// Returns true if the command executed successfully.
|
// Returns true if the command executed successfully.
|
||||||
bool Execute(Editor &ed, CommandId id, const std::string &arg = std::string(), int count = 0);
|
bool Execute(Editor &ed, CommandId id, const std::string &arg = std::string(), int count = 0);
|
||||||
|
|
||||||
bool Execute(Editor &ed, const std::string &name, const std::string &arg = std::string(), int count = 0);
|
bool Execute(Editor &ed, const std::string &name, const std::string &arg = std::string(), int count = 0);
|
||||||
|
|||||||
23
Dockerfile
Normal file
23
Dockerfile
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# Minimal Dockerfile for building and testing kte on Linux
|
||||||
|
# This container provides a build environment with all dependencies.
|
||||||
|
# Mount the source tree at /kte when running the container.
|
||||||
|
FROM alpine:3.19
|
||||||
|
|
||||||
|
# Install build dependencies
|
||||||
|
RUN apk add --no-cache \
|
||||||
|
g++ \
|
||||||
|
cmake \
|
||||||
|
make \
|
||||||
|
ncurses-dev \
|
||||||
|
sdl2-dev \
|
||||||
|
mesa-dev \
|
||||||
|
freetype-dev \
|
||||||
|
libx11-dev \
|
||||||
|
libxext-dev
|
||||||
|
|
||||||
|
# Set working directory where source will be mounted
|
||||||
|
WORKDIR /kte
|
||||||
|
|
||||||
|
# Default command: build and run tests
|
||||||
|
# Add DirectFB include path for SDL2 compatibility on Alpine
|
||||||
|
CMD ["sh", "-c", "cmake -B build -DBUILD_GUI=ON -DBUILD_TESTS=ON -DCMAKE_CXX_FLAGS='-I/usr/include/directfb' && cmake --build build --target kte && cmake --build build --target kge && cmake --build build --target kte_tests && ./build/kte_tests"]
|
||||||
227
Editor.cc
227
Editor.cc
@@ -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>();
|
||||||
@@ -162,9 +198,9 @@ Editor::OpenFile(const std::string &path, std::string &err)
|
|||||||
Buffer &cur = buffers_[curbuf_];
|
Buffer &cur = buffers_[curbuf_];
|
||||||
const bool unnamed = cur.Filename().empty() && !cur.IsFileBacked();
|
const bool unnamed = cur.Filename().empty() && !cur.IsFileBacked();
|
||||||
const bool clean = !cur.Dirty();
|
const bool clean = !cur.Dirty();
|
||||||
const auto &rows = cur.Rows();
|
const std::size_t nrows = cur.Nrows();
|
||||||
const bool rows_empty = rows.empty();
|
const bool rows_empty = (nrows == 0);
|
||||||
const bool single_empty_line = (!rows.empty() && rows.size() == 1 && rows[0].size() == 0);
|
const bool single_empty_line = (nrows == 1 && cur.GetLineView(0).size() == 0);
|
||||||
if (unnamed && clean && (rows_empty || single_empty_line)) {
|
if (unnamed && clean && (rows_empty || single_empty_line)) {
|
||||||
bool ok = cur.OpenFromFile(path, err);
|
bool ok = cur.OpenFromFile(path, err);
|
||||||
if (!ok)
|
if (!ok)
|
||||||
@@ -178,9 +214,8 @@ Editor::OpenFile(const std::string &path, std::string &err)
|
|||||||
// Setup highlighting using registry (extension + shebang)
|
// Setup highlighting using registry (extension + shebang)
|
||||||
cur.EnsureHighlighter();
|
cur.EnsureHighlighter();
|
||||||
std::string first = "";
|
std::string first = "";
|
||||||
const auto &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);
|
||||||
@@ -212,11 +247,8 @@ Editor::OpenFile(const std::string &path, std::string &err)
|
|||||||
// Initialize syntax highlighting by extension + shebang via registry (v2)
|
// Initialize syntax highlighting by extension + shebang via registry (v2)
|
||||||
b.EnsureHighlighter();
|
b.EnsureHighlighter();
|
||||||
std::string first = "";
|
std::string first = "";
|
||||||
{
|
if (b.Nrows() > 0)
|
||||||
const auto &rows = b.Rows();
|
first = b.GetLineString(0);
|
||||||
if (!rows.empty())
|
|
||||||
first = static_cast<std::string>(rows[0]);
|
|
||||||
}
|
|
||||||
std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
|
std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
|
||||||
if (!ft.empty()) {
|
if (!ft.empty()) {
|
||||||
b.SetFiletype(ft);
|
b.SetFiletype(ft);
|
||||||
@@ -245,6 +277,172 @@ 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)
|
||||||
{
|
{
|
||||||
@@ -284,7 +482,10 @@ Editor::CloseBuffer(std::size_t index)
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
if (swap_) {
|
if (swap_) {
|
||||||
swap_->Detach(&buffers_[index]);
|
// 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(&buffers_[index], true);
|
||||||
buffers_[index].SetSwapRecorder(nullptr);
|
buffers_[index].SetSwapRecorder(nullptr);
|
||||||
}
|
}
|
||||||
buffers_.erase(buffers_.begin() + static_cast<std::ptrdiff_t>(index));
|
buffers_.erase(buffers_.begin() + static_cast<std::ptrdiff_t>(index));
|
||||||
|
|||||||
74
Editor.h
74
Editor.h
@@ -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>
|
||||||
|
|
||||||
@@ -497,6 +535,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);
|
||||||
|
|
||||||
@@ -550,6 +612,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
|
||||||
@@ -593,6 +660,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_;
|
||||||
|
|||||||
318
ErrorHandler.cc
Normal file
318
ErrorHandler.cc
Normal file
@@ -0,0 +1,318 @@
|
|||||||
|
#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();
|
||||||
|
} 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>(steady_clock::now().time_since_epoch()).count();
|
||||||
|
}
|
||||||
|
} // namespace kte
|
||||||
106
ErrorHandler.h
Normal file
106
ErrorHandler.h
Normal 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
157
ErrorRecovery.cc
Normal 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
170
ErrorRecovery.h
Normal 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
|
||||||
@@ -19,4 +19,4 @@ public:
|
|||||||
|
|
||||||
// Shutdown/cleanup
|
// Shutdown/cleanup
|
||||||
virtual void Shutdown() = 0;
|
virtual void Shutdown() = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -127,4 +127,4 @@ GUIConfig::LoadFromFile(const std::string &path)
|
|||||||
}
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -30,4 +30,4 @@ public:
|
|||||||
|
|
||||||
// Load from explicit path. Returns true if file existed and was parsed.
|
// Load from explicit path. Returns true if file existed and was parsed.
|
||||||
bool LoadFromFile(const std::string &path);
|
bool LoadFromFile(const std::string &path);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -942,4 +942,4 @@ SyntaxInk(const TokenKind k)
|
|||||||
}
|
}
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|
||||||
#endif // KTE_USE_QT
|
#endif // KTE_USE_QT
|
||||||
|
|||||||
@@ -22,7 +22,9 @@ HelpText::Text()
|
|||||||
" C-k ' Toggle read-only\n"
|
" C-k ' Toggle read-only\n"
|
||||||
" C-k - Unindent region (mark required)\n"
|
" C-k - Unindent region (mark required)\n"
|
||||||
" C-k = Indent region (mark required)\n"
|
" C-k = Indent region (mark required)\n"
|
||||||
|
" C-k / Toggle visual line mode\n"
|
||||||
" C-k ; Command prompt (:\\ )\n"
|
" C-k ; Command prompt (:\\ )\n"
|
||||||
|
" C-k SPACE Toggle mark\n"
|
||||||
" C-k C-d Kill entire line\n"
|
" C-k C-d Kill entire line\n"
|
||||||
" C-k C-q Quit now (no confirm)\n"
|
" C-k C-q Quit now (no confirm)\n"
|
||||||
" C-k C-x Save and quit\n"
|
" C-k C-x Save and quit\n"
|
||||||
@@ -31,11 +33,12 @@ HelpText::Text()
|
|||||||
" C-k c Close current buffer\n"
|
" C-k c Close current buffer\n"
|
||||||
" C-k d Kill to end of line\n"
|
" C-k d Kill to end of line\n"
|
||||||
" C-k e Open file (prompt)\n"
|
" C-k e Open file (prompt)\n"
|
||||||
" C-k i New empty buffer\n"
|
|
||||||
" C-k f Flush kill ring\n"
|
" C-k f Flush kill ring\n"
|
||||||
" C-k g Jump to line\n"
|
" C-k g Jump to line\n"
|
||||||
" C-k h Show this help\n"
|
" C-k h Show this help\n"
|
||||||
|
" C-k i New empty buffer\n"
|
||||||
" C-k j Jump to mark\n"
|
" C-k j Jump to mark\n"
|
||||||
|
" C-k k Center viewport on cursor\n"
|
||||||
" C-k l Reload buffer from disk\n"
|
" C-k l Reload buffer from disk\n"
|
||||||
" C-k n Previous buffer\n"
|
" C-k n Previous buffer\n"
|
||||||
" C-k o Change working directory (prompt)\n"
|
" C-k o Change working directory (prompt)\n"
|
||||||
|
|||||||
@@ -10,4 +10,4 @@ public:
|
|||||||
// Project maintainers can customize the returned string below
|
// Project maintainers can customize the returned string below
|
||||||
// (in HelpText.cc) without touching the help command logic.
|
// (in HelpText.cc) without touching the help command logic.
|
||||||
static std::string Text();
|
static std::string Text();
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -34,4 +34,4 @@ struct LineHighlight {
|
|||||||
std::vector<HighlightSpan> spans;
|
std::vector<HighlightSpan> spans;
|
||||||
std::uint64_t version{0}; // buffer version used for this line
|
std::uint64_t version{0}; // buffer version used for this line
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -298,6 +298,9 @@ GUIFrontend::Step(Editor &ed, bool &running)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Allow deferred opens (including swap recovery prompts) to run.
|
||||||
|
ed.ProcessPendingOpens();
|
||||||
|
|
||||||
// Execute pending mapped inputs (drain queue) AFTER dimensions are updated
|
// Execute pending mapped inputs (drain queue) AFTER dimensions are updated
|
||||||
for (;;) {
|
for (;;) {
|
||||||
MappedInput mi;
|
MappedInput mi;
|
||||||
@@ -388,4 +391,4 @@ GUIFrontend::LoadGuiFont_(const char * /*path*/, const float size_px)
|
|||||||
|
|
||||||
io.Fonts->Build();
|
io.Fonts->Build();
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -33,4 +33,4 @@ private:
|
|||||||
SDL_GLContext gl_ctx_ = nullptr;
|
SDL_GLContext gl_ctx_ = nullptr;
|
||||||
int width_ = 1280;
|
int width_ = 1280;
|
||||||
int height_ = 800;
|
int height_ = 800;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -158,17 +158,17 @@ map_key(const SDL_Keycode key,
|
|||||||
ascii_key = static_cast<int>(key);
|
ascii_key = static_cast<int>(key);
|
||||||
}
|
}
|
||||||
bool ctrl2 = (mod & KMOD_CTRL) != 0;
|
bool ctrl2 = (mod & KMOD_CTRL) != 0;
|
||||||
// If user typed a literal 'C' (uppercase) or '^' as a control qualifier, keep k-prefix active
|
// If user typed a literal 'C' (uppercase) or '^' as a control qualifier, keep k-prefix active
|
||||||
// Do NOT treat lowercase 'c' as a qualifier; 'c' is a valid k-command (BufferClose).
|
// Do NOT treat lowercase 'c' as a qualifier; 'c' is a valid k-command (BufferClose).
|
||||||
if (ascii_key == 'C' || ascii_key == '^') {
|
if (ascii_key == 'C' || ascii_key == '^') {
|
||||||
k_ctrl_pending = true;
|
k_ctrl_pending = true;
|
||||||
// Keep waiting for the next suffix; show status and suppress ensuing TEXTINPUT
|
// Keep waiting for the next suffix; show status and suppress ensuing TEXTINPUT
|
||||||
if (ed)
|
if (ed)
|
||||||
ed->SetStatus("C-k C _");
|
ed->SetStatus("C-k C _");
|
||||||
suppress_textinput_once = true;
|
suppress_textinput_once = true;
|
||||||
out.hasCommand = false;
|
out.hasCommand = false;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
// Otherwise, consume the k-prefix now for the actual suffix
|
// Otherwise, consume the k-prefix now for the actual suffix
|
||||||
k_prefix = false;
|
k_prefix = false;
|
||||||
if (ascii_key != 0) {
|
if (ascii_key != 0) {
|
||||||
@@ -298,7 +298,7 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
// High-resolution trackpads can deliver fractional wheel deltas. Accumulate
|
// High-resolution trackpads can deliver fractional wheel deltas. Accumulate
|
||||||
// precise values and emit one scroll step per whole unit.
|
// precise values and emit one scroll step per whole unit.
|
||||||
float dy = 0.0f;
|
float dy = 0.0f;
|
||||||
#if SDL_VERSION_ATLEAST(2,0,18)
|
#if SDL_VERSION_ATLEAST(2, 0, 18)
|
||||||
dy = e.wheel.preciseY;
|
dy = e.wheel.preciseY;
|
||||||
#else
|
#else
|
||||||
dy = static_cast<float>(e.wheel.y);
|
dy = static_cast<float>(e.wheel.y);
|
||||||
@@ -308,7 +308,7 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
dy = -dy;
|
dy = -dy;
|
||||||
#endif
|
#endif
|
||||||
if (dy != 0.0f) {
|
if (dy != 0.0f) {
|
||||||
wheel_accum_y_ += dy;
|
wheel_accum_y_ += dy;
|
||||||
float abs_accum = wheel_accum_y_ >= 0.0f ? wheel_accum_y_ : -wheel_accum_y_;
|
float abs_accum = wheel_accum_y_ >= 0.0f ? wheel_accum_y_ : -wheel_accum_y_;
|
||||||
int steps = static_cast<int>(abs_accum);
|
int steps = static_cast<int>(abs_accum);
|
||||||
if (steps > 0) {
|
if (steps > 0) {
|
||||||
@@ -439,14 +439,12 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
}
|
}
|
||||||
|
|
||||||
// If editor universal argument is active, consume digit TEXTINPUT
|
// If editor universal argument is active, consume digit TEXTINPUT
|
||||||
if (ed_ &&ed_
|
if (ed_ && ed_
|
||||||
|
|
||||||
|
|
||||||
|
->
|
||||||
->
|
UArg() != 0
|
||||||
UArg() != 0
|
) {
|
||||||
)
|
|
||||||
{
|
|
||||||
const char *txt = e.text.text;
|
const char *txt = e.text.text;
|
||||||
if (txt && *txt) {
|
if (txt && *txt) {
|
||||||
unsigned char c0 = static_cast<unsigned char>(txt[0]);
|
unsigned char c0 = static_cast<unsigned char>(txt[0]);
|
||||||
@@ -473,16 +471,16 @@ ImGuiInputHandler::ProcessSDLEvent(const SDL_Event &e)
|
|||||||
ascii_key = static_cast<int>(c0);
|
ascii_key = static_cast<int>(c0);
|
||||||
}
|
}
|
||||||
if (ascii_key != 0) {
|
if (ascii_key != 0) {
|
||||||
// Qualifier via TEXTINPUT: uppercase 'C' or '^' only
|
// Qualifier via TEXTINPUT: uppercase 'C' or '^' only
|
||||||
if (ascii_key == 'C' || ascii_key == '^') {
|
if (ascii_key == 'C' || ascii_key == '^') {
|
||||||
k_ctrl_pending_ = true;
|
k_ctrl_pending_ = true;
|
||||||
if (ed_)
|
if (ed_)
|
||||||
ed_->SetStatus("C-k C _");
|
ed_->SetStatus("C-k C _");
|
||||||
// Keep k-prefix active; do not emit a command
|
// Keep k-prefix active; do not emit a command
|
||||||
k_prefix_ = true;
|
k_prefix_ = true;
|
||||||
produced = true;
|
produced = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
// Map via k-prefix table; do not pass Ctrl for TEXTINPUT case
|
// Map via k-prefix table; do not pass Ctrl for TEXTINPUT case
|
||||||
CommandId id;
|
CommandId id;
|
||||||
bool pass_ctrl = k_ctrl_pending_;
|
bool pass_ctrl = k_ctrl_pending_;
|
||||||
@@ -608,4 +606,4 @@ ImGuiInputHandler::Poll(MappedInput &out)
|
|||||||
out = q_.front();
|
out = q_.front();
|
||||||
q_.pop();
|
q_.pop();
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -46,4 +46,4 @@ private:
|
|||||||
// command per whole step and keep the fractional remainder.
|
// command per whole step and keep the fractional remainder.
|
||||||
float wheel_accum_y_ = 0.0f;
|
float wheel_accum_y_ = 0.0f;
|
||||||
float wheel_accum_x_ = 0.0f; // reserved for future horizontal scrolling
|
float wheel_accum_x_ = 0.0f; // reserved for future horizontal scrolling
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -912,12 +912,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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -931,4 +927,4 @@ ImGuiRenderer::Draw(Editor &ed)
|
|||||||
ed.SetFilePickerVisible(false);
|
ed.SetFilePickerVisible(false);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,4 +11,4 @@ public:
|
|||||||
~ImGuiRenderer() override = default;
|
~ImGuiRenderer() override = default;
|
||||||
|
|
||||||
void Draw(Editor &ed) override;
|
void Draw(Editor &ed) override;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -28,4 +28,4 @@ public:
|
|||||||
// Poll for input and translate it to a command. Non-blocking.
|
// Poll for input and translate it to a command. Non-blocking.
|
||||||
// Returns true if a command is available in 'out'. Returns false if no input.
|
// Returns true if a command is available in 'out'. Returns false if no input.
|
||||||
virtual bool Poll(MappedInput &out) = 0;
|
virtual bool Poll(MappedInput &out) = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -230,4 +230,4 @@ KLookupEscCommand(const int ascii_key, CommandId &out) -> bool
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,4 +27,4 @@ KLowerAscii(const int key)
|
|||||||
if (key >= 'A' && key <= 'Z')
|
if (key >= 'A' && key <= 'Z')
|
||||||
return key + ('a' - 'A');
|
return key + ('a' - 'A');
|
||||||
return key;
|
return key;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,4 +20,4 @@ private:
|
|||||||
std::string last_pat_;
|
std::string last_pat_;
|
||||||
|
|
||||||
void build_bad_char(const std::string &pattern);
|
void build_bad_char(const std::string &pattern);
|
||||||
};
|
};
|
||||||
|
|||||||
36
PieceTable.h
36
PieceTable.h
@@ -1,5 +1,39 @@
|
|||||||
/*
|
/*
|
||||||
* PieceTable.h - Alternative to GapBuffer using a piece table representation
|
* PieceTable.h - Alternative to GapBuffer using a piece table representation
|
||||||
|
*
|
||||||
|
* PieceTable is kte's core text storage data structure. It provides efficient
|
||||||
|
* insert/delete operations without copying the entire buffer by maintaining a
|
||||||
|
* sequence of "pieces" that reference ranges in two underlying buffers:
|
||||||
|
* - original_: Initial file content (currently unused, reserved for future)
|
||||||
|
* - add_: All text added during editing
|
||||||
|
*
|
||||||
|
* Key advantages:
|
||||||
|
* - O(1) append/prepend operations (common case)
|
||||||
|
* - O(n) insert/delete at arbitrary positions (n = number of pieces, not bytes)
|
||||||
|
* - Efficient undo: just restore the piece list
|
||||||
|
* - Memory efficient: no gap buffer waste
|
||||||
|
*
|
||||||
|
* Performance characteristics:
|
||||||
|
* - Piece count grows with edit operations; automatic consolidation prevents unbounded growth
|
||||||
|
* - Materialization (Data() call) is O(total_size) but cached until next edit
|
||||||
|
* - Line index is lazily rebuilt on first line-based query after edits
|
||||||
|
* - Range and Find operations use lightweight caches for repeated queries
|
||||||
|
*
|
||||||
|
* API evolution:
|
||||||
|
* 1. Legacy API (GapBuffer compatibility):
|
||||||
|
* - Append/Prepend: Build content sequentially
|
||||||
|
* - Data(): Materialize entire buffer
|
||||||
|
*
|
||||||
|
* 2. New buffer-wide API (Phase 1):
|
||||||
|
* - Insert/Delete: Edit at arbitrary byte offsets
|
||||||
|
* - Line-based queries: LineCount, GetLine, GetLineRange
|
||||||
|
* - Position conversion: ByteOffsetToLineCol, LineColToByteOffset
|
||||||
|
* - Efficient extraction: GetRange, Find, WriteToStream
|
||||||
|
*
|
||||||
|
* Implementation notes:
|
||||||
|
* - Consolidation heuristics prevent piece fragmentation (configurable via SetConsolidationParams)
|
||||||
|
* - Thread-safe for concurrent reads (mutex protects caches and lazy rebuilds)
|
||||||
|
* - Version tracking invalidates caches on mutations
|
||||||
*/
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
#include <cstddef>
|
#include <cstddef>
|
||||||
@@ -184,4 +218,4 @@ private:
|
|||||||
mutable FindCache find_cache_;
|
mutable FindCache find_cache_;
|
||||||
|
|
||||||
mutable std::mutex mutex_;
|
mutable std::mutex mutex_;
|
||||||
};
|
};
|
||||||
@@ -123,8 +123,7 @@ protected:
|
|||||||
if (ed_ && viewport.height() > 0 && viewport.width() > 0) {
|
if (ed_ && viewport.height() > 0 && viewport.width() > 0) {
|
||||||
const Buffer *buf = ed_->CurrentBuffer();
|
const Buffer *buf = ed_->CurrentBuffer();
|
||||||
if (buf) {
|
if (buf) {
|
||||||
const auto &lines = buf->Rows();
|
const std::size_t nrows = buf->Nrows();
|
||||||
const std::size_t nrows = lines.size();
|
|
||||||
const std::size_t rowoffs = buf->Rowoffs();
|
const std::size_t rowoffs = buf->Rowoffs();
|
||||||
const std::size_t coloffs = buf->Coloffs();
|
const std::size_t coloffs = buf->Coloffs();
|
||||||
const std::size_t cy = buf->Cury();
|
const std::size_t cy = buf->Cury();
|
||||||
@@ -144,9 +143,8 @@ protected:
|
|||||||
|
|
||||||
// Iterate visible lines
|
// Iterate visible lines
|
||||||
for (std::size_t i = rowoffs, vis_idx = 0; i < last_row; ++i, ++vis_idx) {
|
for (std::size_t i = rowoffs, vis_idx = 0; i < last_row; ++i, ++vis_idx) {
|
||||||
// Materialize the Buffer::Line into a std::string for
|
// Get line as string for regex/iterator usage and general string ops.
|
||||||
// regex/iterator usage and general string ops.
|
const std::string line = buf->GetLineString(i);
|
||||||
const std::string line = static_cast<std::string>(lines[i]);
|
|
||||||
const int y = viewport.y() + static_cast<int>(vis_idx) * line_h;
|
const int y = viewport.y() + static_cast<int>(vis_idx) * line_h;
|
||||||
const int baseline = y + fm.ascent();
|
const int baseline = y + fm.ascent();
|
||||||
|
|
||||||
@@ -775,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;
|
||||||
@@ -801,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());
|
||||||
|
|||||||
@@ -33,4 +33,4 @@ private:
|
|||||||
QWidget *window_ = nullptr; // owned
|
QWidget *window_ = nullptr; // owned
|
||||||
int width_ = 1280;
|
int width_ = 1280;
|
||||||
int height_ = 800;
|
int height_ = 800;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -283,12 +283,11 @@ QtInputHandler::ProcessKeyEvent(const QKeyEvent &e)
|
|||||||
const bool ctrl_like = (mods & Qt::ControlModifier);
|
const bool ctrl_like = (mods & Qt::ControlModifier);
|
||||||
|
|
||||||
// 1) Universal argument digits (when active), consume digits without enqueuing commands
|
// 1) Universal argument digits (when active), consume digits without enqueuing commands
|
||||||
if (ed_ &&ed_
|
if (ed_ && ed_
|
||||||
|
|
||||||
->
|
->
|
||||||
UArg() != 0
|
UArg() != 0
|
||||||
)
|
) {
|
||||||
{
|
|
||||||
if (!(mods & (Qt::ControlModifier | Qt::AltModifier | Qt::MetaModifier))) {
|
if (!(mods & (Qt::ControlModifier | Qt::AltModifier | Qt::MetaModifier))) {
|
||||||
if (e.key() >= Qt::Key_0 && e.key() <= Qt::Key_9) {
|
if (e.key() >= Qt::Key_0 && e.key() <= Qt::Key_9) {
|
||||||
int d = e.key() - Qt::Key_0;
|
int d = e.key() - Qt::Key_0;
|
||||||
@@ -379,10 +378,9 @@ QtInputHandler::ProcessKeyEvent(const QKeyEvent &e)
|
|||||||
// ESC/meta chords: on macOS, do NOT treat Meta as ESC; only Alt (Option) should trigger.
|
// ESC/meta chords: on macOS, do NOT treat Meta as ESC; only Alt (Option) should trigger.
|
||||||
#if defined(__APPLE__)
|
#if defined(__APPLE__)
|
||||||
if (esc_meta_ || (mods & Qt::AltModifier)) {
|
if (esc_meta_ || (mods & Qt::AltModifier)) {
|
||||||
|
|
||||||
|
|
||||||
#else
|
#else
|
||||||
if (esc_meta_ || (mods & (Qt::AltModifier | Qt::MetaModifier))) {
|
if (esc_meta_ || (mods & (Qt::AltModifier | Qt::MetaModifier))) {
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
int ascii_key = 0;
|
int ascii_key = 0;
|
||||||
if (e.key() == Qt::Key_Backspace) {
|
if (e.key() == Qt::Key_Backspace) {
|
||||||
@@ -535,4 +533,4 @@ QtInputHandler::Poll(MappedInput &out)
|
|||||||
out = q_.front();
|
out = q_.front();
|
||||||
q_.pop();
|
q_.pop();
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -37,4 +37,4 @@ private:
|
|||||||
bool esc_meta_ = false; // ESC-prefix for next key
|
bool esc_meta_ = false; // ESC-prefix for next key
|
||||||
bool suppress_text_input_once_ = false; // reserved (Qt sends text in keyPressEvent)
|
bool suppress_text_input_once_ = false; // reserved (Qt sends text in keyPressEvent)
|
||||||
Editor *ed_ = nullptr;
|
Editor *ed_ = nullptr;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -73,4 +73,4 @@ QtRenderer::Draw(Editor &ed)
|
|||||||
}
|
}
|
||||||
// Request a repaint
|
// Request a repaint
|
||||||
widget_->update();
|
widget_->update();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,4 +24,4 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
QWidget *widget_ = nullptr; // not owned
|
QWidget *widget_ = nullptr; // not owned
|
||||||
};
|
};
|
||||||
|
|||||||
14
README.md
14
README.md
@@ -39,15 +39,13 @@ subject to refinement):
|
|||||||
`C-g`.
|
`C-g`.
|
||||||
- Save/Exit: `C-k s` (save), `C-k x` or `C-k C-x` (save and exit),
|
- Save/Exit: `C-k s` (save), `C-k x` or `C-k C-x` (save and exit),
|
||||||
`C-k q` (quit with confirm), `C-k C-q` (quit immediately).
|
`C-k q` (quit with confirm), `C-k C-q` (quit immediately).
|
||||||
- Editing: `C-k d` (kill to EOL), `C-k C-d` (kill line), `C-k
|
- Editing: `C-k d` (kill to EOL), `C-k C-d` (kill line), `C-w` (kill
|
||||||
BACKSPACE` (kill to BOL), `C-w` (kill region), `C-y` ( yank), `C-u`
|
region), `C-y` (yank), `C-u` (universal argument).
|
||||||
(universal argument).
|
|
||||||
- Navigation/Search: `C-s` (incremental find), `C-r` (regex search),
|
- Navigation/Search: `C-s` (incremental find), `C-r` (regex search),
|
||||||
`ESC f/b` (word next/prev), `ESC BACKSPACE` (delete previous word).
|
`ESC f/b` (word next/prev), `ESC BACKSPACE` (delete previous word).
|
||||||
- Buffers/Files: `C-k e` (open), `C-k b`/`C-k p` (switch), `C-k c`
|
- Buffers/Files: `C-k e` (open), `C-k b`/`C-k p` (switch), `C-k c`
|
||||||
(close), `C-k C-r` (reload).
|
(close), `C-k l` (reload).
|
||||||
- Misc: `C-l` (refresh), `C-g` (cancel), `C-k m` (run make), `C-k g`
|
- Misc: `C-l` (refresh), `C-g` (cancel), `C-k g` (goto line).
|
||||||
(goto line).
|
|
||||||
|
|
||||||
See `ke.md` for the canonical ke reference retained for now.
|
See `ke.md` for the canonical ke reference retained for now.
|
||||||
|
|
||||||
@@ -71,8 +69,8 @@ Dependencies by platform
|
|||||||
- Terminal (default):
|
- Terminal (default):
|
||||||
- `sudo apt-get install -y libncurses5-dev libncursesw5-dev`
|
- `sudo apt-get install -y libncurses5-dev libncursesw5-dev`
|
||||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||||
-
|
-
|
||||||
`sudo apt-get install -y libsdl2-dev libfreetype6-dev mesa-common-dev`
|
`sudo apt-get install -y libsdl2-dev libfreetype6-dev mesa-common-dev`
|
||||||
- The `mesa-common-dev` package provides OpenGL headers/libs (
|
- The `mesa-common-dev` package provides OpenGL headers/libs (
|
||||||
`libGL`).
|
`libGL`).
|
||||||
|
|
||||||
|
|||||||
@@ -10,4 +10,4 @@ public:
|
|||||||
virtual ~Renderer() = default;
|
virtual ~Renderer() = default;
|
||||||
|
|
||||||
virtual void Draw(Editor &ed) = 0;
|
virtual void Draw(Editor &ed) = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
85
Swap.h
85
Swap.h
@@ -10,10 +10,12 @@
|
|||||||
#include <memory>
|
#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 "SwapRecorder.h"
|
||||||
|
#include "ErrorRecovery.h"
|
||||||
|
|
||||||
class Buffer;
|
class Buffer;
|
||||||
|
|
||||||
@@ -32,6 +34,18 @@ 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
|
||||||
|
|
||||||
|
// Checkpoint/compaction knobs (stage 2 defaults)
|
||||||
|
// A checkpoint is a full snapshot of the buffer content written as a CHKPT record.
|
||||||
|
// Compaction rewrites the swap file to contain just the latest checkpoint.
|
||||||
|
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
|
||||||
|
|
||||||
|
// Cleanup / retention (best-effort)
|
||||||
|
bool prune_on_startup{true};
|
||||||
|
unsigned prune_max_age_days{30};
|
||||||
|
std::size_t prune_max_files{2048};
|
||||||
};
|
};
|
||||||
|
|
||||||
// SwapManager manages sidecar swap files and a single background writer thread.
|
// SwapManager manages sidecar swap files and a single background writer thread.
|
||||||
@@ -45,13 +59,36 @@ public:
|
|||||||
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);
|
||||||
|
|
||||||
|
// Reset (truncate-by-delete) the journal for a buffer after a clean save.
|
||||||
|
// Best-effort: closes the current fd, deletes the swap file, and resumes recording.
|
||||||
|
void ResetJournal(Buffer &buf);
|
||||||
|
|
||||||
|
// Best-effort pruning of old swap files under the swap directory.
|
||||||
|
// Never touches non-`.swp` files.
|
||||||
|
void PruneSwapDir();
|
||||||
|
|
||||||
// Block until all currently queued records have been written.
|
// Block until all currently queued records have been written.
|
||||||
// If buf is non-null, flushes all records (stage 1) but is primarily intended
|
// If buf is non-null, flushes all records (stage 1) but is primarily intended
|
||||||
// for tests and shutdown.
|
// for tests and shutdown.
|
||||||
void Flush(Buffer *buf = nullptr);
|
void Flush(Buffer *buf = nullptr);
|
||||||
|
|
||||||
|
// 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 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.
|
// Obtain a per-buffer recorder adapter that emits records for that buffer.
|
||||||
// The returned pointer is owned by the SwapManager and remains valid until
|
// The returned pointer is owned by the SwapManager and remains valid until
|
||||||
// Detach(buf) or SwapManager destruction.
|
// Detach(buf) or SwapManager destruction.
|
||||||
@@ -67,6 +104,10 @@ public:
|
|||||||
// treat this as a recovery failure and surface `err`.
|
// treat this as a recovery failure and surface `err`.
|
||||||
static bool ReplayFile(Buffer &buf, const std::string &swap_path, std::string &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.
|
// Test-only hook to keep swap path logic centralized.
|
||||||
// (Avoid duplicating naming rules in unit tests.)
|
// (Avoid duplicating naming rules in unit tests.)
|
||||||
#ifdef KTE_TESTS
|
#ifdef KTE_TESTS
|
||||||
@@ -92,6 +133,20 @@ public:
|
|||||||
// Per-buffer toggle
|
// Per-buffer toggle
|
||||||
void SetSuspended(Buffer &buf, bool on);
|
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 {
|
class BufferRecorder final : public SwapRecorder {
|
||||||
public:
|
public:
|
||||||
@@ -114,6 +169,10 @@ private:
|
|||||||
|
|
||||||
void RecordJoin(Buffer &buf, int row);
|
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;
|
||||||
int fd{-1};
|
int fd{-1};
|
||||||
@@ -121,6 +180,9 @@ private:
|
|||||||
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 {
|
||||||
@@ -134,16 +196,23 @@ private:
|
|||||||
// 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 std::string SwapDirRoot();
|
||||||
|
|
||||||
static bool write_header(int fd);
|
static bool write_header(int fd);
|
||||||
|
|
||||||
static bool open_ctx(JournalCtx &ctx, const std::string &path);
|
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_le32(std::vector<std::uint8_t> &out, std::uint32_t v);
|
static void put_le32(std::vector<std::uint8_t> &out, std::uint32_t v);
|
||||||
@@ -158,11 +227,14 @@ 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::unordered_map<Buffer *, std::unique_ptr<BufferRecorder> > recorders_;
|
std::unordered_map<Buffer *, std::unique_ptr<BufferRecorder> > recorders_;
|
||||||
std::mutex mtx_;
|
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 next_seq_{0};
|
||||||
@@ -170,5 +242,12 @@ private:
|
|||||||
std::uint64_t inflight_{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
|
||||||
@@ -16,4 +16,4 @@ public:
|
|||||||
|
|
||||||
virtual void OnDelete(int row, int col, std::size_t len) = 0;
|
virtual void OnDelete(int row, int col, std::size_t len) = 0;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
76
SyscallWrappers.cc
Normal file
76
SyscallWrappers.cc
Normal 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
47
SyscallWrappers.h
Normal 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
|
||||||
@@ -94,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) {
|
||||||
@@ -123,4 +126,4 @@ TerminalFrontend::Shutdown()
|
|||||||
have_old_sigint_ = false;
|
have_old_sigint_ = false;
|
||||||
}
|
}
|
||||||
endwin();
|
endwin();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -38,4 +38,4 @@ private:
|
|||||||
// Saved SIGINT handler to restore on shutdown
|
// Saved SIGINT handler to restore on shutdown
|
||||||
bool have_old_sigint_ = false;
|
bool have_old_sigint_ = false;
|
||||||
struct sigaction old_sigint_{};
|
struct sigaction old_sigint_{};
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -329,4 +329,4 @@ TerminalInputHandler::Poll(MappedInput &out)
|
|||||||
{
|
{
|
||||||
out = {};
|
out = {};
|
||||||
return decode_(out) && out.hasCommand;
|
return decode_(out) && out.hasCommand;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -34,4 +34,4 @@ private:
|
|||||||
bool mouse_selecting_ = false;
|
bool mouse_selecting_ = false;
|
||||||
|
|
||||||
Editor *ed_ = nullptr; // attached editor for uarg handling
|
Editor *ed_ = nullptr; // attached editor for uarg handling
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -615,4 +615,4 @@ TerminalRenderer::Draw(Editor &ed)
|
|||||||
}
|
}
|
||||||
|
|
||||||
refresh();
|
refresh();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,4 +12,4 @@ public:
|
|||||||
~TerminalRenderer() override;
|
~TerminalRenderer() override;
|
||||||
|
|
||||||
void Draw(Editor &ed) override;
|
void Draw(Editor &ed) override;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -16,6 +16,9 @@ TestFrontend::Init(int &argc, char **argv, 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) {
|
||||||
@@ -32,4 +35,4 @@ TestFrontend::Step(Editor &ed, bool &running)
|
|||||||
|
|
||||||
|
|
||||||
void
|
void
|
||||||
TestFrontend::Shutdown() {}
|
TestFrontend::Shutdown() {}
|
||||||
|
|||||||
@@ -34,4 +34,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
TestInputHandler input_{};
|
TestInputHandler input_{};
|
||||||
TestRenderer renderer_{};
|
TestRenderer renderer_{};
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -27,4 +27,4 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
std::queue<MappedInput> queue_;
|
std::queue<MappedInput> queue_;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -29,4 +29,4 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
std::size_t draw_count_ = 0;
|
std::size_t draw_count_ = 0;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -20,4 +20,4 @@ struct UndoNode {
|
|||||||
UndoNode *parent = nullptr; // previous state; null means pre-first-edit
|
UndoNode *parent = nullptr; // previous state; null means pre-first-edit
|
||||||
UndoNode *child = nullptr; // next in current timeline
|
UndoNode *child = nullptr; // next in current timeline
|
||||||
UndoNode *next = nullptr; // redo branch
|
UndoNode *next = nullptr; // redo branch
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -60,4 +60,4 @@ private:
|
|||||||
std::size_t block_size_;
|
std::size_t block_size_;
|
||||||
std::vector<std::unique_ptr<UndoNode[]> > blocks_;
|
std::vector<std::unique_ptr<UndoNode[]> > blocks_;
|
||||||
std::stack<UndoNode *> available_;
|
std::stack<UndoNode *> available_;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -452,4 +452,4 @@ UndoSystem::debug_log(const char *op) const
|
|||||||
#else
|
#else
|
||||||
(void) op;
|
(void) op;
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|||||||
41
UndoSystem.h
41
UndoSystem.h
@@ -1,3 +1,44 @@
|
|||||||
|
/*
|
||||||
|
* UndoSystem.h - undo/redo system with tree-based branching
|
||||||
|
*
|
||||||
|
* UndoSystem manages the undo/redo history for a Buffer. It provides:
|
||||||
|
*
|
||||||
|
* - Tree-based undo: Multiple redo branches at each node (not just linear history)
|
||||||
|
* - Atomic grouping: Multiple operations can be undone/redone as a single step
|
||||||
|
* - Dirty tracking: Marks when buffer matches last saved state
|
||||||
|
* - Efficient storage: Nodes stored in UndoTree, operations applied to Buffer
|
||||||
|
*
|
||||||
|
* Key concepts:
|
||||||
|
*
|
||||||
|
* 1. Undo tree structure:
|
||||||
|
* - Each edit creates a node in the tree
|
||||||
|
* - Undo moves up the tree (toward root)
|
||||||
|
* - Redo moves down the tree (toward leaves)
|
||||||
|
* - Multiple redo branches preserved (not lost on new edits after undo)
|
||||||
|
*
|
||||||
|
* 2. Operation lifecycle:
|
||||||
|
* - Begin(type): Start recording an operation (insert/delete)
|
||||||
|
* - Append(text): Add content to the pending operation
|
||||||
|
* - commit(): Finalize and add to undo tree
|
||||||
|
* - discard_pending(): Cancel without recording
|
||||||
|
*
|
||||||
|
* 3. Atomic grouping:
|
||||||
|
* - BeginGroup()/EndGroup(): Bracket multiple operations
|
||||||
|
* - All operations in a group share the same group_id
|
||||||
|
* - Undo/redo treats the entire group as one step
|
||||||
|
*
|
||||||
|
* 4. Integration with Buffer:
|
||||||
|
* - UndoSystem holds a reference to its owning Buffer
|
||||||
|
* - apply() executes undo/redo by calling Buffer's editing methods
|
||||||
|
* - Buffer's dirty flag updated automatically
|
||||||
|
*
|
||||||
|
* Usage pattern:
|
||||||
|
* undo_system.Begin(UndoType::Insert);
|
||||||
|
* undo_system.Append("text");
|
||||||
|
* undo_system.commit(); // Now undoable
|
||||||
|
*
|
||||||
|
* See also: UndoTree.h (storage), UndoNode.h (node structure)
|
||||||
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
#include <string_view>
|
#include <string_view>
|
||||||
#include <cstddef>
|
#include <cstddef>
|
||||||
|
|||||||
@@ -7,4 +7,4 @@ struct UndoTree {
|
|||||||
UndoNode *current = nullptr; // current state of buffer
|
UndoNode *current = nullptr; // current state of buffer
|
||||||
UndoNode *saved = nullptr; // points to node matching last save (for dirty flag)
|
UndoNode *saved = nullptr; // points to node matching last save (for dirty flag)
|
||||||
UndoNode *pending = nullptr; // in-progress batch (detached)
|
UndoNode *pending = nullptr; // in-progress batch (detached)
|
||||||
};
|
};
|
||||||
|
|||||||
28
docker-build.sh
Executable file
28
docker-build.sh
Executable file
@@ -0,0 +1,28 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# Helper script to test Linux builds using Docker/Podman
|
||||||
|
# This script mounts the current source tree into a Linux container,
|
||||||
|
# builds kte in terminal-only mode, and runs the test suite.
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Detect whether to use docker or podman
|
||||||
|
if command -v docker &> /dev/null; then
|
||||||
|
CONTAINER_CMD="docker"
|
||||||
|
elif command -v podman &> /dev/null; then
|
||||||
|
CONTAINER_CMD="podman"
|
||||||
|
else
|
||||||
|
echo "Error: Neither docker nor podman found in PATH"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
IMAGE_NAME="kte-linux"
|
||||||
|
|
||||||
|
# Check if image exists, if not, build it
|
||||||
|
if ! $CONTAINER_CMD image inspect "$IMAGE_NAME" &> /dev/null; then
|
||||||
|
echo "Building $IMAGE_NAME image..."
|
||||||
|
$CONTAINER_CMD build -t "$IMAGE_NAME" .
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Run the container with the current directory mounted
|
||||||
|
echo "Running Linux build and tests..."
|
||||||
|
$CONTAINER_CMD run --rm -v "$(pwd):/kte" "$IMAGE_NAME"
|
||||||
245
docs/BENCHMARKS.md
Normal file
245
docs/BENCHMARKS.md
Normal file
@@ -0,0 +1,245 @@
|
|||||||
|
# kte Benchmarking and Testing Guide
|
||||||
|
|
||||||
|
This document describes the benchmarking infrastructure and testing
|
||||||
|
improvements added to ensure high performance and correctness of core
|
||||||
|
operations.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The kte test suite now includes comprehensive benchmarks and migration
|
||||||
|
coverage tests to:
|
||||||
|
|
||||||
|
- Measure performance of core operations (PieceTable, Buffer, syntax
|
||||||
|
highlighting)
|
||||||
|
- Ensure no performance regressions from refactorings
|
||||||
|
- Validate correctness of API migrations (Buffer::Rows() →
|
||||||
|
GetLineString/GetLineView)
|
||||||
|
- Provide performance baselines for future optimizations
|
||||||
|
|
||||||
|
## Running Tests
|
||||||
|
|
||||||
|
### All Tests (including benchmarks)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cmake --build cmake-build-debug --target kte_tests && ./cmake-build-debug/kte_tests
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test Organization
|
||||||
|
|
||||||
|
- **58 existing tests**: Core functionality, undo/redo, swap recovery,
|
||||||
|
search, etc.
|
||||||
|
- **15 benchmark tests**: Performance measurements for critical
|
||||||
|
operations
|
||||||
|
- **30 migration coverage tests**: Edge cases and correctness validation
|
||||||
|
|
||||||
|
Total: **98 tests**
|
||||||
|
|
||||||
|
## Benchmark Results
|
||||||
|
|
||||||
|
### Buffer Iteration Patterns (5,000 lines)
|
||||||
|
|
||||||
|
| Pattern | Time | Speedup vs Rows() |
|
||||||
|
|-----------------------------------------|---------|-------------------|
|
||||||
|
| `Rows()` + iteration | 3.1 ms | 1.0x (baseline) |
|
||||||
|
| `Nrows()` + `GetLineString()` | 1.9 ms | **1.7x faster** |
|
||||||
|
| `Nrows()` + `GetLineView()` (zero-copy) | 0.28 ms | **11x faster** |
|
||||||
|
|
||||||
|
**Key Insight**: `GetLineView()` provides zero-copy access and is
|
||||||
|
dramatically faster than materializing the entire rows cache.
|
||||||
|
|
||||||
|
### PieceTable Operations (10,000 lines)
|
||||||
|
|
||||||
|
| Operation | Time |
|
||||||
|
|-----------------------------|---------|
|
||||||
|
| Sequential inserts (10K) | 2.1 ms |
|
||||||
|
| Random inserts (5K) | 32.9 ms |
|
||||||
|
| `GetLine()` sequential | 4.7 ms |
|
||||||
|
| `GetLineRange()` sequential | 1.3 ms |
|
||||||
|
|
||||||
|
### Buffer Operations
|
||||||
|
|
||||||
|
| Operation | Time |
|
||||||
|
|--------------------------------------|---------|
|
||||||
|
| `Nrows()` (1M calls) | 13.0 ms |
|
||||||
|
| `GetLineString()` (10K lines) | 4.8 ms |
|
||||||
|
| `GetLineView()` (10K lines) | 1.6 ms |
|
||||||
|
| `Rows()` materialization (10K lines) | 6.2 ms |
|
||||||
|
|
||||||
|
### Syntax Highlighting
|
||||||
|
|
||||||
|
| Operation | Time | Notes |
|
||||||
|
|------------------------------------|---------|----------------|
|
||||||
|
| C++ highlighting (~1000 lines) | 2.0 ms | First pass |
|
||||||
|
| HighlighterEngine cache population | 19.9 ms | |
|
||||||
|
| HighlighterEngine cache hits | 0.52 ms | **38x faster** |
|
||||||
|
|
||||||
|
### Large File Performance
|
||||||
|
|
||||||
|
| Operation | Time |
|
||||||
|
|---------------------------------|---------|
|
||||||
|
| Insert 50K lines | 0.53 ms |
|
||||||
|
| Iterate 50K lines (GetLineView) | 2.7 ms |
|
||||||
|
| Random access (10K accesses) | 1.8 ms |
|
||||||
|
|
||||||
|
## API Differences: GetLineString vs GetLineView
|
||||||
|
|
||||||
|
Understanding the difference between these APIs is critical:
|
||||||
|
|
||||||
|
### `GetLineString(row)`
|
||||||
|
|
||||||
|
- Returns: `std::string` (copy)
|
||||||
|
- Content: Line text **without** trailing newline
|
||||||
|
- Use case: When you need to modify the string or store it
|
||||||
|
- Example: `"hello"` for line `"hello\n"`
|
||||||
|
|
||||||
|
### `GetLineView(row)`
|
||||||
|
|
||||||
|
- Returns: `std::string_view` (zero-copy)
|
||||||
|
- Content: Raw line range **including** trailing newline
|
||||||
|
- Use case: Read-only access, maximum performance
|
||||||
|
- Example: `"hello\n"` for line `"hello\n"`
|
||||||
|
- **Warning**: View becomes invalid after buffer modifications
|
||||||
|
|
||||||
|
### `Rows()`
|
||||||
|
|
||||||
|
- Returns: `std::vector<Buffer::Line>&` (materialized cache)
|
||||||
|
- Content: Lines **without** trailing newlines
|
||||||
|
- Use case: Legacy code, being phased out
|
||||||
|
- Performance: Slower due to materialization overhead
|
||||||
|
|
||||||
|
## Migration Coverage Tests
|
||||||
|
|
||||||
|
The `test_migration_coverage.cc` file provides 30 tests covering:
|
||||||
|
|
||||||
|
### Edge Cases
|
||||||
|
|
||||||
|
- Empty buffers
|
||||||
|
- Single lines (with/without newlines)
|
||||||
|
- Very long lines (10,000 characters)
|
||||||
|
- Many empty lines (1,000 newlines)
|
||||||
|
|
||||||
|
### Consistency
|
||||||
|
|
||||||
|
- `GetLineString()` vs `GetLineView()` vs `Rows()`
|
||||||
|
- Consistency after edits (insert, delete, split, join)
|
||||||
|
|
||||||
|
### Boundary Conditions
|
||||||
|
|
||||||
|
- First line access
|
||||||
|
- Last line access
|
||||||
|
- Line range boundaries
|
||||||
|
|
||||||
|
### Special Characters
|
||||||
|
|
||||||
|
- Tabs, carriage returns, null bytes
|
||||||
|
- Unicode (UTF-8 multibyte characters)
|
||||||
|
|
||||||
|
### Stress Tests
|
||||||
|
|
||||||
|
- Large files (10,000 lines)
|
||||||
|
- Many small operations (100+ inserts)
|
||||||
|
- Alternating insert/delete patterns
|
||||||
|
|
||||||
|
### Regression Tests
|
||||||
|
|
||||||
|
- Shebang detection pattern (Editor.cc)
|
||||||
|
- Empty buffer check pattern (Editor.cc)
|
||||||
|
- Syntax highlighter pattern (all highlighters)
|
||||||
|
- Swap snapshot pattern (Swap.cc)
|
||||||
|
|
||||||
|
## Performance Recommendations
|
||||||
|
|
||||||
|
Based on benchmark results:
|
||||||
|
|
||||||
|
1. **Prefer `GetLineView()` for read-only access**
|
||||||
|
- 11x faster than `Rows()` for iteration
|
||||||
|
- Zero-copy, minimal overhead
|
||||||
|
- Use immediately (view invalidates on edit)
|
||||||
|
|
||||||
|
2. **Use `GetLineString()` when you need a copy**
|
||||||
|
- Still 1.7x faster than `Rows()`
|
||||||
|
- Safe to store and modify
|
||||||
|
- Strips trailing newlines automatically
|
||||||
|
|
||||||
|
3. **Avoid `Rows()` in hot paths**
|
||||||
|
- Materializes entire line cache
|
||||||
|
- Slower for large files
|
||||||
|
- Being phased out (legacy API)
|
||||||
|
|
||||||
|
4. **Cache `Nrows()` in tight loops**
|
||||||
|
- Very fast (13ms for 1M calls)
|
||||||
|
- But still worth caching in inner loops
|
||||||
|
|
||||||
|
5. **Leverage HighlighterEngine caching**
|
||||||
|
- 38x speedup on cache hits
|
||||||
|
- Automatically invalidates on edits
|
||||||
|
- Prefetch viewport for smooth scrolling
|
||||||
|
|
||||||
|
## Adding New Benchmarks
|
||||||
|
|
||||||
|
To add a new benchmark:
|
||||||
|
|
||||||
|
1. Add a `TEST(Benchmark_YourName)` in `tests/test_benchmarks.cc`
|
||||||
|
2. Use `BenchmarkTimer` to measure critical sections:
|
||||||
|
```cpp
|
||||||
|
{
|
||||||
|
BenchmarkTimer timer("Operation description");
|
||||||
|
// ... code to benchmark ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
3. Print section headers with `std::cout` for clarity
|
||||||
|
4. Use `ASSERT_EQ` or `EXPECT_TRUE` to validate results
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
TEST(Benchmark_MyOperation) {
|
||||||
|
std::cout << "\n=== My Operation Benchmark ===\n";
|
||||||
|
|
||||||
|
// Setup
|
||||||
|
Buffer buf;
|
||||||
|
std::string data = generate_test_data();
|
||||||
|
buf.insert_text(0, 0, data);
|
||||||
|
|
||||||
|
std::size_t result = 0;
|
||||||
|
{
|
||||||
|
BenchmarkTimer timer("My operation on 10K lines");
|
||||||
|
for (std::size_t i = 0; i < buf.Nrows(); ++i) {
|
||||||
|
result += my_operation(buf, i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
EXPECT_TRUE(result > 0);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Continuous Performance Monitoring
|
||||||
|
|
||||||
|
Run benchmarks regularly to detect regressions:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run tests and save output
|
||||||
|
./cmake-build-debug/kte_tests > benchmark_results.txt
|
||||||
|
|
||||||
|
# Compare with baseline
|
||||||
|
diff benchmark_baseline.txt benchmark_results.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Look for:
|
||||||
|
|
||||||
|
- Significant time increases (>20%) in any benchmark
|
||||||
|
- New operations that are slower than expected
|
||||||
|
- Cache effectiveness degradation
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
The benchmark suite provides:
|
||||||
|
|
||||||
|
- **Performance validation**: Ensures migrations don't regress
|
||||||
|
performance
|
||||||
|
- **Optimization guidance**: Identifies fastest APIs for each use case
|
||||||
|
- **Regression detection**: Catches performance issues early
|
||||||
|
- **Documentation**: Demonstrates correct API usage patterns
|
||||||
|
|
||||||
|
All 98 tests pass with 0 failures, confirming both correctness and
|
||||||
|
performance of the migrated codebase.
|
||||||
1138
docs/DEVELOPER_GUIDE.md
Normal file
1138
docs/DEVELOPER_GUIDE.md
Normal file
File diff suppressed because it is too large
Load Diff
549
docs/audits/error-propagation-standardization.md
Normal file
549
docs/audits/error-propagation-standardization.md
Normal 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.
|
||||||
237
docs/swap.md
Normal file
237
docs/swap.md
Normal 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 buffer’s
|
||||||
|
path:
|
||||||
|
|
||||||
|
1. Take a canonical-ish path key (`std::filesystem::weakly_canonical`,
|
||||||
|
else `absolute`, else the raw `Buffer::Filename()`).
|
||||||
|
2. Encode it so it’s 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)
|
||||||
@@ -11884,4 +11884,4 @@ static const unsigned int DefaultFontRegularCompressedData[72616 / 4] =
|
|||||||
0x0070a96e,
|
0x0070a96e,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5586,4 +5586,4 @@ static const unsigned int DefaultFontBoldCompressedData[32380 / 4] =
|
|||||||
0x0e01060e, 0xff01b82a, 0x8d04b085,
|
0x0e01060e, 0xff01b82a, 0x8d04b085,
|
||||||
0x440002b1, 0x066405b3, 0x00444400, 0x01000000, 0x00000000, 0xfacafa05, 0x00004aa6,
|
0x440002b1, 0x066405b3, 0x00444400, 0x01000000, 0x00000000, 0xfacafa05, 0x00004aa6,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5918,4 +5918,4 @@ static const unsigned int DefaultFontRegularCompressedData[34064 / 4] =
|
|||||||
0x20080082, 0x01060eb3, 0x01b82a0e,
|
0x20080082, 0x01060eb3, 0x01b82a0e,
|
||||||
0x04b085ff, 0x0002b18d, 0x6405b344, 0x44440006, 0x00000000, 0x00000001, 0xccfa0500, 0x0030ee4f,
|
0x04b085ff, 0x0002b18d, 0x6405b344, 0x44440006, 0x00000000, 0x00000001, 0xccfa0500, 0x0030ee4f,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2851,4 +2851,4 @@ static const unsigned int DefaultFontRegularCompressedData[68288 / 4] =
|
|||||||
0x820a2003, 0x421e20c3, 0x18821057,
|
0x820a2003, 0x421e20c3, 0x18821057,
|
||||||
0x21830284, 0xdeda0024, 0x0d83c5d7, 0xa48ad12b, 0x0000001e, 0xa48ad100, 0x62fa051e, 0x00a176d4,
|
0x21830284, 0xdeda0024, 0x0d83c5d7, 0xa48ad12b, 0x0000001e, 0xa48ad100, 0x62fa051e, 0x00a176d4,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -37,4 +37,4 @@ Font::Load(const float size) const
|
|||||||
|
|
||||||
io.Fonts->Build();
|
io.Fonts->Build();
|
||||||
}
|
}
|
||||||
} // namespace kte::Fonts
|
} // namespace kte::Fonts
|
||||||
|
|||||||
@@ -119,4 +119,4 @@ private:
|
|||||||
|
|
||||||
|
|
||||||
void InstallDefaultFonts();
|
void InstallDefaultFonts();
|
||||||
}
|
}
|
||||||
|
|||||||
25743
fonts/Go.h
25743
fonts/Go.h
File diff suppressed because it is too large
Load Diff
@@ -13671,4 +13671,4 @@ static const unsigned int DefaultFontItalicCompressedData[84884 / 4] =
|
|||||||
0x4f1aea4f, 0x0d2022dc, 0x211fdc4f,
|
0x4f1aea4f, 0x0d2022dc, 0x211fdc4f,
|
||||||
0x164f2804, 0x8b952711, 0x236f6f19, 0xfa050081, 0x0bda00e5,
|
0x164f2804, 0x8b952711, 0x236f6f19, 0xfa050081, 0x0bda00e5,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6231,4 +6231,4 @@ static const unsigned int DefaultFontRegularCompressedData[149388 / 4] =
|
|||||||
0x86382043, 0x870f8383, 0x022e2463,
|
0x86382043, 0x870f8383, 0x022e2463,
|
||||||
0x05480066, 0x599623fa, 0x00000043,
|
0x05480066, 0x599623fa, 0x00000043,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5632,4 +5632,4 @@ static const unsigned int DefaultFontRegularCompressedData[66932 / 4] =
|
|||||||
0xc6221786, 0x1788a203, 0x86008524,
|
0xc6221786, 0x1788a203, 0x86008524,
|
||||||
0x2f88e200, 0x1788a520, 0xf6ffb424, 0xfa05fa00, 0xc234b8e9,
|
0x2f88e200, 0x1788a520, 0xf6ffb424, 0xfa05fa00, 0xc234b8e9,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5737,4 +5737,4 @@ static const unsigned int DefaultFontBoldCompressedData[68920 / 4] =
|
|||||||
0x86910006, 0x03c32217, 0x241788b7, 0x00ce0085, 0x202f88e4, 0x261788b5, 0x00ebffb4, 0x050000fe, 0x877646fa,
|
0x86910006, 0x03c32217, 0x241788b7, 0x00ce0085, 0x202f88e4, 0x261788b5, 0x00ebffb4, 0x050000fe, 0x877646fa,
|
||||||
0x000000de,
|
0x000000de,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
22065
fonts/Triplicate.h
22065
fonts/Triplicate.h
File diff suppressed because it is too large
Load Diff
246
main.cc
246
main.cc
@@ -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)
|
||||||
@@ -181,141 +182,144 @@ main(int argc, char *argv[])
|
|||||||
return RunStressHighlighter(stress_seconds);
|
return RunStressHighlighter(stress_seconds);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Determine frontend
|
// Top-level exception handler to prevent data loss and ensure cleanup
|
||||||
|
try {
|
||||||
|
// 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;
|
<<
|
||||||
return 2;
|
std::endl;
|
||||||
}
|
return 2;
|
||||||
|
}
|
||||||
#else
|
#else
|
||||||
bool use_gui = false;
|
bool use_gui = false;
|
||||||
if (req_gui) {
|
if (req_gui) {
|
||||||
use_gui = true;
|
use_gui = true;
|
||||||
} else if (req_term) {
|
} else if (req_term) {
|
||||||
use_gui = false;
|
use_gui = false;
|
||||||
} else {
|
} else {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// Default depends on build target: kge defaults to GUI, kte to terminal
|
// Default depends on build target: kge defaults to GUI, kte to terminal
|
||||||
#if defined(KTE_DEFAULT_GUI)
|
#if defined(KTE_DEFAULT_GUI)
|
||||||
use_gui = true;
|
use_gui = true;
|
||||||
#else
|
#else
|
||||||
use_gui = false;
|
use_gui = false;
|
||||||
#endif
|
#endif
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// 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 (optind < argc) {
|
|
||||||
std::size_t pending_line = 0; // 0 = no pending line
|
|
||||||
for (int i = optind; i < argc; ++i) {
|
|
||||||
const char *arg = argv[i];
|
|
||||||
if (arg && arg[0] == '+') {
|
|
||||||
// Parse +<digits>
|
|
||||||
const char *p = arg + 1;
|
|
||||||
if (*p != '\0') {
|
|
||||||
bool all_digits = true;
|
|
||||||
for (const char *q = p; *q; ++q) {
|
|
||||||
if (!std::isdigit(static_cast<unsigned char>(*q))) {
|
|
||||||
all_digits = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (all_digits) {
|
|
||||||
// Clamp to >=1 later; 0 disables.
|
|
||||||
try {
|
|
||||||
unsigned long v = std::stoul(p);
|
|
||||||
if (v > std::numeric_limits<std::size_t>::max()) {
|
|
||||||
std::cerr <<
|
|
||||||
"kte: Warning: Line number too large, ignoring\n";
|
|
||||||
pending_line = 0;
|
|
||||||
} else {
|
|
||||||
pending_line = static_cast<std::size_t>(v);
|
|
||||||
}
|
|
||||||
} catch (...) {
|
|
||||||
// Ignore malformed huge numbers
|
|
||||||
pending_line = 0;
|
|
||||||
}
|
|
||||||
continue; // look for the next file arg
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Fall through: not a +number, treat as filename starting with '+'
|
|
||||||
}
|
|
||||||
|
|
||||||
std::string err;
|
|
||||||
const std::string path = arg;
|
|
||||||
if (!editor.OpenFile(path, err)) {
|
|
||||||
editor.SetStatus("open: " + err);
|
|
||||||
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.
|
|
||||||
} else {
|
|
||||||
// Create a single empty buffer
|
|
||||||
editor.AddBuffer(Buffer());
|
|
||||||
editor.SetStatus("new: empty buffer");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Install built-in commands
|
|
||||||
InstallDefaultCommands();
|
|
||||||
|
|
||||||
// Select frontend
|
|
||||||
std::unique_ptr<Frontend> fe;
|
|
||||||
#if defined(KTE_BUILD_GUI)
|
|
||||||
if (use_gui) {
|
|
||||||
fe = std::make_unique<GUIFrontend>();
|
|
||||||
} else
|
|
||||||
#endif
|
#endif
|
||||||
{
|
|
||||||
fe = std::make_unique<TerminalFrontend>();
|
// 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 (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
|
||||||
|
for (int i = optind; i < argc; ++i) {
|
||||||
|
const char *arg = argv[i];
|
||||||
|
if (arg && arg[0] == '+') {
|
||||||
|
// Parse +<digits>
|
||||||
|
const char *p = arg + 1;
|
||||||
|
if (*p != '\0') {
|
||||||
|
bool all_digits = true;
|
||||||
|
for (const char *q = p; *q; ++q) {
|
||||||
|
if (!std::isdigit(static_cast<unsigned char>(*q))) {
|
||||||
|
all_digits = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (all_digits) {
|
||||||
|
// Clamp to >=1 later; 0 disables.
|
||||||
|
try {
|
||||||
|
unsigned long v = std::stoul(p);
|
||||||
|
if (v > std::numeric_limits<std::size_t>::max()) {
|
||||||
|
std::cerr <<
|
||||||
|
"kte: Warning: Line number too large, ignoring\n";
|
||||||
|
pending_line = 0;
|
||||||
|
} else {
|
||||||
|
pending_line = static_cast<std::size_t>(v);
|
||||||
|
}
|
||||||
|
} catch (...) {
|
||||||
|
// Ignore malformed huge numbers
|
||||||
|
pending_line = 0;
|
||||||
|
}
|
||||||
|
continue; // look for the next file arg
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Fall through: not a +number, treat as filename starting with '+'
|
||||||
|
}
|
||||||
|
|
||||||
|
const std::string path = arg;
|
||||||
|
editor.RequestOpenFile(path, pending_line);
|
||||||
|
pending_line = 0; // consumed (if set)
|
||||||
|
}
|
||||||
|
// If we ended with a pending +N but no subsequent file, ignore it.
|
||||||
|
} else {
|
||||||
|
// Create a single empty buffer
|
||||||
|
editor.AddBuffer(Buffer());
|
||||||
|
editor.SetStatus("new: empty buffer");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Install built-in commands
|
||||||
|
InstallDefaultCommands();
|
||||||
|
|
||||||
|
// Select frontend
|
||||||
|
std::unique_ptr<Frontend> fe;
|
||||||
|
#if defined(KTE_BUILD_GUI)
|
||||||
|
if (use_gui) {
|
||||||
|
fe = std::make_unique<GUIFrontend>();
|
||||||
|
} else
|
||||||
|
#endif
|
||||||
|
{
|
||||||
|
fe = std::make_unique<TerminalFrontend>();
|
||||||
|
}
|
||||||
|
|
||||||
#if defined(KTE_BUILD_GUI) && defined(__APPLE__)
|
#if defined(KTE_BUILD_GUI) && defined(__APPLE__)
|
||||||
if (use_gui) {
|
if (use_gui) {
|
||||||
/* likely using the .app, so need to cd */
|
/* likely using the .app, so need to cd */
|
||||||
const char *home = getenv("HOME");
|
const char *home = getenv("HOME");
|
||||||
if (!home) {
|
if (!home) {
|
||||||
std::cerr << "kge.app: HOME environment variable not set" << std::endl;
|
std::cerr << "kge.app: HOME environment variable not set" << std::endl;
|
||||||
return 1;
|
return 1;
|
||||||
|
}
|
||||||
|
if (chdir(home) != 0) {
|
||||||
|
std::cerr << "kge.app: failed to chdir to " << home << ": "
|
||||||
|
<< std::strerror(errno) << std::endl;
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if (chdir(home) != 0) {
|
|
||||||
std::cerr << "kge.app: failed to chdir to " << home << ": "
|
|
||||||
<< std::strerror(errno) << std::endl;
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
if (!fe->Init(argc, argv, 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;
|
||||||
|
}
|
||||||
|
|
||||||
|
Execute(editor, CommandId::CenterOnCursor);
|
||||||
|
|
||||||
|
bool running = true;
|
||||||
|
while (running) {
|
||||||
|
fe->Step(editor, running);
|
||||||
|
}
|
||||||
|
|
||||||
|
fe->Shutdown();
|
||||||
|
|
||||||
|
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;
|
return 1;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
Execute(editor, CommandId::CenterOnCursor);
|
|
||||||
|
|
||||||
bool running = true;
|
|
||||||
while (running) {
|
|
||||||
fe->Step(editor, running);
|
|
||||||
}
|
|
||||||
|
|
||||||
fe->Shutdown();
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
@@ -60,11 +60,10 @@ CppHighlighter::HighlightLineStateful(const Buffer &buf,
|
|||||||
const LineState &prev,
|
const LineState &prev,
|
||||||
std::vector<HighlightSpan> &out) const
|
std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
|
||||||
StatefulHighlighter::LineState state = prev;
|
StatefulHighlighter::LineState state = prev;
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
return state;
|
return state;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
if (s.empty())
|
if (s.empty())
|
||||||
return state;
|
return state;
|
||||||
|
|
||||||
@@ -143,7 +142,7 @@ CppHighlighter::HighlightLineStateful(const Buffer &buf,
|
|||||||
bool closed = false;
|
bool closed = false;
|
||||||
while (j + 1 <= n) {
|
while (j + 1 <= n) {
|
||||||
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
||||||
j += 2;
|
j += 2;
|
||||||
closed = true;
|
closed = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -32,4 +32,4 @@ private:
|
|||||||
|
|
||||||
static bool is_ident_char(char c);
|
static bool is_ident_char(char c);
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -40,10 +40,9 @@ ErlangHighlighter::ErlangHighlighter()
|
|||||||
void
|
void
|
||||||
ErlangHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
ErlangHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
|
|
||||||
|
|||||||
@@ -14,4 +14,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -40,10 +40,9 @@ ForthHighlighter::ForthHighlighter()
|
|||||||
void
|
void
|
||||||
ForthHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
ForthHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
|
|
||||||
|
|||||||
@@ -14,4 +14,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -46,10 +46,9 @@ GoHighlighter::GoHighlighter()
|
|||||||
void
|
void
|
||||||
GoHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
GoHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
int bol = 0;
|
int bol = 0;
|
||||||
@@ -75,7 +74,7 @@ GoHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSp
|
|||||||
bool closed = false;
|
bool closed = false;
|
||||||
while (j + 1 <= n) {
|
while (j + 1 <= n) {
|
||||||
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
||||||
j += 2;
|
j += 2;
|
||||||
closed = true;
|
closed = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,4 +15,4 @@ private:
|
|||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
std::unordered_set<std::string> types_;
|
std::unordered_set<std::string> types_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -82,7 +82,7 @@ HighlighterEngine::GetLine(const Buffer &buf, int row, std::uint64_t buf_version
|
|||||||
// Only use cached state if it's for the current version and row still exists
|
// Only use cached state if it's for the current version and row still exists
|
||||||
if (r <= row - 1 && kv.second.version == buf_version) {
|
if (r <= row - 1 && kv.second.version == buf_version) {
|
||||||
// Validate that the cached row index is still valid in the buffer
|
// Validate that the cached row index is still valid in the buffer
|
||||||
if (r >= 0 && static_cast<std::size_t>(r) < buf.Rows().size()) {
|
if (r >= 0 && static_cast<std::size_t>(r) < buf.Nrows()) {
|
||||||
if (r > best)
|
if (r > best)
|
||||||
best = r;
|
best = r;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -87,4 +87,4 @@ private:
|
|||||||
|
|
||||||
void worker_loop() const;
|
void worker_loop() const;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -244,4 +244,4 @@ HighlighterRegistry::RegisterTreeSitter(std::string_view filetype,
|
|||||||
}, /*override_existing=*/true);
|
}, /*override_existing=*/true);
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -44,4 +44,4 @@ public:
|
|||||||
const TSLanguage * (*get_language)());
|
const TSLanguage * (*get_language)());
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -13,10 +13,9 @@ is_digit(char c)
|
|||||||
void
|
void
|
||||||
JSONHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
JSONHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
auto push = [&](int a, int b, TokenKind k) {
|
auto push = [&](int a, int b, TokenKind k) {
|
||||||
if (b > a)
|
if (b > a)
|
||||||
|
|||||||
@@ -9,4 +9,4 @@ class JSONHighlighter final : public LanguageHighlighter {
|
|||||||
public:
|
public:
|
||||||
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -48,4 +48,4 @@ public:
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -25,10 +25,9 @@ LispHighlighter::LispHighlighter()
|
|||||||
void
|
void
|
||||||
LispHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
LispHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
int bol = 0;
|
int bol = 0;
|
||||||
|
|||||||
@@ -14,4 +14,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -24,10 +24,9 @@ MarkdownHighlighter::HighlightLineStateful(const Buffer &buf, int row, const Lin
|
|||||||
std::vector<HighlightSpan> &out) const
|
std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
StatefulHighlighter::LineState state = prev;
|
StatefulHighlighter::LineState state = prev;
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return state;
|
return state;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
|
|
||||||
// Reuse in_block_comment flag as "in fenced code" state.
|
// Reuse in_block_comment flag as "in fenced code" state.
|
||||||
|
|||||||
@@ -11,4 +11,4 @@ public:
|
|||||||
LineState HighlightLineStateful(const Buffer &buf, int row, const LineState &prev,
|
LineState HighlightLineStateful(const Buffer &buf, int row, const LineState &prev,
|
||||||
std::vector<HighlightSpan> &out) const override;
|
std::vector<HighlightSpan> &out) const override;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -5,10 +5,9 @@ namespace kte {
|
|||||||
void
|
void
|
||||||
NullHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
NullHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
if (n <= 0)
|
if (n <= 0)
|
||||||
return;
|
return;
|
||||||
|
|||||||
@@ -8,4 +8,4 @@ class NullHighlighter final : public LanguageHighlighter {
|
|||||||
public:
|
public:
|
||||||
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
void HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const override;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -50,10 +50,9 @@ PythonHighlighter::HighlightLineStateful(const Buffer &buf, int row, const LineS
|
|||||||
std::vector<HighlightSpan> &out) const
|
std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
StatefulHighlighter::LineState state = prev;
|
StatefulHighlighter::LineState state = prev;
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return state;
|
return state;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
|
|
||||||
// Triple-quoted string continuation uses in_raw_string with raw_delim either "'''" or "\"\"\""
|
// Triple-quoted string continuation uses in_raw_string with raw_delim either "'''" or "\"\"\""
|
||||||
|
|||||||
@@ -17,4 +17,4 @@ public:
|
|||||||
private:
|
private:
|
||||||
std::unordered_set<std::string> kws_;
|
std::unordered_set<std::string> kws_;
|
||||||
};
|
};
|
||||||
} // namespace kte
|
} // namespace kte
|
||||||
|
|||||||
@@ -47,10 +47,9 @@ RustHighlighter::RustHighlighter()
|
|||||||
void
|
void
|
||||||
RustHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
RustHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<HighlightSpan> &out) const
|
||||||
{
|
{
|
||||||
const auto &rows = buf.Rows();
|
if (row < 0 || static_cast<std::size_t>(row) >= buf.Nrows())
|
||||||
if (row < 0 || static_cast<std::size_t>(row) >= rows.size())
|
|
||||||
return;
|
return;
|
||||||
std::string s = static_cast<std::string>(rows[static_cast<std::size_t>(row)]);
|
std::string s = buf.GetLineString(static_cast<std::size_t>(row));
|
||||||
int n = static_cast<int>(s.size());
|
int n = static_cast<int>(s.size());
|
||||||
int i = 0;
|
int i = 0;
|
||||||
while (i < n) {
|
while (i < n) {
|
||||||
@@ -72,7 +71,7 @@ RustHighlighter::HighlightLine(const Buffer &buf, int row, std::vector<Highlight
|
|||||||
bool closed = false;
|
bool closed = false;
|
||||||
while (j + 1 <= n) {
|
while (j + 1 <= n) {
|
||||||
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
if (j + 1 < n && s[j] == '*' && s[j + 1] == '/') {
|
||||||
j += 2;
|
j += 2;
|
||||||
closed = true;
|
closed = true;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user