evince/shell/ev-sidebar-annotations.c

/* ev-sidebar-annotations.c
 *  this file is part of evince, a gnome document viewer
 *
 * Copyright (C) 2010 Carlos Garcia Campos  <carlosgc@gnome.org>
 *
 * Evince 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.
 *
 * Evince 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#include "config.h"

#include <glib/gi18n.h>

#include "ev-document-annotations.h"
#include "ev-sidebar-page.h"
#include "ev-sidebar-annotations.h"
#include "ev-jobs.h"
#include "ev-job-scheduler.h"
#include "ev-stock-icons.h"
#include "ev-window.h"
#include "ev-utils.h"

enum {
	PROP_0,
	PROP_WIDGET
};

enum {
	COLUMN_MARKUP,
	COLUMN_ICON,
	COLUMN_ANNOT_MAPPING,
	COLUMN_TOOLTIP,
	N_COLUMNS
};

enum {
	ANNOT_ACTIVATED,
	N_SIGNALS
};

struct _EvSidebarAnnotationsPrivate {
	EvDocument  *document;

	GtkWidget    *swindow;
	GtkWidget    *tree_view;
	GtkTreeStore *tree_model;
	GtkListStore *list_model;

	GMenuModel   *popup_model;
	GtkWidget    *popup;

	EvJob        *job;
	guint         selection_changed_id;
};

#define GET_PRIVATE(o) ev_sidebar_annotations_get_instance_private (o)

static void ev_sidebar_annotations_page_iface_init (EvSidebarPageInterface *iface);
static void ev_sidebar_annotations_load            (EvSidebarAnnotations   *sidebar_annots);
static gboolean ev_sidebar_annotations_popup_menu (GtkWidget *widget);
static gboolean ev_sidebar_annotations_popup_menu_show (EvSidebarAnnotations *sidebar_annots,
							GdkWindow            *rect_window,
							const GdkRectangle   *rect,
							EvMapping            *annot_mapping,
							const GdkEvent       *event);
static void job_finished_callback (EvJobAnnots          *job,
				   EvSidebarAnnotations *sidebar_annots);
static guint signals[N_SIGNALS];

G_DEFINE_TYPE_EXTENDED (EvSidebarAnnotations,
                        ev_sidebar_annotations,
                        GTK_TYPE_BOX,
                        0,
                        G_ADD_PRIVATE (EvSidebarAnnotations)
                        G_IMPLEMENT_INTERFACE (EV_TYPE_SIDEBAR_PAGE,
					       ev_sidebar_annotations_page_iface_init))

#define ANNOT_ICON_SIZE 16

static void
ev_sidebar_annotations_dispose (GObject *object)
{
	EvSidebarAnnotations *sidebar_annots = EV_SIDEBAR_ANNOTATIONS (object);
	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);

	if (priv->job != NULL) {
		g_signal_handlers_disconnect_by_func (priv->job,
						      job_finished_callback,
						      sidebar_annots);
		g_clear_object (&priv->job);
	}

	if (priv->document) {
		g_object_unref (priv->document);
		priv->document = NULL;
	}

	g_clear_object (&priv->popup_model);
	G_OBJECT_CLASS (ev_sidebar_annotations_parent_class)->dispose (object);
}

static void
ev_sidebar_annotations_set_simple_message (EvSidebarAnnotations *sidebar_annots,
					   const gchar          *message)
{
	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);
	GtkTreeIter iter;
	gchar *markup;

	gtk_tree_model_get_iter_first (GTK_TREE_MODEL (priv->list_model), &iter);
	markup = g_strdup_printf ("<span size=\"larger\" style=\"italic\">%s</span>",
				  message);
	gtk_list_store_set (GTK_LIST_STORE (priv->list_model), &iter,
			    COLUMN_MARKUP, markup, -1);
	g_free (markup);

	gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view),
				 GTK_TREE_MODEL (priv->list_model));
}

static void
ev_sidebar_annotations_init (EvSidebarAnnotations *sidebar_annots)
{
	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);
	GtkBuilder *builder;

	gtk_widget_init_template (GTK_WIDGET (sidebar_annots));

	ev_sidebar_annotations_set_simple_message (sidebar_annots, _("Loading…"));

	/* Annotation pop-up */
	builder = gtk_builder_new_from_resource ("/org/gnome/evince/gtk/menus.ui");
	priv->popup_model = g_object_ref (G_MENU_MODEL (gtk_builder_get_object (builder, "annotation-popup")));
	g_object_unref (builder);
	priv->popup = gtk_menu_new_from_model (priv->popup_model);
	gtk_menu_attach_to_widget (GTK_MENU (priv->popup),
				   GTK_WIDGET (sidebar_annots), NULL);
}

