add "Show in folder view" option to file text edit panel

Author: Santiago

src/ImGuiController.cpp

@@ -31,6 +31,7 @@ namespace scex::ImGuiController
 	void OnFindInFolder(const std::string& folderPath, int folderViewId);
 	void OnShowInFileExplorer(const std::string& filePath, int folderViewId);
 	void OnFileClickedInFolderView(const std::string& filePath, int folderViewId);
+	void OnShowInFolderView(const std::string& filePath, int folderViewId);
 	void OnFolderSearchResultClick(const std::string& filePath, const DirectoryFinderSearchResult& searchResult, int folderViewId);
 	void OnFolderSearchResultFoundOrSearchFinished();
 	void OnPanelFocused(int folderViewId);
@@ -57,7 +58,7 @@ namespace scex::ImGuiController
 	FileTextEdit* CreateNewEditor(const char* filePath = nullptr, int fromFolderView = -1)
 	{
 		int fileTextEditId = fileTextEdits.size();
-		fileTextEdits.push_back(new FileTextEdit(filePath, fileTextEditId, fromFolderView, OnPanelFocused));
+		fileTextEdits.push_back(new FileTextEdit(filePath, fileTextEditId, fromFolderView, OnPanelFocused, OnShowInFolderView));
 		fileTextEdits.back()->SetShowDebugPanel(textEditDebugInfo);
 		return fileTextEdits.back();
 	}
@@ -101,7 +102,15 @@ namespace scex::ImGuiController
 			editorToFocus = fileToEditorMap[filePath];
 	}
 
-	// ---- Callback from folder finder ---- //
+	// ---- Callbacks from file text edit ---- //
+	void OnShowInFolderView(const std::string& filePath, int folderViewId)
+	{
+		assert(folderViewId > -1);
+		assert(folderViewers[folderViewId] != nullptr);
+		folderViewers[folderViewId]->ShowFile(filePath);
+	}
+
+	// ---- Callbacks from folder finder ---- //
 	void OnFolderSearchResultClick(const std::string& filePath, const DirectoryFinderSearchResult& searchResult, int folderViewId)
 	{
 		FileTextEdit* targetEditor;
@@ -187,7 +196,7 @@ void scex::ImGuiController::OnPathsDropped(const char** paths, int pathCount)
 	}
 }
 
-void scex::ImGuiController::Tick()
+void scex::ImGuiController::Tick(double deltaTime)
 {
 	ImGui_ImplOpenGL3_NewFrame();
 	ImGui_ImplGlfw_NewFrame();
@@ -266,13 +275,21 @@ void scex::ImGuiController::Tick()
 			if (folderView == nullptr)
 				continue;
 			ImGui::SetNextWindowDockID(leftDockID, ImGuiCond_FirstUseEver);
-			if (!folderView->OnImGui())
+			if (!folderView->OnImGui(deltaTime))
 				folderViewToDelete = i;
 		}
 		if (folderViewToDelete > -1)
 		{
 			delete folderViewers[folderViewToDelete];
 			folderViewers[folderViewToDelete] = nullptr;
+			// notify text editors so they don't try to show file in folder view
+			for (int i = 0; i < fileTextEdits.size(); i++)
+			{
+				FileTextEdit* fte = fileTextEdits[i];
+				if (fte == nullptr)
+					continue;
+				fte->OnFolderViewDeleted(folderViewToDelete);
+			}
 		}
 	}
 	{

src/ImGuiController.h

@@ -9,5 +9,5 @@ namespace scex::ImGuiController
 	void Setup(GLFWwindow* window, const std::string& fileToOpen);
 	bool HasControl();
 	void OnPathsDropped(const char** paths, int pathCount);
-	void Tick();
+	void Tick(double deltaTime);
 }

src/main.cpp

@@ -137,13 +137,21 @@ int main(int argc, char** argv)
 		glDebugMessageControl(GL_DONT_CARE, GL_DONT_CARE, GL_DONT_CARE, 0, nullptr, GL_TRUE);
 	}
 #endif
