Callers now responsible for adding stock items to extra items in icon_prepare_menu.

[rox-filer.git] / ROX-Filer / src / gui_support.c

/*
 * ROX-Filer, filer for the ROX desktop project
 * Copyright (C) 2006, Thomas Leonard and others (see changelog for details).
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

/* gui_support.c - general (GUI) support routines */

#include "config.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/param.h>
#include <stdarg.h>
#include <errno.h>
#include <time.h>

#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include <gdk/gdkx.h>
#include <gdk/gdk.h>
#include <gdk/gdkkeysyms.h>

#include "global.h"

#include "main.h"
#include "gui_support.h"
#include "support.h"
#include "pixmaps.h"
#include "choices.h"
#include "options.h"

gint    screen_width, screen_height;

gint            n_monitors;
GdkRectangle    *monitor_geom = NULL;
gint            monitor_width, monitor_height;
MonitorAdjacent *monitor_adjacent;

static GdkAtom xa_cardinal;

static GtkWidget *current_dialog = NULL;

static GtkWidget *tip_widget = NULL;
static time_t tip_time = 0;     /* Time tip widget last closed */
static gint tip_timeout = 0;    /* When primed */

/* Static prototypes */
static void run_error_info_dialog(GtkMessageType type, const char *message,
                                  va_list args);
static GType simple_image_get_type(void);
static void gui_get_monitor_adjacent(int monitor, MonitorAdjacent *adj);

void gui_store_screen_geometry(GdkScreen *screen)
{
        gint mon;

        screen_width = gdk_screen_get_width(screen);
        screen_height = gdk_screen_get_height(screen);

        if (monitor_adjacent)
                g_free(monitor_adjacent);

        monitor_width = monitor_height = G_MAXINT;
        n_monitors = gdk_screen_get_n_monitors(screen);
        if (monitor_geom)
                g_free(monitor_geom);
        monitor_geom = g_new(GdkRectangle, n_monitors ? n_monitors : 1);

        if (n_monitors)
        {
                for (mon = 0; mon < n_monitors; ++mon)
                {
                        gdk_screen_get_monitor_geometry(screen, mon,
                                        &monitor_geom[mon]);
                        if (monitor_geom[mon].width < monitor_width)
                                monitor_width = monitor_geom[mon].width; 
                        if (monitor_geom[mon].height < monitor_height)
                                monitor_height = monitor_geom[mon].height; 
                }
                monitor_adjacent = g_new(MonitorAdjacent, n_monitors);
                for (mon = 0; mon < n_monitors; ++mon)
                {
                        gui_get_monitor_adjacent(mon, &monitor_adjacent[mon]);
                }
        }
        else
        {
                n_monitors = 1;
                monitor_geom[0].x = monitor_geom[0].y = 0;
                monitor_width = monitor_geom[0].width = screen_width;
                monitor_height = monitor_geom[0].height = screen_height;
                monitor_adjacent = g_new0(MonitorAdjacent, 1);
        }

}

void gui_support_init()
{
        gpointer klass;
        
        xa_cardinal = gdk_atom_intern("CARDINAL", FALSE);

        gui_store_screen_geometry(gdk_screen_get_default());

        /* Work around the scrollbar placement bug */
        klass = g_type_class_ref(gtk_scrolled_window_get_type());
        ((GtkScrolledWindowClass *) klass)->scrollbar_spacing = 0;
        /* (don't unref, ever) */
}

/* Open a modal dialog box showing a message.
 * The user can choose from a selection of buttons at the bottom.
 * Returns -1 if the window is destroyed, or the number of the button
 * if one is clicked (starting from zero).
 *
 * If a dialog is already open, returns -1 without waiting AND
 * brings the current dialog to the front.
 *
 * Each button has two arguments, a GTK_STOCK icon and some text. If the
 * text is NULL, the stock's text is used.
 */
int get_choice(const char *title,
               const char *message,
               int number_of_buttons, ...)
{
        GtkWidget       *dialog;
        GtkWidget       *button = NULL;
        int             i, retval;
        va_list ap;

        if (current_dialog)
        {
                gtk_widget_hide(current_dialog);
                gtk_widget_show(current_dialog);
                return -1;
        }

        current_dialog = dialog = gtk_message_dialog_new(NULL,
                                        GTK_DIALOG_MODAL,
                                        GTK_MESSAGE_QUESTION,
                                        GTK_BUTTONS_NONE,
                                        "%s", message);
        gtk_window_set_position(GTK_WINDOW(dialog), GTK_WIN_POS_CENTER);

        va_start(ap, number_of_buttons);

        for (i = 0; i < number_of_buttons; i++)
        {
                const char *stock = va_arg(ap, char *);
                const char *text = va_arg(ap, char *);

                if (text)
                        button = button_new_mixed(stock, text);
                else
                        button = gtk_button_new_from_stock(stock);

                GTK_WIDGET_SET_FLAGS(button, GTK_CAN_DEFAULT);
                gtk_widget_show(button);

                gtk_dialog_add_action_widget(GTK_DIALOG(current_dialog),
                                                button, i);
        }

        gtk_window_set_title(GTK_WINDOW(dialog), title);
        gtk_window_set_position(GTK_WINDOW(dialog), GTK_WIN_POS_CENTER);

        gtk_dialog_set_default_response(GTK_DIALOG(dialog), i - 1);

        va_end(ap);

        retval = gtk_dialog_run(GTK_DIALOG(dialog));
        if (retval == GTK_RESPONSE_NONE)
                retval = -1;
        gtk_widget_destroy(dialog);

        current_dialog = NULL;

        return retval;
}

void info_message(const char *message, ...)
{
        va_list args;

        va_start(args, message);

        run_error_info_dialog(GTK_MESSAGE_INFO, message, args);
}

/* Display a message in a window with "ROX-Filer" as title */
void report_error(const char *message, ...)
{
        va_list args;

        va_start(args, message);

        run_error_info_dialog(GTK_MESSAGE_ERROR, message, args);
}