static void
ev_sidebar_annotations_get_property (GObject    *object,
				     guint       prop_id,
				     GValue     *value,
				     GParamSpec *pspec)
{
	EvSidebarAnnotations *ev_sidebar_annots;

	ev_sidebar_annots = EV_SIDEBAR_ANNOTATIONS (object);

	switch (prop_id) {
	        case PROP_WIDGET:
			g_value_set_object (value, ev_sidebar_annots->priv->swindow);
			break;
	        default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
			break;
	}
}

static void
ev_sidebar_annotations_class_init (EvSidebarAnnotationsClass *klass)
{
	GObjectClass *g_object_class = G_OBJECT_CLASS (klass);
	GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);

	g_object_class->get_property = ev_sidebar_annotations_get_property;
	g_object_class->dispose = ev_sidebar_annotations_dispose;
	widget_class->popup_menu = ev_sidebar_annotations_popup_menu;

	gtk_widget_class_set_template_from_resource (widget_class,
						     "/org/gnome/evince/ui/sidebar-annotations.ui");
	gtk_widget_class_bind_template_child_private (widget_class, EvSidebarAnnotations, swindow);
	gtk_widget_class_bind_template_child_private (widget_class, EvSidebarAnnotations, tree_view);
	gtk_widget_class_bind_template_child_private (widget_class, EvSidebarAnnotations, tree_model);
	gtk_widget_class_bind_template_child_private (widget_class, EvSidebarAnnotations, list_model);

	g_object_class_override_property (g_object_class, PROP_WIDGET, "main-widget");

	signals[ANNOT_ACTIVATED] =
		g_signal_new ("annot-activated",
			      G_TYPE_FROM_CLASS (g_object_class),
			      G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
			      G_STRUCT_OFFSET (EvSidebarAnnotationsClass, annot_activated),
			      NULL, NULL,
			      g_cclosure_marshal_VOID__POINTER,
			      G_TYPE_NONE, 1,
			      G_TYPE_POINTER);
}

GtkWidget *
ev_sidebar_annotations_new (void)
{
	return GTK_WIDGET (g_object_new (EV_TYPE_SIDEBAR_ANNOTATIONS,
                                         "orientation", GTK_ORIENTATION_VERTICAL,
                                         NULL));
}

void
ev_sidebar_annotations_annot_added (EvSidebarAnnotations *sidebar_annots,
				    EvAnnotation         *annot)
{
	ev_sidebar_annotations_load (sidebar_annots);
}

void
ev_sidebar_annotations_annot_changed (EvSidebarAnnotations *sidebar_annots,
				      EvAnnotation         *annot)
{
	ev_sidebar_annotations_load (sidebar_annots);
}

void
ev_sidebar_annotations_annot_removed (EvSidebarAnnotations *sidebar_annots)
{
	ev_sidebar_annotations_load (sidebar_annots);
}

/**
 * iter_has_mapping:
 * @model: a #GtkTreeModel
 * @iter: a #GtkTreeIter contained in @model
 * @mapping_out: (out) (allow-none): if non-%NULL, will be
 *               filled with the found mapping (#EvMapping)
 *
 * Checks whether @iter contains a #EvMapping, optionally
 * placing it in @mapping_out.
 */
