ListText: GetListItemText() returns std::string_view

MusicPlayerDaemon · Aug 31, 2024 · adeb34b · adeb34b
1 parent 0cff5fa
commit adeb34b
Show file tree

Hide file tree

Showing 15 changed files with 73 additions and 69 deletions.
diff --git a/src/FileListPage.cxx b/src/FileListPage.cxx
@@ -27,6 +27,8 @@
 
 #include <string.h>
 
+using std::string_view_literals::operator""sv;
+
 #define BUFSIZE 1024
 
 #ifndef NCMPC_MINI
@@ -67,7 +69,7 @@ screen_browser_sync_highlights(FileList &fl, const MpdQueue &playlist) noexcept
 
 #endif
 
-const char *
+std::string_view
 FileListPage::GetListItemText(std::span<char> buffer,
 			      unsigned idx) const noexcept
 {
@@ -78,7 +80,7 @@ FileListPage::GetListItemText(std::span<char> buffer,
 	const auto *entity = entry.entity;
 
 	if( entity == nullptr )
-		return "..";
+		return ".."sv;
 
 	if (mpd_entity_get_type(entity) == MPD_ENTITY_TYPE_DIRECTORY) {
 		const auto *dir = mpd_entity_get_directory(entity);
@@ -87,15 +89,14 @@ FileListPage::GetListItemText(std::span<char> buffer,
 	} else if (mpd_entity_get_type(entity) == MPD_ENTITY_TYPE_SONG) {
 		const auto *song = mpd_entity_get_song(entity);
 
-		strfsong(buffer, options.list_format.c_str(), song);
-		return buffer.data();
+		return strfsong(buffer, options.list_format.c_str(), song);
 	} else if (mpd_entity_get_type(entity) == MPD_ENTITY_TYPE_PLAYLIST) {
 		const auto *playlist = mpd_entity_get_playlist(entity);
 		const char *name = GetUriFilename(mpd_playlist_get_path(playlist));
 		return utf8_to_locale(name, buffer);
 	}
 
-	return "Error: Unknown entry!";
+	return "Error: Unknown entry!"sv;
 }
 
 static bool
@@ -485,7 +486,7 @@ screen_browser_paint_directory(const Window window, unsigned width,
 
 static void
 screen_browser_paint_playlist(const Window window, unsigned width,
-			      bool selected, const char *name) noexcept
+			      bool selected, std::string_view name) noexcept
 {
 	row_paint_text(window, width, Style::PLAYLIST, selected, name);
 }

diff --git a/src/FileListPage.hxx b/src/FileListPage.hxx
@@ -63,8 +63,8 @@ private:
 			   bool selected) const noexcept final;
 
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 
 public:
 	/* virtual methods from class Page */

diff --git a/src/HelpPage.cxx b/src/HelpPage.cxx
@@ -222,8 +222,8 @@ class HelpPage final : public ListPage, ListRenderer, ListText {
 			   bool selected) const noexcept override;
 
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 
 	/* virtual methods from class Page */
 	void Paint() const noexcept override;
@@ -234,7 +234,7 @@ class HelpPage final : public ListPage, ListRenderer, ListText {
 	}
 };
 
-const char *
+std::string_view
 HelpPage::GetListItemText(std::span<char>, unsigned i) const noexcept
 {
 	const auto *row = &help_text[i];
@@ -247,7 +247,7 @@ HelpPage::GetListItemText(std::span<char>, unsigned i) const noexcept
 	if (row->command != Command::NONE)
 		return get_key_description(row->command);
 
-	return "";
+	return {};
 }
 
 static std::unique_ptr<Page>

diff --git a/src/KeyDefPage.cxx b/src/KeyDefPage.cxx
@@ -21,6 +21,8 @@
 #include <errno.h>
 #include <string.h>
 
+using std::string_view_literals::operator""sv;
+
 class CommandKeysPage final : public ListPage, ListText {
 	ScreenManager &screen;
 	Page *const parent;
@@ -112,8 +114,8 @@ class CommandKeysPage final : public ListPage, ListText {
 
 private:
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 };
 
 /* TODO: rename to check_n_keys / subcmd_count_keys? */
@@ -202,25 +204,25 @@ CommandKeysPage::AddKey()
 		OverwriteKey(n_keys);
 }
 
