X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b527aac54a829ba2ad77d8fb8609cd54eb8ef5d7..ee3510132b8b4160f848bd4f502a6f5315f90dbc:/src/gtk1/clipbrd.cpp diff --git a/src/gtk1/clipbrd.cpp b/src/gtk1/clipbrd.cpp index 1ab6f2c545..c6edc527b1 100644 --- a/src/gtk1/clipbrd.cpp +++ b/src/gtk1/clipbrd.cpp @@ -1,10 +1,10 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: clipbrd.cpp +// Name: gtk/clipbrd.cpp // Purpose: // Author: Robert Roebling // Id: $Id$ // Copyright: (c) 1998 Robert Roebling -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifdef __GNUG__ @@ -13,22 +13,41 @@ #include "wx/clipbrd.h" +#if wxUSE_CLIPBOARD + +#include "wx/dataobj.h" +#include "wx/utils.h" +#include "wx/log.h" + +#include +#include +#include + //----------------------------------------------------------------------------- -// data +// thread system //----------------------------------------------------------------------------- -wxClipboard *wxTheClipboard = (wxClipboard*) NULL; +#if wxUSE_THREADS +#endif + +//----------------------------------------------------------------------------- +// data +//----------------------------------------------------------------------------- -GdkAtom g_textAtom = 0; GdkAtom g_clipboardAtom = 0; GdkAtom g_targetsAtom = 0; +// the trace mask we use with wxLogTrace() - call +// wxLog::AddTraceMask(TRACE_CLIPBOARD) to enable the trace messages from here +// (there will be a *lot* of them!) +static const wxChar *TRACE_CLIPBOARD = _T("clipboard"); + //----------------------------------------------------------------------------- // reminder //----------------------------------------------------------------------------- /* The contents of a selection are returned in a GtkSelectionData - structure. selection/target identify the request. + structure. selection/target identify the request. type specifies the type of the return; if length < 0, and the data should be ignored. This structure has object semantics - no fields should be modified directly, they should not be created @@ -41,9 +60,9 @@ struct _GtkSelectionData GdkAtom selection; GdkAtom target; GdkAtom type; - gint format; + gint format; guchar *data; - gint length; + gint length; }; */ @@ -53,55 +72,112 @@ struct _GtkSelectionData //----------------------------------------------------------------------------- static void -targets_selection_received( GtkWidget *WXUNUSED(widget), - GtkSelectionData *selection_data, - wxClipboard *clipboard ) +targets_selection_received( GtkWidget *WXUNUSED(widget), + GtkSelectionData *selection_data, +#if (GTK_MINOR_VERSION > 0) + guint32 WXUNUSED(time), +#endif + wxClipboard *clipboard ) { - if (!wxTheClipboard) return; - - if (selection_data->length <= 0) return; - - // make sure we got the data in the correct form - if (selection_data->type != GDK_SELECTION_TYPE_ATOM) return; - - // the atoms we received, holding a list of targets (= formats) - GdkAtom *atoms = (GdkAtom *)selection_data->data; - - for (unsigned int i=0; ilength/sizeof(GdkAtom); i++) - { - if (atoms[i] == clipboard->m_targetRequested) - { - clipboard->m_formatSupported = TRUE; - return; - } - } - - return; + if ( wxTheClipboard && selection_data->length > 0 ) + { + /* make sure we got the data in the correct form */ + GdkAtom type = selection_data->type; + if ( type != GDK_SELECTION_TYPE_ATOM ) + { + if ( strcmp(gdk_atom_name(type), "TARGETS") ) + { + wxLogTrace( TRACE_CLIPBOARD, + _T("got unsupported clipboard target") ); + + clipboard->m_waiting = FALSE; + return; + } + } + +#ifdef __WXDEBUG__ + wxDataFormat clip( selection_data->selection ); + wxLogTrace( TRACE_CLIPBOARD, + wxT("selection received for targets, clipboard %s"), + clip.GetId().c_str() ); +#endif // __WXDEBUG__ + + // the atoms we received, holding a list of targets (= formats) + GdkAtom *atoms = (GdkAtom *)selection_data->data; + + for (unsigned int i=0; ilength/sizeof(GdkAtom); i++) + { + wxDataFormat format( atoms[i] ); + + wxLogTrace( TRACE_CLIPBOARD, + wxT("selection received for targets, format %s"), + format.GetId().c_str() ); + + if (format == clipboard->m_targetRequested) + { + clipboard->m_waiting = FALSE; + clipboard->m_formatSupported = TRUE; + return; + } + } + } + + clipboard->m_waiting = FALSE; } //----------------------------------------------------------------------------- // "selection_received" for the actual data //----------------------------------------------------------------------------- -static void -selection_received( GtkWidget *WXUNUSED(widget), - GtkSelectionData *selection_data, - wxClipboard *clipboard ) +static void +selection_received( GtkWidget *WXUNUSED(widget), + GtkSelectionData *selection_data, +#if (GTK_MINOR_VERSION > 0) + guint32 WXUNUSED(time), +#endif + wxClipboard *clipboard ) { - if (!wxTheClipboard) return; - - if (selection_data->length <= 0) return; - - size_t size = (size_t) selection_data->length; - - // make sure we got the data in the correct form - if (selection_data->type != GDK_SELECTION_TYPE_STRING) return; - - clipboard->m_receivedSize = size; - - clipboard->m_receivedData = new char[size+1]; - - memcpy( clipboard->m_receivedData, selection_data->data, size); + if (!wxTheClipboard) + { + clipboard->m_waiting = FALSE; + return; + } + + wxDataObject *data_object = clipboard->m_receivedData; + + if (!data_object) + { + clipboard->m_waiting = FALSE; + return; + } + + if (selection_data->length <= 0) + { + clipboard->m_waiting = FALSE; + return; + } + + wxDataFormat format( selection_data->target ); + + /* make sure we got the data in the correct format */ + if (!data_object->IsSupportedFormat( format ) ) + { + clipboard->m_waiting = FALSE; + return; + } + + /* make sure we got the data in the correct form (selection type). + if so, copy data to target object */ + if (selection_data->type != GDK_SELECTION_TYPE_STRING) + { + clipboard->m_waiting = FALSE; + return; + } + + data_object->SetData( format, (size_t) selection_data->length, (const char*) selection_data->data ); + + wxTheClipboard->m_formatSupported = TRUE; + clipboard->m_waiting = FALSE; } //----------------------------------------------------------------------------- @@ -109,16 +185,40 @@ selection_received( GtkWidget *WXUNUSED(widget), //----------------------------------------------------------------------------- static gint -selection_clear( GtkWidget *WXUNUSED(widget), GdkEventSelection *WXUNUSED(event) ) +selection_clear_clip( GtkWidget *WXUNUSED(widget), GdkEventSelection *event ) { - if (!wxTheClipboard) return TRUE; - - /* the clipboard is no longer in our hands. we can delete the - * clipboard data. I hope I got that one right... */ - - wxTheClipboard->SetData( (wxDataObject*) NULL ); - - return TRUE; + if (!wxTheClipboard) return TRUE; + + if (event->selection == GDK_SELECTION_PRIMARY) + { + wxTheClipboard->m_ownsPrimarySelection = FALSE; + } + else + if (event->selection == g_clipboardAtom) + { + wxTheClipboard->m_ownsClipboard = FALSE; + } + else + { + wxTheClipboard->m_waiting = FALSE; + return FALSE; + } + + if ((!wxTheClipboard->m_ownsPrimarySelection) && + (!wxTheClipboard->m_ownsClipboard)) + { + /* the clipboard is no longer in our hands. we can the delete clipboard data. */ + if (wxTheClipboard->m_data) + { + wxLogTrace(TRACE_CLIPBOARD, wxT("wxClipboard will get cleared" )); + + delete wxTheClipboard->m_data; + wxTheClipboard->m_data = (wxDataObject*) NULL; + } + } + + wxTheClipboard->m_waiting = FALSE; + return TRUE; } //----------------------------------------------------------------------------- @@ -126,31 +226,53 @@ selection_clear( GtkWidget *WXUNUSED(widget), GdkEventSelection *WXUNUSED(event) //----------------------------------------------------------------------------- static void -selection_handler( GtkWidget *WXUNUSED(widget), GtkSelectionData *selection_data, gpointer WXUNUSED(data) ) +selection_handler( GtkWidget *WXUNUSED(widget), + GtkSelectionData *selection_data, + guint WXUNUSED(info), + guint WXUNUSED(time), + gpointer WXUNUSED(data) ) { - if (!wxTheClipboard) return; - - wxDataObject *data_object = wxTheClipboard->m_data; - - if (!data_object) return; - - if (data_object->GetDataSize() == 0) return; - - gint len = data_object->GetDataSize(); - guchar *bin_data = (guchar*) malloc( len ); - data_object->GetDataHere( (void*)bin_data ); - - if (selection_data->target == GDK_SELECTION_TYPE_STRING) - { - gtk_selection_data_set( - selection_data, GDK_SELECTION_TYPE_STRING, 8*sizeof(gchar), bin_data, len ); - } - else if (selection_data->target == g_textAtom) - { - gtk_selection_data_set( - selection_data, g_textAtom, 8*sizeof(gchar), bin_data, len ); - } - free( bin_data ); + if (!wxTheClipboard) return; + + if (!wxTheClipboard->m_data) return; + + wxDataObject *data = wxTheClipboard->m_data; + + wxDataFormat format( selection_data->target ); + + if (!data->IsSupportedFormat( format )) return; + + int size = data->GetDataSize( format ); + + if (size == 0) return; + + void *d = malloc(size); + + data->GetDataHere( selection_data->target, d ); + + // transform Unicode text into multibyte before putting it on clipboard +#if wxUSE_UNICODE + if ( format.GetType() == wxDF_TEXT ) + { + const wchar_t *wstr = (const wchar_t *)d; + size_t len = wxConvCurrent->WC2MB(NULL, wstr, 0); + char *str = malloc(len + 1); + wxConvCurrent->WC2MB(str, wstr, len); + str[len] = '\0'; + + free(d); + d = str; + } +#endif // wxUSE_UNICODE + + gtk_selection_data_set( + selection_data, + GDK_SELECTION_TYPE_STRING, + 8*sizeof(gchar), + (unsigned char*) d, + size ); + + free(d); } //----------------------------------------------------------------------------- @@ -161,182 +283,328 @@ IMPLEMENT_DYNAMIC_CLASS(wxClipboard,wxObject) wxClipboard::wxClipboard() { - m_data = (wxDataObject*) NULL; - m_clipboardWidget = gtk_window_new( GTK_WINDOW_POPUP ); - gtk_widget_realize( m_clipboardWidget ); - - gtk_signal_connect( GTK_OBJECT(m_clipboardWidget), - "selection_clear_event", - GTK_SIGNAL_FUNC( selection_clear ), - (gpointer) NULL ); - - if (!g_clipboardAtom) g_clipboardAtom = gdk_atom_intern( "CLIPBOARD", FALSE ); - if (!g_textAtom) g_textAtom = gdk_atom_intern( "TEXT", FALSE ); - if (!g_targetsAtom) g_targetsAtom = gdk_atom_intern ("TARGETS", FALSE); - - m_receivedData = (char*)NULL; - m_receivedSize = 0; - m_formatSupported = FALSE; - m_targetRequested = 0; + m_open = FALSE; + + m_ownsClipboard = FALSE; + m_ownsPrimarySelection = FALSE; + + m_data = (wxDataObject*) NULL; + m_receivedData = (wxDataObject*) NULL; + + /* we use m_targetsWidget to query what formats are available */ + + m_targetsWidget = gtk_window_new( GTK_WINDOW_POPUP ); + gtk_widget_realize( m_targetsWidget ); + + gtk_signal_connect( GTK_OBJECT(m_targetsWidget), + "selection_received", + GTK_SIGNAL_FUNC( targets_selection_received ), + (gpointer) this ); + + /* we use m_clipboardWidget to get and to offer data */ + + m_clipboardWidget = gtk_window_new( GTK_WINDOW_POPUP ); + gtk_widget_realize( m_clipboardWidget ); + + gtk_signal_connect( GTK_OBJECT(m_clipboardWidget), + "selection_received", + GTK_SIGNAL_FUNC( selection_received ), + (gpointer) this ); + + gtk_signal_connect( GTK_OBJECT(m_clipboardWidget), + "selection_clear_event", + GTK_SIGNAL_FUNC( selection_clear_clip ), + (gpointer) NULL ); + + if (!g_clipboardAtom) g_clipboardAtom = gdk_atom_intern( "CLIPBOARD", FALSE ); + if (!g_targetsAtom) g_targetsAtom = gdk_atom_intern ("TARGETS", FALSE); + + m_formatSupported = FALSE; + m_targetRequested = 0; + + m_usePrimary = FALSE; } wxClipboard::~wxClipboard() { - Clear(); - - if (m_clipboardWidget) gtk_widget_destroy( m_clipboardWidget ); + Clear(); + + if (m_clipboardWidget) gtk_widget_destroy( m_clipboardWidget ); + if (m_targetsWidget) gtk_widget_destroy( m_targetsWidget ); } void wxClipboard::Clear() { - /* As we have data we also own the clipboard. Once we no longer own - it, clear_selection is called which will set m_data to zero */ - - if (m_data) - { - delete m_data; - gtk_selection_owner_set( (GtkWidget*) NULL, GDK_SELECTION_PRIMARY, GDK_CURRENT_TIME ); - } - - m_receivedSize = 0; - - if (m_receivedData) - { - delete[] m_receivedData; - m_receivedData = (char*) NULL; - } - - m_targetRequested = 0; - - m_formatSupported = FALSE; + if (m_data) + { +#if wxUSE_THREADS + /* disable GUI threads */ +#endif + + /* As we have data we also own the clipboard. Once we no longer own + it, clear_selection is called which will set m_data to zero */ + if (gdk_selection_owner_get( g_clipboardAtom ) == m_clipboardWidget->window) + { + m_waiting = TRUE; + + gtk_selection_owner_set( (GtkWidget*) NULL, g_clipboardAtom, + (guint32) GDK_CURRENT_TIME ); + + while (m_waiting) gtk_main_iteration(); + } + + if (gdk_selection_owner_get( GDK_SELECTION_PRIMARY ) == m_clipboardWidget->window) + { + m_waiting = TRUE; + + gtk_selection_owner_set( (GtkWidget*) NULL, GDK_SELECTION_PRIMARY, + (guint32) GDK_CURRENT_TIME ); + + while (m_waiting) gtk_main_iteration(); + } + + if (m_data) + { + delete m_data; + m_data = (wxDataObject*) NULL; + } + +#if wxUSE_THREADS + /* re-enable GUI threads */ +#endif + } + + m_targetRequested = 0; + m_formatSupported = FALSE; } -void wxClipboard::SetData( wxDataObject *data ) +bool wxClipboard::Open() { - if (m_data) delete m_data; - m_data = data; - if (!m_data) return; - - if (!gtk_selection_owner_set( m_clipboardWidget, - g_clipboardAtom, - GDK_CURRENT_TIME)) - { - delete m_data; - m_data = (wxDataObject*) NULL; - return; - } - - switch (m_data->GetPreferredFormat()) - { - case wxDF_TEXT: - gtk_selection_add_handler( m_clipboardWidget, - g_clipboardAtom, - g_textAtom, - selection_handler, - NULL ); - break; - default: - break; - } + wxCHECK_MSG( !m_open, FALSE, wxT("clipboard already open") ); + + m_open = TRUE; + + return TRUE; } -bool wxClipboard::IsSupportedFormat( wxDataFormat format ) +bool wxClipboard::SetData( wxDataObject *data ) { - m_targetRequested = 0; - - if (format == wxDF_TEXT) - { -// m_targetRequested = g_textAtom; - m_targetRequested = GDK_TARGET_STRING; - } - - if (m_targetRequested == 0) return FALSE; - - gtk_signal_connect( GTK_OBJECT(m_clipboardWidget), - "selection_received", - GTK_SIGNAL_FUNC( targets_selection_received ), - (gpointer) this ); - - m_formatSupported = FALSE; - - gtk_selection_convert( m_clipboardWidget, - g_clipboardAtom, - g_targetsAtom, - GDK_CURRENT_TIME ); - - gtk_signal_disconnect_by_func( GTK_OBJECT(m_clipboardWidget), - GTK_SIGNAL_FUNC( targets_selection_received ), - (gpointer) this ); - - if (!m_formatSupported) return FALSE; - - return TRUE; + wxCHECK_MSG( m_open, FALSE, wxT("clipboard not open") ); + + wxCHECK_MSG( data, FALSE, wxT("data is invalid") ); + + Clear(); + + return AddData( data ); } -bool wxClipboard::ObtainData( wxDataFormat format ) +bool wxClipboard::AddData( wxDataObject *data ) { - m_receivedSize = 0; - - if (m_receivedData) - { - delete[] m_receivedData; - m_receivedData = (char*) NULL; - } - - m_targetRequested = 0; - - if (format == wxDF_TEXT) - { -// m_targetRequested = g_textAtom; - m_targetRequested = GDK_TARGET_STRING; - } - - if (m_targetRequested == 0) return FALSE; - - gtk_signal_connect( GTK_OBJECT(m_clipboardWidget), - "selection_received", - GTK_SIGNAL_FUNC( selection_received ), - (gpointer) this ); - - gtk_selection_convert( m_clipboardWidget, - g_clipboardAtom, - m_targetRequested, - GDK_CURRENT_TIME ); - - gtk_signal_disconnect_by_func( GTK_OBJECT(m_clipboardWidget), - GTK_SIGNAL_FUNC( selection_received ), - (gpointer) this ); - - if (m_receivedSize == 0) return FALSE; - - return TRUE; + wxCHECK_MSG( m_open, FALSE, wxT("clipboard not open") ); + + wxCHECK_MSG( data, FALSE, wxT("data is invalid") ); + + /* we can only store one wxDataObject */ + Clear(); + + m_data = data; + + /* get formats from wxDataObjects */ + wxDataFormat *array = new wxDataFormat[ m_data->GetFormatCount() ]; + m_data->GetAllFormats( array ); + + /* primary selection or clipboard */ + GdkAtom clipboard = m_usePrimary ? (GdkAtom)GDK_SELECTION_PRIMARY + : g_clipboardAtom; + + + for (size_t i = 0; i < m_data->GetFormatCount(); i++) + { + wxLogTrace( TRACE_CLIPBOARD, + wxT("wxClipboard now supports atom %s"), + array[i].GetId().c_str() ); + + gtk_selection_add_target( GTK_WIDGET(m_clipboardWidget), + clipboard, + array[i], + 0 ); /* what is info ? */ + } + + delete[] array; + + gtk_signal_connect( GTK_OBJECT(m_clipboardWidget), + "selection_get", + GTK_SIGNAL_FUNC(selection_handler), + (gpointer) NULL ); + +#if wxUSE_THREADS + /* disable GUI threads */ +#endif + + /* Tell the world we offer clipboard data */ + bool res = (gtk_selection_owner_set( m_clipboardWidget, + clipboard, + (guint32) GDK_CURRENT_TIME )); + + if (m_usePrimary) + m_ownsPrimarySelection = res; + else + m_ownsClipboard = res; + +#if wxUSE_THREADS + /* re-enable GUI threads */ +#endif + + return res; } -size_t wxClipboard::GetDataSize() const +void wxClipboard::Close() { - return m_receivedSize; + wxCHECK_RET( m_open, wxT("clipboard not open") ); + + m_open = FALSE; } -void wxClipboard::GetDataHere( void *data ) const +bool wxClipboard::IsOpened() const { - memcpy(data, m_receivedData, m_receivedSize ); + return m_open; } -//----------------------------------------------------------------------------- -// wxClipboardModule -//----------------------------------------------------------------------------- +bool wxClipboard::IsSupported( const wxDataFormat& format ) +{ + /* reentrance problems */ + if (m_waiting) return FALSE; -IMPLEMENT_DYNAMIC_CLASS(wxClipboardModule,wxModule) + /* store requested format to be asked for by callbacks */ + m_targetRequested = format; -bool wxClipboardModule::OnInit() -{ - wxTheClipboard = new wxClipboard(); - - return TRUE; +#if 0 + wxLogTrace( TRACE_CLIPBOARD, + wxT("wxClipboard:IsSupported: requested format: %s"), + format.GetId().c_str() ); +#endif + + wxCHECK_MSG( m_targetRequested, FALSE, wxT("invalid clipboard format") ); + + m_formatSupported = FALSE; + + /* perform query. this will set m_formatSupported to + TRUE if m_targetRequested is supported. + also, we have to wait for the "answer" from the + clipboard owner which is an asynchronous process. + therefore we set m_waiting = TRUE here and wait + until the callback "targets_selection_received" + sets it to FALSE */ + + m_waiting = TRUE; + + gtk_selection_convert( m_targetsWidget, + m_usePrimary ? (GdkAtom)GDK_SELECTION_PRIMARY + : g_clipboardAtom, + g_targetsAtom, + (guint32) GDK_CURRENT_TIME ); + + while (m_waiting) gtk_main_iteration(); + + if (!m_formatSupported) return FALSE; + + return TRUE; } -void wxClipboardModule::OnExit() +bool wxClipboard::GetData( wxDataObject& data ) { - if (wxTheClipboard) delete wxTheClipboard; - wxTheClipboard = (wxClipboard*) NULL; + wxCHECK_MSG( m_open, FALSE, wxT("clipboard not open") ); + + /* get formats from wxDataObjects */ + wxDataFormat *array = new wxDataFormat[ data.GetFormatCount() ]; + data.GetAllFormats( array ); + + for (size_t i = 0; i < data.GetFormatCount(); i++) + { + wxDataFormat format( array[i] ); + + wxLogTrace( TRACE_CLIPBOARD, + wxT("wxClipboard::GetData: requested format: %s"), + format.GetId().c_str() ); + + /* is data supported by clipboard ? */ + + /* store requested format to be asked for by callbacks */ + m_targetRequested = format; + + wxCHECK_MSG( m_targetRequested, FALSE, wxT("invalid clipboard format") ); + + m_formatSupported = FALSE; + + /* perform query. this will set m_formatSupported to + TRUE if m_targetRequested is supported. + also, we have to wait for the "answer" from the + clipboard owner which is an asynchronous process. + therefore we set m_waiting = TRUE here and wait + until the callback "targets_selection_received" + sets it to FALSE */ + + m_waiting = TRUE; + + gtk_selection_convert( m_targetsWidget, + m_usePrimary ? (GdkAtom)GDK_SELECTION_PRIMARY + : g_clipboardAtom, + g_targetsAtom, + (guint32) GDK_CURRENT_TIME ); + + while (m_waiting) gtk_main_iteration(); + + if (!m_formatSupported) continue; + + /* store pointer to data object to be filled up by callbacks */ + m_receivedData = &data; + + /* store requested format to be asked for by callbacks */ + m_targetRequested = format; + + wxCHECK_MSG( m_targetRequested, FALSE, wxT("invalid clipboard format") ); + + /* start query */ + m_formatSupported = FALSE; + + /* ask for clipboard contents. this will set + m_formatSupported to TRUE if m_targetRequested + is supported. + also, we have to wait for the "answer" from the + clipboard owner which is an asynchronous process. + therefore we set m_waiting = TRUE here and wait + until the callback "targets_selection_received" + sets it to FALSE */ + + m_waiting = TRUE; + + wxLogTrace( TRACE_CLIPBOARD, + wxT("wxClipboard::GetData: format found, start convert") ); + + gtk_selection_convert( m_clipboardWidget, + m_usePrimary ? (GdkAtom)GDK_SELECTION_PRIMARY + : g_clipboardAtom, + m_targetRequested, + (guint32) GDK_CURRENT_TIME ); + + while (m_waiting) gtk_main_iteration(); + + /* this is a true error as we checked for the presence of such data before */ + wxCHECK_MSG( m_formatSupported, FALSE, wxT("error retrieving data from clipboard") ); + + /* return success */ + delete[] array; + return TRUE; + } + + wxLogTrace( TRACE_CLIPBOARD, + wxT("wxClipboard::GetData: format not found") ); + + /* return failure */ + delete[] array; + return FALSE; } + +#endif + // wxUSE_CLIPBOARD +