zoitechat/src/fe-gtk/icon-resolver.c

#include <string.h>

#include "fe-gtk.h"
#include "icon-resolver.h"
#include "theme/theme-policy.h"
#include "../common/cfgfiles.h"

typedef struct
{
	IconResolverRole role;
	int item;
	const char *custom_icon_name;
	const char *system_icon_name;
	const char *resource_name;
} IconRegistryEntry;

typedef struct
{
	const char *stock_name;
	const char *system_icon_name;
} StockIconMap;

static const IconRegistryEntry icon_registry[] = {
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_NEW, "zc-menu-new", "document-new", "new" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_NETWORK_LIST, "zc-menu-network-list", "view-list", "network-list" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_LOAD_PLUGIN, "zc-menu-load-plugin", "document-open", "load-plugin" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_DETACH, "zc-menu-detach", "edit-redo", "detach" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_CLOSE, "zc-menu-close", "window-close", "close" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_QUIT, "zc-menu-quit", "application-exit", "quit" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_DISCONNECT, "zc-menu-disconnect", "network-disconnect", "disconnect" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_CONNECT, "zc-menu-connect", "network-connect", "connect" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_JOIN, "zc-menu-join", "go-jump", "join" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_PREFERENCES, "zc-menu-preferences", "preferences-system", "preferences" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_CLEAR, "zc-menu-clear", "edit-clear", "clear" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_COPY, "zc-menu-copy", "edit-copy", "copy" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_DELETE, "zc-menu-delete", "edit-delete", "delete" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_ADD, "zc-menu-add", "list-add", "add" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_REMOVE, "zc-menu-remove", "list-remove", "remove" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_SPELL_CHECK, "zc-menu-spell-check", "tools-check-spelling", "spell-check" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_SAVE, "zc-menu-save", "document-save", "save" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_SAVE_AS, "zc-menu-save-as", "document-save-as", "save-as" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_REFRESH, "zc-menu-refresh", "view-refresh", "refresh" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_SEARCH, "zc-menu-search", "edit-find", "search" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_FIND, "zc-menu-find", "edit-find", "find" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_PREVIOUS, "zc-menu-previous", "go-previous", "previous" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_NEXT, "zc-menu-next", "go-next", "next" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_HELP, "zc-menu-help", "help-browser", "help" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_ABOUT, "zc-menu-about", "help-about", "about" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_EMOJI, "zc-menu-emoji", "face-smile", "emoji" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_UPDATE, "zc-menu-update", "software-update-available", "update" },
	{ ICON_RESOLVER_ROLE_MENU_ACTION, ICON_RESOLVER_MENU_ACTION_CHANLIST, "zc-menu-chanlist", "network-workgroup", "chanlist" },
	{ ICON_RESOLVER_ROLE_TRAY_STATE, ICON_RESOLVER_TRAY_STATE_NORMAL, NULL, "zoitechat", "tray_normal" },
	{ ICON_RESOLVER_ROLE_TRAY_STATE, ICON_RESOLVER_TRAY_STATE_FILEOFFER, NULL, "mail-attachment", "tray_fileoffer" },
	{ ICON_RESOLVER_ROLE_TRAY_STATE, ICON_RESOLVER_TRAY_STATE_HIGHLIGHT, NULL, "dialog-warning", "tray_highlight" },
	{ ICON_RESOLVER_ROLE_TRAY_STATE, ICON_RESOLVER_TRAY_STATE_MESSAGE, NULL, "mail-unread", "tray_message" },
	{ ICON_RESOLVER_ROLE_TREE_TYPE, ICON_RESOLVER_TREE_TYPE_CHANNEL, NULL, "folder", "tree_channel" },
	{ ICON_RESOLVER_ROLE_TREE_TYPE, ICON_RESOLVER_TREE_TYPE_DIALOG, NULL, "mail-message-new", "tree_dialog" },
	{ ICON_RESOLVER_ROLE_TREE_TYPE, ICON_RESOLVER_TREE_TYPE_SERVER, NULL, "network-server", "tree_server" },
	{ ICON_RESOLVER_ROLE_TREE_TYPE, ICON_RESOLVER_TREE_TYPE_UTIL, NULL, "applications-utilities", "tree_util" },
	{ ICON_RESOLVER_ROLE_USERLIST_RANK, ICON_RESOLVER_USERLIST_RANK_VOICE, NULL, "emblem-ok", "ulist_voice" },
	{ ICON_RESOLVER_ROLE_USERLIST_RANK, ICON_RESOLVER_USERLIST_RANK_HALFOP, NULL, "emblem-shared", "ulist_halfop" },
	{ ICON_RESOLVER_ROLE_USERLIST_RANK, ICON_RESOLVER_USERLIST_RANK_OP, NULL, "emblem-default", "ulist_op" },
	{ ICON_RESOLVER_ROLE_USERLIST_RANK, ICON_RESOLVER_USERLIST_RANK_OWNER, NULL, "emblem-favorite", "ulist_owner" },
	{ ICON_RESOLVER_ROLE_USERLIST_RANK, ICON_RESOLVER_USERLIST_RANK_FOUNDER, NULL, "emblem-favorite", "ulist_founder" },
	{ ICON_RESOLVER_ROLE_USERLIST_RANK, ICON_RESOLVER_USERLIST_RANK_NETOP, NULL, "emblem-system", "ulist_netop" }
};

