SolarMutex does not belong into the URE interface

...so move it from osl/mutex.hxx to its own comphelper/solarmutex.hxx.  It looks
like a newbie mistake that 59e7685d8d812ee8773f57475cbe3aa2a0bdfc81 "Create an
abstract interface to be used to implement a SolarMutex" put it here in the
first place.

I do not consider this an incompatible change really, as no external URE client
code should have used SolarMutex anyway.

(Also included some clean up, like removing unused
{Clearable,Resettable}SolarGuard, and spelling out SolarGuard in the few places
it is used.)

Change-Id: I121ffb5b7cefbc19e88b5405e5a85ffc895be852

14 files changed, 40 insertions, 40 deletions

diff --git a/vcl/aqua/source/app/salinst.cxx b/vcl/aqua/source/app/salinst.cxx
index 5a3ad3304768..b97bbd555387 100644
--- a/vcl/aqua/source/app/salinst.cxx
+++ b/vcl/aqua/source/app/salinst.cxx
@@ -102,7 +102,7 @@ class AquaDelayedSettingsChanged : public Timer
 
 void AquaSalInstance::delayedSettingsChanged( bool bInvalidate )
 {
-    osl::SolarGuard aGuard( *mpSalYieldMutex );
+    osl::Guard< comphelper::SolarMutex > aGuard( *mpSalYieldMutex );
     AquaDelayedSettingsChanged* pTimer = new AquaDelayedSettingsChanged( bInvalidate );
     pTimer->SetTimeout( 50 );
     pTimer->Start();
@@ -460,7 +460,7 @@ void AquaSalInstance::PostUserEvent( AquaSalFrame* pFrame, sal_uInt16 nType, voi
 
 // -----------------------------------------------------------------------
 
-osl::SolarMutex* AquaSalInstance::GetYieldMutex()
+comphelper::SolarMutex* AquaSalInstance::GetYieldMutex()
 {
     return mpSalYieldMutex;
 }
diff --git a/vcl/aqua/source/window/salframeview.mm b/vcl/aqua/source/window/salframeview.mm
index d8ccd17e996a..2a35a4b32551 100644
--- a/vcl/aqua/source/window/salframeview.mm
+++ b/vcl/aqua/source/window/salframeview.mm
@@ -161,7 +161,7 @@ static AquaSalFrame* getMouseContainerFrame()
 {
     if( GetSalData() && GetSalData()->mpFirstInstance )
     {
-        osl::SolarMutex* pMutex = GetSalData()->mpFirstInstance->GetYieldMutex();
+        comphelper::SolarMutex* pMutex = GetSalData()->mpFirstInstance->GetYieldMutex();
         if( pMutex )
         {
             pMutex->acquire();
@@ -438,9 +438,9 @@ static AquaSalFrame* getMouseContainerFrame()
 	return NO;
 }
 
-// helper class similar to a osl::SolarGuard for the SalYieldMutex
-// the difference is that it only does tryToAcquire instead of aquire
-// so dreaded deadlocks like #i93512# are prevented
+// helper class similar to a osl::Guard< comphelper::SolarMutex > for the
+// SalYieldMutex; the difference is that it only does tryToAcquire instead of
+// acquire so dreaded deadlocks like #i93512# are prevented
 class TryGuard
 {
 public:
diff --git a/vcl/generic/app/geninst.cxx b/vcl/generic/app/geninst.cxx
index b5d309d4f280..22a3975ab3a6 100644
--- a/vcl/generic/app/geninst.cxx
+++ b/vcl/generic/app/geninst.cxx
@@ -63,19 +63,19 @@ void SalYieldMutex::release()
     SolarMutexObject::release();
 }
 
-sal_Bool SalYieldMutex::tryToAcquire()
+bool SalYieldMutex::tryToAcquire()
 {
     if ( SolarMutexObject::tryToAcquire() )
     {
         mnThreadId = osl::Thread::getCurrentIdentifier();
         mnCount++;
-        return sal_True;
+        return true;
     }
     else
-        return sal_False;
+        return false;
 }
 
-osl::SolarMutex* SalGenericInstance::GetYieldMutex()
+comphelper::SolarMutex* SalGenericInstance::GetYieldMutex()
 {
     return mpSalYieldMutex;
 }
diff --git a/vcl/headless/svpinst.cxx b/vcl/headless/svpinst.cxx
index 38e077760d1d..f74d37d74ab8 100644
--- a/vcl/headless/svpinst.cxx
+++ b/vcl/headless/svpinst.cxx
@@ -174,7 +174,7 @@ bool SvpSalInstance::CheckTimeout( bool bExecuteTimers )
                 m_aTimeout = aTimeOfDay;
                 m_aTimeout += m_nTimeoutMS;
 
-                osl::SolarGuard aGuard( mpSalYieldMutex );
+                osl::Guard< comphelper::SolarMutex > aGuard( mpSalYieldMutex );
 
                 // notify
                 ImplSVData* pSVData = ImplGetSVData();
diff --git a/vcl/inc/aqua/salinst.h b/vcl/inc/aqua/salinst.h
index 89469c779ae7..441cbefdab6c 100644
--- a/vcl/inc/aqua/salinst.h
+++ b/vcl/inc/aqua/salinst.h
@@ -20,7 +20,7 @@
 #ifndef _SV_SALINST_H
 #define _SV_SALINST_H
 
-#include "osl/mutex.hxx"
+#include "comphelper/solarmutex.hxx"
 #include "osl/thread.hxx"
 #include "osl/conditn.h"
 #include <vcl/solarmutex.hxx>
@@ -44,12 +44,12 @@ public:
                                                 SalYieldMutex();
     virtual void                                acquire();
     virtual void                                release();
-    virtual sal_Bool                            tryToAcquire();
+    virtual bool                                tryToAcquire();
     sal_uLong                                       GetAcquireCount() const { return mnCount; }
     oslThreadIdentifier                         GetThreadId() const { return mnThreadId; }
 };
 
-#define YIELD_GUARD osl::SolarGuard aGuard( GetSalData()->mpFirstInstance->GetYieldMutex() )
+#define YIELD_GUARD osl::Guard< comphelper::SolarMutex > aGuard( GetSalData()->mpFirstInstance->GetYieldMutex() )
 
 
 class AquaSalInstance : public SalInstance
@@ -107,7 +107,7 @@ public:
     virtual SalI18NImeStatus*   CreateI18NImeStatus();
     virtual SalSystem*          CreateSalSystem();
     virtual SalBitmap*          CreateSalBitmap();
-    virtual osl::SolarMutex*    GetYieldMutex();
+    virtual comphelper::SolarMutex* GetYieldMutex();
     virtual sal_uLong               ReleaseYieldMutex();
     virtual void                AcquireYieldMutex( sal_uLong nCount );
     virtual bool                CheckYieldMutex();
diff --git a/vcl/inc/generic/geninst.h b/vcl/inc/generic/geninst.h
index de47409e4fff..acbe1d49e2fb 100644
--- a/vcl/inc/generic/geninst.h
+++ b/vcl/inc/generic/geninst.h
@@ -58,7 +58,7 @@ public:
 
     virtual void        acquire();
     virtual void        release();
-    virtual sal_Bool    tryToAcquire();
+    virtual bool        tryToAcquire();
 
     virtual sal_uIntPtr GetAcquireCount() const { return mnCount; }
     oslThreadIdentifier GetThreadId() const { return mnThreadId; }
@@ -81,7 +81,7 @@ public:
     virtual ~SalGenericInstance();
 
     // Yield mutex
-    virtual osl::SolarMutex*    GetYieldMutex();
+    virtual comphelper::SolarMutex* GetYieldMutex();
     virtual sal_uIntPtr         ReleaseYieldMutex();
     virtual void                AcquireYieldMutex( sal_uIntPtr nCount );
     virtual bool                CheckYieldMutex();
diff --git a/vcl/inc/salinst.hxx b/vcl/inc/salinst.hxx
index 73b79644736d..ca304cae1daa 100644
--- a/vcl/inc/salinst.hxx
+++ b/vcl/inc/salinst.hxx
@@ -33,7 +33,7 @@
 
 #include <list>
 
-
+namespace comphelper { class SolarMutex; }
 struct SystemParentData;
 struct SalPrinterQueueInfo;
 struct ImplJobSetup;
@@ -111,7 +111,7 @@ public:
     virtual SalBitmap*      CreateSalBitmap() = 0;
 
     // YieldMutex
-    virtual osl::SolarMutex*
+    virtual comphelper::SolarMutex*
                             GetYieldMutex() = 0;
     virtual sal_uLong       ReleaseYieldMutex() = 0;
     virtual void            AcquireYieldMutex( sal_uLong nCount ) = 0;
diff --git a/vcl/inc/unx/gtk/gtkinst.hxx b/vcl/inc/unx/gtk/gtkinst.hxx
index 6e358331e8fe..b9e510dcbf0d 100644
--- a/vcl/inc/unx/gtk/gtkinst.hxx
+++ b/vcl/inc/unx/gtk/gtkinst.hxx
@@ -44,7 +44,7 @@ public:
                         GtkYieldMutex();
     virtual void        acquire();
     virtual void        release();
-    virtual sal_Bool    tryToAcquire()  { return SalYieldMutex::tryToAcquire(); }
+    virtual bool        tryToAcquire()  { return SalYieldMutex::tryToAcquire(); }
 
     void ThreadsEnter();
     void ThreadsLeave();
diff --git a/vcl/inc/win/salinst.h b/vcl/inc/win/salinst.h
index 5c3b0382870c..7defd4a95fcc 100644
--- a/vcl/inc/win/salinst.h
+++ b/vcl/inc/win/salinst.h
@@ -59,7 +59,7 @@ public:
     virtual SalI18NImeStatus*   CreateI18NImeStatus();
     virtual SalSystem*          CreateSalSystem();
     virtual SalBitmap*          CreateSalBitmap();
-    virtual osl::SolarMutex*    GetYieldMutex();
+    virtual comphelper::SolarMutex* GetYieldMutex();
     virtual sal_uIntPtr         ReleaseYieldMutex();
     virtual void                AcquireYieldMutex( sal_uIntPtr nCount );
     virtual bool                CheckYieldMutex();
diff --git a/vcl/source/app/solarmutex.cxx b/vcl/source/app/solarmutex.cxx
index 7aba45912881..fb5f416073d9 100644
--- a/vcl/source/app/solarmutex.cxx
+++ b/vcl/source/app/solarmutex.cxx
@@ -35,7 +35,7 @@ void SolarMutexObject::acquire()
     osl_acquireMutex( m_solarMutex );
 }
 
-sal_Bool SolarMutexObject::tryToAcquire()
+bool SolarMutexObject::tryToAcquire()
 {
     return osl_tryToAcquireMutex( m_solarMutex );
 }
diff --git a/vcl/source/app/svapp.cxx b/vcl/source/app/svapp.cxx
index d04d1e2baf7a..8b3d149f8714 100644
--- a/vcl/source/app/svapp.cxx
+++ b/vcl/source/app/svapp.cxx
@@ -63,7 +63,7 @@
 #include "com/sun/star/awt/XToolkit.hpp"
 #include "com/sun/star/uno/XNamingService.hpp"
 #include "com/sun/star/lang/XMultiServiceFactory.hpp"
-#include "osl/mutex.hxx"
+#include "comphelper/solarmutex.hxx"
 #include "osl/process.h"
 
 #include <utility>
@@ -473,7 +473,7 @@ void Application::Quit()
 
 // -----------------------------------------------------------------------
 
-osl::SolarMutex& Application::GetSolarMutex()
+comphelper::SolarMutex& Application::GetSolarMutex()
 {
     ImplSVData* pSVData = ImplGetSVData();
     return *(pSVData->mpDefInst->GetYieldMutex());
diff --git a/vcl/unx/generic/dtrans/X11_selection.cxx b/vcl/unx/generic/dtrans/X11_selection.cxx
index 5b79345d41cd..9cd2c0be3dbc 100644
--- a/vcl/unx/generic/dtrans/X11_selection.cxx
+++ b/vcl/unx/generic/dtrans/X11_selection.cxx
@@ -64,7 +64,7 @@
 #include <osl/process.h>
 
 #include <comphelper/processfactory.hxx>
-#include <osl/mutex.hxx>
+#include <comphelper/solarmutex.hxx>
 
 #define DRAG_EVENT_MASK ButtonPressMask         |\
                               ButtonReleaseMask     |\
@@ -3308,7 +3308,7 @@ void SelectionManager::startDrag(
         */
         if( nPointerGrabSuccess != GrabSuccess )
         {
-            osl::SolarMutex& rSolarMutex( Application::GetSolarMutex() );
+            comphelper::SolarMutex& rSolarMutex( Application::GetSolarMutex() );
             if( rSolarMutex.tryToAcquire() )
             {
                 pCaptureFrame = GetGenericData()->GetSalDisplay()->GetCaptureFrame();
@@ -3349,7 +3349,7 @@ void SelectionManager::startDrag(
                 listener->dragDropEnd( aDragFailedEvent );
             if( pCaptureFrame )
             {
-                osl::SolarMutex& rSolarMutex( Application::GetSolarMutex() );
+                comphelper::SolarMutex& rSolarMutex( Application::GetSolarMutex() );
                 if( rSolarMutex.tryToAcquire() )
                     GetGenericData()->GetSalDisplay()->CaptureMouse( pCaptureFrame );
 #if OSL_DEBUG_LEVEL > 0
@@ -3438,7 +3438,7 @@ void SelectionManager::startDrag(
 
         if( pCaptureFrame )
         {
-            osl::SolarMutex& rSolarMutex( Application::GetSolarMutex() );
+            comphelper::SolarMutex& rSolarMutex( Application::GetSolarMutex() );
             if( rSolarMutex.tryToAcquire() )
                 GetGenericData()->GetSalDisplay()->CaptureMouse( pCaptureFrame );
 #if OSL_DEBUG_LEVEL > 0
diff --git a/vcl/unx/gtk/app/gtkdata.cxx b/vcl/unx/gtk/app/gtkdata.cxx
index af7043a60556..6abb06b13205 100644
--- a/vcl/unx/gtk/app/gtkdata.cxx
+++ b/vcl/unx/gtk/app/gtkdata.cxx
@@ -825,7 +825,7 @@ extern "C" {
 
         SalData *pSalData = GetSalData();
 
-        osl::SolarGuard aGuard( pSalData->m_pInstance->GetYieldMutex() );
+        osl::Guard< comphelper::SolarMutex > aGuard( pSalData->m_pInstance->GetYieldMutex() );
 
         sal_gtk_timeout_defer( pTSource );
 
@@ -911,7 +911,7 @@ gboolean GtkData::userEventFn( gpointer data )
     gboolean bContinue = FALSE;
     GtkData *pThis = (GtkData *) data;
     SalGenericData *pData = GetGenericData();
-    osl::SolarGuard aGuard( pData->m_pInstance->GetYieldMutex() );
+    osl::Guard< comphelper::SolarMutex > aGuard( pData->m_pInstance->GetYieldMutex() );
     const SalGenericDisplay *pDisplay = pData->GetDisplay();
     if (pDisplay)
     {
diff --git a/vcl/win/source/app/salinst.cxx b/vcl/win/source/app/salinst.cxx
index ef43804c1afe..7da838c058dd 100644
--- a/vcl/win/source/app/salinst.cxx
+++ b/vcl/win/source/app/salinst.cxx
@@ -23,7 +23,7 @@
 #include <process.h>
 
 #include <osl/file.hxx>
-#include <osl/mutex.hxx>
+#include <comphelper/solarmutex.hxx>
 
 #include <tools/solarmutex.hxx>
 
@@ -107,9 +107,9 @@ public: // for ImplSalYield()
 public:
                                 SalYieldMutex( WinSalInstance* pInstData );
 
-    virtual void SAL_CALL       acquire();
-    virtual void SAL_CALL       release();
-    virtual sal_Bool SAL_CALL   tryToAcquire();
+    virtual void                acquire();
+    virtual void                release();
+    virtual bool                tryToAcquire();
 
     sal_uLong                       GetAcquireCount( sal_uLong nThreadId );
 };
@@ -125,7 +125,7 @@ SalYieldMutex::SalYieldMutex( WinSalInstance* pInstData )
 
 // -----------------------------------------------------------------------
 
-void SAL_CALL SalYieldMutex::acquire()
+void SalYieldMutex::acquire()
 {
     SolarMutexObject::acquire();
     mnCount++;
@@ -134,7 +134,7 @@ void SAL_CALL SalYieldMutex::acquire()
 
 // -----------------------------------------------------------------------
 
-void SAL_CALL SalYieldMutex::release()
+void SalYieldMutex::release()
 {
     DWORD nThreadId = GetCurrentThreadId();
     if ( mnThreadId != nThreadId )
@@ -176,16 +176,16 @@ void SAL_CALL SalYieldMutex::release()
 
 // -----------------------------------------------------------------------
 
-sal_Bool SAL_CALL SalYieldMutex::tryToAcquire()
+bool SalYieldMutex::tryToAcquire()
 {
     if( SolarMutexObject::tryToAcquire() )
     {
         mnCount++;
         mnThreadId = GetCurrentThreadId();
-        return sal_True;
+        return true;
     }
     else
-        return sal_False;
+        return false;
 }
 
 // -----------------------------------------------------------------------
@@ -593,7 +593,7 @@ WinSalInstance::~WinSalInstance()
 
 // -----------------------------------------------------------------------
 
-osl::SolarMutex* WinSalInstance::GetYieldMutex()
+comphelper::SolarMutex* WinSalInstance::GetYieldMutex()
 {
     return mpSalYieldMutex;
 }