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