Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f8d0e9213f | |||
| 68286ecb7c | |||
| 44807d0f40 | |||
| 41f37478c1 | |||
| d582979eb3 | |||
| 2b194c7910 | |||
| 6498213378 | |||
| 1a37a92534 |
116
.github/workflows/release.yml
vendored
116
.github/workflows/release.yml
vendored
@@ -9,6 +9,9 @@ on:
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
env:
|
||||
BUILD_TYPE: Release
|
||||
|
||||
jobs:
|
||||
homebrew:
|
||||
name: Bump Homebrew formula
|
||||
@@ -34,4 +37,115 @@ jobs:
|
||||
|
||||
Created by https://github.com/mislav/bump-homebrew-formula-action
|
||||
env:
|
||||
COMMITTER_TOKEN: ${{ secrets.GH_CPAT }}
|
||||
COMMITTER_TOKEN: ${{ secrets.GH_CPAT }}
|
||||
linux-build:
|
||||
name: Build Linux ${{ matrix.arch }}
|
||||
runs-on: ${{ matrix.runner }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- arch: amd64
|
||||
runner: ubuntu-latest
|
||||
- arch: arm64
|
||||
runner: ubuntu-24.04-arm64
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install deps
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y build-essential cmake pkg-config \
|
||||
libncurses5-dev libncursesw5-dev \
|
||||
libsdl2-dev libfreetype6-dev mesa-common-dev
|
||||
|
||||
- name: Configure (CMake, GUI ON)
|
||||
run: |
|
||||
cmake -S . -B build -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -DBUILD_GUI=ON
|
||||
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build build --config ${BUILD_TYPE} -j
|
||||
|
||||
- name: Prepare dist
|
||||
run: |
|
||||
mkdir -p dist/linux-${{ matrix.arch }}
|
||||
cp build/kte dist/linux-${{ matrix.arch }}/
|
||||
cp build/kge dist/linux-${{ matrix.arch }}/
|
||||
strip dist/linux-${{ matrix.arch }}/kte || true
|
||||
strip dist/linux-${{ matrix.arch }}/kge || true
|
||||
|
||||
- name: Upload artifact (linux-${{ matrix.arch }})
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: linux-${{ matrix.arch }}
|
||||
path: dist/linux-${{ matrix.arch }}/*
|
||||
|
||||
macos-build:
|
||||
name: Build macOS arm64 (.app)
|
||||
runs-on: macos-14
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install deps (brew)
|
||||
run: |
|
||||
brew update
|
||||
brew install cmake ncurses sdl2 freetype
|
||||
|
||||
- name: Configure (CMake, GUI ON, arm64)
|
||||
run: |
|
||||
cmake -S . -B build -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -DBUILD_GUI=ON -DCMAKE_OSX_ARCHITECTURES=arm64
|
||||
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build build --config ${BUILD_TYPE} -j
|
||||
|
||||
- name: Zip kge.app
|
||||
run: |
|
||||
mkdir -p dist/macos-arm64
|
||||
cd build
|
||||
ditto -c -k --sequesterRsrc --keepParent kge.app ../dist/macos-arm64/kge.app.zip
|
||||
|
||||
- name: Upload artifact (macos-arm64)
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: macos-arm64
|
||||
path: dist/macos-arm64/kge.app.zip
|
||||
|
||||
release:
|
||||
name: Create GitHub Release
|
||||
needs: [ linux-build, macos-build ]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: dist
|
||||
|
||||
- name: Reshape artifact layout
|
||||
run: |
|
||||
ls -R dist
|
||||
# Actions download-artifact places each named artifact in a subfolder
|
||||
# Move into the expected dist structure for GoReleaser
|
||||
mkdir -p dist/linux-amd64 dist/linux-arm64 dist/macos-arm64
|
||||
if [ -d dist/linux-amd64/linux-amd64 ]; then mv dist/linux-amd64/linux-amd64/* dist/linux-amd64/; fi
|
||||
if [ -d dist/linux-arm64/linux-arm64 ]; then mv dist/linux-arm64/linux-arm64/* dist/linux-arm64/; fi
|
||||
if [ -d dist/macos-arm64/macos-arm64 ]; then mv dist/macos-arm64/macos-arm64/* dist/macos-arm64/; fi
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.22.x'
|
||||
|
||||
- name: Run GoReleaser
|
||||
uses: goreleaser/goreleaser-action@v6
|
||||
with:
|
||||
version: latest
|
||||
args: release --clean --config .goreleaser.yaml
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GH_CPAT }}
|
||||
|
||||
69
.goreleaser.yaml
Normal file
69
.goreleaser.yaml
Normal file
@@ -0,0 +1,69 @@
|
||||
# GoReleaser configuration for kte/kge (C++ project)
|
||||
# We use GoReleaser only for releasing: changelog, checksums, and uploading
|
||||
# prebuilt artifacts that are produced by the CI workflow.
|
||||
|
||||
version: 2
|
||||
|
||||
project_name: kte
|
||||
|
||||
before:
|
||||
hooks:
|
||||
# No build here; artifacts are produced by the CI jobs and placed into dist/
|
||||
- echo "GoReleaser: using prebuilt artifacts from dist/"
|
||||
|
||||
builds:
|
||||
# No Go builds; this is a C++ project.
|
||||
- id: noop
|
||||
skip: true
|
||||
|
||||
checksum:
|
||||
name_template: "checksums.txt"
|
||||
algorithm: sha256
|
||||
|
||||
release:
|
||||
# Rely on GITHUB_TOKEN from the workflow.
|
||||
draft: false
|
||||
prerelease: auto
|
||||
mode: replace
|
||||
footer: |
|
||||
Built with CMake. See README for platform dependencies.
|
||||
extra_files:
|
||||
# Linux binaries (amd64, arm64)
|
||||
- glob: dist/linux-amd64/kte
|
||||
- glob: dist/linux-amd64/kge
|
||||
- glob: dist/linux-arm64/kte
|
||||
- glob: dist/linux-arm64/kge
|
||||
# macOS Apple Silicon app bundle (zipped)
|
||||
- glob: dist/macos-arm64/kge.app.zip
|
||||
|
||||
changelog:
|
||||
sort: asc
|
||||
use: github
|
||||
filters:
|
||||
exclude:
|
||||
- '^docs: '
|
||||
- '^chore: '
|
||||
- '^ci: '
|
||||
|
||||
announce:
|
||||
skip: true
|
||||
|
||||
signs:
|
||||
# No signing by default.
|
||||
- artifacts: none
|
||||
|
||||
archives:
|
||||
# We are uploading raw binaries / zip created by CI, so no archives here.
|
||||
- id: none
|
||||
formats: [binary]
|
||||
builds: [noop]
|
||||
|
||||
blobs: []
|
||||
|
||||
brews: []
|
||||
|
||||
snapcrafts: []
|
||||
|
||||
nfpm: []
|
||||
|
||||
publishers: []
|
||||
37
.idea/workspace.xml
generated
37
.idea/workspace.xml
generated
@@ -33,10 +33,9 @@
|
||||
</configurations>
|
||||
</component>
|
||||
<component name="ChangeListManager">
|
||||
<list default="true" id="e1fe3ab0-3650-4fca-8664-a247d5dfa457" name="Changes" comment="Introduce file picker and GUI configuration with enhancements. - Add visual file picker for GUI with toggle support. - Introduce `GUIConfig` class for loading GUI settings from configuration file. - Refactor window initialization to support dynamic sizing based on configuration. - Add macOS-specific handling for fullscreen behavior. - Improve header inclusion order and minor code cleanup.">
|
||||
<change beforePath="$PROJECT_DIR$/CMakeLists.txt" beforeDir="false" afterPath="$PROJECT_DIR$/CMakeLists.txt" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/kte.1" beforeDir="false" afterPath="$PROJECT_DIR$/docs/kte.1" afterDir="false" />
|
||||
<list default="true" id="e1fe3ab0-3650-4fca-8664-a247d5dfa457" name="Changes" comment="Actually add the screenshot.">
|
||||
<change beforePath="$PROJECT_DIR$/.github/workflows/release.yml" beforeDir="false" afterPath="$PROJECT_DIR$/.github/workflows/release.yml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
|
||||
</list>
|
||||
<option name="SHOW_DIALOG" value="false" />
|
||||
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
||||
@@ -51,6 +50,12 @@
|
||||
<option name="myRunOnSave" value="true" />
|
||||
</component>
|
||||
<component name="Git.Settings">
|
||||
<option name="PUSH_TAGS">
|
||||
<GitPushTagMode>
|
||||
<option name="argument" value="--tags" />
|
||||
<option name="title" value="All" />
|
||||
</GitPushTagMode>
|
||||
</option>
|
||||
<option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
|
||||
<option name="UPDATE_TYPE" value="REBASE" />
|
||||
</component>
|
||||
@@ -164,7 +169,7 @@
|
||||
<workItem from="1764539556448" duration="156000" />
|
||||
<workItem from="1764539725338" duration="1075000" />
|
||||
<workItem from="1764542392763" duration="3512000" />
|
||||
<workItem from="1764548345516" duration="8203000" />
|
||||
<workItem from="1764548345516" duration="9962000" />
|
||||
</task>
|
||||
<task id="LOCAL-00001" summary="Add undo/redo infrastructure and buffer management additions.">
|
||||
<option name="closed" value="true" />
|
||||
@@ -262,7 +267,23 @@
|
||||
<option name="project" value="LOCAL" />
|
||||
<updated>1764556512864</updated>
|
||||
</task>
|
||||
<option name="localTasksCounter" value="13" />
|
||||
<task id="LOCAL-00013" summary="Add buffer position display and documentation improvements. - Display buffer position prefix "[x/N]" in GUI and terminal renderers. - Improve `kte` and `kge` man pages with frontend usage details and project homepage. - Update README with GUI invocation instructions. - Bump version to 1.0.0.">
|
||||
<option name="closed" value="true" />
|
||||
<created>1764556854788</created>
|
||||
<option name="number" value="00013" />
|
||||
<option name="presentableId" value="LOCAL-00013" />
|
||||
<option name="project" value="LOCAL" />
|
||||
<updated>1764556854788</updated>
|
||||
</task>
|
||||
<task id="LOCAL-00014" summary="Actually add the screenshot.">
|
||||
<option name="closed" value="true" />
|
||||
<created>1764557759844</created>
|
||||
<option name="number" value="00014" />
|
||||
<option name="presentableId" value="LOCAL-00014" />
|
||||
<option name="project" value="LOCAL" />
|
||||
<updated>1764557759844</updated>
|
||||
</task>
|
||||
<option name="localTasksCounter" value="15" />
|
||||
<servers />
|
||||
</component>
|
||||
<component name="TypeScriptGeneratedFilesManager">
|
||||
@@ -288,7 +309,9 @@
|
||||
<MESSAGE value="Refactor code for consistency and enhanced functionality. - Normalize path handling for buffer operations, supporting tilde expansion and absolute paths. - Introduce `DisplayNameFor` to uniquely resolve buffer display names, minimizing filename clashes. - Add new commands: `ShowWorkingDirectory` and `ChangeWorkingDirectory`. - Refine keybindings and enhance existing commands for improved command flow. - Adjust GUI and terminal renderers to display total line counts alongside filenames. - Update coding style to align with project guidelines." />
|
||||
<MESSAGE value="Add horizontal scrolling support and refactor mouse click handling in GUI. - Introduce horizontal scrolling with column offset synchronization in GUI. - Refactor mouse click handling for improved accuracy and viewport alignment. - Enhance tab expansion and cursor rendering logic for better user experience. - Replace redundant variable declarations in `Buffer` for cleaner code." />
|
||||
<MESSAGE value="Introduce file picker and GUI configuration with enhancements. - Add visual file picker for GUI with toggle support. - Introduce `GUIConfig` class for loading GUI settings from configuration file. - Refactor window initialization to support dynamic sizing based on configuration. - Add macOS-specific handling for fullscreen behavior. - Improve header inclusion order and minor code cleanup." />
|
||||
<option name="LAST_COMMIT_MESSAGE" value="Introduce file picker and GUI configuration with enhancements. - Add visual file picker for GUI with toggle support. - Introduce `GUIConfig` class for loading GUI settings from configuration file. - Refactor window initialization to support dynamic sizing based on configuration. - Add macOS-specific handling for fullscreen behavior. - Improve header inclusion order and minor code cleanup." />
|
||||
<MESSAGE value="Add buffer position display and documentation improvements. - Display buffer position prefix "[x/N]" in GUI and terminal renderers. - Improve `kte` and `kge` man pages with frontend usage details and project homepage. - Update README with GUI invocation instructions. - Bump version to 1.0.0." />
|
||||
<MESSAGE value="Actually add the screenshot." />
|
||||
<option name="LAST_COMMIT_MESSAGE" value="Actually add the screenshot." />
|
||||
</component>
|
||||
<component name="XSLT-Support.FileAssociations.UIState">
|
||||
<expand />
|
||||
|
||||
1
Buffer.h
1
Buffer.h
@@ -5,6 +5,7 @@
|
||||
#define KTE_BUFFER_H
|
||||
|
||||
#include <cstddef>
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
#include <string_view>
|
||||
|
||||
@@ -4,7 +4,7 @@ project(kte)
|
||||
include(GNUInstallDirs)
|
||||
|
||||
set(CMAKE_CXX_STANDARD 17)
|
||||
set(KTE_VERSION "1.0.0")
|
||||
set(KTE_VERSION "1.0.2")
|
||||
|
||||
# Default to terminal-only build to avoid SDL/OpenGL dependency by default.
|
||||
# Enable with -DBUILD_GUI=ON when SDL2/OpenGL/Freetype are available.
|
||||
@@ -180,9 +180,20 @@ if (${BUILD_GUI})
|
||||
MACOSX_BUNDLE_ICON_FILE ${MACOSX_BUNDLE_ICON_FILE}
|
||||
MACOSX_BUNDLE_INFO_PLIST "${CMAKE_CURRENT_BINARY_DIR}/kge-Info.plist")
|
||||
|
||||
add_dependencies(kge kte)
|
||||
add_custom_command(TARGET kge POST_BUILD
|
||||
COMMAND ${CMAKE_COMMAND} -E copy
|
||||
$<TARGET_FILE:kte>
|
||||
$<TARGET_FILE_DIR:kge>/kte
|
||||
COMMENT "Copying kte binary into kge.app bundle")
|
||||
|
||||
install(TARGETS kge
|
||||
BUNDLE DESTINATION .
|
||||
)
|
||||
|
||||
install(TARGETS kte
|
||||
RUNTIME DESTINATION kge.app/Contents/MacOS
|
||||
)
|
||||
else ()
|
||||
install(TARGETS kge
|
||||
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
|
||||
@@ -190,4 +201,5 @@ if (${BUILD_GUI})
|
||||
endif ()
|
||||
# Install kge man page only when GUI is built
|
||||
install(FILES docs/kge.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
|
||||
install(FILES kge.png DESTINATION ${CMAKE_INSTALL_PREFIX}/share/icons)
|
||||
endif ()
|
||||
|
||||
161
README.md
161
README.md
@@ -1,4 +1,6 @@
|
||||
kte — Kyle's Text Editor
|
||||
kte - Kyle's Text Editor
|
||||
|
||||

|
||||
|
||||
Vision
|
||||
-------
|
||||
@@ -11,7 +13,9 @@ can learn and keep in your head.
|
||||
|
||||
I am experimenting with using Jetbrains Junie to assist in
|
||||
development, largely as a way to learn the effective use of agentic
|
||||
coding.
|
||||
coding. I worked with the agent by feeding it notes that I've been
|
||||
taking about text editors for the last few years, as well as the
|
||||
sources from the original ke editor that is all handwritten C.
|
||||
|
||||
Project Goals
|
||||
-------------
|
||||
@@ -26,98 +30,6 @@ Project Goals
|
||||
so a GUI can grow independently of the TUI.
|
||||
- Minimize dependencies; the GUI layer remains optional and isolated.
|
||||
|
||||
User Experience (intended)
|
||||
--------------------------
|
||||
|
||||
- Terminal first: instant startup, responsive editing, no surprises
|
||||
over SSH.
|
||||
- Optional GUI: an ImGui‑based window with tabs, menus, and
|
||||
palette—sharing the same editor core and command model.
|
||||
- Discoverable command model: WordStar/VDE style with a `C-k` prefix,
|
||||
Emacs‑like incremental search, and context help.
|
||||
- Sensible defaults with a simple config file for remaps and theme
|
||||
selection.
|
||||
- Respect the file system: no magic project files; autosave and
|
||||
crash‑recovery journals are opt‑in and visible.
|
||||
|
||||
Core Features (roadmapped)
|
||||
--------------------------
|
||||
|
||||
- Buffers and windows
|
||||
- Multiple file buffers; fast switching, closing, and reopening.
|
||||
- Split views (horizontal/vertical) in TUI and tiled panels in
|
||||
GUI.
|
||||
- Editing primitives
|
||||
- Gap buffer (primary) with an alternative piece table for
|
||||
large‑edit scenarios.
|
||||
- Kill/yank ring, word/sentence/paragraph motions, and rectangle
|
||||
ops.
|
||||
- Undo/redo with grouped edits and time‑travel scrubbing.
|
||||
- Search and replace
|
||||
- Incremental search (C-s) and regex search (C-r) with live
|
||||
highlighting.
|
||||
- Multi‑file grep with a quickfix list; replace with confirm.
|
||||
- Files and projects
|
||||
- Robust encoding/line‑ending detection; safe writes (atomic where
|
||||
possible).
|
||||
- File tree sidebar (GUI) and quick‑open palette.
|
||||
- Lightweight session restore.
|
||||
- Language niceties (opt‑in, no runtime servers required)
|
||||
- Syntax highlighting via fast, table‑driven lexers.
|
||||
- Basic indentation rules per language; trailing whitespace/EOF
|
||||
newline helpers.
|
||||
- Extensibility (later)
|
||||
- Command palette actions backed by the core command model.
|
||||
- Small C++ plugin ABI and a scripting shim for config‑time
|
||||
customization.
|
||||
|
||||
Interfaces
|
||||
----------
|
||||
|
||||
- CLI: the primary interface. `kte [files]` starts in the terminal,
|
||||
adopting your `$TERM` capabilities. Terminal mode is implemented
|
||||
using ncurses.
|
||||
- GUI: an optional ImGui‑based frontend that embeds the same editor
|
||||
core.
|
||||
|
||||
Man pages
|
||||
---------
|
||||
|
||||
- Terminal editor: `docs/kte.1` (view locally with `man -l docs/kte.1`)
|
||||
- GUI frontend: `docs/kge.1` (view locally with `man -l docs/kge.1`)
|
||||
|
||||
The `ke` keybinding reference remains the canonical source for
|
||||
commands while kte evolves: see `docs/ke.md`.
|
||||
|
||||
Architecture (intended)
|
||||
-----------------------
|
||||
|
||||
- Core model
|
||||
- Buffer: file I/O, cursor/mark, viewport state, and edit
|
||||
operations.
|
||||
- GapBuffer: fast in‑memory text structure for typical edits.
|
||||
- PieceTable: alternative representation for heavy insert/delete
|
||||
workflows.
|
||||
- Controller layer
|
||||
- InputHandler interface with `TerminalInputHandler` and
|
||||
`GUIInputHandler` implementations.
|
||||
- Command: normalized operations (save, kill, yank, move, search,
|
||||
etc.).
|
||||
- View layer
|
||||
- Renderer interface with `TerminalRenderer` and `GUIRenderer`
|
||||
implementations.
|
||||
- Editor: top‑level state managing buffers, messaging, and global
|
||||
flags.
|
||||
|
||||
Performance and Reliability Targets
|
||||
-----------------------------------
|
||||
|
||||
- Sub‑millisecond keystroke to screen update on typical files in TUI.
|
||||
- Sustain fluid editing on multi‑megabyte files; graceful degradation
|
||||
on very large files.
|
||||
- Atomic/safe writes; autosave and crash‑recovery journals are
|
||||
explicit and transparent.
|
||||
|
||||
Keybindings
|
||||
-----------
|
||||
kte maintains ke’s command model while internals evolve. Highlights (subject to refinement):
|
||||
@@ -146,26 +58,26 @@ Dependencies by platform
|
||||
------------------------
|
||||
|
||||
- macOS (Homebrew)
|
||||
- Terminal (default):
|
||||
- `brew install ncurses`
|
||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||
- `brew install sdl2 freetype`
|
||||
- OpenGL is provided by the system framework on macOS; no package needed.
|
||||
- Terminal (default):
|
||||
- `brew install ncurses`
|
||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||
- `brew install sdl2 freetype`
|
||||
- OpenGL is provided by the system framework on macOS; no package needed.
|
||||
|
||||
- Debian/Ubuntu
|
||||
- Terminal (default):
|
||||
- `sudo apt-get install -y libncurses5-dev libncursesw5-dev`
|
||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||
- `sudo apt-get install -y libsdl2-dev libfreetype6-dev mesa-common-dev`
|
||||
- The `mesa-common-dev` package provides OpenGL headers/libs (`libGL`).
|
||||
- Terminal (default):
|
||||
- `sudo apt-get install -y libncurses5-dev libncursesw5-dev`
|
||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||
- `sudo apt-get install -y libsdl2-dev libfreetype6-dev mesa-common-dev`
|
||||
- The `mesa-common-dev` package provides OpenGL headers/libs (`libGL`).
|
||||
|
||||
- NixOS/Nix
|
||||
- Terminal (default):
|
||||
- Ad-hoc shell: `nix-shell -p cmake gcc ncurses`
|
||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||
- Ad-hoc shell: `nix-shell -p cmake gcc ncurses SDL2 freetype libGL`
|
||||
- With flakes/devshell (example `flake.nix` inputs not provided): include
|
||||
`ncurses` for TUI, and `SDL2`, `freetype`, `libGL` for GUI in your devShell.
|
||||
- Terminal (default):
|
||||
- Ad-hoc shell: `nix-shell -p cmake gcc ncurses`
|
||||
- Optional GUI (enable with `-DBUILD_GUI=ON`):
|
||||
- Ad-hoc shell: `nix-shell -p cmake gcc ncurses SDL2 freetype libGL`
|
||||
- With flakes/devshell (example `flake.nix` inputs not provided): include
|
||||
`ncurses` for TUI, and `SDL2`, `freetype`, `libGL` for GUI in your devShell.
|
||||
|
||||
Notes
|
||||
-----
|
||||
@@ -212,30 +124,5 @@ cmake --build cmake-build-debug
|
||||
Status
|
||||
------
|
||||
|
||||
- The project is under active evolution toward the above architecture
|
||||
and UX. The terminal interface now uses ncurses for input and
|
||||
rendering. GUI work will follow as a thin, optional layer. ke
|
||||
compatibility remains a primary constraint while internals modernize.
|
||||
|
||||
Roadmap (high level)
|
||||
--------------------
|
||||
|
||||
1. Solidify core buffer model (gap buffer), file I/O, and
|
||||
ke‑compatible commands.
|
||||
2. Introduce structured undo/redo and search/replace with
|
||||
highlighting.
|
||||
3. Stabilize terminal renderer and input handling across common
|
||||
terminals. (initial ncurses implementation landed)
|
||||
4. Add piece table as an alternative backend with runtime selection
|
||||
per buffer.
|
||||
5. Optional GUI frontend using ImGui; shared command palette.
|
||||
6. Language niceties (syntax highlighting, indentation rules) behind a
|
||||
zero‑deps, fast path.
|
||||
7. Session restore, autosave/journaling, and safe write guarantees.
|
||||
8. Extensibility hooks with a small, stable API.
|
||||
References
|
||||
----------
|
||||
|
||||
- [ke](https://git.wntrmute.dev/kyle/ke) manual and keybinding
|
||||
reference: `ke.md`
|
||||
- Inspirations: Antirez’ kilo, WordStar/VDE, Emacs, and `mg(1)`
|
||||
- This project is a hobby text editor meant to be my personal editor. I
|
||||
do not warrant its suitability for anyone else.
|
||||
|
||||
124
ROADMAP.md
124
ROADMAP.md
@@ -1,116 +1,10 @@
|
||||
kte ROADMAP — from skeleton to a working editor
|
||||
ROADMAP / TODO:
|
||||
|
||||
Scope for “working editor” v0.1
|
||||
|
||||
- Runs in a terminal; opens files passed on the CLI or an empty buffer.
|
||||
- Basic navigation, insert/delete, newline handling.
|
||||
- Status line and message area; shows filename, dirty flag, cursor position.
|
||||
- Save file(s) to disk safely; quit/confirm on dirty buffers.
|
||||
- Core ke key chords: C-g (cancel), C-k s/x/q/C-q, C-l, basic arrows, Enter/Backspace, C-s (simple find).
|
||||
|
||||
Guiding principles
|
||||
|
||||
- Keep the core small and understandable; evolve incrementally.
|
||||
- Separate model (Buffer/Editor), control (Input/Command), and view (Renderer).
|
||||
- Favor terminal first; GUI hooks arrive later behind interfaces.
|
||||
|
||||
✓ Milestone 0 — Wire up a minimal app shell
|
||||
|
||||
1. main.cpp
|
||||
- Replace demo printing with real startup using `Editor`.
|
||||
- Parse CLI args; open each path into a buffer (create empty if none). ✓ when `kte file1 file2` loads buffers and
|
||||
exits cleanly.
|
||||
2. Editor integration
|
||||
- Ensure `Editor` can open/switch/close buffers and hold status messages.
|
||||
- Add a temporary “headless loop” to prove open/save calls work.
|
||||
|
||||
✓ Milestone 1 — Command model
|
||||
|
||||
1. Command vocabulary
|
||||
- Flesh out `Command.h/.cpp`: enums/struct for operations and data (e.g., InsertChar, MoveCursor, Save, Quit,
|
||||
FindNext, etc.).
|
||||
- Provide a dispatcher entry point callable from the input layer to mutate `Editor`/`Buffer`.
|
||||
- Definition of done: commands exist for minimal edit/navigation/save/quit; no rendering yet.
|
||||
|
||||
✓ Milestone 2 — Terminal input
|
||||
|
||||
1. Input interfaces
|
||||
- Add `InputHandler.h` interface plus `TerminalInputHandler` implementation.
|
||||
- Terminal input via ncurses (`getch`, `keypad`, non‑blocking with `nodelay`), basic key decoding (arrows, Ctrl, ESC
|
||||
sequences).
|
||||
2. Keymap
|
||||
- Map ke chords to `Command` (C-k prefix handling, C-g cancel, C-l refresh, C-k s/x/q/C-q, C-s find start, text
|
||||
input → InsertChar).
|
||||
3. Event loop
|
||||
- Introduce the core loop in main: read key → translate to `Command` → dispatch → trigger render.
|
||||
|
||||
✓ Milestone 3 — Terminal renderer
|
||||
|
||||
1. View interfaces
|
||||
- Add `Renderer.h` with `TerminalRenderer` implementation (ncurses‑based).
|
||||
2. Minimal draw
|
||||
- Render viewport lines from current buffer; draw status bar (filename, dirty, row:col, message).
|
||||
- Handle scrolling when cursor moves past edges; support window resize (SIGWINCH).
|
||||
3. Cursor
|
||||
- Place terminal cursor at logical buffer location (account for tabs later; start with plain text).
|
||||
|
||||
Milestone 4 — Buffer fundamentals to support editing
|
||||
|
||||
1. GapBuffer
|
||||
- Ensure `GapBuffer` supports insert char, backspace, delete, newline, and efficient cursor moves.
|
||||
2. Buffer API
|
||||
- File I/O (open/save), dirty tracking, encoding/line ending kept simple (UTF‑8, LF) for v0.1.
|
||||
- Cursor state, mark (optional later), and viewport bookkeeping.
|
||||
3. Basic motions
|
||||
- Left/Right/Up/Down, Home/End, PageUp/PageDown; word f/b (optional in v0.1).
|
||||
|
||||
Milestone 5 — Core editing loop complete
|
||||
|
||||
1. Tighten loop timing
|
||||
- Ensure keystroke→update→render latency is reliably low; avoid unnecessary redraws.
|
||||
2. Status/messages
|
||||
- `Editor::SetStatus()` shows transient messages; C-l forces full refresh.
|
||||
3. Prompts
|
||||
- Minimal prompt line for save‑as/confirm quit; blocking read in prompt mode is acceptable for v0.1.
|
||||
|
||||
Milestone 6 — Search (minimal)
|
||||
|
||||
1. Incremental search (C-s)
|
||||
- Simple forward substring search with live highlight of current match; arrow keys navigate matches while in search
|
||||
mode (ke‑style quirk acceptable).
|
||||
- ESC/C-g exits search; Enter confirms and leaves cursor on match.
|
||||
|
||||
Milestone 7 — Safety and polish for v0.1
|
||||
|
||||
1. Safe writes
|
||||
- Write to temp file then rename; preserve permissions where possible.
|
||||
2. Dirty/quit logic
|
||||
- Confirm on quit when any buffer is dirty; `C-k C-q` bypasses confirmation.
|
||||
3. Resize/terminal quirks
|
||||
- Handle small terminals gracefully; no crashes on narrow widths.
|
||||
4. Basic tests
|
||||
- Unit tests for `GapBuffer`, Buffer open/save round‑trip, and command mapping.
|
||||
|
||||
Out of scope for v0.1 (tracked, not blocking)
|
||||
|
||||
- Undo/redo, regex search, kill ring, word motions, tabs/render width, syntax highlighting, piece table selection, GUI.
|
||||
|
||||
Implementation notes (files to add)
|
||||
|
||||
- Input: `InputHandler.h`, `TerminalInputHandler.cc/h` (ncurses).
|
||||
- Rendering: `Renderer.h`, `TerminalRenderer.cc/h` (ncurses).
|
||||
- Prompt helpers: minimal utility for line input in raw mode.
|
||||
- Platform: small termios wrapper; SIGWINCH handler.
|
||||
|
||||
Acceptance checklist for v0.1
|
||||
|
||||
- Start: `./kte [files]` opens files or an empty buffer.
|
||||
- Edit: insert text, backspace, newlines; move cursor; content scrolls.
|
||||
- Save: `C-k s` writes file atomically; dirty flag clears; status shows bytes written.
|
||||
- Quit: `C-k q` confirms if dirty; `C-k C-q` exits without confirm; `C-k x` save+exit.
|
||||
- Refresh: `C-l` redraws.
|
||||
- Search: `C-s` finds next while typing; ESC cancels.
|
||||
|
||||
Next concrete step
|
||||
|
||||
- Stabilize cursor placement and scrolling logic; add resize handling and begin minimal prompt for save‑as.
|
||||
- [ ] Search + Replace
|
||||
- [ ] Regex search + replace
|
||||
- [ ] The undo system should actually work
|
||||
- [ ] Able to mark buffers as read-only
|
||||
- [ ] Built-in help text
|
||||
- [ ] Shorten paths in the homedir with ~
|
||||
- [ ] When the filename is longer than the message window, scoot left to
|
||||
to keep it in view
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
#ifndef KTE_UNDONODE_H
|
||||
#define KTE_UNDONODE_H
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
|
||||
enum class UndoType : uint8_t {
|
||||
enum class UndoType : std::uint8_t {
|
||||
Insert,
|
||||
Delete,
|
||||
Paste,
|
||||
|
||||
BIN
docs/screenshot.jpg
Normal file
BIN
docs/screenshot.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 196 KiB |
Reference in New Issue
Block a user