Load window icons from a custom icon theme

The window icons used to be set by the tileset. This allowed user-made tilesets to override our branding and required loading tilesets before the first window was shown. This commit moves the app icons away from tilesets into a custom icon theme (this should eventually be merged into the hicolor theme). Closes #984. Closes #2019.
longturn · Dec 29, 2023 · e47752e · e47752e
1 parent 90a7cb2
commit e47752e
Show file tree

Hide file tree

Showing 20 changed files with 66 additions and 72 deletions.
diff --git a/client/gui_main.cpp b/client/gui_main.cpp
@@ -69,10 +69,16 @@ int main(int argc, char **argv) { return client_main(argc, argv); }
  */
 void ui_main()
 {
+  // Load window icons
+  QIcon::setThemeSearchPaths(get_data_dirs() + QIcon::themeSearchPaths());
+  QIcon::setFallbackThemeName(QIcon::themeName());
+  QIcon::setThemeName(QStringLiteral("icons"));
+
+  qApp->setWindowIcon(QIcon::fromTheme(QStringLiteral("freeciv21-client")));
+
   if (true) {
     tileset_init(tileset);
     tileset_load_tiles(tileset);
-    qApp->setWindowIcon(QIcon(*get_icon_sprite(tileset)));
     if (!load_theme(gui_options->gui_qt_default_theme_name)) {
       gui_clear_theme();
     }

diff --git a/client/tileset/tilespec.cpp b/client/tileset/tilespec.cpp
@@ -154,8 +154,6 @@ struct named_sprites {
       *treaty_thumb[2],   // 0=disagree, 1=agree
       *arrow[ARROW_LAST], // 0=right arrow, 1=plus, 2=minus
 
-      *icon,
-
       *events[E_COUNT],
 
       // The panel sprites for showing tax % allocations.
@@ -2556,8 +2554,6 @@ static void tileset_lookup_sprite_tags(struct tileset *t)
     }
   }
 
-  SET_SPRITE(icon, QStringLiteral("icon.freeciv"));
-
   for (i = 0; i < E_COUNT; i++) {
     const char *tag = get_event_tag(static_cast<event_type>(i));
 
@@ -5294,20 +5290,6 @@ const QPixmap *get_cursor_sprite(const struct tileset *t,
   return t->sprites.cursor[cursor].frame[frame];
 }
 
-/**
-   Return a sprite for the Freeciv21 icon.  Icons are used by the operating
-   system/window manager.  Usually Freeciv21 has to tell the OS what icon to
-   use.
-
-   Note that this function will return nullptr before the sprites are loaded.
-   The GUI code must be sure to call tileset_load_tiles before setting the
-   top-level icon.
- */
-const QPixmap *get_icon_sprite(const struct tileset *t)
-{
-  return t->sprites.icon;
-}
-
 /**
    Returns a sprite with the "user-attention" crosshair graphic.
 

diff --git a/client/tileset/tilespec.h b/client/tileset/tilespec.h
@@ -256,7 +256,6 @@ const QPixmap *get_cursor_sprite(const struct tileset *t,
                                  int *hot_y, int frame);
 const struct citybar_sprites *get_citybar_sprites(const struct tileset *t);
 const struct editor_sprites *get_editor_sprites(const struct tileset *t);
-const QPixmap *get_icon_sprite(const struct tileset *t);
 const QPixmap *get_attention_crosshair_sprite(const struct tileset *t);
 const QPixmap *get_indicator_sprite(const struct tileset *t,
                                     enum indicator_type indicator,

diff --git a/cmake/FreecivInstall.cmake b/cmake/FreecivInstall.cmake
@@ -47,12 +47,6 @@ if(WIN32 OR MSYS OR MINGW)
     ${CMAKE_SOURCE_DIR}/data/icons/128x128/freeciv21-server.ico
     DESTINATION ${CMAKE_INSTALL_BINDIR}
     COMPONENT freeciv21)
-
-  install(
-    FILES
-    ${CMAKE_SOURCE_DIR}/data/icons/128x128/freeciv21-client.png
-    DESTINATION ${CMAKE_INSTALL_BINDIR}/data/misc
-    COMPONENT freeciv21)
 endif()
 
 # MSYS2 and MINGW specific installation
@@ -169,6 +163,10 @@ if(UNIX AND NOT APPLE)
     message(STATUS "CMAKE_INSTALL_PREFIX changed from the default to /usr.")
   endif()
 
+  install(FILES ${CMAKE_SOURCE_DIR}/data/icons/index.theme
+          DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/freeciv21/icons
+          COMPONENT freeciv21)
+
   # Install MetaInfo and Desktop files for the applications asked for at configure
   if(FREECIV_ENABLE_CLIENT)
     configure_file(${CMAKE_SOURCE_DIR}/dist/net.longturn.freeciv21.desktop.in
@@ -189,12 +187,11 @@ if(UNIX AND NOT APPLE)
       DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/metainfo
       COMPONENT freeciv21
     )
-    install(
-      FILES
-      ${CMAKE_SOURCE_DIR}/data/icons/128x128/freeciv21-client.png
-      DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/freeciv21/misc
-      COMPONENT freeciv21
-    )
+    install(DIRECTORY ${CMAKE_SOURCE_DIR}/data/icons
+            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/freeciv21
+            COMPONENT freeciv21
+            FILES_MATCHING PATTERN "freeciv21-client.png")
+
     if(FREECIV_ENABLE_MANPAGES)
       install(
         FILES
@@ -224,12 +221,11 @@ if(UNIX AND NOT APPLE)
       DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/metainfo
       COMPONENT freeciv21
     )
-    install(
-      FILES
-      ${CMAKE_SOURCE_DIR}/data/icons/128x128/freeciv21-server.png
-      DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/freeciv21/misc
-      COMPONENT freeciv21
-    )
+    install(DIRECTORY ${CMAKE_SOURCE_DIR}/data/icons
+            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/freeciv21
+            COMPONENT freeciv21
+            FILES_MATCHING PATTERN "freeciv21-server.png")
+
     if(FREECIV_ENABLE_MANPAGES)
       install(
         FILES
@@ -262,12 +258,10 @@ if(UNIX AND NOT APPLE)
       DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/metainfo
       COMPONENT freeciv21
     )
-    install(
-      FILES
-      ${CMAKE_SOURCE_DIR}/data/icons/128x128/freeciv21-modpack.png
-      DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/freeciv21/misc
-      COMPONENT freeciv21
-    )
+    install(DIRECTORY ${CMAKE_SOURCE_DIR}/data/icons
+            DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/freeciv21
+            COMPONENT freeciv21
+            FILES_MATCHING PATTERN "freeciv21-modpack.png")
 
     if(FREECIV_ENABLE_MANPAGES)
       install(

diff --git a/data/amplio2.tilespec b/data/amplio2.tilespec
@@ -166,8 +166,7 @@ files =
   "misc/overlays.spec",
   "misc/citybar.spec",
   "misc/shields-large.spec",
-  "misc/editor.spec",
-  "misc/icons.spec"
+  "misc/editor.spec"
 
 
 ; Include color definitions

diff --git a/data/cimpletoon.tilespec b/data/cimpletoon.tilespec
@@ -169,8 +169,7 @@ files =
   "misc/overlays.spec",
   "misc/citybar.spec",
   "misc/shields-large.spec",
-  "misc/editor.spec",
-  "misc/icons.spec"
+  "misc/editor.spec"
 
 
 ; Include color definitions

diff --git a/data/hex2t.tilespec b/data/hex2t.tilespec
@@ -158,7 +158,6 @@ files =
   "misc/space.spec",
   "misc/techs.spec",
   "misc/treaty.spec",
-  "misc/icons.spec",
   "misc/editor.spec",
   "amplio2/nuke.spec"
 

diff --git a/data/hexemplio.tilespec b/data/hexemplio.tilespec
@@ -153,7 +153,6 @@ files =
   "misc/space.spec",
   "misc/techs.spec",
   "misc/treaty.spec",
-  "misc/icons.spec",
   "misc/editor.spec",
   "misc/units.spec",
   "amplio2/nuke.spec",

diff --git a/data/icons/index.theme b/data/icons/index.theme
@@ -0,0 +1,20 @@
+[Icon Theme]
+Name=Freeciv21
+Comment=Freeciv21 Icons
+
+Directories=16x16,32x32,48x48,64x64,128x128
+
+[16x16]
+Size=16
+
+[32x32]
+Size=32
+
+[48x48]
+Size=48
+
+[64x64]
+Size=64
+
+[128x128]
+Size=128
diff --git a/data/isophex.tilespec b/data/isophex.tilespec
@@ -160,7 +160,6 @@ files =
   "misc/space.spec",
   "misc/techs.spec",
   "misc/treaty.spec",
-  "misc/icons.spec",
   "misc/editor.spec",
   "isotrident/nuke.spec",
   "isotrident/cities.spec",

diff --git a/data/isotrident.tilespec b/data/isotrident.tilespec
@@ -158,7 +158,6 @@ files =
   "misc/space.spec",
   "misc/techs.spec",
   "misc/treaty.spec",
-  "misc/icons.spec",
   "misc/editor.spec",
   "isotrident/fog.spec",
   "isotrident/nuke.spec",

diff --git a/data/misc/icons.spec b/data/misc/icons.spec
@@ -1,19 +1,6 @@
-
 [spec]
 
 ; Format and options of this spec file:
 options = "+Freeciv-spec-Devel-2019-Jul-03"
 
-[info]
-
-artists = "
-    James Blewitt, Hugo Flávio, Louis Moureaux (civicon)
-    yd (mpicon)
-"
-
-[extra]
-sprites =
-	{	"tag", "file"
-		"icon.freeciv", "misc/freeciv21-client"
-		; misc/mpicon.png is referenced directly from configure.ac
-	}
+; This file is only present for backward compatibility.
diff --git a/data/toonhex.tilespec b/data/toonhex.tilespec
@@ -155,7 +155,6 @@ files =
   "misc/space.spec",
   "misc/techs.spec",
   "misc/treaty.spec",
-  "misc/icons.spec",
   "misc/editor.spec",
   "cimpletoon/orient_units.spec",
   "amplio2/nuke.spec",

diff --git a/data/trident.tilespec b/data/trident.tilespec
@@ -157,7 +157,6 @@ files =
   "misc/space.spec",
   "misc/techs.spec",
   "misc/treaty.spec",
-  "misc/icons.spec",
   "misc/editor.spec",
   "trident/fog.spec",
   "trident/cities.spec",

diff --git a/dist/net.longturn.freeciv21.desktop.in b/dist/net.longturn.freeciv21.desktop.in
@@ -53,7 +53,7 @@ Comment[pt]=Jogo de estratégia por turnos inspirado na História da civilizaç
 Comment[ru]=Пошаговая стратегическая игра, вдохновлённая историей человеческой цивилизации
 Comment[sv]=Turordningsbaserat strategispel inspirerat av den mänskliga historien
 Exec=@CMAKE_INSTALL_FULL_BINDIR@/freeciv21-client %u
-Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/misc/freeciv21-client.png
+Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/icons/128x128/freeciv21-client.png
 StartupNotify=true
 MimeType=x-scheme-handler/fc21;
 X-KDE-Protocols=fc21;

diff --git a/dist/net.longturn.freeciv21.modpack.desktop.in b/dist/net.longturn.freeciv21.modpack.desktop.in
@@ -10,7 +10,7 @@ GenericName[ru]=Стратегическая игра
 Comment=Download and install add-ons for Freeciv21
 Comment[ru]=Скачивайте и устанавливайте дополнения для Freeciv21
 Exec=@CMAKE_INSTALL_FULL_BINDIR@/freeciv21-modpack-qt
-Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/misc/freeciv21-modpack.png
+Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/icons/128x128/freeciv21-modpack.png
 StartupNotify=true
 Terminal=false
 Type=Application

diff --git a/dist/net.longturn.freeciv21.ruledit.desktop.in b/dist/net.longturn.freeciv21.ruledit.desktop.in
@@ -10,7 +10,7 @@ GenericName[ru]=Стратегическая игра
 Comment=Edit Freeciv21 game rules
 Comment[ru]=Меняйте любые правила Freeciv21 и создавайте новые
 Exec=@CMAKE_INSTALL_FULL_BINDIR@/freeciv21-ruledit
-Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/misc/freeciv21-client.png
+Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/icons/128x128/freeciv21-client.png
 StartupNotify=true
 Terminal=false
 Type=Application

diff --git a/dist/net.longturn.freeciv21.server.desktop.in b/dist/net.longturn.freeciv21.server.desktop.in
@@ -22,7 +22,7 @@ Comment[pt]=Jogo de estratégia por turnos inspirado na História da civilizaç
 Comment[ru]=Пошаговая стратегическая игра, вдохновлённая историей человеческой цивилизации
 Comment[sv]=Turordningsbaserat strategispel inspirerat av den mänskliga historien
 Exec=@CMAKE_INSTALL_FULL_BINDIR@/freeciv21-server
-Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/misc/freeciv21-server.png
+Icon=@CMAKE_INSTALL_FULL_DATAROOTDIR@/freeciv21/icons/128x128/freeciv21-server.png
 StartupNotify=true
 Terminal=true
 Type=Application

diff --git a/tools/fcmp/mpgui_qt.cpp b/tools/fcmp/mpgui_qt.cpp
@@ -82,6 +82,13 @@ int main(int argc, char **argv)
   QCoreApplication::setApplicationVersion(freeciv21_version());
   app.setDesktopFileName(QStringLiteral("net.longturn.freeciv21.modpack"));
 
+  // Load window icons
+  QIcon::setThemeSearchPaths(get_data_dirs() + QIcon::themeSearchPaths());
+  QIcon::setFallbackThemeName(QIcon::themeName());
+  QIcon::setThemeName(QStringLiteral("icons"));
+
+  qApp->setWindowIcon(QIcon::fromTheme(QStringLiteral("freeciv21-modpack")));
+
   // Delegate option parsing to the common function.
   fcmp_parse_cmdline(app);
 

diff --git a/tools/ruledit/ruledit.cpp b/tools/ruledit/ruledit.cpp
@@ -59,6 +59,13 @@ int main(int argc, char **argv)
   QCoreApplication::setApplicationVersion(freeciv21_version());
   app.setDesktopFileName(QStringLiteral("net.longturn.freeciv21.ruledit"));
 
+  // Load window icons
+  QIcon::setThemeSearchPaths(get_data_dirs() + QIcon::themeSearchPaths());
+  QIcon::setFallbackThemeName(QIcon::themeName());
+  QIcon::setThemeName(QStringLiteral("icons"));
+
+  qApp->setWindowIcon(QIcon::fromTheme(QStringLiteral("freeciv21-client")));
+
   log_init();
 
   init_nls();