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  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #include <stdio.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include "viking.h"
  26
  27
  28 typedef struct {
  29   gpointer clipboard;
  30   gint pid;
  31   VikClipboardDataType type;
  32   gint subtype;
  33   guint16 layer_type;
  34   guint len;
  35   guint8 data[0];
  36 } vik_clipboard_t;
  37
  38 static GtkTargetEntry target_table[] = {
  39   { "application/viking", 0, 0 },
  40   { "STRING", 0, 1 },
  41 };
  42
  43 /*****************************************************************
  44  ** functions which send to the clipboard client (we are owner) **
  45  *****************************************************************/
  46
  47 static void clip_get ( GtkClipboard *c, GtkSelectionData *selection_data, guint info, gpointer p )
  48 {
  49   vik_clipboard_t *vc = p;
  50   if (info==0) {
  51     //    g_print("clip_get: vc = %p, size = %d\n", vc, sizeof(*vc) + vc->len);
  52     gtk_selection_data_set ( selection_data, selection_data->target, 8, (void *)vc, sizeof(*vc) + vc->len );
  53   }
  54   if (info==1) {
  55     if (vc->type == VIK_CLIPBOARD_DATA_LAYER) {
  56       gtk_selection_data_set_text ( selection_data, VIK_LAYER(vc->clipboard)->name, -1 );
  57     }
  58   }
  59 }
  60
  61 static void clip_clear ( GtkClipboard *c, gpointer p )
  62 {
  63   g_free(p);
  64 }
  65
  66
  67 /**************************************************************************
  68  ** functions which receive from the clipboard owner (we are the client) **
  69  **************************************************************************/
  70
  71 /* our own data type */
  72 static void clip_receive_viking ( GtkClipboard *c, GtkSelectionData *sd, gpointer p )
  73 {
  74   VikLayersPanel *vlp = p;
  75   vik_clipboard_t *vc;
  76   if (sd->length == -1) {
  77     g_warning ( "paste failed" );
  78     return;
  79   }
  80   //  g_print("clip receive: target = %s, type = %s\n", gdk_atom_name(sd->target), gdk_atom_name(sd->type));
  81   g_assert(!strcmp(gdk_atom_name(sd->target), target_table[0].target));
  82
  83   vc = (vik_clipboard_t *)sd->data;
  84   //  g_print("  sd->data = %p, sd->length = %d, vc->len = %d\n", sd->data, sd->length, vc->len);
  85
  86   if (sd->length != sizeof(*vc) + vc->len) {
  87     g_warning ( "wrong clipboard data size" );
  88     return;
  89   }
  90
  91   if ( vc->type == VIK_CLIPBOARD_DATA_LAYER )
  92   {
  93     VikLayer *new_layer = vik_layer_unmarshall ( vc->data, vc->len, vik_layers_panel_get_viewport(vlp) );
  94     vik_layers_panel_add_layer ( vlp, new_layer );
  95   }
  96   else if ( vc->type == VIK_CLIPBOARD_DATA_SUBLAYER )
  97   {
  98     VikLayer *sel = vik_layers_panel_get_selected ( vlp );
  99     if ( sel && sel->type == vc->layer_type)
 100     {
 101       if ( vik_layer_get_interface(vc->layer_type)->paste_item )
 102         vik_layer_get_interface(vc->layer_type)->paste_item ( sel, vc->subtype, vc->data, vc->len);
 103     }
 104     else
 105       a_dialog_error_msg_extra ( VIK_GTK_WINDOW_FROM_WIDGET(GTK_WIDGET(vlp)), "The clipboard contains sublayer data for a %s layers. You must select a layer of this type to paste the clipboard data.", vik_layer_get_interface(vc->layer_type)->name );
 106   }
 107 }
 108
 109
 110
 111 /*
 112  * utility func to handle pasted text:
 113  * search for N dd.dddddd W dd.dddddd, N dd° dd.dddd W dd° dd.ddddd and so forth
 114  */
 115 static gboolean clip_parse_latlon ( const gchar *text, struct LatLon *coord )
 116 {
 117   gint latdeg, londeg;
 118   gdouble latm, lonm;
 119   gdouble lat, lon;
 120   gchar *cand;
 121   gint len, i;
 122   gchar *s = g_strdup(text);
 123
 124   //  g_print("parsing %s\n", s);
 125
 126   len = strlen(s);
 127
 128   /* remove non-digits following digits; gets rid of degree symbols or whatever people use, and
 129    * punctuation
 130    */
 131   for (i=0; i<len-2; i++) {
 132     if (g_ascii_isdigit (s[i]) && s[i+1] != '.' && !g_ascii_isdigit (s[i+1])) {
 133       s[i+1] = ' ';
 134       if (!g_ascii_isalnum (s[i+2]) && s[i+2] != '-') {
 135         s[i+2] = ' ';
 136       }
 137     }
 138   }
 139
 140   /* now try reading coordinates */
 141   for (i=0; i<len; i++) {
 142     if (s[i] == 'N' || s[i] == 'S' || g_ascii_isdigit (s[i])) {
 143       gchar latc[2] = "SN";
 144       gchar lonc[2] = "WE";
 145       gint j, k;
 146       cand = s+i;
 147
 148       //      printf("Trying >>>>> %s\n", cand);
 149
 150       for (j=0; j<2; j++) {
 151         for (k=0; k<2; k++) {
 152           gchar fmt1[] = "N %d%*[ ]%lf W %d%*[ ]%lf";
 153           gchar fmt2[] = "%d%*[ ]%lf N %d%*[ ]%lf W";
 154           gchar fmt3[] = "N %lf W %lf";
 155           gchar fmt4[] = "%lf N %lf W";
 156
 157           fmt1[0]  = latc[j];     fmt1[13] = lonc[k];
 158           fmt2[11] = latc[j];     fmt2[24] = lonc[k];
 159           fmt3[0]  = latc[j];     fmt3[6]  = lonc[k];
 160           fmt4[4]  = latc[j];     fmt4[10] = lonc[k];
 161
 162           if (sscanf(cand, fmt1, &latdeg, &latm, &londeg, &lonm) == 4 ||
 163               sscanf(cand, fmt2, &latdeg, &latm, &londeg, &lonm) == 4) {
 164             lat = (j*2-1) * (latdeg + latm / 60);
 165             lon = (k*2-1) * (londeg + lonm / 60);
 166             break;
 167           }
 168           if (sscanf(cand, fmt3, &lat, &lon) == 2 ||
 169               sscanf(cand, fmt4, &lat, &lon) == 2) {
 170             lat *= (j*2-1);
 171             lon *= (k*2-1);
 172             break;
 173           }
 174         }
 175         if (k!=2) break;
 176       }
 177       if (j!=2) break;
 178
 179       if (sscanf(cand, "%d%*[ ]%lf %d%*[ ]%lf", &latdeg, &latm, &londeg, &lonm) == 4) {
 180         lat = latdeg/abs(latdeg) * (abs(latdeg) + latm / 60);
 181         lon = londeg/abs(londeg) * (abs(londeg) + lonm / 60);
 182         break;
 183       }
 184       if (sscanf(cand, "%lf %lf", &lat, &lon) == 2) {
 185         break;
 186       }
 187     }
 188   }
 189   g_free(s);
 190
 191   /* did we get to the end without actually finding a coordinate? */
 192   if (i<len && lat >= -90.0 && lat <= 90.0 && lon >= -180.0 && lon <= 180.0) {
 193     coord->lat = lat;
 194     coord->lon = lon;
 195     return TRUE;
 196   }
 197   return FALSE;
 198 }
 199
 200 static void clip_add_wp(VikLayersPanel *vlp, struct LatLon *coord)
 201 {
 202   VikCoord vc;
 203   VikLayer *sel = vik_layers_panel_get_selected ( vlp );
 204
 205
 206   vik_coord_load_from_latlon ( &vc, VIK_COORD_LATLON, coord );
 207
 208   if (sel && sel->type == VIK_LAYER_TRW) {
 209     vik_trw_layer_new_waypoint ( VIK_TRW_LAYER(sel), VIK_GTK_WINDOW_FROM_LAYER(sel), &vc );
 210   } else {
 211     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);
 212   }
 213 }
 214
 215 static void clip_receive_text (GtkClipboard *c, const gchar *text, gpointer p)
 216 {
 217   VikLayersPanel *vlp = p;
 218   struct LatLon coord;
 219   //  g_print("got text: %s\n", text);
 220   if (clip_parse_latlon(text, &coord)) {
 221     clip_add_wp(vlp, &coord);
 222   }
 223 }
 224
 225 static void clip_receive_html ( GtkClipboard *c, GtkSelectionData *sd, gpointer p )
 226 {
 227   VikLayersPanel *vlp = p;
 228   guint r, w;
 229   GError *err = NULL;
 230   gchar *s, *span;
 231   gint tag = 0, i;
 232   struct LatLon coord;
 233
 234   if (sd->length == -1) {
 235     return;
 236   }
 237
 238   /* - copying from Mozilla seems to give html in UTF-16. */
 239   if (!(s =  g_convert ( (gchar *)sd->data, sd->length, "UTF-8", "UTF-16", &r, &w, &err))) {
 240     return;
 241   }
 242   //  g_print("html is %d bytes long: %s\n", sd->length, s);
 243
 244   /* scrape a coordinate pasted from a geocaching.com page: look for a
 245    * telltale tag if possible, and then remove tags
 246    */
 247   if (!(span = g_strstr_len(s, w, "<span id=\"LatLon\">"))) {
 248     span = s;
 249   }
 250   for (i=0; i<strlen(span); i++) {
 251     gchar c = span[i];
 252     if (c == '<') {
 253       tag++;
 254     }
 255     if (tag>0) {
 256       span[i] = ' ';
 257     }
 258     if (c == '>') {
 259       if (tag>0) tag--;
 260     }
 261   }
 262   if (clip_parse_latlon(span, &coord)) {
 263     clip_add_wp(vlp, &coord);
 264   }
 265
 266   g_free(s);
 267 }
 268
 269 /*
 270  * deal with various data types a clipboard may hold
 271  */
 272 void clip_receive_targets ( GtkClipboard *c, GdkAtom *a, gint n, gpointer p )
 273 {
 274   VikLayersPanel *vlp = p;
 275   gint i;
 276
 277   /*  g_print("got targets\n"); */
 278   for (i=0; i<n; i++) {
 279     /* g_print("  ""%s""\n", gdk_atom_name(a[i])); */
 280     if (!strcmp(gdk_atom_name(a[i]), "text/html")) {
 281       gtk_clipboard_request_contents ( c, gdk_atom_intern("text/html", TRUE), clip_receive_html, vlp );
 282       break;
 283     }
 284     if (a[i] == GDK_TARGET_STRING) {
 285       gtk_clipboard_request_text ( c, clip_receive_text, vlp );
 286       break;
 287     }
 288     if (!strcmp(gdk_atom_name(a[i]), "application/viking")) {
 289       gtk_clipboard_request_contents ( c, gdk_atom_intern("application/viking", TRUE), clip_receive_viking, vlp );
 290       break;
 291     }
 292   }
 293 }
 294
 295 /*********************************************************************************
 296  ** public functions                                                            **
 297  *********************************************************************************/
 298
 299 /*
 300  * make a copy of selected object and associate ourselves with the clipboard
 301  */
 302 void a_clipboard_copy_selected ( VikLayersPanel *vlp )
 303 {
 304   VikLayer *sel = vik_layers_panel_get_selected ( vlp );
 305   GtkTreeIter iter;
 306   VikClipboardDataType type;
 307   guint16 layer_type = 0;
 308   gint subtype = 0;
 309   guint8 *data = NULL;
 310   guint len;
 311
 312   if ( ! sel )
 313     return;
 314
 315   vik_treeview_get_selected_iter ( sel->vt, &iter );
 316
 317   if ( vik_treeview_item_get_type ( sel->vt, &iter ) == VIK_TREEVIEW_TYPE_SUBLAYER ) {
 318     type = VIK_CLIPBOARD_DATA_SUBLAYER;
 319     layer_type = sel->type;
 320     if ( vik_layer_get_interface(layer_type)->copy_item) {
 321       subtype = vik_treeview_item_get_data(sel->vt, &iter);
 322       vik_layer_get_interface(layer_type)->copy_item(sel, subtype, vik_treeview_item_get_pointer(sel->vt, &iter), &data, &len );
 323     }
 324   }
 325   else
 326   {
 327     type = VIK_CLIPBOARD_DATA_LAYER;
 328     vik_layer_marshall ( sel, &data, &len );
 329   }
 330
 331   if (data)
 332     a_clipboard_copy( type, layer_type, subtype, len, data);
 333
 334 }
 335
 336 void a_clipboard_copy( VikClipboardDataType type, guint16 layer_type, gint subtype, guint len, guint8 * data)
 337 {
 338   vik_clipboard_t * vc = g_malloc(sizeof(*vc) + len);
 339   GtkClipboard *c = gtk_clipboard_get ( GDK_SELECTION_CLIPBOARD );
 340
 341   vc->type = type;
 342   vc->layer_type = layer_type;
 343   vc->subtype = subtype;
 344   vc->len = len;
 345   memcpy(vc->data, data, len);
 346   g_free(data);
 347   vc->pid = getpid();
 348   gtk_clipboard_set_with_data ( c, target_table, G_N_ELEMENTS(target_table), clip_get, clip_clear, vc );
 349 }
 350
 351 /*
 352  * to deal with multiple data types, we first request the type of data on the clipboard,
 353  * and handle them in the callback
 354  */
 355 gboolean a_clipboard_paste ( VikLayersPanel *vlp )
 356 {
 357   GtkClipboard *c = gtk_clipboard_get ( GDK_SELECTION_CLIPBOARD );
 358   gtk_clipboard_request_targets ( c, clip_receive_targets, vlp );
 359   return TRUE;
 360 }
 361