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.
2025-11-30 18:40:44 -08:00
parent e4cd4877cc
commit fb5976f123
7 changed files with 78 additions and 61 deletions
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -33,58 +33,10 @@
    </configurations>
  </component>
  <component name="ChangeListManager">
-    <list default="true" id="e1fe3ab0-3650-4fca-8664-a247d5dfa457" name="Changes" comment="Add horizontal scrolling support and refactor mouse click handling in GUI.&#10;&#10;- Introduce horizontal scrolling with column offset synchronization in GUI.&#10;- Refactor mouse click handling for improved accuracy and viewport alignment.&#10;- Enhance tab expansion and cursor rendering logic for better user experience.&#10;- Replace redundant variable declarations in `Buffer` for cleaner code.">
-      <change afterPath="$PROJECT_DIR$/GUIConfig.cc" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/GUIConfig.h" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.icns" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_128x128.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_128x128@2x.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_16x16.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_16x16@2x.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_256x256.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_256x256@2x.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_32x32.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_32x32@2x.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_512x512.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.iconset/icon_512x512@2x.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/kge.png" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Buffer.cc" beforeDir="false" afterPath="$PROJECT_DIR$/Buffer.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Buffer.h" beforeDir="false" afterPath="$PROJECT_DIR$/Buffer.h" afterDir="false" />
+    <list default="true" id="e1fe3ab0-3650-4fca-8664-a247d5dfa457" name="Changes" comment="Introduce file picker and GUI configuration with enhancements.&#10;&#10;- Add visual file picker for GUI with toggle support.&#10;- Introduce `GUIConfig` class for loading GUI settings from configuration file.&#10;- Refactor window initialization to support dynamic sizing based on configuration.&#10;- Add macOS-specific handling for fullscreen behavior.&#10;- 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$/Command.cc" beforeDir="false" afterPath="$PROJECT_DIR$/Command.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Command.h" beforeDir="false" afterPath="$PROJECT_DIR$/Command.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Editor.cc" beforeDir="false" afterPath="$PROJECT_DIR$/Editor.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Editor.h" beforeDir="false" afterPath="$PROJECT_DIR$/Editor.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Frontend.h" beforeDir="false" afterPath="$PROJECT_DIR$/Frontend.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GUIFrontend.cc" beforeDir="false" afterPath="$PROJECT_DIR$/GUIFrontend.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GUIFrontend.h" beforeDir="false" afterPath="$PROJECT_DIR$/GUIFrontend.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GUIInputHandler.cc" beforeDir="false" afterPath="$PROJECT_DIR$/GUIInputHandler.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GUIInputHandler.h" beforeDir="false" afterPath="$PROJECT_DIR$/GUIInputHandler.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GUIRenderer.cc" beforeDir="false" afterPath="$PROJECT_DIR$/GUIRenderer.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GUIRenderer.h" beforeDir="false" afterPath="$PROJECT_DIR$/GUIRenderer.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GapBuffer.cc" beforeDir="false" afterPath="$PROJECT_DIR$/GapBuffer.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/GapBuffer.h" beforeDir="false" afterPath="$PROJECT_DIR$/GapBuffer.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/InputHandler.h" beforeDir="false" afterPath="$PROJECT_DIR$/InputHandler.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/KKeymap.cc" beforeDir="false" afterPath="$PROJECT_DIR$/KKeymap.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/KKeymap.h" beforeDir="false" afterPath="$PROJECT_DIR$/KKeymap.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/PieceTable.h" beforeDir="false" afterPath="$PROJECT_DIR$/PieceTable.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TerminalFrontend.cc" beforeDir="false" afterPath="$PROJECT_DIR$/TerminalFrontend.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TerminalFrontend.h" beforeDir="false" afterPath="$PROJECT_DIR$/TerminalFrontend.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TerminalInputHandler.cc" beforeDir="false" afterPath="$PROJECT_DIR$/TerminalInputHandler.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TerminalInputHandler.h" beforeDir="false" afterPath="$PROJECT_DIR$/TerminalInputHandler.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TerminalRenderer.cc" beforeDir="false" afterPath="$PROJECT_DIR$/TerminalRenderer.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TestFrontend.cc" beforeDir="false" afterPath="$PROJECT_DIR$/TestFrontend.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TestInputHandler.h" beforeDir="false" afterPath="$PROJECT_DIR$/TestInputHandler.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TestRenderer.cc" beforeDir="false" afterPath="$PROJECT_DIR$/TestRenderer.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/TestRenderer.h" beforeDir="false" afterPath="$PROJECT_DIR$/TestRenderer.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/UndoNode.h" beforeDir="false" afterPath="$PROJECT_DIR$/UndoNode.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/UndoSystem.cc" beforeDir="false" afterPath="$PROJECT_DIR$/UndoSystem.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/UndoSystem.h" beforeDir="false" afterPath="$PROJECT_DIR$/UndoSystem.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/UndoTree.h" beforeDir="false" afterPath="$PROJECT_DIR$/UndoTree.h" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/cmake/Info.plist.in" beforeDir="false" afterPath="$PROJECT_DIR$/cmake/Info.plist.in" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/main.cc" beforeDir="false" afterPath="$PROJECT_DIR$/main.cc" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/test_undo.cc" beforeDir="false" afterPath="$PROJECT_DIR$/test_undo.cc" 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>
    <option name="SHOW_DIALOG" value="false" />
    <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -212,7 +164,7 @@
      <workItem from="1764539556448" duration="156000" />
      <workItem from="1764539725338" duration="1075000" />
      <workItem from="1764542392763" duration="3512000" />
