src/gtk/dataobj.cpp

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