Merge branch 'hotfix/cursor-positioning' into feature/recent-repos

1 files changed, 378 insertions, 66 deletions

diff --git a/pkg/gui/keybindings.go b/pkg/gui/keybindings.go
index 287619b8b..73f4aabe5 100644
--- a/pkg/gui/keybindings.go
+++ b/pkg/gui/keybindings.go
@@ -1,82 +1,388 @@
 package gui
 
-import "github.com/jesseduffield/gocui"
+import (
+	"github.com/jesseduffield/gocui"
+)
 
 // Binding - a keybinding mapping a key and modifier to a handler. The keypress
 // is only handled if the given view has focus, or handled globally if the view
 // is ""
 type Binding struct {
-	ViewName string
-	Handler  func(*gocui.Gui, *gocui.View) error
-	Key      interface{} // FIXME: find out how to get `gocui.Key | rune`
-	Modifier gocui.Modifier
+	ViewName    string
+	Handler     func(*gocui.Gui, *gocui.View) error
+	Key         interface{} // FIXME: find out how to get `gocui.Key | rune`
+	Modifier    gocui.Modifier
+	KeyReadable string
+	Description string
 }
 
-func (gui *Gui) keybindings(g *gocui.Gui) error {
-	bindings := []Binding{
-		{ViewName: "", Key: 'q', Modifier: gocui.ModNone, Handler: gui.quit},
-		{ViewName: "", Key: gocui.KeyCtrlC, Modifier: gocui.ModNone, Handler: gui.quit},
-		{ViewName: "", Key: gocui.KeyEsc, Modifier: gocui.ModNone, Handler: gui.quit},
-		{ViewName: "", Key: gocui.KeyPgup, Modifier: gocui.ModNone, Handler: gui.scrollUpMain},
-		{ViewName: "", Key: gocui.KeyPgdn, Modifier: gocui.ModNone, Handler: gui.scrollDownMain},
-		{ViewName: "", Key: gocui.KeyCtrlU, Modifier: gocui.ModNone, Handler: gui.scrollUpMain},
-		{ViewName: "", Key: gocui.KeyCtrlD, Modifier: gocui.ModNone, Handler: gui.scrollDownMain},
-		{ViewName: "", Key: 'P', Modifier: gocui.ModNone, Handler: gui.pushFiles},
-		{ViewName: "", Key: 'p', Modifier: gocui.ModNone, Handler: gui.pullFiles},
-		{ViewName: "", Key: 'R', Modifier: gocui.ModNone, Handler: gui.handleRefresh},
-		{ViewName: "status", Key: 'e', Modifier: gocui.ModNone, Handler: gui.handleEditConfig},
-		{ViewName: "status", Key: 'o', Modifier: gocui.ModNone, Handler: gui.handleOpenConfig},
-		{ViewName: "status", Key: 'u', Modifier: gocui.ModNone, Handler: gui.handleCheckForUpdate},
-		{ViewName: "status", Key: 's', Modifier: gocui.ModNone, Handler: gui.handleSwitchRepo},
-		{ViewName: "files", Key: 'c', Modifier: gocui.ModNone, Handler: gui.handleCommitPress},
-		{ViewName: "files", Key: 'C', Modifier: gocui.ModNone, Handler: gui.handleCommitEditorPress},
-		{ViewName: "files", Key: gocui.KeySpace, Modifier: gocui.ModNone, Handler: gui.handleFilePress},
-		{ViewName: "files", Key: 'd', Modifier: gocui.ModNone, Handler: gui.handleFileRemove},
-		{ViewName: "files", Key: 'm', Modifier: gocui.ModNone, Handler: gui.handleSwitchToMerge},
-		{ViewName: "files", Key: 'e', Modifier: gocui.ModNone, Handler: gui.handleFileEdit},
-		{ViewName: "files", Key: 'o', Modifier: gocui.ModNone, Handler: gui.handleFileOpen},
-		{ViewName: "files", Key: 'i', Modifier: gocui.ModNone, Handler: gui.handleIgnoreFile},
-		{ViewName: "files", Key: 'r', Modifier: gocui.ModNone, Handler: gui.handleRefreshFiles},
-		{ViewName: "files", Key: 'S', Modifier: gocui.ModNone, Handler: gui.handleStashSave},
-		{ViewName: "files", Key: 'A', Modifier: gocui.ModNone, Handler: gui.handleAbortMerge},
-		{ViewName: "files", Key: 'a', Modifier: gocui.ModNone, Handler: gui.handleStageAll},
-		{ViewName: "files", Key: 't', Modifier: gocui.ModNone, Handler: gui.handleAddPatch},
-		{ViewName: "files", Key: 'D', Modifier: gocui.ModNone, Handler: gui.handleResetHard},
-		{ViewName: "main", Key: gocui.KeyEsc, Modifier: gocui.ModNone, Handler: gui.handleEscapeMerge},
-		{ViewName: "main", Key: gocui.KeySpace, Modifier: gocui.ModNone, Handler: gui.handlePickHunk},
-		{ViewName: "main", Key: 'b', Modifier: gocui.ModNone, Handler: gui.handlePickBothHunks},
-		{ViewName: "main", Key: gocui.KeyArrowLeft, Modifier: gocui.ModNone, Handler: gui.handleSelectPrevConflict},
-		{ViewName: "main", Key: gocui.KeyArrowRight, Modifier: gocui.ModNone, Handler: gui.handleSelectNextConflict},
-		{ViewName: "main", Key: gocui.KeyArrowUp, Modifier: gocui.ModNone, Handler: gui.handleSelectTop},
-		{ViewName: "main", Key: gocui.KeyArrowDown, Modifier: gocui.ModNone, Handler: gui.handleSelectBottom},
-		{ViewName: "main", Key: 'h', Modifier: gocui.ModNone, Handler: gui.handleSelectPrevConflict},
-		{ViewName: "main", Key: 'l', Modifier: gocui.ModNone, Handler: gui.handleSelectNextConflict},
-		{ViewName: "main", Key: 'k', Modifier: gocui.ModNone, Handler: gui.handleSelectTop},
-		{ViewName: "main", Key: 'j', Modifier: gocui.ModNone, Handler: gui.handleSelectBottom},
-		{ViewName: "main", Key: 'z', Modifier: gocui.ModNone, Handler: gui.handlePopFileSnapshot},
-		{ViewName: "branches", Key: gocui.KeySpace, Modifier: gocui.ModNone, Handler: gui.handleBranchPress},
-		{ViewName: "branches", Key: 'c', Modifier: gocui.ModNone, Handler: gui.handleCheckoutByName},
-		{ViewName: "branches", Key: 'F', Modifier: gocui.ModNone, Handler: gui.handleForceCheckout},
-		{ViewName: "branches", Key: 'n', Modifier: gocui.ModNone, Handler: gui.handleNewBranch},
-		{ViewName: "branches", Key: 'd', Modifier: gocui.ModNone, Handler: gui.handleDeleteBranch},
-		{ViewName: "branches", Key: 'D', Modifier: gocui.ModNone, Handler: gui.handleForceDeleteBranch},
-		{ViewName: "branches", Key: 'm', Modifier: gocui.ModNone, Handler: gui.handleMerge},
-		{ViewName: "commits", Key: 's', Modifier: gocui.ModNone, Handler: gui.handleCommitSquashDown},
-		{ViewName: "commits", Key: 'r', Modifier: gocui.ModNone, Handler: gui.handleRenameCommit},
-		{ViewName: "commits", Key: 'R', Modifier: gocui.ModNone, Handler: gui.handleRenameCommitEditor},
-		{ViewName: "commits", Key: 'g', Modifier: gocui.ModNone, Handler: gui.handleResetToCommit},
-		{ViewName: "commits", Key: 'f', Modifier: gocui.ModNone, Handler: gui.handleCommitFixup},
-		{ViewName: "stash", Key: gocui.KeySpace, Modifier: gocui.ModNone, Handler: gui.handleStashApply},
-		{ViewName: "stash", Key: 'g', Modifier: gocui.ModNone, Handler: gui.handleStashPop},
-		{ViewName: "stash", Key: 'd', Modifier: gocui.ModNone, Handler: gui.handleStashDrop},
-		{ViewName: "commitMessage", Key: gocui.KeyEnter, Modifier: gocui.ModNone, Handler: gui.handleCommitConfirm},
-		{ViewName: "commitMessage", Key: gocui.KeyEsc, Modifier: gocui.ModNone, Handler: gui.handleCommitClose},
+// GetDisplayStrings returns the display string of a file
+func (b *Binding) GetDisplayStrings() []string {
+	return []string{b.GetKey(), b.Description}
+}
+
+func (b *Binding) GetKey() string {
+	r, ok := b.Key.(rune)
+	key := ""
+
+	if ok {
+		key = string(r)
+	} else if b.KeyReadable != "" {
+		key = b.KeyReadable
+	}
+
+	return key
+}
+
+func (gui *Gui) GetKeybindings() []*Binding {
+	bindings := []*Binding{
+		{
+			ViewName: "",
+			Key:      'q',
+			Modifier: gocui.ModNone,
+			Handler:  gui.quit,
+		}, {
+			ViewName: "",
+			Key:      gocui.KeyCtrlC,
+			Modifier: gocui.ModNone,
+			Handler:  gui.quit,
+		}, {
+			ViewName: "",
+			Key:      gocui.KeyEsc,
+			Modifier: gocui.ModNone,
+			Handler:  gui.quit,
+		}, {
+			ViewName: "",
+			Key:      gocui.KeyPgup,
+			Modifier: gocui.ModNone,
+			Handler:  gui.scrollUpMain,
+		}, {
+			ViewName: "",
+			Key:      gocui.KeyPgdn,
+			Modifier: gocui.ModNone,
+			Handler:  gui.scrollDownMain,
+		}, {
+			ViewName: "",
+			Key:      gocui.KeyCtrlU,
+			Modifier: gocui.ModNone,
+			Handler:  gui.scrollUpMain,
+		}, {
+			ViewName: "",
+			Key:      gocui.KeyCtrlD,
+			Modifier: gocui.ModNone,
+			Handler:  gui.scrollDownMain,
+		}, {
+			ViewName:    "",
+			Key:         'P',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.pushFiles,
+			Description: gui.Tr.SLocalize("push"),
+		}, {
+			ViewName:    "",
+			Key:         'p',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.pullFiles,
+			Description: gui.Tr.SLocalize("pull"),
+		}, {
+			ViewName:    "",
+			Key:         'R',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleRefresh,
+			Description: gui.Tr.SLocalize("refresh"),
+		}, {
+			ViewName: "",
+			Key:      'x',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleCreateOptionsMenu,
+		}, {
+			ViewName:    "status",
+			Key:         'e',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleEditConfig,
+			Description: gui.Tr.SLocalize("EditConfig"),
+		}, {
+			ViewName:    "status",
+			Key:         'o',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleOpenConfig,
+			Description: gui.Tr.SLocalize("OpenConfig"),
+		}, {
+			ViewName:    "status",
+			Key:         'u',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleCheckForUpdate,
+			Description: gui.Tr.SLocalize("checkForUpdate"),
+		}, {
+			ViewName:    "status",
+			Key:         's',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleSwitchRepo,
+			Description: gui.Tr.SLocalize("SwitchRepo"),
+		},
+		{
+			ViewName:    "files",
+			Key:         'c',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleCommitPress,
+			Description: gui.Tr.SLocalize("CommitChanges"),
+		}, {
+			ViewName:    "files",
+			Key:         'C',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleCommitEditorPress,
+			Description: gui.Tr.SLocalize("CommitChangesWithEditor"),
+		}, {
+			ViewName:    "files",
+			Key:         gocui.KeySpace,
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleFilePress,
+			KeyReadable: "space",
+			Description: gui.Tr.SLocalize("toggleStaged"),
+		}, {
+			ViewName:    "files",
+			Key:         'd',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleFileRemove,
+			Description: gui.Tr.SLocalize("removeFile"),
+		}, {
+			ViewName:    "files",
+			Key:         'm',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleSwitchToMerge,
+			Description: gui.Tr.SLocalize("resolveMergeConflicts"),
+		}, {
+			ViewName:    "files",
+			Key:         'e',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleFileEdit,
+			Description: gui.Tr.SLocalize("editFile"),
+		}, {
+			ViewName:    "files",
+			Key:         'o',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleFileOpen,
+			Description: gui.Tr.SLocalize("openFile"),
+		}, {
+			ViewName:    "files",
+			Key:         'i',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleIgnoreFile,
+			Description: gui.Tr.SLocalize("ignoreFile"),
+		}, {
+			ViewName:    "files",
+			Key:         'r',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleRefreshFiles,
+			Description: gui.Tr.SLocalize("refreshFiles"),
+		}, {
+			ViewName:    "files",
+			Key:         'S',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleStashSave,
+			Description: gui.Tr.SLocalize("stashFiles"),
+		}, {
+			ViewName:    "files",
+			Key:         'A',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleAbortMerge,
+			Description: gui.Tr.SLocalize("abortMerge"),
+		}, {
+			ViewName:    "files",
+			Key:         'a',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleStageAll,
+			Description: gui.Tr.SLocalize("toggleStagedAll"),
+		}, {
+			ViewName:    "files",
+			Key:         't',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleAddPatch,
+			Description: gui.Tr.SLocalize("addPatch"),
+		}, {
+			ViewName:    "files",
+			Key:         'D',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleResetHard,
+			Description: gui.Tr.SLocalize("resetHard"),
+		}, {
+			ViewName: "main",
+			Key:      gocui.KeyEsc,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleEscapeMerge,
+		}, {
+			ViewName: "main",
+			Key:      gocui.KeySpace,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handlePickHunk,
+		}, {
+			ViewName: "main",
+			Key:      'b',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handlePickBothHunks,
+		}, {
+			ViewName: "main",
+			Key:      gocui.KeyArrowLeft,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectPrevConflict,
+		}, {
+			ViewName: "main",
+			Key:      gocui.KeyArrowRight,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectNextConflict,
+		}, {
+			ViewName: "main",
+			Key:      gocui.KeyArrowUp,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectTop,
+		}, {
+			ViewName: "main",
+			Key:      gocui.KeyArrowDown,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectBottom,
+		}, {
+			ViewName: "main",
+			Key:      'h',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectPrevConflict,
+		}, {
+			ViewName: "main",
+			Key:      'l',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectNextConflict,
+		}, {
+			ViewName: "main",
+			Key:      'k',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectTop,
+		}, {
+			ViewName: "main",
+			Key:      'j',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleSelectBottom,
+		}, {
+			ViewName: "main",
+			Key:      'z',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handlePopFileSnapshot,
+		}, {
+			ViewName:    "branches",
+			Key:         gocui.KeySpace,
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleBranchPress,
+			KeyReadable: "space",
+			Description: gui.Tr.SLocalize("checkout"),
+		}, {
+			ViewName:    "branches",
+			Key:         'c',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleCheckoutByName,
+			Description: gui.Tr.SLocalize("checkoutByName"),
+		}, {
+			ViewName:    "branches",
+			Key:         'F',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleForceCheckout,
+			Description: gui.Tr.SLocalize("forceCheckout"),
+		}, {
+			ViewName:    "branches",
+			Key:         'n',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleNewBranch,
+			Description: gui.Tr.SLocalize("newBranch"),
+		}, {
+			ViewName:    "branches",
+			Key:         'd',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleDeleteBranch,
+			Description: gui.Tr.SLocalize("deleteBranch"),
+		}, {
+			ViewName:    "branches",
+			Key:         'D',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleForceDeleteBranch,
+			Description: gui.Tr.SLocalize("forceDeleteBranch"),
+		}, {
+			ViewName:    "branches",
+			Key:         'm',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleMerge,
+			Description: gui.Tr.SLocalize("mergeIntoCurrentBranch"),
+		}, {
+			ViewName:    "commits",
+			Key:         's',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleCommitSquashDown,
+			Description: gui.Tr.SLocalize("squashDown"),
+		}, {
+			ViewName:    "commits",
+			Key:         'r',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleRenameCommit,
+			Description: gui.Tr.SLocalize("renameCommit"),
+		}, {
+			ViewName:    "commits",
+			Key:         'R',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleRenameCommitEditor,
+			Description: gui.Tr.SLocalize("renameCommitEditor"),
+		}, {
+			ViewName:    "commits",
+			Key:         'g',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleResetToCommit,
+			Description: gui.Tr.SLocalize("resetToThisCommit"),
+		}, {
+			ViewName:    "commits",
+			Key:         'f',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleCommitFixup,
+			Description: gui.Tr.SLocalize("fixupCommit"),
+		}, {
+			ViewName:    "stash",
+			Key:         gocui.KeySpace,
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleStashApply,
+			KeyReadable: "space",
+			Description: gui.Tr.SLocalize("apply"),
+		}, {
+			ViewName:    "stash",
+			Key:         'g',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleStashPop,
+			Description: gui.Tr.SLocalize("pop"),
+		}, {
+			ViewName:    "stash",
+			Key:         'd',
+			Modifier:    gocui.ModNone,
+			Handler:     gui.handleStashDrop,
+			Description: gui.Tr.SLocalize("drop"),
+		}, {
+			ViewName: "commitMessage",
+			Key:      gocui.KeyEnter,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleCommitConfirm,
+		}, {
+			ViewName: "commitMessage",
+			Key:      gocui.KeyEsc,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleCommitClose,
+		}, {
+			ViewName: "menu",
+			Key:      gocui.KeyEsc,
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleMenuClose,
+		}, {
+			ViewName: "menu",
+			Key:      'q',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleMenuClose,
+		},
 	}
 
 	// Would make these keybindings global but that interferes with editing
 	// input in the confirmation panel
-	for _, viewName := range []string{"status", "files", "branches", "commits", "stash"} {
-		bindings = append(bindings, []Binding{
+	for _, viewName := range []string{"status", "files", "branches", "commits", "stash", "menu"} {
+		bindings = append(bindings, []*Binding{
 			{ViewName: viewName, Key: gocui.KeyTab, Modifier: gocui.ModNone, Handler: gui.nextView},
 			{ViewName: viewName, Key: gocui.KeyArrowLeft, Modifier: gocui.ModNone, Handler: gui.previousView},
 			{ViewName: viewName, Key: gocui.KeyArrowRight, Modifier: gocui.ModNone, Handler: gui.nextView},
@@ -89,6 +395,12 @@ func (gui *Gui) keybindings(g *gocui.Gui) error {
 		}...)
 	}
 
+	return bindings
+}
+
+func (gui *Gui) keybindings(g *gocui.Gui) error {
+	bindings := gui.GetKeybindings()
+
 	for _, binding := range bindings {
 		if err := g.SetKeybinding(binding.ViewName, binding.Key, binding.Modifier, binding.Handler); err != nil {
 			return err