src/motif/clipbrd.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        clipbrd.cpp
   3 // Purpose:     Clipboard functionality
   4 // Author:      Julian Smart
   5 // Modified by: Mattia Barbon (added support for generic wxDataObjects)
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13 #pragma implementation
  14 #pragma implementation "clipbrd.h"
  15 #endif
  16
  17 #include "wx/defs.h"
  18
  19 #if wxUSE_CLIPBOARD
  20
  21 #include "wx/app.h"
  22 #include "wx/bitmap.h"
  23 #include "wx/utils.h"
  24 #include "wx/clipbrd.h"
  25 #include "wx/dataobj.h"
  26 #include "wx/ptr_scpd.h"
  27
  28 #include "wx/listimpl.cpp"
  29 WX_DEFINE_LIST(wxDataObjectList);
  30
  31 #ifdef __VMS__
  32 #pragma message disable nosimpint
  33 #endif
  34 #include <Xm/Xm.h>
  35 #include <Xm/CutPaste.h>
  36 #ifdef __VMS__
  37 #pragma message enable nosimpint
  38 #endif
  39
  40 #include "wx/motif/private.h"
  41
  42 bool wxOpenClipboard()
  43 {
  44     return wxTheClipboard->Open();
  45 }
  46
  47 bool wxCloseClipboard()
  48 {
  49     wxTheClipboard->Close();
  50
  51     return true;
  52 }
  53
  54 bool wxEmptyClipboard()
  55 {
  56     wxTheClipboard->Clear();
  57     return true;
  58 }
  59
  60 bool wxClipboardOpen()
  61 {
  62     return wxTheClipboard->IsOpened();
  63 }
  64
  65 bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat)
  66 {
  67     return wxTheClipboard->IsSupported( dataFormat );
  68 }
  69
  70 bool wxSetClipboardData(wxDataFormat dataFormat, wxObject *obj,
  71                         int WXUNUSED(width), int WXUNUSED(height))
  72 {
  73     wxDataObject* dobj = NULL;
  74
  75     if( dataFormat == wxDF_TEXT )
  76     {
  77         wxChar* data = (wxChar*)obj;
  78         dobj = new wxTextDataObject( data );
  79     }
  80     else if( dataFormat = wxDF_BITMAP )
  81     {
  82         wxBitmap* data = (wxBitmap*)obj;
  83         dobj = new wxBitmapDataObject( *data );
  84     }
  85
  86     if( !dobj )
  87         return false;
  88
  89     return wxTheClipboard->SetData( dobj );
  90 }
  91
  92 wxObject *wxGetClipboardData(wxDataFormat dataFormat, long *len)
  93 {
  94     wxDataObject* dobj = NULL;
  95     wxTextDataObject* tobj = NULL;
  96     wxBitmapDataObject* bobj = NULL;
  97
  98     if( dataFormat == wxDF_TEXT )
  99     {
 100         dobj = tobj = new wxTextDataObject;
 101     }
 102     else if( dataFormat = wxDF_BITMAP )
 103     {
 104         dobj = bobj = new wxBitmapDataObject;
 105     }
 106
 107     if( !dobj || !wxTheClipboard->GetData( *dobj ) )
 108         return NULL;
 109
 110     if( tobj )
 111     {
 112         wxString text = tobj->GetText();
 113         wxChar* buf = new wxChar[text.length() + 1];
 114
 115         if( len ) *len = text.length();
 116         return (wxObject*)wxStrcpy( buf, text.c_str() );
 117     }
 118     else if( bobj )
 119     {
 120         if( len ) *len = 0;
 121         return new wxBitmap( bobj->GetBitmap() );
 122     }
 123
 124     return NULL; // just in case...
 125 }
 126
 127 wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat)
 128 {
 129     // Only wxDF_TEXT supported
 130     if (dataFormat == wxDF_TEXT)
 131        return wxDF_TEXT;
 132     else
 133        return wxDF_INVALID;
 134 }
 135
 136 wxDataFormat wxRegisterClipboardFormat(char *WXUNUSED(formatName))
 137 {
 138     // Not supported
 139     return wxDF_INVALID;
 140 }
 141
 142 bool wxGetClipboardFormatName(wxDataFormat dataFormat, char *formatName,
 143                               int maxCount)
 144 {
 145     wxStrncpy( formatName, dataFormat.GetId().c_str(), maxCount );
 146
 147     return true;
 148 }
 149
 150 //-----------------------------------------------------------------------------
 151 // wxClipboard
 152 //-----------------------------------------------------------------------------
 153
 154 IMPLEMENT_DYNAMIC_CLASS(wxClipboard,wxObject)
 155
 156 wxClipboard::wxClipboard()
 157 {
 158     m_open = false;
 159 }
 160
 161 wxClipboard::~wxClipboard()
 162 {
 163     Clear();
 164 }
 165
 166 void wxClipboard::Clear()
 167 {
 168     wxDataObjectList::Node* node = m_data.GetFirst();
 169     while (node)
 170     {
 171         wxDataObject* data = node->GetData();
 172         delete data;
 173         node = node->GetNext();
 174     }
 175     m_data.Clear();
 176 }
 177
 178 bool wxClipboard::Open()
 179 {
 180     wxCHECK_MSG( !m_open, false, "clipboard already open" );
 181
 182     m_open = true;
 183
 184     return true;
 185 }
 186
 187 bool wxClipboard::SetData( wxDataObject *data )
 188 {
 189     wxCHECK_MSG( data, false, "data is invalid" );
 190     wxCHECK_MSG( m_open, false, "clipboard not open" );
 191
 192     Clear();
 193
 194     return AddData( data );
 195 }
 196
 197 wxDECLARE_SCOPED_ARRAY( wxDataFormat, wxDataFormatScopedArray );
 198 wxDEFINE_SCOPED_ARRAY( wxDataFormat, wxDataFormatScopedArray );
 199
 200 bool wxClipboard::AddData( wxDataObject *data )
 201 {
 202     wxCHECK_MSG( data, false, "data is invalid" );
 203     wxCHECK_MSG( m_open, false, "clipboard not open" );
 204
 205     m_data.Append( data );
 206
 207     Display* xdisplay = wxGlobalDisplay();
 208     Window xwindow = XtWindow( (Widget)wxTheApp->GetTopLevelWidget() );
 209     wxXmString label( wxTheApp->GetAppName() );
 210     Time timestamp = XtLastTimestampProcessed( xdisplay );
 211     long itemId;
 212
 213     int retval;
 214
 215     while( ( retval = XmClipboardStartCopy( xdisplay, xwindow, label(),
 216                                             timestamp, (Widget)NULL,
 217                                             (XmCutPasteProc)NULL,
 218                                             &itemId ) )
 219            == XmClipboardLocked );
 220     if( retval != XmClipboardSuccess )
 221         return false;
 222
 223     size_t count = data->GetFormatCount( wxDataObject::Get );
 224     wxDataFormatScopedArray dfarr( new wxDataFormat[count] );
 225     data->GetAllFormats( dfarr.get(), wxDataObject::Get );
 226
 227     for( size_t i = 0; i < count; ++i )
 228     {
 229         size_t size = data->GetDataSize( dfarr[i] );
 230         wxCharBuffer buffer(size);
 231
 232         if( !data->GetDataHere( dfarr[i], buffer.data() ) )
 233             continue;
 234
 235         wxString id = dfarr[i].GetId();
 236
 237         while( ( retval = XmClipboardCopy( xdisplay, xwindow, itemId,
 238                                            wxConstCast(id.c_str(), char),
 239                                            buffer.data(), size, 0, NULL ) )
 240                == XmClipboardLocked );
 241     }
 242
 243     while( XmClipboardEndCopy( xdisplay, xwindow, itemId )
 244            == XmClipboardLocked );
 245
 246     return true;
 247 }
 248
 249 void wxClipboard::Close()
 250 {
 251     wxCHECK_RET( m_open, "clipboard not open" );
 252
 253     m_open = false;
 254 }
 255
 256 bool wxClipboard::IsSupported(const wxDataFormat& format)
 257 {
 258     Display* xdisplay = wxGlobalDisplay();
 259     Window xwindow = XtWindow( (Widget)wxTheApp->GetTopLevelWidget() );
 260     bool isSupported = false;
 261     int retval, count;
 262     unsigned long  max_name_length;
 263     wxString id = format.GetId();
 264
 265     while( ( retval = XmClipboardLock( xdisplay, xwindow ) )
 266            == XmClipboardLocked );
 267     if( retval != XmClipboardSuccess )
 268         return false;
 269
 270     if( XmClipboardInquireCount( xdisplay, xwindow, &count, &max_name_length )
 271         == XmClipboardSuccess )
 272     {
 273         wxCharBuffer buf( max_name_length + 1 );
 274         unsigned long copied;
 275
 276         for( int i = 0; i < count; ++i )
 277         {
 278             if( XmClipboardInquireFormat( xdisplay, xwindow, i + 1,
 279                                           (XtPointer)buf.data(),
 280                                           max_name_length, &copied )
 281                 != XmClipboardSuccess )
 282                 continue;
 283
 284             buf.data()[copied] = '\0';
 285
 286             if( buf == id )
 287             {
 288                 isSupported = true;
 289                 break;
 290             }
 291         }
 292     }
 293
 294     XmClipboardUnlock( xdisplay, xwindow, False );
 295
 296     return isSupported;
 297 }
 298
 299 class wxClipboardEndRetrieve
 300 {
 301 public:
 302     wxClipboardEndRetrieve( Display* display, Window window )
 303         : m_display( display ), m_window( window ) { }
 304     ~wxClipboardEndRetrieve()
 305     {
 306         while( XmClipboardEndRetrieve( m_display, m_window )
 307                == XmClipboardLocked );
 308     }
 309 private:
 310     Display* m_display;
 311     Window m_window;
 312 };
 313
 314 bool wxClipboard::GetData( wxDataObject& data )
 315 {
 316     wxCHECK_MSG( m_open, false, "clipboard not open" );
 317
 318     Display* xdisplay = wxGlobalDisplay();
 319     Window xwindow = XtWindow( (Widget)wxTheApp->GetTopLevelWidget() );
 320     Time timestamp = XtLastTimestampProcessed( xdisplay );
 321
 322     wxDataFormat chosenFormat;
 323     int retval;
 324
 325     ///////////////////////////////////////////////////////////////////////////
 326     // determine if the cliboard holds any format we like
 327     ///////////////////////////////////////////////////////////////////////////
 328     while( ( retval = XmClipboardStartRetrieve( xdisplay, xwindow,
 329                                                 timestamp ) )
 330            == XmClipboardLocked );
 331     if( retval != XmClipboardSuccess )
 332         return false;
 333
 334     wxClipboardEndRetrieve endRetrieve( xdisplay, xwindow );
 335
 336     int count;
 337     unsigned long max_name_length;
 338     size_t dfcount = data.GetFormatCount( wxDataObject::Set );
 339     wxDataFormatScopedArray dfarr( new wxDataFormat[dfcount] );
 340     data.GetAllFormats( dfarr.get(), wxDataObject::Set );
 341
 342     if( XmClipboardInquireCount( xdisplay, xwindow, &count, &max_name_length )
 343         == XmClipboardSuccess )
 344     {
 345         wxCharBuffer buf( max_name_length + 1 );
 346         unsigned long copied;
 347
 348         for( int i = 0; i < count; ++i )
 349         {
 350             if( XmClipboardInquireFormat( xdisplay, xwindow, i + 1,
 351                                           (XtPointer)buf.data(),
 352                                           max_name_length, &copied )
 353                 != XmClipboardSuccess )
 354                 continue;
 355
 356             buf.data()[copied] = '\0';
 357
 358             // try preferred format
 359             if( buf == data.GetPreferredFormat( wxDataObject::Set ).GetId() )
 360             {
 361                 chosenFormat = data.GetPreferredFormat( wxDataObject::Set );
 362                 break;
 363             }
 364
 365             // try all other formats
 366             for( size_t i = 0; i < dfcount; ++i )
 367             {
 368                 if( buf == dfarr[i].GetId() )
 369                     chosenFormat = dfarr[i];
 370             }
 371         }
 372     }
 373
 374     if( chosenFormat == wxDF_INVALID )
 375         return false;
 376
 377     ///////////////////////////////////////////////////////////////////////////
 378     // now retrieve the data
 379     ///////////////////////////////////////////////////////////////////////////
 380     unsigned long length, dummy1;
 381     long dummy2;
 382     wxString id = chosenFormat.GetId();
 383
 384     while( ( retval = XmClipboardInquireLength( xdisplay, xwindow,
 385                                                 wxConstCast(id.c_str(), char),
 386                                                 &length ) )
 387            == XmClipboardLocked );
 388     if( retval != XmClipboardSuccess )
 389         return false;
 390
 391     wxCharBuffer buf(length);
 392
 393     while( ( retval = XmClipboardRetrieve( xdisplay, xwindow,
 394                                            wxConstCast(id.c_str(), char),
 395                                            (XtPointer)buf.data(),
 396                                            length, &dummy1, &dummy2 ) )
 397            == XmClipboardLocked );
 398     if( retval != XmClipboardSuccess )
 399         return false;
 400
 401     if( !data.SetData( chosenFormat, length, buf.data() ) )
 402         return false;
 403
 404     return true;
 405 }
 406
 407 #endif // wxUSE_CLIPBOARD