static gboolean
iter_has_mapping (GtkTreeModel  *model,
		  GtkTreeIter   *iter,
		  EvMapping     **mapping_out)
{
	EvMapping *mapping = NULL;

	gtk_tree_model_get (model, iter,
			    COLUMN_ANNOT_MAPPING, &mapping,
			    -1);

	if (mapping_out && mapping)
		*mapping_out = mapping;

	return mapping != NULL;
}

static void
ev_sidebar_annotations_activate_result_at_iter (EvSidebarAnnotations *sidebar_annots,
                                                GtkTreeModel  *model,
                                                GtkTreeIter   *iter)
{
	EvMapping *mapping;

	if (iter_has_mapping (model, iter, &mapping))
		g_signal_emit (sidebar_annots, signals[ANNOT_ACTIVATED], 0, mapping);
}

static void
selection_changed_cb (GtkTreeSelection     *selection,
		      EvSidebarAnnotations *sidebar_annots)
{
	GtkTreeModel *model;
	GtkTreeIter   iter;

	if (gtk_tree_selection_get_selected (selection, &model, &iter))
	    ev_sidebar_annotations_activate_result_at_iter (sidebar_annots, model, &iter);
}

static gboolean
sidebar_tree_button_press_cb (GtkTreeView    *view,
                              GdkEventButton *event,
                              EvSidebarAnnotations  *sidebar_annots)
{
        GtkTreeModel         *model;
        GtkTreePath          *path;
        GtkTreeIter           iter;
        GtkTreeSelection     *selection;
        EvMapping            *annot_mapping;
        GdkRectangle          rect;

        gtk_tree_view_get_path_at_pos (view, event->x, event->y, &path,
                                       NULL, NULL, NULL);
        if (!path)
                return GDK_EVENT_PROPAGATE;

	model = gtk_tree_view_get_model (view);
	gtk_tree_model_get_iter (model, &iter, path);
	gtk_tree_path_free (path);
        selection = gtk_tree_view_get_selection (view);

	if (gdk_event_triggers_context_menu ((const GdkEvent *) event) &&
	    iter_has_mapping (model, &iter, &annot_mapping)) {

		ev_sidebar_annotations_activate_result_at_iter (sidebar_annots, model, &iter);

		if (!EV_IS_ANNOTATION (annot_mapping->data))
			return GDK_EVENT_PROPAGATE;

		gtk_tree_selection_select_iter (selection, &iter);

		rect.x = event->x;
		rect.y = event->y;
		rect.width = rect.height = 1;
		ev_sidebar_annotations_popup_menu_show (sidebar_annots,
							gtk_tree_view_get_bin_window (view),
							&rect, annot_mapping, (GdkEvent *) event);

		return GDK_EVENT_STOP;
	} else {
		if (!gtk_tree_selection_iter_is_selected (selection, &iter))
			gtk_tree_selection_select_iter (selection, &iter);
		else
			/* This will reveal annotation again in case was scrolled out of EvView */
			ev_sidebar_annotations_activate_result_at_iter (sidebar_annots, model, &iter);
	}

        /* Propagate so the tree view gets the event and can update the selection etc. */
        return GDK_EVENT_PROPAGATE;
}

