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

/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxmenu.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 <toolkit/awt/vclxmenu.hxx>
21#include <toolkit/helper/convert.hxx>
22#include <helper/servicenames.hxx>
23#include <toolkit/helper/vclunohelper.hxx>
24
25#include <com/sun/star/uno/XComponentContext.hpp>
26#include <cppuhelper/supportsservice.hxx>
27#include <cppuhelper/queryinterface.hxx>
28#include <cppuhelper/typeprovider.hxx>
29#include <osl/mutex.hxx>
30#include <tools/debug.hxx>
31#include <vcl/graph.hxx>
32#include <vcl/menu.hxx>
33#include <vcl/keycod.hxx>
34#include <vcl/image.hxx>
35#include <vcl/svapp.hxx>
36#include <vcl/window.hxx>
37
38#include <com/sun/star/awt/KeyModifier.hpp>
39
40VCLXMenu::VCLXMenu()
41 : maMenuListeners( *this )
42 , mnDefaultItem(0)
43{
44 mpMenu = nullptr;
45}
46
47VCLXMenu::VCLXMenu( Menu* pMenu )
48 : maMenuListeners( *this )
49 , mnDefaultItem(0)
50{
51 mpMenu = pMenu;
52}
53
54VCLXMenu::~VCLXMenu()
55{
56 maPopupMenuRefs.clear();
57 if ( mpMenu )
1
Taking true branch
→
58 {
59 mpMenu->RemoveEventListener( LINK( this, VCLXMenu, MenuEventListener )::tools::detail::makeLink( ::tools::detail::castTo<VCLXMenu
*>(this), &VCLXMenu::LinkStubMenuEventListener) );
60 mpMenu.disposeAndClear();
2
←
Calling 'VclPtr::disposeAndClear'
→
61 }
62}
63
64bool VCLXMenu::IsPopupMenu() const
65{
66 return (mpMenu && ! mpMenu->IsMenuBar());
67}
68
69void VCLXMenu::ImplCreateMenu( bool bPopup )
70{
71 DBG_ASSERT( !mpMenu, "CreateMenu: Menu exists!" )do { if (true && (!(!mpMenu))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxmenu.cxx"
":" "71" ": "), "%s", "CreateMenu: Menu exists!"); } } while
(false);
72
73 if ( bPopup )
74 mpMenu = VclPtr<PopupMenu>::Create();
75 else
76 mpMenu = VclPtr<MenuBar>::Create();
77
78 mpMenu->AddEventListener( LINK( this, VCLXMenu, MenuEventListener )::tools::detail::makeLink( ::tools::detail::castTo<VCLXMenu
*>(this), &VCLXMenu::LinkStubMenuEventListener) );
79}
80
81void VCLXMenu::ImplAddListener()
82{
83 assert(mpMenu)(static_cast <bool> (mpMenu) ? void (0) : __assert_fail
("mpMenu", "/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxmenu.cxx"
, 83, __extension__ __PRETTY_FUNCTION__));
84 mpMenu->AddEventListener( LINK( this, VCLXMenu, MenuEventListener )::tools::detail::makeLink( ::tools::detail::castTo<VCLXMenu
*>(this), &VCLXMenu::LinkStubMenuEventListener) );
85}
86
87IMPL_LINK( VCLXMenu, MenuEventListener, VclMenuEvent&, rMenuEvent, void )void VCLXMenu::LinkStubMenuEventListener(void * instance, VclMenuEvent
& data) { return static_cast<VCLXMenu *>(instance)->
MenuEventListener(data); } void VCLXMenu::MenuEventListener(VclMenuEvent
& rMenuEvent)
88{
89 DBG_ASSERT( rMenuEvent.GetMenu() && mpMenu, "Menu???" )do { if (true && (!(rMenuEvent.GetMenu() && mpMenu
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxmenu.cxx"
":" "89" ": "), "%s", "Menu???"); } } while (false);
90
91 if ( rMenuEvent.GetMenu() != mpMenu ) // Also called for the root menu
92 return;
93
94 switch ( rMenuEvent.GetId() )
95 {
96 case VclEventId::MenuSelect:
97 {
98 if ( maMenuListeners.getLength() )
99 {
100 css::awt::MenuEvent aEvent;
101 aEvent.Source = static_cast<cppu::OWeakObject*>(this);
102 aEvent.MenuId = mpMenu->GetCurItemId();
103 maMenuListeners.itemSelected( aEvent );
104 }
105 }
106 break;
107 case VclEventId::ObjectDying:
108 {
109 mpMenu = nullptr;
110 }
111 break;
112 case VclEventId::MenuHighlight:
113 {
114 if ( maMenuListeners.getLength() )
115 {
116 css::awt::MenuEvent aEvent;
117 aEvent.Source = static_cast<cppu::OWeakObject*>(this);
118 aEvent.MenuId = mpMenu->GetCurItemId();
119 maMenuListeners.itemHighlighted( aEvent );
120 }
121 }
122 break;
123 case VclEventId::MenuActivate:
124 {
125 if ( maMenuListeners.getLength() )
126 {
127 css::awt::MenuEvent aEvent;
128 aEvent.Source = static_cast<cppu::OWeakObject*>(this);
129 aEvent.MenuId = mpMenu->GetCurItemId();
130 maMenuListeners.itemActivated( aEvent );
131 }
132 }
133 break;
134 case VclEventId::MenuDeactivate:
135 {
136 if ( maMenuListeners.getLength() )
137 {
138 css::awt::MenuEvent aEvent;
139 aEvent.Source = static_cast<cppu::OWeakObject*>(this);
140 aEvent.MenuId = mpMenu->GetCurItemId();
141 maMenuListeners.itemDeactivated( aEvent );
142 }
143 }
144 break;
145
146 // ignore accessibility events
147 case VclEventId::MenuEnable:
148 case VclEventId::MenuInsertItem:
149 case VclEventId::MenuRemoveItem:
150 case VclEventId::MenuSubmenuActivate:
151 case VclEventId::MenuSubmenuDeactivate:
152 case VclEventId::MenuSubmenuChanged:
153 case VclEventId::MenuDehighlight:
154 case VclEventId::MenuDisable:
155 case VclEventId::MenuItemTextChanged:
156 case VclEventId::MenuItemChecked:
157 case VclEventId::MenuItemUnchecked:
158 case VclEventId::MenuShow:
159 case VclEventId::MenuHide:
160 break;
161
162 default: OSL_FAIL( "MenuEventListener - Unknown event!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxmenu.cxx"
":" "162" ": "), "%s", "MenuEventListener - Unknown event!")
; } } while (false);
163 }
164}
165
166
167OUString SAL_CALL VCLXMenu::getImplementationName( )
168{
169 ::osl::ResettableGuard < ::osl::Mutex > aGuard( GetMutex() );
170 const bool bIsPopupMenu = IsPopupMenu();
171 aGuard.clear();
172
173 OUString implName( "stardiv.Toolkit." );
174 if ( bIsPopupMenu )
175 implName += "VCLXPopupMenu";
176 else
177 implName += "VCLXMenuBar";
178
179 return implName;
180}
181
182css::uno::Sequence< OUString > SAL_CALL VCLXMenu::getSupportedServiceNames( )
183{
184 ::osl::ResettableGuard < ::osl::Mutex > aGuard( GetMutex() );
185 const bool bIsPopupMenu = IsPopupMenu();
186 aGuard.clear();
187
188 if ( bIsPopupMenu )
189 return css::uno::Sequence<OUString>{
190 "com.sun.star.awt.PopupMenu",
191 "stardiv.vcl.PopupMenu"};
192 else
193 return css::uno::Sequence<OUString>{
194 "com.sun.star.awt.MenuBar",
195 "stardiv.vcl.MenuBar"};
196}
197
198sal_Bool SAL_CALL VCLXMenu::supportsService(const OUString& rServiceName )
199{
200 return cppu::supportsService(this, rServiceName);
201}
202
203css::uno::Any VCLXMenu::queryInterface(
204 const css::uno::Type & rType )
205{
206 ::osl::ResettableGuard < ::osl::Mutex > aGuard( GetMutex() );
207 const bool bIsPopupMenu = IsPopupMenu();
208 aGuard.clear();
209
210 css::uno::Any aRet;
211
212 if ( bIsPopupMenu )
213 aRet = ::cppu::queryInterface( rType,
214 static_cast< css::awt::XMenu* >(static_cast<css::awt::XMenuBar*>(this)),
215 static_cast< css::awt::XPopupMenu* >(this),
216 static_cast< css::lang::XTypeProvider* >(this),
217 static_cast< css::lang::XServiceInfo* >(this),
218 static_cast< css::lang::XUnoTunnel* >(this) );
219 else
220 aRet = ::cppu::queryInterface( rType,
221 static_cast< css::awt::XMenu* >(static_cast<css::awt::XMenuBar*>(this)),
222 static_cast< css::awt::XMenuBar* >(this),
223 static_cast< css::lang::XTypeProvider* >(this),
224 static_cast< css::lang::XServiceInfo* >(this),
225 static_cast< css::lang::XUnoTunnel* >(this) );
226
227 return (aRet.hasValue() ? aRet : OWeakObject::queryInterface( rType ));
228}
229
230
231UNO3_GETIMPLEMENTATION_IMPL( VCLXMenu )namespace { class theVCLXMenuUnoTunnelId : public rtl::Static
< UnoTunnelIdInit, theVCLXMenuUnoTunnelId> {}; } const css
::uno::Sequence< sal_Int8 > & VCLXMenu::getUnoTunnelId
() throw() { return theVCLXMenuUnoTunnelId::get().getSeq(); }
sal_Int64 VCLXMenu::getSomething( const css::uno::Sequence<
sal_Int8 >& rId ) { if( isUnoTunnelId<VCLXMenu>
(rId) ) { return sal::static_int_cast<sal_Int64>(reinterpret_cast
<sal_IntPtr>(this)); } return 0; };
232
233css::uno::Sequence< css::uno::Type > VCLXMenu::getTypes()
234{
235 ::osl::ResettableGuard < ::osl::Mutex > aGuard( GetMutex() );
236 const bool bIsPopupMenu = IsPopupMenu();
237 aGuard.clear();
238
239 if ( bIsPopupMenu )
240 {
241 static cppu::OTypeCollection collectionPopupMenu(
242 cppu::UnoType<css::lang::XTypeProvider>::get(), cppu::UnoType<css::awt::XMenu>::get(),
243 cppu::UnoType<css::awt::XPopupMenu>::get(),
244 cppu::UnoType<css::lang::XServiceInfo>::get());
245 return collectionPopupMenu.getTypes();
246 }
247 else
248 {
249 static cppu::OTypeCollection collectionMenuBar(
250 cppu::UnoType<css::lang::XTypeProvider>::get(), cppu::UnoType<css::awt::XMenu>::get(),
251 cppu::UnoType<css::awt::XMenuBar>::get(),
252 cppu::UnoType<css::lang::XServiceInfo>::get());
253 return collectionMenuBar.getTypes();
254 }
255}
256
257
258css::uno::Sequence< sal_Int8 > VCLXMenu::getImplementationId()
259{
260 return css::uno::Sequence<sal_Int8>();
261}
262
263void VCLXMenu::addMenuListener(
264 const css::uno::Reference< css::awt::XMenuListener >& rxListener )
265{
266 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
267
268 maMenuListeners.addInterface( rxListener );
269}
270
271void VCLXMenu::removeMenuListener(
272 const css::uno::Reference< css::awt::XMenuListener >& rxListener )
273{
274 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
275
276 maMenuListeners.removeInterface( rxListener );
277}
278
279void VCLXMenu::insertItem(
280 sal_Int16 nItemId,
281 const OUString& aText,
282 sal_Int16 nItemStyle,
283 sal_Int16 nPos )
284{
285 SolarMutexGuard aSolarGuard;
286 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
287
288 if ( mpMenu )
289 mpMenu->InsertItem(nItemId, aText, static_cast<MenuItemBits>(nItemStyle), OString(), nPos);
290}
291
292void VCLXMenu::removeItem(
293 sal_Int16 nPos,
294 sal_Int16 nCount )
295{
296 SolarMutexGuard aSolarGuard;
297 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
298
299 if (!mpMenu)
300 return;
301
302 sal_Int32 nItemCount = static_cast<sal_Int32>(mpMenu->GetItemCount());
303 if ((nCount > 0) && (nPos >= 0) && (nPos < nItemCount))
304 {
305 sal_Int16 nP = sal::static_int_cast< sal_Int16 >(
306 std::min( static_cast<int>(nPos+nCount), static_cast<int>(nItemCount) ));
307 while( nP-nPos > 0 )
308 mpMenu->RemoveItem( --nP );
309 }
310}
311
312sal_Int16 VCLXMenu::getItemCount( )
313{
314 SolarMutexGuard aSolarGuard;
315 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
316
317 return mpMenu ? mpMenu->GetItemCount() : 0;
318}
319
320sal_Int16 VCLXMenu::getItemId(
321 sal_Int16 nPos )
322{
323 SolarMutexGuard aSolarGuard;
324 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
325
326 return mpMenu ? mpMenu->GetItemId( nPos ) : 0;
327}
328
329sal_Int16 VCLXMenu::getItemPos(
330 sal_Int16 nId )
331{
332 SolarMutexGuard aSolarGuard;
333 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
334
335 return mpMenu ? mpMenu->GetItemPos( nId ) : 0;
336}
337
338void VCLXMenu::enableItem(
339 sal_Int16 nItemId,
340 sal_Bool bEnable )
341{
342 SolarMutexGuard aSolarGuard;
343 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
344
345 if ( mpMenu )
346 mpMenu->EnableItem( nItemId, bEnable );
347}
348
349sal_Bool VCLXMenu::isItemEnabled(
350 sal_Int16 nItemId )
351{
352 SolarMutexGuard aSolarGuard;
353 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
354
355 return mpMenu && mpMenu->IsItemEnabled( nItemId );
356}
357
358void VCLXMenu::setItemText(
359 sal_Int16 nItemId,
360 const OUString& aText )
361{
362 SolarMutexGuard aSolarGuard;
363 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
364
365 if ( mpMenu )
366 mpMenu->SetItemText( nItemId, aText );
367}
368
369OUString VCLXMenu::getItemText(
370 sal_Int16 nItemId )
371{
372 SolarMutexGuard aSolarGuard;
373 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
374
375 OUString aItemText;
376 if ( mpMenu )
377 aItemText = mpMenu->GetItemText( nItemId );
378 return aItemText;
379}
380
381void VCLXMenu::setPopupMenu(
382 sal_Int16 nItemId,
383 const css::uno::Reference< css::awt::XPopupMenu >& rxPopupMenu )
384{
385 SolarMutexGuard aSolarGuard;
386 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
387
388 VCLXMenu* pVCLMenu = comphelper::getUnoTunnelImplementation<VCLXMenu>( rxPopupMenu );
389 DBG_ASSERT( pVCLMenu && pVCLMenu->GetMenu() && pVCLMenu->IsPopupMenu(), "setPopupMenu: Invalid Menu!" )do { if (true && (!(pVCLMenu && pVCLMenu->
GetMenu() && pVCLMenu->IsPopupMenu()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxmenu.cxx"
":" "389" ": "), "%s", "setPopupMenu: Invalid Menu!"); } } while
(false);
390
391 if ( mpMenu && pVCLMenu && pVCLMenu->GetMenu() && pVCLMenu->IsPopupMenu() )
392 {
393 maPopupMenuRefs.push_back( rxPopupMenu );
394
395 mpMenu->SetPopupMenu( nItemId, static_cast<PopupMenu*>( pVCLMenu->GetMenu() ) );
396 }
397}
398
399css::uno::Reference< css::awt::XPopupMenu > VCLXMenu::getPopupMenu(
400 sal_Int16 nItemId )
401{
402 SolarMutexGuard aSolarGuard;
403 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
404
405 css::uno::Reference< css::awt::XPopupMenu > aRef;
406 Menu* pMenu = mpMenu ? mpMenu->GetPopupMenu( nItemId ) : nullptr;
407 if ( pMenu )
408 {
409 for ( size_t n = maPopupMenuRefs.size(); n; )
410 {
411 css::uno::Reference< css::awt::XPopupMenu >& rRef = maPopupMenuRefs[ --n ];
412 Menu* pM = static_cast<VCLXMenu*>(rRef.get())->GetMenu();
413 if ( pM == pMenu )
414 {
415 aRef = rRef;
416 break;
417 }
418 }
419 // it seems the popup menu is not insert into maPopupMenuRefs
420 // if the popup men is not created by stardiv.Toolkit.VCLXPopupMenu
421 if( !aRef.is() )
422 {
423 aRef = new VCLXPopupMenu( static_cast<PopupMenu*>(pMenu) );
424 }
425 }
426 return aRef;
427}
428
429// css::awt::XPopupMenu
430void VCLXMenu::insertSeparator(
431 sal_Int16 nPos )
432{
433 SolarMutexGuard aSolarGuard;
434 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
435
436 if ( mpMenu )
437 mpMenu->InsertSeparator(OString(), nPos);
438}
439
440void VCLXMenu::setDefaultItem(
441 sal_Int16 nItemId )
442{
443 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
444
445 mnDefaultItem = nItemId;
446}
447
448sal_Int16 VCLXMenu::getDefaultItem( )
449{
450 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
451
452 return mnDefaultItem;
453}
454
455void VCLXMenu::checkItem(
456 sal_Int16 nItemId,
457 sal_Bool bCheck )
458{
459 SolarMutexGuard aSolarGuard;
460 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
461
462 if ( mpMenu )
463 mpMenu->CheckItem( nItemId, bCheck );
464}
465
466sal_Bool VCLXMenu::isItemChecked(
467 sal_Int16 nItemId )
468{
469 SolarMutexGuard aSolarGuard;
470 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
471
472 return mpMenu && mpMenu->IsItemChecked( nItemId );
473}
474
475sal_Int16 VCLXMenu::execute(
476 const css::uno::Reference< css::awt::XWindowPeer >& rxWindowPeer,
477 const css::awt::Rectangle& rPos,
478 sal_Int16 nFlags )
479{
480 SolarMutexGuard aSolarGuard;
481 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
482
483 sal_Int16 nRet = 0;
484 if ( mpMenu && IsPopupMenu() )
485 {
486 nRet = static_cast<PopupMenu*>(mpMenu.get())->Execute( VCLUnoHelper::GetWindow( rxWindowPeer ),
487 VCLRectangle( rPos ),
488 static_cast<PopupMenuFlags>(nFlags) | PopupMenuFlags::NoMouseUpClose );
489 }
490 return nRet;
491}
492
493
494void SAL_CALL VCLXMenu::setCommand(
495 sal_Int16 nItemId,
496 const OUString& aCommand )
497{
498 SolarMutexGuard aSolarGuard;
499 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
500
501 if ( mpMenu )
502 mpMenu->SetItemCommand( nItemId, aCommand );
503}
504
505OUString SAL_CALL VCLXMenu::getCommand(
506 sal_Int16 nItemId )
507{
508 SolarMutexGuard aSolarGuard;
509 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
510
511 OUString aItemCommand;
512 if ( mpMenu )
513 aItemCommand = mpMenu->GetItemCommand( nItemId );
514 return aItemCommand;
515}
516
517void SAL_CALL VCLXMenu::setHelpCommand(
518 sal_Int16 nItemId,
519 const OUString& aHelp )
520{
521 SolarMutexGuard aSolarGuard;
522 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
523
524 if ( mpMenu )
525 mpMenu->SetHelpCommand( nItemId, aHelp );
526}
527
528OUString SAL_CALL VCLXMenu::getHelpCommand(
529 sal_Int16 nItemId )
530{
531 SolarMutexGuard aSolarGuard;
532 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
533
534 OUString aHelpCommand;
535 if ( mpMenu )
536 aHelpCommand = mpMenu->GetHelpCommand( nItemId );
537 return aHelpCommand;
538}
539
540
541namespace
542{
543 Image lcl_XGraphic2VCLImage(
544 const css::uno::Reference< css::graphic::XGraphic >& xGraphic,
545 bool bResize )
546 {
547 Image aImage;
548 if ( !xGraphic.is() )
549 return aImage;
550
551 aImage = Image( xGraphic );
552 const ::Size aCurSize = aImage.GetSizePixel();
553 const sal_Int32 nCurWidth = aCurSize.Width();
554 const sal_Int32 nCurHeight = aCurSize.Height();
555 constexpr sal_Int32 nIdeal( 16 );
556
557 if ( nCurWidth > 0 && nCurHeight > 0 )
558 {
559 if ( bResize && ( nCurWidth > nIdeal || nCurHeight > nIdeal ) )
560 {
561 sal_Int32 nIdealWidth = std::min(nCurWidth, nIdeal);
562 sal_Int32 nIdealHeight = std::min(nCurHeight, nIdeal);
563
564 ::Size aNewSize( nIdealWidth, nIdealHeight );
565
566 bool bModified( false );
567 BitmapEx aBitmapEx = aImage.GetBitmapEx();
568 bModified = aBitmapEx.Scale( aNewSize, BmpScaleFlag::BestQuality );
569
570 if ( bModified )
571 aImage = Image( aBitmapEx );
572 }
573 }
574 return aImage;
575 }
576
577 /** Copied from svtools/inc/acceleratorexecute.hxx */
578 css::awt::KeyEvent lcl_VCLKey2AWTKey(
579 const vcl::KeyCode& aVCLKey)
580 {
581 css::awt::KeyEvent aAWTKey;
582 aAWTKey.Modifiers = 0;
583 aAWTKey.KeyCode = static_cast<sal_Int16>(aVCLKey.GetCode());
584
585 if (aVCLKey.IsShift())
586 aAWTKey.Modifiers |= css::awt::KeyModifier::SHIFT;
587 if (aVCLKey.IsMod1())
588 aAWTKey.Modifiers |= css::awt::KeyModifier::MOD1;
589 if (aVCLKey.IsMod2())
590 aAWTKey.Modifiers |= css::awt::KeyModifier::MOD2;
591 if (aVCLKey.IsMod3())
592 aAWTKey.Modifiers |= css::awt::KeyModifier::MOD3;
593
594 return aAWTKey;
595 }
596
597 vcl::KeyCode lcl_AWTKey2VCLKey(const css::awt::KeyEvent& aAWTKey)
598 {
599 bool bShift = ((aAWTKey.Modifiers & css::awt::KeyModifier::SHIFT) == css::awt::KeyModifier::SHIFT );
600 bool bMod1 = ((aAWTKey.Modifiers & css::awt::KeyModifier::MOD1 ) == css::awt::KeyModifier::MOD1 );
601 bool bMod2 = ((aAWTKey.Modifiers & css::awt::KeyModifier::MOD2 ) == css::awt::KeyModifier::MOD2 );
602 bool bMod3 = ((aAWTKey.Modifiers & css::awt::KeyModifier::MOD3 ) == css::awt::KeyModifier::MOD3 );
603 sal_uInt16 nKey = static_cast<sal_uInt16>(aAWTKey.KeyCode);
604
605 return vcl::KeyCode(nKey, bShift, bMod1, bMod2, bMod3);
606 }
607
608}
609
610
611sal_Bool SAL_CALL VCLXMenu::isPopupMenu( )
612{
613 SolarMutexGuard aSolarGuard;
614 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
615 return IsPopupMenu();
616}
617
618void SAL_CALL VCLXMenu::clear( )
619{
620 SolarMutexGuard aSolarGuard;
621 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
622 if ( mpMenu )
623 mpMenu->Clear();
624}
625
626
627css::awt::MenuItemType SAL_CALL VCLXMenu::getItemType(
628 ::sal_Int16 nItemPos )
629{
630 SolarMutexGuard aSolarGuard;
631 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
632
633 css::awt::MenuItemType aMenuItemType =
634 css::awt::MenuItemType_DONTKNOW;
635 if ( mpMenu )
636 {
637 aMenuItemType = static_cast<css::awt::MenuItemType>(mpMenu->GetItemType( nItemPos ));
638 }
639
640 return aMenuItemType;
641}
642
643void SAL_CALL VCLXMenu::hideDisabledEntries(
644 sal_Bool bHide )
645{
646 SolarMutexGuard aSolarGuard;
647 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
648 if ( mpMenu )
649 {
650 if ( bHide )
651 mpMenu->SetMenuFlags( mpMenu->GetMenuFlags() | MenuFlags::HideDisabledEntries );
652 else
653 mpMenu->SetMenuFlags( mpMenu->GetMenuFlags() & ~MenuFlags::HideDisabledEntries );
654 }
655}
656
657
658sal_Bool SAL_CALL VCLXMenu::isInExecute( )
659{
660 SolarMutexGuard aSolarGuard;
661 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
662
663 if ( mpMenu && IsPopupMenu() )
664 return PopupMenu::IsInExecute();
665 else
666 return false;
667}
668
669
670void SAL_CALL VCLXMenu::endExecute()
671{
672 SolarMutexGuard aSolarGuard;
673 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
674
675 if ( mpMenu && IsPopupMenu() )
676 static_cast<PopupMenu*>( mpMenu.get() )->EndExecute();
677}
678
679
680void SAL_CALL VCLXMenu::enableAutoMnemonics(
681 sal_Bool bEnable )
682{
683 SolarMutexGuard aSolarGuard;
684 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
685 if ( mpMenu )
686 {
687 if ( !bEnable )
688 mpMenu->SetMenuFlags( mpMenu->GetMenuFlags() | MenuFlags::NoAutoMnemonics );
689 else
690 mpMenu->SetMenuFlags( mpMenu->GetMenuFlags() & ~MenuFlags::NoAutoMnemonics );
691 }
692}
693
694
695void SAL_CALL VCLXMenu::setAcceleratorKeyEvent(
696 ::sal_Int16 nItemId,
697 const css::awt::KeyEvent& aKeyEvent )
698{
699 SolarMutexGuard aSolarGuard;
700 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
701
702 if ( mpMenu && IsPopupMenu() && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
703 {
704 vcl::KeyCode aVCLKeyCode = lcl_AWTKey2VCLKey( aKeyEvent );
705 mpMenu->SetAccelKey( nItemId, aVCLKeyCode );
706 }
707}
708
709
710css::awt::KeyEvent SAL_CALL VCLXMenu::getAcceleratorKeyEvent(
711 ::sal_Int16 nItemId )
712{
713 SolarMutexGuard aSolarGuard;
714 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
715
716 css::awt::KeyEvent aKeyEvent;
717 if ( mpMenu && IsPopupMenu() && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
718 {
719 vcl::KeyCode nKeyCode = mpMenu->GetAccelKey( nItemId );
720 aKeyEvent = lcl_VCLKey2AWTKey( nKeyCode );
721 }
722
723 return aKeyEvent;
724}
725
726
727void SAL_CALL VCLXMenu::setHelpText(
728 ::sal_Int16 nItemId,
729 const OUString& sHelpText )
730{
731 SolarMutexGuard aSolarGuard;
732 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
733
734 if ( mpMenu && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
735 {
736 mpMenu->SetHelpText( nItemId, sHelpText );
737 }
738}
739
740
741OUString SAL_CALL VCLXMenu::getHelpText(
742 ::sal_Int16 nItemId )
743{
744 SolarMutexGuard aSolarGuard;
745 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
746
747 OUString sHelpText;
748 if ( mpMenu && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
749 {
750 sHelpText = mpMenu->GetHelpText( nItemId );
751 }
752
753 return sHelpText;
754}
755
756
757void SAL_CALL VCLXMenu::setTipHelpText(
758 ::sal_Int16 nItemId,
759 const OUString& sTipHelpText )
760{
761 SolarMutexGuard aSolarGuard;
762 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
763
764 if ( mpMenu && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
765 {
766 mpMenu->SetTipHelpText( nItemId, sTipHelpText );
767 }
768}
769
770
771OUString SAL_CALL VCLXMenu::getTipHelpText(
772 ::sal_Int16 nItemId )
773{
774 SolarMutexGuard aSolarGuard;
775 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
776
777 OUString sTipHelpText;
778 if ( mpMenu && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
779 {
780 sTipHelpText = mpMenu->GetTipHelpText( nItemId );
781 }
782 return sTipHelpText;
783}
784
785
786void SAL_CALL VCLXMenu::setItemImage(
787 ::sal_Int16 nItemId,
788 const css::uno::Reference< css::graphic::XGraphic >& xGraphic,
789 sal_Bool bScale )
790{
791 SolarMutexGuard aSolarGuard;
792 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
793
794 if ( mpMenu && IsPopupMenu() && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
795 {
796 Image aImage = lcl_XGraphic2VCLImage( xGraphic, bScale );
797 mpMenu->SetItemImage( nItemId, aImage );
798 }
799}
800
801
802css::uno::Reference< css::graphic::XGraphic > SAL_CALL
803VCLXMenu::getItemImage(
804 ::sal_Int16 nItemId )
805{
806 SolarMutexGuard aSolarGuard;
807 ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
808
809 css::uno::Reference< css::graphic::XGraphic > rxGraphic;
810
811 if ( mpMenu && IsPopupMenu() && MENU_ITEM_NOTFOUND != mpMenu->GetItemPos( nItemId ) )
812 {
813 Image aImage = mpMenu->GetItemImage( nItemId );
814 if ( !!aImage )
815 rxGraphic = Graphic(aImage.GetBitmapEx()).GetXGraphic();
816 }
817 return rxGraphic;
818}
819
820VCLXMenuBar::VCLXMenuBar()
821{
822 ImplCreateMenu( false );
823}
824
825VCLXMenuBar::VCLXMenuBar( MenuBar* pMenuBar ) : VCLXMenu( static_cast<Menu *>(pMenuBar) )
826{
827}
828
829extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface *
830stardiv_Toolkit_VCLXMenuBar_get_implementation(
831 css::uno::XComponentContext *,
832 css::uno::Sequence<css::uno::Any> const &)
833{
834 return cppu::acquire(new VCLXMenuBar());
835}
836
837VCLXPopupMenu::VCLXPopupMenu()
838{
839 ImplCreateMenu( true );
840}
841
842VCLXPopupMenu::VCLXPopupMenu( PopupMenu* pPopMenu ) : VCLXMenu( static_cast<Menu *>(pPopMenu) )
843{
844 ImplAddListener();
845}
846
847extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface *
848stardiv_Toolkit_VCLXPopupMenu_get_implementation(
849 css::uno::XComponentContext *,
850 css::uno::Sequence<css::uno::Any> const &)
851{
852 return cppu::acquire(new VCLXPopupMenu());
853}
854
855/* 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);
3
←
Calling copy constructor for 'Reference<Menu>'
→
6
←
Returning from copy constructor for 'Reference<Menu>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
7
←
Calling 'Reference::clear'
→
14
←
Returning; memory was released
→
205 if (aTmp.get()) {
15
←
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)
4
←
Assuming field 'm_pBody' is non-null
→
5
←
Taking true branch
→
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
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
)
8
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
9
←
Calling 'VclReferenceBase::release'
→
13
←
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;
16
←
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)
10
←
Assuming the condition is true
→
11
←
Taking true branch
→
40 delete this;
12
←
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