void set_cardinal_property(GdkWindow *window, GdkAtom prop, gulong value)
{
        gdk_property_change(window, prop, xa_cardinal, 32,
                                GDK_PROP_MODE_REPLACE, (gchar *) &value, 1);
}

/* NB: Also used for pinned icons.
 * TODO: Set the level here too.
 */
void make_panel_window(GtkWidget *widget)
{
        static gboolean need_init = TRUE;
        static GdkAtom xa_state, xa_atom, xa_hints, xa_win_hints;
        static GdkAtom xa_NET_WM_DESKTOP;
        GdkWindow *window = widget->window;
        long wm_hints_values[] = {1, False, 0, 0, 0, 0, 0, 0};
        GdkAtom wm_protocols[2];

        g_return_if_fail(window != NULL);

        if (o_override_redirect.int_value)
        {
                gdk_window_set_override_redirect(window, TRUE);
                return;
        }

        if (need_init)
        {
                xa_win_hints = gdk_atom_intern("_WIN_HINTS", FALSE);
                xa_state = gdk_atom_intern("_WIN_STATE", FALSE);
                xa_atom = gdk_atom_intern("ATOM", FALSE);
                xa_hints = gdk_atom_intern("WM_HINTS", FALSE);
                xa_NET_WM_DESKTOP = gdk_atom_intern("_NET_WM_DESKTOP", FALSE);

                need_init = FALSE;
        }
        
        gdk_window_set_decorations(window, 0);
        gdk_window_set_functions(window, 0);
        gtk_window_set_resizable(GTK_WINDOW(widget), FALSE);

        /* Don't hide panel/pinboard windows initially (WIN_STATE_HIDDEN).
         * Needed for IceWM - Christopher Arndt <chris.arndt@web.de>
         */
        set_cardinal_property(window, xa_state,
                        WIN_STATE_STICKY |
                        WIN_STATE_FIXED_POSITION | WIN_STATE_ARRANGE_IGNORE);

        set_cardinal_property(window, xa_win_hints,
                        WIN_HINTS_SKIP_FOCUS | WIN_HINTS_SKIP_WINLIST |
                        WIN_HINTS_SKIP_TASKBAR);

        /* Appear on all workspaces */
        set_cardinal_property(window, xa_NET_WM_DESKTOP, 0xffffffff);

        gdk_property_change(window, xa_hints, xa_hints, 32,
                        GDK_PROP_MODE_REPLACE, (guchar *) wm_hints_values,
                        sizeof(wm_hints_values) / sizeof(long));

        wm_protocols[0] = gdk_atom_intern("WM_DELETE_WINDOW", FALSE);
        wm_protocols[1] = gdk_atom_intern("_NET_WM_PING", FALSE);
        gdk_property_change(window,
                        gdk_atom_intern("WM_PROTOCOLS", FALSE), xa_atom, 32,
                        GDK_PROP_MODE_REPLACE, (guchar *) wm_protocols,
                        sizeof(wm_protocols) / sizeof(GdkAtom));

        gdk_window_set_skip_taskbar_hint(window, TRUE);
        gdk_window_set_skip_pager_hint(window, TRUE);

        if (g_object_class_find_property(G_OBJECT_GET_CLASS(widget),
                                        "accept_focus"))
        {
                GValue vfalse = { 0, };
                g_value_init(&vfalse, G_TYPE_BOOLEAN);
                g_value_set_boolean(&vfalse, FALSE);
                g_object_set_property(G_OBJECT(widget),
                                        "accept_focus", &vfalse);
                g_value_unset(&vfalse);
        }
}

static gboolean error_idle_cb(gpointer data)
{
        char    **error = (char **) data;
        
        report_error("%s", *error);
        null_g_free(error);

        one_less_window();
        return FALSE;
}

/* Display an error with "ROX-Filer" as title next time we are idle.
 * If multiple errors are reported this way before the window is opened,
 * all are displayed in a single window.
 * If an error is reported while the error window is open, it is discarded.
 */
void delayed_error(const char *error, ...)
{
        static char *delayed_error_data = NULL;
        char *old, *new;
        va_list args;

        g_return_if_fail(error != NULL);

        old = delayed_error_data;

        va_start(args, error);
        new = g_strdup_vprintf(error, args);
        va_end(args);

        if (old)
        {
                delayed_error_data = g_strconcat(old,
                                _("\n---\n"),
                                new, NULL);
                g_free(old);
                g_free(new);
        }
        else
        {
                delayed_error_data = new;
                g_idle_add(error_idle_cb, &delayed_error_data);

                number_of_windows++;
        }
}

/* Load the file into memory. Return TRUE on success.
 * Block is zero terminated (but this is not included in the length).
 */
gboolean load_file(const char *pathname, char **data_out, long *length_out)
{
        gsize len;
        GError *error = NULL;
        
        if (!g_file_get_contents(pathname, data_out, &len, &error))
        {
                delayed_error("%s", error->message);
                g_error_free(error);
                return FALSE;
        }
                
        if (length_out)
                *length_out = len;
        return TRUE;
}

GtkWidget *new_help_button(HelpFunc show_help, gpointer data)
{
        GtkWidget       *b, *icon;
        
        b = gtk_button_new();
        gtk_button_set_relief(GTK_BUTTON(b), GTK_RELIEF_NONE);
        icon = gtk_image_new_from_stock(GTK_STOCK_HELP,
                                        GTK_ICON_SIZE_SMALL_TOOLBAR);
        gtk_container_add(GTK_CONTAINER(b), icon);
        g_signal_connect_swapped(b, "clicked", G_CALLBACK(show_help), data);

        GTK_WIDGET_UNSET_FLAGS(b, GTK_CAN_FOCUS);

        return b;
}

/* Read file into memory. Call parse_line(guchar *line) for each line
 * in the file. Callback returns NULL on success, or an error message
 * if something went wrong. Only the first error is displayed to the user.
 */