static void
job_finished_callback (EvJobAnnots          *job,
		       EvSidebarAnnotations *sidebar_annots)
{
	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);
	GtkTreeStore *model = priv->tree_model;
	GtkTreeSelection *selection;
	GList *l;

	if (!job->annots) {
		ev_sidebar_annotations_set_simple_message (sidebar_annots,
							   _("Document contains no annotations"));
		g_clear_object (&priv->job);

		return;
	}

	selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
	gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
	if (priv->selection_changed_id == 0) {
		priv->selection_changed_id =
			g_signal_connect (selection, "changed",
					  G_CALLBACK (selection_changed_cb),
					  sidebar_annots);
	}
	g_signal_connect (priv->tree_view, "button-press-event",
			  G_CALLBACK (sidebar_tree_button_press_cb),
			  sidebar_annots);

	g_signal_handler_block (selection, priv->selection_changed_id);
	gtk_tree_store_clear (model);
	g_signal_handler_unblock (selection, priv->selection_changed_id);

	for (l = job->annots; l; l = g_list_next (l)) {
		EvMappingList *mapping_list;
		GList         *ll;
		gchar         *page_label;
		GtkTreeIter    iter;
		gboolean       found = FALSE;

		mapping_list = (EvMappingList *)l->data;
		page_label = g_strdup_printf (_("Page %d"),
					      ev_mapping_list_get_page (mapping_list) + 1);
		gtk_tree_store_append (model, &iter, NULL);
		gtk_tree_store_set (model, &iter,
				    COLUMN_MARKUP, page_label,
				    -1);
		g_free (page_label);

		for (ll = ev_mapping_list_get_list (mapping_list); ll; ll = g_list_next (ll)) {
			EvAnnotation *annot;
			const gchar  *label;
			const gchar  *modified;
			const gchar  *contents;
			gchar        *markup = NULL;
			gchar        *tooltip = NULL;
			GtkTreeIter   child_iter;
			const gchar  *icon_name = NULL;

			annot = ((EvMapping *)(ll->data))->data;
			if (!EV_IS_ANNOTATION_MARKUP (annot))
				continue;

			label = ev_annotation_markup_get_label (EV_ANNOTATION_MARKUP (annot));
			modified = ev_annotation_get_modified (annot);
			contents = ev_annotation_get_contents (annot);

			if (modified)
				tooltip = g_strdup_printf ("<span weight=\"bold\">%s</span>\n%s", label, modified);
			else
				tooltip = g_strdup_printf ("<span weight=\"bold\">%s</span>", label);

			if (contents && *contents != '\0')
				markup = g_strdup_printf ("%s", contents);
			else
				markup = g_strdup_printf ("<i>%s</i>", _("No Comment"));

			if (EV_IS_ANNOTATION_TEXT (annot)) {
				icon_name = EV_STOCK_ANNOT_TEXT;
			} else if (EV_IS_ANNOTATION_ATTACHMENT (annot)) {
				icon_name = "mail-attachment-symbolic";
			} else if (EV_IS_ANNOTATION_TEXT_MARKUP (annot)) {
                                switch (ev_annotation_text_markup_get_markup_type (EV_ANNOTATION_TEXT_MARKUP (annot))) {
                                case EV_ANNOTATION_TEXT_MARKUP_HIGHLIGHT:
                                        icon_name = "format-justify-left-symbolic";
                                        break;
                                case EV_ANNOTATION_TEXT_MARKUP_STRIKE_OUT:
                                        icon_name = "format-text-strikethrough-symbolic";
                                        break;
                                case EV_ANNOTATION_TEXT_MARKUP_UNDERLINE:
                                        icon_name = "format-text-underline-symbolic";
                                        break;
                                case EV_ANNOTATION_TEXT_MARKUP_SQUIGGLY:
                                        icon_name = EV_STOCK_ANNOT_SQUIGGLY;
                                        break;
                                }
                        }

			gtk_tree_store_append (model, &child_iter, &iter);
			gtk_tree_store_set (model, &child_iter,
					    COLUMN_MARKUP, markup,
					    COLUMN_ICON, icon_name,
					    COLUMN_ANNOT_MAPPING, ll->data,
					    COLUMN_TOOLTIP, tooltip,
					    -1);
			g_free (markup);
			g_free (tooltip);
			found = TRUE;
		}

		if (!found)
			gtk_tree_store_remove (model, &iter);
	}

	gtk_tree_view_expand_all (GTK_TREE_VIEW (priv->tree_view));
	gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view),
				 GTK_TREE_MODEL (model));

	g_clear_object (&priv->job);
}

static void
ev_sidebar_annotations_load (EvSidebarAnnotations *sidebar_annots)
{
	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);

	if (priv->job) {
		g_signal_handlers_disconnect_by_func (priv->job,
						      job_finished_callback,
						      sidebar_annots);
		g_object_unref (priv->job);
	}

	priv->job = ev_job_annots_new (priv->document);
	g_signal_connect (priv->job, "finished",
			  G_CALLBACK (job_finished_callback),
			  sidebar_annots);
	/* The priority doesn't matter for this job */
	ev_job_scheduler_push_job (priv->job, EV_JOB_PRIORITY_NONE);
}

