lock search results

Author: lonnywong

keycodes.go

@@ -27,3 +27,14 @@ var (
 	KeyForward        rune = readline.CharForward
 	KeyForwardDisplay      = "→"
 )
+
+const (
+	// KeyRefresh is the key to refresh the current status
+	KeyRefresh = '\x01'
+
+	// KeyCtrlE is the key to erase the search keywords
+	KeyCtrlE = '\x05'
+
+	// KeySoftEnter is the key to lock the search keywords
+	KeySoftEnter = '\x1e'
+)

list/list.go

@@ -201,6 +201,10 @@ func (l *List) CanPageUp() bool {
 // Index returns the index of the item currently selected inside the searched list. If no item is selected,
 // the NotFound (-1) index is returned.
 func (l *List) Index() int {
+	if l.cursor >= len(l.scope) {
+		return NotFound
+	}
+
 	selected := l.scope[l.cursor]
 
 	for i, item := range l.items {
@@ -235,3 +239,8 @@ func (l *List) Items() ([]interface{}, int) {
 
 	return result, active
 }
+
+// VisibleSize returns the size of the current visible items.
+func (l *List) VisibleSize() int {
+	return len(l.scope)
+}

select.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"strings"
 	"text/tabwriter"
 	"text/template"
 
@@ -18,9 +19,6 @@ import (
 // SelectWithAdd's logic.
 const SelectedAdd = -1
 
-// KeyRefresh indicates to refresh the current status
-const KeyRefresh = '\x01'
-
 // Select represents a list of items used to enable selections, they can be used as search engines, menus
 // or as a list of items in a cli based prompt.
 type Select struct {
@@ -83,6 +81,9 @@ type Select struct {
 
 	Stdin  io.ReadCloser
 	Stdout io.WriteCloser
+
+	// keywords for search
+	keywords string
 }
 
 // SelectKeys defines the available keys used by select mode to enable the user to move around the list
@@ -171,19 +172,27 @@ type SelectTemplates struct {
 	// it shows keys for movement and search.
 	Help string
 
+	// SearchTips is a text/template for displaying search tips while search having results.
+	SearchTips string
+
+	// Keywords is a text/template for the search keywords.
+	Keywords string
+
 	// FuncMap is a map of helper functions that can be used inside of templates according to the text/template
 	// documentation.
 	//
 	// By default, FuncMap contains the color functions used to color the text in templates. If FuncMap
 	// is overridden, the colors functions must be added in the override from promptui.FuncMap to work.
 	FuncMap template.FuncMap
 
-	label    *template.Template
-	active   *template.Template
-	inactive *template.Template
-	selected *template.Template
-	details  *template.Template
-	help     *template.Template
+	label      *template.Template
+	active     *template.Template
+	inactive   *template.Template
+	selected   *template.Template
+	details    *template.Template
+	help       *template.Template
+	searchTips *template.Template
+	keywords   *template.Template
 }
 
 // SearchPrompt is the prompt displayed in search mode.
@@ -225,6 +234,17 @@ func (s *Select) RunCursorAt(cursorPos, scroll int) (int, string, error) {
 	return s.innerRun(cursorPos, scroll, ' ')
 }
 
+func (s *Select) getKeywords(keywords string) string {
+	keywords = strings.Join(strings.Fields(keywords), " ")
+	if keywords == "" {
+		return s.keywords
+	}
+	if s.keywords == "" {
+		return keywords
+	}
+	return s.keywords + " " + keywords
+}
+
 func (s *Select) innerRun(cursorPos, scroll int, top rune) (int, string, error) {
 	c := &readline.Config{
 		Stdin:  s.Stdin,
@@ -275,7 +295,11 @@ func (s *Select) innerRun(cursorPos, scroll int, top rune) (int, string, error)
 			if searchMode {
 				searchMode = false
 				cur.Replace("")
-				s.list.CancelSearch()
+				if s.keywords == "" {
+					s.list.CancelSearch()
+				} else {
+					s.list.Search(s.keywords)
+				}
 			} else {
 				searchMode = true
 			}
@@ -286,31 +310,49 @@ func (s *Select) innerRun(cursorPos, scroll int, top rune) (int, string, error)
 
 			cur.Backspace()
 			if len(cur.Get()) > 0 {
-				s.list.Search(cur.Get())
-			} else {
+				s.list.Search(s.getKeywords(cur.Get()))
+			} else if s.keywords == "" {
 				s.list.CancelSearch()
+			} else {
+				s.list.Search(s.keywords)
 			}
 		case key == s.Keys.PageUp.Code || (key == 'h' && !searchMode):
 			s.list.PageUp()
 		case key == s.Keys.PageDown.Code || (key == 'l' && !searchMode):
 			s.list.PageDown()
 		case key == KeyRefresh:
 			break
+		case canSearch && key == KeyCtrlE && (s.keywords != "" || searchMode):
+			s.keywords = ""
+			searchMode = false
+			cur.Replace("")
+			s.list.CancelSearch()
+		case canSearch && searchMode && key == KeySoftEnter && s.list.VisibleSize() > 0:
+			s.keywords = s.getKeywords(cur.Get())
+			searchMode = false
+			cur.Replace("")
 		default:
 			if canSearch && searchMode {
 				cur.Update(string(line))
-				s.list.Search(cur.Get())
+				s.list.Search(s.getKeywords(cur.Get()))
 			}
 		}
 
 		if searchMode {
 			header := SearchPrompt + cur.Format()
+			if s.list.VisibleSize() > 0 {
+				header += string(render(s.Templates.searchTips, nil))
+			}
 			sb.WriteString(header)
 		} else if !s.HideHelp {
 			help := s.renderHelp(canSearch)
 			sb.Write(help)
 		}
 
+		if s.keywords != "" {
+			sb.Write(render(s.Templates.keywords, s.keywords))
+		}
+
 		label := render(s.Templates.label, s.Label)
 		sb.Write(label)
 
@@ -421,6 +463,17 @@ func (s *Select) GetCurrentIndex() int {
 	return s.list.Index()
 }
 
+// GetVisibleSize returns the size of the current visible items.
+func (s *Select) GetVisibleSize() int {
+	return s.list.VisibleSize()
+}
+
+// GetVisibleItems returns the current visible items.
+func (s *Select) GetVisibleItems() []interface{} {
+	items, _ := s.list.Items()
+	return items
+}
+
 func (s *Select) prepareTemplates() error {
 	tpls := s.Templates
 	if tpls == nil {
@@ -496,6 +549,24 @@ func (s *Select) prepareTemplates() error {
 
 	tpls.help = tpl
 
+	if tpls.SearchTips == "" {
+		tpls.SearchTips = `{{ "     Enter to lock the search results" | faint }}`
+	}
+	tpl, err = template.New("").Funcs(tpls.FuncMap).Parse(tpls.SearchTips)
+	if err != nil {
+		return err
+	}
+	tpls.searchTips = tpl
+
+	if tpls.Keywords == "" {
+		tpls.Keywords = `Keywords: {{ . | blue }} {{ "     Ctrl+E to erase the search keywords" | faint }}`
+	}
+	tpl, err = template.New("").Funcs(tpls.FuncMap).Parse(tpls.Keywords)
+	if err != nil {
+		return err
+	}
+	tpls.keywords = tpl
+
 	s.Templates = tpls
 
 	return nil