void parse_file(const char *path, ParseFunc *parse_line)
{
        char            *data;
        long            length;
        gboolean        seen_error = FALSE;

        if (load_file(path, &data, &length))
        {
                char *eol;
                const char *error;
                char *line = data;
                int  line_number = 1;

                if (strncmp(data, "<?xml ", 6) == 0)
                {
                        delayed_error(_("Attempt to read an XML file as "
                                        "a text file. File '%s' may be "
                                        "corrupted."), path);
                        return;
                }

                while (line && *line)
                {
                        eol = strchr(line, '\n');
                        if (eol)
                                *eol = '\0';

                        error = parse_line(line);

                        if (error && !seen_error)
                        {
                                delayed_error(
                _("Error in '%s' file at line %d: "
                "\n\"%s\"\n"
                "This may be due to upgrading from a previous version of "
                "ROX-Filer. Open the Options window and try changing something "
                "and then changing it back (causing the file to be resaved).\n"
                "Further errors will be ignored."),
                                        path,
                                        line_number,
                                        error);
                                seen_error = TRUE;
                        }

                        if (!eol)
                                break;
                        line = eol + 1;
                        line_number++;
                }
                g_free(data);
        }
}

/* Returns the position of the pointer.
 * TRUE if any modifier keys or mouse buttons are pressed.
 */
gboolean get_pointer_xy(int *x, int *y)
{
        unsigned int mask;

        gdk_window_get_pointer(NULL, x, y, &mask);

        return mask != 0;
}

int get_monitor_under_pointer(void)
{
        int x, y;

        get_pointer_xy(&x, &y);
        return gdk_screen_get_monitor_at_point(gdk_screen_get_default(), x, y);
}

#define DECOR_BORDER 32

/* Centre the window at these coords */
void centre_window(GdkWindow *window, int x, int y)
{
        int     w, h;
        int m;

        g_return_if_fail(window != NULL);

        m = gdk_screen_get_monitor_at_point(gdk_screen_get_default(), x, y);

        gdk_drawable_get_size(window, &w, &h);
        
        x -= w / 2;
        y -= h / 2;

        gdk_window_move(window,
                CLAMP(x, DECOR_BORDER + monitor_geom[m].x,
                        monitor_geom[m].x + monitor_geom[m].width 
                        - w - DECOR_BORDER),
                CLAMP(y, DECOR_BORDER + monitor_geom[m].y,
                        monitor_geom[m].y + monitor_geom[m].height 
                        - h - DECOR_BORDER));
}

static void run_error_info_dialog(GtkMessageType type, const char *message,
                                  va_list args)
{
        GtkWidget *dialog;
        gchar *s;

        g_return_if_fail(message != NULL);

        s = g_strdup_vprintf(message, args);
        va_end(args);

        dialog = gtk_message_dialog_new(NULL,
                                        GTK_DIALOG_MODAL,
                                        type,
                                        GTK_BUTTONS_OK,
                                        "%s", s);
        gtk_window_set_position(GTK_WINDOW(dialog), GTK_WIN_POS_CENTER);
        gtk_dialog_set_default_response(GTK_DIALOG(dialog), GTK_RESPONSE_OK);
        gtk_dialog_run(GTK_DIALOG(dialog));
        gtk_widget_destroy(dialog);

        g_free(s);
}

static GtkWidget *current_wink_widget = NULL;
static gint     wink_timeout = -1;      /* Called when it's time to stop */
static gulong   wink_destroy;           /* Called if the widget dies first */

static gboolean end_wink(gpointer data)
{
        gtk_drag_unhighlight(current_wink_widget);

        g_signal_handler_disconnect(current_wink_widget, wink_destroy);

        current_wink_widget = NULL;

        return FALSE;
}

static void cancel_wink(void)
{
        g_source_remove(wink_timeout);
        end_wink(NULL);
}

static void wink_widget_died(gpointer data)
{
        current_wink_widget = NULL;
        g_source_remove(wink_timeout);
}

/* Draw a black box around this widget, briefly.
 * Note: uses the drag highlighting code for now.
 */
void wink_widget(GtkWidget *widget)
{
        g_return_if_fail(widget != NULL);
        
        if (current_wink_widget)
                cancel_wink();

        current_wink_widget = widget;
        gtk_drag_highlight(current_wink_widget);
        
        wink_timeout = g_timeout_add(300, (GSourceFunc) end_wink, NULL);

        wink_destroy = g_signal_connect_swapped(widget, "destroy",
                                G_CALLBACK(wink_widget_died), NULL);
}

static gboolean idle_destroy_cb(GtkWidget *widget)
{
        gtk_widget_unref(widget);
        gtk_widget_destroy(widget);
        return FALSE;
}

/* Destroy the widget in an idle callback */
void destroy_on_idle(GtkWidget *widget)
{
        gtk_widget_ref(widget);
        g_idle_add((GSourceFunc) idle_destroy_cb, widget);
}

/* Spawn a child process (as spawn_full), and report errors.
 * Returns the child's PID on succes, or 0 on failure.
 */
gint rox_spawn(const gchar *dir, const gchar **argv)
{
        GError  *error = NULL;
        gint pid = 0;

        if (!g_spawn_async_with_pipes(dir, (gchar **) argv, NULL,
                        G_SPAWN_DO_NOT_REAP_CHILD | G_SPAWN_STDOUT_TO_DEV_NULL |
                        G_SPAWN_SEARCH_PATH,
                        NULL, NULL,             /* Child setup fn */
                        &pid,                   /* Child PID */
                        NULL, NULL, NULL,       /* Standard pipes */
                        &error))
        {
                delayed_error("%s", error ? error->message : "(null)");
                g_error_free(error);

                return 0;
        }

        return pid;
}

