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 statusbarmanager.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 FWK_DLLIMPLEMENTATION -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/framework/source/inc -I /home/maarten/src/libreoffice/core/framework/inc -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -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/workdir/CustomTarget/officecfg/registry -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/framework/source/uielement/statusbarmanager.cxx

/home/maarten/src/libreoffice/core/framework/source/uielement/statusbarmanager.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#include <uielement/statusbarmanager.hxx>
21#include <uielement/genericstatusbarcontroller.hxx>
22
23#include <framework/sfxhelperfunctions.hxx>
24#include <framework/addonsoptions.hxx>
25#include <uielement/statusbarmerger.hxx>
26#include <uielement/statusbaritem.hxx>
27#include <com/sun/star/frame/XLayoutManager.hpp>
28#include <com/sun/star/frame/theStatusbarControllerFactory.hpp>
29#include <com/sun/star/ui/ItemStyle.hpp>
30#include <com/sun/star/ui/ItemType.hpp>
31#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
32#include <com/sun/star/lang/XMultiServiceFactory.hpp>
33#include <com/sun/star/beans/XPropertySet.hpp>
34#include <com/sun/star/awt/Command.hpp>
35#include <com/sun/star/ui/XStatusbarItem.hpp>
36#include <comphelper/processfactory.hxx>
37#include <comphelper/sequence.hxx>
38#include <toolkit/helper/vclunohelper.hxx>
39#include <svtools/statusbarcontroller.hxx>
40#include <tools/debug.hxx>
41
42#include <vcl/commandevent.hxx>
43#include <vcl/event.hxx>
44#include <vcl/status.hxx>
45#include <vcl/svapp.hxx>
46#include <vcl/settings.hxx>
47#include <vcl/commandinfoprovider.hxx>
48
49#include <cassert>
50
51using namespace ::com::sun::star;
52
53namespace framework
54{
55
56namespace
57{
58
59template< class MAP >
60struct lcl_UpdateController
61{
62 void operator()( typename MAP::value_type &rElement ) const
63 {
64 try
65 {
66 if ( rElement.second.is() )
67 rElement.second->update();
68 }
69 catch ( uno::Exception& )
70 {
71 }
72 }
73};
74
75template< class MAP >
76struct lcl_RemoveController
77{
78 void operator()( typename MAP::value_type &rElement ) const
79 {
80 try
81 {
82 if ( rElement.second.is() )
83 rElement.second->dispose();
84 }
85 catch ( uno::Exception& )
86 {
87 }
88 }
89};
90
91StatusBarItemBits impl_convertItemStyleToItemBits( sal_Int16 nStyle )
92{
93 StatusBarItemBits nItemBits( StatusBarItemBits::NONE );
94
95 if (( nStyle & css::ui::ItemStyle::ALIGN_RIGHT ) == css::ui::ItemStyle::ALIGN_RIGHT )
96 nItemBits |= StatusBarItemBits::Right;
97 else if ( nStyle & css::ui::ItemStyle::ALIGN_LEFT )
98 nItemBits |= StatusBarItemBits::Left;
99 else
100 nItemBits |= StatusBarItemBits::Center;
101
102 if (( nStyle & css::ui::ItemStyle::DRAW_FLAT ) == css::ui::ItemStyle::DRAW_FLAT )
103 nItemBits |= StatusBarItemBits::Flat;
104 else if ( nStyle & css::ui::ItemStyle::DRAW_OUT3D )
105 nItemBits |= StatusBarItemBits::Out;
106 else
107 nItemBits |= StatusBarItemBits::In;
108
109 if (( nStyle & css::ui::ItemStyle::AUTO_SIZE ) == css::ui::ItemStyle::AUTO_SIZE )
110 nItemBits |= StatusBarItemBits::AutoSize;
111 if ( nStyle & css::ui::ItemStyle::OWNER_DRAW )
112 nItemBits |= StatusBarItemBits::UserDraw;
113
114 if ( nStyle & css::ui::ItemStyle::MANDATORY )
115 nItemBits |= StatusBarItemBits::Mandatory;
116
117 return nItemBits;
118}
119
120}
121
122StatusBarManager::StatusBarManager(
123 const uno::Reference< uno::XComponentContext >& rxContext,
124 const uno::Reference< frame::XFrame >& rFrame,
125 StatusBar* pStatusBar ) :
126 m_bDisposed( false ),
127 m_bFrameActionRegistered( false ),
128 m_bUpdateControllers( false ),
129 m_pStatusBar( pStatusBar ),
130 m_xFrame( rFrame ),
131 m_aListenerContainer( m_mutex ),
132 m_xContext( rxContext )
133{
134
135 m_xStatusbarControllerFactory = frame::theStatusbarControllerFactory::get(
136 ::comphelper::getProcessComponentContext());
137
138 m_pStatusBar->AdjustItemWidthsForHiDPI();
139 m_pStatusBar->SetClickHdl( LINK( this, StatusBarManager, Click )::tools::detail::makeLink( ::tools::detail::castTo<StatusBarManager
*>(this), &StatusBarManager::LinkStubClick)
);
140 m_pStatusBar->SetDoubleClickHdl( LINK( this, StatusBarManager, DoubleClick )::tools::detail::makeLink( ::tools::detail::castTo<StatusBarManager
*>(this), &StatusBarManager::LinkStubDoubleClick)
);
141}
142
143StatusBarManager::~StatusBarManager()
144{
145}
146
147StatusBar* StatusBarManager::GetStatusBar() const
148{
149 SolarMutexGuard g;
150 return m_pStatusBar;
151}
152
153void StatusBarManager::frameAction( const frame::FrameActionEvent& Action )
154{
155 SolarMutexGuard g;
156 if ( Action.Action == frame::FrameAction_CONTEXT_CHANGED )
157 UpdateControllers();
158}
159
160void SAL_CALL StatusBarManager::disposing( const lang::EventObject& Source )
161{
162 SolarMutexGuard g;
163
164 if ( m_bDisposed )
165 return;
166
167 RemoveControllers();
168
169 if ( Source.Source == uno::Reference< uno::XInterface >( m_xFrame, uno::UNO_QUERY ))
170 m_xFrame.clear();
171
172 m_xContext.clear();
173}
174
175// XComponent
176void SAL_CALL StatusBarManager::dispose()
177{
178 uno::Reference< lang::XComponent > xThis(
179 static_cast< OWeakObject* >(this), uno::UNO_QUERY );
180
181 lang::EventObject aEvent( xThis );
182 m_aListenerContainer.disposeAndClear( aEvent );
183
184 {
185 SolarMutexGuard g;
186 if ( m_bDisposed )
1
Assuming field 'm_bDisposed' is false
2
Taking false branch
187 return;
188
189 RemoveControllers();
190
191 // destroy the item data
192 for ( sal_uInt16 n = 0; n < m_pStatusBar->GetItemCount(); n++ )
3
Assuming the condition is false
4
Loop condition is false. Execution continues on line 199
193 {
194 AddonStatusbarItemData *pUserData = static_cast< AddonStatusbarItemData *>(
195 m_pStatusBar->GetItemData( m_pStatusBar->GetItemId( n ) ) );
196 delete pUserData;
197 }
198
199 m_pStatusBar.disposeAndClear();
5
Calling 'VclPtr::disposeAndClear'
200
201 if ( m_bFrameActionRegistered && m_xFrame.is() )
202 {
203 try
204 {
205 m_xFrame->removeFrameActionListener( uno::Reference< frame::XFrameActionListener >(
206 static_cast< ::cppu::OWeakObject *>( this ),
207 uno::UNO_QUERY ));
208 }
209 catch ( const uno::Exception& )
210 {
211 }
212 }
213
214 m_xFrame.clear();
215 m_xContext.clear();
216
217 m_bDisposed = true;
218 }
219}
220
221void SAL_CALL StatusBarManager::addEventListener( const uno::Reference< lang::XEventListener >& xListener )
222{
223 SolarMutexGuard g;
224
225 /* SAFE AREA ----------------------------------------------------------------------------------------------- */
226 if ( m_bDisposed )
227 throw lang::DisposedException();
228
229 m_aListenerContainer.addInterface( cppu::UnoType<lang::XEventListener>::get(), xListener );
230}
231
232void SAL_CALL StatusBarManager::removeEventListener( const uno::Reference< lang::XEventListener >& xListener )
233{
234 m_aListenerContainer.removeInterface( cppu::UnoType<lang::XEventListener>::get(), xListener );
235}
236
237// XUIConfigurationListener
238void SAL_CALL StatusBarManager::elementInserted( const css::ui::ConfigurationEvent& )
239{
240 SolarMutexGuard g;
241
242 if ( m_bDisposed )
243 return;
244}
245
246void SAL_CALL StatusBarManager::elementRemoved( const css::ui::ConfigurationEvent& )
247{
248 SolarMutexGuard g;
249
250 if ( m_bDisposed )
251 return;
252}
253
254void SAL_CALL StatusBarManager::elementReplaced( const css::ui::ConfigurationEvent& )
255{
256 SolarMutexGuard g;
257
258 if ( m_bDisposed )
259 return;
260}
261
262void StatusBarManager::UpdateControllers()
263{
264 if ( !m_bUpdateControllers )
265 {
266 m_bUpdateControllers = true;
267 std::for_each( m_aControllerMap.begin(),
268 m_aControllerMap.end(),
269 lcl_UpdateController< StatusBarControllerMap >() );
270 }
271 m_bUpdateControllers = false;
272}
273
274void StatusBarManager::RemoveControllers()
275{
276 DBG_TESTSOLARMUTEX()do { DbgTestSolarMutex(); } while(false);
277 assert(!m_bDisposed)(static_cast <bool> (!m_bDisposed) ? void (0) : __assert_fail
("!m_bDisposed", "/home/maarten/src/libreoffice/core/framework/source/uielement/statusbarmanager.cxx"
, 277, __extension__ __PRETTY_FUNCTION__))
;
278
279 std::for_each( m_aControllerMap.begin(),
280 m_aControllerMap.end(),
281 lcl_RemoveController< StatusBarControllerMap >() );
282 m_aControllerMap.clear();
283}
284
285void StatusBarManager::CreateControllers()
286{
287 uno::Reference< awt::XWindow > xStatusbarWindow = VCLUnoHelper::GetInterface( m_pStatusBar );
288
289 for ( sal_uInt16 i = 0; i < m_pStatusBar->GetItemCount(); i++ )
290 {
291 sal_uInt16 nId = m_pStatusBar->GetItemId( i );
292 if ( nId == 0 )
293 continue;
294
295 OUString aCommandURL( m_pStatusBar->GetItemCommand( nId ));
296 bool bInit( true );
297 uno::Reference< frame::XStatusbarController > xController;
298 AddonStatusbarItemData *pItemData = static_cast< AddonStatusbarItemData *>( m_pStatusBar->GetItemData( nId ) );
299 uno::Reference< ui::XStatusbarItem > xStatusbarItem(
300 static_cast< cppu::OWeakObject *>( new StatusbarItem( m_pStatusBar, nId, aCommandURL ) ),
301 uno::UNO_QUERY );
302
303 beans::PropertyValue aPropValue;
304 std::vector< uno::Any > aPropVector;
305
306 aPropValue.Name = "CommandURL";
307 aPropValue.Value <<= aCommandURL;
308 aPropVector.push_back( uno::makeAny( aPropValue ) );
309
310 aPropValue.Name = "ModuleIdentifier";
311 aPropValue.Value <<= OUString();
312 aPropVector.push_back( uno::makeAny( aPropValue ) );
313
314 aPropValue.Name = "Frame";
315 aPropValue.Value <<= m_xFrame;
316 aPropVector.push_back( uno::makeAny( aPropValue ) );
317
318 // TODO remove this
319 aPropValue.Name = "ServiceManager";
320 aPropValue.Value <<= uno::Reference<lang::XMultiServiceFactory>(m_xContext->getServiceManager(), uno::UNO_QUERY_THROW);
321 aPropVector.push_back( uno::makeAny( aPropValue ) );
322
323 aPropValue.Name = "ParentWindow";
324 aPropValue.Value <<= xStatusbarWindow;
325 aPropVector.push_back( uno::makeAny( aPropValue ) );
326
327 // TODO still needing with the css::ui::XStatusbarItem?
328 aPropValue.Name = "Identifier";
329 aPropValue.Value <<= nId;
330 aPropVector.push_back( uno::makeAny( aPropValue ) );
331
332 aPropValue.Name = "StatusbarItem";
333 aPropValue.Value <<= xStatusbarItem;
334 aPropVector.push_back( uno::makeAny( aPropValue ) );
335
336 uno::Sequence< uno::Any > aArgs( comphelper::containerToSequence( aPropVector ) );
337
338 // 1) UNO Statusbar controllers, registered in Controllers.xcu
339 if ( m_xStatusbarControllerFactory.is() &&
340 m_xStatusbarControllerFactory->hasController( aCommandURL, "" ))
341 {
342 xController.set(m_xStatusbarControllerFactory->createInstanceWithArgumentsAndContext(
343 aCommandURL, aArgs, m_xContext ),
344 uno::UNO_QUERY );
345 bInit = false; // Initialization is done through the factory service
346 }
347
348 if ( !xController.is() )
349 {
350 // 2) Old SFX2 Statusbar controllers
351 svt::StatusbarController* pController = CreateStatusBarController( m_xFrame, m_pStatusBar, nId, aCommandURL );
352 if ( !pController )
353 {
354 // 3) Is Add-on? Generic statusbar controller
355 if ( pItemData )
356 {
357 pController = new GenericStatusbarController( m_xContext,
358 m_xFrame,
359 xStatusbarItem,
360 pItemData );
361 }
362 else
363 {
364 // 4) Default Statusbar controller
365 pController = new svt::StatusbarController( m_xContext, m_xFrame, aCommandURL, nId );
366 }
367 }
368
369 xController = pController;
370 }
371
372 m_aControllerMap[nId] = xController;
373 if ( bInit )
374 {
375 xController->initialize( aArgs );
376 }
377 }
378
379 // add frame action listeners
380 if ( !m_bFrameActionRegistered && m_xFrame.is() )
381 {
382 m_bFrameActionRegistered = true;
383 m_xFrame->addFrameActionListener( uno::Reference< frame::XFrameActionListener >(
384 static_cast< ::cppu::OWeakObject *>( this ), uno::UNO_QUERY ));
385 }
386}
387
388void StatusBarManager::FillStatusBar( const uno::Reference< container::XIndexAccess >& rItemContainer )
389{
390 SolarMutexGuard g;
391
392 if ( m_bDisposed || !m_pStatusBar )
393 return;
394
395 sal_uInt16 nId( 1 );
396
397 RemoveControllers();
398
399 // reset and fill command map
400 m_pStatusBar->Clear();
401 m_aControllerMap.clear();// TODO already done in RemoveControllers
402
403 for ( sal_Int32 n = 0; n < rItemContainer->getCount(); n++ )
404 {
405 uno::Sequence< beans::PropertyValue > aProps;
406 OUString aCommandURL;
407 sal_Int16 nOffset( 0 );
408 sal_Int16 nStyle( 0 );
409 sal_Int16 nWidth( 0 );
410 sal_uInt16 nType( css::ui::ItemType::DEFAULT );
411
412 try
413 {
414 if ( rItemContainer->getByIndex( n ) >>= aProps )
415 {
416 for ( beans::PropertyValue const & prop : std::as_const(aProps) )
417 {
418 if ( prop.Name == "CommandURL" )
419 {
420 prop.Value >>= aCommandURL;
421 }
422 else if ( prop.Name == "Style" )
423 {
424 prop.Value >>= nStyle;
425 }
426 else if ( prop.Name == "Type" )
427 {
428 prop.Value >>= nType;
429 }
430 else if ( prop.Name == "Width" )
431 {
432 prop.Value >>= nWidth;
433 }
434 else if ( prop.Name == "Offset" )
435 {
436 prop.Value >>= nOffset;
437 }
438 }
439
440 if (( nType == css::ui::ItemType::DEFAULT ) && !aCommandURL.isEmpty() )
441 {
442 auto aProperties = vcl::CommandInfoProvider::GetCommandProperties(aCommandURL, "");
443 OUString aString(vcl::CommandInfoProvider::GetLabelForCommand(aProperties));
444 StatusBarItemBits nItemBits( impl_convertItemStyleToItemBits( nStyle ));
445
446 m_pStatusBar->InsertItem( nId, nWidth, nItemBits, nOffset );
447 m_pStatusBar->SetItemCommand( nId, aCommandURL );
448 m_pStatusBar->SetAccessibleName( nId, aString );
449 ++nId;
450 }
451 }
452 }
453 catch ( const css::lang::IndexOutOfBoundsException& )
454 {
455 break;
456 }
457 }
458
459 // Statusbar Merging
460 constexpr sal_uInt16 STATUSBAR_ITEM_STARTID = 1000;
461 MergeStatusbarInstructionContainer aMergeInstructions = AddonsOptions().GetMergeStatusbarInstructions();
462 if ( !aMergeInstructions.empty() )
463 {
464 const sal_uInt32 nCount = aMergeInstructions.size();
465 sal_uInt16 nItemId( STATUSBAR_ITEM_STARTID );
466
467 for ( sal_uInt32 i = 0; i < nCount; i++ )
468 {
469 MergeStatusbarInstruction &rInstruction = aMergeInstructions[i];
470 if ( !StatusbarMerger::IsCorrectContext( rInstruction.aMergeContext ) )
471 continue;
472
473 AddonStatusbarItemContainer aItems;
474 StatusbarMerger::ConvertSeqSeqToVector( rInstruction.aMergeStatusbarItems, aItems );
475
476 sal_uInt16 nRefPos = StatusbarMerger::FindReferencePos( m_pStatusBar, rInstruction.aMergePoint );
477 if ( nRefPos != STATUSBAR_ITEM_NOTFOUND(sal_uInt16(0xFFFF)) )
478 {
479 StatusbarMerger::ProcessMergeOperation( m_pStatusBar,
480 nRefPos,
481 nItemId,
482 rInstruction.aMergeCommand,
483 rInstruction.aMergeCommandParameter,
484 aItems );
485 }
486 else
487 {
488 StatusbarMerger::ProcessMergeFallback( m_pStatusBar,
489 nItemId,
490 rInstruction.aMergeCommand,
491 rInstruction.aMergeCommandParameter,
492 aItems );
493 }
494 }
495 }
496
497 // Create controllers
498 CreateControllers();
499
500 // Notify controllers that they are now correctly initialized and can start listening
501 UpdateControllers();
502}
503
504void StatusBarManager::DataChanged( const DataChangedEvent& rDCEvt )
505{
506 SolarMutexClearableGuard aGuard;
507
508 if ((( rDCEvt.GetType() == DataChangedEventType::SETTINGS ) ||
509 ( rDCEvt.GetType() == DataChangedEventType::FONTS ) ||
510 ( rDCEvt.GetType() == DataChangedEventType::FONTSUBSTITUTION ) ||
511 ( rDCEvt.GetType() == DataChangedEventType::DISPLAY )) &&
512 ( rDCEvt.GetFlags() & AllSettingsFlags::STYLE ))
513 {
514 css::uno::Reference< css::frame::XLayoutManager > xLayoutManager;
515 css::uno::Reference< css::beans::XPropertySet > xPropSet( m_xFrame, css::uno::UNO_QUERY );
516 if ( xPropSet.is() )
517 xPropSet->getPropertyValue("LayoutManager") >>= xLayoutManager;
518 if ( xLayoutManager.is() )
519 {
520 aGuard.clear();
521 xLayoutManager->doLayout();
522 }
523 }
524}
525
526void StatusBarManager::UserDraw( const UserDrawEvent& rUDEvt )
527{
528 SolarMutexClearableGuard aGuard;
529
530 if ( m_bDisposed )
531 return;
532
533 sal_uInt16 nId( rUDEvt.GetItemId() );
534 StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
535 if (( nId <= 0 ) || ( it == m_aControllerMap.end() ))
536 return;
537
538 uno::Reference< frame::XStatusbarController > xController( it->second );
539 if (xController.is() && rUDEvt.GetRenderContext())
540 {
541 uno::Reference< awt::XGraphics > xGraphics = rUDEvt.GetRenderContext()->CreateUnoGraphics();
542
543 awt::Rectangle aRect( rUDEvt.GetRect().Left(),
544 rUDEvt.GetRect().Top(),
545 rUDEvt.GetRect().GetWidth(),
546 rUDEvt.GetRect().GetHeight() );
547 aGuard.clear();
548 xController->paint(xGraphics, aRect, 0);
549 }
550}
551
552void StatusBarManager::Command( const CommandEvent& rEvt )
553{
554 SolarMutexGuard g;
555
556 if ( m_bDisposed )
557 return;
558
559 if ( rEvt.GetCommand() != CommandEventId::ContextMenu )
560 return;
561
562 sal_uInt16 nId = m_pStatusBar->GetItemId( rEvt.GetMousePosPixel() );
563 StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
564 if (( nId > 0 ) && ( it != m_aControllerMap.end() ))
565 {
566 uno::Reference< frame::XStatusbarController > xController( it->second );
567 if ( xController.is() )
568 {
569 awt::Point aPos;
570 aPos.X = rEvt.GetMousePosPixel().X();
571 aPos.Y = rEvt.GetMousePosPixel().Y();
572 xController->command( aPos, awt::Command::CONTEXTMENU, true, uno::Any() );
573 }
574 }
575}
576
577void StatusBarManager::MouseMove( const MouseEvent& rMEvt )
578{
579 MouseButton(rMEvt,&frame::XStatusbarController::mouseMove);
580}
581
582void StatusBarManager::MouseButton( const MouseEvent& rMEvt ,sal_Bool ( SAL_CALL frame::XStatusbarController::*_pMethod )(const css::awt::MouseEvent&))
583{
584 SolarMutexGuard g;
585
586 if ( m_bDisposed )
587 return;
588
589 sal_uInt16 nId = m_pStatusBar->GetItemId( rMEvt.GetPosPixel() );
590 StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
591 if (( nId <= 0 ) || ( it == m_aControllerMap.end() ))
592 return;
593
594 uno::Reference< frame::XStatusbarController > xController( it->second );
595 if ( xController.is() )
596 {
597 css::awt::MouseEvent aMouseEvent;
598 aMouseEvent.Buttons = rMEvt.GetButtons();
599 aMouseEvent.X = rMEvt.GetPosPixel().X();
600 aMouseEvent.Y = rMEvt.GetPosPixel().Y();
601 aMouseEvent.ClickCount = rMEvt.GetClicks();
602 (xController.get()->*_pMethod)( aMouseEvent);
603 }
604}
605
606void StatusBarManager::MouseButtonDown( const MouseEvent& rMEvt )
607{
608 MouseButton(rMEvt,&frame::XStatusbarController::mouseButtonDown);
609}
610
611void StatusBarManager::MouseButtonUp( const MouseEvent& rMEvt )
612{
613 MouseButton(rMEvt,&frame::XStatusbarController::mouseButtonUp);
614}
615
616IMPL_LINK_NOARG(StatusBarManager, Click, StatusBar*, void)void StatusBarManager::LinkStubClick(void * instance, StatusBar
* data) { return static_cast<StatusBarManager *>(instance
)->Click(data); } void StatusBarManager::Click(__attribute__
((unused)) StatusBar*)
617{
618 SolarMutexGuard g;
619
620 if ( m_bDisposed )
621 return;
622
623 sal_uInt16 nId = m_pStatusBar->GetCurItemId();
624 StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
625 if (( nId > 0 ) && ( it != m_aControllerMap.end() ))
626 {
627 uno::Reference< frame::XStatusbarController > xController( it->second );
628 if ( xController.is() )
629 {
630 const Point aVCLPos = m_pStatusBar->GetPointerPosPixel();
631 const awt::Point aAWTPoint( aVCLPos.X(), aVCLPos.Y() );
632 xController->click( aAWTPoint );
633 }
634 }
635}
636
637IMPL_LINK_NOARG(StatusBarManager, DoubleClick, StatusBar*, void)void StatusBarManager::LinkStubDoubleClick(void * instance, StatusBar
* data) { return static_cast<StatusBarManager *>(instance
)->DoubleClick(data); } void StatusBarManager::DoubleClick
(__attribute__ ((unused)) StatusBar*)
638{
639 SolarMutexGuard g;
640
641 if ( m_bDisposed )
642 return;
643
644 sal_uInt16 nId = m_pStatusBar->GetCurItemId();
645 StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
646 if (( nId > 0 ) && ( it != m_aControllerMap.end() ))
647 {
648 uno::Reference< frame::XStatusbarController > xController( it->second );
649 if ( xController.is() )
650 {
651 const Point aVCLPos = m_pStatusBar->GetPointerPosPixel();
652 const awt::Point aAWTPoint( aVCLPos.X(), aVCLPos.Y() );
653 xController->doubleClick( aAWTPoint );
654 }
655 }
656}
657
658}
659
660/* 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)
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 ;-)
6
Calling 'Reference::clear'
13
Returning; memory was released
205 if (aTmp.get()) {
14
Calling 'Reference::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)
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)
113 m_pBody->release();
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
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
)
7
Taking true branch
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
8
Calling 'VclReferenceBase::release'
12
Returning; memory was released
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;
15
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)
9
Assuming the condition is true
10
Taking true branch
40 delete this;
11
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