icon-lookup: allow for a list of icon themes

fwsmit · fwsmit · commit 2e2d93865fce · 2021-11-05T17:08:40.000+01:00
With the current implementation it's possible to have multiple icon
themes in a somewhat performant manner.
diff --git a/docs/dunst.5.pod b/docs/dunst.5.pod
@@ -388,18 +388,22 @@ If B<icon_position> is set to off, this setting is ignored.
 Can be set to a colon-separated list of paths to search for icons to use with
 notifications.
 
-Dunst doesn't currently do any type of icon lookup outside of these
-directories.
+Dunst doens't search outside of these direcories. For a recursive icon lookup
+system, see B<enable_recursive_icon_lookup>. This new system will eventually
+replace this and will need new settings.
 
-=item B<icon_theme> (default: "hicolor") I<Experimental>
+=item B<icon_theme> (default: "Adwaita", example: "Adwaita, breeze") I<Experimental>
 
-The name of the the theme to use for looking up icons. This has to be the name
-of the directory in which the theme is located, not the human-friendly name of
-the theme. So for example, the theme B<Breeze Dark> is located in
-F</usr/share/icons/breeze-dark>. In this case you have to set the theme to
-B<breeze-dark>.
+Comma-separated of names of the the themes to use for looking up icons. This has
+to be the name of the directory in which the theme is located, not the
+human-friendly name of the theme. So for example, the theme B<Breeze Dark> is
+located in F</usr/share/icons/breeze-dark>. In this case you have to set the
+theme to B<breeze-dark>.
 
-Dunst will look for the theme in B<XDG_DATA_HOME/icons> and
+The first theme in the list is the most important. Only if the icon cannot be
+found in that theme, the next theme will be tried.
+
+Dunst will look for the themes in B<XDG_DATA_HOME/icons> and
 B<$XDG_DATA_DIRS/icons> as specified in the icon theme specification:
 https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html.
 
@@ -410,7 +414,8 @@ B<enable_recursive_icon_lookup> for how to enable it.
 
 =item B<enable_recursive_icon_lookup> (default: false) I<Experimental>
 
-This setting enables the new icon lookup method.
+This setting enables the new icon lookup method. This new system will eventually
+be the old icon lookup.
 
 Currently icons are looked up in the B<icon_path> and scaled according to
 B<min_icon_size> and B<max_icon_size>. Since the B<icon_path> wasn't recursive,
diff --git a/src/draw.c b/src/draw.c
@@ -49,6 +49,28 @@ PangoFontDescription *pango_fdesc;
 
 #define UINT_MAX_N(bits) ((1 << bits) - 1)
 
+void load_icon_themes()
+{
+        bool loaded_theme = false;
+
+        for (int i = 0; settings.icon_theme[i] != NULL; i++) {
+                char *theme = settings.icon_theme[i];
+                int theme_index = load_icon_theme(theme);
+                if (theme_index >= 0) {
+                        LOG_W("Adding default theme %s", theme);
+                        add_default_theme(theme_index);
+                        loaded_theme = true;
+                } else {
+                        LOG_W("NOT Adding default theme '%s'", theme);
+                }
+        }
+        if (!loaded_theme) {
+                int theme_index = load_icon_theme("hicolor");
+                add_default_theme(theme_index);
+        }
+
+}
+
 void draw_setup(void)
 {
         const struct output *out = output_create(settings.force_xwayland);
@@ -58,11 +80,8 @@ void draw_setup(void)
 
         pango_fdesc = pango_font_description_from_string(settings.font);
 
-        int theme_index = load_icon_theme(settings.icon_theme);
-        if (theme_index == -1)
-                theme_index = load_icon_theme("hicolor");
-
-        set_default_theme(theme_index);
+        if (settings.enable_recursive_icon_lookup)
+                load_icon_themes();
 }
 
 static struct color hex_to_color(uint32_t hexValue, int dpc)
@@ -787,6 +806,8 @@ void draw_deinit(void)
 {
         output->win_destroy(win);
         output->deinit();
+        if (settings.enable_recursive_icon_lookup)
+                free_all_themes();
 }
 
 double draw_get_scale(void)
diff --git a/src/icon-lookup.c b/src/icon-lookup.c
@@ -13,7 +13,8 @@
 
 struct icon_theme *icon_themes = NULL;
 int icon_themes_count = 0;
