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 delete clipboard data. */
 235         if (wxTheClipboard->m_dataBroker)
 236         {
 237             delete wxTheClipboard->m_dataBroker;
 238             wxTheClipboard->m_dataBroker = (wxDataBroker*) NULL;
 239         }
 240     }
 241
 242     wxTheClipboard->m_waiting = FALSE;
 243     return TRUE;
 244 }
 245
 246 //-----------------------------------------------------------------------------
 247 // selection handler for supplying data
 248 //-----------------------------------------------------------------------------
 249
 250 static void
 251 selection_handler( GtkWidget *WXUNUSED(widget), GtkSelectionData *selection_data, gpointer WXUNUSED(data) )
 252 {
 253     if (!wxTheClipboard) return;
 254
 255     if (!wxTheClipboard->m_dataBroker) return;
 256
 257     wxNode *node = wxTheClipboard->m_dataBroker->m_dataObjects.First();
 258
 259     while (node)
 260     {
 261         wxDataObject *data_object = (wxDataObject *)node->Data();
 262
 263         if (data_object->GetFormat().GetAtom() != selection_data->target)
 264         {
 265             node = node->Next();
 266             continue;
 267         }
 268
 269         switch (data_object->GetFormat().GetType())
 270         {
 271             case wxDF_TEXT:
 272             {
 273                 wxTextDataObject *text_object = (wxTextDataObject*) data_object;
 274
 275                 wxString text = text_object->GetText();
 276
 277 #if wxUSE_UNICODE
 278                 const wxWX2MBbuf s = text.mbc_str();
 279                 int len = strlen(s);
 280 #else // more efficient in non-Unicode
 281                 const char *s = text.c_str();
 282                 int len = (int) text.Length();
 283 #endif
 284
 285                 gtk_selection_data_set(
 286                     selection_data,
 287                     GDK_SELECTION_TYPE_STRING,
 288                     8*sizeof(gchar),
 289                     (unsigned char*) (const char*) s,
 290                     len );
 291
 292                 break;
 293             }
 294
 295             case wxDF_BITMAP:
 296             {
 297                 // wxBitmapDataObject *private_object = (wxBitmapDataObject*) data_object;
 298
 299                 // how do we do that ?
 300
 301                 break;
 302             }
 303
 304             case wxDF_PRIVATE:
 305             {
 306                 wxPrivateDataObject *private_object = (wxPrivateDataObject*) data_object;
 307
 308                 if (private_object->GetSize() == 0) return;
 309
 310                 gtk_selection_data_set(
 311                     selection_data,
 312                     GDK_SELECTION_TYPE_STRING,
 313                     8*sizeof(gchar),
 314                     (unsigned char*) private_object->GetData(),
 315                     (int) private_object->GetSize() );
 316             }
 317
 318             default:
 319               break;
 320         }
 321
 322         node = node->Next();
 323     }
 324 }
 325
 326 //-----------------------------------------------------------------------------
 327 // wxClipboard
 328 //-----------------------------------------------------------------------------
 329
 330 IMPLEMENT_DYNAMIC_CLASS(wxClipboard,wxObject)
 331
 332 wxClipboard::wxClipboard()
 333 {
 334     m_open = FALSE;
 335
 336     m_ownsClipboard = FALSE;
 337     m_ownsPrimarySelection = FALSE;
 338
 339     m_dataBroker = (wxDataBroker*) NULL;
 340
 341     m_receivedData = (wxDataObject*) NULL;
 342
 343     /* we use m_targetsWidget to query what formats are available */
 344
 345     m_targetsWidget = gtk_window_new( GTK_WINDOW_POPUP );
 346     gtk_widget_realize( m_targetsWidget );
 347
 348     gtk_signal_connect( GTK_OBJECT(m_targetsWidget),
 349                         "selection_received",
 350                         GTK_SIGNAL_FUNC( targets_selection_received ),
 351                         (gpointer) this );
 352
 353     /* we use m_clipboardWidget to get and to offer data */
 354
 355     m_clipboardWidget = gtk_window_new( GTK_WINDOW_POPUP );
 356     gtk_widget_realize( m_clipboardWidget );
 357
 358     gtk_signal_connect( GTK_OBJECT(m_clipboardWidget),
 359                         "selection_received",
 360                         GTK_SIGNAL_FUNC( selection_received ),
 361                         (gpointer) this );
 362
 363     gtk_signal_connect( GTK_OBJECT(m_clipboardWidget),
 364                         "selection_clear_event",
 365                         GTK_SIGNAL_FUNC( selection_clear_clip ),
 366                         (gpointer) NULL );
 367
 368     if (!g_clipboardAtom) g_clipboardAtom = gdk_atom_intern( "CLIPBOARD", FALSE );
 369     if (!g_targetsAtom) g_targetsAtom = gdk_atom_intern ("TARGETS", FALSE);
 370
 371     m_formatSupported = FALSE;
 372     m_targetRequested = 0;
 373 }
 374
 375 wxClipboard::~wxClipboard()
 376 {
 377     Clear();
 378
 379     if (m_clipboardWidget) gtk_widget_destroy( m_clipboardWidget );
 380     if (m_targetsWidget) gtk_widget_destroy( m_targetsWidget );
 381 }
 382
 383 void wxClipboard::Clear()
 384 {
 385     if (m_dataBroker)
 386     {
 387         /*  As we have data we also own the clipboard. Once we no longer own
 388             it, clear_selection is called which will set m_data to zero */
 389
 390         if (gdk_selection_owner_get( g_clipboardAtom ) == m_clipboardWidget->window)
 391         {
 392             m_waiting = TRUE;
 393
 394             gtk_selection_owner_set( (GtkWidget*) NULL, g_clipboardAtom, GDK_CURRENT_TIME );
 395
 396             while (m_waiting) gtk_main_iteration();
 397         }
 398
 399         if (gdk_selection_owner_get( GDK_SELECTION_PRIMARY ) == m_clipboardWidget->window)
 400         {
 401             m_waiting = TRUE;
 402
 403             gtk_selection_owner_set( (GtkWidget*) NULL, GDK_SELECTION_PRIMARY, GDK_CURRENT_TIME );
 404
 405             while (m_waiting) gtk_main_iteration();
 406         }
 407
 408         if (m_dataBroker)
 409         {
 410             delete m_dataBroker;
 411             m_dataBroker = (wxDataBroker*) NULL;
 412         }
 413     }
 414
 415     m_targetRequested = 0;
 416
 417     m_formatSupported = FALSE;
 418 }
 419
 420 bool wxClipboard::Open()
 421 {
 422     wxCHECK_MSG( !m_open, FALSE, _T("clipboard already open") );
 423
 424     m_open = TRUE;
 425
 426     return TRUE;
 427 }
 428
 429 bool wxClipboard::SetData( wxDataObject *data )
 430 {
 431     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 432
 433     wxCHECK_MSG( data, FALSE, _T("data is invalid") );
 434
 435     Clear();
 436
 437     return AddData( data );
 438 }
 439
 440 bool wxClipboard::AddData( wxDataObject *data )
 441 {
 442     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 443
 444     wxCHECK_MSG( data, FALSE, _T("data is invalid") );
 445
 446     /* if clipboard has been cleared before, create new data broker */
 447     if (!m_dataBroker) m_dataBroker = new wxDataBroker();
 448
 449     /* add new data to list of offered data objects */
 450     m_dataBroker->Add( data );
 451
 452     /* get native format id of new data object */
 453     GdkAtom format = data->GetFormat().GetAtom();
 454
 455     wxCHECK_MSG( format, FALSE, _T("data has invalid format") );
 456
 457     /* This should happen automatically, but to be on the safe side */
 458     m_ownsClipboard = FALSE;
 459     m_ownsPrimarySelection = FALSE;
 460
 461     /* Add handlers if someone requests data */
 462
 463 #if (GTK_MINOR_VERSION > 0)
 464
 465     gtk_selection_add_target( GTK_WIDGET(m_clipboardWidget),
 466                               GDK_SELECTION_PRIMARY,
 467                               format,
 468                               0 );  /* what is info ? */
 469
 470     gtk_selection_add_target( GTK_WIDGET(m_clipboardWidget),
 471                               g_clipboardAtom,
 472                               format,
 473                               0 );  /* what is info ? */
 474
 475     gtk_signal_connect( GTK_OBJECT(m_clipboardWidget),
 476                         "selection_get",
 477                         GTK_SIGNAL_FUNC(selection_handler),
 478                         (gpointer) NULL );
 479
 480 #else
 481
 482     gtk_selection_add_handler( m_clipboardWidget,
 483                                g_clipboardAtom,
 484                                format,
 485                                selection_handler,
 486                                (gpointer) NULL );
 487
 488     gtk_selection_add_handler( m_clipboardWidget,
 489                                GDK_SELECTION_PRIMARY,
 490                                format,
 491                                selection_handler,
 492                                (gpointer) NULL );
 493 #endif
 494
 495 //    printf( "vorher.\n" );
 496     /* Tell the world we offer clipboard data */
 497     if (!gtk_selection_owner_set( m_clipboardWidget,
 498                                   g_clipboardAtom,
 499                                   GDK_CURRENT_TIME ))
 500     {
 501         return FALSE;
 502     }
 503     m_ownsClipboard = TRUE;
 504
 505 //    printf( "nachher.\n" );
 506
 507     return TRUE;
 508
 509     if (!gtk_selection_owner_set( m_clipboardWidget,
 510                                   GDK_SELECTION_PRIMARY,
 511                                   GDK_CURRENT_TIME ))
 512     {
 513         return FALSE;
 514     }
 515     m_ownsPrimarySelection = TRUE;
 516
 517     return TRUE;
 518 }
 519
 520 void wxClipboard::Close()
 521 {
 522     wxCHECK_RET( m_open, _T("clipboard not open") );
 523
 524     m_open = FALSE;
 525 }
 526
 527 bool wxClipboard::IsSupported( wxDataFormat format )
 528 {
 529     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 530
 531     /* store requested format to be asked for by callbacks */
 532
 533     m_targetRequested = format.GetAtom();
 534
 535     wxCHECK_MSG( m_targetRequested, FALSE, _T("invalid clipboard format") );
 536
 537     m_formatSupported = FALSE;
 538
 539     /* perform query. this will set m_formatSupported to
 540        TRUE if m_targetRequested is supported.
 541        alsom we have to wait for the "answer" from the
 542        clipboard owner which is an asynchronous process.
 543        therefore we set m_waiting = TRUE here and wait
 544        until the callback "targets_selection_received"
 545        sets it to FALSE */
 546
 547     m_waiting = TRUE;
 548
 549     gtk_selection_convert( m_targetsWidget,
 550                            g_clipboardAtom,
 551                            g_targetsAtom,
 552                            GDK_CURRENT_TIME );
 553
 554     while (m_waiting) gtk_main_iteration();
 555
 556     if (!m_formatSupported) return FALSE;
 557
 558     return TRUE;
 559 }
 560
 561 bool wxClipboard::GetData( wxDataObject *data )
 562 {
 563     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 564
 565     /* is data supported by clipboard ? */
 566
 567     if (!IsSupported( data->GetFormat() )) return FALSE;
 568
 569     /* store pointer to data object to be filled up by callbacks */
 570
 571     m_receivedData = data;
 572
 573     /* store requested format to be asked for by callbacks */
 574
 575     m_targetRequested = data->GetFormat().GetAtom();
 576
 577     wxCHECK_MSG( m_targetRequested, FALSE, _T("invalid clipboard format") );
 578
 579     /* start query */
 580
 581     m_formatSupported = FALSE;
 582
 583     /* ask for clipboard contents.  this will set
 584        m_formatSupported to TRUE if m_targetRequested
 585        is supported.
 586        also, we have to wait for the "answer" from the
 587        clipboard owner which is an asynchronous process.
 588        therefore we set m_waiting = TRUE here and wait
 589        until the callback "targets_selection_received"
 590        sets it to FALSE */
 591
 592     m_waiting = TRUE;
 593
 594     gtk_selection_convert( m_clipboardWidget,
 595                            g_clipboardAtom,
 596                            m_targetRequested,
 597                            GDK_CURRENT_TIME );
 598
 599     while (m_waiting) gtk_main_iteration();
 600
 601     /* this is a true error as we checked for the presence of such data before */
 602
 603     wxCHECK_MSG( m_formatSupported, FALSE, _T("error retrieving data from clipboard") );
 604
 605     return TRUE;
 606 }
 607
 608 //-----------------------------------------------------------------------------
 609 // wxClipboardModule
 610 //-----------------------------------------------------------------------------
 611
 612 IMPLEMENT_DYNAMIC_CLASS(wxClipboardModule,wxModule)
 613
 614 bool wxClipboardModule::OnInit()
 615 {
 616     wxTheClipboard = new wxClipboard();
 617
 618     return TRUE;
 619 }
 620
 621 void wxClipboardModule::OnExit()
 622 {
 623     if (wxTheClipboard) delete wxTheClipboard;
 624     wxTheClipboard = (wxClipboard*) NULL;
 625 }
 626
 627 #endif
 628
 629   // wxUSE_CLIPBOARD
 630