enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity
efl/legacy/efreet/src/lib/efreet_icon.c

1642 lines
45 KiB
C
Raw Blame History

/* vim: set sw=4 ts=4 sts=4 et: */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <dirent.h>
#include <limits.h>
#include <Ecore.h>
#include <Ecore_File.h>
#include "Efreet.h"
#include "efreet_private.h"
static char *efreet_icon_deprecated_user_dir = NULL;
static char *efreet_icon_user_dir = NULL;
static Eina_Hash *efreet_icon_themes = NULL;
static Eina_List *efreet_icon_extensions = NULL;
static Eina_List *efreet_extra_icon_dirs = NULL;
static Eina_Hash *efreet_icon_cache = NULL;
typedef struct Efreet_Icon_Cache Efreet_Icon_Cache;
struct Efreet_Icon_Cache
{
char *key;
char *path;
time_t lasttime;
};
static char *efreet_icon_remove_extension(const char *icon);
static Efreet_Icon_Theme *efreet_icon_find_theme_check(const char *theme_name);
static char *efreet_icon_find_fallback(Efreet_Icon_Theme *theme,
const char *icon,
unsigned int size);
static char *efreet_icon_list_find_fallback(Efreet_Icon_Theme *theme,
Eina_List *icons,
unsigned int size);
static char *efreet_icon_find_helper(Efreet_Icon_Theme *theme,
const char *icon, unsigned int size);
static char *efreet_icon_list_find_helper(Efreet_Icon_Theme *theme,
Eina_List *icons, unsigned int size);
static char *efreet_icon_lookup_icon(Efreet_Icon_Theme *theme,
const char *icon_name, unsigned int size);
static char *efreet_icon_fallback_icon(const char *icon_name);
static char *efreet_icon_fallback_dir_scan(const char *dir,
const char *icon_name);
static char *efreet_icon_lookup_directory(Efreet_Icon_Theme *theme,
Efreet_Icon_Theme_Directory *dir,
const char *icon_name);
static int efreet_icon_directory_size_distance(Efreet_Icon_Theme_Directory *dir,
unsigned int size);
static int efreet_icon_directory_size_match(Efreet_Icon_Theme_Directory *dir,
unsigned int size);
static Efreet_Icon *efreet_icon_new(const char *path);
static void efreet_icon_populate(Efreet_Icon *icon, const char *file);
static char *efreet_icon_lookup_directory_helper(Efreet_Icon_Theme_Directory *dir,
const char *path, const char *icon_name);
static Efreet_Icon_Theme *efreet_icon_theme_new(void);
static void efreet_icon_theme_free(Efreet_Icon_Theme *theme);
static void efreet_icon_theme_dir_scan_all(const char *theme_name);
static void efreet_icon_theme_dir_scan(const char *dir,
const char *theme_name);
static void efreet_icon_theme_dir_validity_check(void);
static void efreet_icon_theme_path_add(Efreet_Icon_Theme *theme,
const char *path);
static void efreet_icon_theme_index_read(Efreet_Icon_Theme *theme,
const char *path);
static Efreet_Icon_Theme_Directory *efreet_icon_theme_directory_new(Efreet_Ini *ini,
const char *name);
static void efreet_icon_theme_directory_free(Efreet_Icon_Theme_Directory *dir);
static void efreet_icon_theme_cache_check(Efreet_Icon_Theme *theme);
static int efreet_icon_theme_cache_check_dir(Efreet_Icon_Theme *theme,
const char *dir);
static int efreet_icon_cache_find(Efreet_Icon_Cache *value, const char *key);
static void efreet_icon_cache_flush(Efreet_Icon_Theme *theme, Eina_List *list);
static void efreet_icon_cache_free(Efreet_Icon_Cache *value);
static char *efreet_icon_cache_check(Efreet_Icon_Theme *theme, const char *icon, unsigned int size);
static void efreet_icon_cache_add(Efreet_Icon_Theme *theme, const char *icon, unsigned int size, const char *value);
static Efreet_Icon_Theme *fake_null = NULL;
static void
_efreet_icon_cache_list_destroy(Eina_List *list)
{
Efreet_Icon_Cache *cache;
EINA_LIST_FREE(list, cache)
efreet_icon_cache_free(cache);
}
/**
* @internal
* @return Returns 1 on success or 0 on failure
* @brief Initializes the icon system
*/
int
efreet_icon_init(void)
{
if (!efreet_icon_themes)
{
const char *default_exts[] = {".png", ".xpm", NULL};
int i;
if (!ecore_init())
{
return 0;
}
/* setup the default extension list */
for (i = 0; default_exts[i] != NULL; i++)
efreet_icon_extensions = eina_list_append(efreet_icon_extensions, strdup(default_exts[i]));
efreet_icon_themes = eina_hash_string_superfast_new(EINA_FREE_CB(efreet_icon_theme_free));
efreet_extra_icon_dirs = NULL;
efreet_icon_cache = eina_hash_pointer_new(EINA_FREE_CB(_efreet_icon_cache_list_destroy));
}
return 1;
}
/**
* @internal
* @return Returns no value
* @brief Shuts down the icon system
*/
void
efreet_icon_shutdown(void)
{
IF_FREE(efreet_icon_user_dir);
IF_FREE(efreet_icon_deprecated_user_dir);
IF_FREE_LIST(efreet_icon_extensions, free);
IF_FREE_HASH(efreet_icon_themes);
efreet_extra_icon_dirs = eina_list_free(efreet_extra_icon_dirs);
IF_FREE_HASH(efreet_icon_cache);
if (fake_null)
{
efreet_icon_theme_free(fake_null);
fake_null = NULL;
}
ecore_shutdown();
}
/**
* @return Returns the user icon directory
* @brief Returns the user icon directory
*/
const char *
efreet_icon_deprecated_user_dir_get(void)
{
const char *user;
int len;
if (efreet_icon_deprecated_user_dir) return efreet_icon_deprecated_user_dir;
user = efreet_home_dir_get();
len = strlen(user) + strlen("/.icons") + 1;
efreet_icon_deprecated_user_dir = malloc(sizeof(char) * len);
snprintf(efreet_icon_deprecated_user_dir, len, "%s/.icons", user);
return efreet_icon_deprecated_user_dir;
}
EAPI const char *
efreet_icon_user_dir_get(void)
{
const char *user;
int len;
if (efreet_icon_user_dir) return efreet_icon_user_dir;
user = efreet_data_home_get();
len = strlen(user) + strlen("/icons") + 1;
efreet_icon_user_dir = malloc(sizeof(char) * len);
snprintf(efreet_icon_user_dir, len, "%s/icons", user);
return efreet_icon_user_dir;
}
/**
* @param ext: The extension to add to the list of checked extensions
* @return Returns no value.
* @brief Adds the given extension to the list of possible icon extensions
*/
EAPI void
efreet_icon_extension_add(const char *ext)
{
efreet_icon_extensions = eina_list_prepend(efreet_icon_extensions, strdup(ext));
}
/**
* @return Returns a list of strings that are paths to other icon directories
* @brief Gets the list of all extra directories to look for icons. These
* directories are used to look for icons after looking in the user icon dir
* and before looking in standard system directories. The order of search is
* from first to last directory in this list. the strings in the list should
* be created with eina_stringshare_add().
*/
EAPI Eina_List **
efreet_icon_extra_list_get(void)
{
return &efreet_extra_icon_dirs;
}
static Eina_Bool
_hash_keys(Eina_Hash *hash __UNUSED__, const void *key, void *list)
{
*(Eina_List**)list = eina_list_append(*(Eina_List**)list, key);
return EINA_TRUE;
}
/**
* @return Returns a list of Efreet_Icon structs for all the non-hidden icon
* themes
* @brief Retrieves all of the non-hidden icon themes available on the system.
* The returned list must be freed. Do not free the list data.
*/
EAPI Eina_List *
efreet_icon_theme_list_get(void)
{
Eina_List *list = NULL;
Eina_List *theme_list = NULL;
char *dir;
Eina_Iterator *it;
/* update the list to include all icon themes */
efreet_icon_theme_dir_scan_all(NULL);
efreet_icon_theme_dir_validity_check();
/* create the list for the user */
it = eina_hash_iterator_key_new(efreet_icon_themes);
eina_iterator_foreach(it, EINA_EACH(_hash_keys), &theme_list);
eina_iterator_free(it);
EINA_LIST_FREE(theme_list, dir)
{
Efreet_Icon_Theme *theme;
theme = eina_hash_find(efreet_icon_themes, dir);
if (theme->hidden || theme->fake) continue;
#ifndef STRICT_SPEC
if (!theme->name.name) continue;
#endif
list = eina_list_append(list, theme);
}
return list;
}
/**
* @param theme_name: The theme to look for
* @return Returns the icon theme related to the given theme name or NULL if
* none exists.
* @brief Tries to get the icon theme structure for the given theme name
*/
EAPI Efreet_Icon_Theme *
efreet_icon_theme_find(const char *theme_name)
{
Efreet_Icon_Theme *theme;
if (!theme_name) return fake_null;
theme = eina_hash_find(efreet_icon_themes, theme_name);
if (!theme)
{
efreet_icon_theme_dir_scan_all(theme_name);
theme = eina_hash_find(efreet_icon_themes, theme_name);
}
return theme;
}
/**
* @internal
* @param icon: The icon name to strip extension
* @return Extension removed if in list of extensions, else untouched.
* @brief Removes extension from icon name if in list of extensions.
*/
static char *
efreet_icon_remove_extension(const char *icon)
{
Eina_List *l;
char *tmp = NULL, *ext = NULL;
if (!icon) return NULL;
tmp = strdup(icon);
ext = strrchr(tmp, '.');
if (ext)
{
const char *ext2;
EINA_LIST_FOREACH(efreet_icon_extensions, l, ext2)
{
if (!strcmp(ext, ext2))
{
#ifdef STRICT_SPEC
WRN("[Efreet]: Requesting an icon with an extension: %s",
icon);
#endif
*ext = '\0';
break;
}
}
}
return tmp;
}
/**
* @internal
* @param theme_name: The icon theme to look for
* @return Returns the Efreet_Icon_Theme structure representing this theme
* or a new blank theme if not found
* @brief Retrieves a theme, or creates a blank one if not found.
*/
static Efreet_Icon_Theme *
efreet_icon_find_theme_check(const char *theme_name)
{
Efreet_Icon_Theme *theme = NULL;
if (theme_name) theme = efreet_icon_theme_find(theme_name);
if (!theme)
{
if ((fake_null) && (!theme_name)) return fake_null;
theme = efreet_icon_theme_new();
theme->fake = 1;
if (theme_name)
{
theme->name.internal = eina_stringshare_add(theme_name);
eina_hash_del(efreet_icon_themes, (void *)theme->name.internal, NULL);
eina_hash_add(efreet_icon_themes, (void *)theme->name.internal, theme);
}
else
{
theme->name.internal = NULL;
fake_null = theme;
}
}
return theme;
}
/**
* @param theme_name: The icon theme to look for
* @param icon: The icon to look for
* @param size; The icon size to look for
* @return Returns the path to the given icon or NULL if none found
* @brief Retrives the path to the given icon.
*/
EAPI char *
efreet_icon_path_find(const char *theme_name, const char *icon, unsigned int size)
{
const char *cached;
char *value;
Efreet_Icon_Theme *theme;
if ((cached = efreet_icon_hash_get(theme_name, icon, size)) != NULL)
{
if (cached == NON_EXISTING) return NULL;
return strdup(cached);
}
theme = efreet_icon_find_theme_check(theme_name);
#ifdef SLOPPY_SPEC
{
char *tmp;
tmp = efreet_icon_remove_extension(icon);
value = efreet_icon_find_helper(theme, tmp, size);
FREE(tmp);
}
#else
value = efreet_icon_find_helper(theme, icon, size);
#endif
/* we didn't find the icon in the theme or in the inherited directories
* then just look for a non theme icon
*/
if (!value || (value == NON_EXISTING)) value = efreet_icon_fallback_icon(icon);
efreet_icon_hash_put(theme_name, icon, size, value);
if (value == NON_EXISTING) value = NULL;
return value;
}
/**
* @param theme_name: The icon theme to look for
* @param icons: List of icons to look for
* @param size; The icon size to look for
* @return Returns the path representing first found icon or
* NULL if none of the icons are found
* @brief Retrieves all of the information about the first found icon in
* the list.
* @note This function will search the given theme for all icons before falling
* back. This is useful when searching for mimetype icons.
*/
EAPI char *
efreet_icon_list_find(const char *theme_name, Eina_List *icons,
unsigned int size)
{
Eina_List *l;
const char *icon = NULL;
char *value = NULL;
char *data;
Efreet_Icon_Theme *theme;
theme = efreet_icon_find_theme_check(theme_name);
#ifdef SLOPPY_SPEC
{
Eina_List *tmps = NULL;
EINA_LIST_FOREACH(icons, l, icon)
tmps = eina_list_append(tmps, efreet_icon_remove_extension(icon));
value = efreet_icon_list_find_helper(theme, tmps, size);
EINA_LIST_FREE(tmps, data)
free(data);
}
#else
value = efreet_icon_list_find_helper(theme, icons, size);
#endif
/* we didn't find the icons in the theme or in the inherited directories
* then just look for a non theme icon
*/
if (!value || (value == NON_EXISTING))
{
EINA_LIST_FOREACH(icons, l, icon)
{
value = efreet_icon_fallback_icon(icon);
if (value && (value != NON_EXISTING))
break;
}
}
if (value == NON_EXISTING) value = NULL;
return value;
}
/**
* @param theme: The icon theme to look for
* @param icon: The icon to look for
* @param size: The icon size to look for
* @return Returns the Efreet_Icon structure representing this icon or NULL
* if the icon is not found
* @brief Retrieves all of the information about the given icon.
*/
EAPI Efreet_Icon *
efreet_icon_find(const char *theme_name, const char *icon, unsigned int size)
{
char *path;
path = efreet_icon_path_find(theme_name, icon, size);
if (path)
{
Efreet_Icon *icon;
icon = efreet_icon_new(path);
free(path);
return icon;
}
return NULL;
}
/**
* @internal
* @param theme: The theme to search in
* @param icon: The icon to search for
* @param size: The size to search for
* @return Returns the icon matching the given information or NULL if no
* icon found
* @brief Scans inheriting themes for the given icon
*/
static char *
efreet_icon_find_fallback(Efreet_Icon_Theme *theme,
const char *icon, unsigned int size)
{
Eina_List *l;
char *parent = NULL;
char *value = NULL;
if (theme->inherits)
{
EINA_LIST_FOREACH(theme->inherits, l, parent)
{
Efreet_Icon_Theme *parent_theme;
parent_theme = efreet_icon_theme_find(parent);
if ((!parent_theme) || (parent_theme == theme)) continue;
value = efreet_icon_find_helper(parent_theme, icon, size);
if (value && (value != NON_EXISTING)) break;
}
}
/* if this isn't the hicolor theme, and we have no other fallbacks
* check hicolor */
else if (strcmp(theme->name.internal, "hicolor"))
{
Efreet_Icon_Theme *parent_theme;
parent_theme = efreet_icon_theme_find("hicolor");
if (parent_theme)
value = efreet_icon_find_helper(parent_theme, icon, size);
}
return value;
}
/**
* @internal
* @param theme: The theme to search in
* @param icon: The icon to search for
* @param size: The size to search for
* @return Returns the icon matching the given information or NULL if no
* icon found
* @brief Scans the theme and any inheriting themes for the given icon
*/
static char *
efreet_icon_find_helper(Efreet_Icon_Theme *theme,
const char *icon, unsigned int size)
{
char *value;
static int recurse = 0;
efreet_icon_theme_cache_check(theme);
/* go no further if this theme is fake */
if (theme->fake || !theme->valid) return NULL;
/* limit recursion in finding themes and inherited themes to 256 levels */
if (recurse > 256) return NULL;
recurse++;
value = efreet_icon_lookup_icon(theme, icon, size);
/* we didin't find the image check the inherited themes */
if (!value || (value == NON_EXISTING))
value = efreet_icon_find_fallback(theme, icon, size);
recurse--;
return value;
}
/**
* @internal
* @param theme: The theme to search in
* @param icons: The icons to search for
* @param size: The size to search for
* @return Returns the icon matching the given information or NULL if no
* icon found
* @brief Scans inheriting themes for the given icons
*/
static char *
efreet_icon_list_find_fallback(Efreet_Icon_Theme *theme,
Eina_List *icons, unsigned int size)
{
Eina_List *l;
char *parent = NULL;
char *value = NULL;
if (theme->inherits)
{
EINA_LIST_FOREACH(theme->inherits, l, parent)
{
Efreet_Icon_Theme *parent_theme;
parent_theme = efreet_icon_theme_find(parent);
if ((!parent_theme) || (parent_theme == theme)) continue;
value = efreet_icon_list_find_helper(parent_theme,
icons, size);
if (value && (value != NON_EXISTING)) break;
}
}
/* if this isn't the hicolor theme, and we have no other fallbacks
* check hicolor
*/
else if (strcmp(theme->name.internal, "hicolor"))
{
Efreet_Icon_Theme *parent_theme;
parent_theme = efreet_icon_theme_find("hicolor");
if (parent_theme)
value = efreet_icon_list_find_helper(parent_theme,
icons, size);
}
return value;
}
/**
* @internal
* @param theme: The theme to search in
* @param icons: The icons to search for
* @param size: The size to search for
* @return Returns the icon matching the given information or NULL if no
* icon found
* @brief Scans the theme and any inheriting themes for the given icons
*/
static char *
efreet_icon_list_find_helper(Efreet_Icon_Theme *theme,
Eina_List *icons, unsigned int size)
{
Eina_List *l;
char *value = NULL;
const char *icon = NULL;
static int recurse = 0;
efreet_icon_theme_cache_check(theme);
/* go no further if this theme is fake */
if (theme->fake || !theme->valid) return NULL;
/* limit recursion in finding themes and inherited themes to 256 levels */
if (recurse > 256) return NULL;
recurse++;
EINA_LIST_FOREACH(icons, l, icon)
{
value = efreet_icon_lookup_icon(theme, icon, size);
if (value && (value != NON_EXISTING))
break;
}
/* we didn't find the image check the inherited themes */
if (!value || (value == NON_EXISTING))
value = efreet_icon_list_find_fallback(theme, icons, size);
recurse--;
return value;
}
/**
* @internal
* @param theme: The icon theme to look in
* @param icon_name: The icon name to look for
* @param size: The icon size to look for
* @return Returns the path for the theme/icon/size combo or NULL if
* none found
* @brief Looks for the @a icon in the @a theme for the @a size given.
*/
static char *
efreet_icon_lookup_icon(Efreet_Icon_Theme *theme, const char *icon_name,
unsigned int size)
{
Eina_List *l;
char *icon = NULL, *tmp = NULL;
Efreet_Icon_Theme_Directory *dir;
int minimal_size = INT_MAX;
if (!theme || (theme->paths == NULL) || !icon_name || !size)
return NULL;
icon = efreet_icon_cache_check(theme, icon_name, size);
if (icon) return icon;
/* search for allowed size == requested size */
EINA_LIST_FOREACH(theme->directories, l, dir)
{
if (!efreet_icon_directory_size_match(dir, size)) continue;
icon = efreet_icon_lookup_directory(theme, dir,
icon_name);
if (icon)
{
efreet_icon_cache_add(theme, icon_name, size, icon);
return icon;
}
}
/* search for any icon that matches */
EINA_LIST_FOREACH(theme->directories, l, dir)
{
int distance;
distance = efreet_icon_directory_size_distance(dir, size);
if (distance >= minimal_size) continue;
tmp = efreet_icon_lookup_directory(theme, dir,
icon_name);
if (tmp)
{
FREE(icon);
icon = tmp;
minimal_size = distance;
}
}
efreet_icon_cache_add(theme, icon_name, size, icon);
return icon;
}
/**
* @internal
* @param theme: The theme to use
* @param dir: The theme directory to look in
* @param icon_name: The icon name to look for
* @return Returns the icon cloest matching the given information or NULL if
* none found
* @brief Tries to find the file closest matching the given icon
*/
static char *
efreet_icon_lookup_directory(Efreet_Icon_Theme *theme,
Efreet_Icon_Theme_Directory *dir,
const char *icon_name)
{
Eina_List *l;
char *icon;
const char *path;
EINA_LIST_FOREACH(theme->paths, l, path)
{
icon = efreet_icon_lookup_directory_helper(dir, path, icon_name);
if (icon) return icon;
}
return NULL;
}
/**
* @internal
* @param dir: The theme directory to work with
* @param size: The size to check
* @return Returns true if the size matches for the given directory, 0
* otherwise
* @brief Checks if the size matches for the given directory or not
*/
static int
efreet_icon_directory_size_match(Efreet_Icon_Theme_Directory *dir,
unsigned int size)
{
if (dir->type == EFREET_ICON_SIZE_TYPE_FIXED)
return (dir->size.normal == size);
if (dir->type == EFREET_ICON_SIZE_TYPE_SCALABLE)
return ((dir->size.min < size) && (size < dir->size.max));
if (dir->type == EFREET_ICON_SIZE_TYPE_THRESHOLD)
return (((dir->size.normal - dir->size.threshold) < size)
&& (size < (dir->size.normal + dir->size.threshold)));
return 0;
}
/**
* @internal
* @param dir: The directory to work with
* @param size: The size to check for
* @return Returns the distance this size is away from the desired size
* @brief Returns the distance the given size is away from the desired size
*/
static int
efreet_icon_directory_size_distance(Efreet_Icon_Theme_Directory *dir,
unsigned int size)
{
if (dir->type == EFREET_ICON_SIZE_TYPE_FIXED)
return (abs(dir->size.normal - size));
if (dir->type == EFREET_ICON_SIZE_TYPE_SCALABLE)
{
if (size < dir->size.min)
return dir->size.min - size;
if (dir->size.max < size)
return size - dir->size.max;
return 0;
}
if (dir->type == EFREET_ICON_SIZE_TYPE_THRESHOLD)
{
if (size < (dir->size.normal - dir->size.threshold))
return (dir->size.min - size);
if ((dir->size.normal + dir->size.threshold) < size)
return (size - dir->size.max);
return 0;
}
return 0;
}
/**
* @internal
* @param icon_name: The icon name to look for
* @return Returns the Efreet_Icon for the given name or NULL if none found
* @brief Looks for the un-themed icon in the base directories
*/
static char *
efreet_icon_fallback_icon(const char *icon_name)
{
char *icon;
if (!icon_name) return NULL;
icon = efreet_icon_cache_check(efreet_icon_find_theme_check(NULL), icon_name, 0);
if (icon) return icon;
icon = efreet_icon_fallback_dir_scan(efreet_icon_deprecated_user_dir_get(), icon_name);
if (!icon)
icon = efreet_icon_fallback_dir_scan(efreet_icon_user_dir_get(), icon_name);
if (!icon)
{
Eina_List *xdg_dirs, *l;
const char *dir;
char path[PATH_MAX];
EINA_LIST_FOREACH(efreet_extra_icon_dirs, l, dir)
{
icon = efreet_icon_fallback_dir_scan(dir, icon_name);
if (icon)
{
efreet_icon_cache_add(efreet_icon_find_theme_check(NULL), icon_name, 0, icon);
return icon;
}
}
xdg_dirs = efreet_data_dirs_get();
EINA_LIST_FOREACH(xdg_dirs, l, dir)
{
snprintf(path, sizeof(path), "%s/icons", dir);
icon = efreet_icon_fallback_dir_scan(path, icon_name);
if (icon)
{
efreet_icon_cache_add(efreet_icon_find_theme_check(NULL), icon_name, 0, icon);
return icon;
}
}
EINA_LIST_FOREACH(xdg_dirs, l, dir)
{
snprintf(path, sizeof(path), "%s/pixmaps", dir);
icon = efreet_icon_fallback_dir_scan(path, icon_name);
if (icon)
{
efreet_icon_cache_add(efreet_icon_find_theme_check(NULL), icon_name, 0, icon);
return icon;
}
}
icon = efreet_icon_fallback_dir_scan("/usr/share/pixmaps", icon_name);
}
efreet_icon_cache_add(efreet_icon_find_theme_check(NULL), icon_name, 0, icon);
return icon;
}
/**
* @internal
* @param dir: The directory to scan
* @param icon_name: The icon to look for
* @return Returns the icon for the given name or NULL on failure
* @brief Scans the given @a dir for the given @a icon_name returning the
* Efreet_icon if found, NULL otherwise.
*/
static char *
efreet_icon_fallback_dir_scan(const char *dir, const char *icon_name)
{
Eina_List *l;
char *icon = NULL;
char path[PATH_MAX], *ext;
const char *icon_path[] = { dir, "/", icon_name, NULL };
size_t size;
if (!dir || !icon_name) return NULL;
size = efreet_array_cat(path, sizeof(path), icon_path);
EINA_LIST_FOREACH(efreet_icon_extensions, l, ext)
{
eina_strlcpy(path + size, ext, sizeof(path) - size);
if (ecore_file_exists(path))
{
icon = strdup(path);
if (icon) break;
}
*(path + size) = '\0';
}
/* This is to catch non-conforming .desktop files */
#ifdef SLOPPY_SPEC
if (!icon)
{
if ((ecore_file_exists(path)) && (!ecore_file_is_dir(path)))
{
icon = strdup(path);
#ifdef STRICT_SPEC
if (icon)
WRN("[Efreet]: Found an icon that already has an extension: %s", path);
#endif
}
}
#endif
return icon;
}
/**
* @internal
* @param theme: The theme to work with
* @param dir: The theme directory to work with
* @param path: The partial path to use
* @return Returns no value
* @brief Caches the icons in the given theme directory path at the given
* size
*/
static char *
efreet_icon_lookup_directory_helper(Efreet_Icon_Theme_Directory *dir,
const char *path, const char *icon_name)
{
Eina_List *l;
char *icon = NULL;
char file_path[PATH_MAX];
const char *ext, *path_strs[] = { path, "/", dir->name, "/", icon_name, NULL };
size_t len;
len = efreet_array_cat(file_path, sizeof(file_path), path_strs);
EINA_LIST_FOREACH(efreet_icon_extensions, l, ext)
{
eina_strlcpy(file_path + len, ext, sizeof(file_path) - len);
if (ecore_file_exists(file_path))
{
icon = strdup(file_path);
break;
}
}
return icon;
}
/**
* @internal
* @return Returns a new Efreet_Icon struct on success or NULL on failure
* @brief Creates a new Efreet_Icon struct
*/
static Efreet_Icon *
efreet_icon_new(const char *path)
{
Efreet_Icon *icon;
char *p;
icon = NEW(Efreet_Icon, 1);
icon->path = strdup(path);
/* load the .icon file if it's available */
p = strrchr(icon->path, '.');
if (p)
{
char ico_path[PATH_MAX];
*p = '\0';
snprintf(ico_path, sizeof(ico_path), "%s.icon", icon->path);
*p = '.';
if (ecore_file_exists(ico_path))
efreet_icon_populate(icon, ico_path);
}
if (!icon->name)
{
const char *file;
file = ecore_file_file_get(icon->path);
p = strrchr(icon->path, '.');
if (p) *p = '\0';
icon->name = strdup(file);
if (p) *p = '.';
}
return icon;
}
/**
* @param icon: The Efreet_Icon to cleanup
* @return Returns no value.
* @brief Free's the given icon and all its internal data.
*/
EAPI void
efreet_icon_free(Efreet_Icon *icon)
{
if (!icon) return;
icon->ref_count --;
if (icon->ref_count > 0) return;
IF_FREE(icon->path);
IF_FREE(icon->name);
IF_FREE_LIST(icon->attach_points, free);
FREE(icon);
}
/**
* @internal
* @param icon: The icon to populate
* @param file: The file to populate from
* @return Returns no value
* @brief Tries to populate the icon information from the given file
*/
static void
efreet_icon_populate(Efreet_Icon *icon, const char *file)
{
Efreet_Ini *ini;
const char *tmp;
ini = efreet_ini_new(file);
if (!ini->data)
{
efreet_ini_free(ini);
return;
}
efreet_ini_section_set(ini, "Icon Data");
tmp = efreet_ini_localestring_get(ini, "DisplayName");
if (tmp) icon->name = strdup(tmp);
tmp = efreet_ini_string_get(ini, "EmbeddedTextRectangle");
if (tmp)
{
int points[4];
char *t, *s, *p;
int i;
t = strdup(tmp);
s = t;
for (i = 0; i < 4; i++)
{
if (s)
{
p = strchr(s, ',');
if (p) *p = '\0';
points[i] = atoi(s);
if (p) s = ++p;
else s = NULL;
}
else
{
points[i] = 0;
}
}
icon->has_embedded_text_rectangle = 1;
icon->embedded_text_rectangle.x0 = points[0];
icon->embedded_text_rectangle.y0 = points[1];
icon->embedded_text_rectangle.x1 = points[2];
icon->embedded_text_rectangle.y1 = points[3];
FREE(t);
}
tmp = efreet_ini_string_get(ini, "AttachPoints");
if (tmp)
{
char *t, *s, *p;
t = strdup(tmp);
s = t;
while (s)
{
Efreet_Icon_Point *point;
p = strchr(s, ',');
/* If this happens there is something wrong with the .icon file */
if (!p) break;
point = NEW(Efreet_Icon_Point, 1);
*p = '\0';
point->x = atoi(s);
s = ++p;
p = strchr(s, '|');
if (p) *p = '\0';
point->y = atoi(s);
icon->attach_points = eina_list_append(icon->attach_points, point);
if (p) s = ++p;
else s = NULL;
}
FREE(t);
}
efreet_ini_free(ini);
}
/**
* @internal
* @return Returns a new Efreet_Icon_Theme on success or NULL on failure
* @brief Creates a new Efreet_Icon_Theme structure
*/
static Efreet_Icon_Theme *
efreet_icon_theme_new(void)
{
Efreet_Icon_Theme *theme;
theme = NEW(Efreet_Icon_Theme, 1);
return theme;
}
/**
* @internal
* @param theme: The theme to free
* @return Returns no value
* @brief Frees up the @a theme structure.
*/
static void
efreet_icon_theme_free(Efreet_Icon_Theme *theme)
{
if (!theme) return;
IF_RELEASE(theme->name.internal);
IF_RELEASE(theme->name.name);
IF_FREE(theme->comment);
IF_FREE(theme->example_icon);
IF_FREE_LIST(theme->paths, free);
IF_FREE_LIST(theme->inherits, free);
IF_FREE_LIST(theme->directories, efreet_icon_theme_directory_free);
FREE(theme);
}
/**
* @internal
* @param theme: The theme to work with
* @param path: The path to add
* @return Returns no value
* @brief This will correctly add the given path to the list of theme paths.
* @Note Assumes you've already verified that @a path is a valid directory.
*/
static void
efreet_icon_theme_path_add(Efreet_Icon_Theme *theme, const char *path)
{
if (!theme || !path) return;
theme->paths = eina_list_append(theme->paths, strdup(path));
}
/**
* @internal
* @return Returns no value
* @brief This validates that our cache is still valid.
*
* This is checked by the following algorithm:
* - if we've check less then 5 seconds ago we're good
* - if the mtime on the dir is less then our last check time we're good
* - otherwise, invalidate the caches
*/
static void
efreet_icon_theme_cache_check(Efreet_Icon_Theme *theme)
{
Eina_List *l;
double new_check;
new_check = ecore_time_get();
/* we're within 5 seconds of the last time we checked the cache */
if ((new_check - 5) <= theme->last_cache_check) return;
if (theme->fake)
efreet_icon_theme_dir_scan_all(theme->name.internal);
else
{
char *path;
EINA_LIST_FOREACH(theme->paths, l, path)
{
if (!efreet_icon_theme_cache_check_dir(theme, path))
break;
}
}
theme->last_cache_check = new_check;
}
/**
* @internal
* @param theme: The icon theme to check
* @param dir: The directory to check
* @return Returns 1 if the cache is still valid, 0 otherwise
* @brief This will check if the theme cache is still valid. If it isn't the
* cache will be invalided and 0 returned.
*/
static int
efreet_icon_theme_cache_check_dir(Efreet_Icon_Theme *theme, const char *dir)
{
struct stat buf;
/* have we modified this directory since our last cache check? */
if (stat(dir, &buf) || (buf.st_mtime > theme->last_cache_check))
{
eina_hash_del(efreet_icon_cache, theme, NULL);
return 0;
}
return 1;
}
/**
* @internal
* @param theme_name: The theme to scan for
* @return Returns no value
* @brief Scans the theme directories. If @a theme_name is NULL it will load
* up all theme data. If @a theme_name is not NULL it will look for that
* specific theme data
*/
static void
efreet_icon_theme_dir_scan_all(const char *theme_name)
{
Eina_List *xdg_dirs, *l;
char path[PATH_MAX], *dir;
efreet_icon_theme_dir_scan(efreet_icon_deprecated_user_dir_get(), theme_name);
efreet_icon_theme_dir_scan(efreet_icon_user_dir_get(), theme_name);
xdg_dirs = efreet_data_dirs_get();
EINA_LIST_FOREACH(xdg_dirs, l, dir)
{
snprintf(path, sizeof(path), "%s/icons", dir);
efreet_icon_theme_dir_scan(path, theme_name);
}
EINA_LIST_FOREACH(xdg_dirs, l, dir)
{
snprintf(path, sizeof(path), "%s/pixmaps", dir);
efreet_icon_theme_dir_scan(path, theme_name);
}
efreet_icon_theme_dir_scan("/usr/share/pixmaps", theme_name);
}
/**
* @internal
* @param search_dir: The directory to scan
* @param theme_name: Scan for this specific theme, set to NULL to find all
* themes.
* @return Returns no value
* @brief Scans the given directory and adds non-hidden icon themes to the
* given list. If the theme isnt' in our cache then load the index.theme and
* add to the cache.
*/
static void
efreet_icon_theme_dir_scan(const char *search_dir, const char *theme_name)
{
DIR *dirs;
struct dirent *dir;
if (!search_dir) return;
dirs = opendir(search_dir);
if (!dirs) return;
while ((dir = readdir(dirs)))
{
Efreet_Icon_Theme *theme;
char path[PATH_MAX];
const char *key;
if (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, "..")) continue;
/* only care if this is a directory or the theme name matches the
* given name */
snprintf(path, sizeof(path), "%s/%s", search_dir, dir->d_name);
if (((theme_name != NULL) && (strcmp(theme_name, dir->d_name)))
|| !ecore_file_is_dir(path))
continue;
key = eina_stringshare_add(dir->d_name);
theme = eina_hash_find(efreet_icon_themes, key);
if (!theme)
{
theme = efreet_icon_theme_new();
theme->name.internal = key;
eina_hash_add(efreet_icon_themes,
(void *)theme->name.internal, theme);
}
else
{
if (theme->fake)
theme->fake = 0;
eina_stringshare_del(key);
}
efreet_icon_theme_path_add(theme, path);
/* we're already valid so no reason to check for an index.theme file */
if (theme->valid) continue;
/* if the index.theme file exists we parse it into the theme */
strncat(path, "/index.theme", sizeof(path));
if (ecore_file_exists(path))
efreet_icon_theme_index_read(theme, path);
}
closedir(dirs);
/* if we were given a theme name we want to make sure that that given
* theme is valid before finishing, unless it's a fake theme */
if (theme_name)
{
Efreet_Icon_Theme *theme;
theme = eina_hash_find(efreet_icon_themes, theme_name);
if (theme && !theme->valid && !theme->fake)
eina_hash_del(efreet_icon_themes, theme_name, theme);
}
}
/**
* @internal
* @param theme: The theme to set the values into
* @param path: The path to the index.theme file for this theme
* @return Returns no value
* @brief This will load up the theme with the data in the index.theme file
*/
static void
efreet_icon_theme_index_read(Efreet_Icon_Theme *theme, const char *path)
{
Efreet_Ini *ini;
const char *tmp;
if (!theme || !path) return;
ini = efreet_ini_new(path);
if (!ini->data)
{
efreet_ini_free(ini);
return;
}
efreet_ini_section_set(ini, "Icon Theme");
tmp = efreet_ini_localestring_get(ini, "Name");
if (tmp) theme->name.name = eina_stringshare_add(tmp);
tmp = efreet_ini_localestring_get(ini, "Comment");
if (tmp) theme->comment = strdup(tmp);
tmp = efreet_ini_string_get(ini, "Example");
if (tmp) theme->example_icon = strdup(tmp);
theme->hidden = efreet_ini_boolean_get(ini, "Hidden");
theme->valid = 1;
/* Check the inheritance. If there is none we inherit from the hicolor theme */
tmp = efreet_ini_string_get(ini, "Inherits");
if (tmp)
{
char *t, *s, *p;
t = strdup(tmp);
s = t;
p = strchr(s, ',');
while (p)
{
*p = '\0';
theme->inherits = eina_list_append(theme->inherits, strdup(s));
s = ++p;
p = strchr(s, ',');
}
theme->inherits = eina_list_append(theme->inherits, strdup(s));
FREE(t);
}
/* make sure this one is done last as setting the directory will change
* the ini section ... */
tmp = efreet_ini_string_get(ini, "Directories");
if (tmp)
{
char *t, *s, *p;
t = strdup(tmp);
s = t;
p = s;
while (p)
{
p = strchr(s, ',');
if (p) *p = '\0';
theme->directories = eina_list_append(theme->directories,
efreet_icon_theme_directory_new(ini, s));
if (p) s = ++p;
}
FREE(t);
}
efreet_ini_free(ini);
}
/**
* @internal
* @return Returns no value
* @brief Because the theme icon directories can be spread over multiple
* base directories we may need to create the icon theme strucutre before
* finding the index.theme file. It may also be that we never find an
* index.theme file as this isn't a valid theme. This function makes sure
* that everything we've got in our hash has a valid key to it.
*/
static void
efreet_icon_theme_dir_validity_check(void)
{
Eina_List *keys;
const char *name;
Eina_Iterator *it;
keys = NULL;
it = eina_hash_iterator_key_new(efreet_icon_themes);
eina_iterator_foreach(it, EINA_EACH(_hash_keys), &keys);
eina_iterator_free(it);
EINA_LIST_FREE(keys, name)
{
Efreet_Icon_Theme *theme;
theme = eina_hash_find(efreet_icon_themes, name);
if (theme && !theme->valid && !theme->fake)
eina_hash_del(efreet_icon_themes, name, theme);
}
}
/**
* @internal
* @param ini: The ini file with information on this directory
* @param name: The name of the directory
* @return Returns a new Efreet_Icon_Theme_Directory based on the
* information in @a ini.
* @brief Creates and initialises an icon theme directory from the given ini
* information
*/
static Efreet_Icon_Theme_Directory *
efreet_icon_theme_directory_new(Efreet_Ini *ini, const char *name)
{
Efreet_Icon_Theme_Directory *dir;
int val;
const char *tmp;
if (!ini) return NULL;
dir = NEW(Efreet_Icon_Theme_Directory, 1);
dir->name = strdup(name);
efreet_ini_section_set(ini, name);
tmp = efreet_ini_string_get(ini, "Context");
if (tmp)
{
if (!strcasecmp(tmp, "Actions"))
dir->context = EFREET_ICON_THEME_CONTEXT_ACTIONS;
else if (!strcasecmp(tmp, "Devices"))
dir->context = EFREET_ICON_THEME_CONTEXT_DEVICES;
else if (!strcasecmp(tmp, "FileSystems"))
dir->context = EFREET_ICON_THEME_CONTEXT_FILESYSTEMS;
else if (!strcasecmp(tmp, "MimeTypes"))
dir->context = EFREET_ICON_THEME_CONTEXT_MIMETYPES;
}
tmp = efreet_ini_string_get(ini, "Type");
if (tmp)
{
if (!strcasecmp(tmp, "Fixed"))
dir->type = EFREET_ICON_SIZE_TYPE_FIXED;
else if (!strcasecmp(tmp, "Scalable"))
dir->type = EFREET_ICON_SIZE_TYPE_SCALABLE;
else if (!strcasecmp(tmp, "Threshold"))
dir->type = EFREET_ICON_SIZE_TYPE_THRESHOLD;
}
dir->size.normal = efreet_ini_int_get(ini, "Size");
val = efreet_ini_int_get(ini, "MinSize");
if (val < 0) dir->size.min = dir->size.normal;
else dir->size.min = val;
val = efreet_ini_int_get(ini, "MaxSize");
if (val < 0) dir->size.max = dir->size.normal;
else dir->size.max = val;
val = efreet_ini_int_get(ini, "Threshold");
if (val < 0) dir->size.threshold = 2;
else dir->size.threshold = val;
return dir;
}
/**
* @internal
* @param dir: The Efreet_Icon_Theme_Directory to free
* @return Returns no value
* @brief Frees the given directory @a dir
*/
static void
efreet_icon_theme_directory_free(Efreet_Icon_Theme_Directory *dir)
{
if (!dir) return;
IF_FREE(dir->name);
FREE(dir);
}
static int
efreet_icon_cache_find(Efreet_Icon_Cache *value, const char *key)
{
if (!value || !key) return -1;
return strcmp(value->key, key);
}
static void
efreet_icon_cache_flush(Efreet_Icon_Theme *theme, Eina_List *list)
{
/* TODO:
* * Dynamic cache size
* * Maybe add references to cache, so that we sort on how often a value is used
*/
while (eina_list_count(list) > 100)
{
Efreet_Icon_Cache *cache;
Eina_List *last;
last = eina_list_last(list);
cache = eina_list_data_get(last);
efreet_icon_cache_free(cache);
list = eina_list_remove_list(list, last);
}
eina_hash_modify(efreet_icon_cache, theme, list);
}
static void
efreet_icon_cache_free(Efreet_Icon_Cache *value)
{
if (!value) return;
IF_FREE(value->key);
IF_FREE(value->path);
free(value);
}
static char *
efreet_icon_cache_check(Efreet_Icon_Theme *theme, const char *icon, unsigned int size)
{
Eina_List *list;
Efreet_Icon_Cache *cache;
char key[4096];
struct stat st;
list = eina_hash_find(efreet_icon_cache, theme);
if (!list) return NULL;
snprintf(key, sizeof(key), "%s %d", icon, size);
cache = eina_list_search_unsorted(list, EINA_COMPARE_CB(efreet_icon_cache_find), key);
if (cache)
{
if (!cache->path)
{
list = eina_list_promote_list(list, eina_list_data_find_list(list, cache));
eina_hash_modify(efreet_icon_cache, theme, list);
return NON_EXISTING;
}
else if (!stat(cache->path, &st) && st.st_mtime == cache->lasttime)
{
list = eina_list_promote_list(list, eina_list_data_find_list(list, cache));
eina_hash_modify(efreet_icon_cache, theme, list);
return strdup(cache->path);
}
efreet_icon_cache_free(cache);
list = eina_list_remove(list, cache);
if (list != NULL) eina_hash_modify(efreet_icon_cache, theme, list);
else eina_hash_del(efreet_icon_cache, theme, NULL);
}
return NULL;
}
static void
efreet_icon_cache_add(Efreet_Icon_Theme *theme, const char *icon, unsigned int size, const char *value)
{
Eina_List *list, *l;
Efreet_Icon_Cache *cache;
char key[4096];
struct stat st;
list = eina_hash_find(efreet_icon_cache, theme);
snprintf(key, sizeof(key), "%s %d", icon, size);
cache = NEW(Efreet_Icon_Cache, 1);
cache->key = strdup(key);
if ((value) && !stat(value, &st))
{
cache->path = strdup(value);
cache->lasttime = st.st_mtime;
}
else
cache->lasttime = ecore_time_get();
l = list;
list = eina_list_prepend(list, cache);
if (!l) eina_hash_add(efreet_icon_cache, theme, list);
else eina_hash_modify(efreet_icon_cache, theme, list);
efreet_icon_cache_flush(theme, list);
}
Reference in New Issue View Git Blame Copy Permalink