static void
ev_sidebar_annotations_document_changed_cb (EvDocumentModel      *model,
					    GParamSpec           *pspec,
					    EvSidebarAnnotations *sidebar_annots)
{
	EvDocument *document = ev_document_model_get_document (model);
	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);

	if (!EV_IS_DOCUMENT_ANNOTATIONS (document))
		return;

	if (priv->document)
		g_object_unref (priv->document);
	priv->document = g_object_ref (document);

	ev_sidebar_annotations_load (sidebar_annots);
}

/* event parameter can be NULL, that means popup was triggered from keyboard */
static gboolean
ev_sidebar_annotations_popup_menu_show (EvSidebarAnnotations *sidebar_annots,
					GdkWindow            *rect_window,
					const GdkRectangle   *rect,
					EvMapping            *annot_mapping,
					const GdkEvent       *event)
{
	GtkWidget *window;

	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);

	if (!EV_IS_ANNOTATION (annot_mapping->data))
		return FALSE;

	window = gtk_widget_get_toplevel (GTK_WIDGET (sidebar_annots));

	ev_window_handle_annot_popup (EV_WINDOW (window), EV_ANNOTATION (annot_mapping->data));
	gtk_menu_popup_at_rect (GTK_MENU (priv->popup), rect_window, rect,
				GDK_GRAVITY_SOUTH_WEST, GDK_GRAVITY_NORTH_WEST, event);
	return TRUE;
}

static gboolean
ev_sidebar_annotations_popup_menu (GtkWidget *widget)
{
	GtkTreeView          *tree_view;
	GtkTreeModel         *model;
	GtkTreePath          *path;
	GtkTreeSelection     *selection;
	EvMapping            *annot_mapping;
	GtkTreeIter           iter;
	GdkRectangle          rect;

	EvSidebarAnnotations *sidebar_annots = EV_SIDEBAR_ANNOTATIONS (widget);
	EvSidebarAnnotationsPrivate *priv = GET_PRIVATE (sidebar_annots);

	tree_view = GTK_TREE_VIEW (priv->tree_view);
	selection = gtk_tree_view_get_selection (tree_view);
	if (!gtk_tree_selection_get_selected (selection, &model, &iter))
		return FALSE;

	if (!iter_has_mapping (model, &iter, &annot_mapping))
		return FALSE;

	path = gtk_tree_model_get_path (model, &iter);

	gtk_tree_view_get_cell_area (tree_view, path,
				     gtk_tree_view_get_column (tree_view, 0),
				     &rect);
	gtk_tree_path_free (path);

	return ev_sidebar_annotations_popup_menu_show (sidebar_annots,
						       gtk_tree_view_get_bin_window (tree_view),
						       &rect, annot_mapping, NULL);
}

/* EvSidebarPageIface */
static void
ev_sidebar_annotations_set_model (EvSidebarPage   *sidebar_page,
				  EvDocumentModel *model)
{
	g_signal_connect (model, "notify::document",
			  G_CALLBACK (ev_sidebar_annotations_document_changed_cb),
			  sidebar_page);
}

static gboolean
ev_sidebar_annotations_support_document (EvSidebarPage *sidebar_page,
					 EvDocument    *document)
{
	return (EV_IS_DOCUMENT_ANNOTATIONS (document));
}

static const gchar *
ev_sidebar_annotations_get_label (EvSidebarPage *sidebar_page)
{
	return _("Annotations");
}

static void
ev_sidebar_annotations_page_iface_init (EvSidebarPageInterface *iface)
{
	iface->support_document = ev_sidebar_annotations_support_document;
	iface->set_model = ev_sidebar_annotations_set_model;
	iface->get_label = ev_sidebar_annotations_get_label;
}