ListCursor: add flag "highlight_cursor"

On text-only pages without a cursor, don't center the line which was found; instead, show the cursor temporarily.
MusicPlayerDaemon · Feb 1, 2021 · 2bbc11d · 2bbc11d
1 parent 666485b
commit 2bbc11d
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 7 deletions.
diff --git a/NEWS b/NEWS
@@ -1,5 +1,6 @@
 ncmpc 0.44 - not yet released
 * fix scrolling problems on help page
+* highlight find results on help page
 * don't attempt IPv6 connection if IPv6 routing is disabled
 
 ncmpc 0.43 - (2021-01-27)

diff --git a/src/HelpPage.cxx b/src/HelpPage.cxx
@@ -319,8 +319,6 @@ HelpPage::OnCommand(struct mpdclient &c, Command cmd)
 
 	lw.SetCursorFromOrigin(0);
 	if (screen_find(screen, lw, cmd, *this)) {
-		/* center the row */
-		lw.Center(lw.GetCursorIndex());
 		SetDirty();
 		return true;
 	}

diff --git a/src/ListCursor.cxx b/src/ListCursor.cxx
@@ -30,6 +30,7 @@ ListCursor::Reset() noexcept
 {
 	selected = 0;
 	range_selection = false;
+	highlight_cursor = false;
 	range_base = 0;
 	start = 0;
 }
@@ -78,6 +79,8 @@ ListCursor::SetLength(unsigned _length) noexcept
 void
 ListCursor::Center(unsigned n) noexcept
 {
+	highlight_cursor = false;
+
 	if (n > GetHeight() / 2)
 		start = n - GetHeight() / 2;
 	else
@@ -94,6 +97,8 @@ ListCursor::Center(unsigned n) noexcept
 void
 ListCursor::ScrollTo(unsigned n) noexcept
 {
+	highlight_cursor = false;
+
 	int new_start = start;
 
 	if (n < start + scroll_offset)
@@ -125,6 +130,7 @@ void
 ListCursor::MoveCursor(unsigned n) noexcept
 {
 	selected = n;
+	highlight_cursor = false;
 
 	CheckSelected();
 	CheckOrigin();
@@ -226,6 +232,8 @@ ListCursor::MoveCursorLast() noexcept
 void
 ListCursor::MoveCursorNextPage() noexcept
 {
+	highlight_cursor = false;
+
 	if (GetHeight() < 2)
 		return;
 	if (selected + GetHeight() < length)
@@ -237,6 +245,8 @@ ListCursor::MoveCursorNextPage() noexcept
 void
 ListCursor::MoveCursorPreviousPage() noexcept
 {
+	highlight_cursor = false;
+
 	if (GetHeight() < 2)
 		return;
 	if (selected > GetHeight() - 1)
@@ -248,6 +258,8 @@ ListCursor::MoveCursorPreviousPage() noexcept
 void
 ListCursor::ScrollUp(unsigned n) noexcept
 {
+	highlight_cursor = false;
+
 	if (start > 0) {
 		if (n > start)
 			start = 0;
@@ -261,6 +273,8 @@ ListCursor::ScrollUp(unsigned n) noexcept
 void
 ListCursor::ScrollDown(unsigned n) noexcept
 {
+	highlight_cursor = false;
+
 	if (start + GetHeight() < length) {
 		if (start + GetHeight() + n > length - 1)
 			start = length - GetHeight();
@@ -274,6 +288,8 @@ ListCursor::ScrollDown(unsigned n) noexcept
 void
 ListCursor::ScrollNextPage() noexcept
 {
+	highlight_cursor = false;
+
 	start += GetHeight();
 	if (start + GetHeight() > length)
 		start = length > GetHeight()
@@ -284,6 +300,8 @@ ListCursor::ScrollNextPage() noexcept
 void
 ListCursor::ScrollPreviousPage() noexcept
 {
+	highlight_cursor = false;
+
 	start = start > GetHeight()
 		? start - GetHeight()
 		: 0;
@@ -292,6 +310,8 @@ ListCursor::ScrollPreviousPage() noexcept
 void
 ListCursor::ScrollNextHalfPage() noexcept
 {
+	highlight_cursor = false;
+
 	start += (GetHeight() - 1) / 2;
 	if (start + GetHeight() > length) {
 		start = length > GetHeight()
@@ -303,6 +323,8 @@ ListCursor::ScrollNextHalfPage() noexcept
 void
 ListCursor::ScrollPreviousHalfPage() noexcept
 {
+	highlight_cursor = false;
+
 	start = start > (GetHeight() - 1) / 2
 		? start - (GetHeight() - 1) / 2
 		: 0;

diff --git a/src/ListCursor.hxx b/src/ListCursor.hxx
@@ -104,6 +104,11 @@ class ListCursor {
 
 	bool show_cursor = true;
 
+	/**
+	 * @see HighlightCursor()
+	 */
+	bool highlight_cursor = false;
+
 public:
 	explicit ListCursor(unsigned _height) noexcept;
 
@@ -131,10 +136,23 @@ public:
 		show_cursor = true;
 	}
 
+	/**
+	 * Make the cursor visible temporarily (until it is moved)?
+	 * This is useful for highlighting a matching line after
+	 * searching in a (cursorless) text page.
+	 */
+	void HighlightCursor() noexcept {
+		highlight_cursor = true;
+	}
+
 	constexpr bool HasCursor() const noexcept {
 		return show_cursor;
 	}
 
+	constexpr bool IsCursorVisible() const noexcept {
+		return show_cursor || highlight_cursor;
+	}
+
 	constexpr bool HasRangeSelection() const noexcept {
 		return range_selection;
 	}

diff --git a/src/ListWindow.cxx b/src/ListWindow.cxx
@@ -33,7 +33,7 @@
 void
 ListWindow::Paint(const ListRenderer &renderer) const noexcept
 {
-	bool cursor_visible = HasCursor() &&
+	bool cursor_visible = IsCursorVisible() &&
 		(!options.hardware_cursor || HasRangeSelection());
 	ListWindowRange range;
 
@@ -87,6 +87,7 @@ ListWindow::Find(const ListText &text,
 
 			if (m(label)) {
 				MoveCursor(i);
+				HighlightCursor();
 				return true;
 			}
 			if (wrap && i == GetCursorIndex())
@@ -133,6 +134,7 @@ ListWindow::ReverseFind(const ListText &text,
 
 			if (m(label)) {
 				MoveCursor(i);
+				HighlightCursor();
 				return true;
 			}
 			if (wrap && i == (int)GetCursorIndex())
@@ -168,6 +170,7 @@ ListWindow::Jump(const ListText &text, const char *str) noexcept
 
 		if (m(label)) {
 			MoveCursor(i);
+			HighlightCursor();
 			return true;
 		}
 	}

diff --git a/src/SongPage.cxx b/src/SongPage.cxx
@@ -549,8 +549,6 @@ SongPage::OnCommand(struct mpdclient &c, Command cmd)
 	}
 
 	if (screen_find(screen, lw, cmd, *this)) {
-		/* center the row */
-		lw.Center(lw.GetCursorIndex());
 		SetDirty();
 		return true;
 	}

diff --git a/src/TextPage.cxx b/src/TextPage.cxx
@@ -90,8 +90,6 @@ TextPage::OnCommand(struct mpdclient &c, Command cmd)
 
 	lw.SetCursorFromOrigin(0);
 	if (screen_find(screen, lw, cmd, *this)) {
-		/* center the row */
-		lw.Center(lw.GetCursorIndex());
 		SetDirty();
 		return true;
 	}