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     m_usePrimary = FALSE;
 375 }
 376
 377 wxClipboard::~wxClipboard()
 378 {
 379     Clear();
 380
 381     if (m_clipboardWidget) gtk_widget_destroy( m_clipboardWidget );
 382     if (m_targetsWidget) gtk_widget_destroy( m_targetsWidget );
 383 }
 384
 385 void wxClipboard::Clear()
 386 {
 387     if (m_dataBroker)
 388     {
 389         /*  As we have data we also own the clipboard. Once we no longer own
 390             it, clear_selection is called which will set m_data to zero */
 391
 392         if (gdk_selection_owner_get( g_clipboardAtom ) == m_clipboardWidget->window)
 393         {
 394             m_waiting = TRUE;
 395
 396             gtk_selection_owner_set( (GtkWidget*) NULL, g_clipboardAtom, GDK_CURRENT_TIME );
 397
 398             while (m_waiting) gtk_main_iteration();
 399         }
 400
 401         if (gdk_selection_owner_get( GDK_SELECTION_PRIMARY ) == m_clipboardWidget->window)
 402         {
 403             m_waiting = TRUE;
 404
 405             gtk_selection_owner_set( (GtkWidget*) NULL, GDK_SELECTION_PRIMARY, GDK_CURRENT_TIME );
 406
 407             while (m_waiting) gtk_main_iteration();
 408         }
 409
 410         if (m_dataBroker)
 411         {
 412             delete m_dataBroker;
 413             m_dataBroker = (wxDataBroker*) NULL;
 414         }
 415     }
 416
 417     m_targetRequested = 0;
 418
 419     m_formatSupported = FALSE;
 420 }
 421
 422 bool wxClipboard::Open()
 423 {
 424     wxCHECK_MSG( !m_open, FALSE, _T("clipboard already open") );
 425
 426     m_open = TRUE;
 427
 428     return TRUE;
 429 }
 430
 431 bool wxClipboard::SetData( wxDataObject *data )
 432 {
 433     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 434
 435     wxCHECK_MSG( data, FALSE, _T("data is invalid") );
 436
 437     Clear();
 438
 439     return AddData( data );
 440 }
 441
 442 bool wxClipboard::AddData( wxDataObject *data )
 443 {
 444     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 445
 446     wxCHECK_MSG( data, FALSE, _T("data is invalid") );
 447
 448     /* if clipboard has been cleared before, create new data broker */
 449     if (!m_dataBroker) m_dataBroker = new wxDataBroker();
 450
 451     /* add new data to list of offered data objects */
 452     m_dataBroker->Add( data );
 453
 454     /* get native format id of new data object */
 455     GdkAtom format = data->GetFormat().GetAtom();
 456
 457     wxCHECK_MSG( format, FALSE, _T("data has invalid format") );
 458
 459     /* This should happen automatically, but to be on the safe side */
 460     m_ownsClipboard = FALSE;
 461     m_ownsPrimarySelection = FALSE;
 462
 463     /* Add handlers if someone requests data */
 464
 465 #if (GTK_MINOR_VERSION > 0)
 466
 467     gtk_selection_add_target( GTK_WIDGET(m_clipboardWidget),
 468                               GDK_SELECTION_PRIMARY,
 469                               format,
 470                               0 );  /* what is info ? */
 471
 472     gtk_selection_add_target( GTK_WIDGET(m_clipboardWidget),
 473                               g_clipboardAtom,
 474                               format,
 475                               0 );  /* what is info ? */
 476
 477     gtk_signal_connect( GTK_OBJECT(m_clipboardWidget),
 478                         "selection_get",
 479                         GTK_SIGNAL_FUNC(selection_handler),
 480                         (gpointer) NULL );
 481
 482 #else
 483
 484     gtk_selection_add_handler( m_clipboardWidget,
 485                                g_clipboardAtom,
 486                                format,
 487                                selection_handler,
 488                                (gpointer) NULL );
 489
 490     gtk_selection_add_handler( m_clipboardWidget,
 491                                GDK_SELECTION_PRIMARY,
 492                                format,
 493                                selection_handler,
 494                                (gpointer) NULL );
 495 #endif
 496
 497     /* Tell the world we offer clipboard data */
 498     if (!gtk_selection_owner_set( m_clipboardWidget,
 499                                   g_clipboardAtom,
 500                                   GDK_CURRENT_TIME ))
 501     {
 502         return FALSE;
 503     }
 504     m_ownsClipboard = TRUE;
 505
 506     if (!gtk_selection_owner_set( m_clipboardWidget,
 507                                   GDK_SELECTION_PRIMARY,
 508                                   GDK_CURRENT_TIME ))
 509     {
 510         return FALSE;
 511     }
 512     m_ownsPrimarySelection = TRUE;
 513
 514     return TRUE;
 515 }
 516
 517 void wxClipboard::Close()
 518 {
 519     wxCHECK_RET( m_open, _T("clipboard not open") );
 520
 521     m_open = FALSE;
 522 }
 523
 524 bool wxClipboard::IsSupported( wxDataFormat format )
 525 {
 526     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 527
 528     /* store requested format to be asked for by callbacks */
 529
 530     m_targetRequested = format.GetAtom();
 531
 532     wxCHECK_MSG( m_targetRequested, FALSE, _T("invalid clipboard format") );
 533
 534     m_formatSupported = FALSE;
 535
 536     /* perform query. this will set m_formatSupported to
 537        TRUE if m_targetRequested is supported.
 538        alsom we have to wait for the "answer" from the
 539        clipboard owner which is an asynchronous process.
 540        therefore we set m_waiting = TRUE here and wait
 541        until the callback "targets_selection_received"
 542        sets it to FALSE */
 543
 544     m_waiting = TRUE;
 545
 546     gtk_selection_convert( m_targetsWidget,
 547                            m_usePrimary?GDK_SELECTION_PRIMARY:g_clipboardAtom,
 548                            g_targetsAtom,
 549                            GDK_CURRENT_TIME );
 550
 551     while (m_waiting) gtk_main_iteration();
 552
 553     if (!m_formatSupported) return FALSE;
 554
 555     return TRUE;
 556 }
 557
 558 bool wxClipboard::GetData( wxDataObject *data )
 559 {
 560     wxCHECK_MSG( m_open, FALSE, _T("clipboard not open") );
 561
 562     /* is data supported by clipboard ? */
 563
 564     if (!IsSupported( data->GetFormat() )) return FALSE;
 565
 566     /* store pointer to data object to be filled up by callbacks */
 567
 568     m_receivedData = data;
 569
 570     /* store requested format to be asked for by callbacks */
 571
 572     m_targetRequested = data->GetFormat().GetAtom();
 573
 574     wxCHECK_MSG( m_targetRequested, FALSE, _T("invalid clipboard format") );
 575
 576     /* start query */
 577
 578     m_formatSupported = FALSE;
 579
 580     /* ask for clipboard contents.  this will set
 581        m_formatSupported to TRUE if m_targetRequested
 582        is supported.
 583        also, we have to wait for the "answer" from the
 584        clipboard owner which is an asynchronous process.
 585        therefore we set m_waiting = TRUE here and wait
 586        until the callback "targets_selection_received"
 587        sets it to FALSE */
 588
 589     m_waiting = TRUE;
 590
 591     gtk_selection_convert( m_clipboardWidget,
 592                            m_usePrimary?GDK_SELECTION_PRIMARY:g_clipboardAtom,
 593                            m_targetRequested,
 594                            GDK_CURRENT_TIME );
 595
 596     while (m_waiting) gtk_main_iteration();
 597
 598     /* this is a true error as we checked for the presence of such data before */
 599
 600     wxCHECK_MSG( m_formatSupported, FALSE, _T("error retrieving data from clipboard") );
 601
 602     return TRUE;
 603 }
 604
 605 //-----------------------------------------------------------------------------
 606 // wxClipboardModule
 607 //-----------------------------------------------------------------------------
 608
 609 IMPLEMENT_DYNAMIC_CLASS(wxClipboardModule,wxModule)
 610
 611 bool wxClipboardModule::OnInit()
 612 {
 613     wxTheClipboard = new wxClipboard();
 614
 615     return TRUE;
 616 }
 617
 618 void wxClipboardModule::OnExit()
 619 {
 620     if (wxTheClipboard) delete wxTheClipboard;
 621     wxTheClipboard = (wxClipboard*) NULL;
 622 }
 623
 624 #endif
 625
 626   // wxUSE_CLIPBOARD
 627