static const StockIconMap stock_icon_map[] = {
	{ "gtk-new", "document-new" },
	{ "gtk-open", "document-open" },
	{ "gtk-revert-to-saved", "document-open" },
	{ "gtk-save", "document-save" },
	{ "gtk-save-as", "document-save-as" },
	{ "gtk-add", "list-add" },
	{ "gtk-cancel", "dialog-cancel" },
	{ "gtk-ok", "dialog-ok" },
	{ "gtk-no", "dialog-cancel" },
	{ "gtk-yes", "dialog-ok" },
	{ "gtk-apply", "dialog-apply" },
	{ "gtk-dialog-error", "dialog-error" },
	{ "gtk-copy", "edit-copy" },
	{ "gtk-delete", "edit-delete" },
	{ "gtk-remove", "list-remove" },
	{ "gtk-clear", "edit-clear" },
	{ "gtk-redo", "edit-redo" },
	{ "gtk-find", "edit-find" },
	{ "gtk-justify-left", "edit-find" },
	{ "gtk-refresh", "view-refresh" },
	{ "gtk-go-back", "go-previous" },
	{ "gtk-go-forward", "go-next" },
	{ "gtk-index", "view-list" },
	{ "gtk-jump-to", "go-jump" },
	{ "gtk-media-play", "media-playback-start" },
	{ "gtk-preferences", "preferences-system" },
	{ "gtk-help", "help-browser" },
	{ "gtk-about", "help-about" },
	{ "gtk-close", "window-close" },
	{ "gtk-quit", "application-exit" },
	{ "gtk-connect", "network-connect" },
	{ "gtk-disconnect", "network-disconnect" },
	{ "gtk-network", "network-workgroup" },
	{ "gtk-spell-check", "tools-check-spelling" }
};


static int
menu_action_from_icon_name (const char *icon_name)
{
	size_t i;

	if (!icon_name)
		return -1;

	for (i = 0; i < G_N_ELEMENTS (icon_registry); i++)
	{
		if (icon_registry[i].role != ICON_RESOLVER_ROLE_MENU_ACTION)
			continue;

		if (icon_registry[i].system_icon_name && strcmp (icon_name, icon_registry[i].system_icon_name) == 0)
			return icon_registry[i].item;
	}

	return -1;
}

static const IconRegistryEntry *
icon_registry_find (IconResolverRole role, int item)
{
	size_t i;

	for (i = 0; i < G_N_ELEMENTS (icon_registry); i++)
	{
		if (icon_registry[i].role == role && icon_registry[i].item == item)
			return &icon_registry[i];
	}

	return NULL;
}

static const IconRegistryEntry *
icon_registry_find_custom (const char *custom_icon_name)
{
	size_t i;

	if (!custom_icon_name)
		return NULL;

	for (i = 0; i < G_N_ELEMENTS (icon_registry); i++)
	{
		if (icon_registry[i].custom_icon_name && strcmp (icon_registry[i].custom_icon_name, custom_icon_name) == 0)
			return &icon_registry[i];
	}

	return NULL;
}

const char *
icon_resolver_icon_name_from_stock (const char *stock_name)
{
	size_t i;

	if (!stock_name)
		return NULL;

	for (i = 0; i < G_N_ELEMENTS (stock_icon_map); i++)
	{
		if (strcmp (stock_name, stock_icon_map[i].stock_name) == 0)
			return stock_icon_map[i].system_icon_name;
	}

	return stock_name;
}

gboolean
icon_resolver_menu_action_from_name (const char *name, int *action_out)
{
	size_t i;

	if (!name)
		return FALSE;

	for (i = 0; i < G_N_ELEMENTS (icon_registry); i++)
	{
		if (icon_registry[i].role != ICON_RESOLVER_ROLE_MENU_ACTION)
			continue;

		if ((icon_registry[i].custom_icon_name && strcmp (name, icon_registry[i].custom_icon_name) == 0) ||
		    (icon_registry[i].system_icon_name && strcmp (name, icon_registry[i].system_icon_name) == 0))
		{
			if (action_out)
				*action_out = icon_registry[i].item;
			return TRUE;
		}
	}

	for (i = 0; i < G_N_ELEMENTS (stock_icon_map); i++)
	{
		if (strcmp (name, stock_icon_map[i].stock_name) == 0)
		{
			int action = menu_action_from_icon_name (stock_icon_map[i].system_icon_name);

			if (action >= 0)
			{
				if (action_out)
					*action_out = action;
				return TRUE;
			}
		}
	}

	return FALSE;
}

