kte/Editor.cc

#include <algorithm>
#include <cstdio>
#include <cstdlib>
#include <filesystem>
#include <utility>

#include "Editor.h"
#include "ErrorHandler.h"
#include "syntax/HighlighterRegistry.h"
#include "syntax/CppHighlighter.h"
#include "syntax/NullHighlighter.h"


namespace {
// Universal-argument repeat counts are capped here (well below INT_MAX).
constexpr int kMaxUArgCount = 1000000;
} // namespace


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


namespace {
// Same normalization as Buffer::OpenFromFile (expand "~", canonical path if
// the file exists, else absolute), so a path can be compared with the
// Filename() of open buffers.
std::string
normalize_open_path(const std::string &in)
{
	std::string expanded = in;
	if (!expanded.empty() && expanded[0] == '~') {
		const char *home = std::getenv("HOME");
		if (home && expanded.size() >= 2 && (expanded[1] == '/' || expanded[1] == '\\'))
			expanded = std::string(home) + expanded.substr(1);
		else if (home && expanded.size() == 1)
			expanded = std::string(home);
	}
	try {
		std::filesystem::path p(expanded);
		if (std::filesystem::exists(p))
			return std::filesystem::canonical(p).string();
		return std::filesystem::absolute(p).string();
	} catch (...) {
		return expanded;
	}
}
} // namespace


std::size_t
Editor::FindOpenBuffer(const std::string &path) const
{
	const std::string norm = normalize_open_path(path);
	const auto &bufs       = Buffers();
	for (std::size_t i = 0; i < bufs.size(); ++i) {
		if (!bufs[i].Filename().empty() && bufs[i].Filename() == norm)
			return i;
	}
	return static_cast<std::size_t>(-1);
}


Editor::Editor()
{
	swap_ = std::make_unique<kte::SwapManager>();
}


void
Editor::SetDimensions(std::size_t rows, std::size_t cols)
{
	rows_ = rows;
	cols_ = cols;
}


void
Editor::SetStatus(const std::string &message)
{
	msg_   = message;
	msgtm_ = std::time(nullptr);
}


Buffer *
Editor::CurrentBuffer()
{
	auto &bufs = Buffers();
	if (bufs.empty() || curbuf_ >= bufs.size()) {
		return nullptr;
	}
	return &bufs[curbuf_];
}


const Buffer *
Editor::CurrentBuffer() const
{
	const auto &bufs = Buffers();
	if (bufs.empty() || curbuf_ >= bufs.size()) {
		return nullptr;
	}
	return &bufs[curbuf_];
}


static std::vector<std::filesystem::path>
split_reverse(const std::filesystem::path &p)
{
	std::vector<std::filesystem::path> parts;
	for (auto it = p; !it.empty(); it = it.parent_path()) {
		if (it == it.parent_path()) {
			// root or single element
			if (!it.empty())
				parts.push_back(it);
			break;
		}
		parts.push_back(it.filename());
	}
	return parts; // from leaf toward root
}


std::string
Editor::DisplayNameFor(const Buffer &buf) const
{
	std::string full = buf.Filename();
	if (full.empty())
		return std::string("[no name]");

	std::filesystem::path target(full);
	auto target_parts = split_reverse(target);
	if (target_parts.empty())
		return target.filename().string();

	// Prepare list of other buffer paths
	std::vector<std::vector<std::filesystem::path> > others;
	const auto &bufs = Buffers();
	others.reserve(bufs.size());
	for (const auto &b: bufs) {
		if (&b == &buf)
			continue;
		if (b.Filename().empty())
			continue;
		others.push_back(split_reverse(std::filesystem::path(b.Filename())));
	}

	// Increase suffix length until unique among others
	std::size_t need = 1; // at least basename
	for (;;) {
		// Build candidate suffix for target
		std::filesystem::path cand;
		for (std::size_t i = 0; i < need && i < target_parts.size(); ++i) {
			cand = std::filesystem::path(target_parts[i]) / cand;
		}
		// Compare against others
		bool clash = false;
		for (const auto &o_parts: others) {
			std::filesystem::path ocand;
			for (std::size_t i = 0; i < need && i < o_parts.size(); ++i) {
				ocand = std::filesystem::path(o_parts[i]) / ocand;
			}
			if (ocand == cand) {
				clash = true;
				break;
			}
		}
		if (!clash || need >= target_parts.size()) {
			std::string s = cand.string();
			// Remove any trailing slash that may appear from root joining
			if (!s.empty() && (s.back() == '/' || s.back() == '\\'))
				s.pop_back();
			return s;
		}
		++need;
	}
}


