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 roadmap.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 /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/glm -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/libmount -isystem /usr/include/blkid -isystem /usr/include/cairo -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/pixman-1 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/libxml2 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -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 VCL_DLLIMPLEMENTATION -D DLLIMPLEMENTATION_UITEST -D CUI_DLL_NAME="libcuilo.so" -D DESKTOP_DETECTOR_DLL_NAME="libdesktop_detectorlo.so" -D TK_DLL_NAME="libtklo.so" -D SYSTEM_ZLIB -D GLM_FORCE_CTOR_INIT -D SK_USER_CONFIG_HEADER=</home/maarten/src/libreoffice/core/config_host/config_skia.h> -D SKIA_DLL -D ENABLE_CUPS -D HAVE_VALGRIND_HEADERS -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/core -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/effects -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/config -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/ports -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/third_party/vulkan -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/tools/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia -I /home/maarten/src/libreoffice/core/external/skia/inc/ -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/lcms2/include -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/workdir/UnpackedTarball/harfbuzz/src -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/graphite/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium/public -D COMPONENT_BUILD -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libpng -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libjpeg-turbo -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/vcl/inc -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/libxml2 -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/vcl/source/control/roadmap.cxx

/home/maarten/src/libreoffice/core/vcl/source/control/roadmap.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 <vector>
21#include <algorithm>
22#include <vcl/event.hxx>
23#include <vcl/toolkit/roadmap.hxx>
24#include <vcl/settings.hxx>
25#include <hyperlabel.hxx>
26#include <tools/color.hxx>
27#include <rtl/ustring.hxx>
28
29constexpr long LABELBASEMAPHEIGHT = 8;
30constexpr long ROADMAP_INDENT_X = 4;
31constexpr long ROADMAP_INDENT_Y = 27;
32constexpr long ROADMAP_ITEM_DISTANCE_Y = 6;
33
34namespace vcl
35{
36
37typedef std::vector< RoadmapItem* > HL_Vector;
38
39//= ColorChanger
40
41namespace {
42
43class IDLabel : public FixedText
44{
45public:
46 IDLabel( vcl::Window* _pParent, WinBits _nWinStyle );
47 virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
48 virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
49};
50
51}
52
53class RoadmapItem : public RoadmapTypes
54{
55private:
56 VclPtr<IDLabel> mpID;
57 VclPtr<HyperLabel> mpDescription;
58 const Size m_aItemPlayground;
59
60public:
61 RoadmapItem( ORoadmap& _rParent, const Size& _rItemPlayground );
62 ~RoadmapItem();
63
64 void SetID( sal_Int16 ID );
65 sal_Int16 GetID() const;
66
67 void SetIndex( ItemIndex Index );
68 ItemIndex GetIndex() const;
69
70 void Update( ItemIndex RMIndex, const OUString& _rText );
71
72 void SetPosition( RoadmapItem const * OldHyperLabel );
73
74 void ToggleBackgroundColor( const Color& _rGBColor );
75 void SetInteractive( bool _bInteractive );
76
77 void SetClickHdl( const Link<HyperLabel*,void>& rLink );
78 void Enable( bool bEnable );
79 bool IsEnabled() const;
80 void GrabFocus();
81
82 bool Contains( const vcl::Window* _pWindow ) const;
83
84private:
85 void ImplUpdateIndex( const ItemIndex _nIndex );
86 void ImplUpdatePosSize();
87};
88
89//= RoadmapImpl
90
91class RoadmapImpl : public RoadmapTypes
92{
93protected:
94 const ORoadmap& m_rAntiImpl;
95 Link<LinkParamNone*,void> m_aSelectHdl;
96 BitmapEx m_aPicture;
97 HL_Vector m_aRoadmapSteps;
98 ItemId m_iCurItemID;
99 bool m_bInteractive : 1;
100 bool m_bComplete : 1;
101 Size m_aItemSizePixel;
102public:
103 bool m_bPaintInitialized : 1;
104
105public:
106 explicit RoadmapImpl(const ORoadmap& rAntiImpl)
107 : m_rAntiImpl(rAntiImpl)
108 , m_iCurItemID(-1)
109 , m_bInteractive(true)
110 , m_bComplete(true)
111 , m_bPaintInitialized(false)
112 , InCompleteHyperLabel(nullptr)
113 {}
114
115 RoadmapItem* InCompleteHyperLabel;
116
117 HL_Vector& getHyperLabels()
118 {
119 return m_aRoadmapSteps;
120 }
121
122 void insertHyperLabel(ItemIndex Index, RoadmapItem* _rRoadmapStep)
123 {
124 m_aRoadmapSteps.insert(m_aRoadmapSteps.begin() + Index, _rRoadmapStep);
125 }
126
127 ItemIndex getItemCount() const
128 {
129 return m_aRoadmapSteps.size();
130 }
131
132 void setCurItemID(ItemId i)
133 {
134 m_iCurItemID = i;
135 }
136 ItemId getCurItemID() const
137 {
138 return m_iCurItemID;
139 }
140
141 void setInteractive(const bool _bInteractive)
142 {
143 m_bInteractive = _bInteractive;
144 }
145 bool isInteractive() const
146 {
147 return m_bInteractive;
148 }
149
150 void setComplete(const bool _bComplete)
151 {
152 m_bComplete = _bComplete;
153 }
154 bool isComplete() const
155 {
156 return m_bComplete;
157 }
158
159 void setPicture(const BitmapEx& _rPic)
160 {
161 m_aPicture = _rPic;
162 }
163 const BitmapEx& getPicture() const
164 {
165 return m_aPicture;
166 }
167
168 void setSelectHdl(const Link<LinkParamNone*,void>& _rHdl)
169 {
170 m_aSelectHdl = _rHdl;
171 }
172 const Link<LinkParamNone*,void>& getSelectHdl() const
173 {
174 return m_aSelectHdl;
175 }
176
177 void initItemSize();
178 const Size& getItemSize() const
179 {
180 return m_aItemSizePixel;
181 }
182
183 void removeHyperLabel(ItemIndex Index)
184 {
185 if ((Index > -1) && (Index < getItemCount()))
186 {
187 delete m_aRoadmapSteps[Index];
188 m_aRoadmapSteps.erase(m_aRoadmapSteps.begin() + Index);
189 }
190 }
191};
192
193void RoadmapImpl::initItemSize()
194{
195 Size aLabelSize( m_rAntiImpl.GetOutputSizePixel() );
196 aLabelSize.setHeight( m_rAntiImpl.LogicToPixel(Size(0, LABELBASEMAPHEIGHT), MapMode(MapUnit::MapAppFont)).Height() );
197 aLabelSize.AdjustWidth( -(m_rAntiImpl.LogicToPixel(Size(2 * ROADMAP_INDENT_X, 0), MapMode(MapUnit::MapAppFont)).Width()) );
198 m_aItemSizePixel = aLabelSize;
199}
200
201//= Roadmap
202
203ORoadmap::ORoadmap(vcl::Window* _pParent, WinBits _nWinStyle)
204 : Control(_pParent, _nWinStyle)
205 , m_pImpl(new RoadmapImpl(*this))
206{
207}
208
209void ORoadmap::implInit(vcl::RenderContext& rRenderContext)
210{
211 delete m_pImpl->InCompleteHyperLabel;
212 m_pImpl->InCompleteHyperLabel = nullptr;
213 m_pImpl->setCurItemID(-1);
214 m_pImpl->setComplete(true);
215 m_pImpl->m_bPaintInitialized = true;
216
217 // Roadmap control should be reachable as one unit with a Tab key
218 // the next Tab key should spring out of the control.
219 // To reach it the control itself should get focus and set it
220 // on entries. The entries themself should not be reachable with
221 // the Tab key directly. So each entry should have WB_NOTABSTOP.
222
223 // In other words the creator should create the control with the following
224 // flags:
225 // SetStyle( ( GetStyle() | WB_TABSTOP ) & ~WB_DIALOGCONTROL );
226
227// TODO: if somebody sets a new font from outside (OutputDevice::SetFont), we would have to react
228// on this with calculating a new bold font.
229// Unfortunately, the OutputDevice does not offer a notify mechanism for a changed font.
230// So settings the font from outside is simply a forbidden scenario at the moment
231 rRenderContext.EnableMapMode(false);
232}
233
234ORoadmap::~ORoadmap()
235{
236 disposeOnce();
237}
238
239void ORoadmap::dispose()
240{
241 HL_Vector aItemsCopy = m_pImpl->getHyperLabels();
242 m_pImpl->getHyperLabels().clear();
243 for (auto const& itemCopy : aItemsCopy)
244 {
245 delete itemCopy;
246 }
247 if ( ! m_pImpl->isComplete() )
248 delete m_pImpl->InCompleteHyperLabel;
249 m_pImpl.reset();
250 Control::dispose();
251}
252
253RoadmapTypes::ItemId ORoadmap::GetCurrentRoadmapItemID() const
254{
255 return m_pImpl->getCurItemID();
256}
257
258RoadmapItem* ORoadmap::GetPreviousHyperLabel(ItemIndex Index)
259{
260 RoadmapItem* pOldItem = nullptr;
261 if ( Index > 0 )
262 pOldItem = m_pImpl->getHyperLabels().at( Index - 1 );
263 return pOldItem;
264}
265
266RoadmapItem* ORoadmap::InsertHyperLabel(ItemIndex Index, const OUString& _sLabel, ItemId RMID, bool _bEnabled, bool _bIncomplete)
267{
268 if (m_pImpl->getItemCount() == 0)
269 m_pImpl->initItemSize();
270
271 RoadmapItem* pItem = nullptr;
272 RoadmapItem* pOldItem = GetPreviousHyperLabel( Index );
273
274 pItem = new RoadmapItem( *this, m_pImpl->getItemSize() );
275 if ( _bIncomplete )
276 {
277 pItem->SetInteractive( false );
278 }
279 else
280 {
281 pItem->SetInteractive( m_pImpl->isInteractive() );
282 m_pImpl->insertHyperLabel( Index, pItem );
283 }
284 pItem->SetPosition( pOldItem );
285 pItem->Update( Index, _sLabel );
286 pItem->SetClickHdl(LINK( this, ORoadmap, ImplClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<ORoadmap
*>(this), &ORoadmap::LinkStubImplClickHdl) );
287 pItem->SetID( RMID );
288 pItem->SetIndex( Index );
289 if (!_bEnabled)
290 pItem->Enable( _bEnabled );
291 return pItem;
292}
293
294void ORoadmap::SetRoadmapBitmap(const BitmapEx& _rBmp)
295{
296 m_pImpl->setPicture( _rBmp );
297 Invalidate( );
298}
299
300void ORoadmap::SetRoadmapInteractive(bool _bInteractive)
301{
302 m_pImpl->setInteractive( _bInteractive );
303
304 const HL_Vector& rItems = m_pImpl->getHyperLabels();
305 for (auto const& item : rItems)
306 {
307 item->SetInteractive( _bInteractive );
308 }
309}
310
311bool ORoadmap::IsRoadmapInteractive() const
312{
313 return m_pImpl->isInteractive();
314}
315
316void ORoadmap::SetRoadmapComplete(bool _bComplete)
317{
318 bool bWasComplete = m_pImpl->isComplete();
319 m_pImpl->setComplete( _bComplete );
320 if (_bComplete)
321 {
322 if (m_pImpl->InCompleteHyperLabel != nullptr)
323 {
324 delete m_pImpl->InCompleteHyperLabel;
325 m_pImpl->InCompleteHyperLabel = nullptr;
326 }
327 }
328 else if (bWasComplete)
329 m_pImpl->InCompleteHyperLabel = InsertHyperLabel(m_pImpl->getItemCount(), "...", -1, true/*bEnabled*/, true/*bIncomplete*/ );
330}
331
332void ORoadmap::UpdatefollowingHyperLabels(ItemIndex _nIndex)
333{
334 const HL_Vector& rItems = m_pImpl->getHyperLabels();
335 if ( _nIndex < static_cast<ItemIndex>(rItems.size()) )
336 {
337 for ( HL_Vector::const_iterator i = rItems.begin() + _nIndex;
338 i != rItems.end();
339 ++i, ++_nIndex
340 )
341 {
342 RoadmapItem* pItem = *i;
343
344 pItem->SetIndex( _nIndex );
345 pItem->SetPosition( GetPreviousHyperLabel( _nIndex ) );
346 }
347
348 }
349 if ( ! m_pImpl->isComplete() )
350 {
351 RoadmapItem* pOldItem = GetPreviousHyperLabel( m_pImpl->getItemCount() );
352 m_pImpl->InCompleteHyperLabel->SetPosition( pOldItem );
353 m_pImpl->InCompleteHyperLabel->Update( m_pImpl->getItemCount(), "..." );
354 }
355}
356
357void ORoadmap::ReplaceRoadmapItem(ItemIndex Index, const OUString& roadmapItem, ItemId RMID, bool _bEnabled)
358{
359 RoadmapItem* pItem = GetByIndex( Index);
360 if ( pItem != nullptr )
361 {
362 pItem->Update( Index, roadmapItem );
363 pItem->SetID( RMID );
364 pItem->Enable( _bEnabled );
365 }
366}
367
368RoadmapTypes::ItemIndex ORoadmap::GetItemCount() const
369{
370 return m_pImpl->getItemCount();
371}
372
373RoadmapTypes::ItemId ORoadmap::GetItemID(ItemIndex _nIndex) const
374{
375 const RoadmapItem* pHyperLabel = GetByIndex( _nIndex );
376 if ( pHyperLabel )
377 return pHyperLabel->GetID();
378 return -1;
379}
380
381void ORoadmap::InsertRoadmapItem(ItemIndex Index, const OUString& RoadmapItem, ItemId _nUniqueId, bool _bEnabled)
382{
383 InsertHyperLabel( Index, RoadmapItem, _nUniqueId, _bEnabled, false/*bIncomplete*/ );
384 // TODO YPos is superfluous, if items are always appended
385 UpdatefollowingHyperLabels( Index + 1 );
386}
387
388void ORoadmap::DeleteRoadmapItem(ItemIndex Index)
389{
390 if ( m_pImpl->getItemCount() > 0 && ( Index > -1) && ( Index < m_pImpl->getItemCount() ) )
391 {
392 m_pImpl->removeHyperLabel( Index );
393 UpdatefollowingHyperLabels( Index );
394 }
395}
396
397bool ORoadmap::IsRoadmapComplete() const
398{
399 return m_pImpl->isComplete();
400}
401
402void ORoadmap::EnableRoadmapItem( ItemId _nItemId, bool _bEnable )
403{
404 RoadmapItem* pItem = GetByID( _nItemId );
405 if ( pItem != nullptr )
406 pItem->Enable( _bEnable );
407}
408
409void ORoadmap::ChangeRoadmapItemLabel( ItemId _nID, const OUString& _sLabel )
410{
411 RoadmapItem* pItem = GetByID( _nID );
412 if ( pItem == nullptr )
413 return;
414
415 pItem->Update( pItem->GetIndex(), _sLabel );
416
417 const HL_Vector& rItems = m_pImpl->getHyperLabels();
418 size_t nPos = 0;
419 for (auto const& item : rItems)
420 {
421 item->SetPosition( GetPreviousHyperLabel(nPos) );
422 ++nPos;
423 }
424}
425
426void ORoadmap::ChangeRoadmapItemID(ItemId _nID, ItemId NewID)
427{
428 RoadmapItem* pItem = GetByID( _nID );
429 if ( pItem != nullptr )
430 pItem->SetID( NewID );
431}
432
433RoadmapItem* ORoadmap::GetByID(ItemId _nID)
434{
435 ItemId nLocID = 0;
436 const HL_Vector& rItems = m_pImpl->getHyperLabels();
437 for (auto const& item : rItems)
438 {
439 nLocID = item->GetID();
440 if ( nLocID == _nID )
441 return item;
442 }
443 return nullptr;
444}
445
446const RoadmapItem* ORoadmap::GetByID(ItemId _nID) const
447{
448 return const_cast< ORoadmap* >( this )->GetByID( _nID );
449}
450
451RoadmapItem* ORoadmap::GetByIndex(ItemIndex _nItemIndex)
452{
453 const HL_Vector& rItems = m_pImpl->getHyperLabels();
454 if ( ( _nItemIndex > -1 ) && ( _nItemIndex < static_cast<ItemIndex>(rItems.size()) ) )
455 {
456 return rItems.at( _nItemIndex );
457 }
458 return nullptr;
459}
460
461const RoadmapItem* ORoadmap::GetByIndex(ItemIndex _nItemIndex) const
462{
463 return const_cast< ORoadmap* >( this )->GetByIndex( _nItemIndex );
464}
465
466RoadmapTypes::ItemId ORoadmap::GetNextAvailableItemId(ItemIndex _nNewIndex)
467{
468 ItemIndex searchIndex = ++_nNewIndex;
469 while ( searchIndex < m_pImpl->getItemCount() )
470 {
471 RoadmapItem* pItem = GetByIndex( searchIndex );
472 if ( pItem->IsEnabled() )
473 return pItem->GetID( );
474
475 ++searchIndex;
476 }
477 return -1;
478}
479
480RoadmapTypes::ItemId ORoadmap::GetPreviousAvailableItemId(ItemIndex _nNewIndex)
481{
482 ItemIndex searchIndex = --_nNewIndex;
483 while ( searchIndex > -1 )
484 {
485 RoadmapItem* pItem = GetByIndex( searchIndex );
486 if ( pItem->IsEnabled() )
487 return pItem->GetID( );
488
489 searchIndex--;
490 }
491 return -1;
492}
493
494void ORoadmap::DeselectOldRoadmapItems()
495{
496 const HL_Vector& rItems = m_pImpl->getHyperLabels();
497 for (auto const& item : rItems)
498 {
499 item->ToggleBackgroundColor( COL_TRANSPARENT );
500 }
501}
502
503void ORoadmap::SetItemSelectHdl(const Link<LinkParamNone*,void>& _rHdl)
504{
505 m_pImpl->setSelectHdl(_rHdl);
506}
507
508Link<LinkParamNone*,void> const & ORoadmap::GetItemSelectHdl() const
509{
510 return m_pImpl->getSelectHdl();
511}
512
513void ORoadmap::Select()
514{
515 GetItemSelectHdl().Call( nullptr );
516 CallEventListeners( VclEventId::RoadmapItemSelected );
517}
518
519void ORoadmap::GetFocus()
520{
521 RoadmapItem* pCurHyperLabel = GetByID( GetCurrentRoadmapItemID() );
522 if ( pCurHyperLabel != nullptr )
523 pCurHyperLabel->GrabFocus();
524}
525
526bool ORoadmap::SelectRoadmapItemByID( ItemId _nNewID )
527{
528 DeselectOldRoadmapItems();
529 RoadmapItem* pItem = GetByID( _nNewID );
530 if ( pItem != nullptr )
531 {
532 if ( pItem->IsEnabled() )
533 {
534 const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
535 pItem->ToggleBackgroundColor( rStyleSettings.GetHighlightColor() ); //HighlightColor
536
537 pItem->GrabFocus();
538 m_pImpl->setCurItemID(_nNewID);
539
540 Select();
541 return true;
542 }
543 }
544 return false;
545}
546
547void ORoadmap::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& _rRect)
548{
549 if (!m_pImpl->m_bPaintInitialized)
550 implInit(rRenderContext);
551 Control::Paint(rRenderContext, _rRect);
552
553 // draw the bitmap
554 if (!!m_pImpl->getPicture())
555 {
556 Size aBitmapSize = m_pImpl->getPicture().GetSizePixel();
557 Size aMySize(GetOutputSizePixel());
558
559 Point aBitmapPos(aMySize.Width() - aBitmapSize.Width(), aMySize.Height() - aBitmapSize.Height());
560
561 // draw it
562 rRenderContext.DrawBitmapEx( aBitmapPos, m_pImpl->getPicture() );
563 }
564
565 // draw the headline
566 DrawHeadline(rRenderContext);
567}
568
569void ORoadmap::DrawHeadline(vcl::RenderContext& rRenderContext)
570{
571 Point aTextPos = LogicToPixel(Point(ROADMAP_INDENT_X, 8), MapMode(MapUnit::MapAppFont));
572
573 Size aOutputSize(GetOutputSizePixel());
574
575 // draw it
576 rRenderContext.DrawText(tools::Rectangle(aTextPos, aOutputSize), GetText(),
577 DrawTextFlags::Left | DrawTextFlags::Top | DrawTextFlags::MultiLine | DrawTextFlags::WordBreak);
578 rRenderContext.DrawTextLine(aTextPos, aOutputSize.Width(), STRIKEOUT_NONE, LINESTYLE_SINGLE, LINESTYLE_NONE);
579 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
580 rRenderContext.SetLineColor(rStyleSettings.GetFieldTextColor());
581 rRenderContext.SetTextColor(rStyleSettings.GetFieldTextColor());
582}
583
584RoadmapItem* ORoadmap::GetByPointer(vcl::Window const * pWindow)
585{
586 const HL_Vector& rItems = m_pImpl->getHyperLabels();
587 for (auto const& item : rItems)
588 {
589 if ( item->Contains( pWindow ) )
590 return item;
591 }
592 return nullptr;
593}
594
595bool ORoadmap::PreNotify(NotifyEvent& _rNEvt)
596{
597 // capture KeyEvents for taskpane cycling
598 if ( _rNEvt.GetType() == MouseNotifyEvent::KEYINPUT )
599 {
600 vcl::Window* pWindow = _rNEvt.GetWindow();
601 RoadmapItem* pItem = GetByPointer( pWindow );
602 if ( pItem != nullptr )
603 {
604 sal_Int16 nKeyCode = _rNEvt.GetKeyEvent()->GetKeyCode().GetCode();
605 switch( nKeyCode )
606 {
607 case KEY_UP:
608 { // Note: Performance wise this is not optimal, because we search for an ID in the labels
609 // and afterwards we search again for a label with the appropriate ID ->
610 // unnecessarily we search twice!!!
611 ItemId nPrevItemID = GetPreviousAvailableItemId( pItem->GetIndex() );
612 if ( nPrevItemID != -1 )
613 return SelectRoadmapItemByID( nPrevItemID );
614 }
615 break;
616 case KEY_DOWN:
617 {
618 ItemId nNextItemID = GetNextAvailableItemId( pItem->GetIndex() );
619 if ( nNextItemID != -1 )
620 return SelectRoadmapItemByID( nNextItemID );
621 }
622 break;
623 case KEY_SPACE:
624 return SelectRoadmapItemByID( pItem->GetID() );
625 }
626 }
627 }
628 return Window::PreNotify( _rNEvt );
629}
630
631IMPL_LINK(ORoadmap, ImplClickHdl, HyperLabel*, CurHyperLabel, void)void ORoadmap::LinkStubImplClickHdl(void * instance, HyperLabel
* data) { return static_cast<ORoadmap *>(instance)->
ImplClickHdl(data); } void ORoadmap::ImplClickHdl(HyperLabel*
CurHyperLabel)
632{
633 SelectRoadmapItemByID( CurHyperLabel->GetID() );
634}
635
636void ORoadmap::DataChanged(const DataChangedEvent& rDCEvt)
637{
638 if (!((( rDCEvt.GetType() == DataChangedEventType::SETTINGS ) ||
639 ( rDCEvt.GetType() == DataChangedEventType::DISPLAY )) &&
640 ( rDCEvt.GetFlags() & AllSettingsFlags::STYLE )))
641 return;
642
643 const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
644 SetBackground( Wallpaper( rStyleSettings.GetFieldColor() ) );
645 Color aTextColor = rStyleSettings.GetFieldTextColor();
646 vcl::Font aFont = GetFont();
647 aFont.SetColor( aTextColor );
648 SetFont( aFont );
649 RoadmapTypes::ItemId curItemID = GetCurrentRoadmapItemID();
650 RoadmapItem* pLabelItem = GetByID( curItemID );
651 if (pLabelItem != nullptr)
652 {
653 pLabelItem->ToggleBackgroundColor(rStyleSettings.GetHighlightColor());
654 }
655 Invalidate();
656}
657
658void ORoadmap::ApplySettings(vcl::RenderContext& rRenderContext)
659{
660 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
661 Color aTextColor = rStyleSettings.GetFieldTextColor();
662 vcl::Font aFont = rRenderContext.GetFont();
663 aFont.SetColor(aTextColor);
664 aFont.SetWeight(WEIGHT_BOLD);
665 aFont.SetUnderline(LINESTYLE_SINGLE);
666 rRenderContext.SetFont(aFont);
667 rRenderContext.SetBackground(rStyleSettings.GetFieldColor());
668}
669
670RoadmapItem::RoadmapItem(ORoadmap& _rParent, const Size& _rItemPlayground)
671 : m_aItemPlayground(_rItemPlayground)
672{
673 mpID = VclPtr<IDLabel>::Create( &_rParent, WB_WORDBREAK );
674 mpID->Show();
675 mpDescription = VclPtr<HyperLabel>::Create( &_rParent, WB_NOTABSTOP | WB_WORDBREAK );
676 mpDescription->Show();
677}
678
679RoadmapItem::~RoadmapItem()
680{
681 mpID.disposeAndClear();
682 mpDescription.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
683}
684
685bool RoadmapItem::Contains(const vcl::Window* _pWindow) const
686{
687 return ( mpID == _pWindow ) || ( mpDescription == _pWindow );
688}
689
690void RoadmapItem::GrabFocus()
691{
692 if ( mpDescription )
693 mpDescription->GrabFocus();
694}
695
696void RoadmapItem::SetInteractive(bool _bInteractive)
697{
698 if ( mpDescription )
699 mpDescription->SetInteractive(_bInteractive);
700}
701
702void RoadmapItem::SetID(sal_Int16 ID)
703{
704 if ( mpDescription )
705 mpDescription->SetID(ID);
706}
707
708sal_Int16 RoadmapItem::GetID() const
709{
710 return mpDescription ? mpDescription->GetID() : sal_Int16(-1);
711}
712
713void RoadmapItem::ImplUpdateIndex(const ItemIndex _nIndex)
714{
715 mpDescription->SetIndex( _nIndex );
716
717 OUString aIDText = OUString::number( _nIndex + 1 ) + ".";
718 mpID->SetText( aIDText );
719
720 // update the geometry of both controls
721 ImplUpdatePosSize();
722}
723
724void RoadmapItem::SetIndex(ItemIndex Index)
725{
726 ImplUpdateIndex(Index);
727}
728
729RoadmapTypes::ItemIndex RoadmapItem::GetIndex() const
730{
731 return mpDescription ? mpDescription->GetIndex() : ItemIndex(-1);
732}
733
734void RoadmapItem::SetPosition(RoadmapItem const * _pOldItem)
735{
736 Point aIDPos;
737 if ( _pOldItem == nullptr )
738 {
739 aIDPos = mpID->LogicToPixel(Point(ROADMAP_INDENT_X, ROADMAP_INDENT_Y), MapMode(MapUnit::MapAppFont));
740 }
741 else
742 {
743 Size aOldSize = _pOldItem->mpDescription->GetSizePixel();
744
745 aIDPos = _pOldItem->mpID->GetPosPixel();
746 aIDPos.AdjustY(aOldSize.Height() );
747 aIDPos.AdjustY(mpID->GetParent()->LogicToPixel( Size( 0, ROADMAP_ITEM_DISTANCE_Y ) ).Height() );
748 }
749 mpID->SetPosPixel( aIDPos );
750
751 sal_Int32 nDescPos = aIDPos.X() + mpID->GetSizePixel().Width();
752 mpDescription->SetPosPixel( Point( nDescPos, aIDPos.Y() ) );
753}
754
755void RoadmapItem::Enable(bool _bEnable)
756{
757 mpID->Enable(_bEnable);
758 mpDescription->Enable(_bEnable);
759}
760
761bool RoadmapItem::IsEnabled() const
762{
763 return mpID->IsEnabled();
764}
765
766void RoadmapItem::ToggleBackgroundColor(const Color& _rGBColor)
767{
768 if (_rGBColor == COL_TRANSPARENT)
769 mpID->SetControlBackground();
770 else
771 mpID->SetControlBackground( mpID->GetSettings().GetStyleSettings().GetHighlightColor() );
772 mpDescription->ToggleBackgroundColor(_rGBColor);
773}
774
775void RoadmapItem::ImplUpdatePosSize()
776{
777 // calculate widths
778 long nIDWidth = mpID->GetTextWidth( mpID->GetText() );
779 long nMaxIDWidth = mpID->GetTextWidth( "100." );
780 nIDWidth = ::std::min( nIDWidth, nMaxIDWidth );
781
782 // check how many space the description would need
783 Size aDescriptionSize = mpDescription->CalcMinimumSize( m_aItemPlayground.Width() - nIDWidth );
784
785 // position and size both controls
786 Size aIDSize( nIDWidth, aDescriptionSize.Height() );
787 mpID->SetSizePixel( aIDSize );
788
789 Point aIDPos = mpID->GetPosPixel();
790 mpDescription->SetPosPixel( Point( aIDPos.X() + nIDWidth, aIDPos.Y() ) );
791 mpDescription->SetSizePixel( aDescriptionSize );
792}
793
794void RoadmapItem::Update(ItemIndex RMIndex, const OUString& _rText)
795{
796 // update description label
797 mpDescription->SetLabel( _rText );
798
799 // update the index in both controls, which triggers updating the geometry of both
800 ImplUpdateIndex( RMIndex );
801}
802
803void RoadmapItem::SetClickHdl(const Link<HyperLabel*,void>& rLink)
804{
805 if ( mpDescription )
806 mpDescription->SetClickHdl( rLink);
807}
808
809IDLabel::IDLabel(vcl::Window* _pParent, WinBits _nWinStyle)
810 : FixedText(_pParent, _nWinStyle)
811{
812}
813
814void IDLabel::ApplySettings(vcl::RenderContext& rRenderContext)
815{
816 FixedText::ApplySettings(rRenderContext);
817
818 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
819 if (GetControlBackground() == COL_TRANSPARENT)
820 rRenderContext.SetTextColor(rStyleSettings.GetFieldTextColor());
821 else
822 rRenderContext.SetTextColor(rStyleSettings.GetHighlightTextColor());
823}
824
825void IDLabel::DataChanged(const DataChangedEvent& rDCEvt)
826{
827 FixedText::DataChanged( rDCEvt );
828
829 if ((( rDCEvt.GetType() == DataChangedEventType::SETTINGS ) ||
830 ( rDCEvt.GetType() == DataChangedEventType::DISPLAY )) &&
831 ( rDCEvt.GetFlags() & AllSettingsFlags::STYLE ))
832 {
833 const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
834 if (GetControlBackground() != COL_TRANSPARENT)
835 SetControlBackground(rStyleSettings.GetHighlightColor());
836 Invalidate();
837 }
838}
839
840} // namespace vcl
841
842/* 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<vcl::HyperLabel>'
→
5
←
Returning from copy constructor for 'Reference<vcl::HyperLabel>'
→
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