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

/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21#include <navtoolbar.hxx>
22#include <frm_resource.hxx>
23#include <featuredispatcher.hxx>
24#include <strings.hrc>
25#include <commandimageprovider.hxx>
26
27#include <com/sun/star/uno/Any.hxx>
28#include <com/sun/star/form/runtime/FormFeature.hpp>
29
30#include <svx/labelitemwindow.hxx>
31
32#include <vcl/event.hxx>
33#include <vcl/commandinfoprovider.hxx>
34#include <vcl/toolbox.hxx>
35
36#include <sal/macros.h>
37#include <osl/diagnose.h>
38#include <tools/debug.hxx>
39
40#define LID_RECORD_LABEL1000 1000
41#define LID_RECORD_FILLER1001 1001
42
43
44namespace frm
45{
46
47
48 using ::com::sun::star::uno::makeAny;
49 namespace FormFeature = ::com::sun::star::form::runtime::FormFeature;
50
51
52 namespace
53 {
54 bool isArtificialItem( sal_Int16 _nFeatureId )
55 {
56 return ( _nFeatureId == LID_RECORD_LABEL1000 )
57 || ( _nFeatureId == LID_RECORD_FILLER1001 );
58 }
59
60 OUString getLabelString(const char* pResId)
61 {
62 OUString sLabel( " " + FRM_RES_STRING(pResId)ResourceManager::loadString(pResId) + " " );
63 return sLabel;
64 }
65
66 OUString lcl_getCommandURL( const sal_Int16 _nFormFeature )
67 {
68 const char* pAsciiCommandName = nullptr;
69 switch ( _nFormFeature )
70 {
71 case FormFeature::MoveAbsolute : pAsciiCommandName = "AbsoluteRecord"; break;
72 case FormFeature::TotalRecords : pAsciiCommandName = "RecTotal"; break;
73 case FormFeature::MoveToFirst : pAsciiCommandName = "FirstRecord"; break;
74 case FormFeature::MoveToPrevious : pAsciiCommandName = "PrevRecord"; break;
75 case FormFeature::MoveToNext : pAsciiCommandName = "NextRecord"; break;
76 case FormFeature::MoveToLast : pAsciiCommandName = "LastRecord"; break;
77 case FormFeature::SaveRecordChanges : pAsciiCommandName = "RecSave"; break;
78 case FormFeature::UndoRecordChanges : pAsciiCommandName = "RecUndo"; break;
79 case FormFeature::MoveToInsertRow : pAsciiCommandName = "NewRecord"; break;
80 case FormFeature::DeleteRecord : pAsciiCommandName = "DeleteRecord"; break;
81 case FormFeature::ReloadForm : pAsciiCommandName = "Refresh"; break;
82 case FormFeature::RefreshCurrentControl : pAsciiCommandName = "RefreshFormControl"; break;
83 case FormFeature::SortAscending : pAsciiCommandName = "Sortup"; break;
84 case FormFeature::SortDescending : pAsciiCommandName = "SortDown"; break;
85 case FormFeature::InteractiveSort : pAsciiCommandName = "OrderCrit"; break;
86 case FormFeature::AutoFilter : pAsciiCommandName = "AutoFilter"; break;
87 case FormFeature::InteractiveFilter : pAsciiCommandName = "FilterCrit"; break;
88 case FormFeature::ToggleApplyFilter : pAsciiCommandName = "FormFiltered"; break;
89 case FormFeature::RemoveFilterAndSort : pAsciiCommandName = "RemoveFilterSort"; break;
90 }
91 if ( pAsciiCommandName != nullptr )
92 return ".uno:" + OUString::createFromAscii( pAsciiCommandName );
93
94 OSL_FAIL( "lcl_getCommandURL: unknown FormFeature!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "94" ": "), "%s", "lcl_getCommandURL: unknown FormFeature!"
); } } while (false);
95 return OUString();
96 }
97 }
98
99 class ImplNavToolBar : public ToolBox
100 {
101 protected:
102 const IFeatureDispatcher* m_pDispatcher;
103
104 public:
105 explicit ImplNavToolBar( vcl::Window* _pParent )
106 :ToolBox( _pParent, WB_3DLOOK )
107 ,m_pDispatcher( nullptr )
108 {
109 }
110
111 void setDispatcher( const IFeatureDispatcher* _pDispatcher )
112 {
113 m_pDispatcher = _pDispatcher;
114 }
115
116 protected:
117 // ToolBox overridables
118 virtual void Select() override;
119
120 };
121
122
123 void ImplNavToolBar::Select()
124 {
125 if ( m_pDispatcher )
126 {
127 if ( !m_pDispatcher->isEnabled( GetCurItemId() ) )
128 // the toolbox is a little bit buggy: With ToolBoxItemBits::REPEAT, it sometimes
129 // happens that a select is reported, even though the respective
130 // item has just been disabled.
131 return;
132 m_pDispatcher->dispatch( GetCurItemId() );
133 }
134 }
135
136 NavigationToolBar::NavigationToolBar( vcl::Window* _pParent, WinBits _nStyle,
137 const PCommandImageProvider& _pImageProvider,
138 const OUString & sModuleId )
139 :Window( _pParent, _nStyle )
140 ,m_pDispatcher( nullptr )
141 ,m_pImageProvider( _pImageProvider )
142 ,m_eImageSize( eSmall )
143 ,m_pToolbar( nullptr )
144 ,m_sModuleId( sModuleId )
145 {
146 implInit( );
147 }
148
149 NavigationToolBar::~NavigationToolBar( )
150 {
151 disposeOnce();
152 }
153
154 void NavigationToolBar::dispose()
155 {
156 for (auto & childWin : m_aChildWins)
157 childWin.disposeAndClear();
158 m_aChildWins.clear();
159 m_pToolbar.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
160 vcl::Window::dispose();
161 }
162
163 void NavigationToolBar::setDispatcher( const IFeatureDispatcher* _pDispatcher )
164 {
165 m_pDispatcher = _pDispatcher;
166
167 m_pToolbar->setDispatcher( _pDispatcher );
168
169 RecordPositionInput* pPositionWindow = static_cast< RecordPositionInput* >( m_pToolbar->GetItemWindow( FormFeature::MoveAbsolute ) );
170 OSL_ENSURE( pPositionWindow, "NavigationToolBar::setDispatcher: can't forward the dispatcher to the position window!" )do { if (true && (!(pPositionWindow))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "170" ": "), "%s", "NavigationToolBar::setDispatcher: can't forward the dispatcher to the position window!"
); } } while (false);
171 if ( pPositionWindow )
172 pPositionWindow->setDispatcher( _pDispatcher );
173
174 // update feature states
175 for ( ToolBox::ImplToolItems::size_type nPos = 0; nPos < m_pToolbar->GetItemCount(); ++nPos )
176 {
177 sal_uInt16 nItemId = m_pToolbar->GetItemId( nPos );
178
179 if ( ( nItemId == LID_RECORD_LABEL1000 ) || ( nItemId == LID_RECORD_FILLER1001 ) )
180 continue;
181
182 // is this item enabled?
183 bool bEnabled = m_pDispatcher && m_pDispatcher->isEnabled( nItemId );
184 implEnableItem( nItemId, bEnabled );
185 }
186 }
187
188 void NavigationToolBar::implEnableItem( sal_uInt16 _nItemId, bool _bEnabled )
189 {
190 m_pToolbar->EnableItem( _nItemId, _bEnabled );
191
192 if ( _nItemId == FormFeature::MoveAbsolute )
193 m_pToolbar->EnableItem( LID_RECORD_LABEL1000, _bEnabled );
194
195 if ( _nItemId == FormFeature::TotalRecords )
196 m_pToolbar->EnableItem( LID_RECORD_FILLER1001, _bEnabled );
197 }
198
199 void NavigationToolBar::enableFeature( sal_Int16 _nFeatureId, bool _bEnabled )
200 {
201 DBG_ASSERT( m_pToolbar->GetItemPos( static_cast<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND,do { if (true && (!(m_pToolbar->GetItemPos( static_cast
<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND))
) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "202" ": "), "%s", "NavigationToolBar::enableFeature: invalid id!"
); } } while (false)
202 "NavigationToolBar::enableFeature: invalid id!" )do { if (true && (!(m_pToolbar->GetItemPos( static_cast
<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND))
) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "202" ": "), "%s", "NavigationToolBar::enableFeature: invalid id!"
); } } while (false);
203
204 implEnableItem( static_cast<sal_uInt16>(_nFeatureId), _bEnabled );
205 }
206
207 void NavigationToolBar::checkFeature( sal_Int16 _nFeatureId, bool _bEnabled )
208 {
209 DBG_ASSERT( m_pToolbar->GetItemPos( static_cast<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND,do { if (true && (!(m_pToolbar->GetItemPos( static_cast
<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND))
) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "210" ": "), "%s", "NavigationToolBar::checkFeature: invalid id!"
); } } while (false)
210 "NavigationToolBar::checkFeature: invalid id!" )do { if (true && (!(m_pToolbar->GetItemPos( static_cast
<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND))
) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "210" ": "), "%s", "NavigationToolBar::checkFeature: invalid id!"
); } } while (false);
211
212 m_pToolbar->CheckItem( static_cast<sal_uInt16>(_nFeatureId), _bEnabled );
213 }
214
215 void NavigationToolBar::setFeatureText( sal_Int16 _nFeatureId, const OUString& _rText )
216 {
217 DBG_ASSERT( m_pToolbar->GetItemPos( static_cast<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND,do { if (true && (!(m_pToolbar->GetItemPos( static_cast
<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND))
) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "218" ": "), "%s", "NavigationToolBar::checkFeature: invalid id!"
); } } while (false)
218 "NavigationToolBar::checkFeature: invalid id!" )do { if (true && (!(m_pToolbar->GetItemPos( static_cast
<sal_uInt16>(_nFeatureId) ) != ToolBox::ITEM_NOTFOUND))
) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "218" ": "), "%s", "NavigationToolBar::checkFeature: invalid id!"
); } } while (false);
219
220 vcl::Window* pItemWindow = m_pToolbar->GetItemWindow( static_cast<sal_uInt16>(_nFeatureId) );
221 if ( pItemWindow )
222 {
223 if (_nFeatureId == FormFeature::TotalRecords)
224 static_cast<LabelItemWindow*>(pItemWindow)->set_label(_rText);
225 else if (_nFeatureId == FormFeature::MoveAbsolute)
226 static_cast<RecordPositionInput*>(pItemWindow)->set_text(_rText);
227 }
228 else
229 m_pToolbar->SetItemText( static_cast<sal_uInt16>(_nFeatureId), _rText );
230 }
231
232 void NavigationToolBar::implInit( )
233 {
234 m_pToolbar = VclPtr<ImplNavToolBar>::Create( this );
235 m_pToolbar->SetOutStyle( TOOLBOX_STYLE_FLAT );
236 m_pToolbar->Show();
237
238 // need the SfxApplication for retrieving information about our
239 // items. We could duplicate all the information here in our lib
240 // (such as the item text and the image), but why should we?
241
242 static struct FeatureDescription
243 {
244 sal_uInt16 nId;
245 bool bRepeat;
246 bool bItemWindow;
247 } const aSupportedFeatures[] =
248 {
249 { LID_RECORD_LABEL1000, false, true },
250 { FormFeature::MoveAbsolute, false, true },
251 { LID_RECORD_FILLER1001, false, true },
252 { FormFeature::TotalRecords, false, true },
253 { FormFeature::MoveToFirst, true, false },
254 { FormFeature::MoveToPrevious, true, false },
255 { FormFeature::MoveToNext, true, false },
256 { FormFeature::MoveToLast, true, false },
257 { FormFeature::MoveToInsertRow, false, false },
258 { 0, false, false },
259 { FormFeature::SaveRecordChanges, false, false },
260 { FormFeature::UndoRecordChanges, false, false },
261 { FormFeature::DeleteRecord, false, false },
262 { FormFeature::ReloadForm, false, false },
263 { FormFeature::RefreshCurrentControl, false, false },
264 { 0, false, false },
265 { FormFeature::SortAscending, false, false },
266 { FormFeature::SortDescending, false, false },
267 { FormFeature::InteractiveSort, false, false },
268 { FormFeature::AutoFilter, false, false },
269 { FormFeature::InteractiveFilter, false, false },
270 { FormFeature::ToggleApplyFilter, false, false },
271 { FormFeature::RemoveFilterAndSort, false, false },
272 };
273
274 FeatureDescription const * pSupportedFeatures = aSupportedFeatures;
275 FeatureDescription const * pSupportedFeaturesEnd = aSupportedFeatures + SAL_N_ELEMENTS( aSupportedFeatures )(sizeof(sal_n_array_size(aSupportedFeatures)));
276 for ( ; pSupportedFeatures < pSupportedFeaturesEnd; ++pSupportedFeatures )
277 {
278 if ( pSupportedFeatures->nId )
279 { // it's _not_ a separator
280
281 // insert the entry
282 m_pToolbar->InsertItem( pSupportedFeatures->nId, OUString(), pSupportedFeatures->bRepeat ? ToolBoxItemBits::REPEAT : ToolBoxItemBits::NONE );
283 m_pToolbar->SetQuickHelpText( pSupportedFeatures->nId, OUString() ); // TODO
284
285 if ( !isArtificialItem( pSupportedFeatures->nId ) )
286 {
287 OUString sCommandURL( lcl_getCommandURL( pSupportedFeatures->nId ) );
288 m_pToolbar->SetItemCommand( pSupportedFeatures->nId, sCommandURL );
289 auto aProperties = vcl::CommandInfoProvider::GetCommandProperties(sCommandURL, m_sModuleId);
290 m_pToolbar->SetQuickHelpText(pSupportedFeatures->nId,
291 vcl::CommandInfoProvider::GetLabelForCommand(aProperties));
292 }
293
294 if ( pSupportedFeatures->bItemWindow )
295 {
296 vcl::Window* pItemWindow = nullptr;
297 if ( FormFeature::MoveAbsolute == pSupportedFeatures->nId )
298 {
299 pItemWindow = VclPtr<RecordPositionInput>::Create( m_pToolbar );
300 static_cast< RecordPositionInput* >( pItemWindow )->setDispatcher( m_pDispatcher );
301 }
302 else if (pSupportedFeatures->nId == LID_RECORD_FILLER1001)
303 pItemWindow = VclPtr<LabelItemWindow>::Create(m_pToolbar, getLabelString(RID_STR_LABEL_OFreinterpret_cast<char const *>("RID_STR_LABEL_OF" "\004"
u8"of")));
304 else if (pSupportedFeatures->nId == LID_RECORD_LABEL1000)
305 pItemWindow = VclPtr<LabelItemWindow>::Create(m_pToolbar, getLabelString(RID_STR_LABEL_RECORDreinterpret_cast<char const *>("RID_STR_LABEL_RECORD" "\004"
u8"Record")));
306 else if (pSupportedFeatures->nId == FormFeature::TotalRecords)
307 pItemWindow = VclPtr<LabelItemWindow>::Create(m_pToolbar, "");
308
309 m_aChildWins.emplace_back(pItemWindow );
310 m_pToolbar->SetItemWindow( pSupportedFeatures->nId, pItemWindow );
311 }
312 }
313 else
314 { // a separator
315 m_pToolbar->InsertSeparator( );
316 }
317 }
318
319 forEachItemWindow( &NavigationToolBar::adjustItemWindowWidth );
320
321 implUpdateImages();
322 }
323
324
325 void NavigationToolBar::implUpdateImages()
326 {
327 OSL_ENSURE( m_pImageProvider, "NavigationToolBar::implUpdateImages: no image provider => no images!" )do { if (true && (!(m_pImageProvider))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "327" ": "), "%s", "NavigationToolBar::implUpdateImages: no image provider => no images!"
); } } while (false);
328 if ( !m_pImageProvider )
329 return;
330
331 const ToolBox::ImplToolItems::size_type nItemCount = m_pToolbar->GetItemCount();
332
333 // collect the FormFeatures in the toolbar
334 std::vector<sal_Int16> aFormFeatures;
335 aFormFeatures.reserve( nItemCount );
336
337 for ( ToolBox::ImplToolItems::size_type i=0; i<nItemCount; ++i )
338 {
339 sal_uInt16 nId = m_pToolbar->GetItemId( i );
340 if ( ( ToolBoxItemType::BUTTON == m_pToolbar->GetItemType( i ) ) && !isArtificialItem( nId ) )
341 aFormFeatures.push_back( nId );
342 }
343
344 // translate them into command URLs
345 css::uno::Sequence< OUString > aCommandURLs( aFormFeatures.size() );
346 size_t i = 0;
347 for (auto const& formFeature : aFormFeatures)
348 {
349 aCommandURLs[i++] = lcl_getCommandURL(formFeature);
350 }
351
352 // retrieve the images for the command URLs
353 std::vector<Image> aCommandImages = m_pImageProvider->getCommandImages( aCommandURLs, m_eImageSize == eLarge );
354
355 // and set them at the toolbar
356 auto commandImage = aCommandImages.begin();
357 for (auto const& formFeature : aFormFeatures)
358 {
359 m_pToolbar->SetItemImage( formFeature, *commandImage );
360 ++commandImage;
361 }
362
363 // parts of our layout is dependent on the size of our icons
364 Resize();
365 }
366
367
368 void NavigationToolBar::implSetImageSize( ImageSize _eSize )
369 {
370 if ( _eSize != m_eImageSize )
371 {
372 m_eImageSize = _eSize;
373 implUpdateImages();
374 }
375 }
376
377
378 void NavigationToolBar::SetImageSize( ImageSize _eSize )
379 {
380 implSetImageSize( _eSize );
381 }
382
383
384 void NavigationToolBar::ShowFunctionGroup( FunctionGroup _eGroup, bool _bShow )
385 {
386 const sal_uInt16* pGroupIds = nullptr;
387
388 switch ( _eGroup )
389 {
390 case ePosition:
391 {
392 static const sal_uInt16 aPositionIds[] = {
393 LID_RECORD_LABEL1000, FormFeature::MoveAbsolute, LID_RECORD_FILLER1001, FormFeature::TotalRecords, 0
394 };
395 pGroupIds = aPositionIds;
396 }
397 break;
398 case eNavigation:
399 {
400 static const sal_uInt16 aNavigationIds[] = {
401 FormFeature::MoveToFirst, FormFeature::MoveToPrevious, FormFeature::MoveToNext, FormFeature::MoveToLast, FormFeature::MoveToInsertRow, 0
402 };
403 pGroupIds = aNavigationIds;
404 }
405 break;
406 case eRecordActions:
407 {
408 static const sal_uInt16 aActionIds[] = {
409 FormFeature::SaveRecordChanges, FormFeature::UndoRecordChanges, FormFeature::DeleteRecord, FormFeature::ReloadForm, FormFeature::RefreshCurrentControl, 0
410 };
411 pGroupIds = aActionIds;
412 }
413 break;
414 case eFilterSort:
415 {
416 static const sal_uInt16 aFilterSortIds[] = {
417 FormFeature::SortAscending, FormFeature::SortDescending, FormFeature::InteractiveSort, FormFeature::AutoFilter, FormFeature::InteractiveFilter, FormFeature::ToggleApplyFilter, FormFeature::RemoveFilterAndSort, 0
418 };
419 pGroupIds = aFilterSortIds;
420 }
421 break;
422 default:
423 OSL_FAIL( "NavigationToolBar::ShowFunctionGroup: invalid group id!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "423" ": "), "%s", "NavigationToolBar::ShowFunctionGroup: invalid group id!"
); } } while (false);
424 }
425
426 if ( pGroupIds )
427 while ( *pGroupIds )
428 m_pToolbar->ShowItem( *pGroupIds++, _bShow );
429 }
430
431
432 bool NavigationToolBar::IsFunctionGroupVisible( FunctionGroup _eGroup )
433 {
434 sal_uInt16 nIndicatorItem = 0;
435 switch ( _eGroup )
436 {
437 case ePosition : nIndicatorItem = LID_RECORD_LABEL1000; break;
438 case eNavigation : nIndicatorItem = FormFeature::MoveToFirst; break;
439 case eRecordActions : nIndicatorItem = FormFeature::SaveRecordChanges; break;
440 case eFilterSort : nIndicatorItem = FormFeature::SortAscending; break;
441 default:
442 OSL_FAIL( "NavigationToolBar::IsFunctionGroupVisible: invalid group id!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/forms/source/solar/control/navtoolbar.cxx"
":" "442" ": "), "%s", "NavigationToolBar::IsFunctionGroupVisible: invalid group id!"
); } } while (false);
443 }
444
445 return m_pToolbar->IsItemVisible( nIndicatorItem );
446 }
447
448
449 void NavigationToolBar::StateChanged( StateChangedType nType )
450 {
451 Window::StateChanged( nType );
452
453 switch ( nType )
454 {
455 case StateChangedType::Zoom:
456// m_pToolbar->SetZoom( GetZoom() );
457// forEachItemWindow( setItemWindowZoom, NULL );
458 // the ToolBox class is not zoomable at the moment, so
459 // we better have no zoom at all instead of only half a zoom ...
460 break;
461
462 case StateChangedType::ControlFont:
463 forEachItemWindow( &NavigationToolBar::setItemControlFont );
464 forEachItemWindow( &NavigationToolBar::adjustItemWindowWidth );
465 break;
466
467 case StateChangedType::ControlForeground:
468 forEachItemWindow( &NavigationToolBar::setItemControlForeground );
469 break;
470
471 case StateChangedType::Mirroring:
472 {
473 sal_Bool bIsRTLEnabled( IsRTLEnabled() );
474 m_pToolbar->EnableRTL( bIsRTLEnabled );
475 forEachItemWindow( &NavigationToolBar::enableItemRTL, &bIsRTLEnabled );
476 Resize();
477 }
478 break;
479 default:;
480 }
481 }
482
483 void NavigationToolBar::Resize()
484 {
485 // resize/position the toolbox as a whole
486 sal_Int32 nToolbarHeight = m_pToolbar->CalcWindowSizePixel().Height();
487
488 sal_Int32 nMyHeight = GetOutputSizePixel().Height();
489 m_pToolbar->SetPosSizePixel( Point( 0, ( nMyHeight - nToolbarHeight ) / 2 ),
490 Size( GetSizePixel().Width(), nToolbarHeight ) );
491
492 Window::Resize();
493 }
494
495 void NavigationToolBar::SetControlBackground()
496 {
497 Window::SetControlBackground();
498 m_pToolbar->SetControlBackground();
499 forEachItemWindow( &NavigationToolBar::setItemBackground, nullptr );
500
501 implUpdateImages();
502 }
503
504 void NavigationToolBar::SetControlBackground( const Color& _rColor )
505 {
506 Window::SetControlBackground( _rColor );
507 m_pToolbar->SetControlBackground( _rColor );
508 forEachItemWindow( &NavigationToolBar::setItemBackground, &_rColor );
509
510 implUpdateImages();
511 }
512
513 void NavigationToolBar::SetTextLineColor( )
514 {
515 Window::SetTextLineColor( );
516 m_pToolbar->SetTextLineColor( );
517 forEachItemWindow( &NavigationToolBar::setTextLineColor, nullptr );
518 }
519
520 void NavigationToolBar::SetTextLineColor( const Color& _rColor )
521 {
522 Window::SetTextLineColor( _rColor );
523 m_pToolbar->SetTextLineColor( _rColor );
524 forEachItemWindow( &NavigationToolBar::setTextLineColor, &_rColor );
525 }
526
527 void NavigationToolBar::forEachItemWindow( ItemWindowHandler _handler )
528 {
529 for ( ToolBox::ImplToolItems::size_type item = 0; item < m_pToolbar->GetItemCount(); ++item )
530 {
531 sal_uInt16 nItemId = m_pToolbar->GetItemId( item );
532 vcl::Window* pItemWindow = m_pToolbar->GetItemWindow( nItemId );
533 if ( pItemWindow )
534 (this->*_handler)( nItemId, pItemWindow );
535 }
536 }
537
538 void NavigationToolBar::forEachItemWindow( ItemWindowHandler2 _handler, const void* _pParam )
539 {
540 for ( ToolBox::ImplToolItems::size_type item = 0; item < m_pToolbar->GetItemCount(); ++item )
541 {
542 sal_uInt16 nItemId = m_pToolbar->GetItemId( item );
543 vcl::Window* pItemWindow = m_pToolbar->GetItemWindow( nItemId );
544 if ( pItemWindow )
545 (*_handler)( nItemId, pItemWindow, _pParam );
546 }
547 }
548
549 void NavigationToolBar::setItemBackground( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow, const void* _pColor )
550 {
551 if ( _pColor )
552 _pItemWindow->SetControlBackground( *static_cast< const Color* >( _pColor ) );
553 else
554 _pItemWindow->SetControlBackground();
555 }
556
557 void NavigationToolBar::setTextLineColor( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow, const void* _pColor )
558 {
559 if ( _pColor )
560 _pItemWindow->SetTextLineColor( *static_cast< const Color* >( _pColor ) );
561 else
562 _pItemWindow->SetTextLineColor();
563 }
564
565 void NavigationToolBar::setItemControlFont( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow ) const
566 {
567 if ( IsControlFont() )
568 _pItemWindow->SetControlFont( GetControlFont() );
569 else
570 _pItemWindow->SetControlFont( );
571 }
572
573 void NavigationToolBar::setItemControlForeground( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow ) const
574 {
575 if ( IsControlForeground() )
576 _pItemWindow->SetControlForeground( GetControlForeground() );
577 else
578 _pItemWindow->SetControlForeground( );
579 _pItemWindow->SetTextColor( GetTextColor() );
580 }
581
582 void NavigationToolBar::adjustItemWindowWidth( sal_uInt16 _nItemId, vcl::Window* _pItemWindow ) const
583 {
584 int nHeight = 0;
585
586 OUString sItemText;
587 switch ( _nItemId )
588 {
589 case LID_RECORD_LABEL1000:
590 sItemText = getLabelString( RID_STR_LABEL_RECORDreinterpret_cast<char const *>("RID_STR_LABEL_RECORD" "\004"
u8"Record") );
591 break;
592
593 case LID_RECORD_FILLER1001:
594 sItemText = getLabelString( RID_STR_LABEL_OFreinterpret_cast<char const *>("RID_STR_LABEL_OF" "\004"
u8"of") );
595 break;
596
597 case FormFeature::MoveAbsolute:
598 sItemText = "12345678";
599 nHeight = _pItemWindow->get_preferred_size().Height();
600 break;
601
602 case FormFeature::TotalRecords:
603 sItemText = "123456";
604 break;
605 }
606
607 if (nHeight == 0)
608 nHeight = _pItemWindow->GetTextHeight() + 4;
609
610 Size aSize(_pItemWindow->GetTextWidth(sItemText), nHeight);
611 aSize.AdjustWidth(6 );
612 _pItemWindow->SetSizePixel( aSize );
613
614 m_pToolbar->SetItemWindow( _nItemId, _pItemWindow );
615 }
616
617 void NavigationToolBar::enableItemRTL( sal_uInt16 /*_nItemId*/, vcl::Window* _pItemWindow, const void* _pIsRTLEnabled )
618 {
619 _pItemWindow->EnableRTL( *static_cast< const sal_Bool* >( _pIsRTLEnabled ) );
620 }
621
622 RecordPositionInput::RecordPositionInput(vcl::Window* pParent)
623 : RecordItemWindow(pParent)
624 , m_pDispatcher( nullptr )
625 {
626 }
627
628 void RecordPositionInput::setDispatcher( const IFeatureDispatcher* _pDispatcher )
629 {
630 m_pDispatcher = _pDispatcher;
631 }
632
633 void RecordPositionInput::PositionFired(sal_Int64 nRecord)
634 {
635 if (!m_pDispatcher)
636 return;
637 m_pDispatcher->dispatchWithArgument( FormFeature::MoveAbsolute, "Position", makeAny( static_cast<sal_Int32>(nRecord) ) );
638 }
639
640} // namespace frm
641
642/* 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);
2
←
Calling copy constructor for 'Reference<frm::ImplNavToolBar>'
→
5
←
Returning from copy constructor for 'Reference<frm::ImplNavToolBar>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
6
←
Calling 'Reference::clear'
→
13
←
Returning; memory was released
→
205 if (aTmp.get()) {
14
←
Calling 'Reference::get'
→
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
3
←
Assuming field 'm_pBody' is non-null
→
4
←
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
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
)
7
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
8
←
Calling 'VclReferenceBase::release'
→
12
←
Returning; memory was released
→
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
15
←
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__));
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__));
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
9
←
Assuming the condition is true
→
10
←
Taking true branch
→
40 delete this;
11
←
Memory is released
→
41 }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44 sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47
48
49private:
50 VclReferenceBase(const VclReferenceBase&) = delete;
51 VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52
53 bool mbDisposed : 1;
54
55protected:
56 VclReferenceBase();
57protected:
58 virtual ~VclReferenceBase();
59
60protected:
61 virtual void dispose();
62
63public:
64 void disposeOnce();
65 bool isDisposed() const { return mbDisposed; }
66
67};
68#endif