-      <workItem from="1764548345516" duration="7941000" />
+      <workItem from="1764548345516" duration="8203000" />
    </task>
    <task id="LOCAL-00001" summary="Add undo/redo infrastructure and buffer management additions.">
      <option name="closed" value="true" />
@@ -302,7 +254,15 @@
      <option name="project" value="LOCAL" />
      <updated>1764551986561</updated>
    </task>
-    <option name="localTasksCounter" value="12" />
+    <task id="LOCAL-00012" summary="Introduce file picker and GUI configuration with enhancements.&#10;&#10;- Add visual file picker for GUI with toggle support.&#10;- Introduce `GUIConfig` class for loading GUI settings from configuration file.&#10;- Refactor window initialization to support dynamic sizing based on configuration.&#10;- Add macOS-specific handling for fullscreen behavior.&#10;- Improve header inclusion order and minor code cleanup.">
+      <option name="closed" value="true" />
+      <created>1764556512864</created>
+      <option name="number" value="00012" />
+      <option name="presentableId" value="LOCAL-00012" />
+      <option name="project" value="LOCAL" />
+      <updated>1764556512864</updated>
+    </task>
+    <option name="localTasksCounter" value="13" />
    <servers />
  </component>
  <component name="TypeScriptGeneratedFilesManager">
@@ -327,7 +287,8 @@
    <MESSAGE value="Add GUI initialization updates and improve navigation commands.&#10;&#10;- Implement terminal detachment for GUI mode to enable terminal closure post-launch.&#10;- Add `+N` support for opening files at specific line numbers and refine cursor positioning.&#10;- Introduce `JumpToLine` command for direct navigation by line number.&#10;- Enhance mouse wheel handling for line-wise scrolling." />
    <MESSAGE value="Refactor code for consistency and enhanced functionality.&#10;&#10;- Normalize path handling for buffer operations, supporting tilde expansion and absolute paths.&#10;- Introduce `DisplayNameFor` to uniquely resolve buffer display names, minimizing filename clashes.&#10;- Add new commands: `ShowWorkingDirectory` and `ChangeWorkingDirectory`.&#10;- Refine keybindings and enhance existing commands for improved command flow.&#10;- Adjust GUI and terminal renderers to display total line counts alongside filenames.&#10;- Update coding style to align with project guidelines." />
    <MESSAGE value="Add horizontal scrolling support and refactor mouse click handling in GUI.&#10;&#10;- Introduce horizontal scrolling with column offset synchronization in GUI.&#10;- Refactor mouse click handling for improved accuracy and viewport alignment.&#10;- Enhance tab expansion and cursor rendering logic for better user experience.&#10;- Replace redundant variable declarations in `Buffer` for cleaner code." />
-    <option name="LAST_COMMIT_MESSAGE" value="Add horizontal scrolling support and refactor mouse click handling in GUI.&#10;&#10;- Introduce horizontal scrolling with column offset synchronization in GUI.&#10;- Refactor mouse click handling for improved accuracy and viewport alignment.&#10;- Enhance tab expansion and cursor rendering logic for better user experience.&#10;- Replace redundant variable declarations in `Buffer` for cleaner code." />
+    <MESSAGE value="Introduce file picker and GUI configuration with enhancements.&#10;&#10;- Add visual file picker for GUI with toggle support.&#10;- Introduce `GUIConfig` class for loading GUI settings from configuration file.&#10;- Refactor window initialization to support dynamic sizing based on configuration.&#10;- Add macOS-specific handling for fullscreen behavior.&#10;- Improve header inclusion order and minor code cleanup." />
+    <option name="LAST_COMMIT_MESSAGE" value="Introduce file picker and GUI configuration with enhancements.&#10;&#10;- Add visual file picker for GUI with toggle support.&#10;- Introduce `GUIConfig` class for loading GUI settings from configuration file.&#10;- Refactor window initialization to support dynamic sizing based on configuration.&#10;- Add macOS-specific handling for fullscreen behavior.&#10;- Improve header inclusion order and minor code cleanup." />
  </component>
  <component name="XSLT-Support.FileAssociations.UIState">
    <expand />
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -4,7 +4,7 @@ project(kte)
 include(GNUInstallDirs)

 set(CMAKE_CXX_STANDARD 17)
