Bug Summary

File:home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx
Warning:line 133, column 52
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 navbarcontrol.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 -isystem /usr/include/libxml2 -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 SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -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/forms/inc -I /home/maarten/src/libreoffice/core/forms/source/inc -I /home/maarten/src/libreoffice/core/forms/source/solar/inc -I /home/maarten/src/libreoffice/core/workdir/YaccTarget/connectivity/source/parse -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/oovbaapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/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/forms/source/solar/component/navbarcontrol.cxx

/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.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 "navbarcontrol.hxx"
22#include <frm_strings.hxx>
23#include <componenttools.hxx>
24#include <navtoolbar.hxx>
25#include <commandimageprovider.hxx>
26
27#include <com/sun/star/awt/XView.hpp>
28#include <com/sun/star/awt/PosSize.hpp>
29#include <com/sun/star/beans/XPropertySet.hpp>
30#include <com/sun/star/form/runtime/FormFeature.hpp>
31#include <com/sun/star/awt/XControlModel.hpp>
32#include <com/sun/star/frame/ModuleManager.hpp>
33
34#include <tools/debug.hxx>
35#include <tools/diagnose_ex.h>
36#include <vcl/svapp.hxx>
37#include <vcl/settings.hxx>
38
39
40namespace frm
41{
42
43 using namespace ::com::sun::star::uno;
44 using namespace ::com::sun::star::beans;
45 using namespace ::com::sun::star::awt;
46 using namespace ::com::sun::star::lang;
47 using namespace ::com::sun::star::frame;
48 using namespace ::com::sun::star::graphic;
49 namespace FormFeature = ::com::sun::star::form::runtime::FormFeature;
50
51#define FORWARD_TO_PEER_1( unoInterface, method, param1 )Reference< unoInterface > xTypedPeer( getPeer(), UNO_QUERY
); if ( xTypedPeer.is() ) { xTypedPeer->method( param1 );
} \
52 Reference< unoInterface > xTypedPeer( getPeer(), UNO_QUERY ); \
53 if ( xTypedPeer.is() ) \
54 { \
55 xTypedPeer->method( param1 ); \
56 }
57
58 ONavigationBarControl::ONavigationBarControl( const Reference< XComponentContext >& _rxORB)
59 :UnoControl(), m_xContext(_rxORB)
60 {
61 }
62
63
64 ONavigationBarControl::~ONavigationBarControl()
65 {
66 }
67
68
69 IMPLEMENT_FORWARD_XTYPEPROVIDER2( ONavigationBarControl, UnoControl, ONavigationBarControl_Base )css::uno::Sequence< css::uno::Type > ONavigationBarControl
::getTypes( ) { return ::comphelper::concatSequences( UnoControl
::getTypes(), ONavigationBarControl_Base::getTypes() ); } css
::uno::Sequence< sal_Int8 > ONavigationBarControl::getImplementationId
( ) { return css::uno::Sequence<sal_Int8>(); }
70
71
72 Any SAL_CALL ONavigationBarControl::queryAggregation( const Type& _rType )
73 {
74 Any aReturn = UnoControl::queryAggregation( _rType );
75
76 if ( !aReturn.hasValue() )
77 aReturn = ONavigationBarControl_Base::queryInterface( _rType );
78
79 return aReturn;
80 }
81
82
83 namespace
84 {
85
86 WinBits lcl_getWinBits_nothrow( const Reference< XControlModel >& _rxModel )
87 {
88 WinBits nBits = 0;
89 try
90 {
91 Reference< XPropertySet > xProps( _rxModel, UNO_QUERY );
92 if ( xProps.is() )
93 {
94 sal_Int16 nBorder = 0;
95 xProps->getPropertyValue( PROPERTY_BORDER"Border" ) >>= nBorder;
96 if ( nBorder )
97 nBits |= WB_BORDER;
98
99 bool bTabStop = false;
100 if ( xProps->getPropertyValue( PROPERTY_TABSTOP"Tabstop" ) >>= bTabStop )
101 nBits |= ( bTabStop ? WB_TABSTOP : WB_NOTABSTOP );
102 }
103 }
104 catch( const Exception& )
105 {
106 DBG_UNHANDLED_EXCEPTION("forms.component")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "106" ": ", "forms.component" );;
107 }
108 return nBits;
109 }
110 }
111
112
113 void SAL_CALL ONavigationBarControl::createPeer( const Reference< XToolkit >& /*_rToolkit*/, const Reference< XWindowPeer >& _rParentPeer )
114 {
115 SolarMutexGuard aGuard;
116
117 if (getPeer().is())
1
Taking false branch
→
118 return;
119
120 mbCreatingPeer = true;
121
122 // determine the VLC window for the parent
123 vcl::Window* pParentWin = nullptr;
124 if ( _rParentPeer.is() )
2
←
Taking true branch
→
125 {
126 VCLXWindow* pParentXWin = comphelper::getUnoTunnelImplementation<VCLXWindow>( _rParentPeer );
127 if ( pParentXWin )
3
←
Assuming 'pParentXWin' is non-null
→
4
←
Taking true branch
→
128 pParentWin = pParentXWin->GetWindow().get();
5
←
Calling 'VCLXWindow::GetWindow'
→
14
←
Returning from 'VCLXWindow::GetWindow'
→
15
←
Calling implicit destructor for 'VclPtr<vcl::Window>'
→
16
←
Calling '~Reference'
→
23
←
Returning from '~Reference'
→
24
←
Returning from destructor for 'VclPtr<vcl::Window>'
→
129 DBG_ASSERT( pParentWin, "ONavigationBarControl::createPeer: could not obtain the VCL-level parent window!" )do { if (true && (!(pParentWin))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "129" ": "), "%s", "ONavigationBarControl::createPeer: could not obtain the VCL-level parent window!"
); } } while (false);
25
←
Taking false branch
→
26
←
Loop condition is false. Exiting loop
→
130 }
131
132 // create the peer
133 rtl::Reference<ONavigationBarPeer> pPeer = ONavigationBarPeer::Create( m_xContext, pParentWin, getModel() );
27
←
Use of memory after it is freed
134 assert(pPeer && "ONavigationBarControl::createPeer: invalid peer returned!")(static_cast <bool> (pPeer && "ONavigationBarControl::createPeer: invalid peer returned!"
) ? void (0) : __assert_fail ("pPeer && \"ONavigationBarControl::createPeer: invalid peer returned!\""
, "/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
, 134, __extension__ __PRETTY_FUNCTION__));
135
136 // announce the peer to the base class
137 setPeer( pPeer.get() );
138
139 // initialize ourself (and thus the peer) with the model properties
140 updateFromModel();
141
142 Reference< XView > xPeerView( getPeer(), UNO_QUERY );
143 if ( xPeerView.is() )
144 {
145 xPeerView->setZoom( maComponentInfos.nZoomX, maComponentInfos.nZoomY );
146 xPeerView->setGraphics( mxGraphics );
147 }
148
149 // a lot of initial settings from our component infos
150 setPosSize( maComponentInfos.nX, maComponentInfos.nY, maComponentInfos.nWidth, maComponentInfos.nHeight, PosSize::POSSIZE );
151
152 pPeer->setVisible ( maComponentInfos.bVisible && !mbDesignMode );
153 pPeer->setEnable ( maComponentInfos.bEnable );
154 pPeer->setDesignMode( mbDesignMode );
155
156 peerCreated();
157
158 mbCreatingPeer = false;
159 }
160
161
162 OUString SAL_CALL ONavigationBarControl::getImplementationName()
163 {
164 return "com.sun.star.comp.form.ONavigationBarControl";
165 }
166
167
168 Sequence< OUString > SAL_CALL ONavigationBarControl::getSupportedServiceNames()
169 {
170 return { "com.sun.star.awt.UnoControl",
171 "com.sun.star.form.control.NavigationToolBar" };
172 }
173
174
175 void SAL_CALL ONavigationBarControl::registerDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor )
176 {
177 FORWARD_TO_PEER_1( XDispatchProviderInterception, registerDispatchProviderInterceptor, _rxInterceptor )Reference< XDispatchProviderInterception > xTypedPeer( getPeer
(), UNO_QUERY ); if ( xTypedPeer.is() ) { xTypedPeer->registerDispatchProviderInterceptor
( _rxInterceptor ); };
178 }
179
180
181 void SAL_CALL ONavigationBarControl::releaseDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor )
182 {
183 FORWARD_TO_PEER_1( XDispatchProviderInterception, releaseDispatchProviderInterceptor, _rxInterceptor )Reference< XDispatchProviderInterception > xTypedPeer( getPeer
(), UNO_QUERY ); if ( xTypedPeer.is() ) { xTypedPeer->releaseDispatchProviderInterceptor
( _rxInterceptor ); };
184 }
185
186
187 void SAL_CALL ONavigationBarControl::setDesignMode( sal_Bool _bOn )
188 {
189 UnoControl::setDesignMode( _bOn );
190 FORWARD_TO_PEER_1( XVclWindowPeer, setDesignMode, _bOn )Reference< XVclWindowPeer > xTypedPeer( getPeer(), UNO_QUERY
); if ( xTypedPeer.is() ) { xTypedPeer->setDesignMode( _bOn
); };
191 }
192
193
194 // ONavigationBarPeer
195
196
197 rtl::Reference<ONavigationBarPeer> ONavigationBarPeer::Create( const Reference< XComponentContext >& _rxORB,
198 vcl::Window* _pParentWindow, const Reference< XControlModel >& _rxModel )
199 {
200 DBG_TESTSOLARMUTEX()do { DbgTestSolarMutex(); } while(false);
201
202 // the peer itself
203 rtl::Reference<ONavigationBarPeer> pPeer(new ONavigationBarPeer( _rxORB ));
204
205 // the VCL control for the peer
206 Reference< XModel > xContextDocument( getXModel( _rxModel ) );
207 Reference< XModuleManager2 > xModuleManager( ModuleManager::create(_rxORB) );
208 OUString sModuleID = xModuleManager->identify( xContextDocument );
209
210 VclPtrInstance<NavigationToolBar> pNavBar(
211 _pParentWindow,
212 lcl_getWinBits_nothrow( _rxModel ),
213 std::make_shared<DocumentCommandImageProvider>( _rxORB, xContextDocument ),
214 sModuleID
215 );
216
217 // some knittings
218 pNavBar->setDispatcher( pPeer.get() );
219 pNavBar->SetComponentInterface( pPeer.get() );
220
221 // we want a faster repeating rate for the slots in this
222 // toolbox
223 AllSettings aSettings = pNavBar->GetSettings();
224 MouseSettings aMouseSettings = aSettings.GetMouseSettings();
225 aMouseSettings.SetButtonRepeat( 10 );
226 aSettings.SetMouseSettings( aMouseSettings );
227 pNavBar->SetSettings( aSettings, true );
228
229 // outta here
230 return pPeer;
231 }
232
233
234 ONavigationBarPeer::ONavigationBarPeer( const Reference< XComponentContext >& _rxORB )
235 :OFormNavigationHelper( _rxORB )
236 {
237 }
238
239
240 ONavigationBarPeer::~ONavigationBarPeer()
241 {
242 }
243
244
245 IMPLEMENT_FORWARD_XINTERFACE2( ONavigationBarPeer, VCLXWindow, OFormNavigationHelper )void ONavigationBarPeer::acquire() throw() { VCLXWindow::acquire
(); } void ONavigationBarPeer::release() throw() { VCLXWindow
::release(); } css::uno::Any ONavigationBarPeer::queryInterface
( const css::uno::Type& _rType ) { css::uno::Any aReturn =
VCLXWindow::queryInterface( _rType ); if ( !aReturn.hasValue
() ) aReturn = OFormNavigationHelper::queryInterface( _rType )
; return aReturn; }
246
247
248 IMPLEMENT_FORWARD_XTYPEPROVIDER2( ONavigationBarPeer, VCLXWindow, OFormNavigationHelper )css::uno::Sequence< css::uno::Type > ONavigationBarPeer
::getTypes( ) { return ::comphelper::concatSequences( VCLXWindow
::getTypes(), OFormNavigationHelper::getTypes() ); } css::uno
::Sequence< sal_Int8 > ONavigationBarPeer::getImplementationId
( ) { return css::uno::Sequence<sal_Int8>(); }
249
250
251 void SAL_CALL ONavigationBarPeer::dispose( )
252 {
253 VCLXWindow::dispose();
254 OFormNavigationHelper::dispose();
255 }
256
257
258 void SAL_CALL ONavigationBarPeer::setProperty( const OUString& _rPropertyName, const Any& _rValue )
259 {
260 SolarMutexGuard aGuard;
261
262 VclPtr< NavigationToolBar > pNavBar = GetAs< NavigationToolBar >();
263 if ( !pNavBar )
264 {
265 VCLXWindow::setProperty( _rPropertyName, _rValue );
266 return;
267 }
268
269 bool bVoid = !_rValue.hasValue();
270
271 bool bBoolValue = false;
272 Color nColor = COL_TRANSPARENT;
273
274 // TODO: more generic mechanisms for this (the grid control implementation,
275 // when used herein, will do the same stuff for lot of these)
276
277 if ( _rPropertyName == PROPERTY_BACKGROUNDCOLOR"BackgroundColor" )
278 {
279 if ( bVoid )
280 {
281 pNavBar->SetBackground( pNavBar->GetSettings().GetStyleSettings().GetFaceColor() );
282 pNavBar->SetControlBackground();
283 }
284 else
285 {
286 OSL_VERIFY( _rValue >>= nColor )do { if (!(_rValue >>= nColor)) do { if (true &&
(!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "286" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0);
287 Color aColor( nColor );
288 pNavBar->SetBackground( aColor );
289 pNavBar->SetControlBackground( aColor );
290 }
291 }
292 else if ( _rPropertyName == PROPERTY_TEXTLINECOLOR"TextLineColor" )
293 {
294 if ( bVoid )
295 {
296 pNavBar->SetTextLineColor();
297 }
298 else
299 {
300 OSL_VERIFY( _rValue >>= nColor )do { if (!(_rValue >>= nColor)) do { if (true &&
(!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "300" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0);
301 pNavBar->SetTextLineColor( nColor );
302 }
303 }
304 else if ( _rPropertyName == PROPERTY_ICONSIZE"IconSize" )
305 {
306 sal_Int16 nInt16Value = 0;
307 OSL_VERIFY( _rValue >>= nInt16Value )do { if (!(_rValue >>= nInt16Value)) do { if (true &&
(!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "307" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0);
308 pNavBar->SetImageSize( nInt16Value ? NavigationToolBar::eLarge : NavigationToolBar::eSmall );
309 }
310 else if ( _rPropertyName == PROPERTY_SHOW_POSITION"ShowPosition" )
311 {
312 OSL_VERIFY( _rValue >>= bBoolValue )do { if (!(_rValue >>= bBoolValue)) do { if (true &&
(!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "312" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0);
313 pNavBar->ShowFunctionGroup( NavigationToolBar::ePosition, bBoolValue );
314 }
315 else if ( _rPropertyName == PROPERTY_SHOW_NAVIGATION"ShowNavigation" )
316 {
317 OSL_VERIFY( _rValue >>= bBoolValue )do { if (!(_rValue >>= bBoolValue)) do { if (true &&
(!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "317" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0);
318 pNavBar->ShowFunctionGroup( NavigationToolBar::eNavigation, bBoolValue );
319 }
320 else if ( _rPropertyName == PROPERTY_SHOW_RECORDACTIONS"ShowRecordActions" )
321 {
322 OSL_VERIFY( _rValue >>= bBoolValue )do { if (!(_rValue >>= bBoolValue)) do { if (true &&
(!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "322" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0);
323 pNavBar->ShowFunctionGroup( NavigationToolBar::eRecordActions, bBoolValue );
324 }
325 else if ( _rPropertyName == PROPERTY_SHOW_FILTERSORT"ShowFilterSort" )
326 {
327 OSL_VERIFY( _rValue >>= bBoolValue )do { if (!(_rValue >>= bBoolValue)) do { if (true &&
(!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/component/navbarcontrol.cxx"
":" "327" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0);
328 pNavBar->ShowFunctionGroup( NavigationToolBar::eFilterSort, bBoolValue );
329 }
330 else
331 {
332 VCLXWindow::setProperty( _rPropertyName, _rValue );
333 }
334 }
335
336
337 Any SAL_CALL ONavigationBarPeer::getProperty( const OUString& _rPropertyName )
338 {
339 SolarMutexGuard aGuard;
340
341 Any aReturn;
342 VclPtr< NavigationToolBar > pNavBar = GetAs< NavigationToolBar >();
343
344 if ( _rPropertyName == PROPERTY_BACKGROUNDCOLOR"BackgroundColor" )
345 {
346 aReturn <<= pNavBar->GetControlBackground();
347 }
348 else if ( _rPropertyName == PROPERTY_TEXTLINECOLOR"TextLineColor" )
349 {
350 aReturn <<= pNavBar->GetTextLineColor();
351 }
352 else if ( _rPropertyName == PROPERTY_ICONSIZE"IconSize" )
353 {
354 sal_Int16 nIconType = ( NavigationToolBar::eLarge == pNavBar->GetImageSize() )
355 ? 1 : 0;
356 aReturn <<= nIconType;
357 }
358 else if ( _rPropertyName == PROPERTY_SHOW_POSITION"ShowPosition" )
359 {
360 aReturn <<= pNavBar->IsFunctionGroupVisible( NavigationToolBar::ePosition );
361 }
362 else if ( _rPropertyName == PROPERTY_SHOW_NAVIGATION"ShowNavigation" )
363 {
364 aReturn <<= pNavBar->IsFunctionGroupVisible( NavigationToolBar::eNavigation );
365 }
366 else if ( _rPropertyName == PROPERTY_SHOW_RECORDACTIONS"ShowRecordActions" )
367 {
368 aReturn <<= pNavBar->IsFunctionGroupVisible( NavigationToolBar::eRecordActions );
369 }
370 else if ( _rPropertyName == PROPERTY_SHOW_FILTERSORT"ShowFilterSort" )
371 {
372 aReturn <<= pNavBar->IsFunctionGroupVisible( NavigationToolBar::eFilterSort );
373 }
374 else
375 aReturn = VCLXWindow::getProperty( _rPropertyName );
376
377 return aReturn;
378 }
379
380
381 void ONavigationBarPeer::interceptorsChanged( )
382 {
383 if ( isDesignMode() )
384 // not interested in if we're in design mode
385 return;
386
387 OFormNavigationHelper::interceptorsChanged();
388 }
389
390
391 void ONavigationBarPeer::featureStateChanged( sal_Int16 _nFeatureId, bool _bEnabled )
392 {
393 // enable this button on the toolbox
394 VclPtr< NavigationToolBar > pNavBar = GetAs< NavigationToolBar >();
395 if ( pNavBar )
396 {
397 pNavBar->enableFeature( _nFeatureId, _bEnabled );
398
399 // is it a feature with additional state information?
400 if ( _nFeatureId == FormFeature::ToggleApplyFilter )
401 { // additional boolean state
402 pNavBar->checkFeature( _nFeatureId, getBooleanState( _nFeatureId ) );
403 }
404 else if ( _nFeatureId == FormFeature::TotalRecords )
405 {
406 pNavBar->setFeatureText( _nFeatureId, getStringState( _nFeatureId ) );
407 }
408 else if ( _nFeatureId == FormFeature::MoveAbsolute )
409 {
410 pNavBar->setFeatureText( _nFeatureId, OUString::number(getIntegerState(_nFeatureId)) );
411 }
412 }
413
414 // base class
415 OFormNavigationHelper::featureStateChanged( _nFeatureId, _bEnabled );
416 }
417
418
419 void ONavigationBarPeer::allFeatureStatesChanged( )
420 {
421 {
422 // force the control to update it's states
423 SolarMutexGuard g;
424 VclPtr< NavigationToolBar > pNavBar = GetAs< NavigationToolBar >();
425 if ( pNavBar )
426 pNavBar->setDispatcher( this );
427 }
428
429 // base class
430 OFormNavigationHelper::allFeatureStatesChanged( );
431 }
432
433
434 bool ONavigationBarPeer::isEnabled( sal_Int16 _nFeatureId ) const
435 {
436 if ( const_cast< ONavigationBarPeer* >( this )->isDesignMode() )
437 return false;
438
439 return OFormNavigationHelper::isEnabled( _nFeatureId );
440 }
441
442
443 void SAL_CALL ONavigationBarPeer::setDesignMode( sal_Bool _bOn )
444 {
445 VCLXWindow::setDesignMode( _bOn );
446
447 if ( _bOn )
448 disconnectDispatchers();
449 else
450 connectDispatchers();
451 // this will connect if not already connected and just update else
452 }
453
454
455 void SAL_CALL ONavigationBarPeer::disposing( const EventObject& _rSource )
456 {
457 VCLXWindow::disposing( _rSource );
458 OFormNavigationHelper::disposing( _rSource );
459 }
460
461
462 void ONavigationBarPeer::getSupportedFeatures( ::std::vector< sal_Int16 >& _rFeatureIds )
463 {
464 _rFeatureIds.push_back( FormFeature::MoveAbsolute );
465 _rFeatureIds.push_back( FormFeature::TotalRecords );
466 _rFeatureIds.push_back( FormFeature::MoveToFirst );
467 _rFeatureIds.push_back( FormFeature::MoveToPrevious );
468 _rFeatureIds.push_back( FormFeature::MoveToNext );
469 _rFeatureIds.push_back( FormFeature::MoveToLast );
470 _rFeatureIds.push_back( FormFeature::SaveRecordChanges );
471 _rFeatureIds.push_back( FormFeature::UndoRecordChanges );
472 _rFeatureIds.push_back( FormFeature::MoveToInsertRow );
473 _rFeatureIds.push_back( FormFeature::DeleteRecord );
474 _rFeatureIds.push_back( FormFeature::ReloadForm );
475 _rFeatureIds.push_back( FormFeature::RefreshCurrentControl );
476 _rFeatureIds.push_back( FormFeature::SortAscending );
477 _rFeatureIds.push_back( FormFeature::SortDescending );
478 _rFeatureIds.push_back( FormFeature::InteractiveSort );
479 _rFeatureIds.push_back( FormFeature::AutoFilter );
480 _rFeatureIds.push_back( FormFeature::InteractiveFilter );
481 _rFeatureIds.push_back( FormFeature::ToggleApplyFilter );
482 _rFeatureIds.push_back( FormFeature::RemoveFilterAndSort );
483 }
484
485} // namespace frm
486
487
488extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface*
489com_sun_star_comp_form_ONavigationBarControl_get_implementation (css::uno::XComponentContext* context,
490 css::uno::Sequence<css::uno::Any> const &)
491{
492 return cppu::acquire(new frm::ONavigationBarControl(context));
493}
494
495/* 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() ) ); }
7
←
Calling constructor for 'VclPtr<vcl::Window>'
→
12
←
Returning from constructor for 'VclPtr<vcl::Window>'
→
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>(); }
6
←
Calling 'VCLXWindow::GetAs'
→
13
←
Returning from '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)
8
←
Calling constructor for 'Reference<vcl::Window>'
→
11
←
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();
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)
9
←
Assuming field 'm_pBody' is non-null
→
10
←
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
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
)
17
←
Taking true branch
→
113 m_pBody->release();
18
←
Calling 'VclReferenceBase::release'
→
22
←
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;
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)
19
←
Assuming the condition is true
→
20
←
Taking true branch
→
40 delete this;
21
←
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