fgof-lineedit Public

Notifications Fork 0 Star 0
874e906
Branches trunk Tags v0.1.0
1 Branches 1 Tags
Go to file T
Code
mfwolffe Document word movement
874e906 14 Commits
.github Add lineedit CI
src Add word movement
test Test word movement
.gitignore Ignore local docs
README.md Document word movement
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, action, history, and prompt-state types
  • prompt constructor, editable buffer core, cursor movement helpers, word-wise navigation, history navigation, and action dispatch
  • smoke-test coverage and CI wiring

Still to implement:

  • 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_action
  • lineedit_state
  • prompt_spec
  • history_entry

Action constants:

  • FGOF_LINEEDIT_ACT_NONE
  • FGOF_LINEEDIT_ACT_INSERT
  • FGOF_LINEEDIT_ACT_DELETE_LEFT
  • FGOF_LINEEDIT_ACT_DELETE_RIGHT
  • FGOF_LINEEDIT_ACT_MOVE_LEFT
  • FGOF_LINEEDIT_ACT_MOVE_RIGHT
  • FGOF_LINEEDIT_ACT_MOVE_WORD_LEFT
  • FGOF_LINEEDIT_ACT_MOVE_WORD_RIGHT
  • FGOF_LINEEDIT_ACT_MOVE_HOME
  • FGOF_LINEEDIT_ACT_MOVE_END
  • FGOF_LINEEDIT_ACT_HISTORY_PREVIOUS
  • FGOF_LINEEDIT_ACT_HISTORY_NEXT

Current public procedures:

  • add_history_entry
  • apply_action
  • buffer_length
  • set_buffer
  • insert_text
  • insert_action
  • delete_left
  • delete_right
  • default_prompt
  • history_count
  • history_previous
  • history_next
  • init_lineedit
  • move_cursor_left
  • move_cursor_right
  • move_cursor_word_left
  • move_cursor_word_right
  • move_cursor_home
  • move_cursor_end
  • reset_lineedit
  • simple_action

Quick Start

program demo_lineedit
  use fgof_lineedit, only : &
    FGOF_LINEEDIT_ACT_HISTORY_PREVIOUS, &
    add_history_entry, &
    apply_action, &
    default_prompt, &
    init_lineedit, &
    insert_action, &
    lineedit_state, &
    simple_action
  implicit none

  type(lineedit_state) :: editor

  call init_lineedit(editor, default_prompt("> "))
  call apply_action(editor, insert_action("draft"))
  call add_history_entry(editor, "build")
  call apply_action(editor, simple_action(FGOF_LINEEDIT_ACT_HISTORY_PREVIOUS))
  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