std::size_t
Editor::AddBuffer(const Buffer &buf)
{
	auto &bufs = Buffers();
	// push_back may reallocate the vector's storage, moving every existing
	// Buffer to a new address. Drain any in-flight swap records first so the
	// writer thread never dereferences an address that's about to move, then
	// rehome each attached buffer that actually moved.
	if (Swap() && !bufs.empty())
		Swap()->Flush();
	std::vector<Buffer *> old_addrs;
	old_addrs.reserve(bufs.size());
	for (auto &b: bufs)
		old_addrs.push_back(&b);
	bufs.push_back(buf);
	if (Swap()) {
		for (std::size_t i = 0; i < old_addrs.size(); ++i) {
			Buffer *new_addr = &bufs[i];
			if (new_addr != old_addrs[i])
				bufs[i].SetSwapRecorder(Swap()->Rehome(old_addrs[i], new_addr));
		}
		Swap()->Attach(&bufs.back());
		bufs.back().SetSwapRecorder(Swap()->RecorderFor(&bufs.back()));
	}
	if (bufs.size() == 1) {
		curbuf_ = 0;
	}
	return bufs.size() - 1;
}


std::size_t
Editor::AddBuffer(Buffer &&buf)
{
	auto &bufs = Buffers();
	if (Swap() && !bufs.empty())
		Swap()->Flush();
	std::vector<Buffer *> old_addrs;
	old_addrs.reserve(bufs.size());
	for (auto &b: bufs)
		old_addrs.push_back(&b);
	bufs.push_back(std::move(buf));
	if (Swap()) {
		for (std::size_t i = 0; i < old_addrs.size(); ++i) {
			Buffer *new_addr = &bufs[i];
			if (new_addr != old_addrs[i])
				bufs[i].SetSwapRecorder(Swap()->Rehome(old_addrs[i], new_addr));
		}
		Swap()->Attach(&bufs.back());
		bufs.back().SetSwapRecorder(Swap()->RecorderFor(&bufs.back()));
	}
	if (bufs.size() == 1) {
		curbuf_ = 0;
	}
	return bufs.size() - 1;
}


bool
Editor::OpenFile(const std::string &path, std::string &err)
{
	// A file that is already open is switched to, not opened again: two
	// buffers for one file would share (and corrupt) one swap journal, and
	// closing either would delete the other's journal.
	if (const std::size_t open_idx = FindOpenBuffer(path); open_idx != static_cast<std::size_t>(-1)) {
		SwitchTo(open_idx);
		return true;
	}

	// If the current buffer is an unnamed, empty, clean scratch buffer, reuse
	// it instead of creating a new one.
	auto &bufs_ref = Buffers();
	if (!bufs_ref.empty() && curbuf_ < bufs_ref.size()) {
		Buffer &cur                  = bufs_ref[curbuf_];
		const bool unnamed           = cur.Filename().empty() && !cur.IsFileBacked();
		const bool clean             = !cur.Dirty();
		const std::size_t nrows      = cur.Nrows();
		const bool rows_empty        = (nrows == 0);
		const bool single_empty_line = (nrows == 1 && cur.GetLineView(0).size() == 0);
		if (unnamed && clean && (rows_empty || single_empty_line)) {
			bool ok = cur.OpenFromFile(path, err);
			if (!ok)
				return false;
			// Ensure swap recorder is attached for this buffer
			if (Swap()) {
				Swap()->Attach(&cur);
				cur.SetSwapRecorder(Swap()->RecorderFor(&cur));
				Swap()->NotifyFilenameChanged(cur);
			}
			// Setup highlighting using registry (extension + shebang)
			cur.EnsureHighlighter();
			std::string first = "";
			if (cur.Nrows() > 0)
				first = cur.GetLineString(0);
			std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
			if (!ft.empty()) {
				cur.SetFiletype(ft);
				cur.SetSyntaxEnabled(true);
				if (auto *eng = cur.Highlighter()) {
					eng->SetHighlighter(kte::HighlighterRegistry::CreateFor(ft));
					eng->InvalidateFrom(0);
				}
			} else {
				cur.SetFiletype("");
				cur.SetSyntaxEnabled(true);
				if (auto *eng = cur.Highlighter()) {
					eng->SetHighlighter(std::make_unique<kte::NullHighlighter>());
					eng->InvalidateFrom(0);
				}
			}
			// Defensive: ensure any active prompt is closed after a successful open
			CancelPrompt();
			return true;
		}
	}

	Buffer b;
	if (!b.OpenFromFile(path, err)) {
		return false;
	}
	// NOTE: swap recorder/attach must happen after the buffer is stored in its
	// final location (vector) because swap manager keys off Buffer*.
	// Initialize syntax highlighting by extension + shebang via registry (v2)
	b.EnsureHighlighter();
	std::string first = "";
	if (b.Nrows() > 0)
		first = b.GetLineString(0);
	std::string ft = kte::HighlighterRegistry::DetectForPath(path, first);
	if (!ft.empty()) {
		b.SetFiletype(ft);
		b.SetSyntaxEnabled(true);
		if (auto *eng = b.Highlighter()) {
			eng->SetHighlighter(kte::HighlighterRegistry::CreateFor(ft));
			eng->InvalidateFrom(0);
		}
	} else {
		b.SetFiletype("");
		b.SetSyntaxEnabled(true);
		if (auto *eng = b.Highlighter()) {
			eng->SetHighlighter(std::make_unique<kte::NullHighlighter>());
			eng->InvalidateFrom(0);
		}
	}
	// Add as a new buffer and switch to it
	std::size_t idx = AddBuffer(std::move(b));
	if (Swap()) {
		Swap()->NotifyFilenameChanged(Buffers()[idx]);
	}
	SwitchTo(idx);
	// Defensive: ensure any active prompt is closed after a successful open
	CancelPrompt();
	return true;
}


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;
			std::uint64_t valid_bytes = 0;
			if (!kte::SwapManager::ReplayFile(*b, swp, rerr, &valid_bytes)) {
				SetStatus("Swap recovery failed: " + rerr);
				return false;
			}
			// This session keeps appending to the same journal. Drop a torn
			// final record first, or new records would land behind it and the
			// journal could not be replayed after another crash.
			try {
				if (std::filesystem::file_size(swp) > valid_bytes)
					std::filesystem::resize_file(swp, valid_bytes);
			} catch (...) {
				// Best effort; the replay itself succeeded.
			}
			// Nothing in the undo history matches the file on disk now: keep
			// the buffer dirty even after undoing back to the loaded state.
			if (auto *u = b->Undo())
				u->mark_base_unsaved();
			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) {
		std::string kept_as;
		if (yes) {
			(void) std::remove(swp.c_str());
		} else {
			// Keep the unreadable journal for inspection, but out of the way:
			// left in place, the new session's records would be appended
			// behind the corrupt data and could never be replayed.
			kept_as = swp + ".corrupt";
			if (std::rename(swp.c_str(), kept_as.c_str()) != 0)
				kept_as.clear();
		}
		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 (!kept_as.empty()) {
			SetStatus("Opened " + req.path + " (unreadable swap kept as " + kept_as + ")");
		} else if (!rerr_s.empty()) {
			SetStatus("Opened " + req.path + " (swap unreadable)");
		} else {
			SetStatus("Opened " + req.path);
		}
		return true;
	}
	return false;
}