GtkWidget *button_new_image_text(GtkWidget *image, const char *message)
{
        GtkWidget *button, *align, *hbox, *label;
        
        button = gtk_button_new();
        label = gtk_label_new_with_mnemonic(message);
        gtk_label_set_mnemonic_widget(GTK_LABEL(label), button);

        hbox = gtk_hbox_new(FALSE, 2);

        align = gtk_alignment_new(0.5, 0.5, 0.0, 0.0);

        gtk_box_pack_start(GTK_BOX(hbox), image, FALSE, FALSE, 0);
        gtk_box_pack_end(GTK_BOX(hbox), label, FALSE, FALSE, 0);

        gtk_container_add(GTK_CONTAINER(button), align);
        gtk_container_add(GTK_CONTAINER(align), hbox);
        gtk_widget_show_all(align);

        return button;
}

GtkWidget *button_new_mixed(const char *stock, const char *message)
{
        return button_new_image_text(gtk_image_new_from_stock(stock,
                                               GTK_ICON_SIZE_BUTTON),
                                        message);
}

/* Highlight entry in red if 'error' is TRUE */
void entry_set_error(GtkWidget *entry, gboolean error)
{
        const GdkColor red = {0, 0xffff, 0, 0};
        const GdkColor white = {0, 0xffff, 0xffff, 0xffff};

        gtk_widget_modify_text(entry, GTK_STATE_NORMAL, error ? &red : NULL);
        gtk_widget_modify_base(entry, GTK_STATE_NORMAL, error ? &white : NULL);
}

/* Change stacking position of higher to be just above lower.
 * If lower is NULL, put higher at the bottom of the stack.
 */
void window_put_just_above(GdkWindow *higher, GdkWindow *lower)
{
        if (o_override_redirect.int_value && lower)
        {
                XWindowChanges restack;

                gdk_error_trap_push();
                
                restack.stack_mode = Above;

                restack.sibling = GDK_WINDOW_XWINDOW(lower);

                XConfigureWindow(gdk_display, GDK_WINDOW_XWINDOW(higher),
                                CWSibling | CWStackMode, &restack);

                gdk_flush();
                if (gdk_error_trap_pop())
                        g_warning("window_put_just_above()\n");
        }
        else
                gdk_window_lower(higher);       /* To bottom of stack */
}

/* Copied from Gtk */
static GtkFixedChild* fixed_get_child(GtkFixed *fixed, GtkWidget *widget)
{
        GList *children;

        children = fixed->children;
        while (children)
        {
                GtkFixedChild *child;

                child = children->data;
                children = children->next;

                if (child->widget == widget)
                        return child;
        }

        return NULL;
}

/* Like gtk_fixed_move(), except not insanely slow */
void fixed_move_fast(GtkFixed *fixed, GtkWidget *widget, int x, int y)
{
        GtkFixedChild *child;

        child = fixed_get_child(fixed, widget);

        g_assert(child);

        gtk_widget_freeze_child_notify(widget);

        child->x = x;
        gtk_widget_child_notify(widget, "x");

        child->y = y;
        gtk_widget_child_notify(widget, "y");

        gtk_widget_thaw_child_notify(widget);

        if (GTK_WIDGET_VISIBLE(widget) && GTK_WIDGET_VISIBLE(fixed))
        {
                int border_width = GTK_CONTAINER(fixed)->border_width;
                GtkAllocation child_allocation;
                GtkRequisition child_requisition;

                gtk_widget_get_child_requisition(child->widget,
                                        &child_requisition);
                child_allocation.x = child->x + border_width;
                child_allocation.y = child->y + border_width;

                child_allocation.x += GTK_WIDGET(fixed)->allocation.x;
                child_allocation.y += GTK_WIDGET(fixed)->allocation.y;

                child_allocation.width = child_requisition.width;
                child_allocation.height = child_requisition.height;
                gtk_widget_size_allocate(child->widget, &child_allocation);
        }
}

/* Draw the black border */
static gint tooltip_draw(GtkWidget *w)
{
        gdk_draw_rectangle(w->window, w->style->fg_gc[w->state], FALSE, 0, 0,
                        w->allocation.width - 1, w->allocation.height - 1);

        return FALSE;
}

/* When the tips window closed, record the time. If we try to open another
 * tip soon, it will appear more quickly.
 */
static void tooltip_destroyed(gpointer data)
{
        time(&tip_time);
}

/* Display a tooltip-like widget near the pointer with 'text'. If 'text' is
 * NULL, close any current tooltip.
 */
void tooltip_show(guchar *text)
{
        GtkWidget *label;
        int     x, y, py;
        int     w, h;
        int m;

        if (tip_timeout)
        {
                g_source_remove(tip_timeout);
                tip_timeout = 0;
        }

        if (tip_widget)
        {
                gtk_widget_destroy(tip_widget);
                tip_widget = NULL;
        }

        if (!text)
                return;

        /* Show the tip */
        tip_widget = gtk_window_new(GTK_WINDOW_POPUP);
        gtk_widget_set_app_paintable(tip_widget, TRUE);
        gtk_widget_set_name(tip_widget, "gtk-tooltips");

        g_signal_connect_swapped(tip_widget, "expose_event",
                        G_CALLBACK(tooltip_draw), tip_widget);

        label = gtk_label_new(text);
        gtk_misc_set_padding(GTK_MISC(label), 4, 2);
        gtk_container_add(GTK_CONTAINER(tip_widget), label);
        gtk_widget_show(label);
        gtk_widget_realize(tip_widget);

        w = tip_widget->allocation.width;
        h = tip_widget->allocation.height;
        gdk_window_get_pointer(NULL, &x, &py, NULL);

        m = gdk_screen_get_monitor_at_point(gdk_screen_get_default(), x, py);
        
        x -= w / 2;
        y = py + 12; /* I don't know the pointer height so I use a constant */

        /* Now check for screen boundaries */
        x = CLAMP(x, monitor_geom[m].x,
                        monitor_geom[m].x + monitor_geom[m].width - w);
        y = CLAMP(y, monitor_geom[m].y,
                        monitor_geom[m].y + monitor_geom[m].height - h);

        /* And again test if pointer is over the tooltip window */
        if (py >= y && py <= y + h)
                y = py - h - 2;
        gtk_window_move(GTK_WINDOW(tip_widget), x, y);
        gtk_widget_show(tip_widget);

        g_signal_connect_swapped(tip_widget, "destroy",
                        G_CALLBACK(tooltip_destroyed), NULL);
        time(&tip_time);
}