-
+	float programTime = 0.0;
+	double lastFrameTime = 0.0;
+	double currentFrameTime = 0.0;
+	double deltaTime = 0.0;
 	/* Loop until the user closes the window */
 	while (!glfwWindowShouldClose(window))
 	{
+		currentFrameTime = glfwGetTime();
+		deltaTime = currentFrameTime - lastFrameTime;
+
 		/* Draw scene */
 		glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-		scex::ImGuiController::Tick();
+		scex::ImGuiController::Tick(deltaTime);
+
+		programTime += deltaTime;
 
 		/* Swap front and back buffers */
 		glfwSwapBuffers(window);
@@ -157,6 +165,7 @@ int main(int argc, char** argv)
 		else
 			redrawCounter--;
 		glfwPollEvents();
+		lastFrameTime = currentFrameTime;
 	}
 
 	glfwTerminate();

src/panels/DirectoryTreeView.cpp

@@ -1,8 +1,10 @@
 #include "DirectoryTreeView.h"
 
 #include <iostream>
+#include <PathUtils.h>
 
 #define MAX_SEARCH_RESULTS 50
+#define SECONDS_TO_SELECT_ON_SHOW_FILE 2.0f
 
 DirectoryTreeView::DirectoryTreeView(
 	const std::string& folderPath,
@@ -29,7 +31,7 @@ DirectoryTreeView::~DirectoryTreeView()
 		Trie::Free(item.second);
 }
 
-bool DirectoryTreeView::OnImGui()
+bool DirectoryTreeView::OnImGui(double deltaTime)
 {
 	bool windowIsOpen = true;
 	if (requestingFocus)
@@ -88,6 +90,12 @@ bool DirectoryTreeView::OnImGui()
 		ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, { 0.0f, 2.0f });
 		ImGui::SetNextItemOpen(true);
 		RecursivelyDisplayDirectoryNode(directoryTreeRoot);
+		if (selectionTimer > 0.0f)
+		{
+			selectionTimer -= deltaTime;
+			if (selectionTimer <= 0.0f)
+				fileToHighlight = "";
+		}
 		ImGui::PopStyleVar(2);
 
 		if (lastHoveredNode != nullptr)
@@ -128,6 +136,12 @@ void DirectoryTreeView::RunSearch()
 	searchResults.clear();
 }
 