-const char *
+std::string_view
 CommandKeysPage::GetListItemText(std::span<char> buffer,
 				 unsigned idx) const noexcept
 {
 	if (idx == GetLeavePosition())
-		return "[..]";
+		return "[..]"sv;
 
 	if (idx == GetAddPosition()) {
-		snprintf(buffer.data(), buffer.size(), "%d. %s", idx, _("Add new key"));
-		return buffer.data();
+		std::size_t length = snprintf(buffer.data(), buffer.size(), "%d. %s", idx, _("Add new key"));
+		return {buffer.data(), length};
 	}
 
 	assert(IsKeyPosition(idx));
 
-	snprintf(buffer.data(), buffer.size(),
-		 "%d. %-20s   (%d) ", idx,
-		 GetLocalizedKeyName(binding->keys[PositionToKeyIndex(idx)]),
-		 binding->keys[PositionToKeyIndex(idx)]);
-	return buffer.data();
+	std::size_t length = snprintf(buffer.data(), buffer.size(),
+				      "%d. %-20s   (%d) ", idx,
+				      GetLocalizedKeyName(binding->keys[PositionToKeyIndex(idx)]),
+				      binding->keys[PositionToKeyIndex(idx)]);
+	return {buffer.data(), length};
 }
 
 void
@@ -352,8 +354,8 @@ class CommandListPage final : public ListPage, ListText {
 
 private:
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 };
 
 bool
@@ -407,7 +409,7 @@ CommandListPage::Save()
 	fclose(f);
 }
 
-const char *
+std::string_view
 CommandListPage::GetListItemText(std::span<char> buffer,
 				 unsigned idx) const noexcept
 {
@@ -432,11 +434,11 @@ CommandListPage::GetListItemText(std::span<char> buffer,
 	if (len < get_cmds_max_name_width())
 		memset(buffer.data() + len, ' ', get_cmds_max_name_width() - len);
 
-	snprintf(buffer.data() + get_cmds_max_name_width(),
-		 buffer.size() - get_cmds_max_name_width(),
-		 " - %s", my_gettext(get_command_definitions()[idx].description));
+	std::size_t length = snprintf(buffer.data() + get_cmds_max_name_width(),
+				      buffer.size() - get_cmds_max_name_width(),
+				      " - %s", my_gettext(get_command_definitions()[idx].description));
 
-	return buffer.data();
+	return {buffer.data(), length};
 }
 
 void

diff --git a/src/ListText.hxx b/src/ListText.hxx
@@ -4,13 +4,14 @@
 #pragma once
 
 #include <span>
+#include <string_view>
 
 class ListText {
 public:
 	/**
 	 * @return the text in the locale charset
 	 */
 	[[gnu::pure]]
-	virtual const char *GetListItemText(std::span<char> buffer,
-					    unsigned i) const noexcept = 0;
+	virtual std::string_view GetListItemText(std::span<char> buffer,
+						 unsigned i) const noexcept = 0;
 };
diff --git a/src/ListWindow.cxx b/src/ListWindow.cxx
@@ -65,8 +65,7 @@ ListWindow::Find(const ListText &text,
 	do {
 		while (i < GetLength()) {
 			char buffer[1024];
-			const char *label = text.GetListItemText(buffer, i);
-			assert(label != nullptr);
+			const std::string_view label = text.GetListItemText(buffer, i);
 
 			if (m(label)) {
 				MoveCursor(i);
@@ -110,8 +109,7 @@ ListWindow::ReverseFind(const ListText &text,
 	do {
 		while (i >= 0) {
 			char buffer[1024];
-			const char *label = text.GetListItemText(buffer, i);
-			assert(label != nullptr);
+			const std::string_view label = text.GetListItemText(buffer, i);
 
 			if (m(label)) {
 				MoveCursor(i);
@@ -144,8 +142,7 @@ ListWindow::Jump(const ListText &text, const char *str) noexcept
 
 	for (unsigned i = 0; i < GetLength(); i++) {
 		char buffer[1024];
-		const char *label = text.GetListItemText(buffer, i);
-		assert(label != nullptr);
+		const std::string_view label = text.GetListItemText(buffer, i);
 
 		if (m(label)) {
 			MoveCursor(i);

diff --git a/src/QueuePage.cxx b/src/QueuePage.cxx
@@ -114,8 +114,8 @@ class QueuePage final : public ListPage, ListRenderer, ListText {
 			   bool selected) const noexcept override;
 
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 
 public:
 	/* virtual methods from class Page */
@@ -179,7 +179,7 @@ QueuePage::RestoreSelection()
 	SaveSelection();
 }
 
-const char *
+std::string_view 
 QueuePage::GetListItemText(std::span<char> buffer,
 			   unsigned idx) const noexcept
 {

diff --git a/src/SearchPage.cxx b/src/SearchPage.cxx
@@ -125,25 +125,27 @@ class SearchPage final : public FileListPage {
 class SearchHelpText final : public ListText {
 public:
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned idx) const noexcept override {
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned idx) const noexcept override {
 		assert(idx < std::size(help_text));
 
 		if (idx == 0) {
-			snprintf(buffer.data(), buffer.size(),
-				 " %s : %s",
-				 GetGlobalKeyBindings().GetKeyNames(Command::SCREEN_SEARCH).c_str(),
-				 "New search");
-			return buffer.data();
+			std::size_t length =
+				snprintf(buffer.data(), buffer.size(),
+					 " %s : %s",
+					 GetGlobalKeyBindings().GetKeyNames(Command::SCREEN_SEARCH).c_str(),
+					 "New search");
+			return {buffer.data(), length};
 		}
 
 		if (idx == 1) {
-			snprintf(buffer.data(), buffer.size(),
-				 " %s : %s [%s]",
-				 GetGlobalKeyBindings().GetKeyNames(Command::SEARCH_MODE).c_str(),
-				 get_key_description(Command::SEARCH_MODE),
-				 my_gettext(mode[options.search_mode].label));
-			return buffer.data();
+			std::size_t length =
+				snprintf(buffer.data(), buffer.size(),
+					 " %s : %s [%s]",
+					 GetGlobalKeyBindings().GetKeyNames(Command::SEARCH_MODE).c_str(),
+					 get_key_description(Command::SEARCH_MODE),
+					 my_gettext(mode[options.search_mode].label));
+			return {buffer.data(), length};
 		}
 
 		return help_text[idx];

diff --git a/src/SongPage.cxx b/src/SongPage.cxx
@@ -145,8 +145,8 @@ class SongPage final : public ListPage, ListText {
 
 private:
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 };
 
 void
@@ -164,10 +164,10 @@ SongPage::Clear() noexcept
 	}
 }
 
-const char *
+std::string_view
 SongPage::GetListItemText(std::span<char>, unsigned idx) const noexcept
 {
-	return lines[idx].c_str();
+	return lines[idx];
 }
 
 static std::unique_ptr<Page>

diff --git a/src/TagListPage.cxx b/src/TagListPage.cxx
@@ -16,6 +16,8 @@
 #include <assert.h>
 #include <string.h>
 
+using std::string_view_literals::operator""sv;
+
 TagFilter
 TagListPage::MakeCursorFilter() const noexcept
 {
@@ -40,13 +42,13 @@ CompareUTF8(const std::string &a, const std::string &b)
 	return CollateUTF8(a.c_str(), b.c_str()) < 0;
 }
 
-const char *
+std::string_view
 TagListPage::GetListItemText(std::span<char> buffer,
 			     unsigned idx) const noexcept
 {
 	if (parent != nullptr) {
 		if (idx == 0)
-			return "..";
+			return ".."sv;
 
 		--idx;
 	}

diff --git a/src/TagListPage.hxx b/src/TagListPage.hxx
@@ -105,6 +105,6 @@ public:
 			   bool selected) const noexcept override;
 
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 };
diff --git a/src/TextListRenderer.cxx b/src/TextListRenderer.cxx
@@ -9,7 +9,7 @@
 
 static void
 list_window_paint_row(const Window window, unsigned width, bool selected,
-		      const char *text) noexcept
+		      std::string_view text) noexcept
 {
 	row_paint_text(window, width, Style::LIST,
 		       selected, text);
@@ -20,8 +20,7 @@ TextListRenderer::PaintListItem(const Window window, unsigned i, unsigned,
 				unsigned width, bool selected) const noexcept
 {
 	char buffer[1024];
-	const char *label = text.GetListItemText(buffer, i);
-	assert(label != nullptr);
+	const std::string_view label = text.GetListItemText(buffer, i);
 
 	list_window_paint_row(window, width, selected, label);
 }
diff --git a/src/TextPage.cxx b/src/TextPage.cxx
@@ -53,7 +53,7 @@ TextPage::Append(const char *str) noexcept
 	lw.SetLength(lines.size());
 }
 
-const char *
+std::string_view
 TextPage::GetListItemText(std::span<char> buffer, unsigned idx) const noexcept
 {
 	assert(idx < lines.size());

diff --git a/src/TextPage.hxx b/src/TextPage.hxx
@@ -63,6 +63,6 @@ public:
 
 private:
 	/* virtual methods from class ListText */
-	const char *GetListItemText(std::span<char> buffer,
-				    unsigned i) const noexcept override;
+	std::string_view GetListItemText(std::span<char> buffer,
+					 unsigned i) const noexcept override;
 };
diff --git a/src/paint.hxx b/src/paint.hxx
@@ -52,7 +52,7 @@ row_clear_to_eol(const Window window, unsigned width, bool selected) noexcept
 static inline void
 row_paint_text(const Window window, unsigned width,
 	       Style style, bool selected,
-	       const char *text) noexcept
+	       std::string_view text) noexcept
 {
 	row_color(window, style, selected);