/* Call callback(user_data) after a while, unless cancelled.
 * Object is refd now and unref when cancelled / after callback called.
 */
void tooltip_prime(GtkFunction callback, GObject *object)
{
        time_t  now;
        int     delay;

        g_return_if_fail(tip_timeout == 0);
        
        time(&now);
        delay = now - tip_time > 2 ? 1000 : 200;

        g_object_ref(object);
        tip_timeout = g_timeout_add_full(G_PRIORITY_DEFAULT_IDLE,
                                         delay,
                                         (GSourceFunc) callback,
                                         object,
                                         g_object_unref);
}

/* Like gtk_widget_modify_font, but copes with font_desc == NULL */
void widget_modify_font(GtkWidget *widget, PangoFontDescription *font_desc)
{
        GtkRcStyle *rc_style;

        g_return_if_fail(GTK_IS_WIDGET(widget));

        rc_style = gtk_widget_get_modifier_style(widget);  

        if (rc_style->font_desc)
                pango_font_description_free(rc_style->font_desc);

        rc_style->font_desc = font_desc
                                ? pango_font_description_copy(font_desc)
                                : NULL;

        gtk_widget_modify_style(widget, rc_style);
}

/* Confirm the action with the user. If action is NULL, the text from stock
 * is used.
 */
gboolean confirm(const gchar *message, const gchar *stock, const gchar *action)
{
        return get_choice(PROJECT, message, 2,
                          GTK_STOCK_CANCEL, NULL,
                          stock, action) == 1;
}

struct _Radios {
        GList *widgets;

        void (*changed)(Radios *, gpointer data);
        gpointer changed_data;
};

/* Create a new set of radio buttons.
 * Use radios_add to add options, then radios_pack to put them into something.
 * The radios object will self-destruct with the first widget it contains.
 * changed(data) is called (if not NULL) when pack is called, and on any
 * change after that.
 */
Radios *radios_new(void (*changed)(Radios *, gpointer data), gpointer data)
{
        Radios *radios;

        radios = g_new(Radios, 1);

        radios->widgets = NULL;
        radios->changed = changed;
        radios->changed_data = data;

        return radios;
}

static void radios_free(GtkWidget *radio, Radios *radios)
{
        g_return_if_fail(radios != NULL);

        g_list_free(radios->widgets);
        g_free(radios);
}

void radios_add(Radios *radios, const gchar *tip, gint value,
                const gchar *label, ...)
{
        GtkWidget *radio;
        GSList *group = NULL;
        gchar *s;
        va_list args;

        g_return_if_fail(radios != NULL);
        g_return_if_fail(label != NULL);

        va_start(args, label);
        s = g_strdup_vprintf(label, args);
        va_end(args);

        if (radios->widgets)
        {
                GtkRadioButton *first = GTK_RADIO_BUTTON(radios->widgets->data);
                group = gtk_radio_button_get_group(first);
        }

        radio = gtk_radio_button_new_with_label(group, s);
        gtk_label_set_line_wrap(GTK_LABEL(GTK_BIN(radio)->child), TRUE);
        gtk_widget_show(radio);
        if (tip)
                gtk_tooltips_set_tip(tooltips, radio, tip, NULL);
        if (!group)
                g_signal_connect(G_OBJECT(radio), "destroy",
                                G_CALLBACK(radios_free), radios);

        radios->widgets = g_list_prepend(radios->widgets, radio);
        g_object_set_data(G_OBJECT(radio), "rox-radios-value",
                          GINT_TO_POINTER(value));
}

static void radio_toggled(GtkToggleButton *button, Radios *radios)
{
        g_return_if_fail(radios != NULL);

        if (button && !gtk_toggle_button_get_active(button))
                return; /* Stop double-notifies */

        if (radios->changed)
                radios->changed(radios, radios->changed_data);
}

void radios_pack(Radios *radios, GtkBox *box)
{
        GList *next;

        g_return_if_fail(radios != NULL);

        for (next = g_list_last(radios->widgets); next; next = next->prev)
        {
                GtkWidget *button = GTK_WIDGET(next->data);

                gtk_box_pack_start(box, button, FALSE, TRUE, 0);
                g_signal_connect(button, "toggled",
                                G_CALLBACK(radio_toggled), radios);
        }
        radio_toggled(NULL, radios);
}

void radios_set_value(Radios *radios, gint value)
{
        GList *next;

        g_return_if_fail(radios != NULL);

        for (next = radios->widgets; next; next = next->next)
        {
                GtkToggleButton *radio = GTK_TOGGLE_BUTTON(next->data);
                int radio_value;

                radio_value = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(radio),
                                                "rox-radios-value"));
                
                if (radio_value == value)
                {
                        gtk_toggle_button_set_active(radio, TRUE);
                        return;
                }
        }

        g_warning("Value %d not in radio group!", value);
}

gint radios_get_value(Radios *radios)
{
        GList *next;

        g_return_val_if_fail(radios != NULL, -1);

        for (next = radios->widgets; next; next = next->next)
        {
                GtkToggleButton *radio = GTK_TOGGLE_BUTTON(next->data);

                if (gtk_toggle_button_get_active(radio))
                        return GPOINTER_TO_INT(g_object_get_data(
                                        G_OBJECT(radio), "rox-radios-value"));
        }

        g_warning("Nothing in the radio group is selected!");

        return -1;
}

/* Convert a list of URIs as a string into a GList of EscapedPath URIs.
 * No unescaping is done.
 * Lines beginning with # are skipped.
 * The text block passed in is zero terminated (after the final CRLF)
 */
GList *uri_list_to_glist(const char *uri_list)
{
        GList   *list = NULL;

        while (*uri_list)
        {
                char    *linebreak;
                int     length;

                linebreak = strchr(uri_list, 13);

                if (!linebreak || linebreak[1] != 10)
                {
                        delayed_error("uri_list_to_glist: %s",
                                        _("Incorrect or missing line "
                                          "break in text/uri-list data"));
                        return list;
                }

                length = linebreak - uri_list;

                if (length && uri_list[0] != '#')
                        list = g_list_append(list, g_strndup(uri_list, length));

                uri_list = linebreak + 2;
        }

        return list;
}

