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