-set(KTE_VERSION "0.9.2")
+set(KTE_VERSION "1.0.0")

 # Default to terminal-only build to avoid SDL/OpenGL dependency by default.
 # Enable with -DBUILD_GUI=ON when SDL2/OpenGL/Freetype are available.
--- a/GUIRenderer.cc
+++ b/GUIRenderer.cc
@@ -312,6 +312,18 @@ GUIRenderer::Draw(Editor &ed)
 			} catch (...) {}
 		}
 		left += "  ";
+		// Insert buffer position prefix "[x/N] " before filename
+		{
+			std::size_t total = ed.BufferCount();
+			if (total > 0) {
+				std::size_t idx1 = ed.CurrentBufferIndex() + 1; // 1-based for display
+				left += "[";
+				left += std::to_string(static_cast<unsigned long long>(idx1));
+				left += "/";
+				left += std::to_string(static_cast<unsigned long long>(total));
+				left += "] ";
+			}
+		}
 		left += fname;
 		if (buf->Dirty())
 			left += " *";
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@ kte — Kyle's Text Editor

 Vision
 -------
-kte will be a small, fast, and understandable text editor with a
-terminal<EFBFBD>first UX and an optional ImGui GUI. It modernizes the
+kte is a small, fast, and understandable text editor with a
+terminal-first UX and an optional ImGui GUI. It modernizes the
 original ke editor while preserving its familiar WordStar/VDE‑style
 command model and Emacs‑influenced ergonomics. The focus is on
 simplicity of design, excellent latency, and pragmatic features you
@@ -80,6 +80,15 @@ Interfaces
 - 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)
 -----------------------

@@ -180,6 +189,15 @@ Run:
 ./cmake-build-debug/kte [files]
 ```

+If you configured the GUI, you can also run the GUI-first target (when
+built as `kge`) or request the GUI from `kte`:
+
+```
+./cmake-build-debug/kte --gui [files]
+# or if built/installed as a separate GUI target
+./cmake-build-debug/kge [files]
+```
+
 GUI build example
 -----------------

--- a/TerminalRenderer.cc
+++ b/TerminalRenderer.cc
@@ -180,6 +180,18 @@ TerminalRenderer::Draw(Editor &ed)
 			fname = "[no name]";
 		}
 		left += "  ";
+		// Insert buffer position prefix "[x/N] " before filename
+		{
+			std::size_t total = ed.BufferCount();
+			if (total > 0) {
+				std::size_t idx1 = ed.CurrentBufferIndex() + 1; // human-friendly 1-based
+				left += "[";
+				left += std::to_string(static_cast<unsigned long long>(idx1));
+				left += "/";
+				left += std::to_string(static_cast<unsigned long long>(total));
+				left += "] ";
+			}
+		}
 		left += fname;
 		if (b && b->Dirty())
 			left += " *";
--- a/docs/kge.1
+++ b/docs/kge.1
@@ -17,8 +17,11 @@ kge \- Kyle's Graphical Editor (GUI-first)
 is the GUI-first build target of Kyle's Text Editor. It shares the same
 editor core and command model as
 .BR kte (1),
-but defaults to the graphical ImGui frontend when available. A terminal
-(ncurses) frontend is also available and can be requested explicitly.
+and defaults to the graphical ImGui frontend when available. A terminal
+(ncurses) frontend is also available and can be requested explicitly with
+.B --term
+or by invoking
+.BR kte (1).

 If one or more
 .I files
@@ -199,6 +202,8 @@ Open using the terminal frontend from kge:
 .BR kte (1),
 .I docs/ke.md
 (project keybinding manual)
+.br
+Project homepage: https://github.com/wntrmute/kte
 .SH BUGS
 Report issues on the project tracker. Some behaviors are inherited from
 ke and may evolve over time; see the manual for notes.
--- a/docs/kte.1
+++ b/docs/kte.1
@@ -16,8 +16,15 @@ kte \- Kyle's Text Editor (terminal-first)
 .B kte
 is a small, fast, and understandable text editor with a terminal-first
 experience. It preserves ke's WordStar/VDE-style command model with
-Emacs-influenced ergonomics. The core uses ncurses in the terminal and can
-optionally run with a GUI frontend if built.
+Emacs-influenced ergonomics. The core uses ncurses in the terminal.
+
+By default, .B kte
+runs in the terminal (ncurses) frontend. If the binary was built with GUI
+support, the same editor core can be shown with an ImGui-based GUI by passing
+.B --gui
+or by invoking the GUI-first target
+.BR kge (1)
+when available.

 If one or more
 .I files
@@ -194,6 +201,8 @@ Force GUI frontend (if available):
 .BR kge (1),
 .I docs/ke.md
 (project keybinding manual)
+.br
+Project homepage: https://github.com/wntrmute/kte
 .SH BUGS
 Incremental search currently restarts from the top on each invocation; see
 \(lqKnown behavior\(rq in the ke manual. Report issues on the project tracker.