typedef struct _SimpleImageClass SimpleImageClass;
typedef struct _SimpleImage SimpleImage;

struct _SimpleImageClass {
        GtkWidgetClass parent;
};

struct _SimpleImage {
        GtkWidget widget;

        GdkPixbuf *pixbuf;
        int       width, height;
};

#define SIMPLE_IMAGE(obj) (GTK_CHECK_CAST((obj), \
                                simple_image_get_type(), SimpleImage))

static void simple_image_finialize(GObject *object)
{
        SimpleImage *image = SIMPLE_IMAGE(object);

        g_object_unref(G_OBJECT(image->pixbuf));
        image->pixbuf = NULL;
}

static void simple_image_size_request(GtkWidget      *widget,
                                      GtkRequisition *requisition)
{
        SimpleImage *image = (SimpleImage *) widget;

        requisition->width = image->width;
        requisition->height = image->height;
}

/* Render a pixbuf without messing up the clipping */
void render_pixbuf(GdkPixbuf *pixbuf, GdkDrawable *target, GdkGC *gc,
                   int x, int y, int width, int height)
{
        gdk_draw_pixbuf(target, gc, pixbuf, 0, 0, x, y, width, height,
                        GDK_RGB_DITHER_NORMAL, 0, 0);

}

static gint simple_image_expose(GtkWidget *widget, GdkEventExpose *event)
{
        SimpleImage *image = (SimpleImage *) widget;
        int x;
        
        gdk_gc_set_clip_region(widget->style->black_gc, event->region);

        x = widget->allocation.x +
                (widget->allocation.width - image->width) / 2;
        
        render_pixbuf(image->pixbuf, widget->window, widget->style->black_gc,
                        x, widget->allocation.y,
                        image->width, image->height);
                        
        gdk_gc_set_clip_region(widget->style->black_gc, NULL);
        return FALSE;
}

static void simple_image_class_init(gpointer gclass, gpointer data)
{
        GObjectClass *object = (GObjectClass *) gclass;
        GtkWidgetClass *widget = (GtkWidgetClass *) gclass;

        object->finalize = simple_image_finialize;
        widget->size_request = simple_image_size_request;
        widget->expose_event = simple_image_expose;
}

static void simple_image_init(GTypeInstance *object, gpointer gclass)
{
        GTK_WIDGET_SET_FLAGS(object, GTK_NO_WINDOW);
}

static GType simple_image_get_type(void)
{
        static GType type = 0;

        if (!type)
        {
                static const GTypeInfo info =
                {
                        sizeof (SimpleImageClass),
                        NULL,                   /* base_init */
                        NULL,                   /* base_finalise */
                        simple_image_class_init,
                        NULL,                   /* class_finalise */
                        NULL,                   /* class_data */
                        sizeof(SimpleImage),
                        0,                      /* n_preallocs */
                        simple_image_init,
                };

                type = g_type_register_static(gtk_widget_get_type(),
                                                "SimpleImage", &info, 0);
        }

        return type;
}

GtkWidget *simple_image_new(GdkPixbuf *pixbuf)
{
        SimpleImage *image;

        g_return_val_if_fail(pixbuf != NULL, NULL);

        image = g_object_new(simple_image_get_type(), NULL);

        image->pixbuf = pixbuf;
        g_object_ref(G_OBJECT(pixbuf));

        image->width = gdk_pixbuf_get_width(pixbuf);
        image->height = gdk_pixbuf_get_height(pixbuf);

        return GTK_WIDGET(image);
}

/* Whether a line l1 long starting from n1 overlaps a line l2 from n2 */
inline static gboolean gui_ranges_overlap(int n1, int l1, int n2, int l2)
{
        return (n1 > n2 && n1 < n2 + l2) ||
                (n1 + l1 > n2 && n1 + l1 < n2 + l2) ||
                (n1 <= n2 && n1 + l1 >= n2 + l2);
}

static void gui_get_monitor_adjacent(int monitor, MonitorAdjacent *adj)
{
        int m;

        adj->left = adj->right = adj->top = adj->bottom = FALSE;

        for (m = 0; m < n_monitors; ++m)
        {
                if (m == monitor)
                        continue;
                if (gui_ranges_overlap(monitor_geom[m].y,
                                monitor_geom[m].height,
                                monitor_geom[monitor].y,
                                monitor_geom[monitor].height))
                {
                        if (monitor_geom[m].x < monitor_geom[monitor].x)
                        {
                                adj->left = TRUE;
                        }
                        else if (monitor_geom[m].x > monitor_geom[monitor].x)
                        {
                                adj->right = TRUE;
                        }
                }
                if (gui_ranges_overlap(monitor_geom[m].x,
                                monitor_geom[m].width,
                                monitor_geom[monitor].x,
                                monitor_geom[monitor].width))
                {
                        if (monitor_geom[m].y < monitor_geom[monitor].y)
                        {
                                adj->top = TRUE;
                        }
                        else if (monitor_geom[m].y > monitor_geom[monitor].y)
                        {
                                adj->bottom = TRUE;
                        }
                }
        }
}