-int default_theme_index = -1;
+int *default_themes_index = NULL;
+int default_themes_count = 0;
 
 static bool is_readable_file(const char *filename)
 {
@@ -29,13 +30,6 @@ int get_icon_theme(char *name) {
         return -1;
 }
 
-void print_all_dir_counts(char *theme_name, char *msg) {
-        printf("%s: %s\n", theme_name, msg);
-        for (int i = 0; i < icon_themes_count; i++) {
-                printf("Dir count %s: %i\n", icon_themes[i].name, icon_themes[i].dirs_count);
-        }
-}
-
 /**
  * Load a theme from a directory. Don't call this function if the theme is
  * already loaded. It also loads the inherited themes. If there are no
@@ -50,7 +44,7 @@ void print_all_dir_counts(char *theme_name, char *msg) {
  * @retval -1 means no index was found
  */
 int load_icon_theme_from_dir(const char *icon_dir, const char *subdir_theme) {
-        printf("Loading theme %s/%s\n", icon_dir, subdir_theme);
+        LOG_D("Loading theme %s/%s\n", icon_dir, subdir_theme);
         char *theme_index_dir = g_build_filename(icon_dir, subdir_theme, "index.theme", NULL);
         FILE *theme_index = fopen(theme_index_dir, "r");
         g_free(theme_index_dir);
@@ -76,7 +70,6 @@ int load_icon_theme_from_dir(const char *icon_dir, const char *subdir_theme) {
 
         // load theme directories
         icon_themes[index].dirs_count = ini->section_count - 1;
-        print_all_dir_counts(icon_themes[index].name, "First");
         icon_themes[index].dirs = calloc(icon_themes[index].dirs_count, sizeof(struct icon_theme_dir));
 
         for (int i = 0; i < icon_themes[index].dirs_count; i++) {
@@ -129,15 +122,14 @@ int load_icon_theme_from_dir(const char *icon_dir, const char *subdir_theme) {
                         }
                 }
         }
-        print_all_dir_counts(icon_themes[index].name, "Second");
 
 
         // load inherited themes
         if (!STR_EQ(icon_themes[index].name, "Hicolor"))
         {
                 char **inherits = string_to_array(get_value(ini, "Icon Theme", "Inherits"), ",");
                 icon_themes[index].inherits_count = string_array_length(inherits);
-                printf("Theme has %i inherited themes\n", icon_themes[index].inherits_count);
+                LOG_D("Theme has %i inherited themes\n", icon_themes[index].inherits_count);
                 if (icon_themes[index].inherits_count <= 0) {
                         // set fallback theme to hicolor if there are no inherits
                         g_strfreev(inherits);
@@ -150,15 +142,13 @@ int load_icon_theme_from_dir(const char *icon_dir, const char *subdir_theme) {
                 icon_themes[index].inherits_index = calloc(icon_themes[index].inherits_count, sizeof(int));
 
                 for (int i = 0; inherits[i] != NULL; i++) {
-                        printf("inherits: %s\n", inherits[i]);
+                        LOG_D("inherits: %s\n", inherits[i]);
                         icon_themes[index].inherits_index[i] = get_icon_theme(inherits[i]);
                         if (icon_themes[index].inherits_index[i] == -1) {
-                                printf("Loading inherited theme\n");
-                                print_all_dir_counts(icon_themes[index].name, "Third");
+                                LOG_D("Loading inherited theme\n");
                                 // FIXME don't use a pointer to the theme,
                                 // since it may be invalidated after realloc. Use an index instead
                                 icon_themes[index].inherits_index[i] = load_icon_theme(inherits[i]);
-                                print_all_dir_counts("unknown", "Fourth");
                         }
                 }
                 g_strfreev(inherits);
@@ -168,10 +158,6 @@ int load_icon_theme_from_dir(const char *icon_dir, const char *subdir_theme) {
 
         finish_ini(ini);
         free(ini);
-
-        print_all_dir_counts("unknown", "End");
-        printf("Othere dirs count %i\n", icon_themes[0].dirs_count);
-        printf("index %i\n", index);
         return index;
 }
 
@@ -215,7 +201,7 @@ void get_theme_path() {
         add_paths_from_env(theme_path, "XDG_DATA_DIRS", "icons", "/usr/local/share/:/usr/share/");
         g_ptr_array_add(theme_path, g_strdup("/usr/share/pixmaps"));
         for (int i = 0; i < theme_path->len; i++) {
-                printf("Theme locations: %s\n", (char*)theme_path->pdata[i]);
+                LOG_D("Theme locations: %s\n", (char*)theme_path->pdata[i]);
         }
 }
 
@@ -244,7 +230,6 @@ void finish_icon_theme_dir(struct icon_theme_dir *dir) {
 void finish_icon_theme(struct icon_theme *theme) {
         if (!theme)
                 return;
-        printf("Finishing %i dirs\n", theme->dirs_count);
         for (int i = 0; i < theme->dirs_count; i++) {
                 finish_icon_theme_dir(&theme->dirs[i]);
         }
@@ -256,9 +241,8 @@ void finish_icon_theme(struct icon_theme *theme) {
 }
 
 void free_all_themes() {
-        printf("Finishing %i themes\n", icon_themes_count);
+        LOG_D("Finishing %i themes\n", icon_themes_count);
         for (int i = 0; i < icon_themes_count; i++) {
-                printf("Theme dirs %i\n", icon_themes[i].dirs_count);
                 finish_icon_theme(&icon_themes[i]);
         }
         free(icon_themes);
@@ -269,7 +253,7 @@ void free_all_themes() {
 }
 
 // see icon-lookup.h
-void set_default_theme(int theme_index) {
+void add_default_theme(int theme_index) {
         if (theme_index < 0) {
                 LOG_W("Invalid theme index: %i", theme_index);
                 return;
@@ -279,13 +263,16 @@ void set_default_theme(int theme_index) {
                                 theme_index);
                 return;
         }
-        default_theme_index = theme_index;
+        default_themes_count++;
+        default_themes_index = realloc(default_themes_index,
+                        default_themes_count * sizeof(int));
+        default_themes_index[default_themes_count - 1] = theme_index;
 }
 
 // see icon-lookup.h
 char *find_icon_in_theme(const char *name, int theme_index, int size) {
         struct icon_theme *theme = &icon_themes[theme_index];
-        printf("Finding icon %s in theme %s\n", name, theme->name);
+        LOG_D("Finding icon %s in theme %s\n", name, theme->name);
         for (int i = 0; i < theme->dirs_count; i++) {
                 bool match_size = false;
                 struct icon_theme_dir dir = theme->dirs[i];
@@ -362,9 +349,16 @@ char *find_icon_path(const char *name, int size) {
                         return NULL;
         }
 
-        if (default_theme_index == -1) {
-                printf("No icon theme has been set.\n");
+        if (!default_themes_index) {
+                LOG_W("No icon theme has been set.\n");
                 return NULL;
         }
-        return find_icon_in_theme_with_inherit(name, default_theme_index, size);
+        for (int i = 0; i < default_themes_count; i++) {
+                char *icon = find_icon_in_theme_with_inherit(name,
+                                default_themes_index[i], size);
+                if (icon)
+                        return icon;
+
+        }
+        return NULL;
 }
diff --git a/src/icon-lookup.h b/src/icon-lookup.h
@@ -38,12 +38,13 @@ int load_icon_theme(char *name);
 
 
 /**
- * Set the default icon theme used for looking up icons. Inherited themes will
- * be used as a fallback.
+ * Add theme to the list of default themes. The theme that's added first will
+ * be used first for lookup. After that the inherited themes will be used and
+ * only after that the next default theme will be used.
  *
  * @param theme_index The index of the theme as returned by #load_icon_theme
  */
-void set_default_theme(int theme_index);
+void add_default_theme(int theme_index);
 
 /**
  * Find icon of specified size in selected theme. This function will not return
@@ -72,5 +73,10 @@ void set_default_theme(int theme_index);
  */
 char *find_icon_path(const char *name, int size);
 
+/**
+ * Free all icon themes.
+ */
+void free_all_themes();
+
 #endif
 /* vim: set ft=c tabstop=8 shiftwidth=8 expandtab textwidth=0: */
diff --git a/src/option_parser.c b/src/option_parser.c
@@ -153,6 +153,12 @@ int string_parse_list(const void *data, const char *s, void *ret) {
                         offset->y = int_arr[1];
                         g_free(int_arr);
                         break;
+                case STRING_LIST: ;
+                        g_strfreev(*(char ***) ret);
+                        *(char ***) ret = string_to_array(s, ",");
+                        success = true;
+                        break;
+
                 default:
                         LOG_W("Don't know this list type: %i", type);
                         break;
diff --git a/src/settings.h b/src/settings.h
@@ -131,7 +131,7 @@ struct settings {
         enum vertical_alignment vertical_alignment;
         int min_icon_size;
         int max_icon_size;
-        char *icon_theme; // experimental
+        char **icon_theme; // experimental
         bool enable_recursive_icon_lookup; // experimental
         char *icon_path;
         enum follow_mode f_mode;
diff --git a/src/settings_data.h b/src/settings_data.h
@@ -139,8 +139,8 @@ const enum zwlr_layer_shell_v1_layer {
 enum list_type {
         INVALID_LIST = 0,
         MOUSE_LIST = 1,
-        ORIGIN_LIST = 2,
-        OFFSET_LIST = 3,
+        OFFSET_LIST = 2,
+        STRING_LIST = 3,
 };
 
 #define ENUM_END {NULL, 0}
@@ -1054,11 +1054,11 @@ static const struct setting allowed_settings[] = {
                 .name = "icon_theme",
                 .section = "global",
                 .description = "Name of the icon theme",
-                .type = TYPE_STRING,
+                .type = TYPE_LIST,
                 .default_value = "Adwaita",
                 .value = &settings.icon_theme,
                 .parser = NULL,
-                .parser_data = NULL,
+                .parser_data = GINT_TO_POINTER(STRING_LIST),
         },
         {
                 .name = "icon_path",
diff --git a/test/icon-lookup.c b/test/icon-lookup.c
diff --git a/test/icon.c b/test/icon.c
diff --git a/test/test.c b/test/test.c
