Change the signature of ExecuteOnEnterCallback

CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.1] - 28.07.2023
+
+[Diff](https://github.com/elk-language/go-prompt/compare/v1.1.0...elk-language:go-prompt:v1.1.1)
+
+### Added
+- `func (*prompt.Prompt).TerminalColumns() strings.Width`
+- `func (*prompt.Prompt).TerminalRows() int`
+
+### Changed
+- Change signatures:
+ - `prompt.ExecuteOnEnterCallback`
+ - from `func(buffer *prompt.Buffer, indentSize int) (indent int, execute bool)`
+ - to `func(p *prompt.Prompt, indentSize int) (indent int, execute bool)`
+- Change `(*Prompt).Buffer` from a public field to a public getter method
+
+
 ## [1.1.0] - 28.07.2023
 
 [Diff](https://github.com/elk-language/go-prompt/compare/v1.0.3...elk-language:go-prompt:v1.1.0)

_example/automatic-indenter/main.go

@@ -18,8 +18,8 @@ func main() {
  p.Run()
 }
 
-func ExecuteOnEnter(buffer *prompt.Buffer, indentSize int) (int, bool) {
- input := buffer.Text()
+func ExecuteOnEnter(p *prompt.Prompt, indentSize int) (int, bool) {
+ input := p.Buffer().Text()
  lines := strings.SplitAfter(input, "\n")
  var spaces int
  if len(lines) > 0 {

_example/bang-executor/main.go

@@ -17,8 +17,8 @@ func main() {
  p.Run()
 }
 
-func ExecuteOnEnter(buffer *prompt.Buffer, indentSize int) (int, bool) {
- input := buffer.Text()
+func ExecuteOnEnter(p *prompt.Prompt, indentSize int) (int, bool) {
+ input := p.Buffer().Text()
  char, _ := utf8.DecodeLastRuneInString(input)
  return 0, char == '!'
 }

_example/http-prompt/main.go

@@ -160,6 +160,7 @@ func executor(in string) {
 
 func completer(in prompt.Document) ([]prompt.Suggest, istrings.RuneNumber, istrings.RuneNumber) {
  endIndex := in.CurrentRuneIndex()
+ in.
  w := in.GetWordBeforeCursor()
  if w == "" {
  return []prompt.Suggest{}, 0, 0

constructor.go

@@ -80,7 +80,7 @@ func WithPrefix(prefix string) Option {
 // WithInitialText can be used to set the initial buffer text.
 func WithInitialText(text string) Option {
  return func(p *Prompt) error {
- p.Buffer.InsertTextMoveCursor(text, p.renderer.col, int(p.renderer.row), true)
+ p.buffer.InsertTextMoveCursor(text, p.renderer.col, int(p.renderer.row), true)
  return nil
  }
 }
@@ -286,7 +286,7 @@ func WithExitChecker(fn ExitChecker) Option {
  }
 }
 
-func DefaultExecuteOnEnterCallback(buffer *Buffer, indentSize int) (int, bool) {
+func DefaultExecuteOnEnterCallback(p *Prompt, indentSize int) (int, bool) {
  return 0, true
 }
 
@@ -299,7 +299,7 @@ func New(executor Executor, opts ...Option) *Prompt {
  pt := &Prompt{
  reader: NewStdinReader(),
  renderer: NewRenderer(),
- Buffer: NewBuffer(),
+ buffer: NewBuffer(),
  executor: executor,
  history: NewHistory(),
  completion: NewCompletionManager(6),

emacs.go

@@ -47,7 +47,7 @@ var emacsKeyBindings = []KeyBind{
  Key: ControlE,
  Fn: func(p *Prompt) bool {
  return p.CursorRightRunes(
- istrings.RuneCountInString(p.Buffer.Document().CurrentLineAfterCursor()),
+ istrings.RuneCountInString(p.buffer.Document().CurrentLineAfterCursor()),
  )
  },
  },
@@ -56,16 +56,16 @@ var emacsKeyBindings = []KeyBind{
  Key: ControlA,
  Fn: func(p *Prompt) bool {
  return p.CursorLeftRunes(
- p.Buffer.Document().FindStartOfFirstWordOfLine(),
+ p.buffer.Document().FindStartOfFirstWordOfLine(),
  )
  },
  },
  // Cut the Line after the cursor
  {
  Key: ControlK,
  Fn: func(p *Prompt) bool {
- p.Buffer.DeleteRunes(
- istrings.RuneCountInString(p.Buffer.Document().CurrentLineAfterCursor()),
+ p.buffer.DeleteRunes(
+ istrings.RuneCountInString(p.buffer.Document().CurrentLineAfterCursor()),
  p.renderer.col,
  p.renderer.row,
  )
@@ -76,8 +76,8 @@ var emacsKeyBindings = []KeyBind{
  {
  Key: ControlU,
  Fn: func(p *Prompt) bool {
- p.Buffer.DeleteBeforeCursorRunes(
- istrings.RuneCountInString(p.Buffer.Document().CurrentLineBeforeCursor()),
+ p.buffer.DeleteBeforeCursorRunes(
+ istrings.RuneCountInString(p.buffer.Document().CurrentLineBeforeCursor()),
  p.renderer.col,
  p.renderer.row,
  )
@@ -88,8 +88,8 @@ var emacsKeyBindings = []KeyBind{
  {
  Key: ControlD,
  Fn: func(p *Prompt) bool {
- if p.Buffer.Text() != "" {
- p.Buffer.Delete(1, p.renderer.col, p.renderer.row)
+ if p.buffer.Text() != "" {
+ p.buffer.Delete(1, p.renderer.col, p.renderer.row)
  return true
  }
  return false
@@ -99,7 +99,7 @@ var emacsKeyBindings = []KeyBind{
  {
  Key: ControlH,
  Fn: func(p *Prompt) bool {
- p.Buffer.DeleteBeforeCursor(1, p.renderer.col, p.renderer.row)
+ p.buffer.DeleteBeforeCursor(1, p.renderer.col, p.renderer.row)
  return true
  },
  },
@@ -115,7 +115,7 @@ var emacsKeyBindings = []KeyBind{
  Key: AltRight,
  Fn: func(p *Prompt) bool {
  return p.CursorRightRunes(
- p.Buffer.Document().FindRuneNumberUntilEndOfCurrentWord(),
+ p.buffer.Document().FindRuneNumberUntilEndOfCurrentWord(),
  )
  },
  },
@@ -131,7 +131,7 @@ var emacsKeyBindings = []KeyBind{
  Key: AltLeft,
  Fn: func(p *Prompt) bool {
  return p.CursorLeftRunes(
- p.Buffer.Document().FindRuneNumberUntilStartOfPreviousWord(),
+ p.buffer.Document().FindRuneNumberUntilStartOfPreviousWord(),
  )
  },
  },

emacs_test.go

@@ -8,7 +8,7 @@ import (
 
 func TestEmacsKeyBindings(t *testing.T) {
  p := New(NoopExecutor)
- buf := p.Buffer
+ buf := p.buffer
  buf.InsertTextMoveCursor("abcde", DefColCount, DefRowCount, false)
  if buf.cursorPosition != istrings.RuneNumber(len("abcde")) {
  t.Errorf("Want %d, but got %d", len("abcde"), buf.cursorPosition)

key_bind_func.go

@@ -6,25 +6,25 @@ import (
 
 // GoLineEnd Go to the End of the line
 func GoLineEnd(p *Prompt) bool {
- x := []rune(p.Buffer.Document().TextAfterCursor())
+ x := []rune(p.buffer.Document().TextAfterCursor())
  return p.CursorRightRunes(istrings.RuneNumber(len(x)))
 }
 
 // GoLineBeginning Go to the beginning of the line
 func GoLineBeginning(p *Prompt) bool {
- x := []rune(p.Buffer.Document().TextBeforeCursor())
+ x := []rune(p.buffer.Document().TextBeforeCursor())
  return p.CursorLeftRunes(istrings.RuneNumber(len(x)))
 }
 
 // DeleteChar Delete character under the cursor
 func DeleteChar(p *Prompt) bool {
- p.Buffer.Delete(1, p.renderer.col, p.renderer.row)
+ p.buffer.Delete(1, p.renderer.col, p.renderer.row)
  return true
 }
 
 // DeleteBeforeChar Go to Backspace
 func DeleteBeforeChar(p *Prompt) bool {
- p.Buffer.DeleteBeforeCursor(1, p.renderer.col, p.renderer.row)
+ p.buffer.DeleteBeforeCursor(1, p.renderer.col, p.renderer.row)
  return true
 }
 
@@ -39,8 +39,8 @@ func GoLeftChar(p *Prompt) bool {
 }
 
 func DeleteWordBeforeCursor(p *Prompt) bool {
- p.Buffer.DeleteBeforeCursorRunes(
- istrings.RuneCountInString(p.Buffer.Document().GetWordBeforeCursorWithSpace()),
+ p.buffer.DeleteBeforeCursorRunes(
+ istrings.RuneCountInString(p.buffer.Document().GetWordBeforeCursorWithSpace()),
  p.renderer.col,
  p.renderer.row,
  )