Rework links system, it adds support for remote links now and it makes

2006-05-02  Carlos Garcia Campos  <carlosgc@gnome.org>
	* backend/Makefile.am:
	* backend/ev-document-links.[ch]:
	* backend/ev-document.[ch]:
	* backend/ev-link-action.[ch]:
	* backend/ev-link-dest.[ch]:
	* backend/ev-link.[ch]:
	* pdf/ev-poppler.cc: (pdf_document_find_link_dest),
	(ev_link_dest_from_dest), (ev_link_from_action), (build_tree):
	* shell/ev-page-action.c: (build_new_tree_cb):
	* shell/ev-sidebar-links.c: (get_page_from_dest), (print_section_cb),
	(links_page_num_func), (update_page_callback):
	* shell/ev-view.[ch]: (ev_view_goto_dest), (ev_view_handle_link),
	(tip_from_link):
	* shell/ev-jobs.c:
	* shell/ev-window.[ch]: (ev_window_open_uri),
	(sidebar_links_link_activated_cb), (ev_view_popup_cmd_open_link):
	* shell/ev-application.[ch]: (ev_application_open_window),
	(ev_application_open_uri):
	Rework links system, it adds support for remote links now and it makes
	easier to add new kinds of actions and destinations. Fixes bug #317292

1 files changed, 319 insertions, 0 deletions