bool
Editor::ProcessPendingOpens()
{
	// Opening can throw (bad_alloc on a huge file, filesystem errors). This
	// runs from every frontend's loop, outside command dispatch: report the
	// failure instead of letting it end the editor.
	try {
		// Also the once-per-frame hook for the journal: retry the
		// checkpoint of a journal that lost a record.
		if (kte::SwapManager *sm = Swap())
			sm->RetryGapCheckpoints();
		return process_pending_opens_();
	} catch (const std::exception &e) {
		kte::ErrorHandler::Instance().Error("Editor", std::string("open failed: ") + e.what(), "");
		SetStatus(std::string("Open failed: ") + e.what());
	} catch (...) {
		SetStatus("Open failed");
	}
	return false;
}


bool
Editor::process_pending_opens_()
{
	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;
		// Already open: switch to it. Its swap file is this session's live
		// journal, not something to recover.
		if (const std::size_t open_idx = FindOpenBuffer(req.path); open_idx != static_cast<std::size_t>(-1)) {
			SwitchTo(open_idx);
			apply_pending_line(*this, req.line1);
			SetStatus("Switched to " + Buffers()[open_idx].Filename());
			opened_any = true;
			return opened_any;
		}

		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 && kte::SwapManager::JournalInUse(swp)) {
			// Another running kte is editing this file: its journal is live.
			// Open without recovery and leave the journal alone; this
			// session will not journal the file.
			std::string err;
			if (!OpenFile(req.path, err)) {
				SetStatus(err);
				continue;
			}
			apply_pending_line(*this, req.line1);
			SetStatus(req.path + " is open in another kte; this copy has no crash recovery");
			return true;
		}
		if (swp_exists && !kte::SwapManager::JournalMatchesFile(swp, req.path)) {
			// The file changed (or was removed) after the journal started, so
			// its position-based edits no longer apply.
			pending_recovery_prompt_     = RecoveryPromptKind::DeleteCorruptSwap;
			pending_recovery_open_       = req;
			pending_recovery_swap_path_  = swp;
			pending_recovery_replay_err_ = "stale";
			StartPrompt(PromptKind::Confirm, "Swap", "");
			SetStatus("Swap file for " + req.path +
			          " predates changes to the file on disk and cannot be applied. Delete it? (y/N, C-g cancel)");
			return opened_any;
		}
		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) {
						// Nothing to recover. Remove the journal rather than
						// appending this session's records to it (it may end in a
						// torn record, which would make them unreplayable).
						(void) std::remove(swp.c_str());
					} else {
						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
Editor::SwitchTo(std::size_t index)
{
	auto &bufs = Buffers();
	if (index >= bufs.size()) {
		return false;
	}
	curbuf_ = index;
	// Robustness: ensure a valid highlighter is installed when switching buffers
	Buffer &b = bufs[curbuf_];
	if (b.SyntaxEnabled()) {
		b.EnsureHighlighter();
		if (auto *eng = b.Highlighter()) {
			if (!eng->HasHighlighter()) {
				// Try to set based on existing filetype; fall back to NullHighlighter
				if (!b.Filetype().empty()) {
					auto hl = kte::HighlighterRegistry::CreateFor(b.Filetype());
					if (hl) {
						eng->SetHighlighter(std::move(hl));
					} else {
						eng->SetHighlighter(std::make_unique<kte::NullHighlighter>());
					}
				} else {
					eng->SetHighlighter(std::make_unique<kte::NullHighlighter>());
				}
				eng->InvalidateFrom(0);
			}
		}
	}
	return true;
}


bool
Editor::CloseBuffer(std::size_t index)
{
	auto &bufs = Buffers();
	if (index >= bufs.size()) {
		return false;
	}
	if (Swap()) {
		// Always remove swap file when closing a buffer on normal exit.
		// Swap files are for crash recovery; on clean close, we don't need them.
		// This prevents stale swap files from accumulating (e.g., when used as git editor).
		Swap()->Detach(&bufs[index], true);
		bufs[index].SetSwapRecorder(nullptr);
		// Drain in-flight records before the erase-shift below moves other
		// buffers to new addresses (vector::erase never reallocates, but it does
		// move-assign each trailing buffer into the previous slot).
		Swap()->Flush();
	}
	bufs.erase(bufs.begin() + static_cast<std::ptrdiff_t>(index));
	if (Swap()) {
		// erase() shifts every buffer after `index` down by one slot in-place
		// (no reallocation), so the buffer now at slot i used to live at slot
		// i+1 (same underlying storage, since data() doesn't move on erase).
		for (std::size_t i = index; i < bufs.size(); ++i) {
			Buffer *new_addr = &bufs[i];
			Buffer *old_addr = new_addr + 1;
			bufs[i].SetSwapRecorder(Swap()->Rehome(old_addr, new_addr));
		}
	}
	if (bufs.empty()) {
		curbuf_ = 0;
	} else if (curbuf_ >= bufs.size()) {
		curbuf_ = bufs.size() - 1;
	}
	return true;
}


void
Editor::Reset()
{
	rows_    = cols_ = 0;
	mode_    = 0;
	kill_    = 0;
	no_kill_ = 0;
	dirtyex_ = 0;
	msg_.clear();
	msgtm_                = 0;
	uarg_                 = 0;
	ucount_               = 0;
	repeatable_           = false;
	quit_requested_       = false;
	quit_confirm_pending_ = false;
	// Reset close-confirm/save state
	close_confirm_pending_ = false;
	close_after_save_      = false;
	auto &bufs = Buffers();
	if (Swap()) {
		for (auto &buf : bufs)
			Swap()->Detach(&buf, true);
	}
	bufs.clear();
	curbuf_ = 0;
}


// --- Universal argument helpers ---
void
Editor::UArgStart()
{
	// If not active, start fresh; else multiply by 4 per ke semantics
	if (uarg_ == 0) {
		ucount_ = 0;
	} else {
		if (ucount_ == 0) {
			ucount_ = 1;
		}
		ucount_ = std::min(ucount_ * 4, kMaxUArgCount); // no int overflow
	}
	uarg_ = 1;
	char buf[64];
	std::snprintf(buf, sizeof(buf), "C-u %d", ucount_);
	SetStatus(buf);
}


void
Editor::UArgDigit(int d)
{
	if (d < 0)
		d = 0;
	if (d > 9)
		d = 9;
	if (uarg_ == 0) {
		uarg_   = 1;
		ucount_ = 0;
	}
	ucount_ = (ucount_ > (kMaxUArgCount - d) / 10) ? kMaxUArgCount : ucount_ * 10 + d;
	char buf[64];
	std::snprintf(buf, sizeof(buf), "C-u %d", ucount_);
	SetStatus(buf);
}


void
Editor::UArgClear()
{
	uarg_   = 0;
	ucount_ = 0;
}


int
Editor::UArgGet()
{
	int n = (ucount_ > 0) ? ucount_ : 1;
	UArgClear();
	return n;
}