fgof-lineedit Public

Notifications Fork 0 Star 0
b82afdd
Branches trunk Tags v0.1.0
1 Branches 1 Tags
Go to file T
Code
mfwolffe Add lineedit history
b82afdd 7 Commits
.github Add lineedit CI
src Add lineedit history
test Test lineedit core
.gitignore Ignore local docs
README.md Test lineedit core
fpm.toml Scaffold lineedit package

fgof-lineedit

CI

Fortran-native line editing helpers for interactive CLI tools.

fgof-lineedit is intended to be a small, standalone library that gives Fortran shells, REPLs, and interactive CLIs a friendlier editing surface than raw terminal reads.

It is part of the FortranGoingOnForty lib-modules catalog, but it is intended to stand on its own as a normal fpm package.

Current v1 target:

  • editable line buffer and cursor model
  • prompt handling and rendered line state
  • history navigation and history storage hooks
  • completion and key-handling integration points
  • clean boundaries with future fgof-termios and fgof-keys

Future scope:

  • richer readline-style editing commands
  • completion engines and menu UIs
  • prompt widgets and multi-line editing

Status

Initial scaffold is in place.

Implemented today:

  • public fgof_lineedit and fgof_lineedit_types modules
  • line editor and prompt-state types
  • prompt constructor, editable buffer core, and cursor movement helpers
  • smoke-test coverage and CI wiring

Still to implement:

  • history and completion hooks
  • terminal integration and redraw behavior

Why Use It

  • line editing is repeatedly hand-built in shells, REPLs, and text tools
  • the Fortran ecosystem still lacks an obvious small default package here
  • it is meant to compose cleanly with fgof-pty, future fgof-termios, and future fgof-keys

Public API Shape

Primary modules:

  • fgof_lineedit
  • fgof_lineedit_types

Public types:

  • lineedit_state
  • prompt_spec

Current public procedures:

  • buffer_length
  • set_buffer
  • insert_text
  • delete_left
  • delete_right
  • default_prompt
  • init_lineedit
  • move_cursor_left
  • move_cursor_right
  • move_cursor_home
  • move_cursor_end
  • reset_lineedit

Quick Start

program demo_lineedit
  use fgof_lineedit, only : default_prompt, init_lineedit, insert_text, lineedit_state, move_cursor_left
  implicit none

  type(lineedit_state) :: editor

  call init_lineedit(editor, default_prompt("> "))
  call insert_text(editor, "help")
  call move_cursor_left(editor)
  print "(A)", editor%buffer
end program demo_lineedit

Build And Test

fpm test

That is the baseline verification command locally and in CI.

Supported Platforms

  • macOS
  • Linux

Boundaries

  • intended to stay independently versioned and releasable
  • focused on editing state and library ergonomics, not full shell implementation
  • terminal-mode control should stay in a future companion package

License

MIT