From 0d097872c2fd45d7f7123db9fd2ab3cf21e43a98 Mon Sep 17 00:00:00 2001
From: VonC <vonc@laposte.net>
Date: Fri, 21 Feb 2020 16:30:47 +0100
Subject: [PATCH] ExitChecker: Exit go-prompt Run() for loop (#161)

---
 option.go |  8 ++++++++
 prompt.go | 17 ++++++++++++++++-
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/option.go b/option.go
index 0352d37..87d95a2 100644
--- a/option.go
+++ b/option.go
@@ -250,6 +250,14 @@ func OptionBreakLineCallback(fn func(*Document)) Option {
 	}
 }
 
+// OptionSetExitCheckerOnInput set an exit function which checks if go-prompt exits its Run loop
+func OptionSetExitCheckerOnInput(fn ExitChecker) Option {
+	return func(p *Prompt) error {
+		p.exitChecker = fn
+		return nil
+	}
+}
+
 // New returns a Prompt with powerful auto-completion.
 func New(executor Executor, completer Completer, opts ...Option) *Prompt {
 	defaultWriter := NewStdoutWriter()
diff --git a/prompt.go b/prompt.go
index dd152ce..00c00ea 100644
--- a/prompt.go
+++ b/prompt.go
@@ -11,6 +11,11 @@ import (
 // Executor is called when user input something text.
 type Executor func(string)
 
+// ExitChecker is called after user input to check if prompt must stop and exit go-prompt Run loop.
+// User input means: selecting/typing an entry, then <return>, and the executor is called.
+// Then, if said entry content matches the ExitChecker function criteria, exit go-prompt (not the overall Go program)
+type ExitChecker func(string) bool
+
 // Completer should return the suggest item from Document.
 type Completer func(Document) []Suggest
 
@@ -26,6 +31,8 @@ type Prompt struct {
 	ASCIICodeBindings []ASCIICodeBind
 	keyBindMode       KeyBindMode
 	completionOnDown  bool
+	exitChecker       ExitChecker
+	skipTearDown      bool
 }
 
 // Exec is the struct contains user input context.
@@ -35,6 +42,7 @@ type Exec struct {
 
 // Run starts prompt.
 func (p *Prompt) Run() {
+	p.skipTearDown = false
 	defer debug.Teardown()
 	debug.Log("start prompt")
 	p.setUp()
@@ -74,8 +82,13 @@ func (p *Prompt) Run() {
 				p.executor(e.input)
 
 				p.completion.Update(*p.buf.Document())
+
 				p.renderer.Render(p.buf, p.completion)
 
+				if p.exitChecker != nil && p.exitChecker(e.input) {
+					p.skipTearDown = true
+					return
+				}
 				// Set raw mode
 				debug.AssertNoError(p.in.Setup())
 				go p.readBuffer(bufCh, stopReadBufCh)
@@ -269,6 +282,8 @@ func (p *Prompt) setUp() {
 }
 
 func (p *Prompt) tearDown() {
-	debug.AssertNoError(p.in.TearDown())
+	if !p.skipTearDown {
+		debug.AssertNoError(p.in.TearDown())
+	}
 	p.renderer.TearDown()
 }