+void DirectoryTreeView::ShowFile(const std::string& filePath)
+{
+	fileToHighlight = filePath;
+	selectionTimer = SECONDS_TO_SELECT_ON_SHOW_FILE;
+}
+
 void DirectoryTreeView::Refresh()
 {
 	for (auto& item : searchTrie.children)
@@ -178,6 +192,12 @@ void DirectoryTreeView::SetLastHoveredNode(const DirectoryTreeViewNode* node)
 
 void DirectoryTreeView::RecursivelyDisplayDirectoryNode(const DirectoryTreeViewNode& parentNode)
 {
+	bool needToSelectNode = false;
+	if (fileToHighlight.length() > 0 && PathUtils::GetFolderPath(fileToHighlight).find(parentNode.fullPath) != std::string::npos) // show file in folder functionality
+		ImGui::SetNextItemOpen(true);
+	else if (fileToHighlight.compare(parentNode.fullPath) == 0)
+		needToSelectNode = true;
+
 	ImGui::PushID(&parentNode);
 	if (parentNode.isDirectory)
 	{
@@ -197,7 +217,9 @@ void DirectoryTreeView::RecursivelyDisplayDirectoryNode(const DirectoryTreeViewN
 	}
 	else
 	{
-		if (ImGui::TreeNodeEx(parentNode.fileName.c_str(), ImGuiTreeNodeFlags_NoTreePushOnOpen | ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_SpanFullWidth | ImGuiTreeNodeFlags_FramePadding))
+		if (ImGui::TreeNodeEx(parentNode.fileName.c_str(),
+			ImGuiTreeNodeFlags_NoTreePushOnOpen | ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_SpanFullWidth |
+			ImGuiTreeNodeFlags_FramePadding | (needToSelectNode ? ImGuiTreeNodeFlags_Selected : 0x0)))
 		{
 			if (ImGui::IsItemClicked(0))
 			{

src/panels/DirectoryTreeView.h

@@ -32,12 +32,16 @@ struct DirectoryTreeView
 		std::vector<std::pair<std::string, OnContextMenuCallback>>* folderContextMenuOptions = nullptr,
 		int id = -1);
 	~DirectoryTreeView();
-	bool OnImGui();
+	bool OnImGui(double deltaTime);
 	void RunSearch();
+	void ShowFile(const std::string& filePath);
 
 private:
 	int id = -1;
 
+	std::string fileToHighlight = "";
+	float selectionTimer = -1.0f;
+
 	bool requestingFocus = false;
 	bool searching = false;
 	char findFilesBuffer[FIND_FILES_BUFFER_SIZE];

src/panels/FileTextEdit.cpp

@@ -24,11 +24,12 @@ std::unordered_map<std::string, const TextEditor::LanguageDefinition*> FileTextE
 	{".json",&TextEditor::LanguageDefinition::Json()}
 };
 
-FileTextEdit::FileTextEdit(const char* filePath, int id, int createdFromFolderView, OnFocusedCallback onFocusedCallback)
+FileTextEdit::FileTextEdit(const char* filePath, int id, int createdFromFolderView, OnFocusedCallback onFocusedCallback, OnShowInFolderViewCallback onShowInFolderViewCallback)
 {
 	this->id = id;
 	this->createdFromFolderView = createdFromFolderView;
 	this->onFocusedCallback = onFocusedCallback;
+	this->onShowInFolderViewCallback = onShowInFolderViewCallback;
 	editor = new TextEditor();
 	if (filePath == nullptr)
 		panelName = "untitled##" + std::to_string((int)this);
@@ -84,6 +85,10 @@ bool FileTextEdit::OnImGui()
 				OnSaveCommand();
 			if (this->hasAssociatedFile && ImGui::MenuItem("Show in file explorer"))
 				Utils::ShowInFileExplorer(this->associatedFile);
+			if (this->hasAssociatedFile &&
+				this->onShowInFolderViewCallback != nullptr &&
+				this->createdFromFolderView > -1 && ImGui::MenuItem("Show in folder view"))
+				this->onShowInFolderViewCallback(this->associatedFile, this->createdFromFolderView);;
 			ImGui::EndMenu();
 		}
 		if (ImGui::BeginMenu("Edit"))
@@ -254,6 +259,12 @@ const char* FileTextEdit::GetAssociatedFile()
 	return associatedFile.c_str();
 }
 
+void FileTextEdit::OnFolderViewDeleted(int folderViewId)
+{
+	if (createdFromFolderView == folderViewId)
+		createdFromFolderView = -1;
+}
+
 void FileTextEdit::SetShowDebugPanel(bool value)
 {
 	showDebugPanel = value;

src/panels/FileTextEdit.h

@@ -5,15 +5,18 @@
 struct FileTextEdit
 {
 	typedef void (*OnFocusedCallback)(int folderViewId);
+	typedef void (*OnShowInFolderViewCallback)(const std::string& filePath, int folderViewId);
 
 	FileTextEdit(const char* filePath = nullptr,
 		int id = -1,
 		int createdFromFolderView = -1,
-		OnFocusedCallback onFocusedCallback = nullptr);
+		OnFocusedCallback onFocusedCallback = nullptr,
+		OnShowInFolderViewCallback onShowInFolderViewCallback = nullptr);
 	~FileTextEdit();
 	bool OnImGui();
 	void SetSelection(int startLine, int startChar, int endLine, int endChar);
 	const char* GetAssociatedFile();
+	void OnFolderViewDeleted(int folderViewId);
 	void SetShowDebugPanel(bool value);
 
 private:
@@ -27,6 +30,7 @@ struct FileTextEdit
 	int createdFromFolderView = -1;
 
 	OnFocusedCallback onFocusedCallback = nullptr;
+	OnShowInFolderViewCallback onShowInFolderViewCallback = nullptr;
 
 	TextEditor* editor = nullptr;
 	bool showDebugPanel = false;