LibreOffice Module vcl (master) 1
svpinst.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
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/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
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 .
18 */
19
20#ifndef INCLUDED_VCL_INC_HEADLESS_SVPINST_HXX
21#define INCLUDED_VCL_INC_HEADLESS_SVPINST_HXX
22
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>
30
31#include <condition_variable>
32
33#include <sys/time.h>
34
35#ifdef IOS
36#define SvpSalInstance AquaSalInstance
37#endif
38
39class SvpSalInstance;
40class SvpSalTimer final : public SalTimer
41{
43public:
44 SvpSalTimer( SvpSalInstance* pInstance ) : m_pInstance( pInstance ) {}
45 virtual ~SvpSalTimer() override;
46
47 // override all pure virtual methods
48 virtual void Start( sal_uInt64 nMS ) override;
49 virtual void Stop() override;
50};
51
52class SvpSalFrame;
53class GenPspGraphics;
54
55enum class SvpRequest
56{
57 NONE,
60};
61
62class SvpSalYieldMutex final : public SalYieldMutex
63{
64private:
65 // note: these members might as well live in SvpSalInstance, but there is
66 // at least one subclass of SvpSalInstance (GTK3) that doesn't use them.
67 friend class SvpSalInstance;
68 // members for communication from main thread to non-main thread
71 // members for communication from non-main thread to main thread
72 bool m_bNoYieldLock = false; // accessed only on main thread
73 std::mutex m_WakeUpMainMutex; // guard m_wakeUpMain & m_Request
74 std::condition_variable m_WakeUpMainCond;
75 bool m_wakeUpMain = false;
77
78 virtual void doAcquire( sal_uInt32 nLockCount ) override;
79 virtual sal_uInt32 doRelease( bool bUnlockAll ) override;
80
81public:
83 virtual ~SvpSalYieldMutex() override;
84
85 virtual bool IsCurrentThread() const override;
86};
87
88// NOTE: the functions IsMainThread, DoYield and Wakeup *require* the use of
89// SvpSalYieldMutex; if a subclass uses something else it must override these
90// (Wakeup is only called by SvpSalTimer and SvpSalFrame)
92{
93 timeval m_aTimeout;
95 oslThreadIdentifier m_MainThread;
96
97 virtual void TriggerUserEventProcessing() override;
98 virtual void ProcessEvent( SalUserEvent aEvent ) override;
99 bool ImplYield(bool bWait, bool bHandleAllCurrentEvents);
100
101public:
103
104 SvpSalInstance( std::unique_ptr<SalYieldMutex> pMutex );
105 virtual ~SvpSalInstance() override;
106
107 void CloseWakeupPipe(bool log);
108 void CreateWakeupPipe(bool log);
110
111 void StartTimer( sal_uInt64 nMS );
112 void StopTimer();
113
114 inline void registerFrame( SalFrame* pFrame );
115 inline void deregisterFrame( SalFrame* pFrame );
116
117 bool CheckTimeout( bool bExecuteTimers = true );
118
119 // Frame
120 virtual SalFrame* CreateChildFrame( SystemParentData* pParent, SalFrameStyleFlags nStyle ) override;
121 virtual SalFrame* CreateFrame( SalFrame* pParent, SalFrameStyleFlags nStyle ) override;
122 virtual void DestroyFrame( SalFrame* pFrame ) override;
123
124 // Object (System Child Window)
125 virtual SalObject* CreateObject( SalFrame* pParent, SystemWindowData* pWindowData, bool bShow ) override;
126 virtual void DestroyObject( SalObject* pObject ) override;
127
128 // VirtualDevice
129 // nDX and nDY in Pixel
130 // nBitCount: 0 == Default(=as window) / 1 == Mono
131 // pData allows for using a system dependent graphics or device context
132 virtual std::unique_ptr<SalVirtualDevice>
134 tools::Long &nDX, tools::Long &nDY,
135 DeviceFormat eFormat, const SystemGraphicsData *pData = nullptr ) override;
136
137 // Printer
138 // pSetupData->mpDriverData can be 0
139 // pSetupData must be updated with the current
140 // JobSetup
142 ImplJobSetup* pSetupData ) override;
143 virtual void DestroyInfoPrinter( SalInfoPrinter* pPrinter ) override;
144 virtual std::unique_ptr<SalPrinter> CreatePrinter( SalInfoPrinter* pInfoPrinter ) override;
145
146 virtual void GetPrinterQueueInfo( ImplPrnQueueList* pList ) override;
147 virtual void GetPrinterQueueState( SalPrinterQueueInfo* pInfo ) override;
148 virtual OUString GetDefaultPrinter() override;
149 virtual void PostPrintersChanged() override;
150
151 // SalTimer
152 virtual SalTimer* CreateSalTimer() override;
153 // SalSystem
154 virtual SalSystem* CreateSalSystem() override;
155 // SalBitmap
156 virtual std::shared_ptr<SalBitmap> CreateSalBitmap() override;
157
158 // wait next event and dispatch
159 // must returned by UserEvent (SalFrame::PostEvent)
160 // and timer
161 virtual bool DoYield(bool bWait, bool bHandleAllCurrentEvents) override;
162 virtual bool AnyInput( VclInputFlags nType ) override;
163 virtual bool IsMainThread() const override;
164 virtual void updateMainThread() override;
165
166 virtual OUString GetConnectionIdentifier() override;
167
168 virtual void AddToRecentDocumentList(const OUString& rFileUrl, const OUString& rMimeType, const OUString& rDocumentService) override;
169
170 virtual std::unique_ptr<GenPspGraphics> CreatePrintGraphics() override;
171
172 virtual const cairo_font_options_t* GetCairoFontOptions() override;
173};
174
176{
177 insertFrame( pFrame );
178}
179
181{
182 eraseFrame( pFrame );
183}
184
186
187#endif // INCLUDED_VCL_INC_HEADLESS_SVPINST_HXX
188
189/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
struct _cairo_surface cairo_surface_t
Definition: CairoCommon.hxx:72
A SalFrame is a system window (e.g. an X11 window).
Definition: salframe.hxx:115
void eraseFrame(SalFrame *pFrame)
void insertFrame(SalFrame *pFrame)
sal_uLong m_nTimeoutMS
Definition: svpinst.hxx:94
void Wakeup(SvpRequest request=SvpRequest::NONE)
virtual SalFrame * CreateChildFrame(SystemParentData *pParent, SalFrameStyleFlags nStyle) override
virtual void GetPrinterQueueInfo(ImplPrnQueueList *pList) override
SvpSalInstance(std::unique_ptr< SalYieldMutex > pMutex)
virtual SalObject * CreateObject(SalFrame *pParent, SystemWindowData *pWindowData, bool bShow) override
virtual SalInfoPrinter * CreateInfoPrinter(SalPrinterQueueInfo *pQueueInfo, ImplJobSetup *pSetupData) override
virtual std::shared_ptr< SalBitmap > CreateSalBitmap() override
virtual std::unique_ptr< GenPspGraphics > CreatePrintGraphics() override
virtual OUString GetConnectionIdentifier() override
virtual bool DoYield(bool bWait, bool bHandleAllCurrentEvents) override
Wait for the next event (if bWait) and dispatch it, includes posted events, and timers.
void deregisterFrame(SalFrame *pFrame)
Definition: svpinst.hxx:180
virtual void DestroyObject(SalObject *pObject) override
virtual SalSystem * CreateSalSystem() override
virtual std::unique_ptr< SalVirtualDevice > CreateVirtualDevice(SalGraphics &rGraphics, tools::Long &nDX, tools::Long &nDY, DeviceFormat eFormat, const SystemGraphicsData *pData=nullptr) override
oslThreadIdentifier m_MainThread
Definition: svpinst.hxx:95
virtual void updateMainThread() override
Set the app's (somewhat) magic/main-thread to this one.
void CreateWakeupPipe(bool log)
void StartTimer(sal_uInt64 nMS)
void registerFrame(SalFrame *pFrame)
Definition: svpinst.hxx:175
void CloseWakeupPipe(bool log)
static SvpSalInstance * s_pDefaultInstance
Definition: svpinst.hxx:102
timeval m_aTimeout
Definition: svpinst.hxx:93
virtual const cairo_font_options_t * GetCairoFontOptions() override
virtual void DestroyFrame(SalFrame *pFrame) override
bool CheckTimeout(bool bExecuteTimers=true)
virtual void DestroyInfoPrinter(SalInfoPrinter *pPrinter) override
virtual OUString GetDefaultPrinter() override
virtual bool AnyInput(VclInputFlags nType) override
virtual ~SvpSalInstance() override
virtual void TriggerUserEventProcessing() override
virtual void PostPrintersChanged() override
virtual bool IsMainThread() const override
bool ImplYield(bool bWait, bool bHandleAllCurrentEvents)
virtual std::unique_ptr< SalPrinter > CreatePrinter(SalInfoPrinter *pInfoPrinter) override
virtual void GetPrinterQueueState(SalPrinterQueueInfo *pInfo) override
virtual void ProcessEvent(SalUserEvent aEvent) override
virtual SalFrame * CreateFrame(SalFrame *pParent, SalFrameStyleFlags nStyle) override
virtual SalTimer * CreateSalTimer() override
virtual void AddToRecentDocumentList(const OUString &rFileUrl, const OUString &rMimeType, const OUString &rDocumentService) override
SvpSalTimer(SvpSalInstance *pInstance)
Definition: svpinst.hxx:44
virtual ~SvpSalTimer() override
virtual void Stop() override
virtual void Start(sal_uInt64 nMS) override
SvpSalInstance * m_pInstance
Definition: svpinst.hxx:42
bool m_bNoYieldLock
Definition: svpinst.hxx:72
virtual ~SvpSalYieldMutex() override
virtual bool IsCurrentThread() const override
virtual sal_uInt32 doRelease(bool bUnlockAll) override
std::condition_variable m_WakeUpMainCond
Definition: svpinst.hxx:74
SvpRequest m_Request
Definition: svpinst.hxx:76
osl::Condition m_NonMainWaitingYieldCond
Definition: svpinst.hxx:70
int m_FeedbackFDs[2]
Definition: svpinst.hxx:69
std::mutex m_WakeUpMainMutex
Definition: svpinst.hxx:73
virtual void doAcquire(sal_uInt32 nLockCount) override
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
VclInputFlags
Definition: inputtypes.hxx:25
NONE
long Long
SalFrameStyleFlags
Definition: salframe.hxx:65
DeviceFormat
Definition: salgtype.hxx:28
struct _cairo_font_options cairo_font_options_t
Definition: salinst.hxx:73
sal_uIntPtr sal_uLong
VCL_DLLPUBLIC cairo_surface_t * get_underlying_cairo_surface(const VirtualDevice &rDevice)
SvpRequest
Definition: svpinst.hxx:56
@ MainThreadDispatchOneEvent
@ MainThreadDispatchAllEvents