src/clipboard.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  * Copyright (C) 2005, Alex Foobarian <foobarian@gmail.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <string.h>
  28 #include <stdlib.h>
  29 #ifdef HAVE_SYS_TYPES_H
  30 #include <sys/types.h>
  31 #endif
  32 #ifdef HAVE_UNISTD_H
  33 #include <unistd.h>
  34 #endif
  35
  36 #include <glib/gi18n.h>
  37
  38 #include "viking.h"
  39
  40
  41 typedef struct {
  42   gpointer clipboard;
  43   gint pid;
  44   VikClipboardDataType type;
  45   gint subtype;
  46   guint16 layer_type;
  47   guint len;
  48   gchar *text;
  49   guint8 data[0];
  50 } vik_clipboard_t;
  51
  52 static GtkTargetEntry target_table[] = {
  53   { "application/viking", 0, 0 },
  54   { "STRING", 0, 1 },
  55 };
  56
  57 /*****************************************************************
  58  ** functions which send to the clipboard client (we are owner) **
  59  *****************************************************************/
  60
  61 static void clip_get ( GtkClipboard *c, GtkSelectionData *selection_data, guint info, gpointer p )
  62 {
  63   vik_clipboard_t *vc = p;
  64   if ( info == 0 ) {
  65     // Viking Data Type
  66     //    g_print("clip_get: vc = %p, size = %d\n", vc, sizeof(*vc) + vc->len);
  67     gtk_selection_data_set ( selection_data, gtk_selection_data_get_target(selection_data), 8, (void *)vc, sizeof(*vc) + vc->len );
  68   }
  69   if ( info == 1 ) {
  70     // Should be a string, but make sure it's something
  71     if ( vc->text )
  72       gtk_selection_data_set_text ( selection_data, vc->text, -1); // string text is null terminated
  73   }
  74
  75 }
  76
  77 static void clip_clear ( GtkClipboard *c, gpointer p )
  78 {
  79   vik_clipboard_t* vc = (vik_clipboard_t*)p;
  80   g_free(vc->text);
  81   g_free(vc);
  82 }
  83
  84
  85 /**************************************************************************
  86  ** functions which receive from the clipboard owner (we are the client) **
  87  **************************************************************************/
  88
  89 /* our own data type */
  90 static void clip_receive_viking ( GtkClipboard *c, GtkSelectionData *sd, gpointer p )
  91 {
  92   VikLayersPanel *vlp = p;
  93   vik_clipboard_t *vc;
  94   if (gtk_selection_data_get_length(sd) == -1) {
  95     g_warning ( _("paste failed") );
  96     return;
  97   }
  98   //  g_print("clip receive: target = %s, type = %s\n", gdk_atom_name(gtk_selection_data_get_target(sd), gdk_atom_name(sd->type));
  99   //g_assert(!strcmp(gdk_atom_name(gtk_selection_data_get_target(sd)), target_table[0].target));
 100
 101   vc = (vik_clipboard_t *)gtk_selection_data_get_data(sd);
 102   //  g_print("  sd->data = %p, sd->length = %d, vc->len = %d\n", sd->data, sd->length, vc->len);
 103
 104   if (gtk_selection_data_get_length(sd) != sizeof(*vc) + vc->len) {
 105     g_warning ( _("wrong clipboard data size") );
 106     return;
 107   }
 108
 109   if ( vc->type == VIK_CLIPBOARD_DATA_LAYER )
 110   {
 111     VikLayer *new_layer = vik_layer_unmarshall ( vc->data, vc->len, vik_layers_panel_get_viewport(vlp) );
 112     vik_layers_panel_add_layer ( vlp, new_layer );
 113   }
 114   else if ( vc->type == VIK_CLIPBOARD_DATA_SUBLAYER )
 115   {
 116     VikLayer *sel = vik_layers_panel_get_selected ( vlp );
 117     if ( sel && sel->type == vc->layer_type)
 118     {
 119       if ( vik_layer_get_interface(vc->layer_type)->paste_item )
 120         vik_layer_get_interface(vc->layer_type)->paste_item ( sel, vc->subtype, vc->data, vc->len);
 121     }
 122     else
 123       a_dialog_error_msg_extra ( VIK_GTK_WINDOW_FROM_WIDGET(GTK_WIDGET(vlp)),
 124                                  _("The clipboard contains sublayer data for %s layers. "
 125                                    "You must select a layer of this type to paste the clipboard data."),
 126                                  vik_layer_get_interface(vc->layer_type)->name );
 127   }
 128 }
 129
 130
 131
 132 /**
 133  * clip_parse_latlon:
 134  * @text: text containing LatLon data.
 135  * @coord: computed coordinates.
 136  *
 137  * Utility func to handle pasted text:
 138  * search for N dd.dddddd W dd.dddddd, N dd° dd.dddd W dd° dd.ddddd and so forth.
 139  *
 140  * Returns: TRUE if coordinates are set.
 141  */
 142 static gboolean clip_parse_latlon ( const gchar *text, struct LatLon *coord )
 143 {
 144   gint latdeg, londeg;
 145   gdouble latm, lonm;
 146   gdouble lat, lon;
 147   gchar *cand;
 148   gint len, i;
 149   gchar *s = g_strdup(text);
 150
 151   //  g_print("parsing %s\n", s);
 152
 153   len = strlen(s);
 154
 155   /* remove non-digits following digits; gets rid of degree symbols or whatever people use, and
 156    * punctuation
 157    */
 158   for (i=0; i<len-2; i++) {
 159     if (g_ascii_isdigit (s[i]) && s[i+1] != '.' && !g_ascii_isdigit (s[i+1])) {
 160       s[i+1] = ' ';
 161       if (!g_ascii_isalnum (s[i+2]) && s[i+2] != '-') {
 162         s[i+2] = ' ';
 163       }
 164     }
 165   }
 166
 167   /* now try reading coordinates */
 168   for (i=0; i<len; i++) {
 169     if (s[i] == 'N' || s[i] == 'S' || g_ascii_isdigit (s[i])) {
 170       gchar latc[2] = "SN";
 171       gchar lonc[2] = "WE";
 172       gint j, k;
 173       cand = s+i;
 174
 175       for (j=0; j<2; j++) {
 176         for (k=0; k<2; k++) {
 177           gchar fmt1[] = "N %d%*[ ]%lf W %d%*[ ]%lf";
 178           gchar fmt2[] = "%d%*[ ]%lf N %d%*[ ]%lf W";
 179           gchar fmt3[] = "N %lf W %lf";
 180           gchar fmt4[] = "%lf N %lf W";
 181
 182           fmt1[0]  = latc[j];     fmt1[13] = lonc[k];
 183           fmt2[11] = latc[j];     fmt2[24] = lonc[k];
 184           fmt3[0]  = latc[j];     fmt3[6]  = lonc[k];
 185           fmt4[4]  = latc[j];     fmt4[10] = lonc[k];
 186
 187           if (sscanf(cand, fmt1, &latdeg, &latm, &londeg, &lonm) == 4 ||
 188               sscanf(cand, fmt2, &latdeg, &latm, &londeg, &lonm) == 4) {
 189             lat = (j*2-1) * (latdeg + latm / 60);
 190             lon = (k*2-1) * (londeg + lonm / 60);
 191             break;
 192           }
 193           if (sscanf(cand, fmt3, &lat, &lon) == 2 ||
 194               sscanf(cand, fmt4, &lat, &lon) == 2) {
 195             lat *= (j*2-1);
 196             lon *= (k*2-1);
 197             break;
 198           }
 199         }
 200         if (k!=2) break;
 201       }
 202       if (j!=2) break;
 203
 204       if (sscanf(cand, "%d%*[ ]%lf %d%*[ ]%lf", &latdeg, &latm, &londeg, &lonm) == 4) {
 205         lat = latdeg/abs(latdeg) * (abs(latdeg) + latm / 60);
 206         lon = londeg/abs(londeg) * (abs(londeg) + lonm / 60);
 207         break;
 208       }
 209       if (sscanf(cand, "%lf %lf", &lat, &lon) == 2) {
 210         break;
 211       }
 212     }
 213   }
 214   g_free(s);
 215
 216   /* did we get to the end without actually finding a coordinate? */
 217   if (i<len && lat >= -90.0 && lat <= 90.0 && lon >= -180.0 && lon <= 180.0) {
 218     coord->lat = lat;
 219     coord->lon = lon;
 220     return TRUE;
 221   }
 222   return FALSE;
 223 }
 224
 225 static void clip_add_wp(VikLayersPanel *vlp, struct LatLon *coord)
 226 {
 227   VikCoord vc;
 228   VikLayer *sel = vik_layers_panel_get_selected ( vlp );
 229
 230
 231   vik_coord_load_from_latlon ( &vc, VIK_COORD_LATLON, coord );
 232
 233   if (sel && sel->type == VIK_LAYER_TRW) {
 234     vik_trw_layer_new_waypoint ( VIK_TRW_LAYER(sel), VIK_GTK_WINDOW_FROM_LAYER(sel), &vc );
 235   } else {
 236     a_dialog_error_msg_extra ( VIK_GTK_WINDOW_FROM_WIDGET(GTK_WIDGET(vlp)), _("In order to paste a waypoint, please select an appropriate layer to paste into."), NULL);
 237   }
 238 }
 239
 240 static void clip_receive_text (GtkClipboard *c, const gchar *text, gpointer p)
 241 {
 242   VikLayersPanel *vlp = p;
 243
 244   g_debug ( "got text: %s", text );
 245
 246   VikLayer *sel = vik_layers_panel_get_selected ( vlp );
 247   if ( sel && vik_treeview_get_editing ( sel->vt ) ) {
 248     GtkTreeIter iter;
 249     if ( vik_treeview_get_selected_iter ( sel->vt, &iter ) ) {
 250       // Try to sanitize input:
 251       gchar *name = g_strescape ( text, NULL );
 252       vik_layer_rename ( sel, name );
 253       vik_treeview_item_set_name ( sel->vt, &iter, name );
 254       g_free ( name );
 255     }
 256     return;
 257   }
 258
 259   struct LatLon coord;
 260   if (clip_parse_latlon(text, &coord)) {
 261     clip_add_wp(vlp, &coord);
 262   }
 263 }
 264
 265 static void clip_receive_html ( GtkClipboard *c, GtkSelectionData *sd, gpointer p )
 266 {
 267   VikLayersPanel *vlp = p;
 268   gsize r, w;
 269   GError *err = NULL;
 270   gchar *s, *span;
 271   gint tag = 0, i;
 272   struct LatLon coord;
 273
 274   if (gtk_selection_data_get_length(sd) == -1) {
 275     return;
 276   }
 277
 278   /* - copying from Mozilla seems to give html in UTF-16. */
 279   if (!(s =  g_convert ( (gchar *)gtk_selection_data_get_data(sd), gtk_selection_data_get_length(sd), "UTF-8", "UTF-16", &r, &w, &err))) {
 280     return;
 281   }
 282   //  g_print("html is %d bytes long: %s\n", gtk_selection_data_get_length(sd), s);
 283
 284   /* scrape a coordinate pasted from a geocaching.com page: look for a
 285    * telltale tag if possible, and then remove tags
 286    */
 287   if (!(span = g_strstr_len(s, w, "<span id=\"LatLon\">"))) {
 288     span = s;
 289   }
 290   for (i=0; i<strlen(span); i++) {
 291     gchar ch = span[i];
 292     if (ch == '<') {
 293       tag++;
 294     }
 295     if (tag>0) {
 296       span[i] = ' ';
 297     }
 298     if (ch == '>') {
 299       if (tag>0) tag--;
 300     }
 301   }
 302   if (clip_parse_latlon(span, &coord)) {
 303     clip_add_wp(vlp, &coord);
 304   }
 305
 306   g_free(s);
 307 }
 308
 309 /**
 310  * clip_receive_targets:
 311  *
 312  * Deal with various data types a clipboard may hold.
 313  */
 314 void clip_receive_targets ( GtkClipboard *c, GdkAtom *a, gint n, gpointer p )
 315 {
 316   VikLayersPanel *vlp = p;
 317   gint i;
 318
 319   for (i=0; i<n; i++) {
 320     gchar* name = gdk_atom_name(a[i]);
 321     //g_print("  ""%s""\n", name);
 322     gboolean breaktime = FALSE;
 323     if (!g_strcmp0(name, "text/html")) {
 324       gtk_clipboard_request_contents ( c, gdk_atom_intern("text/html", TRUE), clip_receive_html, vlp );
 325       breaktime = TRUE;
 326     }
 327     if (a[i] == GDK_TARGET_STRING) {
 328       gtk_clipboard_request_text ( c, clip_receive_text, vlp );
 329       breaktime = TRUE;
 330     }
 331     if (!g_strcmp0(name, "application/viking")) {
 332       gtk_clipboard_request_contents ( c, gdk_atom_intern("application/viking", TRUE), clip_receive_viking, vlp );
 333       breaktime = TRUE;
 334     }
 335
 336     g_free ( name );
 337
 338     if ( breaktime )
 339       break;
 340   }
 341 }
 342
 343 /*********************************************************************************
 344  ** public functions                                                            **
 345  *********************************************************************************/
 346
 347 /**
 348  * a_clipboard_copy_selected:
 349  *
 350  * Make a copy of selected object and associate ourselves with the clipboard.
 351  */
 352 void a_clipboard_copy_selected ( VikLayersPanel *vlp )
 353 {
 354   VikLayer *sel = vik_layers_panel_get_selected ( vlp );
 355   GtkTreeIter iter;
 356   VikClipboardDataType type = VIK_CLIPBOARD_DATA_NONE;
 357   guint16 layer_type = 0;
 358   gint subtype = 0;
 359   guint8 *data = NULL;
 360   guint len = 0;
 361   const gchar *name = NULL;
 362
 363   if ( ! sel )
 364     return;
 365
 366   vik_treeview_get_selected_iter ( sel->vt, &iter );
 367   layer_type = sel->type;
 368
 369   // Since we intercept copy and paste keyboard operations, this is called even when a cell is being edited
 370   if ( vik_treeview_get_editing ( sel->vt ) ) {
 371     type = VIK_CLIPBOARD_DATA_TEXT;
 372     //  I don't think we can access what is actually selected (internal to GTK) so we go for the name of the item
 373     // At least this is better than copying the layer data - which is even further away from what the user would be expecting...
 374     name = vik_treeview_item_get_name ( sel->vt, &iter );
 375     len = 0;
 376   }
 377   else {
 378     if ( vik_treeview_item_get_type ( sel->vt, &iter ) == VIK_TREEVIEW_TYPE_SUBLAYER ) {
 379       type = VIK_CLIPBOARD_DATA_SUBLAYER;
 380       if ( vik_layer_get_interface(layer_type)->copy_item) {
 381         subtype = vik_treeview_item_get_data(sel->vt, &iter);
 382         vik_layer_get_interface(layer_type)->copy_item(sel, subtype, vik_treeview_item_get_pointer(sel->vt, &iter), &data, &len );
 383         // This name is used in setting the text representation of the item on the clipboard.
 384         name = vik_treeview_item_get_name(sel->vt, &iter);
 385       }
 386     }
 387     else {
 388       gint ilen;
 389       type = VIK_CLIPBOARD_DATA_LAYER;
 390       vik_layer_marshall ( sel, &data, &ilen );
 391       len = ilen;
 392       name = vik_layer_get_name ( vik_treeview_item_get_pointer(sel->vt, &iter) );
 393     }
 394   }
 395   a_clipboard_copy ( type, layer_type, subtype, len, name, data );
 396 }
 397
 398 void a_clipboard_copy( VikClipboardDataType type, guint16 layer_type, gint subtype, guint len, const gchar* text, guint8 * data)
 399 {
 400   vik_clipboard_t * vc = g_malloc(sizeof(*vc) + len);
 401   GtkClipboard *c = gtk_clipboard_get ( GDK_SELECTION_CLIPBOARD );
 402
 403   vc->type = type;
 404   vc->layer_type = layer_type;
 405   vc->subtype = subtype;
 406   vc->len = len;
 407   vc->text = g_strdup (text);
 408   if ( data ) {
 409     memcpy(vc->data, data, len);
 410     g_free(data);
 411   }
 412   vc->pid = getpid();
 413
 414   // Simple clipboard copy when necessary
 415   if ( type == VIK_CLIPBOARD_DATA_TEXT )
 416     gtk_clipboard_set_text ( c, text, -1 );
 417   else
 418     gtk_clipboard_set_with_data ( c, target_table, G_N_ELEMENTS(target_table), clip_get, clip_clear, vc );
 419 }
 420
 421 /**
 422  * a_clipboard_paste:
 423  *
 424  * To deal with multiple data types, we first request the type of data on the clipboard,
 425  * and handle them in the callback.
 426  */
 427 gboolean a_clipboard_paste ( VikLayersPanel *vlp )
 428 {
 429   GtkClipboard *c = gtk_clipboard_get ( GDK_SELECTION_CLIPBOARD );
 430   gtk_clipboard_request_targets ( c, clip_receive_targets, vlp );
 431   return TRUE;
 432 }
 433
 434 /**
 435  *
 436  * Detect our own data types
 437  */
 438 static void clip_determine_viking_type ( GtkClipboard *c, GtkSelectionData *sd, gpointer p )
 439 {
 440   VikClipboardDataType *vdct = p;
 441   // Default value
 442   *vdct = VIK_CLIPBOARD_DATA_NONE;
 443   vik_clipboard_t *vc;
 444   if (gtk_selection_data_get_length(sd) == -1) {
 445     g_warning ("DETERMINING TYPE: length failure");
 446     return;
 447   }
 448
 449   vc = (vik_clipboard_t *)gtk_selection_data_get_data(sd);
 450
 451   if ( !vc->type )
 452     return;
 453
 454   if ( vc->type == VIK_CLIPBOARD_DATA_LAYER ) {
 455     *vdct = VIK_CLIPBOARD_DATA_LAYER;
 456   }
 457   else if ( vc->type == VIK_CLIPBOARD_DATA_SUBLAYER ) {
 458     *vdct = VIK_CLIPBOARD_DATA_SUBLAYER;
 459   }
 460   else {
 461     g_warning ("DETERMINING TYPE: THIS SHOULD NEVER HAPPEN");
 462   }
 463 }
 464
 465 static void clip_determine_type ( GtkClipboard *c, GdkAtom *a, gint n, gpointer p )
 466 {
 467   gint i;
 468   for (i=0; i<n; i++) {
 469     gchar *name = gdk_atom_name(a[i]);
 470     // g_print("  ""%s""\n", name);
 471     gboolean breaktime = FALSE;
 472     if (!g_strcmp0(name, "application/viking")) {
 473       gtk_clipboard_request_contents ( c, gdk_atom_intern("application/viking", TRUE), clip_determine_viking_type, p );
 474       breaktime = TRUE;
 475     }
 476
 477     g_free ( name );
 478
 479     if ( breaktime )
 480       break;
 481   }
 482 }
 483
 484 /**
 485  * a_clipboard_type:
 486  *
 487  * Return the type of data held in the clipboard if any
 488  */
 489 VikClipboardDataType a_clipboard_type ( )
 490 {
 491   GtkClipboard *c = gtk_clipboard_get ( GDK_SELECTION_CLIPBOARD );
 492   VikClipboardDataType *vcdt = g_malloc ( sizeof (VikClipboardDataType) );
 493
 494   gtk_clipboard_request_targets ( c, clip_determine_type, vcdt );
 495   gint answer = *vcdt;
 496   g_free ( vcdt );
 497   return answer;
 498 }