Add File > Open... and browse modal (#59)

* WIP: Add env; Browse / Open File dialog for .gltf

* Add BrowseFile, move logic from main

* Interactive current path in File > Open

- Show drop-down listing parent paths recursively.
- Dynamically trim long paths to the form `.../current/path`.
- Move `Popup` ownership to user of `BrowseFile`.
- Fix window sizing.

Author: karnkaul

lib/engine/CMakeLists.txt

@@ -40,6 +40,7 @@ target_sources(${PROJECT_NAME} PRIVATE
   include/${target_prefix}/engine/engine.hpp
   include/${target_prefix}/engine/scene_renderer.hpp
 
+  include/${target_prefix}/engine/editor/browse_file.hpp
   include/${target_prefix}/engine/editor/common.hpp
   include/${target_prefix}/engine/editor/inspector.hpp
   include/${target_prefix}/engine/editor/log.hpp
@@ -48,6 +49,7 @@ target_sources(${PROJECT_NAME} PRIVATE
   src/scene_renderer.cpp
   src/engine.cpp
 
+  src/editor/browse_file.cpp
   src/editor/common.cpp
   src/editor/inspector.cpp
   src/editor/log.cpp

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

@@ -0,0 +1,13 @@
+#pragma once
+#include <facade/engine/editor/common.hpp>
+#include <facade/util/env.hpp>
+
+namespace facade::editor {
+struct BrowseFile {
+	env::DirEntries& out_entries;
+	env::MatchList extensions{};
+	float parent_indent{5.0f};
+
+	std::string operator()(NotClosed<Popup> popup, std::string& out_path);
+};
+} // namespace facade::editor

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

@@ -35,15 +35,20 @@ struct NotClosed {
 	NotClosed(NotClosed<Derived>) {}
 };
 
+class Canvas : public Openable {
+  protected:
+	using Openable::Openable;
+};
+
 ///
 /// \brief RAII Dear ImGui window
 ///
-class Window : public Openable {
+class Window : public Canvas {
   public:
 	class Menu;
 
 	explicit Window(char const* label, bool* open_if = {}, int flags = {});
-	Window(NotClosed<Window> parent, char const* label, glm::vec2 size = {}, Bool border = {}, int flags = {});
+	Window(NotClosed<Canvas> parent, char const* label, glm::vec2 size = {}, Bool border = {}, int flags = {});
 	~Window();
 
   private:
@@ -83,7 +88,7 @@ class Menu : public Openable {
 ///
 class Window::Menu : public MenuBar {
   public:
-	explicit Menu(NotClosed<Window>);
+	explicit Menu(NotClosed<Canvas>);
 	~Menu();
 };
 
@@ -99,24 +104,24 @@ class MainMenu : public MenuBar {
 ///
 /// \brief RAII Dear ImGui Popup
 ///
-class Popup : public Openable {
+class Popup : public Canvas {
   public:
-	explicit Popup(char const* id, Bool centered = {}, int flags = {}) : Popup(id, {}, centered, flags) {}
+	explicit Popup(char const* id, Bool centered = {}, int flags = {}) : Popup(id, {}, {}, centered, flags) {}
 	~Popup();
 
 	static void open(char const* id);
 	static void close_current();
 
   protected:
-	explicit Popup(char const* id, Bool modal, Bool centered, int flags);
+	explicit Popup(char const* id, Bool modal, Bool closeable, Bool centered, int flags);
 };
 
 ///
 /// \brief RAII Dear ImGui PopupModal
 ///
 class Modal : public Popup {
   public:
-	explicit Modal(char const* id, Bool centered = {true}, int flags = {}) : Popup(id, {true}, centered, flags) {}
+	explicit Modal(char const* id, Bool centered = {true}, Bool closeable = {true}, int flags = {}) : Popup(id, {true}, closeable, centered, flags) {}
 };
 
 ///

lib/engine/src/editor/browse_file.cpp

@@ -0,0 +1,87 @@
+#include <fmt/format.h>
+#include <imgui.h>
+#include <facade/engine/editor/browse_file.hpp>
+#include <facade/util/env.hpp>
+#include <filesystem>
+
+namespace facade::editor {
+namespace fs = std::filesystem;
+
+namespace {
+constexpr bool drop_leading_dir(std::string_view& out) {
+	if (!out.empty() && out[0] == '/') { out = out.substr(1); }
+	if (auto const i = out.find_first_of('/'); i != std::string_view::npos) {
+		out = out.substr(i + 1);
+		return true;
+	}
+	return false;
+}
+
+std::string truncate(std::string_view in, std::size_t limit) {
+	if (in.size() <= limit) { return std::string{in}; }
+	while (in.size() + 4 > limit && drop_leading_dir(in))
+		;
+	return fmt::format(".../{}", in);
+}
+} // namespace
+
+std::string BrowseFile::operator()(NotClosed<Popup> popup, std::string& out_path) {
+	auto const fs_path = [&] {
+		auto ret = fs::absolute(out_path);
+		if (!fs::is_directory(ret)) {
+			ret = fs::current_path();
+			out_path = ret.generic_string();
+		}
+		return ret;
+	}();
+	auto label = out_path;
+	auto const text_size = ImGui::CalcTextSize(label.c_str());
+	ImGui::PushItemWidth(-50.0f);
+	if (auto const ratio = (ImGui::GetWindowWidth() - 100.0f) / text_size.x; ratio > 0.0f) {
+		auto const limit = static_cast<std::size_t>(ratio * static_cast<float>(label.size()));
+		label = truncate(label, limit);
+	}
+	if (ImGui::BeginCombo("Path", label.c_str())) {
+		auto item_width = 0.0f;
+		for (auto p = fs_path; !p.empty(); p = p.parent_path()) {
+			ImGui::SetCursorPosX(ImGui::GetCursorPosX() + item_width);
+			item_width += parent_indent;
+			auto name = p.filename().generic_string();
+			name += "/";
+			if (ImGui::Selectable(name.c_str(), false)) {
+				out_path = p.generic_string();
+				break;
+			}
+			if (p.parent_path() == p) { break; }
+		}
+		ImGui::EndCombo();
+	}
+	if (fs_path.has_parent_path() && ImGui::Button("Up")) { out_path = fs_path.parent_path().generic_string(); }
+	if (auto documents = env::documents_path(); !documents.empty()) {
+		ImGui::SameLine();
+		if (ImGui::Button("Documents")) { out_path = std::move(documents); }
+	}
+	if (auto downloads = env::downloads_path(); !downloads.empty()) {
+		ImGui::SameLine();
+		if (ImGui::Button("Downloads")) { out_path = std::move(downloads); }
+	}
+
+	ImGui::Separator();
+	if (auto window = editor::Window{popup, "File Tree"}) {
+		env::GetDirEntries{.extensions = extensions}(out_entries, out_path.c_str());
+		if (fs_path.has_parent_path() && ImGui::Selectable("..", false, ImGuiSelectableFlags_DontClosePopups)) {
+			out_path = fs_path.parent_path().generic_string();
+		}
+		for (auto const& dir : out_entries.dirs) {
+			auto filename = env::to_filename(dir);
+			filename += "/";
+			if (ImGui::Selectable(filename.c_str(), false, ImGuiSelectableFlags_DontClosePopups)) { out_path = dir; }
+		}
+		for (auto const& file : out_entries.files) {
+			if (ImGui::Selectable(env::to_filename(file).c_str(), false, ImGuiSelectableFlags_DontClosePopups)) { return file; }
+		}
+	}
+
+	return {};
+}
+} // namespace facade::editor

lib/engine/src/editor/common.cpp

@@ -5,10 +5,10 @@
 namespace facade::editor {
 Openable::Openable(bool is_open) : m_open(is_open) {}
 
-Window::Window(char const* label, bool* open_if, int flags) : Openable(ImGui::Begin(label, open_if, flags)) {}
+Window::Window(char const* label, bool* open_if, int flags) : Canvas(ImGui::Begin(label, open_if, flags)) {}
 
-Window::Window(NotClosed<Window>, char const* label, glm::vec2 size, Bool border, int flags)
-	: Openable(ImGui::BeginChild(label, {size.x, size.y}, border.value, flags)), m_child(true) {}
+Window::Window(NotClosed<Canvas>, char const* label, glm::vec2 size, Bool border, int flags)
+	: Canvas(ImGui::BeginChild(label, {size.x, size.y}, border.value, flags)), m_child(true) {}
 
 // ImGui windows requires End() even if Begin() returned false
 Window::~Window() {
@@ -30,7 +30,7 @@ bool TreeNode::leaf(char const* label, int flags) {
 	return false;
 }
 
-Window::Menu::Menu(NotClosed<Window>) : MenuBar(ImGui::BeginMenuBar()) {}
+Window::Menu::Menu(NotClosed<Canvas>) : MenuBar(ImGui::BeginMenuBar()) {}
 
 Window::Menu::~Menu() {
 	if (m_open) { ImGui::EndMenuBar(); }
@@ -42,13 +42,13 @@ MainMenu::~MainMenu() {
 	if (m_open) { ImGui::EndMainMenuBar(); }
 }
 
-Popup::Popup(char const* id, Bool modal, Bool centered, int flags) {
+Popup::Popup(char const* id, Bool modal, Bool closeable, Bool centered, int flags) {
 	if (centered) {
 		auto const center = ImGui::GetMainViewport()->GetCenter();
 		ImGui::SetNextWindowPos(center, ImGuiCond_Appearing, ImVec2{0.5f, 0.5f});
 	}
 	if (modal) {
-		m_open = ImGui::BeginPopupModal(id, {}, flags);
+		m_open = ImGui::BeginPopupModal(id, &closeable.value, flags);
 	} else {
 		m_open = ImGui::BeginPopup(id, flags);
 	}

lib/engine/src/engine.cpp

@@ -8,6 +8,7 @@
 #include <facade/glfw/glfw_wsi.hpp>
 #include <facade/render/renderer.hpp>
 #include <facade/util/data_provider.hpp>
+#include <facade/util/env.hpp>
 #include <facade/util/error.hpp>
 #include <facade/util/logger.hpp>
 #include <facade/vk/cmd.hpp>
@@ -276,7 +277,7 @@ bool Engine::load_async(std::string gltf_json_path, UniqueTask<void()> on_loaded
 	}
 
 	// ready to start loading
-	logger::info("[Engine] Loading GLTF [{}]...", State::to_filename(gltf_json_path));
+	logger::info("[Engine] Loading GLTF [{}]...", env::to_filename(gltf_json_path));
 	// populate load request
 	m_impl->load.callback = std::move(on_loaded);
 	m_impl->load.request.path = std::move(gltf_json_path);
@@ -321,7 +322,7 @@ void Engine::update_load_request() {
 	auto const duration = time::since_start() - m_impl->load.request.start_time;
 	// unlock mutex to prevent possible deadlock (eg callback calls load_gltf again)
 	lock.unlock();
-	logger::info("...GLTF [{}] loaded in [{:.2f}s]", State::to_filename(path), duration);
+	logger::info("...GLTF [{}] loaded in [{:.2f}s]", env::to_filename(path), duration);
 	// invoke callback
 	if (callback) { callback(); }
 }

lib/glfw/include/facade/glfw/glfw.hpp

@@ -68,14 +68,6 @@ struct Glfw::State {
 	/// \brief Delta-time between polls.
 	///
 	float dt{};
-
-	///
-	/// \brief Obtain the filename of a file drop path.
-	/// \param path Path to extract filename from
-	///
-	/// Passed path must be in generic form.
-	///
-	static std::string to_filename(std::string_view path);
 };
 
 ///

lib/glfw/src/glfw.cpp

@@ -55,11 +55,6 @@ void Glfw::poll_events() {
 
 void Glfw::reset_dt() { g_states.dt = {}; }
 
-std::string Glfw::State::to_filename(std::string_view path) {
-	if (auto const i = path.find_last_of('/'); i != std::string_view::npos) { path = path.substr(i + 1); }
-	return std::string{path};
-}
-
 auto Glfw::Window::make() -> UniqueWin {
 	auto ret = Window{};
 	ret.glfw = get_or_make_glfw();

lib/util/CMakeLists.txt

@@ -70,6 +70,7 @@ target_sources(${PROJECT_NAME} PRIVATE
   include/${target_prefix}/util/data_provider.hpp
   include/${target_prefix}/util/enum_array.hpp
   include/${target_prefix}/util/enumerate.hpp
+  include/${target_prefix}/util/env.hpp
   include/${target_prefix}/util/error.hpp
   include/${target_prefix}/util/fixed_string.hpp
   include/${target_prefix}/util/flex_array.hpp
@@ -89,6 +90,7 @@ target_sources(${PROJECT_NAME} PRIVATE
   include/${target_prefix}/util/visitor.hpp
 
   src/data_provider.cpp
+  src/env.cpp
   src/image.cpp
   src/logger.cpp
   src/rgb.cpp

lib/util/include/facade/util/env.hpp

@@ -0,0 +1,39 @@
+#pragma once
+#include <span>
+#include <string>
+#include <vector>
+
+namespace facade::env {
+using MatchList = std::span<std::string_view const>;
+
+struct DirEntries {
+	std::vector<std::string> dirs{};
+	std::vector<std::string> files{};
+};
+
+struct GetDirEntries {
+	MatchList extensions{};
+	bool sort{true};
+	bool show_hidden{false};
+
+	bool operator()(DirEntries& out_entries, char const* path) const;
+};
+
+///
+/// \brief Obtain the filename of a file drop path.
+/// \param path Path to extract filename from
+/// \returns Filename
+///
+std::string to_filename(std::string_view path);
+
+///
+/// \brief Obtain the user documents path.
+/// \returns Documents path in generic form
+///
+std::string documents_path();
+///
+/// \brief Obtain the user documents path.
+/// \returns Downloads path in generic form
+///
+std::string downloads_path();
+} // namespace facade::env