-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add prompt from upstream * fix: add wrapped PromptWithSuggestion * chore: suppress golang-lint since we are using upstream code
- Loading branch information
Showing
2 changed files
with
234 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,226 @@ | ||
| // Copyright (c) The Cryptorium Authors. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package prompt | ||
|
|
||
| import ( | ||
| "fmt" //lint:ignore faillint for prompts it is better than logs. | ||
| "strings" | ||
|
|
||
| "github.com/peterh/liner" | ||
| ) | ||
|
|
||
| // Stdin holds the stdin line reader (also using stdout for printing prompts). | ||
| // Only this reader may be used for input because it keeps an internal buffer. | ||
| var Stdin UserPrompter = newTerminalPrompter() | ||
|
|
||
| // UserPrompter defines the methods needed by the console to prompt the user for | ||
| // various types of inputs. | ||
| type UserPrompter interface { | ||
| // PromptWithSuggestion displays prompt and an editable text with cursor at | ||
| // given position. The cursor will be set to the end of the line if given position | ||
| // is negative or greater than length of text (in runes). Returns a line of user input, not | ||
| // including a trailing newline character. An io.EOF error is returned if the user | ||
| // signals end-of-file by pressing Ctrl-D. | ||
| PromptWithSuggestion(prompt string, text string, pos int) (string, error) | ||
|
|
||
| // PromptInput displays the given prompt to the user and requests some textual | ||
| // data to be entered, returning the input of the user. | ||
| PromptInput(prompt string) (string, error) | ||
|
|
||
| // PromptPassword displays the given prompt to the user and requests some textual | ||
| // data to be entered, but one which must not be echoed out into the terminal. | ||
| // The method returns the input provided by the user. | ||
| PromptPassword(prompt string) (string, error) | ||
|
|
||
| // PromptConfirm displays the given prompt to the user and requests a boolean | ||
| // choice to be made, returning that choice. | ||
| PromptConfirm(prompt string) (bool, error) | ||
|
|
||
| // SetHistory sets the input scrollback history that the prompter will allow | ||
| // the user to scroll back to. | ||
| SetHistory(history []string) | ||
|
|
||
| // AppendHistory appends an entry to the scrollback history. It should be called | ||
| // if and only if the prompt to append was a valid command. | ||
| AppendHistory(command string) | ||
|
|
||
| // ClearHistory clears the entire history. | ||
| ClearHistory() | ||
|
|
||
| // SetWordCompleter sets the completion function that the prompter will call to | ||
| // fetch completion candidates when the user presses tab. | ||
| SetWordCompleter(completer WordCompleter) | ||
| } | ||
|
|
||
| func PromptWithSuggestion(prompt string, text string, pos int) (string, error) { | ||
| return Stdin.PromptWithSuggestion(prompt, text, pos) | ||
| } | ||
|
|
||
| func PromptInput(prompt string) (string, error) { | ||
| return Stdin.PromptInput(prompt) | ||
| } | ||
|
|
||
| func PromptPassword(prompt string) (string, error) { | ||
| return Stdin.PromptPassword(prompt) | ||
| } | ||
|
|
||
| func PromptConfirm(prompt string) (bool, error) { | ||
| return Stdin.PromptConfirm(prompt) | ||
| } | ||
|
|
||
| func SetHistory(history []string) { | ||
| Stdin.SetHistory(history) | ||
| } | ||
|
|
||
| func AppendHistory(command string) { | ||
| Stdin.AppendHistory(command) | ||
| } | ||
|
|
||
| func ClearHistory() { | ||
| Stdin.ClearHistory() | ||
| } | ||
|
|
||
| func SetWordCompleter(completer WordCompleter) { | ||
| Stdin.SetWordCompleter(completer) | ||
| } | ||
|
|
||
| // WordCompleter takes the currently edited line with the cursor position and | ||
| // returns the completion candidates for the partial word to be completed. If | ||
| // the line is "Hello, wo!!!" and the cursor is before the first '!', ("Hello, | ||
| // wo!!!", 9) is passed to the completer which may returns ("Hello, ", {"world", | ||
| // "Word"}, "!!!") to have "Hello, world!!!". | ||
| type WordCompleter func(line string, pos int) (string, []string, string) | ||
|
|
||
| // terminalPrompter is a UserPrompter backed by the liner package. It supports | ||
| // prompting the user for various input, among others for non-echoing password | ||
| // input. | ||
| type terminalPrompter struct { | ||
| *liner.State | ||
| warned bool | ||
| supported bool | ||
| normalMode liner.ModeApplier | ||
| rawMode liner.ModeApplier | ||
| } | ||
|
|
||
| // newTerminalPrompter creates a liner based user input prompter working off the | ||
| // standard input and output streams. | ||
| func newTerminalPrompter() *terminalPrompter { | ||
| p := new(terminalPrompter) | ||
| // Get the original mode before calling NewLiner. | ||
| // This is usually regular "cooked" mode where characters echo. | ||
| normalMode, _ := liner.TerminalMode() | ||
| // Turn on liner. It switches to raw mode. | ||
| p.State = liner.NewLiner() | ||
| rawMode, err := liner.TerminalMode() | ||
| if err != nil || !liner.TerminalSupported() { | ||
| p.supported = false | ||
| } else { | ||
| p.supported = true | ||
| p.normalMode = normalMode | ||
| p.rawMode = rawMode | ||
| // Switch back to normal mode while we're not prompting. | ||
| //nolint:errcheck | ||
| normalMode.ApplyMode() | ||
| } | ||
| p.SetCtrlCAborts(true) | ||
| p.SetTabCompletionStyle(liner.TabPrints) | ||
| p.SetMultiLineMode(true) | ||
| return p | ||
| } | ||
|
|
||
| // PromptWithSuggestion displays prompt and an editable text with cursor at | ||
| // given position. The cursor will be set to the end of the line if given position | ||
| // is negative or greater than length of text (in runes). Returns a line of user input, not | ||
| // including a trailing newline character. An io.EOF error is returned if the user | ||
| // signals end-of-file by pressing Ctrl-D. | ||
| func (p *terminalPrompter) PromptWithSuggestion(prompt string, text string, pos int) (string, error) { | ||
| if p.supported { | ||
| //nolint:errcheck | ||
| p.rawMode.ApplyMode() | ||
| //nolint:errcheck | ||
| defer p.normalMode.ApplyMode() | ||
| } else { | ||
| // liner tries to be smart about printing the prompt | ||
| // and doesn't print anything if input is redirected. | ||
| // Un-smart it by printing the prompt always. | ||
| fmt.Print(prompt) | ||
| prompt = "" | ||
| defer fmt.Println() | ||
| } | ||
| return p.State.PromptWithSuggestion(prompt, text, pos) | ||
| } | ||
|
|
||
| // PromptInput displays the given prompt to the user and requests some textual | ||
| // data to be entered, returning the input of the user. | ||
| func (p *terminalPrompter) PromptInput(prompt string) (string, error) { | ||
| if p.supported { | ||
| //nolint:errcheck | ||
| p.rawMode.ApplyMode() | ||
| //nolint:errcheck | ||
| defer p.normalMode.ApplyMode() | ||
| } else { | ||
| // liner tries to be smart about printing the prompt | ||
| // and doesn't print anything if input is redirected. | ||
| // Un-smart it by printing the prompt always. | ||
| fmt.Print(prompt) | ||
| prompt = "" | ||
| defer fmt.Println() | ||
| } | ||
| return p.State.Prompt(prompt) | ||
| } | ||
|
|
||
| // PromptPassword displays the given prompt to the user and requests some textual | ||
| // data to be entered, but one which must not be echoed out into the terminal. | ||
| // The method returns the input provided by the user. | ||
| func (p *terminalPrompter) PromptPassword(prompt string) (passwd string, err error) { | ||
| if p.supported { | ||
| //nolint:errcheck | ||
| p.rawMode.ApplyMode() | ||
| //nolint:errcheck | ||
| defer p.normalMode.ApplyMode() | ||
| return p.State.PasswordPrompt(prompt) | ||
| } | ||
| if !p.warned { | ||
| fmt.Println("!! Unsupported terminal, password will be echoed.") | ||
| p.warned = true | ||
| } | ||
| // Just as in Prompt, handle printing the prompt here instead of relying on liner. | ||
| fmt.Print(prompt) | ||
| passwd, err = p.State.Prompt("") | ||
| fmt.Println() | ||
| return passwd, err | ||
| } | ||
|
|
||
| // PromptConfirm displays the given prompt to the user and requests a boolean | ||
| // choice to be made, returning that choice. | ||
| func (p *terminalPrompter) PromptConfirm(prompt string) (bool, error) { | ||
| input, err := p.Prompt(prompt + " [y/n] ") | ||
| if len(input) > 0 && strings.EqualFold(input[:1], "y") { | ||
| return true, nil | ||
| } | ||
| return false, err | ||
| } | ||
|
|
||
| // SetHistory sets the input scrollback history that the prompter will allow | ||
| // the user to scroll back to. | ||
| func (p *terminalPrompter) SetHistory(history []string) { | ||
| //nolint:errcheck | ||
| p.State.ReadHistory(strings.NewReader(strings.Join(history, "\n"))) | ||
| } | ||
|
|
||
| // AppendHistory appends an entry to the scrollback history. | ||
| func (p *terminalPrompter) AppendHistory(command string) { | ||
| p.State.AppendHistory(command) | ||
| } | ||
|
|
||
| // ClearHistory clears the entire history. | ||
| func (p *terminalPrompter) ClearHistory() { | ||
| p.State.ClearHistory() | ||
| } | ||
|
|
||
| // SetWordCompleter sets the completion function that the prompter will call to | ||
| // fetch completion candidates when the user presses tab. | ||
| func (p *terminalPrompter) SetWordCompleter(completer WordCompleter) { | ||
| p.State.SetWordCompleter(liner.WordCompleter(completer)) | ||
| } |