Add search term unhighlighting

Preserve the active search while suppressing match highlights until
the next search navigation.

Resolved #1164

Author: noborus

oviewer/action.go

@@ -154,6 +154,11 @@ func (root *Root) toggleStatusLine(context.Context) {
 	}
 }
 
+// unHighlight disables highlighting until the next search.
+func (root *Root) unHighlight(context.Context) {
+	root.undoHighlight = true
+}
+
 // toggleRuler cycles through the ruler types (None, Relative, Absolute) each time it is called.
 func (root *Root) toggleRuler(ctx context.Context) {
 	switch root.Doc.RulerType {

oviewer/keybind.go

@@ -96,6 +96,7 @@ const (
 	actionAlignFormat = "align_format"
 	actionRawFormat   = "raw_format"
 	actionRuler       = "toggle_ruler"
+	actionUnHighlight = "un_highlight"
 	actionStatusLine  = "status_line"
 
 	// Change Display with Input
@@ -227,6 +228,7 @@ func (root *Root) handlers() map[string]func(context.Context) {
 		actionAlignFormat: root.alignFormat,
 		actionRawFormat:   root.rawFormat,
 		actionRuler:       root.toggleRuler,
+		actionUnHighlight: root.unHighlight,
 		actionStatusLine:  root.toggleStatusLine,
 
 		// Change Display with Input
@@ -431,6 +433,7 @@ var keyBindDescriptions = []KeyBindDescription{
 	{Group: GroupChange, Action: actionAlignFormat, Description: "align columns"},
 	{Group: GroupChange, Action: actionRawFormat, Description: "toggle raw output mode"},
 	{Group: GroupChange, Action: actionRuler, Description: "ruler toggle"},
+	{Group: GroupChange, Action: actionUnHighlight, Description: "unhighlight search results until the next search"},
 	{Group: GroupChange, Action: actionStatusLine, Description: "status line toggle"},
 	{Group: GroupChange, Action: actionStyleToggle, Description: "suppress style highlight by number"},
 

oviewer/keydefine.go

@@ -47,6 +47,7 @@ func DefaultKeyBinds() KeyBind {
 		actionRightAlign:     {"alt+a"},
 		actionRuler:          {"alt+shift+F9"},
 		actionWriteOriginal:  {"alt+shift+F8"},
+		actionUnHighlight:    {"ctrl+alt+u"},
 		actionStatusLine:     {"ctrl+F10"},
 
 		// Move actions.

oviewer/oviewer.go

@@ -73,6 +73,8 @@ type Root struct {
 
 	// searchOpt is the search option.
 	searchOpt string
+	// undoHighlight indicates whether highlighting should be undone until the next search.
+	undoHighlight bool
 
 	// message is the message to display.
 	message string

oviewer/prepare_draw.go

@@ -550,6 +550,9 @@ func (root *Root) multiColorHighlight(lineC LineC) {
 // searchHighlight applies the style of the search highlight.
 // Apply style to contents.
 func (root *Root) searchHighlight(lineC LineC) {
+	if root.undoHighlight {
+		return
+	}
 	if root.searcher == nil || root.searcher.String() == "" {
 		return
 	}

oviewer/search.go

@@ -679,12 +679,14 @@ func (root *Root) sendFirstSearch(value string, t searchType) {
 
 // forwardSearch performs the forward search.
 func (root *Root) forwardSearch(ctx context.Context, str string, next int) {
+	root.undoHighlight = false
 	searcher := root.setSearcher(str, root.Config.CaseSensitive)
 	root.searchMove(ctx, true, root.startSearchLN()+next, searcher)
 }
 
 // backSearch performs the back search.
 func (root *Root) backSearch(ctx context.Context, str string, next int) {
+	root.undoHighlight = false
 	searcher := root.setSearcher(str, root.Config.CaseSensitive)
 	root.searchMove(ctx, false, root.startSearchLN()+next, searcher)
 }