const char *
icon_resolver_icon_name_for_menu_custom (const char *custom_icon_name)
{
	const IconRegistryEntry *entry = icon_registry_find_custom (custom_icon_name);

	if (!entry)
		return NULL;

	return entry->system_icon_name;
}

gboolean
icon_resolver_menu_action_from_custom (const char *custom_icon_name, int *action_out)
{
	const IconRegistryEntry *entry = icon_registry_find_custom (custom_icon_name);

	if (!entry || entry->role != ICON_RESOLVER_ROLE_MENU_ACTION)
		return FALSE;

	if (action_out)
		*action_out = entry->item;

	return TRUE;
}

const char *
icon_resolver_system_icon_name (IconResolverRole role, int item)
{
	const IconRegistryEntry *entry = icon_registry_find (role, item);

	if (!entry)
		return NULL;

	return entry->system_icon_name;
}

IconResolverThemeVariant
icon_resolver_detect_theme_variant (void)
{
	if (theme_policy_is_app_dark_mode_active ())
		return ICON_RESOLVER_THEME_DARK;

	return ICON_RESOLVER_THEME_LIGHT;
}

static gboolean
resource_exists (const char *resource_path)
{
	return g_resources_get_info (resource_path, G_RESOURCE_LOOKUP_FLAGS_NONE, NULL, NULL, NULL);
}

static char *
resolve_user_override (const IconRegistryEntry *entry, IconResolverThemeVariant variant)
{
	const char *variant_name = variant == ICON_RESOLVER_THEME_DARK ? "dark" : "light";
	char *path;

	path = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "icons" G_DIR_SEPARATOR_S "%s" G_DIR_SEPARATOR_S "%s.png",
	                        get_xdir (), variant_name, entry->resource_name);
	if (g_file_test (path, G_FILE_TEST_EXISTS))
		return path;
	g_free (path);

	path = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "icons" G_DIR_SEPARATOR_S "%s-%s.png",
	                        get_xdir (), entry->resource_name, variant_name);
	if (g_file_test (path, G_FILE_TEST_EXISTS))
		return path;
	g_free (path);

	path = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "icons" G_DIR_SEPARATOR_S "%s.png",
	                        get_xdir (), entry->resource_name);
	if (g_file_test (path, G_FILE_TEST_EXISTS))
		return path;
	g_free (path);

	return NULL;
}

static char *
resolve_bundled_variant (const IconRegistryEntry *entry, IconResolverThemeVariant variant)
{
	const char *variant_name = variant == ICON_RESOLVER_THEME_DARK ? "dark" : "light";
	char *path;

	if (entry->role == ICON_RESOLVER_ROLE_MENU_ACTION)
	{
		path = g_strdup_printf ("/icons/menu/%s/%s.png", variant_name, entry->resource_name);
		if (resource_exists (path))
			return path;
		g_free (path);

		path = g_strdup_printf ("/icons/menu/%s/%s.svg", variant_name, entry->resource_name);
		if (resource_exists (path))
			return path;
		g_free (path);
	}
	else
	{
		path = g_strdup_printf ("/icons/%s-%s.png", entry->resource_name, variant_name);
		if (resource_exists (path))
			return path;
		g_free (path);
	}

	return NULL;
}

static char *
resolve_bundled_neutral (const IconRegistryEntry *entry)
{
	char *path;

	if (entry->role == ICON_RESOLVER_ROLE_MENU_ACTION)
	{
		path = g_strdup_printf ("/icons/menu/light/%s.png", entry->resource_name);
		if (resource_exists (path))
			return path;
		g_free (path);

		path = g_strdup_printf ("/icons/menu/light/%s.svg", entry->resource_name);
		if (resource_exists (path))
			return path;
		g_free (path);
	}
	else
	{
		path = g_strdup_printf ("/icons/%s.png", entry->resource_name);
		if (resource_exists (path))
			return path;
		g_free (path);
	}

	return NULL;
}

char *
icon_resolver_resolve_path (IconResolverRole role, int item, GtkIconSize size,
                            const char *context, IconResolverThemeVariant variant,
                            const char **system_icon_name)
{
	const IconRegistryEntry *entry;
	IconResolverThemeVariant effective_variant = variant;
	char *path;

	(void)size;
	(void)context;

	entry = icon_registry_find (role, item);
	if (!entry)
		return NULL;

	if (system_icon_name)
		*system_icon_name = entry->system_icon_name;

	if (effective_variant == ICON_RESOLVER_THEME_SYSTEM)
		effective_variant = icon_resolver_detect_theme_variant ();

	path = resolve_user_override (entry, effective_variant);
	if (path)
		return path;

	path = resolve_bundled_variant (entry, effective_variant);
	if (path)
		return path;

	return resolve_bundled_neutral (entry);
}