src/gtk/clipbrd.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        clipbrd.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "clipbrd.h"
  12 #endif
  13
  14 #include "wx/clipbrd.h"
  15
  16 #if wxUSE_CLIPBOARD
  17
  18 #include "wx/utils.h"
  19
  20 #include "glib.h"
  21 #include "gdk/gdk.h"
  22 #include "gtk/gtk.h"
  23
  24 //-----------------------------------------------------------------------------
  25 // data
  26 //-----------------------------------------------------------------------------
  27
  28 wxClipboard *wxTheClipboard = (wxClipboard*) NULL;
  29
  30 GdkAtom  g_clipboardAtom   = 0;
  31 GdkAtom  g_targetsAtom     = 0;
  32
  33 //-----------------------------------------------------------------------------
  34 // reminder
  35 //-----------------------------------------------------------------------------
  36
  37 /* The contents of a selection are returned in a GtkSelectionData
  38    structure. selection/target identify the request.
  39    type specifies the type of the return; if length < 0, and
  40    the data should be ignored. This structure has object semantics -
  41    no fields should be modified directly, they should not be created
  42    directly, and pointers to them should not be stored beyond the duration of
  43    a callback. (If the last is changed, we'll need to add reference
  44    counting)
  45
  46 struct _GtkSelectionData
  47 {
  48   GdkAtom selection;
  49   GdkAtom target;
  50   GdkAtom type;
  51   gint    format;
  52   guchar *data;
  53   gint    length;
  54 };
  55
  56 */
  57
  58 //-----------------------------------------------------------------------------
  59 // "selection_received" for targets
  60 //-----------------------------------------------------------------------------
  61
  62 static void
  63 targets_selection_received( GtkWidget *WXUNUSED(widget),
  64                             GtkSelectionData *selection_data,
  65 #if (GTK_MINOR_VERSION > 0)
  66                             guint32 WXUNUSED(time),
  67 #endif
  68                             wxClipboard *clipboard )
  69 {
  70     if (!wxTheClipboard)
  71     {
  72         clipboard->m_waiting = FALSE;
  73         return;
  74     }
  75
  76     if (selection_data->length <= 0)
  77     {
  78         clipboard->m_waiting = FALSE;
  79         return;
  80     }
  81
  82     /* make sure we got the data in the correct form */
  83     if (selection_data->type != GDK_SELECTION_TYPE_ATOM)
  84     {
  85         clipboard->m_waiting = FALSE;
  86         return;
  87     }
  88
  89     // the atoms we received, holding a list of targets (= formats)
  90     GdkAtom *atoms = (GdkAtom *)selection_data->data;
  91
  92     for (unsigned int i=0; i<selection_data->length/sizeof(GdkAtom); i++)
  93     {
  94 /*      char *name = gdk_atom_name (atoms[i]);
  95         if (name) printf( "Format available: %s.\n", name ); */
  96
  97         if (atoms[i] == clipboard->m_targetRequested)
  98         {
  99             clipboard->m_waiting = FALSE;
 100             clipboard->m_formatSupported = TRUE;
 101             return;
 102         }
 103     }
 104
 105     clipboard->m_waiting = FALSE;
 106     return;
 107 }
 108
 109 //-----------------------------------------------------------------------------
 110 // "selection_received" for the actual data
 111 //-----------------------------------------------------------------------------
 112
 113 static void
 114 selection_received( GtkWidget *WXUNUSED(widget),
 115                     GtkSelectionData *selection_data,
 116 #if (GTK_MINOR_VERSION > 0)
 117                     guint32 WXUNUSED(time),
 118 #endif
 119                     wxClipboard *clipboard )
 120 {
 121     if (!wxTheClipboard)
 122     {
 123         clipboard->m_waiting = FALSE;
 124         return;
 125     }
 126
 127     wxDataObject *data_object = clipboard->m_receivedData;
 128
 129     if (!data_object)
 130     {
 131         clipboard->m_waiting = FALSE;
 132         return;
 133     }
 134
 135     if (selection_data->length <= 0)
 136     {
 137         clipboard->m_waiting = FALSE;
 138         return;
 139     }
 140
 141     /* make sure we got the data in the correct format */
 142     if (data_object->GetFormat().GetAtom() != selection_data->target)
 143     {
 144         clipboard->m_waiting = FALSE;
 145         return;
 146     }
 147
 148     /* make sure we got the data in the correct form (selection type).
 149        if so, copy data to target object */
 150
 151     switch (data_object->GetFormat().GetType())
 152     {
 153         case wxDF_TEXT:
 154         {
 155             if (selection_data->type != GDK_SELECTION_TYPE_STRING)
 156             {
 157                 clipboard->m_waiting = FALSE;
 158                 return;
 159             }
 160
 161             wxTextDataObject *text_object = (wxTextDataObject *) data_object;
 162
 163             wxString text = (const char*) selection_data->data;
 164
 165             text_object->SetText( text );
 166
 167             break;
 168         }
 169
 170         case wxDF_BITMAP:
 171         {
 172             if (selection_data->type != GDK_SELECTION_TYPE_BITMAP)
 173             {
 174                 clipboard->m_waiting = FALSE;
 175                 return;
 176             }
 177
 178             break;
 179         }
 180
 181         case wxDF_PRIVATE:
 182         {
 183             if (selection_data->type != GDK_SELECTION_TYPE_STRING)
 184             {
 185                 clipboard->m_waiting = FALSE;
 186                 return;
 187             }
 188
 189             wxPrivateDataObject *private_object = (wxPrivateDataObject *) data_object;
 190
 191             private_object->SetData( (const char*) selection_data->data, (size_t) selection_data->length );
 192
 193             break;
 194         }
 195
 196         default:
 197         {
 198             clipboard->m_waiting = FALSE;
 199             return;
 200         }
 201     }
 202
 203     wxTheClipboard->m_formatSupported = TRUE;
 204     clipboard->m_waiting = FALSE;
 205 }
 206
 207 //-----------------------------------------------------------------------------
 208 // "selection_clear"
 209 //-----------------------------------------------------------------------------
 210
 211 static gint
 212 selection_clear_clip( GtkWidget *WXUNUSED(widget), GdkEventSelection *event )
 213 {
 214     if (!wxTheClipboard) return TRUE;
 215
 216     if (event->selection == GDK_SELECTION_PRIMARY)
 217     {
 218         wxTheClipboard->m_ownsPrimarySelection = FALSE;
 219     }
 220     else
 221     if (event->selection == g_clipboardAtom)
 222     {
 223         wxTheClipboard->m_ownsClipboard = FALSE;
 224     }
 225     else
 226     {
 227         wxTheClipboard->m_waiting = FALSE;
 228         return FALSE;
 229     }
 230
 231     if ((!wxTheClipboard->m_ownsPrimarySelection) &&
 232         (!wxTheClipboard->m_ownsClipboard))
 233     {
 234         /* the clipboard is no longer in our hands. we can the  clipboard data. */
 235
 236         if (wxTheClipboard->m_dataBroker)
 237         {
 238             delete wxTheClipboard->m_dataBroker;
 239             wxTheClipboard->m_dataBroker = (wxDataBroker*) NULL;
 240         }
 241     }
 242
 243     wxTheClipboard->m_waiting = FALSE;
 244     return TRUE;
 245 }
 246
 247 //-----------------------------------------------------------------------------
 248 // selection handler for supplying data
 249 //-----------------------------------------------------------------------------
 250
 251 static void
 252 selection_handler( GtkWidget *WXUNUSED(widget), GtkSelectionData *selection_data, gpointer WXUNUSED(data) )
 253 {
 254     if (!wxTheClipboard) return;
 255
 256     if (!wxTheClipboard->m_dataBroker) return;
 257
 258     wxNode *node = wxTheClipboard->m_dataBroker->m_dataObjects.First();
 259
 260     while (node)
 261     {
 262         wxDataObject *data_object = (wxDataObject *)node->Data();
 263
 264         if (data_object->GetFormat().GetAtom() != selection_data->target)
 265         {
 266             node = node->Next();
 267             break;
 268         }
 269
 270         switch (data_object->GetFormat().GetType())
 271         {
 272             case wxDF_TEXT:
 273             {
 274                 wxTextDataObject *text_object = (wxTextDataObject*) data_object;
 275
 276                 wxString text = text_object->GetText();
 277
 278 #if wxUSE_UNICODE
 279                 const wxWX2MBbuf s = text.mbc_str();
 280                 int len = strlen(s);
 281 #else // more efficient in non-Unicode
 282                 const char *s = text.c_str();
 283                 int len = (int) text.Length();
 284 #endif
 285
 286                 gtk_selection_data_set(
 287                     selection_data,
 288                     GDK_SELECTION_TYPE_STRING,
 289                     8*sizeof(gchar),
 290                     (unsigned char*) (const char*) s,
 291                     len );
 292
 293                 break;
 294             }
 295
 296             case wxDF_BITMAP:
 297             {
 298                 // wxBitmapDataObject *private_object = (wxBitmapDataObject*) data_object;
 299
 300                 // how do we do that ?
 301
 302                 break;
 303             }
 304
 305             case wxDF_PRIVATE:
 306             {
 307                 wxPrivateDataObject *private_object = (wxPrivateDataObject*) data_object;
 308
 309                 if (private_object->GetSize() == 0) return;
 310
 311                 gtk_selection_data_set(
 312                     selection_data,
 313                     GDK_SELECTION_TYPE_STRING,
 314                     8*sizeof(gchar),
 315                     (unsigned char*) private_object->GetData(),
 316                     (int) private_object->GetSize() );
 317             }
 318
 319             default:
 320               break;
 321         }
 322
 323         node = node->Next();
 324     }
 325 }
 326
 327 //-----------------------------------------------------------------------------
 328 // wxClipboard
 329 //-----------------------------------------------------------------------------
 330
 331 IMPLEMENT_DYNAMIC_CLASS(wxClipboard,wxObject)
 332
 333 wxClipboard::wxClipboard()
 334 {
 335     m_open = FALSE;
 336
 337     m_ownsClipboard = FALSE;
 338     m_ownsPrimarySelection = FALSE;
 339
 340     m_dataBroker = (wxDataBroker*) NULL;
 341
 342     m_receivedData = (wxDataObject*) NULL;
 343
 344     /* we use m_targetsWidget to query what formats are available */
 345
 346     m_targetsWidget = gtk_window_new( GTK_WINDOW_POPUP );
 347     gtk_widget_realize( m_targetsWidget );
 348
 349     gtk_signal_connect( GTK_OBJECT(m_targetsWidget),
 350                         "selection_received",
 351                         GTK_SIGNAL_FUNC( targets_selection_received ),
 352                         (gpointer) this );
 353
 354     /* we use m_clipboardWidget to get and to offer data */
 355
 356     m_clipboardWidget = gtk_window_new( GTK_WINDOW_POPUP );
 357     gtk_widget_realize( m_clipboardWidget );
 358
 359     gtk_signal_connect( GTK_OBJECT(m_clipboardWidget),
 360                         "selection_received",
 361                         GTK_SIGNAL_FUNC( selection_received ),
 362                         (gpointer) this );
 363
 364     gtk_signal_connect( GTK_OBJECT(m_clipboardWidget),
 365                         "selection_clear_event",
 366                         GTK_SIGNAL_FUNC( selection_clear_clip ),
 367                         (gpointer) NULL );
 368
 369     if (!g_clipboardAtom) g_clipboardAtom = gdk_atom_intern( "CLIPBOARD", FALSE );
 370     if (!g_targetsAtom) g_targetsAtom = gdk_atom_intern ("TARGETS", FALSE);
 371
 372     m_formatSupported = FALSE;
 373     m_targetRequested = 0;
 374 }
 375
 376 wxClipboard::~wxClipboard()
 377 {
 378     Clear();
 379
 380     if (m_clipboardWidget) gtk_widget_destroy( m_clipboardWidget );
 381     if (m_targetsWidget) gtk_widget_destroy( m_targetsWidget );
 382 }
 383
 384 void wxClipboard::Clear()
 385 {
 386     if (m_dataBroker)
 387     {
 388         /*  As we have data we also own the clipboard. Once we no longer own
 389             it, clear_selection is called which will set m_data to zero */
 390
 391         if (gdk_selection_owner_get( g_clipboardAtom ) == m_clipboardWidget->window)
 392         {
 393             m_waiting = TRUE;
 394
 395             gtk_selection_owner_set( (GtkWidget*) NULL, g_clipboardAtom, GDK_CURRENT_TIME );
 396
 397             while (m_waiting) gtk_main_iteration();
 398         }
 399
 400         if (gdk_selection_owner_get( GDK_SELECTION_PRIMARY ) == m_clipboardWidget->window)
 401         {
 402             m_waiting = TRUE;
 403
 404             gtk_selection_owner_set( (GtkWidget*) NULL, GDK_SELECTION_PRIMARY, GDK_CURRENT_TIME );
 405
 406             while (m_waiting) gtk_main_iteration();
 407         }
 408
 409         if (m_dataBroker)
 410         {
 411             delete m_dataBroker;
 412             m_dataBroker = (wxDataBroker*) NULL;
 413         }
 414     }
 415
 416     m_targetRequested = 0;
 417
 418     m_formatSupported = FALSE;
 419 }
 420
 421 bool wxClipboard::Open()
 422 {
 423     wxCHECK_MSG( !m_open, FALSE, _T("clipboard already open") );
 424
 425     m_open = TRUE;
 426
 427     return TRUE;
 428 }
 429
 430 bool wxClipboard::SetData( wxDataObject *data )
 431 {
 432     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 433
 434     wxCHECK_MSG( data, FALSE, _T("data is invalid") );
 435
 436     Clear();
 437
 438     return AddData( data );
 439 }
 440
 441 bool wxClipboard::AddData( wxDataObject *data )
 442 {
 443     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 444
 445     wxCHECK_MSG( data, FALSE, _T("data is invalid") );
 446
 447     /* if clipboard has been cleared before, create new data broker */
 448
 449     if (!m_dataBroker) m_dataBroker = new wxDataBroker();
 450
 451     /* add new data to list of offered data objects */
 452
 453     m_dataBroker->Add( data );
 454
 455     /* get native format id of new data object */
 456
 457     GdkAtom format = data->GetFormat().GetAtom();
 458
 459     wxCHECK_MSG( format, FALSE, _T("data has invalid format") );
 460
 461     /* This should happen automatically, but to be on the safe side */
 462
 463     m_ownsClipboard = FALSE;
 464     m_ownsPrimarySelection = FALSE;
 465
 466     /* Add handlers if someone requests data */
 467
 468
 469 #if (GTK_MINOR_VERSION > 0)
 470
 471     gtk_selection_add_target( GTK_WIDGET(m_clipboardWidget),
 472                               GDK_SELECTION_PRIMARY,
 473                               format,
 474                               0 );  /* what is info ? */
 475
 476     gtk_selection_add_target( GTK_WIDGET(m_clipboardWidget),
 477                               g_clipboardAtom,
 478                               format,
 479                               0 );  /* what is info ? */
 480
 481     gtk_signal_connect( GTK_OBJECT(m_clipboardWidget),
 482                         "selection_get",
 483                         GTK_SIGNAL_FUNC(selection_handler),
 484                         (gpointer) NULL );
 485
 486 #else
 487
 488     gtk_selection_add_handler( m_clipboardWidget,
 489                                g_clipboardAtom,
 490                                format,
 491                                selection_handler,
 492                                (gpointer) NULL );
 493
 494     gtk_selection_add_handler( m_clipboardWidget,
 495                                GDK_SELECTION_PRIMARY,
 496                                format,
 497                                selection_handler,
 498                                (gpointer) NULL );
 499 #endif
 500
 501     /* Tell the world we offer clipboard data */
 502
 503     if (!gtk_selection_owner_set( m_clipboardWidget,
 504                                   g_clipboardAtom,
 505                                   GDK_CURRENT_TIME ))
 506     {
 507         return FALSE;
 508     }
 509     m_ownsClipboard = TRUE;
 510
 511     if (!gtk_selection_owner_set( m_clipboardWidget,
 512                                   GDK_SELECTION_PRIMARY,
 513                                   GDK_CURRENT_TIME ))
 514     {
 515         return FALSE;
 516     }
 517     m_ownsPrimarySelection = TRUE;
 518
 519     return TRUE;
 520 }
 521
 522 void wxClipboard::Close()
 523 {
 524     wxCHECK_RET( m_open, _T("clipboard not open") );
 525
 526     m_open = FALSE;
 527 }
 528
 529 bool wxClipboard::IsSupported( wxDataFormat format )
 530 {
 531     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 532
 533     /* store requested format to be asked for by callbacks */
 534
 535     m_targetRequested = format.GetAtom();
 536
 537     wxCHECK_MSG( m_targetRequested, FALSE, _T("invalid clipboard format") );
 538
 539     m_formatSupported = FALSE;
 540
 541     /* perform query. this will set m_formatSupported to
 542        TRUE if m_targetRequested is supported.
 543        alsom we have to wait for the "answer" from the
 544        clipboard owner which is an asynchronous process.
 545        therefore we set m_waiting = TRUE here and wait
 546        until the callback "targets_selection_received"
 547        sets it to FALSE */
 548
 549     m_waiting = TRUE;
 550
 551     gtk_selection_convert( m_targetsWidget,
 552                            g_clipboardAtom,
 553                            g_targetsAtom,
 554                            GDK_CURRENT_TIME );
 555
 556     while (m_waiting) gtk_main_iteration();
 557
 558     if (!m_formatSupported) return FALSE;
 559
 560     return TRUE;
 561 }
 562
 563 bool wxClipboard::GetData( wxDataObject *data )
 564 {
 565     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 566
 567     /* is data supported by clipboard ? */
 568
 569     if (!IsSupported( data->GetFormat() )) return FALSE;
 570
 571     /* store pointer to data object to be filled up by callbacks */
 572
 573     m_receivedData = data;
 574
 575     /* store requested format to be asked for by callbacks */
 576
 577     m_targetRequested = data->GetFormat().GetAtom();
 578
 579     wxCHECK_MSG( m_targetRequested, FALSE, _T("invalid clipboard format") );
 580
 581     /* start query */
 582
 583     m_formatSupported = FALSE;
 584
 585     /* ask for clipboard contents.  this will set
 586        m_formatSupported to TRUE if m_targetRequested
 587        is supported.
 588        also, we have to wait for the "answer" from the
 589        clipboard owner which is an asynchronous process.
 590        therefore we set m_waiting = TRUE here and wait
 591        until the callback "targets_selection_received"
 592        sets it to FALSE */
 593
 594     m_waiting = TRUE;
 595
 596     gtk_selection_convert( m_clipboardWidget,
 597                            g_clipboardAtom,
 598                            m_targetRequested,
 599                            GDK_CURRENT_TIME );
 600
 601     while (m_waiting) gtk_main_iteration();
 602
 603     /* this is a true error as we checked for the presence of such data before */
 604
 605     wxCHECK_MSG( m_formatSupported, FALSE, _T("error retrieving data from clipboard") );
 606
 607     return TRUE;
 608 }
 609
 610 //-----------------------------------------------------------------------------
 611 // wxClipboardModule
 612 //-----------------------------------------------------------------------------
 613
 614 IMPLEMENT_DYNAMIC_CLASS(wxClipboardModule,wxModule)
 615
 616 bool wxClipboardModule::OnInit()
 617 {
 618     wxTheClipboard = new wxClipboard();
 619
 620     return TRUE;
 621 }
 622
 623 void wxClipboardModule::OnExit()
 624 {
 625     if (wxTheClipboard) delete wxTheClipboard;
 626     wxTheClipboard = (wxClipboard*) NULL;
 627 }
 628
 629 #endif
 630
 631   // wxUSE_CLIPBOARD
 632