19f62ea84SAndrew Rist /**************************************************************
2cdf0e10cSrcweir *
39f62ea84SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
49f62ea84SAndrew Rist * or more contributor license agreements. See the NOTICE file
59f62ea84SAndrew Rist * distributed with this work for additional information
69f62ea84SAndrew Rist * regarding copyright ownership. The ASF licenses this file
79f62ea84SAndrew Rist * to you under the Apache License, Version 2.0 (the
89f62ea84SAndrew Rist * "License"); you may not use this file except in compliance
99f62ea84SAndrew Rist * with the License. You may obtain a copy of the License at
109f62ea84SAndrew Rist *
119f62ea84SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0
129f62ea84SAndrew Rist *
139f62ea84SAndrew Rist * Unless required by applicable law or agreed to in writing,
149f62ea84SAndrew Rist * software distributed under the License is distributed on an
159f62ea84SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
169f62ea84SAndrew Rist * KIND, either express or implied. See the License for the
179f62ea84SAndrew Rist * specific language governing permissions and limitations
189f62ea84SAndrew Rist * under the License.
199f62ea84SAndrew Rist *
209f62ea84SAndrew Rist *************************************************************/
219f62ea84SAndrew Rist
229f62ea84SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir // MARKER(update_precomp.py): autogen include statement, do not remove
25cdf0e10cSrcweir #include "precompiled_vcl.hxx"
26cdf0e10cSrcweir
27cdf0e10cSrcweir #include <osl/module.h>
28cdf0e10cSrcweir #include <unx/gtk/gtkdata.hxx>
29cdf0e10cSrcweir #include <unx/gtk/gtkinst.hxx>
30cdf0e10cSrcweir #include <unx/salobj.h>
31cdf0e10cSrcweir #include <unx/gtk/gtkframe.hxx>
32cdf0e10cSrcweir #include <unx/gtk/gtkobject.hxx>
33cdf0e10cSrcweir #include <unx/gtk/atkbridge.hxx>
34cdf0e10cSrcweir
35cdf0e10cSrcweir #include <rtl/strbuf.hxx>
36cdf0e10cSrcweir
37cdf0e10cSrcweir #include <rtl/uri.hxx>
38cdf0e10cSrcweir
39cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1
40cdf0e10cSrcweir #include <stdio.h>
41cdf0e10cSrcweir #endif
42cdf0e10cSrcweir
43cdf0e10cSrcweir #include <dlfcn.h>
44cdf0e10cSrcweir #include <fcntl.h>
45cdf0e10cSrcweir #include <unistd.h>
46cdf0e10cSrcweir
GtkHookedYieldMutex()47cdf0e10cSrcweir GtkHookedYieldMutex::GtkHookedYieldMutex()
48cdf0e10cSrcweir {
49cdf0e10cSrcweir }
50cdf0e10cSrcweir
51cdf0e10cSrcweir /*
52cdf0e10cSrcweir * These methods always occur in pairs
53cdf0e10cSrcweir * A ThreadsEnter is followed by a ThreadsLeave
54cdf0e10cSrcweir * We need to queue up the recursive lock count
55cdf0e10cSrcweir * for each pair, so we can accurately restore
56cdf0e10cSrcweir * it later.
57cdf0e10cSrcweir */
ThreadsEnter()58cdf0e10cSrcweir void GtkHookedYieldMutex::ThreadsEnter()
59cdf0e10cSrcweir {
60cdf0e10cSrcweir acquire();
61cdf0e10cSrcweir if( !aYieldStack.empty() )
62cdf0e10cSrcweir { /* Previously called ThreadsLeave() */
63cdf0e10cSrcweir sal_uLong nCount = aYieldStack.front();
64cdf0e10cSrcweir aYieldStack.pop_front();
65cdf0e10cSrcweir while( nCount-- > 1 )
66cdf0e10cSrcweir acquire();
67cdf0e10cSrcweir }
68cdf0e10cSrcweir }
69cdf0e10cSrcweir
ThreadsLeave()70cdf0e10cSrcweir void GtkHookedYieldMutex::ThreadsLeave()
71cdf0e10cSrcweir {
72cdf0e10cSrcweir aYieldStack.push_front( mnCount );
73cdf0e10cSrcweir
74cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1
75cdf0e10cSrcweir if( mnThreadId &&
76cdf0e10cSrcweir mnThreadId != vos::OThread::getCurrentIdentifier())
77cdf0e10cSrcweir fprintf( stderr, "\n\n--- A different thread owns the mutex ...---\n\n\n");
78cdf0e10cSrcweir #endif
79cdf0e10cSrcweir
80cdf0e10cSrcweir while( mnCount > 1 )
81cdf0e10cSrcweir release();
82cdf0e10cSrcweir release();
83cdf0e10cSrcweir }
84cdf0e10cSrcweir
acquire()85cdf0e10cSrcweir void GtkHookedYieldMutex::acquire()
86cdf0e10cSrcweir {
87cdf0e10cSrcweir SalYieldMutex::acquire();
88cdf0e10cSrcweir }
89cdf0e10cSrcweir
release()90cdf0e10cSrcweir void GtkHookedYieldMutex::release()
91cdf0e10cSrcweir {
92cdf0e10cSrcweir SalYieldMutex::release();
93cdf0e10cSrcweir }
94cdf0e10cSrcweir
95cdf0e10cSrcweir extern "C"
96cdf0e10cSrcweir {
97cdf0e10cSrcweir #define GET_YIELD_MUTEX() static_cast<GtkHookedYieldMutex*>(GetSalData()->m_pInstance->GetYieldMutex())
GdkThreadsEnter(void)98cdf0e10cSrcweir static void GdkThreadsEnter( void )
99cdf0e10cSrcweir {
100cdf0e10cSrcweir GtkHookedYieldMutex *pYieldMutex = GET_YIELD_MUTEX();
101cdf0e10cSrcweir pYieldMutex->ThreadsEnter();
102cdf0e10cSrcweir }
GdkThreadsLeave(void)103cdf0e10cSrcweir static void GdkThreadsLeave( void )
104cdf0e10cSrcweir {
105cdf0e10cSrcweir GtkHookedYieldMutex *pYieldMutex = GET_YIELD_MUTEX();
106cdf0e10cSrcweir pYieldMutex->ThreadsLeave();
107cdf0e10cSrcweir }
hookLocks(oslModule pModule)108cdf0e10cSrcweir static bool hookLocks( oslModule pModule )
109cdf0e10cSrcweir {
110cdf0e10cSrcweir typedef void (*GdkLockFn) (GCallback enter_fn, GCallback leave_fn);
111cdf0e10cSrcweir
112cdf0e10cSrcweir GdkLockFn gdk_threads_set_lock_functions =
113cdf0e10cSrcweir (GdkLockFn) osl_getAsciiFunctionSymbol( pModule, "gdk_threads_set_lock_functions" );
114cdf0e10cSrcweir if ( !gdk_threads_set_lock_functions )
115cdf0e10cSrcweir {
116cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1
117cdf0e10cSrcweir fprintf( stderr, "Failed to hook gdk threads locks\n" );
118cdf0e10cSrcweir #endif
119cdf0e10cSrcweir return false;
120cdf0e10cSrcweir }
121cdf0e10cSrcweir
122cdf0e10cSrcweir gdk_threads_set_lock_functions (GdkThreadsEnter, GdkThreadsLeave);
123cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1
124cdf0e10cSrcweir fprintf( stderr, "Hooked gdk threads locks\n" );
125cdf0e10cSrcweir #endif
126cdf0e10cSrcweir return true;
127cdf0e10cSrcweir }
128cdf0e10cSrcweir
create_SalInstance(oslModule pModule)129cdf0e10cSrcweir VCLPLUG_GTK_PUBLIC SalInstance* create_SalInstance( oslModule pModule )
130cdf0e10cSrcweir {
131cdf0e10cSrcweir /* #i92121# workaround deadlocks in the X11 implementation
132cdf0e10cSrcweir */
133cdf0e10cSrcweir static const char* pNoXInitThreads = getenv( "SAL_NO_XINITTHREADS" );
134cdf0e10cSrcweir /* #i90094#
135cdf0e10cSrcweir from now on we know that an X connection will be
136cdf0e10cSrcweir established, so protect X against itself
137cdf0e10cSrcweir */
138cdf0e10cSrcweir if( ! ( pNoXInitThreads && *pNoXInitThreads ) )
139cdf0e10cSrcweir XInitThreads();
140cdf0e10cSrcweir
141cdf0e10cSrcweir const gchar* pVersion = gtk_check_version( 2, 2, 0 );
142cdf0e10cSrcweir if( pVersion )
143cdf0e10cSrcweir {
144cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1
145cdf0e10cSrcweir fprintf( stderr, "gtk version conflict: %s\n", pVersion );
146cdf0e10cSrcweir #endif
147cdf0e10cSrcweir return NULL;
148cdf0e10cSrcweir }
149cdf0e10cSrcweir
150cdf0e10cSrcweir GtkYieldMutex *pYieldMutex;
151cdf0e10cSrcweir
152cdf0e10cSrcweir // init gdk thread protection
153cdf0e10cSrcweir if ( !g_thread_supported() )
154cdf0e10cSrcweir g_thread_init( NULL );
155cdf0e10cSrcweir
156cdf0e10cSrcweir if ( hookLocks( pModule ) )
157cdf0e10cSrcweir pYieldMutex = new GtkHookedYieldMutex();
158cdf0e10cSrcweir else
159cdf0e10cSrcweir pYieldMutex = new GtkYieldMutex();
160cdf0e10cSrcweir
161cdf0e10cSrcweir gdk_threads_init();
162cdf0e10cSrcweir
163cdf0e10cSrcweir GtkInstance* pInstance = new GtkInstance( pYieldMutex );
164cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1
165cdf0e10cSrcweir fprintf( stderr, "creating GtkSalInstance 0x%p\n", pInstance );
166cdf0e10cSrcweir #endif
167cdf0e10cSrcweir
168cdf0e10cSrcweir // initialize SalData
169cdf0e10cSrcweir GtkData *pSalData = new GtkData();
170cdf0e10cSrcweir SetSalData( pSalData );
171cdf0e10cSrcweir pSalData->m_pInstance = pInstance;
172cdf0e10cSrcweir pSalData->Init();
173cdf0e10cSrcweir pSalData->initNWF();
174cdf0e10cSrcweir
175cdf0e10cSrcweir InitAtkBridge();
176cdf0e10cSrcweir
177cdf0e10cSrcweir return pInstance;
178cdf0e10cSrcweir }
179cdf0e10cSrcweir }
180cdf0e10cSrcweir
~GtkInstance()181cdf0e10cSrcweir GtkInstance::~GtkInstance()
182cdf0e10cSrcweir {
183cdf0e10cSrcweir DeInitAtkBridge();
184cdf0e10cSrcweir }
185cdf0e10cSrcweir
CreateFrame(SalFrame * pParent,sal_uLong nStyle)186cdf0e10cSrcweir SalFrame* GtkInstance::CreateFrame( SalFrame* pParent, sal_uLong nStyle )
187cdf0e10cSrcweir {
188cdf0e10cSrcweir return new GtkSalFrame( pParent, nStyle );
189cdf0e10cSrcweir }
190cdf0e10cSrcweir
CreateChildFrame(SystemParentData * pParentData,sal_uLong)191cdf0e10cSrcweir SalFrame* GtkInstance::CreateChildFrame( SystemParentData* pParentData, sal_uLong )
192cdf0e10cSrcweir {
193cdf0e10cSrcweir SalFrame* pFrame = new GtkSalFrame( pParentData );
194cdf0e10cSrcweir
195cdf0e10cSrcweir return pFrame;
196cdf0e10cSrcweir }
197cdf0e10cSrcweir
CreateObject(SalFrame * pParent,SystemWindowData * pWindowData,sal_Bool bShow)198cdf0e10cSrcweir SalObject* GtkInstance::CreateObject( SalFrame* pParent, SystemWindowData* pWindowData, sal_Bool bShow )
199cdf0e10cSrcweir {
200cdf0e10cSrcweir // there is no method to set a visual for a GtkWidget
201cdf0e10cSrcweir // so we need the X11SalObject in that case
202cdf0e10cSrcweir if( pWindowData )
203cdf0e10cSrcweir return X11SalObject::CreateObject( pParent, pWindowData, bShow );
204cdf0e10cSrcweir
205cdf0e10cSrcweir return new GtkSalObject( static_cast<GtkSalFrame*>(pParent), bShow );
206cdf0e10cSrcweir }
207cdf0e10cSrcweir
208cdf0e10cSrcweir extern "C"
209cdf0e10cSrcweir {
210cdf0e10cSrcweir typedef void*(* getDefaultFnc)();
211cdf0e10cSrcweir typedef void(* addItemFnc)(void *, const char *);
212cdf0e10cSrcweir }
213cdf0e10cSrcweir
AddToRecentDocumentList(const rtl::OUString & rFileUrl,const rtl::OUString & rMimeType)214cdf0e10cSrcweir void GtkInstance::AddToRecentDocumentList(const rtl::OUString& rFileUrl, const rtl::OUString& rMimeType)
215cdf0e10cSrcweir {
216cdf0e10cSrcweir rtl::OString sGtkURL;
217cdf0e10cSrcweir rtl_TextEncoding aSystemEnc = osl_getThreadTextEncoding();
218cdf0e10cSrcweir if ((aSystemEnc == RTL_TEXTENCODING_UTF8) || (rFileUrl.compareToAscii( "file://", 7 ) != 0))
219cdf0e10cSrcweir sGtkURL = rtl::OUStringToOString(rFileUrl, RTL_TEXTENCODING_UTF8);
220cdf0e10cSrcweir else
221cdf0e10cSrcweir {
222cdf0e10cSrcweir //Non-utf8 locales are a bad idea if trying to work with non-ascii filenames
223cdf0e10cSrcweir //Decode %XX components
224cdf0e10cSrcweir rtl::OUString sDecodedUri = Uri::decode(rFileUrl.copy(7), rtl_UriDecodeToIuri, RTL_TEXTENCODING_UTF8);
225cdf0e10cSrcweir //Convert back to system locale encoding
226cdf0e10cSrcweir rtl::OString sSystemUrl = rtl::OUStringToOString(sDecodedUri, aSystemEnc);
227cdf0e10cSrcweir //Encode to an escaped ASCII-encoded URI
228cdf0e10cSrcweir gchar *g_uri = g_filename_to_uri(sSystemUrl.getStr(), NULL, NULL);
229cdf0e10cSrcweir sGtkURL = rtl::OString(g_uri);
230cdf0e10cSrcweir g_free(g_uri);
231cdf0e10cSrcweir }
232cdf0e10cSrcweir #if GTK_CHECK_VERSION(2,10,0)
233cdf0e10cSrcweir GtkRecentManager *manager = gtk_recent_manager_get_default ();
234*24c56ab9SHerbert Dürr gtk_recent_manager_add_item( manager, sGtkURL.getStr());
235cdf0e10cSrcweir (void)rMimeType;
236cdf0e10cSrcweir #else
237cdf0e10cSrcweir static getDefaultFnc sym_gtk_recent_manager_get_default =
238cdf0e10cSrcweir (getDefaultFnc)osl_getAsciiFunctionSymbol( GetSalData()->m_pPlugin, "gtk_recent_manager_get_default" );
239cdf0e10cSrcweir
240cdf0e10cSrcweir static addItemFnc sym_gtk_recent_manager_add_item =
241cdf0e10cSrcweir (addItemFnc)osl_getAsciiFunctionSymbol( GetSalData()->m_pPlugin, "gtk_recent_manager_add_item");
242cdf0e10cSrcweir if (sym_gtk_recent_manager_get_default && sym_gtk_recent_manager_add_item)
243cdf0e10cSrcweir sym_gtk_recent_manager_add_item(sym_gtk_recent_manager_get_default(), sGtkURL);
244cdf0e10cSrcweir else
245cdf0e10cSrcweir X11SalInstance::AddToRecentDocumentList(rFileUrl, rMimeType);
246cdf0e10cSrcweir #endif
247cdf0e10cSrcweir }
248cdf0e10cSrcweir
GtkYieldMutex()249cdf0e10cSrcweir GtkYieldMutex::GtkYieldMutex()
250cdf0e10cSrcweir {
251cdf0e10cSrcweir }
252cdf0e10cSrcweir
acquire()253cdf0e10cSrcweir void GtkYieldMutex::acquire()
254cdf0e10cSrcweir {
255cdf0e10cSrcweir vos::OThread::TThreadIdentifier aCurrentThread = vos::OThread::getCurrentIdentifier();
256cdf0e10cSrcweir // protect member manipulation
257cdf0e10cSrcweir OMutex::acquire();
258cdf0e10cSrcweir if( mnCount > 0 && mnThreadId == aCurrentThread )
259cdf0e10cSrcweir {
260cdf0e10cSrcweir mnCount++;
261cdf0e10cSrcweir OMutex::release();
262cdf0e10cSrcweir return;
263cdf0e10cSrcweir }
264cdf0e10cSrcweir OMutex::release();
265cdf0e10cSrcweir
266cdf0e10cSrcweir // obtain gdk mutex
267cdf0e10cSrcweir gdk_threads_enter();
268cdf0e10cSrcweir
269cdf0e10cSrcweir // obtained gdk mutex, now lock count is one by definition
270cdf0e10cSrcweir OMutex::acquire();
271cdf0e10cSrcweir mnCount = 1;
272cdf0e10cSrcweir mnThreadId = aCurrentThread;
273cdf0e10cSrcweir OMutex::release();
274cdf0e10cSrcweir }
275cdf0e10cSrcweir
release()276cdf0e10cSrcweir void GtkYieldMutex::release()
277cdf0e10cSrcweir {
278cdf0e10cSrcweir vos::OThread::TThreadIdentifier aCurrentThread = vos::OThread::getCurrentIdentifier();
279cdf0e10cSrcweir // protect member manipulation
280cdf0e10cSrcweir OMutex::acquire();
281cdf0e10cSrcweir // strange things happen, do nothing if we don't own the mutex
282cdf0e10cSrcweir if( mnThreadId == aCurrentThread )
283cdf0e10cSrcweir {
284cdf0e10cSrcweir mnCount--;
285cdf0e10cSrcweir if( mnCount == 0 )
286cdf0e10cSrcweir {
287cdf0e10cSrcweir gdk_threads_leave();
288cdf0e10cSrcweir mnThreadId = 0;
289cdf0e10cSrcweir }
290cdf0e10cSrcweir }
291cdf0e10cSrcweir OMutex::release();
292cdf0e10cSrcweir }
293cdf0e10cSrcweir
tryToAcquire()294cdf0e10cSrcweir sal_Bool GtkYieldMutex::tryToAcquire()
295cdf0e10cSrcweir {
296cdf0e10cSrcweir vos::OThread::TThreadIdentifier aCurrentThread = vos::OThread::getCurrentIdentifier();
297cdf0e10cSrcweir // protect member manipulation
298cdf0e10cSrcweir OMutex::acquire();
299cdf0e10cSrcweir if( mnCount > 0 )
300cdf0e10cSrcweir {
301cdf0e10cSrcweir if( mnThreadId == aCurrentThread )
302cdf0e10cSrcweir {
303cdf0e10cSrcweir mnCount++;
304cdf0e10cSrcweir OMutex::release();
305cdf0e10cSrcweir return sal_True;
306cdf0e10cSrcweir }
307cdf0e10cSrcweir else
308cdf0e10cSrcweir {
309cdf0e10cSrcweir OMutex::release();
310cdf0e10cSrcweir return sal_False;
311cdf0e10cSrcweir }
312cdf0e10cSrcweir }
313cdf0e10cSrcweir OMutex::release();
314cdf0e10cSrcweir
315cdf0e10cSrcweir // HACK: gdk_threads_mutex is private, we shouldn't use it.
316cdf0e10cSrcweir // how to we do a try_lock without having a gdk_threads_try_enter ?
317cdf0e10cSrcweir if( ! g_mutex_trylock( gdk_threads_mutex ) )
318cdf0e10cSrcweir return sal_False;
319cdf0e10cSrcweir
320cdf0e10cSrcweir // obtained gdk mutex, now lock count is one by definition
321cdf0e10cSrcweir OMutex::acquire();
322cdf0e10cSrcweir mnCount = 1;
323cdf0e10cSrcweir mnThreadId = aCurrentThread;
324cdf0e10cSrcweir OMutex::release();
325cdf0e10cSrcweir
326cdf0e10cSrcweir return sal_True;
327cdf0e10cSrcweir }
328cdf0e10cSrcweir
Grab()329cdf0e10cSrcweir int GtkYieldMutex::Grab()
330cdf0e10cSrcweir {
331cdf0e10cSrcweir // this MUST only be called by gdk/gtk callbacks:
332cdf0e10cSrcweir // they are entered with gdk mutex locked; the mutex
333cdf0e10cSrcweir // was unlocked by GtkYieldMutex befor yielding which
334cdf0e10cSrcweir // is now locked again by gtk implicitly
335cdf0e10cSrcweir
336cdf0e10cSrcweir // obtained gdk mutex, now lock count is one by definition
337cdf0e10cSrcweir OMutex::acquire();
338cdf0e10cSrcweir int nRet = mnCount;
339cdf0e10cSrcweir if( mnCount == 0 ) // recursive else
340cdf0e10cSrcweir mnThreadId = vos::OThread::getCurrentIdentifier();
341cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1
342cdf0e10cSrcweir else if( mnThreadId != vos::OThread::getCurrentIdentifier() )
343cdf0e10cSrcweir {
344cdf0e10cSrcweir fprintf( stderr, "Yield mutex grabbed in different thread !\n" );
345cdf0e10cSrcweir abort();
346cdf0e10cSrcweir }
347cdf0e10cSrcweir #endif
348cdf0e10cSrcweir mnCount = 1;
349cdf0e10cSrcweir OMutex::release();
350cdf0e10cSrcweir return nRet;
351cdf0e10cSrcweir }
352cdf0e10cSrcweir
Ungrab(int nGrabs)353cdf0e10cSrcweir void GtkYieldMutex::Ungrab( int nGrabs )
354cdf0e10cSrcweir {
355cdf0e10cSrcweir // this MUST only be called when leaving the callback
356cdf0e10cSrcweir // that locked the mutex with Grab()
357cdf0e10cSrcweir OMutex::acquire();
358cdf0e10cSrcweir mnCount = nGrabs;
359cdf0e10cSrcweir if( mnCount == 0 )
360cdf0e10cSrcweir mnThreadId = 0;
361cdf0e10cSrcweir OMutex::release();
362cdf0e10cSrcweir }
363