static void rox_wmspec_change_state(gboolean add, GdkWindow *window,
                                    GdkAtom state1, GdkAtom state2)
{
        GdkDisplay *display = gdk_drawable_get_display(GDK_DRAWABLE(window));
        XEvent xev;
        
#define _NET_WM_STATE_REMOVE        0    /* remove/unset property */
#define _NET_WM_STATE_ADD           1    /* add/set property */
#define _NET_WM_STATE_TOGGLE        2    /* toggle property  */  

        xev.xclient.type = ClientMessage;
        xev.xclient.serial = 0;
        xev.xclient.send_event = True;
        xev.xclient.window = GDK_WINDOW_XID(window);
        xev.xclient.message_type = gdk_x11_get_xatom_by_name_for_display(
                        display, "_NET_WM_STATE");
        xev.xclient.format = 32;
        xev.xclient.data.l[0] = add ? _NET_WM_STATE_ADD : _NET_WM_STATE_REMOVE;
        xev.xclient.data.l[1] = gdk_x11_atom_to_xatom_for_display(display,
                        state1);
        xev.xclient.data.l[2] = gdk_x11_atom_to_xatom_for_display(display,
                        state2);
        xev.xclient.data.l[3] = 0;
        xev.xclient.data.l[4] = 0;
        
        XSendEvent(GDK_DISPLAY_XDISPLAY(display),
                   GDK_WINDOW_XID(
                        gdk_screen_get_root_window(
                                gdk_drawable_get_screen(GDK_DRAWABLE(window)))),
                   False,
                   SubstructureRedirectMask | SubstructureNotifyMask,
                   &xev);
}

void keep_below(GdkWindow *window, gboolean setting)
{
        g_return_if_fail(GDK_IS_WINDOW(window));

        if (GDK_WINDOW_DESTROYED(window))
                return;

        if (gdk_window_is_visible(window))
        {
                if (setting)
                {
                        rox_wmspec_change_state(FALSE, window,
                                gdk_atom_intern("_NET_WM_STATE_ABOVE", FALSE),
                                GDK_NONE);
                }
                rox_wmspec_change_state(setting, window,
                                gdk_atom_intern("_NET_WM_STATE_BELOW", FALSE),
                                GDK_NONE);
        }
#if 0
        else
        {
#if GTK_CHECK_VERSION(2,4,0)
          gdk_synthesize_window_state(window,
                                setting ? GDK_WINDOW_STATE_ABOVE :
                                        GDK_WINDOW_STATE_BELOW,
                                setting ? GDK_WINDOW_STATE_BELOW : 0);
#endif
        }
#endif
}

static void
size_prepared_cb (GdkPixbufLoader *loader, 
                  int              width,
                  int              height,
                  gpointer         data)
{
        struct {
                gint width;
                gint height;
                gboolean preserve_aspect_ratio;
        } *info = data;

        g_return_if_fail (width > 0 && height > 0);

        if(info->preserve_aspect_ratio) {
                if ((double)height * (double)info->width >
                    (double)width * (double)info->height) {
                        width = 0.5 + (double)width * (double)info->height / (double)height;
                        height = info->height;
                } else {
                        height = 0.5 + (double)height * (double)info->width / (double)width;
                        width = info->width;
                }
        } else {
                width = info->width;
                height = info->height;
        }
        
        gdk_pixbuf_loader_set_size (loader, width, height);
}

/**
 * rox_pixbuf_new_from_file_at_scale:
 * @filename: Name of file to load.
 * @width: The width the image should have
 * @height: The height the image should have
 * @preserve_aspect_ratio: %TRUE to preserve the image's aspect ratio
 * @error: Return location for an error
 *
 * Creates a new pixbuf by loading an image from a file.  The file format is
 * detected automatically. If %NULL is returned, then @error will be set.
 * Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
 * The image will be scaled to fit in the requested size, optionally preserving
 * the image's aspect ratio.
 *
 * Return value: A newly-created pixbuf with a reference count of 1, or %NULL 
 * if any of several error conditions occurred:  the file could not be opened,
 * there was no loader for the file's format, there was not enough memory to
 * allocate the image buffer, or the image file contained invalid data.
 *
 * Taken from GTK 2.6.
 **/
GdkPixbuf *
rox_pixbuf_new_from_file_at_scale (const char *filename,
                                   int         width, 
                                   int         height,
                                   gboolean    preserve_aspect_ratio,
                                   GError    **error)
{

        GdkPixbufLoader *loader;
        GdkPixbuf       *pixbuf;

        guchar buffer [4096];
        int length;
        FILE *f;
        struct {
                gint width;
                gint height;
                gboolean preserve_aspect_ratio;
        } info;

        g_return_val_if_fail (filename != NULL, NULL);
        g_return_val_if_fail (width > 0 && height > 0, NULL);

        f = fopen (filename, "rb");
        if (!f) {
                gchar *utf8_filename = g_filename_to_utf8 (filename, -1,
                                                           NULL, NULL, NULL);
                g_set_error (error,
                             G_FILE_ERROR,
                             g_file_error_from_errno (errno),
                             _("Failed to open file '%s': %s"),
                             utf8_filename ? utf8_filename : "???",
                             g_strerror (errno));
                g_free (utf8_filename);
                return NULL;
        }

        loader = gdk_pixbuf_loader_new ();

        info.width = width;
        info.height = height;
        info.preserve_aspect_ratio = preserve_aspect_ratio;

        g_signal_connect (loader, "size-prepared", G_CALLBACK (size_prepared_cb), &info);

        while (!feof (f) && !ferror (f)) {
                length = fread (buffer, 1, sizeof (buffer), f);
                if (length > 0)
                        if (!gdk_pixbuf_loader_write (loader, buffer, length, error)) {
                                gdk_pixbuf_loader_close (loader, NULL);
                                fclose (f);
                                g_object_unref (loader);
                                return NULL;
                        }
        }

        fclose (f);

        if (!gdk_pixbuf_loader_close (loader, error)) {
                g_object_unref (loader);
                return NULL;
        }

        pixbuf = gdk_pixbuf_loader_get_pixbuf (loader);

        if (!pixbuf) {
                gchar *utf8_filename = g_filename_to_utf8 (filename, -1,
                                                           NULL, NULL, NULL);

                g_object_unref (loader);

                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_FAILED,
                             _("Failed to load image '%s': reason not known, probably a corrupt image file"),
                             utf8_filename ? utf8_filename : "???");
                g_free (utf8_filename);
                return NULL;
        }

        g_object_ref (pixbuf);

        g_object_unref (loader);

        return pixbuf;
}

/* Make the name bolder and larger.
 * scale_factor can be PANGO_SCALE_X_LARGE, etc.
 */
void make_heading(GtkWidget *label, double scale_factor)
{
        PangoAttribute *attr;
        PangoAttrList *list;

        list = pango_attr_list_new();

        attr = pango_attr_weight_new(PANGO_WEIGHT_BOLD);
        attr->start_index = 0;
        attr->end_index = -1;
        pango_attr_list_insert(list, attr);

        attr = pango_attr_scale_new(scale_factor);
        attr->start_index = 0;
        attr->end_index = -1;
        pango_attr_list_insert(list, attr);

        gtk_label_set_attributes(GTK_LABEL(label), list);
}

/* Launch a program using 0launch.
 * If button-3 is used, open the GUI with -g.
 */
void launch_uri(const char *uri)
{
        const char *argv[] = {"0launch", NULL, NULL, NULL};
        const char *uri_0launch = "/uri/0install/zero-install.sourceforge.net"
                                  "/bin/0launch";

        if (!available_in_path(argv[0]))
        {
                if (access(uri_0launch, X_OK) == 0)
                        argv[0] = uri_0launch;
                else
                {
                        delayed_error(_("This program (%s) cannot be run, "
                                "as the 0launch command is not available. "
                                "It can be downloaded from here:\n\n"
                                "http://0install.net/injector.html"),
                                uri);
                        return;
                }
        }

        if (current_event_button() == 3)
        {
                argv[1] = "-g";
                argv[2] = uri;
        }
        else
                argv[1] = uri;

        rox_spawn(NULL, argv);
}

static gint button3_button_pressed(GtkButton *button,
                                GdkEventButton *event,
                                gpointer date)
{
        if (event->button == 3)
        {
                gtk_grab_add(GTK_WIDGET(button));
                gtk_button_pressed(button);

                return TRUE;
        }

        return FALSE;
}

static gint button3_button_released(GtkButton *button,
                                GdkEventButton *event,
                                FilerWindow *filer_window)
{
        if (event->button == 3)
        {
                gtk_grab_remove(GTK_WIDGET(button));
                gtk_button_released(button);

                return TRUE;
        }

        return FALSE;
}

void allow_right_click(GtkWidget *button)
{
        g_signal_connect(button, "button_press_event",
                G_CALLBACK(button3_button_pressed), NULL);
        g_signal_connect(button, "button_release_event",
                G_CALLBACK(button3_button_released), NULL);
}

/* Return mouse button used in the current event, or -1 if none (no event,
 * or not a click).
 */
gint current_event_button(void)
{
        GdkEventButton *bev;
        gint button = -1;

        bev = (GdkEventButton *) gtk_get_current_event();

        if (bev &&
            (bev->type == GDK_BUTTON_PRESS || bev->type == GDK_BUTTON_RELEASE))
                button = bev->button;

        gdk_event_free((GdkEvent *) bev);

        return button;
}

/* Create a new pixbuf by colourizing 'src' to 'color'. If the function fails,
 * 'src' will be returned (with an increased reference count, so it is safe to
 * g_object_unref() the return value whether the function fails or not).
 */
GdkPixbuf *create_spotlight_pixbuf(GdkPixbuf *src, GdkColor *color)
{
        guchar opacity = 192;
        guchar alpha = 255 - opacity;
        GdkPixbuf *dst;
        GdkColorspace colorspace;
        int width, height, src_rowstride, dst_rowstride, x, y;
        int n_channels, bps;
        int r, g, b;
        guchar *spixels, *dpixels, *src_pixels, *dst_pixels;
        gboolean has_alpha;

        has_alpha = gdk_pixbuf_get_has_alpha(src);
        colorspace = gdk_pixbuf_get_colorspace(src);
        n_channels = gdk_pixbuf_get_n_channels(src);
        bps = gdk_pixbuf_get_bits_per_sample(src);

        if ((colorspace != GDK_COLORSPACE_RGB) ||
            (!has_alpha && n_channels != 3) ||
            (has_alpha && n_channels != 4) ||
            (bps != 8))
                goto error;

        width = gdk_pixbuf_get_width(src);
        height = gdk_pixbuf_get_height(src);

        dst = gdk_pixbuf_new(colorspace, has_alpha, bps, width, height);
        if (dst == NULL)
                goto error;

        src_pixels = gdk_pixbuf_get_pixels(src);
        dst_pixels = gdk_pixbuf_get_pixels(dst);
        src_rowstride = gdk_pixbuf_get_rowstride(src);
        dst_rowstride = gdk_pixbuf_get_rowstride(dst);

        r = opacity * (color->red >> 8);
        g = opacity * (color->green >> 8);
        b = opacity * (color->blue >> 8);

        for (y = 0; y < height; y++)
        {
                spixels = src_pixels + y * src_rowstride;
                dpixels = dst_pixels + y * dst_rowstride;
                for (x = 0; x < width; x++)
                {
                        *dpixels++ = (*spixels++ * alpha + r) >> 8;
                        *dpixels++ = (*spixels++ * alpha + g) >> 8;
                        *dpixels++ = (*spixels++ * alpha + b) >> 8;
                        if (has_alpha)
                                *dpixels++ = *spixels++;
                }

        }
        return dst;

error:
        g_object_ref(src);
        return src;
}

/* Load the Templates.glade file and build a component.
 * Note that libglade caches the XML itself.
 */
GladeXML *get_glade_xml(const char *component)
{
        GladeXML *widgets;
        char *path;

        path = g_build_filename(app_dir, "Templates.glade", NULL);
        widgets = glade_xml_new(path, component, NULL);

        if (widgets == NULL)
                g_warning("Failed to load widget '%s' from '%s'",
                                component, path);
        
        g_free(path);

        return widgets;
}

void add_stock_to_menu_item(GtkWidget *item, const char *stock)
{
        gtk_image_menu_item_set_image(GTK_IMAGE_MENU_ITEM(item),
                        gtk_image_new_from_stock(stock, GTK_ICON_SIZE_MENU));
}