Add editor::FileBrowser

- Rename `BrowseGltf` to `FileBrowser`.
- Incorporate "*.skybox" into browsers and drops.
- Use `string_view` for events.

Author: karnkaul

lib/engine/CMakeLists.txt

@@ -43,6 +43,7 @@ target_sources(${PROJECT_NAME} PRIVATE
   include/${target_prefix}/engine/editor/browse_file.hpp
   include/${target_prefix}/engine/editor/common.hpp
   include/${target_prefix}/engine/editor/drag_drop_id.hpp
+  include/${target_prefix}/engine/editor/file_browser.hpp
   include/${target_prefix}/engine/editor/inspector.hpp
   include/${target_prefix}/engine/editor/log.hpp
   include/${target_prefix}/engine/editor/reflector.hpp
@@ -54,6 +55,7 @@ target_sources(${PROJECT_NAME} PRIVATE
 
   src/editor/browse_file.cpp
   src/editor/common.cpp
+  src/editor/file_browser.cpp
   src/editor/inspector.cpp
   src/editor/log.cpp
   src/editor/reflector.cpp

lib/engine/include/facade/engine/editor/file_browser.hpp

@@ -0,0 +1,31 @@
+#pragma once
+#include <facade/engine/editor/browse_file.hpp>
+
+namespace facade::editor {
+///
+/// \brief Persistent modal pop up to browse for a file given a list of extensions.
+///
+/// Uses Modal and BrowseFile.
+///
+class FileBrowser {
+  public:
+	struct Result {
+		std::string selected{};
+		std::string_view browse_path{};
+		bool path_changed{};
+	};
+
+	FileBrowser(std::string label, std::vector<std::string> extensions, std::string browse_path);
+
+	Result update(bool& out_trigger);
+
+	std::vector<std::string> extensions;
+
+  private:
+	std::string m_browse_path;
+	std::string m_label;
+	std::vector<std::string_view> m_extensions_view{};
+	env::DirEntries m_dir_entries{};
+	bool m_trigger{};
+};
+} // namespace facade::editor

lib/engine/src/editor/browse_file.cpp

@@ -2,6 +2,7 @@
 #include <imgui.h>
 #include <facade/engine/editor/browse_file.hpp>
 #include <facade/util/env.hpp>
+#include <facade/util/fixed_string.hpp>
 #include <filesystem>
 
 namespace facade::editor {
@@ -75,6 +76,16 @@ auto BrowseFile::operator()(NotClosed<Popup> popup, std::string& out_path) -> Re
 		if (ImGui::Button("Downloads")) { cd(std::move(downloads)); }
 	}
 
+	ImGui::Separator();
+	auto exts = FixedString{};
+	if (extensions.empty()) {
+		exts = "*.*";
+	} else {
+		exts = FixedString{"*{}", extensions[0]};
+		for (auto it = std::next(extensions.begin()); it != extensions.end(); ++it) { exts += FixedString{", *{}", *it}; }
+	}
+	ImGui::Text("%s", exts.c_str());
+
 	ImGui::Separator();
 	if (auto window = editor::Window{popup, "File Tree"}) {
 		env::GetDirEntries{.extensions = extensions}(out_entries, out_path.c_str());

lib/engine/src/editor/file_browser.cpp

@@ -0,0 +1,29 @@
+#include <imgui.h>
+#include <facade/engine/editor/file_browser.hpp>
+
+namespace facade::editor {
+FileBrowser::FileBrowser(std::string label, std::vector<std::string> extensions, std::string browse_path)
+	: extensions(std::move(extensions)), m_browse_path(std::move(browse_path)), m_label(std::move(label)) {
+	if (m_label.empty()) { m_label = "Browse..."; }
+}
+
+auto FileBrowser::update(bool& out_trigger) -> Result {
+	auto ret = Result{};
+	if (out_trigger && !ImGui::IsPopupOpen(m_label.c_str())) { Modal::open(m_label.c_str()); }
+	out_trigger = false;
+	if (ImGui::IsPopupOpen(m_label.c_str())) { ImGui::SetNextWindowSize({400.0f, 250.0f}, ImGuiCond_FirstUseEver); }
+	if (auto popup = Modal{m_label.c_str()}) {
+		m_extensions_view.clear();
+		m_extensions_view.reserve(extensions.size());
+		for (auto const& extension : extensions) { m_extensions_view.push_back(extension); }
+		auto [selected, changed] = BrowseFile{.out_entries = m_dir_entries, .extensions = m_extensions_view}(popup, m_browse_path);
+		ret.path_changed = changed;
+		ret.browse_path = m_browse_path;
+		if (!selected.empty()) {
+			popup.close_current();
+			ret.selected = std::move(selected);
+		}
+	}
+	return ret;
+}
+} // namespace facade::editor

src/gui/events.hpp

@@ -1,16 +1,16 @@
 #pragma once
-#include <string>
+#include <string_view>
 
 namespace facade::event {
 struct Shutdown {};
 struct OpenRecent {
-	std::string path{};
+	std::string_view path{};
 };
 struct OpenFile {};
 struct BrowseCd {
-	std::string path{};
+	std::string_view path{};
 };
 struct FileDrop {
-	std::string path{};
+	std::string_view path{};
 };
 } // namespace facade::event

src/gui/gltf_sources.cpp

@@ -10,39 +10,29 @@ namespace facade {
 namespace {
 namespace fs = std::filesystem;
 
-fs::path find_gltf(fs::path root) {
-	if (root.extension() == ".gltf") { return root; }
+fs::path find_file_with_ext(fs::path root, env::MatchList exts) {
+	auto const match = [exts](std::string_view ext) { return std::any_of(exts.begin(), exts.end(), [ext](std::string_view rhs) { return ext == rhs; }); };
+	if (match(root.extension().string())) { return root; }
 	if (!fs::is_directory(root)) { return {}; }
 	for (auto const& it : fs::directory_iterator{root}) {
 		if (!it.is_regular_file()) { continue; }
 		auto path = it.path();
-		if (path.extension() == ".gltf") { return path; }
+		if (match(path.extension().string())) { return path; }
 	}
 	return {};
 }
 } // namespace
 
-BrowseGltf::BrowseGltf(std::shared_ptr<Events> const& events, std::string browse_path)
-	: m_events(events), m_observer(events, [this](event::OpenFile) { m_trigger = true; }), m_browse_path(std::move(browse_path)) {}
+FileBrowser::FileBrowser(std::shared_ptr<Events> const& events, std::string browse_path)
+	: m_events(events), m_observer(events, [this](event::OpenFile) { m_trigger = true; }),
+	  m_browser("Browse...", {".gltf", ".skybox"}, std::move(browse_path)) {}
 
-std::string BrowseGltf::update() {
-	if (m_trigger) {
-		editor::Popup::open("Browse...");
-		m_trigger = false;
+std::string FileBrowser::update() {
+	auto result = m_browser.update(m_trigger);
+	if (result.path_changed) {
+		if (auto events = m_events.lock()) { events->dispatch(event::BrowseCd{result.browse_path}); }
 	}
-	if (ImGui::IsPopupOpen("Browse...")) { ImGui::SetNextWindowSize({400.0f, 250.0f}, ImGuiCond_FirstUseEver); }
-	if (auto popup = editor::Modal{"Browse..."}) {
-		static constexpr std::string_view gltf_ext_v[] = {".gltf"};
-		auto [selected, dir_changed] = editor::BrowseFile{.out_entries = m_dir_entries, .extensions = gltf_ext_v}(popup, m_browse_path);
-		if (dir_changed) {
-			if (auto events = m_events.lock()) { events->dispatch(event::BrowseCd{m_browse_path}); }
-		}
-		if (!selected.empty()) {
-			popup.close_current();
-			return selected;
-		}
-	}
-	return {};
+	return std::move(result.selected);
 }
 
 OpenRecent::OpenRecent(std::shared_ptr<Events> const& events) : m_observer(events, [this](event::OpenRecent const& recent) { m_path = recent.path; }) {}
@@ -53,11 +43,12 @@ DropFile::DropFile(std::shared_ptr<Events> const& events) : m_observer(events, [
 
 std::string DropFile::update() {
 	if (m_path.empty()) { return {}; }
-	if (auto ret = find_gltf(m_path); fs::is_regular_file(ret)) {
+	static constexpr std::string_view exts_v[] = {".gltf", ".skybox"};
+	if (auto ret = find_file_with_ext(m_path, exts_v); fs::is_regular_file(ret)) {
 		m_path.clear();
 		return ret.generic_string();
 	}
-	logger::error("Failed to locate .gltf in path: [{}]", m_path);
+	logger::error("Failed to locate .gltf / .skybox in path: [{}]", m_path);
 	m_path.clear();
 	return {};
 }

src/gui/gltf_sources.hpp

@@ -1,19 +1,19 @@
 #pragma once
 #include <events/events.hpp>
+#include <facade/engine/editor/file_browser.hpp>
 #include <facade/util/env.hpp>
 #include <gui/events.hpp>
 #include <gui/path_source.hpp>
 
 namespace facade {
-class BrowseGltf : public PathSource {
+class FileBrowser : public PathSource {
   public:
-	BrowseGltf(std::shared_ptr<Events> const& events, std::string browse_path);
+	FileBrowser(std::shared_ptr<Events> const& events, std::string browse_path);
 
   private:
 	std::weak_ptr<Events> m_events;
 	Observer<event::OpenFile> m_observer;
-	env::DirEntries m_dir_entries{};
-	std::string m_browse_path{};
+	editor::FileBrowser m_browser;
 	bool m_trigger{};
 
 	std::string update() final;

src/main.cpp

@@ -20,6 +20,7 @@
 
 #include <imgui.h>
 
+#include <charconv>
 #include <filesystem>
 #include <iostream>
 
@@ -113,7 +114,7 @@ void run(AppOpts const& opts) {
 
 	auto path_sources = PathSource::List{};
 	path_sources.sources.push_back(std::make_unique<DropFile>(events));
-	path_sources.sources.push_back(std::make_unique<BrowseGltf>(events, config.config.file_menu.browse_path));
+	path_sources.sources.push_back(std::make_unique<FileBrowser>(events, config.config.file_menu.browse_path));
 	path_sources.sources.push_back(std::make_unique<OpenRecent>(events));
 
 	auto quit = Observer<event::Shutdown>{events, [&engine](event::Shutdown) { engine->request_stop(); }};
@@ -156,7 +157,14 @@ void run(AppOpts const& opts) {
 			window_menu.display_menu(menu);
 			window_menu.display_windows(*engine);
 
-			if (auto path = path_sources.update(); !path.empty()) { load_async(std::move(path)); }
+			if (auto path = path_sources.update(); !path.empty()) {
+				auto const ext = fs::path{path}.extension().string();
+				if (ext == ".gltf") {
+					load_async(std::move(path));
+				} else {
+					logger::warn("Unrecognized path: {}", path);
+				}
+			}
 		}
 
 		config.update(*engine);
@@ -179,16 +187,14 @@ void run(AppOpts const& opts) {
 	}
 }
 
-std::optional<std::uint32_t> to_u32(std::string const& s) {
-	try {
-		int i = std::stoi(s);
-		if (i < 0) {
-			logger::error("Invalid value: {}", i);
-			return {};
-		}
-		return static_cast<std::uint32_t>(i);
-	} catch (std::exception const& e) { logger::error("Invalid value: {} ({})", s, e.what()); }
-	return {};
+std::optional<std::uint32_t> to_u32(std::string_view const s) {
+	auto ret = std::uint32_t{};
+	auto [_, ec] = std::from_chars(s.data(), s.data() + s.size(), ret);
+	if (ec != std::errc{}) {
+		logger::error("Invalid value: {}", s);
+		return {};
+	}
+	return ret;
 }
 } // namespace