Bug Summary

File:home/maarten/src/libreoffice/core/framework/source/uielement/menubarmerger.cxx
Warning:line 366, column 21
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 menubarmerger.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/menubarmerger.cxx

/home/maarten/src/libreoffice/core/framework/source/uielement/menubarmerger.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/menubarmerger.hxx>
21#include <framework/addonsoptions.hxx>
22#include <com/sun/star/uno/Sequence.hxx>
23
24using namespace ::com::sun::star;
25
26const char SEPARATOR_STRING[] = "private:separator";
27
28const char MERGECOMMAND_ADDAFTER[] = "AddAfter";
29const char MERGECOMMAND_ADDBEFORE[] = "AddBefore";
30const char MERGECOMMAND_REPLACE[] = "Replace";
31const char MERGECOMMAND_REMOVE[] = "Remove";
32
33const char MERGEFALLBACK_ADDPATH[] = "AddPath";
34const char MERGEFALLBACK_IGNORE[] = "Ignore";
35
36namespace framework
37{
38
39/**
40 Check whether a module identifier is part of a context
41 defined by a colon separated list of module identifier.
42
43 @param
44 rContext
45
46 Describes a context string list where all contexts
47 are delimited by a colon. For more information about
48 the module identifier used as context strings see the
49 IDL description of css::frame::XModuleManager
50
51 @param
52 rModuleIdentifier
53
54 A string describing a module identifier. See IDL
55 description of css::frame::XModuleManager.
56
57*/
58bool MenuBarMerger::IsCorrectContext( const OUString& rContext, const OUString& rModuleIdentifier )
59{
60 return ( rContext.isEmpty() || ( rContext.indexOf( rModuleIdentifier ) >= 0 ));
61}
62
63void MenuBarMerger::RetrieveReferencePath(
64 const OUString& rReferencePathString,
65 ::std::vector< OUString >& rReferencePath )
66{
67 const char aDelimiter = '\\';
68
69 rReferencePath.clear();
70 sal_Int32 nIndex( 0 );
71 do
72 {
73 OUString aToken = rReferencePathString.getToken( 0, aDelimiter, nIndex );
74 if ( !aToken.isEmpty() )
75 rReferencePath.push_back( aToken );
76 }
77 while ( nIndex >= 0 );
78}
79
80ReferencePathInfo MenuBarMerger::FindReferencePath(
81 const ::std::vector< OUString >& rReferencePath,
82 Menu* pMenu )
83{
84 sal_uInt32 i( 0 );
85 const sal_uInt32 nCount( rReferencePath.size() );
86
87 ReferencePathInfo aResult;
88 if ( !nCount )
89 {
90 aResult.pPopupMenu = nullptr;
91 aResult.nPos = 0;
92 aResult.nLevel = -1;
93 aResult.eResult = RP_MENUITEM_NOT_FOUND;
94 return aResult;
95 }
96
97 Menu* pCurrMenu( pMenu );
98 RPResultInfo eResult( RP_OK );
99
100 sal_Int32 nLevel( - 1 );
101 sal_uInt16 nPos( MENU_ITEM_NOTFOUND );
102 do
103 {
104 ++nLevel;
105 OUString aCmd( rReferencePath[i] );
106
107 if ( i == nCount-1 )
108 {
109 // Check last reference path element. Must be a leave (menu item).
110 sal_uInt16 nTmpPos = FindMenuItem( aCmd, pCurrMenu );
111 if ( nTmpPos != MENU_ITEM_NOTFOUND )
112 nPos = nTmpPos;
113 eResult = ( nTmpPos != MENU_ITEM_NOTFOUND ) ? RP_OK : RP_MENUITEM_NOT_FOUND;
114 }
115 else
116 {
117 // Check reference path element. Must be a node (popup menu)!
118 sal_uInt16 nTmpPos = FindMenuItem( aCmd, pCurrMenu );
119 if ( nTmpPos != MENU_ITEM_NOTFOUND )
120 {
121 sal_uInt16 nItemId = pCurrMenu->GetItemId( nTmpPos );
122 Menu* pTmpMenu = pCurrMenu->GetPopupMenu( nItemId );
123 if ( pTmpMenu != nullptr )
124 pCurrMenu = pTmpMenu;
125 else
126 {
127 nPos = nTmpPos;
128 eResult = RP_MENUITEM_INSTEAD_OF_POPUPMENU_FOUND;
129 }
130 }
131 else
132 eResult = RP_POPUPMENU_NOT_FOUND;
133 }
134 i++;
135 }
136 while ((i < nCount) && (eResult == RP_OK));
137
138 aResult.pPopupMenu = pCurrMenu;
139 aResult.nPos = nPos;
140 aResult.nLevel = nLevel;
141 aResult.eResult = eResult;
142
143 return aResult;
144}
145
146sal_uInt16 MenuBarMerger::FindMenuItem( const OUString& rCmd, Menu const * pCurrMenu )
147{
148 for ( sal_uInt16 i = 0; i < pCurrMenu->GetItemCount(); i++ )
149 {
150 const sal_uInt16 nItemId = pCurrMenu->GetItemId( i );
151 if ( nItemId > 0 )
152 {
153 if ( rCmd == pCurrMenu->GetItemCommand( nItemId ) )
154 return i;
155 }
156 }
157
158 return MENU_ITEM_NOTFOUND;
159}
160
161bool MenuBarMerger::CreateSubMenu(
162 Menu* pSubMenu,
163 sal_uInt16& nItemId,
164 const OUString& rModuleIdentifier,
165 const AddonMenuContainer& rAddonSubMenu )
166{
167 const sal_uInt32 nSize = rAddonSubMenu.size();
168 for ( sal_uInt32 i = 0; i < nSize; i++ )
169 {
170 const AddonMenuItem& rMenuItem = rAddonSubMenu[i];
171
172 if ( IsCorrectContext( rMenuItem.aContext, rModuleIdentifier ))
173 {
174 if ( rMenuItem.aURL == SEPARATOR_STRING )
175 {
176 pSubMenu->InsertSeparator();
177 }
178 else
179 {
180 pSubMenu->InsertItem(nItemId, rMenuItem.aTitle);
181 pSubMenu->SetItemCommand( nItemId, rMenuItem.aURL );
182 if ( !rMenuItem.aSubMenu.empty() )
183 {
184 VclPtr<PopupMenu> pPopupMenu = VclPtr<PopupMenu>::Create();
185 pSubMenu->SetPopupMenu( nItemId, pPopupMenu );
186 ++nItemId;
187
188 CreateSubMenu( pPopupMenu, nItemId, rModuleIdentifier, rMenuItem.aSubMenu );
189 }
190 else
191 ++nItemId;
192 }
193 }
194 }
195
196 return true;
197}
198
199bool MenuBarMerger::MergeMenuItems(
200 Menu* pMenu,
201 sal_uInt16 nPos,
202 sal_uInt16 nModIndex,
203 sal_uInt16& nItemId,
204 const OUString& rModuleIdentifier,
205 const AddonMenuContainer& rAddonMenuItems )
206{
207 sal_uInt16 nIndex( 0 );
208 const sal_uInt32 nSize = rAddonMenuItems.size();
209 for ( sal_uInt32 i = 0; i < nSize; i++ )
210 {
211 const AddonMenuItem& rMenuItem = rAddonMenuItems[i];
212
213 if ( IsCorrectContext( rMenuItem.aContext, rModuleIdentifier ))
214 {
215 if ( rMenuItem.aURL == SEPARATOR_STRING )
216 {
217 pMenu->InsertSeparator(OString(), nPos+nModIndex+nIndex);
218 }
219 else
220 {
221 pMenu->InsertItem(nItemId, rMenuItem.aTitle, MenuItemBits::NONE, OString(), nPos+nModIndex+nIndex);
222 pMenu->SetItemCommand( nItemId, rMenuItem.aURL );
223 if ( !rMenuItem.aSubMenu.empty() )
224 {
225 VclPtr<PopupMenu> pSubMenu = VclPtr<PopupMenu>::Create();
226 pMenu->SetPopupMenu( nItemId, pSubMenu );
227 ++nItemId;
228
229 CreateSubMenu( pSubMenu, nItemId, rModuleIdentifier, rMenuItem.aSubMenu );
230 }
231 else
232 ++nItemId;
233 }
234 ++nIndex;
235 }
236 }
237
238 return true;
239}
240
241bool MenuBarMerger::ReplaceMenuItem(
242 Menu* pMenu,
243 sal_uInt16 nPos,
244 sal_uInt16& rItemId,
245 const OUString& rModuleIdentifier,
246 const AddonMenuContainer& rAddonMenuItems )
247{
248 // There is no replace available. Therefore we first have to
249 // remove the old menu entry,
250 pMenu->RemoveItem( nPos );
251
252 return MergeMenuItems( pMenu, nPos, 0, rItemId, rModuleIdentifier, rAddonMenuItems );
253}
254
255bool MenuBarMerger::RemoveMenuItems(
256 Menu* pMenu,
257 sal_uInt16 nPos,
258 const OUString& rMergeCommandParameter )
259{
260 const sal_uInt16 nParam( sal_uInt16( rMergeCommandParameter.toInt32() ));
261 sal_uInt16 nCount = std::max( nParam, sal_uInt16(1) );
262
263 sal_uInt16 i = 0;
264 while (( nPos < pMenu->GetItemCount() ) && ( i < nCount ))
265 {
266 pMenu->RemoveItem( nPos );
267 ++i;
268 }
269
270 return true;
271}
272
273bool MenuBarMerger::ProcessMergeOperation(
274 Menu* pMenu,
275 sal_uInt16 nPos,
276 sal_uInt16& nItemId,
277 const OUString& rMergeCommand,
278 const OUString& rMergeCommandParameter,
279 const OUString& rModuleIdentifier,
280 const AddonMenuContainer& rAddonMenuItems )
281{
282 sal_uInt16 nModIndex( 0 );
283
284 if ( rMergeCommand == MERGECOMMAND_ADDBEFORE )
285 {
286 nModIndex = 0;
287 return MergeMenuItems( pMenu, nPos, nModIndex, nItemId, rModuleIdentifier, rAddonMenuItems );
288 }
289 else if ( rMergeCommand == MERGECOMMAND_ADDAFTER )
290 {
291 nModIndex = 1;
292 return MergeMenuItems( pMenu, nPos, nModIndex, nItemId, rModuleIdentifier, rAddonMenuItems );
293 }
294 else if ( rMergeCommand == MERGECOMMAND_REPLACE )
295 {
296 return ReplaceMenuItem( pMenu, nPos, nItemId, rModuleIdentifier, rAddonMenuItems );
297 }
298 else if ( rMergeCommand == MERGECOMMAND_REMOVE )
299 {
300 return RemoveMenuItems( pMenu, nPos, rMergeCommandParameter );
301 }
302
303 return false;
304}
305
306bool MenuBarMerger::ProcessFallbackOperation(
307 const ReferencePathInfo& aRefPathInfo,
308 sal_uInt16& rItemId,
309 const OUString& rMergeCommand,
310 const OUString& rMergeFallback,
311 const ::std::vector< OUString >& rReferencePath,
312 const OUString& rModuleIdentifier,
313 const AddonMenuContainer& rAddonMenuItems )
314{
315 if (( rMergeFallback == MERGEFALLBACK_IGNORE ) ||
1
Taking false branch
316 ( rMergeCommand == MERGECOMMAND_REPLACE ) ||
317 ( rMergeCommand == MERGECOMMAND_REMOVE ) )
318 {
319 return true;
320 }
321 else if ( rMergeFallback == MERGEFALLBACK_ADDPATH )
2
Assuming the condition is true
3
Taking true branch
322 {
323 Menu* pCurrMenu( aRefPathInfo.pPopupMenu );
324 sal_Int32 nLevel( aRefPathInfo.nLevel );
325 const sal_Int32 nSize( rReferencePath.size() );
326 bool bFirstLevel( true );
327
328 while ( nLevel < nSize )
4
Assuming 'nLevel' is < 'nSize'
5
Loop condition is true. Entering loop body
23
Assuming 'nLevel' is < 'nSize'
24
Loop condition is true. Entering loop body
329 {
330 if ( nLevel == nSize-1 )
6
Assuming the condition is false
7
Taking false branch
25
Assuming the condition is false
26
Taking false branch
331 {
332 const sal_uInt32 nCount = rAddonMenuItems.size();
333 for ( sal_uInt32 i = 0; i < nCount; ++i )
334 {
335 const AddonMenuItem& rMenuItem = rAddonMenuItems[i];
336 if ( IsCorrectContext( rMenuItem.aContext, rModuleIdentifier ))
337 {
338 if ( rMenuItem.aURL == SEPARATOR_STRING )
339 pCurrMenu->InsertSeparator();
340 else
341 {
342 pCurrMenu->InsertItem(rItemId, rMenuItem.aTitle);
343 pCurrMenu->SetItemCommand( rItemId, rMenuItem.aURL );
344 ++rItemId;
345 }
346 }
347 }
348 }
349 else
350 {
351 const OUString aCmd( rReferencePath[nLevel] );
352
353 VclPtr<PopupMenu> pPopupMenu = VclPtr<PopupMenu>::Create();
8
Calling 'VclPtr::Create'
10
Returned allocated memory
354
355 if ( bFirstLevel
10.1
'bFirstLevel' is true
26.1
'bFirstLevel' is false
10.1
'bFirstLevel' is true
26.1
'bFirstLevel' is false
10.1
'bFirstLevel' is true
26.1
'bFirstLevel' is false
10.1
'bFirstLevel' is true
26.1
'bFirstLevel' is false
&& ( aRefPathInfo.eResult == RP_MENUITEM_INSTEAD_OF_POPUPMENU_FOUND ))
11
Assuming field 'eResult' is equal to RP_MENUITEM_INSTEAD_OF_POPUPMENU_FOUND
12
Taking true branch
356 {
357 // special case: menu item without popup
358 sal_uInt16 nInsPos = aRefPathInfo.nPos;
359 sal_uInt16 nSetItemId = pCurrMenu->GetItemId( nInsPos );
360 pCurrMenu->SetItemCommand( nSetItemId, aCmd );
361 pCurrMenu->SetPopupMenu( nSetItemId, pPopupMenu );
362 }
363 else
364 {
365 // normal case: insert a new item with popup
366 pCurrMenu->InsertItem(rItemId, OUString());
27
Use of memory after it is freed
367 pCurrMenu->SetItemCommand( rItemId, aCmd );
368 pCurrMenu->SetPopupMenu( rItemId, pPopupMenu );
369 }
370
371 pCurrMenu = pPopupMenu;
372 ++rItemId;
373 bFirstLevel = false;
374 }
13
Calling implicit destructor for 'VclPtr<PopupMenu>'
14
Calling '~Reference'
21
Returning from '~Reference'
22
Returning from destructor for 'VclPtr<PopupMenu>'
375 ++nLevel;
376 }
377 return true;
378 }
379
380 return false;
381}
382
383void MenuBarMerger::GetMenuEntry(
384 const uno::Sequence< beans::PropertyValue >& rAddonMenuEntry,
385 AddonMenuItem& rAddonMenuItem )
386{
387 // Reset submenu member
388 rAddonMenuItem.aSubMenu.clear();
389
390 for ( const beans::PropertyValue& rProp : rAddonMenuEntry )
391 {
392 OUString aMenuEntryPropName = rProp.Name;
393 if ( aMenuEntryPropName == ADDONSMENUITEM_STRING_URL"URL" )
394 rProp.Value >>= rAddonMenuItem.aURL;
395 else if ( aMenuEntryPropName == ADDONSMENUITEM_STRING_TITLE"Title" )
396 rProp.Value >>= rAddonMenuItem.aTitle;
397 else if ( aMenuEntryPropName == ADDONSMENUITEM_STRING_SUBMENU"Submenu" )
398 {
399 uno::Sequence< uno::Sequence< beans::PropertyValue > > aSubMenu;
400 rProp.Value >>= aSubMenu;
401 GetSubMenu( aSubMenu, rAddonMenuItem.aSubMenu );
402 }
403 else if ( aMenuEntryPropName == ADDONSMENUITEM_STRING_CONTEXT"Context" )
404 rProp.Value >>= rAddonMenuItem.aContext;
405 }
406}
407
408void MenuBarMerger::GetSubMenu(
409 const uno::Sequence< uno::Sequence< beans::PropertyValue > >& rSubMenuEntries,
410 AddonMenuContainer& rSubMenu )
411{
412 rSubMenu.clear();
413
414 const sal_Int32 nCount = rSubMenuEntries.getLength();
415 rSubMenu.reserve(rSubMenu.size() + nCount);
416 for ( sal_Int32 i = 0; i < nCount; i++ )
417 {
418 const uno::Sequence< beans::PropertyValue >& rMenuEntry = rSubMenuEntries[ i ];
419
420 AddonMenuItem aMenuItem;
421 GetMenuEntry( rMenuEntry, aMenuItem );
422 rSubMenu.push_back( aMenuItem );
423 }
424}
425
426} // namespace framework
427
428/* 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 );
9
Memory is allocated
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
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
14.1
Field 'm_pBody' is non-null
14.1
Field 'm_pBody' is non-null
14.1
Field 'm_pBody' is non-null
14.1
Field 'm_pBody' is non-null
)
15
Taking true branch
113 m_pBody->release();
16
Calling 'VclReferenceBase::release'
20
Returning; memory was released
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
17
Assuming the condition is true
18
Taking true branch
40 delete this;
19
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