Bug Summary

File:home/maarten/src/libreoffice/core/include/rtl/ref.hxx
Warning:line 192, column 9
Use of memory after it is freed

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-unknown-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name stylesettings.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D TOOLKIT_DLLIMPLEMENTATION -D SVT_DLL_NAME="libsvtlo.so" -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/toolkit/inc -I /home/maarten/src/libreoffice/core/toolkit/source -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/toolkit/source/awt/stylesettings.cxx

/home/maarten/src/libreoffice/core/toolkit/source/awt/stylesettings.cxx

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
21#include "stylesettings.hxx"
22#include <toolkit/awt/vclxwindow.hxx>
23#include <toolkit/helper/vclunohelper.hxx>
24
25#include <com/sun/star/lang/DisposedException.hpp>
26
27#include <comphelper/interfacecontainer2.hxx>
28#include <osl/diagnose.h>
29#include <osl/mutex.hxx>
30#include <vcl/event.hxx>
31#include <vcl/window.hxx>
32#include <vcl/settings.hxx>
33#include <vcl/svapp.hxx>
34
35
36namespace toolkit
37{
38
39
40 using ::com::sun::star::uno::Reference;
41 using ::com::sun::star::uno::RuntimeException;
42 using ::com::sun::star::lang::DisposedException;
43 using ::com::sun::star::lang::EventObject;
44 using ::com::sun::star::awt::FontDescriptor;
45 using ::com::sun::star::awt::XStyleChangeListener;
46
47
48 //= WindowStyleSettings_Data
49
50 struct WindowStyleSettings_Data
51 {
52 VCLXWindow* pOwningWindow;
53 ::comphelper::OInterfaceContainerHelper2 aStyleChangeListeners;
54
55 WindowStyleSettings_Data( ::osl::Mutex& i_rListenerMutex, VCLXWindow& i_rOwningWindow )
56 : pOwningWindow( &i_rOwningWindow )
57 ,aStyleChangeListeners( i_rListenerMutex )
58 {
59 }
60
61 DECL_LINK( OnWindowEvent, VclWindowEvent&, void )static void LinkStubOnWindowEvent(void *, VclWindowEvent&
); void OnWindowEvent(VclWindowEvent&)
;
62 };
63
64
65 IMPL_LINK( WindowStyleSettings_Data, OnWindowEvent, VclWindowEvent&, rEvent, void )void WindowStyleSettings_Data::LinkStubOnWindowEvent(void * instance
, VclWindowEvent& data) { return static_cast<WindowStyleSettings_Data
*>(instance)->OnWindowEvent(data); } void WindowStyleSettings_Data
::OnWindowEvent(VclWindowEvent& rEvent)
66 {
67 if ( rEvent.GetId() != VclEventId::WindowDataChanged )
68 return;
69 const DataChangedEvent* pDataChangedEvent = static_cast< const DataChangedEvent* >( rEvent.GetData() );
70 if ( !pDataChangedEvent || ( pDataChangedEvent->GetType() != DataChangedEventType::SETTINGS ) )
71 return;
72 if ( !( pDataChangedEvent->GetFlags() & AllSettingsFlags::STYLE ) )
73 return;
74
75 EventObject aEvent( *pOwningWindow );
76 aStyleChangeListeners.notifyEach( &XStyleChangeListener::styleSettingsChanged, aEvent );
77 }
78
79
80 //= StyleMethodGuard
81
82 namespace {
83
84 class StyleMethodGuard
85 {
86 public:
87 explicit StyleMethodGuard( WindowStyleSettings_Data const & i_rData )
88 {
89 if ( i_rData.pOwningWindow == nullptr )
90 throw DisposedException();
91 }
92
93 private:
94 SolarMutexGuard m_aGuard;
95 };
96
97 }
98
99 //= WindowStyleSettings
100
101
102 WindowStyleSettings::WindowStyleSettings(::osl::Mutex& i_rListenerMutex, VCLXWindow& i_rOwningWindow )
103 :m_pData( new WindowStyleSettings_Data(i_rListenerMutex, i_rOwningWindow ) )
104 {
105 VclPtr<vcl::Window> pWindow = i_rOwningWindow.GetWindow();
106 if ( !pWindow )
107 throw RuntimeException();
108 pWindow->AddEventListener( LINK( m_pData.get(), WindowStyleSettings_Data, OnWindowEvent )::tools::detail::makeLink( ::tools::detail::castTo<WindowStyleSettings_Data
*>(m_pData.get()), &WindowStyleSettings_Data::LinkStubOnWindowEvent
)
);
109 }
110
111
112 WindowStyleSettings::~WindowStyleSettings()
113 {
114 }
115
116
117 void WindowStyleSettings::dispose()
118 {
119 StyleMethodGuard aGuard( *m_pData );
120
121 VclPtr<vcl::Window> pWindow = m_pData->pOwningWindow->GetWindow();
122 OSL_ENSURE( pWindow, "WindowStyleSettings::dispose: window has been reset before we could revoke the listener!" )do { if (true && (!(pWindow))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/stylesettings.cxx"
":" "122" ": "), "%s", "WindowStyleSettings::dispose: window has been reset before we could revoke the listener!"
); } } while (false)
;
123 if ( pWindow )
124 pWindow->RemoveEventListener( LINK( m_pData.get(), WindowStyleSettings_Data, OnWindowEvent )::tools::detail::makeLink( ::tools::detail::castTo<WindowStyleSettings_Data
*>(m_pData.get()), &WindowStyleSettings_Data::LinkStubOnWindowEvent
)
);
125
126 EventObject aEvent( *this );
127 m_pData->aStyleChangeListeners.disposeAndClear( aEvent );
128
129 m_pData->pOwningWindow = nullptr;
130 }
131
132
133 namespace
134 {
135 sal_Int32 lcl_getStyleColor( WindowStyleSettings_Data const & i_rData, Color const & (StyleSettings::*i_pGetter)() const )
136 {
137 const VclPtr<vcl::Window>& pWindow = i_rData.pOwningWindow->GetWindow();
138 const AllSettings aAllSettings = pWindow->GetSettings();
139 const StyleSettings& aStyleSettings = aAllSettings.GetStyleSettings();
140 return sal_Int32((aStyleSettings.*i_pGetter)());
141 }
142
143 void lcl_setStyleColor( WindowStyleSettings_Data const & i_rData, void (StyleSettings::*i_pSetter)( Color const & ), sal_Int32 i_nColor )
144 {
145 VclPtr<vcl::Window> pWindow = i_rData.pOwningWindow->GetWindow();
2
Calling 'VCLXWindow::GetWindow'
11
Returning from 'VCLXWindow::GetWindow'
24
Calling 'VCLXWindow::GetWindow'
146 AllSettings aAllSettings = pWindow->GetSettings();
147 StyleSettings aStyleSettings = aAllSettings.GetStyleSettings();
148 (aStyleSettings.*i_pSetter)( Color(i_nColor) );
149 aAllSettings.SetStyleSettings( aStyleSettings );
150 pWindow->SetSettings( aAllSettings );
151 }
12
Calling implicit destructor for 'VclPtr<vcl::Window>'
13
Calling '~Reference'
20
Returning from '~Reference'
21
Returning from destructor for 'VclPtr<vcl::Window>'
152
153 FontDescriptor lcl_getStyleFont( WindowStyleSettings_Data const & i_rData, vcl::Font const & (StyleSettings::*i_pGetter)() const )
154 {
155 const VclPtr<vcl::Window>& pWindow = i_rData.pOwningWindow->GetWindow();
156 const AllSettings aAllSettings = pWindow->GetSettings();
157 const StyleSettings& aStyleSettings = aAllSettings.GetStyleSettings();
158 return VCLUnoHelper::CreateFontDescriptor( (aStyleSettings.*i_pGetter)() );
159 }
160
161 void lcl_setStyleFont( WindowStyleSettings_Data const & i_rData, void (StyleSettings::*i_pSetter)( vcl::Font const &),
162 vcl::Font const & (StyleSettings::*i_pGetter)() const, const FontDescriptor& i_rFont )
163 {
164 VclPtr<vcl::Window> pWindow = i_rData.pOwningWindow->GetWindow();
165 AllSettings aAllSettings = pWindow->GetSettings();
166 StyleSettings aStyleSettings = aAllSettings.GetStyleSettings();
167 const vcl::Font aNewFont = VCLUnoHelper::CreateFont( i_rFont, (aStyleSettings.*i_pGetter)() );
168 (aStyleSettings.*i_pSetter)( aNewFont );
169 aAllSettings.SetStyleSettings( aStyleSettings );
170 pWindow->SetSettings( aAllSettings );
171 }
172 }
173
174
175 ::sal_Int32 SAL_CALL WindowStyleSettings::getActiveBorderColor()
176 {
177 StyleMethodGuard aGuard( *m_pData );
178 return lcl_getStyleColor( *m_pData, &StyleSettings::GetActiveBorderColor );
179 }
180
181
182 void SAL_CALL WindowStyleSettings::setActiveBorderColor( ::sal_Int32 _activebordercolor )
183 {
184 StyleMethodGuard aGuard( *m_pData );
185 lcl_setStyleColor( *m_pData, &StyleSettings::SetActiveBorderColor, _activebordercolor );
186 }
187
188
189 ::sal_Int32 SAL_CALL WindowStyleSettings::getActiveColor()
190 {
191 StyleMethodGuard aGuard( *m_pData );
192 return lcl_getStyleColor( *m_pData, &StyleSettings::GetActiveColor );
193 }
194
195
196 void SAL_CALL WindowStyleSettings::setActiveColor( ::sal_Int32 _activecolor )
197 {
198 StyleMethodGuard aGuard( *m_pData );
199 lcl_setStyleColor( *m_pData, &StyleSettings::SetActiveColor, _activecolor );
200 }
201
202
203 ::sal_Int32 SAL_CALL WindowStyleSettings::getActiveTabColor()
204 {
205 StyleMethodGuard aGuard( *m_pData );
206 return lcl_getStyleColor( *m_pData, &StyleSettings::GetActiveTabColor );
207 }
208
209
210 void SAL_CALL WindowStyleSettings::setActiveTabColor( ::sal_Int32 _activetabcolor )
211 {
212 StyleMethodGuard aGuard( *m_pData );
213 lcl_setStyleColor( *m_pData, &StyleSettings::SetActiveTabColor, _activetabcolor );
214 }
215
216
217 ::sal_Int32 SAL_CALL WindowStyleSettings::getActiveTextColor()
218 {
219 StyleMethodGuard aGuard( *m_pData );
220 return lcl_getStyleColor( *m_pData, &StyleSettings::GetActiveTextColor );
221 }
222
223
224 void SAL_CALL WindowStyleSettings::setActiveTextColor( ::sal_Int32 _activetextcolor )
225 {
226 StyleMethodGuard aGuard( *m_pData );
227 lcl_setStyleColor( *m_pData, &StyleSettings::SetActiveTextColor, _activetextcolor );
228 }
229
230
231 ::sal_Int32 SAL_CALL WindowStyleSettings::getButtonRolloverTextColor()
232 {
233 StyleMethodGuard aGuard( *m_pData );
234 return lcl_getStyleColor( *m_pData, &StyleSettings::GetButtonRolloverTextColor );
235 }
236
237
238 void SAL_CALL WindowStyleSettings::setButtonRolloverTextColor( ::sal_Int32 _buttonrollovertextcolor )
239 {
240 StyleMethodGuard aGuard( *m_pData );
241 lcl_setStyleColor( *m_pData, &StyleSettings::SetButtonRolloverTextColor, _buttonrollovertextcolor );
242 // Also need to set ActionButtonRolloverTextColor as this setting can't be
243 // set through the UNO interface otherwise.
244 // Previously this setting was used to set colors for both scenarios,
245 // but action button setting was added to differentiate the buttons from
246 // "normal" buttons in some themes.
247 lcl_setStyleColor( *m_pData, &StyleSettings::SetActionButtonRolloverTextColor, _buttonrollovertextcolor );
248 }
249
250
251 ::sal_Int32 SAL_CALL WindowStyleSettings::getButtonTextColor()
252 {
253 StyleMethodGuard aGuard( *m_pData );
254 return lcl_getStyleColor( *m_pData, &StyleSettings::GetButtonTextColor );
255 }
256
257
258 void SAL_CALL WindowStyleSettings::setButtonTextColor( ::sal_Int32 _buttontextcolor )
259 {
260 StyleMethodGuard aGuard( *m_pData );
261 lcl_setStyleColor( *m_pData, &StyleSettings::SetButtonTextColor, _buttontextcolor );
1
Calling 'lcl_setStyleColor'
22
Returning; memory was released
262 // Also need to set ActionButtonTextColor and DefaultActionButtonTextColor
263 // as this two settings can't be set through the UNO interface otherwise.
264 // Previously this setting was used to set colors for all three scenarios,
265 // but action button setting was added to differentiate the buttons from
266 // "normal" buttons in some themes.
267 lcl_setStyleColor( *m_pData, &StyleSettings::SetActionButtonTextColor, _buttontextcolor );
23
Calling 'lcl_setStyleColor'
268 lcl_setStyleColor( *m_pData, &StyleSettings::SetDefaultActionButtonTextColor, _buttontextcolor );
269 }
270
271
272 ::sal_Int32 SAL_CALL WindowStyleSettings::getCheckedColor()
273 {
274 StyleMethodGuard aGuard( *m_pData );
275 return lcl_getStyleColor( *m_pData, &StyleSettings::GetCheckedColor );
276 }
277
278
279 void SAL_CALL WindowStyleSettings::setCheckedColor( ::sal_Int32 _checkedcolor )
280 {
281 StyleMethodGuard aGuard( *m_pData );
282 lcl_setStyleColor( *m_pData, &StyleSettings::SetCheckedColor, _checkedcolor );
283 }
284
285
286 ::sal_Int32 SAL_CALL WindowStyleSettings::getDarkShadowColor()
287 {
288 StyleMethodGuard aGuard( *m_pData );
289 return lcl_getStyleColor( *m_pData, &StyleSettings::GetDarkShadowColor );
290 }
291
292
293 void SAL_CALL WindowStyleSettings::setDarkShadowColor( ::sal_Int32 _darkshadowcolor )
294 {
295 StyleMethodGuard aGuard( *m_pData );
296 lcl_setStyleColor( *m_pData, &StyleSettings::SetDarkShadowColor, _darkshadowcolor );
297 }
298
299
300 ::sal_Int32 SAL_CALL WindowStyleSettings::getDeactiveBorderColor()
301 {
302 StyleMethodGuard aGuard( *m_pData );
303 return lcl_getStyleColor( *m_pData, &StyleSettings::GetDeactiveBorderColor );
304 }
305
306
307 void SAL_CALL WindowStyleSettings::setDeactiveBorderColor( ::sal_Int32 _deactivebordercolor )
308 {
309 StyleMethodGuard aGuard( *m_pData );
310 lcl_setStyleColor( *m_pData, &StyleSettings::SetDeactiveBorderColor, _deactivebordercolor );
311 }
312
313
314 ::sal_Int32 SAL_CALL WindowStyleSettings::getDeactiveColor()
315 {
316 StyleMethodGuard aGuard( *m_pData );
317 return lcl_getStyleColor( *m_pData, &StyleSettings::GetDeactiveColor );
318 }
319
320
321 void SAL_CALL WindowStyleSettings::setDeactiveColor( ::sal_Int32 _deactivecolor )
322 {
323 StyleMethodGuard aGuard( *m_pData );
324 lcl_setStyleColor( *m_pData, &StyleSettings::SetDeactiveColor, _deactivecolor );
325 }
326
327
328 ::sal_Int32 SAL_CALL WindowStyleSettings::getDeactiveTextColor()
329 {
330 StyleMethodGuard aGuard( *m_pData );
331 return lcl_getStyleColor( *m_pData, &StyleSettings::GetDeactiveTextColor );
332 }
333
334
335 void SAL_CALL WindowStyleSettings::setDeactiveTextColor( ::sal_Int32 _deactivetextcolor )
336 {
337 StyleMethodGuard aGuard( *m_pData );
338 lcl_setStyleColor( *m_pData, &StyleSettings::SetDeactiveTextColor, _deactivetextcolor );
339 }
340
341
342 ::sal_Int32 SAL_CALL WindowStyleSettings::getDialogColor()
343 {
344 StyleMethodGuard aGuard( *m_pData );
345 return lcl_getStyleColor( *m_pData, &StyleSettings::GetDialogColor );
346 }
347
348
349 void SAL_CALL WindowStyleSettings::setDialogColor( ::sal_Int32 _dialogcolor )
350 {
351 StyleMethodGuard aGuard( *m_pData );
352 lcl_setStyleColor( *m_pData, &StyleSettings::SetDialogColor, _dialogcolor );
353 }
354
355
356 ::sal_Int32 SAL_CALL WindowStyleSettings::getDialogTextColor()
357 {
358 StyleMethodGuard aGuard( *m_pData );
359 return lcl_getStyleColor( *m_pData, &StyleSettings::GetDialogTextColor );
360 }
361
362
363 void SAL_CALL WindowStyleSettings::setDialogTextColor( ::sal_Int32 _dialogtextcolor )
364 {
365 StyleMethodGuard aGuard( *m_pData );
366 lcl_setStyleColor( *m_pData, &StyleSettings::SetDialogTextColor, _dialogtextcolor );
367 }
368
369
370 ::sal_Int32 SAL_CALL WindowStyleSettings::getDisableColor()
371 {
372 StyleMethodGuard aGuard( *m_pData );
373 return lcl_getStyleColor( *m_pData, &StyleSettings::GetDisableColor );
374 }
375
376
377 void SAL_CALL WindowStyleSettings::setDisableColor( ::sal_Int32 _disablecolor )
378 {
379 StyleMethodGuard aGuard( *m_pData );
380 lcl_setStyleColor( *m_pData, &StyleSettings::SetDisableColor, _disablecolor );
381 }
382
383
384 ::sal_Int32 SAL_CALL WindowStyleSettings::getFaceColor()
385 {
386 StyleMethodGuard aGuard( *m_pData );
387 return lcl_getStyleColor( *m_pData, &StyleSettings::GetFaceColor );
388 }
389
390
391 void SAL_CALL WindowStyleSettings::setFaceColor( ::sal_Int32 _facecolor )
392 {
393 StyleMethodGuard aGuard( *m_pData );
394 lcl_setStyleColor( *m_pData, &StyleSettings::SetFaceColor, _facecolor );
395 }
396
397
398 ::sal_Int32 SAL_CALL WindowStyleSettings::getFaceGradientColor()
399 {
400 StyleMethodGuard aGuard( *m_pData );
401 const VclPtr<vcl::Window>& pWindow = m_pData->pOwningWindow->GetWindow();
402 const AllSettings aAllSettings = pWindow->GetSettings();
403 const StyleSettings& aStyleSettings = aAllSettings.GetStyleSettings();
404 return sal_Int32(aStyleSettings.GetFaceGradientColor());
405 }
406
407
408 ::sal_Int32 SAL_CALL WindowStyleSettings::getFieldColor()
409 {
410 StyleMethodGuard aGuard( *m_pData );
411 return lcl_getStyleColor( *m_pData, &StyleSettings::GetFieldColor );
412 }
413
414
415 void SAL_CALL WindowStyleSettings::setFieldColor( ::sal_Int32 _fieldcolor )
416 {
417 StyleMethodGuard aGuard( *m_pData );
418 lcl_setStyleColor( *m_pData, &StyleSettings::SetFieldColor, _fieldcolor );
419 }
420
421
422 ::sal_Int32 SAL_CALL WindowStyleSettings::getFieldRolloverTextColor()
423 {
424 StyleMethodGuard aGuard( *m_pData );
425 return lcl_getStyleColor( *m_pData, &StyleSettings::GetFieldRolloverTextColor );
426 }
427
428
429 void SAL_CALL WindowStyleSettings::setFieldRolloverTextColor( ::sal_Int32 _fieldrollovertextcolor )
430 {
431 StyleMethodGuard aGuard( *m_pData );
432 lcl_setStyleColor( *m_pData, &StyleSettings::SetFieldRolloverTextColor, _fieldrollovertextcolor );
433 }
434
435
436 ::sal_Int32 SAL_CALL WindowStyleSettings::getFieldTextColor()
437 {
438 StyleMethodGuard aGuard( *m_pData );
439 return lcl_getStyleColor( *m_pData, &StyleSettings::GetFieldTextColor );
440 }
441
442
443 void SAL_CALL WindowStyleSettings::setFieldTextColor( ::sal_Int32 _fieldtextcolor )
444 {
445 StyleMethodGuard aGuard( *m_pData );
446 lcl_setStyleColor( *m_pData, &StyleSettings::SetFieldTextColor, _fieldtextcolor );
447 }
448
449
450 ::sal_Int32 SAL_CALL WindowStyleSettings::getGroupTextColor()
451 {
452 StyleMethodGuard aGuard( *m_pData );
453 return lcl_getStyleColor( *m_pData, &StyleSettings::GetGroupTextColor );
454 }
455
456
457 void SAL_CALL WindowStyleSettings::setGroupTextColor( ::sal_Int32 _grouptextcolor )
458 {
459 StyleMethodGuard aGuard( *m_pData );
460 lcl_setStyleColor( *m_pData, &StyleSettings::SetGroupTextColor, _grouptextcolor );
461 }
462
463
464 ::sal_Int32 SAL_CALL WindowStyleSettings::getHelpColor()
465 {
466 StyleMethodGuard aGuard( *m_pData );
467 return lcl_getStyleColor( *m_pData, &StyleSettings::GetHelpColor );
468 }
469
470
471 void SAL_CALL WindowStyleSettings::setHelpColor( ::sal_Int32 _helpcolor )
472 {
473 StyleMethodGuard aGuard( *m_pData );
474 lcl_setStyleColor( *m_pData, &StyleSettings::SetHelpColor, _helpcolor );
475 }
476
477
478 ::sal_Int32 SAL_CALL WindowStyleSettings::getHelpTextColor()
479 {
480 StyleMethodGuard aGuard( *m_pData );
481 return lcl_getStyleColor( *m_pData, &StyleSettings::GetHelpTextColor );
482 }
483
484
485 void SAL_CALL WindowStyleSettings::setHelpTextColor( ::sal_Int32 _helptextcolor )
486 {
487 StyleMethodGuard aGuard( *m_pData );
488 lcl_setStyleColor( *m_pData, &StyleSettings::SetHelpTextColor, _helptextcolor );
489 }
490
491
492 ::sal_Int32 SAL_CALL WindowStyleSettings::getHighlightColor()
493 {
494 StyleMethodGuard aGuard( *m_pData );
495 return lcl_getStyleColor( *m_pData, &StyleSettings::GetHighlightColor );
496 }
497
498
499 void SAL_CALL WindowStyleSettings::setHighlightColor( ::sal_Int32 _highlightcolor )
500 {
501 StyleMethodGuard aGuard( *m_pData );
502 lcl_setStyleColor( *m_pData, &StyleSettings::SetHighlightColor, _highlightcolor );
503 }
504
505
506 ::sal_Int32 SAL_CALL WindowStyleSettings::getHighlightTextColor()
507 {
508 StyleMethodGuard aGuard( *m_pData );
509 return lcl_getStyleColor( *m_pData, &StyleSettings::GetHighlightTextColor );
510 }
511
512
513 void SAL_CALL WindowStyleSettings::setHighlightTextColor( ::sal_Int32 _highlighttextcolor )
514 {
515 StyleMethodGuard aGuard( *m_pData );
516 lcl_setStyleColor( *m_pData, &StyleSettings::SetHighlightTextColor, _highlighttextcolor );
517 }
518
519
520 ::sal_Int32 SAL_CALL WindowStyleSettings::getInactiveTabColor()
521 {
522 StyleMethodGuard aGuard( *m_pData );
523 return lcl_getStyleColor( *m_pData, &StyleSettings::GetInactiveTabColor );
524 }
525
526
527 void SAL_CALL WindowStyleSettings::setInactiveTabColor( ::sal_Int32 _inactivetabcolor )
528 {
529 StyleMethodGuard aGuard( *m_pData );
530 lcl_setStyleColor( *m_pData, &StyleSettings::SetInactiveTabColor, _inactivetabcolor );
531 }
532
533
534 ::sal_Int32 SAL_CALL WindowStyleSettings::getLabelTextColor()
535 {
536 StyleMethodGuard aGuard( *m_pData );
537 return lcl_getStyleColor( *m_pData, &StyleSettings::GetLabelTextColor );
538 }
539
540
541 void SAL_CALL WindowStyleSettings::setLabelTextColor( ::sal_Int32 _labeltextcolor )
542 {
543 StyleMethodGuard aGuard( *m_pData );
544 lcl_setStyleColor( *m_pData, &StyleSettings::SetLabelTextColor, _labeltextcolor );
545 }
546
547
548 ::sal_Int32 SAL_CALL WindowStyleSettings::getLightColor()
549 {
550 StyleMethodGuard aGuard( *m_pData );
551 return lcl_getStyleColor( *m_pData, &StyleSettings::GetLightColor );
552 }
553
554
555 void SAL_CALL WindowStyleSettings::setLightColor( ::sal_Int32 _lightcolor )
556 {
557 StyleMethodGuard aGuard( *m_pData );
558 lcl_setStyleColor( *m_pData, &StyleSettings::SetLightColor, _lightcolor );
559 }
560
561
562 ::sal_Int32 SAL_CALL WindowStyleSettings::getMenuBarColor()
563 {
564 StyleMethodGuard aGuard( *m_pData );
565 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMenuBarColor );
566 }
567
568
569 void SAL_CALL WindowStyleSettings::setMenuBarColor( ::sal_Int32 _menubarcolor )
570 {
571 StyleMethodGuard aGuard( *m_pData );
572 lcl_setStyleColor( *m_pData, &StyleSettings::SetMenuBarColor, _menubarcolor );
573 }
574
575
576 ::sal_Int32 SAL_CALL WindowStyleSettings::getMenuBarTextColor()
577 {
578 StyleMethodGuard aGuard( *m_pData );
579 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMenuBarTextColor );
580 }
581
582
583 void SAL_CALL WindowStyleSettings::setMenuBarTextColor( ::sal_Int32 _menubartextcolor )
584 {
585 StyleMethodGuard aGuard( *m_pData );
586 lcl_setStyleColor( *m_pData, &StyleSettings::SetMenuBarTextColor, _menubartextcolor );
587 }
588
589
590 ::sal_Int32 SAL_CALL WindowStyleSettings::getMenuBorderColor()
591 {
592 StyleMethodGuard aGuard( *m_pData );
593 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMenuBorderColor );
594 }
595
596
597 void SAL_CALL WindowStyleSettings::setMenuBorderColor( ::sal_Int32 _menubordercolor )
598 {
599 StyleMethodGuard aGuard( *m_pData );
600 lcl_setStyleColor( *m_pData, &StyleSettings::SetMenuBorderColor, _menubordercolor );
601 }
602
603
604 ::sal_Int32 SAL_CALL WindowStyleSettings::getMenuColor()
605 {
606 StyleMethodGuard aGuard( *m_pData );
607 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMenuColor );
608 }
609
610
611 void SAL_CALL WindowStyleSettings::setMenuColor( ::sal_Int32 _menucolor )
612 {
613 StyleMethodGuard aGuard( *m_pData );
614 lcl_setStyleColor( *m_pData, &StyleSettings::SetMenuColor, _menucolor );
615 }
616
617
618 ::sal_Int32 SAL_CALL WindowStyleSettings::getMenuHighlightColor()
619 {
620 StyleMethodGuard aGuard( *m_pData );
621 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMenuHighlightColor );
622 }
623
624
625 void SAL_CALL WindowStyleSettings::setMenuHighlightColor( ::sal_Int32 _menuhighlightcolor )
626 {
627 StyleMethodGuard aGuard( *m_pData );
628 lcl_setStyleColor( *m_pData, &StyleSettings::SetMenuHighlightColor, _menuhighlightcolor );
629 }
630
631
632 ::sal_Int32 SAL_CALL WindowStyleSettings::getMenuHighlightTextColor()
633 {
634 StyleMethodGuard aGuard( *m_pData );
635 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMenuHighlightTextColor );
636 }
637
638
639 void SAL_CALL WindowStyleSettings::setMenuHighlightTextColor( ::sal_Int32 _menuhighlighttextcolor )
640 {
641 StyleMethodGuard aGuard( *m_pData );
642 lcl_setStyleColor( *m_pData, &StyleSettings::SetMenuHighlightTextColor, _menuhighlighttextcolor );
643 }
644
645
646 ::sal_Int32 SAL_CALL WindowStyleSettings::getMenuTextColor()
647 {
648 StyleMethodGuard aGuard( *m_pData );
649 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMenuTextColor );
650 }
651
652
653 void SAL_CALL WindowStyleSettings::setMenuTextColor( ::sal_Int32 _menutextcolor )
654 {
655 StyleMethodGuard aGuard( *m_pData );
656 lcl_setStyleColor( *m_pData, &StyleSettings::SetMenuTextColor, _menutextcolor );
657 }
658
659
660 ::sal_Int32 SAL_CALL WindowStyleSettings::getMonoColor()
661 {
662 StyleMethodGuard aGuard( *m_pData );
663 return lcl_getStyleColor( *m_pData, &StyleSettings::GetMonoColor );
664 }
665
666
667 void SAL_CALL WindowStyleSettings::setMonoColor( ::sal_Int32 _monocolor )
668 {
669 StyleMethodGuard aGuard( *m_pData );
670 lcl_setStyleColor( *m_pData, &StyleSettings::SetMonoColor, _monocolor );
671 }
672
673
674 ::sal_Int32 SAL_CALL WindowStyleSettings::getRadioCheckTextColor()
675 {
676 StyleMethodGuard aGuard( *m_pData );
677 return lcl_getStyleColor( *m_pData, &StyleSettings::GetRadioCheckTextColor );
678 }
679
680
681 void SAL_CALL WindowStyleSettings::setRadioCheckTextColor( ::sal_Int32 _radiochecktextcolor )
682 {
683 StyleMethodGuard aGuard( *m_pData );
684 lcl_setStyleColor( *m_pData, &StyleSettings::SetRadioCheckTextColor, _radiochecktextcolor );
685 }
686
687
688 ::sal_Int32 SAL_CALL WindowStyleSettings::getSeparatorColor()
689 {
690 StyleMethodGuard aGuard( *m_pData );
691 const VclPtr<vcl::Window>& pWindow = m_pData->pOwningWindow->GetWindow();
692 const AllSettings aAllSettings = pWindow->GetSettings();
693 const StyleSettings& aStyleSettings = aAllSettings.GetStyleSettings();
694 return sal_Int32(aStyleSettings.GetSeparatorColor());
695 }
696
697
698 ::sal_Int32 SAL_CALL WindowStyleSettings::getShadowColor()
699 {
700 StyleMethodGuard aGuard( *m_pData );
701 return lcl_getStyleColor( *m_pData, &StyleSettings::GetShadowColor );
702 }
703
704
705 void SAL_CALL WindowStyleSettings::setShadowColor( ::sal_Int32 _shadowcolor )
706 {
707 StyleMethodGuard aGuard( *m_pData );
708 lcl_setStyleColor( *m_pData, &StyleSettings::SetShadowColor, _shadowcolor );
709 }
710
711
712 ::sal_Int32 SAL_CALL WindowStyleSettings::getWindowColor()
713 {
714 StyleMethodGuard aGuard( *m_pData );
715 return lcl_getStyleColor( *m_pData, &StyleSettings::GetWindowColor );
716 }
717
718
719 void SAL_CALL WindowStyleSettings::setWindowColor( ::sal_Int32 _windowcolor )
720 {
721 StyleMethodGuard aGuard( *m_pData );
722 lcl_setStyleColor( *m_pData, &StyleSettings::SetWindowColor, _windowcolor );
723 }
724
725
726 ::sal_Int32 SAL_CALL WindowStyleSettings::getWindowTextColor()
727 {
728 StyleMethodGuard aGuard( *m_pData );
729 return lcl_getStyleColor( *m_pData, &StyleSettings::GetWindowTextColor );
730 }
731
732
733 void SAL_CALL WindowStyleSettings::setWindowTextColor( ::sal_Int32 _windowtextcolor )
734 {
735 StyleMethodGuard aGuard( *m_pData );
736 lcl_setStyleColor( *m_pData, &StyleSettings::SetWindowTextColor, _windowtextcolor );
737 }
738
739
740 ::sal_Int32 SAL_CALL WindowStyleSettings::getWorkspaceColor()
741 {
742 StyleMethodGuard aGuard( *m_pData );
743 return lcl_getStyleColor( *m_pData, &StyleSettings::GetWorkspaceColor );
744 }
745
746
747 void SAL_CALL WindowStyleSettings::setWorkspaceColor( ::sal_Int32 _workspacecolor )
748 {
749 StyleMethodGuard aGuard( *m_pData );
750 lcl_setStyleColor( *m_pData, &StyleSettings::SetWorkspaceColor, _workspacecolor );
751 }
752
753
754 sal_Bool SAL_CALL WindowStyleSettings::getHighContrastMode()
755 {
756 StyleMethodGuard aGuard( *m_pData );
757 const VclPtr<vcl::Window>& pWindow = m_pData->pOwningWindow->GetWindow();
758 const AllSettings aAllSettings = pWindow->GetSettings();
759 const StyleSettings& aStyleSettings = aAllSettings.GetStyleSettings();
760 return aStyleSettings.GetHighContrastMode();
761 }
762
763
764 void SAL_CALL WindowStyleSettings::setHighContrastMode( sal_Bool _highcontrastmode )
765 {
766 StyleMethodGuard aGuard( *m_pData );
767 VclPtr<vcl::Window> pWindow = m_pData->pOwningWindow->GetWindow();
768 AllSettings aAllSettings = pWindow->GetSettings();
769 StyleSettings aStyleSettings = aAllSettings.GetStyleSettings();
770 aStyleSettings.SetHighContrastMode( _highcontrastmode );
771 aAllSettings.SetStyleSettings( aStyleSettings );
772 pWindow->SetSettings( aAllSettings );
773 }
774
775
776 FontDescriptor SAL_CALL WindowStyleSettings::getApplicationFont()
777 {
778 StyleMethodGuard aGuard( *m_pData );
779 return lcl_getStyleFont( *m_pData, &StyleSettings::GetAppFont );
780 }
781
782
783 void SAL_CALL WindowStyleSettings::setApplicationFont( const FontDescriptor& _applicationfont )
784 {
785 StyleMethodGuard aGuard( *m_pData );
786 lcl_setStyleFont( *m_pData, &StyleSettings::SetAppFont, &StyleSettings::GetAppFont, _applicationfont );
787 }
788
789
790 FontDescriptor SAL_CALL WindowStyleSettings::getHelpFont()
791 {
792 StyleMethodGuard aGuard( *m_pData );
793 return lcl_getStyleFont( *m_pData, &StyleSettings::GetHelpFont );
794 }
795
796
797 void SAL_CALL WindowStyleSettings::setHelpFont( const FontDescriptor& _helpfont )
798 {
799 StyleMethodGuard aGuard( *m_pData );
800 lcl_setStyleFont( *m_pData, &StyleSettings::SetHelpFont, &StyleSettings::GetHelpFont, _helpfont );
801 }
802
803
804 FontDescriptor SAL_CALL WindowStyleSettings::getTitleFont()
805 {
806 StyleMethodGuard aGuard( *m_pData );
807 return lcl_getStyleFont( *m_pData, &StyleSettings::GetTitleFont );
808 }
809
810
811 void SAL_CALL WindowStyleSettings::setTitleFont( const FontDescriptor& _titlefont )
812 {
813 StyleMethodGuard aGuard( *m_pData );
814 lcl_setStyleFont( *m_pData, &StyleSettings::SetTitleFont, &StyleSettings::GetTitleFont, _titlefont );
815 }
816
817
818 FontDescriptor SAL_CALL WindowStyleSettings::getFloatTitleFont()
819 {
820 StyleMethodGuard aGuard( *m_pData );
821 return lcl_getStyleFont( *m_pData, &StyleSettings::GetFloatTitleFont );
822 }
823
824
825 void SAL_CALL WindowStyleSettings::setFloatTitleFont( const FontDescriptor& _floattitlefont )
826 {
827 StyleMethodGuard aGuard( *m_pData );
828 lcl_setStyleFont( *m_pData, &StyleSettings::SetFloatTitleFont, &StyleSettings::GetFloatTitleFont, _floattitlefont );
829 }
830
831
832 FontDescriptor SAL_CALL WindowStyleSettings::getMenuFont()
833 {
834 StyleMethodGuard aGuard( *m_pData );
835 return lcl_getStyleFont( *m_pData, &StyleSettings::GetMenuFont );
836 }
837
838
839 void SAL_CALL WindowStyleSettings::setMenuFont( const FontDescriptor& _menufont )
840 {
841 StyleMethodGuard aGuard( *m_pData );
842 lcl_setStyleFont( *m_pData, &StyleSettings::SetMenuFont, &StyleSettings::GetMenuFont, _menufont );
843 }
844
845
846 FontDescriptor SAL_CALL WindowStyleSettings::getToolFont()
847 {
848 StyleMethodGuard aGuard( *m_pData );
849 return lcl_getStyleFont( *m_pData, &StyleSettings::GetToolFont );
850 }
851
852
853 void SAL_CALL WindowStyleSettings::setToolFont( const FontDescriptor& _toolfont )
854 {
855 StyleMethodGuard aGuard( *m_pData );
856 lcl_setStyleFont( *m_pData, &StyleSettings::SetToolFont, &StyleSettings::GetToolFont, _toolfont );
857 }
858
859
860 FontDescriptor SAL_CALL WindowStyleSettings::getGroupFont()
861 {
862 StyleMethodGuard aGuard( *m_pData );
863 return lcl_getStyleFont( *m_pData, &StyleSettings::GetGroupFont );
864 }
865
866
867 void SAL_CALL WindowStyleSettings::setGroupFont( const FontDescriptor& _groupfont )
868 {
869 StyleMethodGuard aGuard( *m_pData );
870 lcl_setStyleFont( *m_pData, &StyleSettings::SetGroupFont, &StyleSettings::GetGroupFont, _groupfont );
871 }
872
873
874 FontDescriptor SAL_CALL WindowStyleSettings::getLabelFont()
875 {
876 StyleMethodGuard aGuard( *m_pData );
877 return lcl_getStyleFont( *m_pData, &StyleSettings::GetLabelFont );
878 }
879
880
881 void SAL_CALL WindowStyleSettings::setLabelFont( const FontDescriptor& _labelfont )
882 {
883 StyleMethodGuard aGuard( *m_pData );
884 lcl_setStyleFont( *m_pData, &StyleSettings::SetLabelFont, &StyleSettings::GetLabelFont, _labelfont );
885 }
886
887
888 FontDescriptor SAL_CALL WindowStyleSettings::getRadioCheckFont()
889 {
890 StyleMethodGuard aGuard( *m_pData );
891 return lcl_getStyleFont( *m_pData, &StyleSettings::GetRadioCheckFont );
892 }
893
894
895 void SAL_CALL WindowStyleSettings::setRadioCheckFont( const FontDescriptor& _radiocheckfont )
896 {
897 StyleMethodGuard aGuard( *m_pData );
898 lcl_setStyleFont( *m_pData, &StyleSettings::SetRadioCheckFont, &StyleSettings::GetRadioCheckFont, _radiocheckfont );
899 }
900
901
902 FontDescriptor SAL_CALL WindowStyleSettings::getPushButtonFont()
903 {
904 StyleMethodGuard aGuard( *m_pData );
905 return lcl_getStyleFont( *m_pData, &StyleSettings::GetPushButtonFont );
906 }
907
908
909 void SAL_CALL WindowStyleSettings::setPushButtonFont( const FontDescriptor& _pushbuttonfont )
910 {
911 StyleMethodGuard aGuard( *m_pData );
912 lcl_setStyleFont( *m_pData, &StyleSettings::SetPushButtonFont, &StyleSettings::GetPushButtonFont, _pushbuttonfont );
913 }
914
915
916 FontDescriptor SAL_CALL WindowStyleSettings::getFieldFont()
917 {
918 StyleMethodGuard aGuard( *m_pData );
919 return lcl_getStyleFont( *m_pData, &StyleSettings::GetFieldFont );
920 }
921
922
923 void SAL_CALL WindowStyleSettings::setFieldFont( const FontDescriptor& _fieldfont )
924 {
925 StyleMethodGuard aGuard( *m_pData );
926 lcl_setStyleFont( *m_pData, &StyleSettings::SetFieldFont, &StyleSettings::GetFieldFont, _fieldfont );
927 }
928
929
930 void SAL_CALL WindowStyleSettings::addStyleChangeListener( const Reference< XStyleChangeListener >& i_rListener )
931 {
932 StyleMethodGuard aGuard( *m_pData );
933 if ( i_rListener.is() )
934 m_pData->aStyleChangeListeners.addInterface( i_rListener );
935 }
936
937
938 void SAL_CALL WindowStyleSettings::removeStyleChangeListener( const Reference< XStyleChangeListener >& i_rListener )
939 {
940 StyleMethodGuard aGuard( *m_pData );
941 if ( i_rListener.is() )
942 m_pData->aStyleChangeListeners.removeInterface( i_rListener );
943 }
944
945
946} // namespace toolkit
947
948
949/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/home/maarten/src/libreoffice/core/include/toolkit/awt/vclxwindow.hxx

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_TOOLKIT_AWT_VCLXWINDOW_HXX
21#define INCLUDED_TOOLKIT_AWT_VCLXWINDOW_HXX
22
23#include <toolkit/dllapi.h>
24#include <toolkit/awt/vclxdevice.hxx>
25#include <vcl/window.hxx>
26
27#include <com/sun/star/awt/XWindow2.hpp>
28#include <com/sun/star/awt/XVclWindowPeer.hpp>
29#include <com/sun/star/awt/XLayoutConstrains.hpp>
30#include <com/sun/star/awt/XView.hpp>
31#include <com/sun/star/beans/XPropertySetInfo.hpp>
32#include <com/sun/star/accessibility/XAccessible.hpp>
33#include <com/sun/star/awt/XDockableWindow.hpp>
34#include <com/sun/star/awt/XStyleSettingsSupplier.hpp>
35
36#include <comphelper/servicehelper.hxx>
37#include <cppuhelper/implbase.hxx>
38
39#include <tools/gen.hxx>
40#include <tools/link.hxx>
41
42#include <memory>
43#include <vector>
44#include <functional>
45
46namespace comphelper { class OInterfaceContainerHelper2; }
47namespace com::sun::star::accessibility { class XAccessibleContext; }
48
49class VclWindowEvent;
50
51namespace toolkit
52{
53 class IAccessibleFactory;
54}
55
56
57class UnoPropertyArrayHelper;
58class VCLXWindowImpl;
59typedef cppu::ImplInheritanceHelper< VCLXDevice,
60 css::awt::XWindow2,
61 css::awt::XVclWindowPeer,
62 css::awt::XLayoutConstrains,
63 css::awt::XView,
64 css::awt::XDockableWindow,
65 css::accessibility::XAccessible,
66 css::lang::XEventListener,
67 css::beans::XPropertySetInfo,
68 css::awt::XStyleSettingsSupplier
69 > VCLXWindow_Base;
70
71class TOOLKIT_DLLPUBLIC__attribute__ ((visibility("default"))) VCLXWindow : public VCLXWindow_Base
72{
73private:
74 std::unique_ptr<VCLXWindowImpl> mpImpl;
75
76 UnoPropertyArrayHelper *GetPropHelper();
77
78protected:
79 Size ImplCalcWindowSize( const Size& rOutSz ) const;
80 DECL_LINK(WindowEventListener, VclWindowEvent&, void )static void LinkStubWindowEventListener(void *, VclWindowEvent
&); void WindowEventListener(VclWindowEvent&)
;
81
82 virtual void ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent );
83 virtual css::uno::Reference< css::accessibility::XAccessibleContext >
84 CreateAccessibleContext();
85
86 void SetSynthesizingVCLEvent( bool b );
87 bool IsSynthesizingVCLEvent() const;
88
89 void SetSystemParent_Impl( const css::uno::Any& rHandle );
90
91 ::toolkit::IAccessibleFactory& getAccessibleFactory();
92
93 // helper ...
94 static void PushPropertyIds( std::vector< sal_uInt16 > &aIds, int nFirstId, ...);
95 // for use in controls/
96 static void ImplGetPropertyIds( std::vector< sal_uInt16 > &aIds,
97 bool bWithDefaults = false );
98 virtual void GetPropertyIds( std::vector< sal_uInt16 > &aIds );
99
100 ::comphelper::OInterfaceContainerHelper2& GetContainerListeners();
101 ::comphelper::OInterfaceContainerHelper2& GetTopWindowListeners();
102
103public:
104 typedef ::std::function<void ()> Callback;
105
106protected:
107 /** executes the given callback asynchronously
108
109 At the moment the callback is called, the Solar Mutex is not locked. In particular, this implies that
110 you cannot rely on |this| not being disposed. However, you *can* rely on |this| being still alive (i.e.
111 having a ref count > 0).
112
113 As a consequence, this can be used for doing listener notifications, using event multiplexers. Those multiplexers
114 care for the disposed state themself, and are alive as long as |this| is alive.
115 */
116 void ImplExecuteAsyncWithoutSolarLock(
117 const Callback& i_callback
118 );
119
120public:
121 VCLXWindow( bool bWithDefaultProps = false );
122 virtual ~VCLXWindow() override;
123
124 virtual void SetWindow( const VclPtr< vcl::Window > &pWindow );
125 template< class derived_type > VclPtr< derived_type > GetAs() const {
126 return VclPtr< derived_type >( static_cast< derived_type * >( GetOutputDevice().get() ) ); }
4
Calling constructor for 'VclPtr<vcl::Window>'
9
Returning from constructor for 'VclPtr<vcl::Window>'
26
Calling 'VclPtr::get'
127 template< class derived_type > VclPtr< derived_type > GetAsDynamic() const {
128 return VclPtr< derived_type >( dynamic_cast< derived_type * >( GetOutputDevice().get() ) ); }
129 VclPtr<vcl::Window> GetWindow() const { return GetAs<vcl::Window>(); }
3
Calling 'VCLXWindow::GetAs'
10
Returning from 'VCLXWindow::GetAs'
25
Calling 'VCLXWindow::GetAs'
130
131 void suspendVclEventListening( );
132 void resumeVclEventListening( );
133
134 void notifyWindowRemoved( vcl::Window const & _rWindow );
135
136 // css::lang::XUnoTunnel
137 UNO3_GETIMPLEMENTATION_DECL(VCLXWindow)static const css::uno::Sequence< sal_Int8 > & getUnoTunnelId
() throw(); virtual sal_Int64 getSomething( const css::uno::Sequence
< sal_Int8 >& aIdentifier ) override;
138
139 // css::lang::XEventListener
140 virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
141
142 // css::lang::XComponent
143 void SAL_CALL dispose( ) override;
144 void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override;
145 void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override;
146
147 // css::awt::XWindow
148 void SAL_CALL setPosSize( sal_Int32 X, sal_Int32 Y, sal_Int32 Width, sal_Int32 Height, sal_Int16 Flags ) override;
149 css::awt::Rectangle SAL_CALL getPosSize( ) override;
150 void SAL_CALL setVisible( sal_Bool Visible ) override;
151 void SAL_CALL setEnable( sal_Bool Enable ) override;
152 void SAL_CALL setFocus( ) override;
153 void SAL_CALL addWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override;
154 void SAL_CALL removeWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override;
155 void SAL_CALL addFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override;
156 void SAL_CALL removeFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override;
157 void SAL_CALL addKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override;
158 void SAL_CALL removeKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override;
159 void SAL_CALL addMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override;
160 void SAL_CALL removeMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override;
161 void SAL_CALL addMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override;
162 void SAL_CALL removeMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override;
163 void SAL_CALL addPaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override;
164 void SAL_CALL removePaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override;
165
166 // css::awt::XWindowPeer
167 css::uno::Reference< css::awt::XToolkit > SAL_CALL getToolkit( ) override;
168 void SAL_CALL setPointer( const css::uno::Reference< css::awt::XPointer >& Pointer ) override;
169 void SAL_CALL setBackground( sal_Int32 Color ) override;
170 void SAL_CALL invalidate( sal_Int16 Flags ) override;
171 void SAL_CALL invalidateRect( const css::awt::Rectangle& Rect, sal_Int16 Flags ) override;
172
173 // css::awt::XVclWindowPeer
174 sal_Bool SAL_CALL isChild( const css::uno::Reference< css::awt::XWindowPeer >& Peer ) override;
175 void SAL_CALL setDesignMode( sal_Bool bOn ) override;
176 sal_Bool SAL_CALL isDesignMode( ) override;
177 void SAL_CALL enableClipSiblings( sal_Bool bClip ) override;
178 void SAL_CALL setForeground( sal_Int32 Color ) override;
179 void SAL_CALL setControlFont( const css::awt::FontDescriptor& aFont ) override;
180 void SAL_CALL getStyles( sal_Int16 nType, css::awt::FontDescriptor& Font, sal_Int32& ForegroundColor, sal_Int32& BackgroundColor ) override;
181 void SAL_CALL setProperty( const OUString& PropertyName, const css::uno::Any& Value ) override;
182 css::uno::Any SAL_CALL getProperty( const OUString& PropertyName ) override;
183
184 // css::awt::XLayoutConstrains
185 css::awt::Size SAL_CALL getMinimumSize( ) override;
186 css::awt::Size SAL_CALL getPreferredSize( ) override;
187 css::awt::Size SAL_CALL calcAdjustedSize( const css::awt::Size& aNewSize ) override;
188
189 // css::awt::XView
190 sal_Bool SAL_CALL setGraphics( const css::uno::Reference< css::awt::XGraphics >& aDevice ) override;
191 css::uno::Reference< css::awt::XGraphics > SAL_CALL getGraphics( ) override;
192 css::awt::Size SAL_CALL getSize( ) override;
193 void SAL_CALL draw( sal_Int32 nX, sal_Int32 nY ) override;
194 void SAL_CALL setZoom( float fZoomX, float fZoomY ) override;
195
196 // css::accessibility::XAccessible
197 css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext( ) override;
198
199 // css::awt::XDockableWindow
200 void SAL_CALL addDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override;
201 void SAL_CALL removeDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override;
202 void SAL_CALL enableDocking( sal_Bool bEnable ) override;
203 sal_Bool SAL_CALL isFloating( ) override;
204 void SAL_CALL setFloatingMode( sal_Bool bFloating ) override;
205 void SAL_CALL lock( ) override;
206 void SAL_CALL unlock( ) override;
207 sal_Bool SAL_CALL isLocked( ) override;
208 void SAL_CALL startPopupMode( const css::awt::Rectangle& WindowRect ) override;
209 sal_Bool SAL_CALL isInPopupMode( ) override;
210
211 // css::awt::XWindow2
212 void SAL_CALL setOutputSize( const css::awt::Size& aSize ) override;
213 css::awt::Size SAL_CALL getOutputSize( ) override;
214 sal_Bool SAL_CALL isVisible( ) override;
215 sal_Bool SAL_CALL isActive( ) override;
216 sal_Bool SAL_CALL isEnabled( ) override;
217 sal_Bool SAL_CALL hasFocus( ) override;
218
219 // css::beans::XPropertySetInfo
220 css::uno::Sequence< css::beans::Property > SAL_CALL getProperties( ) override;
221 css::beans::Property SAL_CALL getPropertyByName( const OUString& aName ) override;
222 sal_Bool SAL_CALL hasPropertyByName( const OUString& Name ) override;
223
224 // XStyleSettingsSupplier
225 virtual css::uno::Reference< css::awt::XStyleSettings > SAL_CALL getStyleSettings() override;
226};
227
228#endif // INCLUDED_TOOLKIT_AWT_VCLXWINDOW_HXX
229
230/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx

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_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
5
Calling constructor for 'Reference<vcl::Window>'
8
Returning from constructor for 'Reference<vcl::Window>'
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__))
;
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
;
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
27
Calling 'Reference::get'
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/home/maarten/src/libreoffice/core/include/rtl/ref.hxx

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_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
6
Assuming field 'm_pBody' is non-null
7
Taking true branch
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
)
14
Taking true branch
113 m_pBody->release();
15
Calling 'VclReferenceBase::release'
19
Returning; memory was released
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
28
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/home/maarten/src/libreoffice/core/include/vcl/vclreferencebase.hxx

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#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
16
Assuming the condition is true
17
Taking true branch
40 delete this;
18
Memory is released
41 }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44 sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47
48
49private:
50 VclReferenceBase(const VclReferenceBase&) = delete;
51 VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52
53 bool mbDisposed : 1;
54
55protected:
56 VclReferenceBase();
57protected:
58 virtual ~VclReferenceBase();
59
60protected:
61 virtual void dispose();
62
63public:
64 void disposeOnce();
65 bool isDisposed() const { return mbDisposed; }
66
67};
68#endif