diff --git a/backend/ev-link-action.c b/backend/ev-link-action.c
new file mode 100644
index 0000000..23f4194
--- /dev/null
+++ b/backend/ev-link-action.c
@@ -0,0 +1,319 @@
+/* this file is part of evince, a gnome document viewer
+ *
+ *  Copyright (C) 2006 Carlos Garcia Campos <carlosgc@gnome.org>
+ *  Copyright (C) 2005 Red Hat, Inc.
+ *
+ * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+#include "ev-link-action.h"
+
+enum {
+	PROP_0,
+	PROP_TYPE,
+	PROP_DEST,
+	PROP_URI,
+	PROP_FILENAME,
+	PROP_PARAMS
+};
+
+struct _EvLinkAction {
+	GObject base_instance;
+
+	EvLinkActionPrivate *priv;
+};
+
+struct _EvLinkActionClass {
+	GObjectClass base_class;
+};
+
+struct _EvLinkActionPrivate {
+	EvLinkActionType  type;
+	EvLinkDest       *dest;
+	gchar            *uri;
+	gchar            *filename;
+	gchar            *params;
+};
+
+G_DEFINE_TYPE (EvLinkAction, ev_link_action, G_TYPE_OBJECT)
+
+#define EV_LINK_ACTION_GET_PRIVATE(object) \
+        (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_LINK_ACTION, EvLinkActionPrivate))
+
+GType
+ev_link_action_type_get_type (void)
+{
+	static GType type = 0;
+
+	if (G_UNLIKELY (type == 0)) {
+		static const GEnumValue values[] = {
+			{ EV_LINK_ACTION_TYPE_GOTO_DEST, "EV_LINK_ACTION_TYPE_GOTO_DEST", "goto-dest" },
+			{ EV_LINK_ACTION_TYPE_GOTO_REMOTE, "EV_LINK_ACTION_TYPE_GOTO_REMOTE", "goto-remote" },
+			{ EV_LINK_ACTION_TYPE_LAUNCH, "EV_LINK_ACTION_TYPE_LAUNCH", "launch" },
+			{ EV_LINK_ACTION_TYPE_EXTERNAL_URI, "EV_LINK_ACTION_TYPE_EXTERNAL_URI", "external-uri"},
+			{ 0, NULL, NULL }
+		};
+
+		type = g_enum_register_static ("EvLinkActionType", values);
+	}
+
+	return type;
+}
+
+EvLinkActionType
+ev_link_action_get_action_type (EvLinkAction *self)
+{
+	g_return_val_if_fail (EV_IS_LINK_ACTION (self), 0);
+
+	return self->priv->type;
+}
+
+EvLinkDest *
+ev_link_action_get_dest (EvLinkAction *self)
+{
+	g_return_val_if_fail (EV_IS_LINK_ACTION (self), NULL);
+
+	return self->priv->dest;
+}
+
+const gchar *
+ev_link_action_get_uri (EvLinkAction *self)
+{
+	g_return_val_if_fail (EV_IS_LINK_ACTION (self), NULL);
+
+	return self->priv->uri;
+}
+
+const gchar *
+ev_link_action_get_filename (EvLinkAction *self)
+{
+	g_return_val_if_fail (EV_IS_LINK_ACTION (self), NULL);
+
+	return self->priv->filename;
+}
+
+const gchar *
+ev_link_action_get_params (EvLinkAction *self)
+{
+	g_return_val_if_fail (EV_IS_LINK_ACTION (self), NULL);
+
+	return self->priv->params;
+}
+
+static void
+ev_link_action_get_property (GObject    *object,
+			     guint       prop_id,
+			     GValue     *value,
+			     GParamSpec *param_spec)
+{
+	EvLinkAction *self;
+
+	self = EV_LINK_ACTION (object);
+
+	switch (prop_id) {
+	        case PROP_TYPE:
+		        g_value_set_enum (value, self->priv->type);
+		        break;
+	        case PROP_DEST:
+		        g_value_set_pointer (value, self->priv->dest);
+			break;
+	        case PROP_URI:
+			g_value_set_string (value, self->priv->uri);
+			break;
+	        case PROP_FILENAME:
+			g_value_set_string (value, self->priv->filename);
+			break;
+	        case PROP_PARAMS:
+			g_value_set_string (value, self->priv->params);
+			break;
+	        default:
+			G_OBJECT_WARN_INVALID_PROPERTY_ID (object,
+							   prop_id,
+							   param_spec);
+			break;
+	}
+}
+
+static void
+ev_link_action_set_property (GObject      *object,
+			     guint         prop_id,
+			     const GValue *value,
+			     GParamSpec   *param_spec)
+{
+	EvLinkAction *self = EV_LINK_ACTION (object);
+
+	switch (prop_id) {
+	        case PROP_TYPE:
+			self->priv->type = g_value_get_enum (value);
+			break;
+	        case PROP_DEST:
+			self->priv->dest = g_value_get_pointer (value);
+			break;
+	        case PROP_URI:
+			g_free (self->priv->uri);
+			self->priv->uri = g_value_dup_string (value);
+			break;
+	        case PROP_FILENAME:
+			g_free (self->priv->filename);
+			self->priv->filename = g_value_dup_string (value);
+			break;
+	        case PROP_PARAMS:
+			g_free (self->priv->params);
+			self->priv->params = g_value_dup_string (value);
+			break;
+	        default:
+			G_OBJECT_WARN_INVALID_PROPERTY_ID (object,
+							   prop_id,
+							   param_spec);
+			break;
+	}
+}
+
+static void
+ev_link_action_finalize (GObject *object)
+{
+	EvLinkActionPrivate *priv;
+
+	priv = EV_LINK_ACTION (object)->priv;
+
+	if (priv->dest) {
+		g_object_unref (priv->dest);
+		priv->dest = NULL;
+	}
+
+	if (priv->uri) {
+		g_free (priv->uri);
+		priv->uri = NULL;
+	}
+
+	if (priv->filename) {
+		g_free (priv->filename);
+		priv->filename = NULL;
+	}
+
+	if (priv->params) {
+		g_free (priv->params);
+		priv->params = NULL;
+	}
+
+	G_OBJECT_CLASS (ev_link_action_parent_class)->finalize (object);
+}
+
+static void
+ev_link_action_init (EvLinkAction *ev_link_action)
+{
+	ev_link_action->priv = EV_LINK_ACTION_GET_PRIVATE (ev_link_action);
+
+	ev_link_action->priv->dest = NULL;
+	ev_link_action->priv->uri = NULL;
+	ev_link_action->priv->filename = NULL;
+	ev_link_action->priv->params = NULL;
+}
+
+static void
+ev_link_action_class_init (EvLinkActionClass *ev_link_action_class)
+{
+	GObjectClass *g_object_class;
+
+	g_object_class = G_OBJECT_CLASS (ev_link_action_class);
+
+	g_object_class->set_property = ev_link_action_set_property;
+	g_object_class->get_property = ev_link_action_get_property;
+
+	g_object_class->finalize = ev_link_action_finalize;
+
+	g_type_class_add_private (g_object_class, sizeof (EvLinkActionPrivate));
+
+	g_object_class_install_property (g_object_class,
+					 PROP_TYPE,
+					 g_param_spec_enum  ("type",
+							     "Action Type",
+							     "The link action type",
+							     EV_TYPE_LINK_ACTION_TYPE,
+							     EV_LINK_ACTION_TYPE_GOTO_DEST,
+							     G_PARAM_READWRITE |
+							     G_PARAM_CONSTRUCT_ONLY));
+	g_object_class_install_property (g_object_class,
+					 PROP_DEST,
+					 g_param_spec_pointer ("dest",
+							       "Action destination",
+							       "The link action destination",
+							       G_PARAM_READWRITE |
+							       G_PARAM_CONSTRUCT_ONLY));
+	g_object_class_install_property (g_object_class,
+					 PROP_URI,
+					 g_param_spec_string ("uri",
+							      "Link Action URI",
+							      "The link action URI",
+							      NULL,
+							      G_PARAM_READWRITE |
+							      G_PARAM_CONSTRUCT_ONLY));
+	g_object_class_install_property (g_object_class,
+					 PROP_FILENAME,
+					 g_param_spec_string ("filename",
+							      "Filename",
+							      "The link action filename",
+							      NULL,
+							      G_PARAM_READWRITE |
+							      G_PARAM_CONSTRUCT_ONLY));
+	g_object_class_install_property (g_object_class,
+					 PROP_PARAMS,
+					 g_param_spec_string ("params",
+							      "Params",
+							      "The link action params",
+							      NULL,
+							      G_PARAM_READWRITE |
+							      G_PARAM_CONSTRUCT_ONLY));
+}
+
+EvLinkAction *
+ev_link_action_new_dest (EvLinkDest *dest)
+{
+	return EV_LINK_ACTION (g_object_new (EV_TYPE_LINK_ACTION,
+					     "dest", dest,
+					     "type", EV_LINK_ACTION_TYPE_GOTO_DEST,
+					     NULL));
+}
+
+EvLinkAction *
+ev_link_action_new_remote (EvLinkDest  *dest,
+			   const gchar *filename)
+{
+	return EV_LINK_ACTION (g_object_new (EV_TYPE_LINK_ACTION,
+					     "dest", dest,
+					     "filename", filename,
+					     "type", EV_LINK_ACTION_TYPE_GOTO_REMOTE,
+					     NULL));
+}
+
+EvLinkAction *
+ev_link_action_new_external_uri (const gchar *uri)
+{
+	return EV_LINK_ACTION (g_object_new (EV_TYPE_LINK_ACTION,
+					     "uri", uri,
+					     "type", EV_LINK_ACTION_TYPE_EXTERNAL_URI,
+					     NULL));
+}
+
+EvLinkAction *
+ev_link_action_new_launch (const gchar *filename,
+			   const gchar *params)
+{
+	return EV_LINK_ACTION (g_object_new (EV_TYPE_LINK_ACTION,
+					     "filename", filename,
+					     "params", params,
+					     "type", EV_LINK_ACTION_TYPE_LAUNCH,
+					     NULL));
+}