Add multi-select mode (#166)

Adds a new usage mode: multi-select.

Enter multi-select mode by pressing tab, do selections and then press
tab again to exit and run action.

In multi-select mode,

- Pressing labels will select them, but not exit yet.
- Pressing labels for selected matches will deselect them.
- Pressing Tab or Enter will accept selections.

On accept, the selected matches will be joined together
with spaces between them and the action will be run
as usual.

---------

Co-authored-by: Abhinav Gupta <mail@abhinavg.net>

Author: hansmansson

app.go

@@ -181,6 +181,8 @@ func (c *ctrl) Init() {
 			SkippedMatch:   base.Foreground(tcell.ColorGray),
 			HintLabel:      base.Foreground(tcell.ColorRed),
 			HintLabelInput: base.Foreground(tcell.ColorYellow),
+			SelectedMatch:  base.Foreground(tcell.ColorYellow),
+			DeselectLabel:  base.Foreground(tcell.ColorDarkRed),
 		},
 	}).Build()
 

integration/integration_test.go

@@ -361,6 +361,87 @@ func TestIntegration_ActionEnv(t *testing.T) {
 		"action pane ID does not match")
 }
 
+func TestIntegration_MultiSelect(t *testing.T) {
+	t.Parallel()
+
+	env := (&fakeEnvConfig{
+		Action: "json-report",
+	}).Build(t)
+
+	testFile := filepath.Join(env.Root, "give.txt")
+	require.NoError(t,
+		os.WriteFile(testFile, []byte(_giveText), 0o644),
+		"write test file")
+
+	tmux := (&virtualTmuxConfig{
+		Tmux:   env.Tmux,
+		Width:  80,
+		Height: 40,
+		Env:    env.Environ(),
+	}).Build(t)
+	time.Sleep(250 * time.Millisecond)
+	require.NoError(t, tmux.Command("set-buffer", "").Run(),
+		"clear tmux buffer")
+
+	// Clear to ensure the "cat /path/to/whatever" isn't part of the
+	// matched text.
+	tmux.Clear()
+	fmt.Fprintln(tmux, "clear && cat", testFile)
+	if !assert.NoError(t, tmux.WaitUntilContains("--EOF--", 5*time.Second)) {
+		t.Fatalf("could not find EOF in %q", tmux.Contents())
+	}
+
+	tmux.Clear()
+	_, err := tmux.Write([]byte{0x01, 'f'}) // ctrl-a f
+	require.NoError(t, err, "send ctrl-a f")
+
+	time.Sleep(250 * time.Millisecond)
+
+	// Enter multi-select mode.
+	_, err = tmux.Write([]byte{0x09})
+	require.NoError(t, err, "send tab")
+
+	time.Sleep(200 * time.Millisecond)
+
+	hints := tmux.Hints()
+	t.Logf("got hints %q", hints)
+	if !assert.Len(t, hints, len(_wantMatches)) {
+		t.Fatalf("expected %d hints in %q", len(_wantMatches), tmux.Contents())
+	}
+
+	// Select all hints.
+	for _, hint := range hints {
+		_, err := io.WriteString(tmux, hint)
+		require.NoError(t, err, "select hint %q", hint)
+		time.Sleep(250 * time.Millisecond)
+	}
+
+	// Accept output and exit.
+	_, err = tmux.Write([]byte{0x0d}) // CR
+	require.NoError(t, err, "send enter")
+
+	time.Sleep(250 * time.Millisecond)
+
+	got, err := tmux.Command("show-buffer").Output()
+	require.NoError(t, err)
+
+	var state jsonReport
+	require.NoError(t, json.Unmarshal(got, &state))
+
+	t.Logf("got %+v", state)
+
+	// The outputs are space-separated in some order.
+	texts := strings.Split(state.Text, " ")
+	assert.Len(t, texts, len(_wantMatches), "expected texts to match")
+
+	var wantTexts []string
+	for i := range _wantMatches {
+		wantTexts = append(wantTexts, _wantMatches[i].Text)
+	}
+
+	assert.ElementsMatch(t, wantTexts, texts)
+}
+
 type fakeEnv struct {
 	Root   string
 	Home   string

internal/fastcopy/hint.go

@@ -6,12 +6,27 @@ import (
 
 	"github.com/abhinav/tmux-fastcopy/internal/huffman"
 	"github.com/abhinav/tmux-fastcopy/internal/ui"
+	tcell "github.com/gdamore/tcell/v2"
 )
 
 type hint struct {
-	Label   string
-	Text    string
+	// Label to select this hint.
+	Label string
+
+	// Text that will be copied if this hint is selected.
+	Text string
+
+	// List ot matches identified by this hint.
+	//
+	// Note that a hint may have multiple matches
+	// if the same text appears on the screen multiple times,
+	// or if the same text matches multiple regexes.
 	Matches []Match
+
+	// Selected reports whether this hint is selected.
+	//
+	// This is only used in multi-selection mode.
+	Selected bool
 }
 
 // generateHints generates a list of hints for the given text. It uses alphabet
@@ -58,13 +73,28 @@ func generateHints(alphabet []rune, text string, matches []Match) []hint {
 	return hints
 }
 
-func (h *hint) Annotations(input string, style Style) (anns []ui.TextAnnotation) {
+// AnnotationStyle is the style of annotations for hints and matched text.
+type AnnotationStyle struct {
+	// Matched text that is still a candidate for selection.
+	Match tcell.Style
+
+	// Matched text that is no longer a candidate for selection.
+	Skipped tcell.Style
+
+	// Label that the user must type to select the hint.
+	Label tcell.Style
+
+	// Part of a multi-character label that the user has already typed.
+	LabelTyped tcell.Style
+}
+
+func (h *hint) Annotations(input string, style AnnotationStyle) (anns []ui.TextAnnotation) {
 	matched := strings.HasPrefix(h.Label, input)
 
 	// If the hint matches the input, overlay the hint (both, typed
 	// and non-typed portions) over the string. Otherwise, grey out
 	// the match.
-	matchStyle := style.SkippedMatch
+	matchStyle := style.Skipped
 	if matched {
 		matchStyle = style.Match
 	}
@@ -82,7 +112,7 @@ func (h *hint) Annotations(input string, style Style) (anns []ui.TextAnnotation)
 				anns = append(anns, ui.OverlayTextAnnotation{
 					Offset:  pos.Start,
 					Overlay: input,
-					Style:   style.HintLabelInput,
+					Style:   style.LabelTyped,
 				})
 				i += len(input)
 			}
@@ -92,7 +122,7 @@ func (h *hint) Annotations(input string, style Style) (anns []ui.TextAnnotation)
 				anns = append(anns, ui.OverlayTextAnnotation{
 					Offset:  pos.Start + len(input),
 					Overlay: h.Label[i:],
-					Style:   style.HintLabel,
+					Style:   style.Label,
 				})
 			}
 

internal/fastcopy/hint_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	"github.com/abhinav/tmux-fastcopy/internal/ui"
+	tcell "github.com/gdamore/tcell/v2"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -107,7 +108,12 @@ func TestGenerateHints(t *testing.T) {
 func TestHintAnnotations(t *testing.T) {
 	t.Parallel()
 
-	style := sampleStyle()
+	style := AnnotationStyle{
+		Match:      tcell.StyleDefault.Foreground(tcell.ColorGreen),
+		Skipped:    tcell.StyleDefault.Foreground(tcell.ColorGray),
+		Label:      tcell.StyleDefault.Foreground(tcell.ColorRed),
+		LabelTyped: tcell.StyleDefault.Foreground(tcell.ColorYellow),
+	}
 
 	tests := []struct {
 		desc  string
@@ -130,7 +136,7 @@ func TestHintAnnotations(t *testing.T) {
 				ui.OverlayTextAnnotation{
 					Offset:  0,
 					Overlay: "a",
-					Style:   style.HintLabel,
+					Style:   style.Label,
 				},
 				ui.StyleTextAnnotation{
 					Offset: 1,
@@ -140,7 +146,7 @@ func TestHintAnnotations(t *testing.T) {
 				ui.OverlayTextAnnotation{
 					Offset:  7,
 					Overlay: "a",
-					Style:   style.HintLabel,
+					Style:   style.Label,
 				},
 				ui.StyleTextAnnotation{
 					Offset: 8,
@@ -163,7 +169,7 @@ func TestHintAnnotations(t *testing.T) {
 				ui.OverlayTextAnnotation{
 					Offset:  0,
 					Overlay: "a",
-					Style:   style.HintLabelInput,
+					Style:   style.LabelTyped,
 				},
 				ui.StyleTextAnnotation{
 					Offset: 1,
@@ -185,7 +191,7 @@ func TestHintAnnotations(t *testing.T) {
 				ui.OverlayTextAnnotation{
 					Offset:  1,
 					Overlay: "ab",
-					Style:   style.HintLabel,
+					Style:   style.Label,
 				},
 				ui.StyleTextAnnotation{
 					Offset: 3,
@@ -208,12 +214,12 @@ func TestHintAnnotations(t *testing.T) {
 				ui.OverlayTextAnnotation{
 					Offset:  1,
 					Overlay: "a",
-					Style:   style.HintLabelInput,
+					Style:   style.LabelTyped,
 				},
 				ui.OverlayTextAnnotation{
 					Offset:  2,
 					Overlay: "b",
-					Style:   style.HintLabel,
+					Style:   style.Label,
 				},
 				ui.StyleTextAnnotation{
 					Offset: 3,
@@ -236,7 +242,7 @@ func TestHintAnnotations(t *testing.T) {
 				ui.StyleTextAnnotation{
 					Offset: 1,
 					Length: 6,
-					Style:  style.SkippedMatch,
+					Style:  style.Skipped,
 				},
 			},
 		},
@@ -253,7 +259,7 @@ func TestHintAnnotations(t *testing.T) {
 				ui.OverlayTextAnnotation{
 					Offset:  0,
 					Overlay: "abcd",
-					Style:   style.HintLabel,
+					Style:   style.Label,
 				},
 			},
 		},