LibGUI: Move file icon lookup into a separate FileIconProvider

Let's get it out of FileSystemModel so you can look up a nice icon for
a path without needing a model.

Libraries/LibGUI/CMakeLists.txt

@@ -24,6 +24,7 @@ set(SOURCES
     DragOperation.cpp
     EmojiInputDialog.cpp
     Event.cpp
+    FileIconProvider.cpp
     FilePicker.cpp
     FileSystemModel.cpp
     FilteringProxyModel.cpp

Libraries/LibGUI/FileIconProvider.cpp

@@ -0,0 +1,148 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <AK/String.h>
+#include <LibGUI/FileIconProvider.h>
+#include <LibGUI/Icon.h>
+#include <LibGfx/Bitmap.h>
+#include <sys/stat.h>
+
+namespace GUI {
+
+#define ENUMERATE_FILETYPES(F) \
+    F(cplusplus, ".cpp")       \
+    F(header, ".h")            \
+    F(html, ".html")           \
+    F(image, ".png")           \
+    F(java, ".java")           \
+    F(javascript, ".js")       \
+    F(library, ".so", ".a")    \
+    F(markdown, ".md")         \
+    F(object, ".o", ".obj")    \
+    F(pdf, ".pdf")             \
+    F(python, ".py")           \
+    F(sound, ".wav")           \
+    F(ini, ".ini")             \
+    F(text, ".txt")
+
+#define __ENUMERATE_FILETYPE(filetype_name, ...) \
+    static Icon s_filetype_##filetype_name##_icon;
+ENUMERATE_FILETYPES(__ENUMERATE_FILETYPE)
+#undef __ENUMERATE_FILETYPE
+
+static Icon s_directory_icon;
+static Icon s_directory_open_icon;
+static Icon s_home_directory_icon;
+static Icon s_home_directory_open_icon;
+static Icon s_file_icon;
+static Icon s_symlink_icon;
+static Icon s_socket_icon;
+static Icon s_executable_icon;
+
+static void initialize_if_needed()
+{
+    static bool s_initialized = false;
+    if (s_initialized)
+        return;
+    s_directory_icon = Icon::default_icon("filetype-folder");
+    s_directory_open_icon = Icon::default_icon("filetype-folder-open");
+    s_home_directory_icon = Icon::default_icon("home-directory");
+    s_home_directory_open_icon = Icon::default_icon("home-directory-open");
+    s_file_icon = Icon::default_icon("filetype-unknown");
+    s_symlink_icon = Icon::default_icon("filetype-symlink");
+    s_socket_icon = Icon::default_icon("filetype-socket");
+    s_executable_icon = Icon::default_icon("filetype-executable");
+
+#define __ENUMERATE_FILETYPE(filetype_name, ...) \
+    s_filetype_##filetype_name##_icon = Icon::default_icon("filetype-" #filetype_name);
+    ENUMERATE_FILETYPES(__ENUMERATE_FILETYPE)
+#undef __ENUMERATE_FILETYPE
+
+    s_initialized = true;
+}
+
+Icon FileIconProvider::directory_icon()
+{
+    initialize_if_needed();
+    return s_directory_icon;
+}
+
+Icon FileIconProvider::directory_open_icon()
+{
+    initialize_if_needed();
+    return s_directory_open_icon;
+}
+
+Icon FileIconProvider::home_directory_icon()
+{
+    initialize_if_needed();
+    return s_home_directory_icon;
+}
+
+Icon FileIconProvider::home_directory_open_icon()
+{
+    initialize_if_needed();
+    return s_home_directory_open_icon;
+}
+
+Icon FileIconProvider::filetype_image_icon()
+{
+    initialize_if_needed();
+    return s_filetype_image_icon;
+}
+
+Icon FileIconProvider::icon_for_path(const String& path)
+{
+    struct stat stat;
+    if (::stat(path.characters(), &stat) < 0)
+        return {};
+    return icon_for_path(path, stat.st_mode);
+}
+
+Icon FileIconProvider::icon_for_path(const String& path, mode_t mode)
+{
+    initialize_if_needed();
+    if (S_ISDIR(mode))
+        return s_directory_icon;
+    if (S_ISLNK(mode))
+        return s_symlink_icon;
+    if (S_ISSOCK(mode))
+        return s_socket_icon;
+    if (mode & (S_IXUSR | S_IXGRP | S_IXOTH))
+        return s_executable_icon;
+
+#define __ENUMERATE_FILETYPE(filetype_name, filetype_extensions...)      \
+    for (auto& extension : { filetype_extensions }) {                    \
+        if (path.ends_with(extension, CaseSensitivity::CaseInsensitive)) \
+            return s_filetype_##filetype_name##_icon;                    \
+    }
+    ENUMERATE_FILETYPES(__ENUMERATE_FILETYPE)
+#undef __ENUMERATE_FILETYPE
+
+    return s_file_icon;
+}
+
+}

Libraries/LibGUI/FileIconProvider.h

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <AK/Forward.h>
+#include <LibGUI/Forward.h>
+#include <sys/types.h>
+
+namespace GUI {
+
+class FileIconProvider {
+public:
+    static Icon icon_for_path(const String&, mode_t);
+    static Icon icon_for_path(const String&);
+
+    static Icon filetype_image_icon();
+    static Icon directory_icon();
+    static Icon directory_open_icon();
+    static Icon home_directory_icon();
+    static Icon home_directory_open_icon();
+};
+
+}

Libraries/LibGUI/FileSystemModel.cpp

@@ -30,6 +30,7 @@
 #include <LibCore/DirIterator.h>
 #include <LibCore/File.h>
 #include <LibCore/StandardPaths.h>
+#include <LibGUI/FileIconProvider.h>
 #include <LibGUI/FileSystemModel.h>
 #include <LibGUI/Painter.h>
 #include <LibGfx/Bitmap.h>
@@ -204,20 +205,6 @@ FileSystemModel::FileSystemModel(const StringView& root_path, Mode mode)
     : m_root_path(LexicalPath::canonicalized_path(root_path))
     , m_mode(mode)
 {
-    m_directory_icon = Icon::default_icon("filetype-folder");
-    m_directory_open_icon = Icon::default_icon("filetype-folder-open");
-    m_home_directory_icon = Icon::default_icon("home-directory");
-    m_home_directory_open_icon = Icon::default_icon("home-directory-open");
-    m_file_icon = Icon::default_icon("filetype-unknown");
-    m_symlink_icon = Icon::default_icon("filetype-symlink");
-    m_socket_icon = Icon::default_icon("filetype-socket");
-    m_executable_icon = Icon::default_icon("filetype-executable");
-
-#define __ENUMERATE_FILETYPE(filetype_name, ...) \
-    m_filetype_##filetype_name##_icon = Icon::default_icon("filetype-" #filetype_name);
-    ENUMERATE_FILETYPES
-#undef __ENUMERATE_FILETYPE
-
     setpwent();
     while (auto* passwd = getpwent())
         m_user_names.set(passwd->pw_uid, passwd->pw_name);
@@ -456,49 +443,27 @@ Variant FileSystemModel::data(const ModelIndex& index, Role role) const
     return {};
 }
 
-Icon FileSystemModel::icon_for_file(const mode_t mode, const String& name) const
-{
-    if (S_ISDIR(mode))
-        return m_directory_icon;
-    if (S_ISLNK(mode))
-        return m_symlink_icon;
-    if (S_ISSOCK(mode))
-        return m_socket_icon;
-    if (mode & (S_IXUSR | S_IXGRP | S_IXOTH))
-        return m_executable_icon;
-
-#define __ENUMERATE_FILETYPE(filetype_name, filetype_extensions...)  \
-    for (auto& extension : Vector<String> { filetype_extensions }) { \
-        if (name.to_lowercase().ends_with(extension))                \
-            return m_filetype_##filetype_name##_icon;                \
-    }
-    ENUMERATE_FILETYPES
-#undef __ENUMERATE_FILETYPE
-
-    return m_file_icon;
-}
-
 Icon FileSystemModel::icon_for(const Node& node) const
 {
     if (Gfx::Bitmap::is_path_a_supported_image_format(node.name.to_lowercase())) {
         if (!node.thumbnail) {
             if (!const_cast<FileSystemModel*>(this)->fetch_thumbnail_for(node))
-                return m_filetype_image_icon;
+                return FileIconProvider::filetype_image_icon();
         }
-        return GUI::Icon(m_filetype_image_icon.bitmap_for_size(16), *node.thumbnail);
+        return GUI::Icon(FileIconProvider::filetype_image_icon().bitmap_for_size(16), *node.thumbnail);
     }
 
     if (node.is_directory()) {
         if (node.full_path(*this) == Core::StandardPaths::home_directory()) {
             if (node.is_selected())
-                return m_home_directory_open_icon;
-            return m_home_directory_icon;
+                return FileIconProvider::home_directory_open_icon();
+            return FileIconProvider::home_directory_icon();
         }
         if (node.is_selected())
-            return m_directory_open_icon;
+            return FileIconProvider::directory_open_icon();
     }
 
-    return icon_for_file(node.mode, node.name);
+    return FileIconProvider::icon_for_path(node.name, node.mode);
 }
 
 static HashMap<String, RefPtr<Gfx::Bitmap>> s_thumbnail_cache;

Libraries/LibGUI/FileSystemModel.h

@@ -35,21 +35,6 @@
 #include <sys/stat.h>
 #include <time.h>
 
-#define ENUMERATE_FILETYPES                    \
-    __ENUMERATE_FILETYPE(cplusplus, ".cpp")    \
-    __ENUMERATE_FILETYPE(header, ".h")         \
-    __ENUMERATE_FILETYPE(html, ".html")        \
-    __ENUMERATE_FILETYPE(image, ".png")        \
-    __ENUMERATE_FILETYPE(java, ".java")        \
-    __ENUMERATE_FILETYPE(javascript, ".js")    \
-    __ENUMERATE_FILETYPE(library, ".so", ".a") \
-    __ENUMERATE_FILETYPE(markdown, ".md")      \
-    __ENUMERATE_FILETYPE(object, ".o", ".obj") \
-    __ENUMERATE_FILETYPE(pdf, ".pdf")          \
-    __ENUMERATE_FILETYPE(python, ".py")        \
-    __ENUMERATE_FILETYPE(sound, ".wav")        \
-    __ENUMERATE_FILETYPE(ini, ".ini")          \
-    __ENUMERATE_FILETYPE(text, ".txt")
 namespace GUI {
 
 class FileSystemModel
@@ -139,7 +124,6 @@ public:
     ModelIndex m_previously_selected_index {};
 
     const Node& node(const ModelIndex& index) const;
-    GUI::Icon icon_for_file(const mode_t mode, const String& name) const;
 
     Function<void(int done, int total)> on_thumbnail_progress;
     Function<void()> on_complete;
@@ -181,20 +165,6 @@ private:
     Mode m_mode { Invalid };
     OwnPtr<Node> m_root { nullptr };
 
-    GUI::Icon m_directory_icon;
-    GUI::Icon m_directory_open_icon;
-    GUI::Icon m_home_directory_icon;
-    GUI::Icon m_home_directory_open_icon;
-    GUI::Icon m_file_icon;
-    GUI::Icon m_symlink_icon;
-    GUI::Icon m_socket_icon;
-    GUI::Icon m_executable_icon;
-
-#define __ENUMERATE_FILETYPE(filetype_name, ...) \
-    GUI::Icon m_filetype_##filetype_name##_icon;
-    ENUMERATE_FILETYPES
-#undef __ENUMERATE_FILETYPE
-
     unsigned m_thumbnail_progress { 0 };
     unsigned m_thumbnail_progress_total { 0 };
 

Libraries/LibGUI/Forward.h

@@ -45,6 +45,7 @@ class Frame;
 class GroupBox;
 class HorizontalBoxLayout;
 class HorizontalSlider;
+class Icon;
 class IconView;
 class JsonArrayModel;
 class KeyEvent;