1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef INCLUDED_VCL_INC_HEADLESS_SVPINST_HXX
21 #define INCLUDED_VCL_INC_HEADLESS_SVPINST_HXX
23 #include <osl/thread.hxx>
24 #include <osl/conditn.hxx>
25 #include <salinst.hxx>
26 #include <saltimer.hxx>
27 #include <salusereventlist.hxx>
28 #include <unx/geninst.h>
29 #include <unx/genprn.h>
31 #include <condition_variable>
38 #define SvpSalInstance AquaSalInstance
42 class SvpSalTimer final
: public SalTimer
44 SvpSalInstance
* m_pInstance
;
46 SvpSalTimer( SvpSalInstance
* pInstance
) : m_pInstance( pInstance
) {}
47 virtual ~SvpSalTimer() override
;
49 // override all pure virtual methods
50 virtual void Start( sal_uInt64 nMS
) override
;
51 virtual void Stop() override
;
60 MainThreadDispatchOneEvent
,
61 MainThreadDispatchAllEvents
,
64 class SvpSalYieldMutex final
: public SalYieldMutex
67 // note: these members might as well live in SvpSalInstance, but there is
68 // at least one subclass of SvpSalInstance (GTK3) that doesn't use them.
69 friend class SvpSalInstance
;
70 // members for communication from main thread to non-main thread
71 std::mutex m_FeedbackMutex
;
72 std::queue
<bool> m_FeedbackPipe
;
73 std::condition_variable m_FeedbackCV
;
74 osl::Condition m_NonMainWaitingYieldCond
;
75 // members for communication from non-main thread to main thread
76 bool m_bNoYieldLock
= false; // accessed only on main thread
77 std::mutex m_WakeUpMainMutex
; // guard m_wakeUpMain & m_Request
78 std::condition_variable m_WakeUpMainCond
;
79 bool m_wakeUpMain
= false;
80 SvpRequest m_Request
= SvpRequest::NONE
;
82 virtual void doAcquire( sal_uInt32 nLockCount
) override
;
83 virtual sal_uInt32
doRelease( bool bUnlockAll
) override
;
87 virtual ~SvpSalYieldMutex() override
;
89 virtual bool IsCurrentThread() const override
;
92 // NOTE: the functions IsMainThread, DoYield and Wakeup *require* the use of
93 // SvpSalYieldMutex; if a subclass uses something else it must override these
94 // (Wakeup is only called by SvpSalTimer and SvpSalFrame)
95 class VCL_DLLPUBLIC SvpSalInstance
: public SalGenericInstance
, public SalUserEventList
98 sal_uLong m_nTimeoutMS
;
99 oslThreadIdentifier m_MainThread
;
101 virtual void TriggerUserEventProcessing() override
;
102 virtual void ProcessEvent( SalUserEvent aEvent
) override
;
103 bool ImplYield(bool bWait
, bool bHandleAllCurrentEvents
);
106 static SvpSalInstance
* s_pDefaultInstance
;
108 SvpSalInstance( std::unique_ptr
<SalYieldMutex
> pMutex
);
109 virtual ~SvpSalInstance() override
;
111 void CloseWakeupPipe();
112 void Wakeup(SvpRequest request
= SvpRequest::NONE
);
114 void StartTimer( sal_uInt64 nMS
);
117 inline void registerFrame( SalFrame
* pFrame
);
118 inline void deregisterFrame( SalFrame
* pFrame
);
120 bool CheckTimeout( bool bExecuteTimers
= true );
123 virtual SalFrame
* CreateChildFrame( SystemParentData
* pParent
, SalFrameStyleFlags nStyle
) override
;
124 virtual SalFrame
* CreateFrame( SalFrame
* pParent
, SalFrameStyleFlags nStyle
) override
;
125 virtual void DestroyFrame( SalFrame
* pFrame
) override
;
127 // Object (System Child Window)
128 virtual SalObject
* CreateObject( SalFrame
* pParent
, SystemWindowData
* pWindowData
, bool bShow
) override
;
129 virtual void DestroyObject( SalObject
* pObject
) override
;
132 // nDX and nDY in Pixel
133 // nBitCount: 0 == Default(=as window) / 1 == Mono
134 // pData allows for using a system dependent graphics or device context
135 virtual std::unique_ptr
<SalVirtualDevice
>
136 CreateVirtualDevice( SalGraphics
& rGraphics
,
137 tools::Long
&nDX
, tools::Long
&nDY
,
138 DeviceFormat eFormat
, const SystemGraphicsData
*pData
= nullptr ) override
;
141 // pSetupData->mpDriverData can be 0
142 // pSetupData must be updated with the current
144 virtual SalInfoPrinter
* CreateInfoPrinter( SalPrinterQueueInfo
* pQueueInfo
,
145 ImplJobSetup
* pSetupData
) override
;
146 virtual void DestroyInfoPrinter( SalInfoPrinter
* pPrinter
) override
;
147 virtual std::unique_ptr
<SalPrinter
> CreatePrinter( SalInfoPrinter
* pInfoPrinter
) override
;
149 virtual void GetPrinterQueueInfo( ImplPrnQueueList
* pList
) override
;
150 virtual void GetPrinterQueueState( SalPrinterQueueInfo
* pInfo
) override
;
151 virtual OUString
GetDefaultPrinter() override
;
152 virtual void PostPrintersChanged() override
;
155 virtual SalTimer
* CreateSalTimer() override
;
157 virtual SalSystem
* CreateSalSystem() override
;
159 virtual std::shared_ptr
<SalBitmap
> CreateSalBitmap() override
;
161 // wait next event and dispatch
162 // must returned by UserEvent (SalFrame::PostEvent)
164 virtual bool DoYield(bool bWait
, bool bHandleAllCurrentEvents
) override
;
165 virtual bool AnyInput( VclInputFlags nType
) override
;
166 virtual bool IsMainThread() const override
;
167 virtual void updateMainThread() override
;
169 virtual OUString
GetConnectionIdentifier() override
;
171 virtual void AddToRecentDocumentList(const OUString
& rFileUrl
, const OUString
& rMimeType
, const OUString
& rDocumentService
) override
;
173 virtual std::unique_ptr
<GenPspGraphics
> CreatePrintGraphics() override
;
175 virtual const cairo_font_options_t
* GetCairoFontOptions() override
;
178 inline void SvpSalInstance::registerFrame( SalFrame
* pFrame
)
180 insertFrame( pFrame
);
183 inline void SvpSalInstance::deregisterFrame( SalFrame
* pFrame
)
185 eraseFrame( pFrame
);
188 VCL_DLLPUBLIC cairo_surface_t
* get_underlying_cairo_surface(const VirtualDevice
& rDevice
);
190 #endif // INCLUDED_VCL_INC_HEADLESS_SVPINST_HXX
192 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */