src/gtk/dataobj.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/dataobj.cpp
   3 // Purpose:     wxDataObject class
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #if wxUSE_DATAOBJ
  14
  15 #include "wx/dataobj.h"
  16
  17 #ifndef WX_PRECOMP
  18     #include "wx/log.h"
  19     #include "wx/app.h"
  20     #include "wx/image.h"
  21 #endif
  22
  23 #include "wx/mstream.h"
  24 #include "wx/uri.h"
  25
  26 #include "wx/gtk/private.h"
  27
  28 //-------------------------------------------------------------------------
  29 // global data
  30 //-------------------------------------------------------------------------
  31
  32 GdkAtom  g_textAtom        = 0;
  33 GdkAtom  g_altTextAtom     = 0;
  34 GdkAtom  g_pngAtom         = 0;
  35 GdkAtom  g_fileAtom        = 0;
  36
  37 //-------------------------------------------------------------------------
  38 // wxDataFormat
  39 //-------------------------------------------------------------------------
  40
  41 wxDataFormat::wxDataFormat()
  42 {
  43     // do *not* call PrepareFormats() from here for 2 reasons:
  44     //
  45     // 1. we will have time to do it later because some other Set function
  46     //    must be called before we really need them
  47     //
  48     // 2. doing so prevents us from declaring global wxDataFormats because
  49     //    calling PrepareFormats (and thus gdk_atom_intern) before GDK is
  50     //    initialised will result in a crash
  51     m_type = wxDF_INVALID;
  52     m_format = (GdkAtom) 0;
  53 }
  54
  55 wxDataFormat::wxDataFormat( wxDataFormatId type )
  56 {
  57     PrepareFormats();
  58     SetType( type );
  59 }
  60
  61 wxDataFormat::wxDataFormat( const wxChar *id )
  62 {
  63     PrepareFormats();
  64     SetId( id );
  65 }
  66
  67 wxDataFormat::wxDataFormat( const wxString &id )
  68 {
  69     PrepareFormats();
  70     SetId( id );
  71 }
  72
  73 wxDataFormat::wxDataFormat( NativeFormat format )
  74 {
  75     PrepareFormats();
  76     SetId( format );
  77 }
  78
  79 void wxDataFormat::SetType( wxDataFormatId type )
  80 {
  81     PrepareFormats();
  82
  83     m_type = type;
  84
  85 #if wxUSE_UNICODE
  86     if (m_type == wxDF_UNICODETEXT)
  87         m_format = g_textAtom;
  88     else if (m_type == wxDF_TEXT)
  89         m_format = g_altTextAtom;
  90 #else
  91     if (m_type == wxDF_TEXT || m_type == wxDF_UNICODETEXT)
  92         m_format = g_textAtom;
  93 #endif
  94     else
  95     if (m_type == wxDF_BITMAP)
  96         m_format = g_pngAtom;
  97     else
  98     if (m_type == wxDF_FILENAME)
  99         m_format = g_fileAtom;
 100     else
 101     {
 102        wxFAIL_MSG( wxT("invalid dataformat") );
 103     }
 104 }
 105
 106 wxDataFormatId wxDataFormat::GetType() const
 107 {
 108     return m_type;
 109 }
 110
 111 wxString wxDataFormat::GetId() const
 112 {
 113     wxGtkString atom_name(gdk_atom_name(m_format));
 114     return wxString::FromAscii(atom_name);
 115 }
 116
 117 void wxDataFormat::SetId( NativeFormat format )
 118 {
 119     PrepareFormats();
 120     m_format = format;
 121
 122     if (m_format == g_textAtom)
 123 #if wxUSE_UNICODE
 124         m_type = wxDF_UNICODETEXT;
 125 #else
 126         m_type = wxDF_TEXT;
 127 #endif
 128     else
 129     if (m_format == g_altTextAtom)
 130         m_type = wxDF_TEXT;
 131     else
 132     if (m_format == g_pngAtom)
 133         m_type = wxDF_BITMAP;
 134     else
 135     if (m_format == g_fileAtom)
 136         m_type = wxDF_FILENAME;
 137     else
 138         m_type = wxDF_PRIVATE;
 139 }
 140
 141 void wxDataFormat::SetId( const wxChar *id )
 142 {
 143     PrepareFormats();
 144     m_type = wxDF_PRIVATE;
 145     wxString tmp( id );
 146     m_format = gdk_atom_intern( (const char*) tmp.ToAscii(), FALSE );
 147 }
 148
 149 void wxDataFormat::PrepareFormats()
 150 {
 151     // VZ: GNOME included in RedHat 6.1 uses the MIME types below and not the
 152     //     atoms STRING and file:ALL as the old code was, but normal X apps
 153     //     use STRING for text selection when transfering the data via
 154     //     clipboard, for example, so do use STRING for now (GNOME apps will
 155     //     probably support STRING as well for compatibility anyhow), but use
 156     //     text/uri-list for file dnd because compatibility is not important
 157     //     here (with whom?)
 158     if (!g_textAtom)
 159 #if wxUSE_UNICODE
 160         g_textAtom = gdk_atom_intern( "UTF8_STRING", FALSE );
 161         g_altTextAtom = gdk_atom_intern( "STRING", FALSE );
 162 #else
 163         g_textAtom = gdk_atom_intern( "STRING" /* "text/plain" */, FALSE );
 164 #endif
 165     if (!g_pngAtom)
 166         g_pngAtom = gdk_atom_intern( "image/png", FALSE );
 167     if (!g_fileAtom)
 168         g_fileAtom = gdk_atom_intern( "text/uri-list", FALSE );
 169 }
 170
 171 //-------------------------------------------------------------------------
 172 // wxDataObject
 173 //-------------------------------------------------------------------------
 174
 175 wxDataObject::wxDataObject()
 176 {
 177 }
 178
 179 wxDataObject::~wxDataObject()
 180 {
 181     // dtor is empty but needed for Darwin and AIX -- otherwise it doesn't link
 182 }
 183
 184 bool wxDataObject::IsSupportedFormat(const wxDataFormat& format, Direction dir) const
 185 {
 186     size_t nFormatCount = GetFormatCount(dir);
 187     if ( nFormatCount == 1 )
 188     {
 189         return format == GetPreferredFormat();
 190     }
 191     else
 192     {
 193         wxDataFormat *formats = new wxDataFormat[nFormatCount];
 194         GetAllFormats(formats,dir);
 195
 196         size_t n;
 197         for ( n = 0; n < nFormatCount; n++ )
 198         {
 199             if ( formats[n] == format )
 200                 break;
 201         }
 202
 203         delete [] formats;
 204
 205         // found?
 206         return n < nFormatCount;
 207     }
 208 }
 209
 210 // ----------------------------------------------------------------------------
 211 // wxTextDataObject
 212 // ----------------------------------------------------------------------------
 213
 214 #if defined(__WXGTK20__) && wxUSE_UNICODE
 215 void wxTextDataObject::GetAllFormats(wxDataFormat *formats, wxDataObjectBase::Direction dir) const
 216 {
 217     *formats++ = GetPreferredFormat();
 218     *formats = g_altTextAtom;
 219 }
 220 #endif
 221
 222 // ----------------------------------------------------------------------------
 223 // wxFileDataObject
 224 // ----------------------------------------------------------------------------
 225
 226 bool wxFileDataObject::GetDataHere(void *buf) const
 227 {
 228     wxString filenames;
 229
 230     for (size_t i = 0; i < m_filenames.GetCount(); i++)
 231     {
 232         filenames += wxT("file:");
 233         filenames += m_filenames[i];
 234         filenames += wxT("\r\n");
 235     }
 236
 237     memcpy( buf, filenames.mbc_str(), filenames.length() + 1 );
 238
 239     return true;
 240 }
 241
 242 size_t wxFileDataObject::GetDataSize() const
 243 {
 244     size_t res = 0;
 245
 246     for (size_t i = 0; i < m_filenames.GetCount(); i++)
 247     {
 248         // This is junk in UTF-8
 249         res += m_filenames[i].length();
 250         res += 5 + 2; // "file:" (5) + "\r\n" (2)
 251     }
 252
 253     return res + 1;
 254 }
 255
 256 bool wxFileDataObject::SetData(size_t WXUNUSED(size), const void *buf)
 257 {
 258     m_filenames.Empty();
 259
 260     // we get data in the text/uri-list format, i.e. as a sequence of URIs
 261     // (filenames prefixed by "file:") delimited by "\r\n"
 262     wxString filename;
 263     for ( const char *p = (const char *)buf; ; p++ )
 264     {
 265         // some broken programs (testdnd GTK+ sample!) omit the trailing
 266         // "\r\n", so check for '\0' explicitly here instead of doing it in
 267         // the loop statement to account for it
 268         if ( (*p == '\r' && *(p+1) == '\n') || !*p )
 269         {
 270             size_t lenPrefix = 5; // strlen("file:")
 271             if ( filename.Left(lenPrefix).MakeLower() == _T("file:") )
 272             {
 273                 // sometimes the syntax is "file:filename", sometimes it's
 274                 // URL-like: "file://filename" - deal with both
 275                 if ( filename[lenPrefix] == _T('/') &&
 276                      filename[lenPrefix + 1] == _T('/') )
 277                 {
 278                     // skip the slashes
 279                     lenPrefix += 2;
 280                 }
 281
 282                 // It would probably be nicer to use a GTK or Glib
 283                 // function to unescape the 8-bit strings pointed to
 284                 // by buf, but this does the same in wx code.
 285                 wxString filename_unicode = wxURI::Unescape(filename.c_str() + lenPrefix);
 286                 wxCharBuffer filename_8bit = wxConvISO8859_1.cWX2MB( filename_unicode );
 287                 filename_unicode = wxConvFileName->cMB2WX( filename_8bit );
 288                 AddFile( filename_unicode );
 289                 filename.Empty();
 290             }
 291             else if ( !filename.empty() )
 292             {
 293                 wxLogDebug(_T("Unsupported URI \"%s\" in wxFileDataObject"),
 294                            filename.c_str());
 295             }
 296
 297             if ( !*p )
 298                 break;
 299
 300             // skip '\r'
 301             p++;
 302         }
 303         else
 304         {
 305             // The string is in ISO-8859-1 according to XDND spec
 306             filename += *p;
 307         }
 308     }
 309
 310     return true;
 311 }
 312
 313 void wxFileDataObject::AddFile( const wxString &filename )
 314 {
 315    m_filenames.Add( filename );
 316 }
 317
 318 // ----------------------------------------------------------------------------
 319 // wxBitmapDataObject
 320 // ----------------------------------------------------------------------------
 321
 322 wxBitmapDataObject::wxBitmapDataObject()
 323 {
 324     Init();
 325 }
 326
 327 wxBitmapDataObject::wxBitmapDataObject( const wxBitmap& bitmap )
 328                   : wxBitmapDataObjectBase(bitmap)
 329 {
 330     Init();
 331
 332     DoConvertToPng();
 333 }
 334
 335 wxBitmapDataObject::~wxBitmapDataObject()
 336 {
 337     Clear();
 338 }
 339
 340 void wxBitmapDataObject::SetBitmap( const wxBitmap &bitmap )
 341 {
 342     ClearAll();
 343
 344     wxBitmapDataObjectBase::SetBitmap(bitmap);
 345
 346     DoConvertToPng();
 347 }
 348
 349 bool wxBitmapDataObject::GetDataHere(void *buf) const
 350 {
 351     if ( !m_pngSize )
 352     {
 353         wxFAIL_MSG( wxT("attempt to copy empty bitmap failed") );
 354
 355         return false;
 356     }
 357
 358     memcpy(buf, m_pngData, m_pngSize);
 359
 360     return true;
 361 }
 362
 363 bool wxBitmapDataObject::SetData(size_t size, const void *buf)
 364 {
 365     Clear();
 366
 367     wxCHECK_MSG( wxImage::FindHandler(wxBITMAP_TYPE_PNG) != NULL,
 368                  false, wxT("You must call wxImage::AddHandler(new wxPNGHandler); to be able to use clipboard with bitmaps!") );
 369
 370     m_pngSize = size;
 371     m_pngData = malloc(m_pngSize);
 372
 373     memcpy(m_pngData, buf, m_pngSize);
 374
 375     wxMemoryInputStream mstream((char*) m_pngData, m_pngSize);
 376     wxImage image;
 377     if ( !image.LoadFile( mstream, wxBITMAP_TYPE_PNG ) )
 378     {
 379         return false;
 380     }
 381
 382     m_bitmap = wxBitmap(image);
 383
 384     return m_bitmap.Ok();
 385 }
 386
 387 void wxBitmapDataObject::DoConvertToPng()
 388 {
 389     if ( !m_bitmap.Ok() )
 390         return;
 391
 392     wxCHECK_RET( wxImage::FindHandler(wxBITMAP_TYPE_PNG) != NULL,
 393                  wxT("You must call wxImage::AddHandler(new wxPNGHandler); to be able to use clipboard with bitmaps!") );
 394
 395     wxImage image = m_bitmap.ConvertToImage();
 396
 397     wxCountingOutputStream count;
 398     image.SaveFile(count, wxBITMAP_TYPE_PNG);
 399
 400     m_pngSize = count.GetSize() + 100; // sometimes the size seems to vary ???
 401     m_pngData = malloc(m_pngSize);
 402
 403     wxMemoryOutputStream mstream((char*) m_pngData, m_pngSize);
 404     image.SaveFile(mstream, wxBITMAP_TYPE_PNG);
 405 }
 406
 407 #endif // wxUSE_DATAOBJ