src/hlink.c

   1 /* vim: set sw=8: -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2
   3 /*
   4  * hlink.c: hyperlink support
   5  *
   6  * Copyright (C) 2000-2005 Jody Goldberg (jody@gnome.org)
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License, or (at your option) version 3.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  21  * USA
  22  */
  23 #include <gnumeric-config.h>
  24 #include <glib/gi18n-lib.h>
  25 #include "gnumeric.h"
  26 #include "hlink.h"
  27 #include "hlink-impl.h"
  28 #include "command-context.h"
  29 #include "workbook-control.h"
  30 #include "workbook-view.h"
  31 #include "selection.h"
  32 #include "sheet.h"
  33 #include "sheet-view.h"
  34 #include "sheet-style.h"
  35 #include "ranges.h"
  36 #include "position.h"
  37 #include "expr-name.h"
  38 #include "expr.h"
  39 #include "value.h"
  40 #include "mstyle.h"
  41
  42 #include <goffice/goffice.h>
  43 #include <gsf/gsf-impl-utils.h>
  44
  45 #define GET_CLASS(instance) G_TYPE_INSTANCE_GET_CLASS (instance, GNM_HLINK_TYPE, GnmHLinkClass)
  46
  47 static GObjectClass *gnm_hlink_parent_class;
  48
  49 /*
  50  * WARNING WARNING WARNING
  51  *
  52  * The type names are used in the xml persistence DO NOT CHANGE THEM
  53  */
  54 /**
  55  * gnm_hlink_activate:
  56  * @lnk:
  57  * @wbcg: the wbcg that activated the link
  58  *
  59  * Returns: TRUE if the link successfully activated.
  60  **/
  61 gboolean
  62 gnm_hlink_activate (GnmHLink *lnk, WBCGtk *wbcg)
  63 {
  64         g_return_val_if_fail (GNM_IS_HLINK (lnk), FALSE);
  65
  66         return GET_CLASS (lnk)->Activate (lnk, wbcg);
  67 }
  68
  69 /**
  70  * gnm_sheet_hlink_find:
  71  * @sheet: #Sheet
  72  * @pos: #GcmCellPos
  73  *
  74  * Returns: (transfer none): the found #GnmHLink.
  75  **/
  76 GnmHLink *
  77 gnm_sheet_hlink_find (Sheet const *sheet, GnmCellPos const *pos)
  78 {
  79         GnmStyle const *style = sheet_style_get (sheet, pos->col, pos->row);
  80         return gnm_style_get_hlink (style);
  81 }
  82
  83 static void
  84 gnm_hlink_finalize (GObject *obj)
  85 {
  86         GnmHLink *lnk = (GnmHLink *)obj;
  87
  88         g_free (lnk->target);
  89         lnk->target = NULL;
  90
  91         g_free (lnk->tip);
  92         lnk->tip = NULL;
  93
  94         gnm_hlink_parent_class->finalize (obj);
  95 }
  96
  97 static void
  98 gnm_hlink_base_set_sheet (GnmHLink *lnk, Sheet *sheet)
  99 {
 100         lnk->sheet = sheet;
 101 }
 102
 103 static void
 104 gnm_hlink_base_set_target (GnmHLink *lnk, gchar const *target)
 105 {
 106         gchar *tmp = g_strdup (target);
 107         g_free (lnk->target);
 108         lnk->target = tmp;
 109 }
 110
 111 static const char *
 112 gnm_hlink_base_get_target (GnmHLink const *lnk)
 113 {
 114         return lnk->target;
 115 }
 116
 117 static void
 118 gnm_hlink_class_init (GObjectClass *object_class)
 119 {
 120         GnmHLinkClass *hlink_class = (GnmHLinkClass *)object_class;
 121
 122         gnm_hlink_parent_class = g_type_class_peek_parent (object_class);
 123
 124         object_class->finalize = gnm_hlink_finalize;
 125         hlink_class->set_sheet = gnm_hlink_base_set_sheet;
 126         hlink_class->set_target = gnm_hlink_base_set_target;
 127         hlink_class->get_target = gnm_hlink_base_get_target;
 128 }
 129
 130 static void
 131 gnm_hlink_init (GObject *obj)
 132 {
 133         GnmHLink *lnk = (GnmHLink * )obj;
 134         lnk->target = NULL;
 135         lnk->tip = NULL;
 136 }
 137
 138 GSF_CLASS_ABSTRACT (GnmHLink, gnm_hlink,
 139                     gnm_hlink_class_init, gnm_hlink_init, G_TYPE_OBJECT)
 140
 141 const char *
 142 gnm_hlink_get_target (GnmHLink const *lnk)
 143 {
 144         g_return_val_if_fail (GNM_IS_HLINK (lnk), NULL);
 145
 146         return GET_CLASS (lnk)->get_target (lnk);
 147 }
 148
 149 void
 150 gnm_hlink_set_target (GnmHLink *lnk, gchar const *target)
 151 {
 152         g_return_if_fail (GNM_IS_HLINK (lnk));
 153
 154         GET_CLASS (lnk)->set_target (lnk, target);
 155 }
 156
 157 const char *
 158 gnm_hlink_get_tip (GnmHLink const *lnk)
 159 {
 160         g_return_val_if_fail (GNM_IS_HLINK (lnk), NULL);
 161         return lnk->tip;
 162 }
 163
 164 void
 165 gnm_hlink_set_tip (GnmHLink *lnk, gchar const *tip)
 166 {
 167         gchar *tmp;
 168
 169         g_return_if_fail (GNM_IS_HLINK (lnk));
 170
 171         tmp = g_strdup (tip);
 172         g_free (lnk->tip);
 173         lnk->tip = tmp;
 174 }
 175
 176 /**
 177  * gnm_hlink_get_sheet:
 178  * @lnk: link
 179  *
 180  * Returns: (transfer none): the sheet
 181  */
 182 Sheet *
 183 gnm_hlink_get_sheet (GnmHLink *lnk)
 184 {
 185         g_return_val_if_fail (GNM_IS_HLINK (lnk), NULL);
 186         return lnk->sheet;
 187 }
 188
 189 void
 190 gnm_hlink_set_sheet (GnmHLink *lnk, Sheet *sheet)
 191 {
 192         g_return_if_fail (GNM_IS_HLINK (lnk));
 193         GET_CLASS (lnk)->set_sheet (lnk, sheet);
 194 }
 195
 196 GnmHLink *
 197 gnm_hlink_new (GType typ, Sheet *sheet)
 198 {
 199         GnmHLink *lnk;
 200
 201         g_return_val_if_fail (typ != 0, NULL);
 202         g_return_val_if_fail (g_type_is_a (typ, GNM_HLINK_TYPE), NULL);
 203         g_return_val_if_fail (!G_TYPE_IS_ABSTRACT (typ), NULL);
 204         g_return_val_if_fail (IS_SHEET (sheet), NULL);
 205
 206         lnk = g_object_new (typ, NULL);
 207         gnm_hlink_set_sheet (lnk, sheet);
 208         return lnk;
 209 }
 210
 211 /**
 212  * gnm_hlink_dup:
 213  * @lnk: Existing link
 214  *
 215  * Returns: (transfer full): A duplicate link.
 216  */
 217 GnmHLink *
 218 gnm_hlink_dup (GnmHLink *lnk)
 219 {
 220         GnmHLink *new_lnk = g_object_new (G_OBJECT_TYPE (lnk), NULL);
 221
 222         gnm_hlink_set_sheet (new_lnk, lnk->sheet);
 223         gnm_hlink_set_target (new_lnk, gnm_hlink_get_target (lnk));
 224         gnm_hlink_set_tip (new_lnk, lnk->tip);
 225
 226         return new_lnk;
 227 }
 228
 229 /**
 230  * gnm_hlink_equal:
 231  * @a: a #GnmHLink
 232  * @b: a #GnmHLink
 233  * @relax_sheet: if %TRUE, ignore differences solely caused by being linked into different sheets.
 234  *
 235  * Returns: %TRUE, if links are equal
 236  */
 237 gboolean
 238 gnm_hlink_equal (GnmHLink const *a, GnmHLink const *b, gboolean relax_sheet)
 239 {
 240         g_return_val_if_fail (GNM_IS_HLINK (a), FALSE);
 241         g_return_val_if_fail (GNM_IS_HLINK (b), FALSE);
 242
 243         if (a == b)
 244                 return TRUE;
 245
 246         if (!relax_sheet && a->sheet != b->sheet)
 247                 return FALSE;
 248
 249         return (g_strcmp0 (a->target, b->target) == 0 &&
 250                 g_strcmp0 (a->tip, b->tip) == 0);
 251 }
 252
 253 /***************************************************************************/
 254 /* Link to named regions within the current workbook */
 255 typedef struct { GnmHLinkClass hlink; } GnmHLinkCurWBClass;
 256 typedef struct {
 257         GnmHLink hlink;
 258
 259         GnmDependent dep;
 260 } GnmHLinkCurWB;
 261 #define GNM_HLINK_CUR_WB(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), gnm_hlink_cur_wb_get_type (), GnmHLinkCurWB))
 262
 263 #define GNM_IS_HLINK_CUR_WB(o)  (G_TYPE_CHECK_INSTANCE_TYPE ((o), gnm_hlink_cur_wb_get_type ()))
 264
 265
 266 static GObjectClass *gnm_hlink_cur_wb_parent_class;
 267
 268 static gboolean
 269 gnm_hlink_cur_wb_activate (GnmHLink *lnk, WBCGtk *wbcg)
 270 {
 271         WorkbookControl *wbc = GNM_WBC (wbcg);
 272         SheetView *sv;
 273         GnmSheetRange sr;
 274
 275         if (!gnm_hlink_get_range_target (lnk, &sr)) {
 276                 go_cmd_context_error_invalid
 277                         (GO_CMD_CONTEXT (wbcg),
 278                          _("Link target"),
 279                          lnk->target ? lnk->target : "-");
 280                 return FALSE;
 281         }
 282
 283         sv = sheet_get_view (sr.sheet,  wb_control_view (wbc));
 284         sv_selection_set (sv, &sr.range.start,
 285                           sr.range.start.col, sr.range.start.row,
 286                           sr.range.end.col, sr.range.end.row);
 287         gnm_sheet_view_make_cell_visible (sv, sr.range.start.col, sr.range.start.row, FALSE);
 288         if (wbcg_cur_sheet (wbcg) != sr.sheet)
 289                 wb_view_sheet_focus (wb_control_view (wbc), sr.sheet);
 290
 291         return TRUE;
 292 }
 293
 294 static void
 295 gnm_hlink_cur_wb_set_sheet (GnmHLink *lnk, Sheet *sheet)
 296 {
 297         GnmHLinkCurWB *hlcwb = (GnmHLinkCurWB *)lnk;
 298         ((GnmHLinkClass*)gnm_hlink_cur_wb_parent_class)
 299                 ->set_sheet (lnk, sheet);
 300         dependent_managed_set_sheet (&hlcwb->dep, sheet);
 301 }
 302
 303 static void
 304 gnm_hlink_cur_wb_set_target (GnmHLink *lnk, const char *target)
 305 {
 306         GnmHLinkCurWB *hlcwb = (GnmHLinkCurWB *)lnk;
 307         GnmExprTop const *texpr = NULL;
 308
 309         ((GnmHLinkClass*)gnm_hlink_cur_wb_parent_class)
 310                 ->set_target (lnk, NULL);
 311
 312         if (target && lnk->sheet) {
 313                 GnmParsePos pp;
 314                 GnmExprParseFlags flags = GNM_EXPR_PARSE_UNKNOWN_NAMES_ARE_INVALID;
 315                 GnmConventions const *convs = lnk->sheet->convs;
 316
 317                 parse_pos_init_sheet (&pp, lnk->sheet);
 318                 texpr = gnm_expr_parse_str (target, &pp, flags, convs, NULL);
 319
 320                 if (texpr == NULL || gnm_expr_top_is_err (texpr, GNM_ERROR_REF)) {
 321                         // Nothing, error
 322                 } else if (gnm_expr_get_name (texpr->expr)) {
 323                         // Nothing, we're good
 324                 } else {
 325                         // Allow only ranges and normalize
 326                         GnmValue *v = gnm_expr_top_get_range (texpr);
 327                         gnm_expr_top_unref (texpr);
 328                         texpr = v ? gnm_expr_top_new_constant (v) : NULL;
 329                 }
 330         }
 331
 332         dependent_managed_set_expr (&hlcwb->dep, texpr);
 333         if (texpr)
 334                 gnm_expr_top_unref (texpr);
 335 }
 336
 337 static const char *
 338 gnm_hlink_cur_wb_get_target (GnmHLink const *lnk)
 339 {
 340         GnmHLinkCurWB *hlcwb = (GnmHLinkCurWB *)lnk;
 341         GnmExprTop const *texpr = hlcwb->dep.texpr;
 342         char *tgt = NULL;
 343         Sheet *sheet = lnk->sheet;
 344
 345         if (texpr && sheet) {
 346                 GnmConventions const *convs = sheet_get_conventions (sheet);
 347                 GnmParsePos pp;
 348                 parse_pos_init_sheet (&pp, sheet);
 349                 tgt = gnm_expr_top_as_string (texpr, &pp, convs);
 350         }
 351
 352         // Use parent class for storage.  Ick!
 353         ((GnmHLinkClass*)gnm_hlink_cur_wb_parent_class)
 354                 ->set_target ((GnmHLink *)lnk, tgt);
 355         g_free (tgt);
 356
 357         return ((GnmHLinkClass*)gnm_hlink_cur_wb_parent_class)
 358                 ->get_target (lnk);
 359 }
 360
 361 static void
 362 gnm_hlink_cur_wb_init (GObject *obj)
 363 {
 364         GnmHLinkCurWB *hlcwb = (GnmHLinkCurWB *)obj;
 365         dependent_managed_init (&hlcwb->dep, NULL);
 366 }
 367
 368 static void
 369 gnm_hlink_cur_wb_finalize (GObject *obj)
 370 {
 371         GnmHLinkCurWB *hlcwb = (GnmHLinkCurWB *)obj;
 372
 373         dependent_managed_set_expr (&hlcwb->dep, NULL);
 374
 375         gnm_hlink_cur_wb_parent_class->finalize (obj);
 376 }
 377
 378 static void
 379 gnm_hlink_cur_wb_class_init (GObjectClass *object_class)
 380 {
 381         GnmHLinkClass *hlink_class = (GnmHLinkClass *) object_class;
 382
 383         gnm_hlink_cur_wb_parent_class = g_type_class_peek_parent (object_class);
 384
 385         object_class->finalize = gnm_hlink_cur_wb_finalize;
 386         hlink_class->Activate = gnm_hlink_cur_wb_activate;
 387         hlink_class->set_sheet = gnm_hlink_cur_wb_set_sheet;
 388         hlink_class->set_target = gnm_hlink_cur_wb_set_target;
 389         hlink_class->get_target = gnm_hlink_cur_wb_get_target;
 390 }
 391
 392 GSF_CLASS (GnmHLinkCurWB, gnm_hlink_cur_wb,
 393            gnm_hlink_cur_wb_class_init, gnm_hlink_cur_wb_init,
 394            GNM_HLINK_TYPE)
 395 #if 0
 396 ;
 397 #endif
 398
 399
 400 /**
 401  * gnm_hlink_get_range_target:
 402  * @lnk: the hyperlink to query
 403  * @sr: location to start link target range
 404  *
 405  * This function determines the location that a link points to.  It will
 406  * resolve names.
 407  *
 408  * Returns: %TRUE, if the link refers to a range.
 409  */
 410 gboolean
 411 gnm_hlink_get_range_target (GnmHLink const *lnk, GnmSheetRange *sr)
 412 {
 413         GnmHLinkCurWB *hlcwb;
 414         GnmExprTop const *texpr;
 415         GnmValue *vr;
 416         GnmRangeRef const *r;
 417         GnmParsePos pp;
 418         Sheet *start_sheet, *end_sheet;
 419
 420         g_return_val_if_fail (GNM_IS_HLINK (lnk), FALSE);
 421
 422         if (!GNM_IS_HLINK_CUR_WB (lnk))
 423                 return FALSE;
 424
 425         hlcwb = (GnmHLinkCurWB *)lnk;
 426         texpr = hlcwb->dep.texpr;
 427         if (!texpr)
 428                 return FALSE;
 429         vr = gnm_expr_top_get_range (texpr);
 430         if (!vr)
 431                 return FALSE;
 432         r = value_get_rangeref (vr);
 433
 434         parse_pos_init_sheet (&pp, lnk->sheet);
 435         gnm_rangeref_normalize_pp (r, &pp, &start_sheet, &end_sheet,
 436                                    &sr->range);
 437         sr->sheet = start_sheet;
 438         value_release (vr);
 439
 440         return TRUE;
 441 }
 442
 443
 444 GnmExprTop const *
 445 gnm_hlink_get_target_expr (GnmHLink const *lnk)
 446 {
 447
 448         GnmHLinkCurWB *hlcwb;
 449
 450         g_return_val_if_fail (GNM_IS_HLINK (lnk), NULL);
 451
 452         if (!GNM_IS_HLINK_CUR_WB (lnk))
 453                 return NULL;
 454
 455         hlcwb = (GnmHLinkCurWB *)lnk;
 456         return hlcwb->dep.texpr;
 457 }
 458
 459
 460
 461 /***************************************************************************/
 462 /* Link to arbitrary urls */
 463 typedef struct { GnmHLinkClass hlink; } GnmHLinkURLClass;
 464 typedef struct {
 465         GnmHLink hlink;
 466 } GnmHLinkURL;
 467
 468 static gboolean
 469 gnm_hlink_url_activate (GnmHLink *lnk, WBCGtk *wbcg)
 470 {
 471         GError *err = NULL;
 472         GdkScreen *screen;
 473
 474         if (lnk->target == NULL)
 475                 return FALSE;
 476
 477         screen = gtk_window_get_screen (wbcg_toplevel (wbcg));
 478         err = go_gtk_url_show (lnk->target, screen);
 479
 480         if (err != NULL) {
 481                 char *msg = g_strdup_printf (_("Unable to activate the url '%s'"), lnk->target);
 482                 go_cmd_context_error_invalid (GO_CMD_CONTEXT (wbcg),
 483                                               msg, err->message);
 484                 g_free (msg);
 485                 g_error_free (err);
 486         }
 487
 488         return err == NULL;
 489 }
 490
 491 static void
 492 gnm_hlink_url_class_init (GObjectClass *object_class)
 493 {
 494         GnmHLinkClass *hlink_class = (GnmHLinkClass *) object_class;
 495
 496         hlink_class->Activate  = gnm_hlink_url_activate;
 497 }
 498
 499 GSF_CLASS (GnmHLinkURL, gnm_hlink_url,
 500            gnm_hlink_url_class_init, NULL,
 501            GNM_HLINK_TYPE)
 502
 503 /***************************************************************************/
 504 /* email is just a url, but it is cleaner to stick it in a distinct type   */
 505 typedef struct { GnmHLinkURLClass hlink; } GnmHLinkEMailClass;
 506 typedef struct {
 507         GnmHLinkURL hlink;
 508 } GnmHLinkEMail;
 509
 510 GSF_CLASS (GnmHLinkEMail, gnm_hlink_email,
 511            NULL, NULL,
 512            gnm_hlink_url_get_type ())
 513
 514 /***************************************************************************/
 515 /* Link to arbitrary urls */
 516 typedef struct { GnmHLinkClass hlink; } GnmHLinkExternalClass;
 517 typedef struct {
 518         GnmHLink hlink;
 519 } GnmHLinkExternal;
 520
 521 static gboolean
 522 gnm_hlink_external_activate (GnmHLink *lnk, WBCGtk *wbcg)
 523 {
 524         GError *err = NULL;
 525         gboolean res = FALSE;
 526         char *cmd;
 527         GdkScreen *screen;
 528
 529         if (lnk->target == NULL)
 530                 return FALSE;
 531
 532         cmd = go_shell_arg_to_uri (lnk->target);
 533         screen = gtk_window_get_screen (wbcg_toplevel (wbcg));
 534         err = go_gtk_url_show (cmd, screen);
 535         g_free (cmd);
 536
 537         if (err != NULL) {
 538                 char *msg = g_strdup_printf(_("Unable to open '%s'"), lnk->target);
 539                 go_cmd_context_error_invalid (GO_CMD_CONTEXT (wbcg),
 540                                               msg, err->message);
 541                 g_free (msg);
 542                 g_error_free (err);
 543         }
 544
 545         return res;
 546 }
 547
 548 static void
 549 gnm_hlink_external_class_init (GObjectClass *object_class)
 550 {
 551         GnmHLinkClass *hlink_class = (GnmHLinkClass *) object_class;
 552
 553         hlink_class->Activate  = gnm_hlink_external_activate;
 554 }
 555
 556 GSF_CLASS (GnmHLinkExternal, gnm_hlink_external,
 557            gnm_hlink_external_class_init, NULL,
 558            GNM_HLINK_TYPE)
 559
 560 /**
 561  * _gnm_hlink_init: (skip)
 562  */
 563 void
 564 _gnm_hlink_init (void)
 565 {
 566         /* make sure that all hlink types are registered */
 567         gnm_hlink_cur_wb_get_type ();
 568         gnm_hlink_url_get_type ();
 569         gnm_hlink_email_get_type ();
 570         gnm_hlink_external_get_type ();
 571 }