Refactor: add a separate Prompt view

So far, confirmations and prompts were handled by the same view, context, and
controller, with a bunch of conditional code based on whether the view is
editable. This was more or less ok so far, since it does save a little bit of
code duplication; however, now we need separate views, because we don't have
dynamic keybindings, but we want to map "confirm" to different keys in
confirmations (the "universal.confirm" user config) and prompts (hard-coded to
enter, because it doesn't make sense to customize it there).

It also allows us to get rid of the conditional code, which is a nice benefit;
and the code duplication is actually not *that* bad.

Author: stefanhaller

pkg/cheatsheet/generate.go

@@ -116,6 +116,7 @@ func localisedTitle(tr *i18n.TranslationSet, str string) string {
 		"commitDescription": tr.CommitDescriptionTitle,
 		"commits":           tr.CommitsTitle,
 		"confirmation":      tr.ConfirmationTitle,
+		"prompt":            tr.PromptTitle,
 		"information":       tr.InformationTitle,
 		"main":              tr.NormalTitle,
 		"patchBuilding":     tr.PatchBuildingTitle,

pkg/gui/context/context.go

@@ -41,6 +41,7 @@ const (
 
 	MENU_CONTEXT_KEY               types.ContextKey = "menu"
 	CONFIRMATION_CONTEXT_KEY       types.ContextKey = "confirmation"
+	PROMPT_CONTEXT_KEY             types.ContextKey = "prompt"
 	SEARCH_CONTEXT_KEY             types.ContextKey = "search"
 	COMMIT_MESSAGE_CONTEXT_KEY     types.ContextKey = "commitMessage"
 	COMMIT_DESCRIPTION_CONTEXT_KEY types.ContextKey = "commitDescription"
@@ -73,6 +74,7 @@ var AllContextKeys = []types.ContextKey{
 
 	MENU_CONTEXT_KEY,
 	CONFIRMATION_CONTEXT_KEY,
+	PROMPT_CONTEXT_KEY,
 	SEARCH_CONTEXT_KEY,
 	COMMIT_MESSAGE_CONTEXT_KEY,
 	SUBMODULES_CONTEXT_KEY,
@@ -106,6 +108,7 @@ type ContextTree struct {
 	CustomPatchBuilderSecondary types.Context
 	MergeConflicts              *MergeConflictsContext
 	Confirmation                *ConfirmationContext
+	Prompt                      *PromptContext
 	CommitMessage               *CommitMessageContext
 	CommitDescription           types.Context
 	CommandLog                  types.Context
@@ -141,6 +144,7 @@ func (self *ContextTree) Flatten() []types.Context {
 		self.Stash,
 		self.Menu,
 		self.Confirmation,
+		self.Prompt,
 		self.CommitMessage,
 		self.CommitDescription,
 

pkg/gui/context/prompt_context.go

@@ -0,0 +1,30 @@
+package context
+
+import (
+	"github.com/jesseduffield/lazygit/pkg/gui/types"
+)
+
+type PromptContext struct {
+	*SimpleContext
+	c *ContextCommon
+
+	State ConfirmationContextState
+}
+
+var _ types.Context = (*PromptContext)(nil)
+
+func NewPromptContext(
+	c *ContextCommon,
+) *PromptContext {
+	return &PromptContext{
+		c: c,
+		SimpleContext: NewSimpleContext(NewBaseContext(NewBaseContextOpts{
+			View:                  c.Views().Prompt,
+			WindowName:            "prompt",
+			Key:                   PROMPT_CONTEXT_KEY,
+			Kind:                  types.TEMPORARY_POPUP,
+			Focusable:             true,
+			HasUncontrolledBounds: true,
+		})),
+	}
+}

pkg/gui/context/setup.go

@@ -84,6 +84,7 @@ func NewContextTree(c *ContextCommon) *ContextTree {
 			c,
 		),
 		Confirmation:  NewConfirmationContext(c),
+		Prompt:        NewPromptContext(c),
 		CommitMessage: NewCommitMessageContext(c),
 		CommitDescription: NewSimpleContext(
 			NewBaseContext(NewBaseContextOpts{

pkg/gui/controllers.go

@@ -193,6 +193,7 @@ func (gui *Gui) resetHelpersAndControllers() {
 	statusController := controllers.NewStatusController(common)
 	commandLogController := controllers.NewCommandLogController(common)
 	confirmationController := controllers.NewConfirmationController(common)
+	promptController := controllers.NewPromptController(common)
 	suggestionsController := controllers.NewSuggestionsController(common)
 	jumpToSideWindowController := controllers.NewJumpToSideWindowController(common, gui.handleNextTab)
 
@@ -399,6 +400,10 @@ func (gui *Gui) resetHelpersAndControllers() {
 		confirmationController,
 	)
 
+	controllers.AttachControllers(gui.State.Contexts.Prompt,
+		promptController,
+	)
+
 	controllers.AttachControllers(gui.State.Contexts.Suggestions,
 		suggestionsController,
 	)

pkg/gui/controllers/confirmation_controller.go

@@ -1,9 +1,6 @@
 package controllers
 
 import (
-	"fmt"
-
-	"github.com/jesseduffield/gocui"
 	"github.com/jesseduffield/lazygit/pkg/gui/context"
 	"github.com/jesseduffield/lazygit/pkg/gui/types"
 )
@@ -39,45 +36,19 @@ func (self *ConfirmationController) GetKeybindings(opts types.KeybindingsOpts) [
 			DisplayOnScreen: true,
 		},
 		{
-			Key: opts.GetKey(opts.Config.Universal.TogglePanel),
-			Handler: func() error {
-				if len(self.c.Contexts().Suggestions.State.Suggestions) > 0 {
-					self.switchToSuggestions()
-				}
-				return nil
-			},
-		},
-		{
-			Key:               opts.GetKey(opts.Config.Universal.CopyToClipboard),
-			Handler:           self.handleCopyToClipboard,
-			Description:       self.c.Tr.CopyToClipboardMenu,
-			DisplayOnScreen:   true,
-			GetDisabledReason: self.copyToClipboardEnabled,
+			Key:             opts.GetKey(opts.Config.Universal.CopyToClipboard),
+			Handler:         self.handleCopyToClipboard,
+			Description:     self.c.Tr.CopyToClipboardMenu,
+			DisplayOnScreen: true,
 		},
 	}
 
 	return bindings
 }
 
-func (self *ConfirmationController) GetMouseKeybindings(opts types.KeybindingsOpts) []*gocui.ViewMouseBinding {
-	return []*gocui.ViewMouseBinding{
-		{
-			ViewName:    self.c.Contexts().Suggestions.GetViewName(),
-			FocusedView: self.c.Contexts().Confirmation.GetViewName(),
-			Key:         gocui.MouseLeft,
-			Handler: func(gocui.ViewMouseBindingOpts) error {
-				self.switchToSuggestions()
-				// Let it fall through to the ListController's click handler so that
-				// the clicked line gets selected:
-				return gocui.ErrKeybindingNotHandled
-			},
-		},
-	}
-}
-
 func (self *ConfirmationController) GetOnFocusLost() func(types.OnFocusLostOpts) {
 	return func(types.OnFocusLostOpts) {
-		self.c.Helpers().Confirmation.DeactivateConfirmationPrompt()
+		self.c.Helpers().Confirmation.DeactivateConfirmation()
 	}
 }
 
@@ -89,18 +60,6 @@ func (self *ConfirmationController) context() *context.ConfirmationContext {
 	return self.c.Contexts().Confirmation
 }
 
-func (self *ConfirmationController) switchToSuggestions() {
-	subtitle := ""
-	if self.c.State().GetRepoState().GetCurrentPopupOpts().HandleDeleteSuggestion != nil {
-		// We assume that whenever things are deletable, they
-		// are also editable, so we show both keybindings
-		subtitle = fmt.Sprintf(self.c.Tr.SuggestionsSubtitle,
-			self.c.UserConfig().Keybinding.Universal.Remove, self.c.UserConfig().Keybinding.Universal.Edit)
-	}
-	self.c.Views().Suggestions.Subtitle = subtitle
-	self.c.Context().Replace(self.c.Contexts().Suggestions)
-}
-
 func (self *ConfirmationController) handleCopyToClipboard() error {
 	confirmationView := self.c.Views().Confirmation
 	text := confirmationView.Buffer()
@@ -111,12 +70,3 @@ func (self *ConfirmationController) handleCopyToClipboard() error {
 	self.c.Toast(self.c.Tr.MessageCopiedToClipboard)
 	return nil
 }
-
-func (self *ConfirmationController) copyToClipboardEnabled() *types.DisabledReason {
-	if self.c.Views().Confirmation.Editable {
-		// The empty text is intentional. We don't want to get a toast when invoking this, we only
-		// want to prevent it from showing up in the options bar.
-		return &types.DisabledReason{Text: ""}
-	}
-	return nil
-}