Improved file chooser dialog, extracted some code into separate functions.

kblaschke · kblaschke · commit 7034039c0547 · 2024-01-19T19:53:37.000+01:00
diff --git a/src/GuiFileChooserWindow.cpp b/src/GuiFileChooserWindow.cpp
@@ -5,6 +5,8 @@
 #include <Poco/SortedDirectoryIterator.h>
 #include <Poco/String.h>
 
+#include <algorithm>
+
 void GuiFileChooserWindow::Show()
 {
     _visible = true;
@@ -19,9 +21,10 @@ bool GuiFileChooserWindow::Draw()
 
     bool fileSelected{false};
 
-    if (!_currentDir.isDirectory() || !Poco::File(_currentDir).exists())
+    if (!_currentDir.isDirectory()
+        || (!_currentDir.toString().empty() && !Poco::File(_currentDir).exists()))
     {
-        _currentDir = Poco::Path::home();
+        ChangeDirectory(Poco::Path::home());
     }
 
     if (ImGui::Begin("Load Preset", &_visible), ImGuiWindowFlags_NoCollapse)
@@ -30,74 +33,36 @@ bool GuiFileChooserWindow::Draw()
 
         ImGui::Separator();
 
-        ImGui::Text("%s", _currentDir.toString().c_str());
+        char pathBuffer[2048]{};
+        strncpy(pathBuffer, _currentDir.toString().c_str(), std::min<size_t>(2047, _currentDir.toString().size()));
 
-        if (ImGui::BeginListBox("##filelist", ImVec2(-1,-1)))
+        if (ImGui::InputText("##path", &pathBuffer[0], IM_ARRAYSIZE(pathBuffer)), ImGuiInputTextFlags_EnterReturnsTrue)
         {
-            Poco::SortedDirectoryIterator directoryIterator(_currentDir);
-            Poco::SortedDirectoryIterator directoryEnd;
+            ChangeDirectory(std::string(pathBuffer));
+        }
 
-            int index = 0;
-            while (directoryIterator != directoryEnd)
+        if (ImGui::BeginListBox("##filelist", ImVec2(-1, -1)))
+        {
+            if (_currentDir.toString().empty())
             {
-                bool isSelected = _selectedFileIndex == index;
-                bool isDirectory = false;
-                bool isHidden = false;
-                try
-                {
-                    // This will throw for broken symlinks or if the file/dir isn't accessible
-                    isHidden = directoryIterator->isHidden();
-                    isDirectory = directoryIterator->isDirectory();
-                }
-                catch (...)
-                {
-                }
+                ImGui::TextColored(ImVec4(1.0f, 0.0f, 0.0f, 1.0f), "No path entered");
+            }
+            else
+            {
+                Poco::File pathCheck(_currentDir);
 
-                if (!_showhidden && isHidden)
+                if (!pathCheck.exists())
                 {
-                    ++directoryIterator;
-                    continue;
+                    ImGui::TextColored(ImVec4(1.0f, 0.0f, 0.0f, 1.0f), "Directory does not exist");
                 }
-
-                auto filename = directoryIterator.name();
-
-                if (isDirectory)
+                else if (!pathCheck.canRead())
                 {
-                    filename.append("/");
+                    ImGui::TextColored(ImVec4(1.0f, 0.0f, 0.0f, 1.0f), "Directory cannot be accessed");
                 }
                 else
                 {
-                    if (Poco::icompare(directoryIterator.path().getExtension(), "milk") != 0)
-                    {
-                        ++directoryIterator;
-                        continue;
-                    }
-                }
-
-                if (ImGui::Selectable(filename.c_str(), isSelected, ImGuiSelectableFlags_AllowDoubleClick))
-                {
-                    _selectedFileIndex = index;
-
-                    if (ImGui::IsMouseDoubleClicked(0))
-                    {
-                        if (isDirectory)
-                        {
-                            _currentDir = directoryIterator.path();
-                            _currentDir.makeDirectory();
-                            poco_debug_f1(_logger, "Changing dir to: %s", _currentDir.toString());
-                        }
-                        else
-                        {
-                            _selectedFile = directoryIterator.path();
-                            poco_debug_f1(_logger, "User selected file: %s", _selectedFile.path());
-                            fileSelected = true;
-                            _visible = false;
-                        }
-                    }
+                    fileSelected = PopulateFileList();
                 }
-
-                ++directoryIterator;
-                index++;
             }
 
             ImGui::EndListBox();
@@ -112,6 +77,12 @@ bool GuiFileChooserWindow::Draw()
 
     return fileSelected;
 }
+
+const Poco::File& GuiFileChooserWindow::SelectedFile() const
+{
+    return _selectedFile;
+}
+
 void GuiFileChooserWindow::DrawNavButtons()
 {
     ImGui::Checkbox("Show hidden files", &_showhidden);
@@ -122,33 +93,138 @@ void GuiFileChooserWindow::DrawNavButtons()
 
     if (ImGui::Button("Up"))
     {
-        _currentDir = _currentDir.parent();
-        _currentDir.makeDirectory();
+        ChangeDirectory(_currentDir.parent());
         poco_debug_f1(_logger, "Going one dir up: %s", _currentDir.toString());
     }
 
     ImGui::SameLine();
 
     if (ImGui::Button("Home"))
+    {
+        ChangeDirectory(Poco::Path::home());
+        poco_debug_f1(_logger, "Going to user's home dir: %s", _currentDir.toString());
+    }
+
+    for (const auto& root: roots)
+    {
+        ImGui::SameLine();
+
+        if (ImGui::Button(root.c_str()))
         {
-            _currentDir = Poco::Path::home();
-            poco_debug_f1(_logger, "Going to user's home dir: %s", _currentDir.toString());
+            ChangeDirectory(root);
+            poco_debug_f1(_logger, "Changing root/drive to: %s", _currentDir.toString());
         }
+    }
+}
+
+bool GuiFileChooserWindow::PopulateFileList()
+{
+    bool fileSelected{false};
+    bool changeDir{false};
+    Poco::Path newDir;
 
-        for (const auto& root: roots)
+    int index = 0;
+    for (const auto& file : _currentFileList)
+    {
+        bool isSelected = _selectedFileIndex == index;
+        bool isDirectory = false;
+        try
+        {
+            // This will throw for broken symlinks or if the file/dir isn't accessible
+            isDirectory = file.isDirectory();
+        }
+        catch (...)
         {
-            ImGui::SameLine();
+        }
 
-            if (ImGui::Button(root.c_str()))
-            {
-                _currentDir = root;
+        Poco::Path filePath(file.path());
+        auto filename = filePath.getFileName();
+
+        if (isDirectory)
+        {
+            filename.append("/");
+        }
 
-                poco_debug_f1(_logger, "Changing root/drive to: %s", _currentDir.toString());
+        if (ImGui::Selectable(filename.c_str(), isSelected, ImGuiSelectableFlags_AllowDoubleClick))
+        {
+            _selectedFileIndex = index;
+
+            if (ImGui::IsMouseDoubleClicked(0))
+            {
+                if (isDirectory)
+                {
+                    newDir = filePath;
+                    changeDir = true;
+                    poco_debug_f1(_logger, "Changing dir to: %s", _currentDir.toString());
+                }
+                else
+                {
+                    _selectedFile = filePath;
+                    poco_debug_f1(_logger, "User selected file: %s", _selectedFile.path());
+                    fileSelected = true;
+                    _visible = false;
+                }
             }
         }
+
+        index++;
+    }
+
+    if (changeDir)
+    {
+        ChangeDirectory(newDir);
+    }
+
+    return fileSelected;
 }
 
-const Poco::File& GuiFileChooserWindow::SelectedFile() const
+void GuiFileChooserWindow::ChangeDirectory(const Poco::Path& newDirectory)
 {
-    return _selectedFile;
+    _currentDir = newDirectory;
+    _currentDir.makeDirectory();
+
+    _currentFileList.clear();
+
+    if (_currentDir.toString().empty())
+    {
+        return;
+    }
+
+    Poco::File pathCheck(_currentDir);
+    if (!pathCheck.exists() || !pathCheck.canRead())
+    {
+        return;
+    }
+
+    // Ideally, only use the directory iterator after cd'ing into a new dir and store the path list.
+    Poco::SortedDirectoryIterator directoryIterator(_currentDir);
+    Poco::SortedDirectoryIterator directoryEnd;
+
+    while (directoryIterator != directoryEnd)
+    {
+        bool isHidden = false;
+        bool isDirectory = false;
+        try
+        {
+            // This will throw for broken symlinks or if the file/dir isn't accessible
+            isHidden = directoryIterator->isHidden();
+            isDirectory = directoryIterator->isDirectory();
+        }
+        catch (...)
+        {
+        }
+
+        if (!isDirectory && Poco::icompare(directoryIterator.path().getExtension(), "milk") != 0)
+        {
+            ++directoryIterator;
+            continue;
+        }
+
+        if (!isHidden || _showhidden)
+        {
+            _currentFileList.push_back(*directoryIterator);
+        }
+
+        ++directoryIterator;
+    }
 }
diff --git a/src/GuiFileChooserWindow.h b/src/GuiFileChooserWindow.h
@@ -4,6 +4,11 @@
 #include <Poco/Path.h>
 #include <Poco/Logger.h>
 
+/**
+ * @brief File/preset chooser dialog
+ *
+ * Displays a file browser that shows directories and .milk files from which the user can choose one.
+ */
 class GuiFileChooserWindow
 {
 public:
@@ -16,16 +21,41 @@ class GuiFileChooserWindow
      */
     bool Draw();
 
+
+    /**
+     * @brief Returns the selected file
+     * @return The selected file
+     */
     const Poco::File& SelectedFile() const;
 
 protected:
+    /**
+     * Draws the navigation buttons on top (up, home, root/drives)
+     */
     void DrawNavButtons();
 
+    /**
+     * @brief Fills the file list with content and checks if one was chosen
+     * @return True if the user chose a file.
+     */
+    bool PopulateFileList();
+
+    /**
+     * @brief Changes the currently displayed directory to the given path.
+     *
+     * The path must not necessarily exist or be accessible. A message is shown to the user if something is wrong.
+     *
+     * @param newDirectory The directory to chdir into
+     */
+    void ChangeDirectory(const Poco::Path& newDirectory);
+
     bool _visible{ false }; //!< File chooser window visible.
     bool _showhidden{ false }; //!< If true, hidden files/dirs are shown.
     Poco::Path _currentDir{ Poco::Path::current() }; //!< Current working dir.
+    std::vector<Poco::File> _currentFileList; //!< File list of current directory
     Poco::File _selectedFile; //!< Currently selected file.
     int _selectedFileIndex{ 0 }; //!< Currently selected item in the file list.
 
+
     Poco::Logger& _logger{ Poco::Logger::get("GuiFileChooserWindow") };
 };
