Some cleanups for APIs related to contexts (#3808)

- **PR Description**

Some cleanups for APIs related to contexts. Most of these were triggered
by a TODO comment in the code.

Author: stefanhaller

pkg/gui/context.go

@@ -53,7 +53,7 @@ func (self *ContextMgr) Replace(c types.Context) error {
 
 	defer self.Unlock()
 
-	return self.ActivateContext(c, types.OnFocusOpts{})
+	return self.Activate(c, types.OnFocusOpts{})
 }
 
 func (self *ContextMgr) Push(c types.Context, opts ...types.OnFocusOpts) error {
@@ -74,7 +74,7 @@ func (self *ContextMgr) Push(c types.Context, opts ...types.OnFocusOpts) error {
 	contextsToDeactivate, contextToActivate := self.pushToContextStack(c)
 
 	for _, contextToDeactivate := range contextsToDeactivate {
-		if err := self.deactivateContext(contextToDeactivate, types.OnFocusLostOpts{NewContextKey: c.GetKey()}); err != nil {
+		if err := self.deactivate(contextToDeactivate, types.OnFocusLostOpts{NewContextKey: c.GetKey()}); err != nil {
 			return err
 		}
 	}
@@ -83,7 +83,7 @@ func (self *ContextMgr) Push(c types.Context, opts ...types.OnFocusOpts) error {
 		return nil
 	}
 
-	return self.ActivateContext(contextToActivate, singleOpts)
+	return self.Activate(contextToActivate, singleOpts)
 }
 
 // Adjusts the context stack based on the context that's being pushed and
@@ -160,44 +160,14 @@ func (self *ContextMgr) Pop() error {
 
 	self.Unlock()
 
-	if err := self.deactivateContext(currentContext, types.OnFocusLostOpts{NewContextKey: newContext.GetKey()}); err != nil {
+	if err := self.deactivate(currentContext, types.OnFocusLostOpts{NewContextKey: newContext.GetKey()}); err != nil {
 		return err
 	}
 
-	return self.ActivateContext(newContext, types.OnFocusOpts{})
+	return self.Activate(newContext, types.OnFocusOpts{})
 }
 
-func (self *ContextMgr) RemoveContexts(contextsToRemove []types.Context) error {
-	self.Lock()
-
-	if len(self.ContextStack) == 1 {
-		self.Unlock()
-		return nil
-	}
-
-	rest := lo.Filter(self.ContextStack, func(context types.Context, _ int) bool {
-		for _, contextToRemove := range contextsToRemove {
-			if context.GetKey() == contextToRemove.GetKey() {
-				return false
-			}
-		}
-		return true
-	})
-	self.ContextStack = rest
-	contextToActivate := rest[len(rest)-1]
-	self.Unlock()
-
-	for _, context := range contextsToRemove {
-		if err := self.deactivateContext(context, types.OnFocusLostOpts{NewContextKey: contextToActivate.GetKey()}); err != nil {
-			return err
-		}
-	}
-
-	// activate the item at the top of the stack
-	return self.ActivateContext(contextToActivate, types.OnFocusOpts{})
-}
-
-func (self *ContextMgr) deactivateContext(c types.Context, opts types.OnFocusLostOpts) error {
+func (self *ContextMgr) deactivate(c types.Context, opts types.OnFocusLostOpts) error {
 	view, _ := self.gui.c.GocuiGui().View(c.GetViewName())
 
 	if opts.NewContextKey != context.SEARCH_CONTEXT_KEY {
@@ -220,7 +190,7 @@ func (self *ContextMgr) deactivateContext(c types.Context, opts types.OnFocusLos
 	return nil
 }
 
-func (self *ContextMgr) ActivateContext(c types.Context, opts types.OnFocusOpts) error {
+func (self *ContextMgr) Activate(c types.Context, opts types.OnFocusOpts) error {
 	viewName := c.GetViewName()
 	v, err := self.gui.c.GocuiGui().View(viewName)
 	if err != nil {
@@ -392,7 +362,7 @@ func (self *ContextMgr) ContextForKey(key types.ContextKey) types.Context {
 	return nil
 }
 
-func (self *ContextMgr) PopupContexts() []types.Context {
+func (self *ContextMgr) CurrentPopup() []types.Context {
 	self.RLock()
 	defer self.RUnlock()
 

pkg/gui/context/local_commits_context.go

@@ -34,7 +34,7 @@ func NewLocalCommitsContext(c *ContextCommon) *LocalCommitsContext {
 	getDisplayStrings := func(startIdx int, endIdx int) [][]string {
 		selectedCommitHash := ""
 
-		if c.CurrentContext().GetKey() == LOCAL_COMMITS_CONTEXT_KEY {
+		if c.Context().Current().GetKey() == LOCAL_COMMITS_CONTEXT_KEY {
 			selectedCommit := viewModel.GetSelected()
 			if selectedCommit != nil {
 				selectedCommitHash = selectedCommit.Hash

pkg/gui/context/menu_context.go

@@ -197,7 +197,7 @@ func (self *MenuContext) OnMenuPress(selectedItem *types.MenuItem) error {
 		return nil
 	}
 
-	if err := self.c.PopContext(); err != nil {
+	if err := self.c.Context().Pop(); err != nil {
 		return err
 	}
 

pkg/gui/context/parent_context_mgr.go

@@ -4,17 +4,14 @@ import "github.com/jesseduffield/lazygit/pkg/gui/types"
 
 type ParentContextMgr struct {
 	ParentContext types.Context
-	// we can't know on the calling end whether a Context is actually a nil value without reflection, so we're storing this flag here to tell us. There has got to be a better way around this
-	hasParent bool
 }
 
 var _ types.ParentContexter = (*ParentContextMgr)(nil)
 
 func (self *ParentContextMgr) SetParentContext(context types.Context) {
 	self.ParentContext = context
-	self.hasParent = true
 }
 
-func (self *ParentContextMgr) GetParentContext() (types.Context, bool) {
-	return self.ParentContext, self.hasParent
+func (self *ParentContextMgr) GetParentContext() types.Context {
+	return self.ParentContext
 }

pkg/gui/context/patch_explorer_context.go

@@ -53,7 +53,7 @@ func NewPatchExplorerContext(
 		func(selectedLineIdx int) error {
 			ctx.GetMutex().Lock()
 			defer ctx.GetMutex().Unlock()
-			return ctx.NavigateTo(ctx.c.IsCurrentContext(ctx), selectedLineIdx)
+			return ctx.NavigateTo(ctx.c.Context().IsCurrent(ctx), selectedLineIdx)
 		}),
 	)
 

pkg/gui/context/sub_commits_context.go

@@ -47,7 +47,7 @@ func NewSubCommitsContext(
 		}
 
 		selectedCommitHash := ""
-		if c.CurrentContext().GetKey() == SUB_COMMITS_CONTEXT_KEY {
+		if c.Context().Current().GetKey() == SUB_COMMITS_CONTEXT_KEY {
 			selectedCommit := viewModel.GetSelected()
 			if selectedCommit != nil {
 				selectedCommitHash = selectedCommit.Hash

pkg/gui/controllers/commit_description_controller.go

@@ -53,7 +53,7 @@ func (self *CommitDescriptionController) context() *context.CommitMessageContext
 }
 
 func (self *CommitDescriptionController) switchToCommitMessage() error {
-	return self.c.ReplaceContext(self.c.Contexts().CommitMessage)
+	return self.c.Context().Replace(self.c.Contexts().CommitMessage)
 }
 
 func (self *CommitDescriptionController) close() error {

pkg/gui/controllers/commit_message_controller.go

@@ -85,7 +85,7 @@ func (self *CommitMessageController) handleNextCommit() error {
 }
 
 func (self *CommitMessageController) switchToCommitDescription() error {
-	if err := self.c.ReplaceContext(self.c.Contexts().CommitDescription); err != nil {
+	if err := self.c.Context().Replace(self.c.Contexts().CommitDescription); err != nil {
 		return err
 	}
 	return nil

pkg/gui/controllers/commits_files_controller.go

@@ -178,8 +178,8 @@ func (self *CommitFilesController) checkout(node *filetree.CommitFileNode) error
 }
 
 func (self *CommitFilesController) discard(selectedNodes []*filetree.CommitFileNode) error {
-	parentContext, ok := self.c.CurrentContext().GetParentContext()
-	if !ok || parentContext.GetKey() != context.LOCAL_COMMITS_CONTEXT_KEY {
+	parentContext := self.c.Context().Current().GetParentContext()
+	if parentContext == nil || parentContext.GetKey() != context.LOCAL_COMMITS_CONTEXT_KEY {
 		return errors.New(self.c.Tr.CanOnlyDiscardFromLocalCommits)
 	}
 
@@ -354,7 +354,7 @@ func (self *CommitFilesController) enterCommitFile(node *filetree.CommitFileNode
 			}
 		}
 
-		return self.c.PushContext(self.c.Contexts().CustomPatchBuilder, opts)
+		return self.c.Context().Push(self.c.Contexts().CustomPatchBuilder, opts)
 	}
 
 	if self.c.Git().Patch.PatchBuilder.Active() && self.c.Git().Patch.PatchBuilder.To != self.context().GetRef().RefName() {

pkg/gui/controllers/confirmation_controller.go

@@ -49,7 +49,7 @@ func (self *ConfirmationController) GetKeybindings(opts types.KeybindingsOpts) [
 							self.c.UserConfig.Keybinding.Universal.Remove, self.c.UserConfig.Keybinding.Universal.Edit)
 					}
 					self.c.Views().Suggestions.Subtitle = subtitle
-					return self.c.ReplaceContext(self.c.Contexts().Suggestions)
+					return self.c.Context().Replace(self.c.Contexts().Suggestions)
 				}
 				return nil
 			},