filetypes.h File Reference

#include <gdk/gdk.h>
#include <glib.h>
#include "filemodel.h"

Include dependency graph for filetypes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	FILE_EXT_DRZ   "drz"
#define	FILE_EXT_SHORTCUT   "desktop"
#define	FILE_EXT_SHORTCUT_TO_DIR   "directory"
#define	DIR_DRZ   "System/drz"
#define	DIR_SHORTCUTS   "System/Shortcuts"
#define	DIR_NOTES   "Notes"
#define	DIR_ADE_THUMBS   "Digital Editions/Thumbnails"
Functions
void	filetypes_init (gboolean watch)
gboolean	filetypes_showdir ()
GdkPixbuf *	get_icon_from_file_extension (const gchar *file_ext, const gboolean is_directory, const filemodel_thumbsize_t icon_size)
	Get icon for specified file extension.
GdkPixbuf *	get_icon_from_file (const gchar *icon_name, filemodel_thumbsize_t icon_size)
GdkPixbuf *	get_icon_delete_toggle (gboolean toggled, filemodel_thumbsize_t icon_size)
GdkPixbuf *	get_icon_application (const filemodel_thumbsize_t icon_size)
	Get icon for application (executable file).
GdkPixbuf *	get_icon_library (const filemodel_thumbsize_t icon_size)
	Get icon for library (SD card).
void	apply_icon_overlay_shortcut (const filemodel_thumbsize_t icon_size, GdkPixbuf *icon)
	Apply overlay for shortcuts to the given icon.
void	apply_icon_overlay_delete (const filemodel_thumbsize_t icon_size, GdkPixbuf *icon, gboolean toggled)
const gchar *	get_type_descr_from_file_extension (const gchar *file_ext, const gboolean is_directory)
	Get filetype description for specified file extension.
const gchar *	get_viewer_from_file_extension (const gchar *file_ext)
	Get executable for viewer application to be used for specified file extension.
gboolean	get_generate_thumbnail (const gchar *file_ext)
	Get boolean to determine whether or not to generate thumbnail.
gboolean	is_drz_file_extension (const gchar *file_ext)
	Tell whether the specified file extension is a drz file or not.
gboolean	is_shortcut_file_extension (const gchar *file_ext)
	Tell whether the specified file extension is a shortcut file or not.
gboolean	is_shortcut_file (const char *filename)
const char *	g_extension_pointer (const char *path)

---

Define Documentation

#define DIR_ADE_THUMBS   "Digital Editions/Thumbnails"

Definition at line 56 of file filetypes.h.

Referenced by index_full().

#define DIR_DRZ   "System/drz"

Definition at line 53 of file filetypes.h.

Referenced by index_full().

#define DIR_NOTES   "Notes"

Definition at line 55 of file filetypes.h.

Referenced by add_desktop_items().

#define DIR_SHORTCUTS   "System/Shortcuts"

Definition at line 54 of file filetypes.h.

Referenced by add_desktop_items(), create_shortcut_item(), and index_full().

#define FILE_EXT_DRZ   "drz"

File Name : filetypes.h

Description: Content browser filetype specific utilities Copyright (C) 2008 iRex Technologies B.V. All rights reserved.

Definition at line 49 of file filetypes.h.

Referenced by is_drz_file_extension().

#define FILE_EXT_SHORTCUT   "desktop"

Definition at line 50 of file filetypes.h.

Referenced by create_shortcut_file(), and is_shortcut_file_extension().

#define FILE_EXT_SHORTCUT_TO_DIR   "directory"

Definition at line 51 of file filetypes.h.

Referenced by create_shortcut_file(), and is_shortcut_file_extension().

---

Function Documentation

void apply_icon_overlay_delete	(	const filemodel_thumbsize_t	icon_size,
		GdkPixbuf *	icon,
		gboolean	toggled
	)

Definition at line 492 of file filetypes.c.

References apply_icon_overlay().

Referenced by create_delete_overlay().

{
    if (toggled)
        apply_icon_overlay( icon_size, icon, "overlay-delete-toggled");
    else
        apply_icon_overlay( icon_size, icon, "overlay-delete-untoggled");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void apply_icon_overlay_shortcut	(	const filemodel_thumbsize_t	icon_size,
		GdkPixbuf *	icon
	)

Apply overlay for shortcuts to the given icon.

---------------------------------------------------------------------------

Name : apply_icon_overlay_shortcut

Parameters:

[in]	icon_size	- specifies which icon overlay is requested
[in,out]	icon	- a pixbuf holding a bitmap of the icon to be modified

Returns:

--

--------------------------------------------------------------------------

Definition at line 485 of file filetypes.c.

References apply_icon_overlay().

Referenced by get_thumbnail_for_shortcut().

{
    apply_icon_overlay( icon_size, icon, "overlay-shortcut");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void filetypes_init

(

gboolean

watch

)

Definition at line 267 of file filetypes.c.

References add_filetypes_from_gconf(), add_hardcoded_filetypes(), CTB_GCONF_PATH, g_filetype_info, g_gconfclient, g_showdir, on_gconf_key_changed(), read_gconf_boolean(), and REGKEY_SHOW_SDCARD.

Referenced by filemodel_init(), and index_full().

{
    g_filetype_info = g_array_new( TRUE, TRUE, sizeof(filetype_info_t) );
    g_assert(g_filetype_info);

    add_hardcoded_filetypes();
    add_filetypes_from_gconf();

    if (watch) {
        g_gconfclient = gconf_client_get_default();
        g_assert(g_gconfclient);
        g_showdir = read_gconf_boolean(CTB_GCONF_PATH, REGKEY_SHOW_SDCARD, g_gconfclient);

        gconf_client_add_dir(g_gconfclient,
                             CTB_GCONF_PATH,
                             GCONF_CLIENT_PRELOAD_NONE,
                             NULL);

        gconf_client_notify_add(g_gconfclient,
                                CTB_GCONF_PATH,
                                on_gconf_key_changed,
                                NULL,
                                NULL,
                                NULL);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

gboolean filetypes_showdir

(

)

Definition at line 295 of file filetypes.c.

References g_showdir.

Referenced by add_desktop_items().

{
    return g_showdir;
}

Here is the caller graph for this function:

const char* g_extension_pointer

(

const char *

path

)

---------------------------------------------------------------------------

g_extension_pointer:

Parameters:

path

A filename or file path.

Extracts the extension from the end of a filename (the part after the final '.' in the filename).

Returns: A pointer to the extension part of the filename, or a pointer to the end of the string if the filename does not have an extension.

--------------------------------------------------------------------------

g_extension_pointer: : A filename or file path.

Extracts the extension from the end of a filename (the part after the final '.' in the filename).

Returns: A pointer to the extension part of the filename, or a pointer to the end of the string if the filename does not have an extension.

Definition at line 585 of file filetypes.c.

Referenced by activate_shortcut(), add_filename(), get_tag_for_file(), get_thumbnail_for_shortcut(), ignore_thumbnail_generation(), is_shortcut_file(), and read_directory().

{
   char * s;

   g_return_val_if_fail(path != NULL, NULL);

   /* get the dot in the last element of the path */
   char *t = strrchr(path, G_DIR_SEPARATOR);
   if (t != NULL)
      s = strrchr(t, '.');
   else
      s = strrchr(path, '.');

   if (s == NULL)
      return path + strlen(path); /* There is no extension. */
   else {
      ++s;      /* pass the . */
      return s;
   }
}

Here is the caller graph for this function:

gboolean get_generate_thumbnail

(

const gchar *

file_ext

)

Get boolean to determine whether or not to generate thumbnail.

--------------------------------------------------------------------------- Name : get_generate_thumbnail

Parameters:

[in]

file_ext

- file extension for which viewer is requested

Returns:

Boolean, true to generate thumbnail, false for not --------------------------------------------------------------------------

Definition at line 564 of file filetypes.c.

References find_filetype_info(), and filetype_info_t::generate_thumbnail.

Referenced by ignore_thumbnail_generation().

{
    filetype_info_t *details = find_filetype_info(file_ext, FALSE, FALSE);
    return details->generate_thumbnail;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GdkPixbuf* get_icon_application

(

const filemodel_thumbsize_t

icon_size

)

Get icon for application (executable file).

---------------------------------------------------------------------------

Name : get_icon_application

Parameters:

[in]

icon_size

- specifies which icon is requested

Returns:

Pointer to pixbuf holding the requested icon or NULL on error. Lifetime of the pixbuf is guaranteed until the next call to this function, caller must g_object_ref() / _unref() the pixbuf when it needs the pixbuf longer than that.

--------------------------------------------------------------------------

Definition at line 404 of file filetypes.c.

References get_icon_from_file(), and ICONNAME_APPLICATION.

Referenced by get_thumbnail_for_shortcut().

{
    return get_icon_from_file(ICONNAME_APPLICATION, icon_size);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GdkPixbuf* get_icon_delete_toggle	(	gboolean	toggled,
		filemodel_thumbsize_t	icon_size
	)

Definition at line 416 of file filetypes.c.

References get_icon_from_file().

Referenced by toggle_cell_function().

{
    if (toggled) {
        return get_icon_from_file("delete-toggled", icon_size);
    } else {
        return get_icon_from_file("delete-untoggled", icon_size);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

GdkPixbuf* get_icon_from_file	(	const gchar *	icon_name,
		filemodel_thumbsize_t	icon_size
	)

Definition at line 430 of file filetypes.c.

References compareString(), ERRORPRINTF, g_icon_cache, ICONFILE_POSTFIX, ICONFILE_PREFIX, and ICONS_DIRECTORY.

Referenced by add_browse_mode_specials(), add_delete_mode_specials(), add_desktop_item(), add_previous_dir(), apply_icon_overlay(), get_icon_application(), get_icon_delete_toggle(), and get_icon_library().

{
    if (g_icon_cache == NULL) g_icon_cache = g_tree_new(compareString);

    g_assert(icon_name && *icon_name);
    gchar icon_file[256];
    snprintf(icon_file, 255, "%s/%s%s%s",
                                 ICONS_DIRECTORY,
                                 ICONFILE_PREFIX,
                                 icon_name,
                                 ICONFILE_POSTFIX[icon_size]);
    int len = strlen(ICONS_DIRECTORY) + strlen(ICONFILE_PREFIX) + 1;
    gchar* short_name = icon_file + len;
    gpointer cache = g_tree_lookup(g_icon_cache, short_name);
    GdkPixbuf *icon = NULL;
    if (cache) {
        icon = (GdkPixbuf *)cache;
    } else {
        GError *err = NULL;
        icon = gdk_pixbuf_new_from_file(icon_file, &err);
        if (icon) {
            g_tree_insert(g_icon_cache, g_strdup(short_name), icon);
        } else  {
            ERRORPRINTF("cannot load iconfile [%s] error [%s]", icon_file, err->message);
            g_clear_error(&err);
        }
    }
    return icon;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GdkPixbuf* get_icon_from_file_extension	(	const gchar *	file_ext,
		const gboolean	is_directory,
		const filemodel_thumbsize_t	icon_size
	)

Get icon for specified file extension.

---------------------------------------------------------------------------

Name : get_icon_from_file_extension

Parameters:

[in]	file_ext	- file extension for which icon is requested or empty string
[in]	is_directory	- whether file_ext is a directory
[in]	icon_size	- specifies which icon is requested

Returns:

Pointer to pixbuf holding the requested icon or NULL on error. Lifetime of the pixbuf is guaranteed until the next call to this function, caller must g_object_ref() / _unref() the pixbuf when it needs the pixbuf longer than that.

--------------------------------------------------------------------------

Definition at line 369 of file filetypes.c.

References ERRORPRINTF, find_filetype_info(), filetype_info_t::icon_name, ICONFILE_POSTFIX, ICONFILE_PREFIX, ICONS_DIRECTORY, and filetype_info_t::pixbuf_icon.

Referenced by get_thumbnail(), and get_thumbnail_for_shortcut().

{
    GdkPixbuf *icon               = NULL;

    filetype_info_t *details = find_filetype_info(file_ext, is_directory, TRUE);
    if (details)
    {
        // get normal icon
        GdkPixbuf **p_pixbuf_icon = &(details->pixbuf_icon[icon_size]);
        icon = *p_pixbuf_icon;
        if (icon == NULL)
        {
            // load filetype icon from file
            gchar* icon_file = g_strdup_printf( "%s/%s%s%s",
                    ICONS_DIRECTORY,
                    ICONFILE_PREFIX,
                    details->icon_name,
                    ICONFILE_POSTFIX[icon_size] );
            GError *err = NULL;
            icon = gdk_pixbuf_new_from_file( icon_file, &err );
            if (icon) *p_pixbuf_icon = icon;
            else
            {
                ERRORPRINTF("cannot load iconfile [%s] error [%s]", icon_file, err->message);
                g_clear_error(&err);
            }
            g_free(icon_file);
        }
    }
    return icon;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GdkPixbuf* get_icon_library

(

const filemodel_thumbsize_t

icon_size

)

Get icon for library (SD card).

---------------------------------------------------------------------------

Name : get_icon_library

Parameters:

[in]

icon_size

- specifies which icon is requested

Returns:

Pointer to pixbuf holding the requested icon or NULL on error. Lifetime of the pixbuf is guaranteed until the next call to this function, caller must g_object_ref() / _unref() the pixbuf when it needs the pixbuf longer than that.

--------------------------------------------------------------------------

Definition at line 410 of file filetypes.c.

References get_icon_from_file(), and ICONNAME_LIBRARY.

Referenced by get_thumbnail_for_shortcut().

{
    return get_icon_from_file(ICONNAME_LIBRARY, icon_size);
}

Here is the call graph for this function:

Here is the caller graph for this function:

const gchar* get_type_descr_from_file_extension	(	const gchar *	file_ext,
		const gboolean	is_directory
	)

Get filetype description for specified file extension.

---------------------------------------------------------------------------

Name : get_type_descr_from_file_extension

Parameters:

[in]	file_ext	- file extension for which a description is requested or empty string
[in]	is_directory	- whether filename is a directory

Returns:

filetype description or NULL when no description for the specified file extension

--------------------------------------------------------------------------

Definition at line 503 of file filetypes.c.

References filetype_info_t::description, ERRORPRINTF, and find_filetype_info().

Referenced by load_items_in_model().

{
    filetype_info_t *details = find_filetype_info(file_ext, is_directory, TRUE);

    const gchar *description = "";
    if (details)
    {
        if (details->description)
        {
            description = _( details->description );
        }
        else
        {
            ERRORPRINTF( "filetype [%s] is_dir [%d] has no description",
                         details->description, is_directory);
        }
    }

    return description;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const gchar* get_viewer_from_file_extension

(

const gchar *

file_ext

)

Get executable for viewer application to be used for specified file extension.

---------------------------------------------------------------------------

Name : get_viewer_from_file_extension

Parameters:

[in]

file_ext

- file extension for which viewer is requested or empty string

Returns:

Command-line command for the requested viewer application or NULL when no viewer known for the specified filename

--------------------------------------------------------------------------

Definition at line 555 of file filetypes.c.

References find_filetype_info(), and filetype_info_t::viewer_cmd.

Referenced by activate_item(), delete_item(), ignore_file(), and ignore_thumbnail_generation().

{
    filetype_info_t *details = find_filetype_info(file_ext, FALSE, FALSE);

    const gchar *viewer_cmd = (details) ?  details->viewer_cmd : NULL;
    return viewer_cmd;
}

Here is the call graph for this function:

Here is the caller graph for this function:

gboolean is_drz_file_extension

(

const gchar *

file_ext

)

Tell whether the specified file extension is a drz file or not.

---------------------------------------------------------------------------

Name : is_drz_file_extension

Parameters:

[in]

file_ext

- file extension to be checked or empty string

Returns:

TRUE when file extension is a drz file or FALSE when file extension not a drz file, or error

--------------------------------------------------------------------------

Definition at line 526 of file filetypes.c.

References FILE_EXT_DRZ.

Referenced by read_directory().

{
    if ( strcmp( file_ext, FILE_EXT_DRZ ) == 0 )
    {
        return TRUE;
    }
    return FALSE;
}

Here is the caller graph for this function:

gboolean is_shortcut_file

(

const char *

filename

)

Definition at line 547 of file filetypes.c.

References g_extension_pointer(), and is_shortcut_file_extension().

Referenced by check_shortcut(), and handle_changes().

{
    const char* ext = g_extension_pointer(filename);
    return is_shortcut_file_extension(ext);
}

Here is the call graph for this function:

Here is the caller graph for this function:

gboolean is_shortcut_file_extension

(

const gchar *

file_ext

)

Tell whether the specified file extension is a shortcut file or not.

---------------------------------------------------------------------------

Name : is_shortcut_file_extension

Parameters:

[in]

file_ext

- file extension to be checked or empty string

Returns:

TRUE when file extension is a shortcut file or FALSE when file extension not a shortcut file, or error

--------------------------------------------------------------------------

Definition at line 536 of file filetypes.c.

References FILE_EXT_SHORTCUT, and FILE_EXT_SHORTCUT_TO_DIR.

Referenced by activate_item(), get_thumbnail(), ignore_file(), is_shortcut_file(), load_items_in_model(), and shortcut_allowed().

{
    if (   strcmp( file_ext, FILE_EXT_SHORTCUT       ) == 0
        || strcmp( file_ext, FILE_EXT_SHORTCUT_TO_DIR) == 0 )
    {
        return TRUE;
    }
    return FALSE;
}

Here is the caller graph for this function: