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 tbzoomsliderctrl.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 SC_DLLIMPLEMENTATION -D SC_INFO_OSVERSION="LINUX" -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/liborcus/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/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/external/clew/source/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/sc/source/core/inc -I /home/maarten/src/libreoffice/core/sc/source/filter/inc -I /home/maarten/src/libreoffice/core/sc/source/ui/inc -I /home/maarten/src/libreoffice/core/sc/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sc/sdi -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/oovbaapi/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/sc/source/ui/cctrl/tbzoomsliderctrl.cxx

/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.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#include <tbzoomsliderctrl.hxx>
20#include <vcl/InterimItemWindow.hxx>
21#include <vcl/event.hxx>
22#include <vcl/image.hxx>
23#include <vcl/toolbox.hxx>
24#include <vcl/virdev.hxx>
25#include <vcl/gradient.hxx>
26#include <vcl/settings.hxx>
27#include <svx/zoomslideritem.hxx>
28#include <iterator>
29#include <set>
30#include <bitmaps.hlst>
31
32#include <com/sun/star/frame/XFrame.hpp>
33#include <com/sun/star/frame/XDispatchProvider.hpp>
34
35// class ScZoomSliderControl ---------------------------------------
36
37SFX_IMPL_TOOLBOX_CONTROL( ScZoomSliderControl, SvxZoomSliderItem )SfxToolBoxControl* ScZoomSliderControl::CreateImpl( sal_uInt16
nSlotId, sal_uInt16 nId, ToolBox &rTbx ) { return new ScZoomSliderControl
( nSlotId, nId, rTbx ); } void ScZoomSliderControl::RegisterControl
(sal_uInt16 nSlotId, SfxModule *pMod) { SfxToolBoxControl::RegisterToolBoxControl
( pMod, SfxTbxCtrlFactory( ScZoomSliderControl::CreateImpl, typeid
(SvxZoomSliderItem), nSlotId ) ); };
38
39ScZoomSliderControl::ScZoomSliderControl(
40 sal_uInt16 nSlotId,
41 sal_uInt16 nId,
42 ToolBox& rTbx )
43 :SfxToolBoxControl( nSlotId, nId, rTbx )
44{
45 rTbx.Invalidate();
46}
47
48ScZoomSliderControl::~ScZoomSliderControl()
49{
50
51}
52
53void ScZoomSliderControl::StateChanged( sal_uInt16 /*nSID*/, SfxItemState eState,
54 const SfxPoolItem* pState )
55{
56 sal_uInt16 nId = GetId();
57 ToolBox& rTbx = GetToolBox();
58 ScZoomSliderWnd* pBox = static_cast<ScZoomSliderWnd*>(rTbx.GetItemWindow( nId ));
59 OSL_ENSURE( pBox ,"Control not found!" )do { if (true && (!(pBox))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "59" ": "), "%s", "Control not found!"); } } while (false
);
60
61 if ( SfxItemState::DEFAULT != eState || pState->IsVoidItem() )
62 {
63 SvxZoomSliderItem aZoomSliderItem( 100 );
64 pBox->Disable();
65 pBox->UpdateFromItem( &aZoomSliderItem );
66 }
67 else
68 {
69 pBox->Enable();
70 OSL_ENSURE( dynamic_cast<const SvxZoomSliderItem*>( pState) != nullptr, "invalid item type" )do { if (true && (!(dynamic_cast<const SvxZoomSliderItem
*>( pState) != nullptr))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "70" ": "), "%s", "invalid item type"); } } while (false
);
71 const SvxZoomSliderItem* pZoomSliderItem = dynamic_cast< const SvxZoomSliderItem* >( pState );
72
73 OSL_ENSURE( pZoomSliderItem, "Sc::ScZoomSliderControl::StateChanged(), wrong item type!" )do { if (true && (!(pZoomSliderItem))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "73" ": "), "%s", "Sc::ScZoomSliderControl::StateChanged(), wrong item type!"
); } } while (false);
74 if( pZoomSliderItem )
75 pBox->UpdateFromItem( pZoomSliderItem );
76 }
77}
78
79VclPtr<InterimItemWindow> ScZoomSliderControl::CreateItemWindow( vcl::Window *pParent )
80{
81 // #i98000# Don't try to get a value via SfxViewFrame::Current here.
82 // The view's value is always notified via StateChanged later.
83 VclPtrInstance<ScZoomSliderWnd> xSlider( pParent,
84 css::uno::Reference< css::frame::XDispatchProvider >( m_xFrame->getController(),
85 css::uno::UNO_QUERY ), 100 );
86 return xSlider;
87}
88
89struct ScZoomSlider::ScZoomSliderWnd_Impl
90{
91 sal_uInt16 mnCurrentZoom;
92 sal_uInt16 mnMinZoom;
93 sal_uInt16 mnMaxZoom;
94 std::vector< long > maSnappingPointOffsets;
95 std::vector< sal_uInt16 > maSnappingPointZooms;
96 Image maSliderButton;
97 Image maIncreaseButton;
98 Image maDecreaseButton;
99 bool mbOmitPaint;
100 VclPtr<vcl::Window> mxParentWindow;
101
102 explicit ScZoomSliderWnd_Impl( sal_uInt16 nCurrentZoom, vcl::Window* parentWindow ) :
103 mnCurrentZoom( nCurrentZoom ),
104 mnMinZoom( 10 ),
105 mnMaxZoom( 400 ),
106 maSnappingPointOffsets(),
107 maSnappingPointZooms(),
108 maSliderButton(),
109 maIncreaseButton(),
110 maDecreaseButton(),
111 mbOmitPaint( false ),
112 mxParentWindow(parentWindow)
113 {
114 }
115};
116
117constexpr sal_uInt16 gnSliderCenter(100);
118
119const long nButtonWidth = 10;
120const long nButtonHeight = 10;
121const long nIncDecWidth = 11;
122const long nIncDecHeight = 11;
123const long nSliderHeight = 2;
124const long nSliderWidth = 4;
125const long nSnappingHeight = 4;
126const long nSliderXOffset = 20;
127const long nSnappingEpsilon = 5; // snapping epsilon in pixels
128const long nSnappingPointsMinDist = nSnappingEpsilon; // minimum distance of two adjacent snapping points
129
130sal_uInt16 ScZoomSlider::Offset2Zoom( long nOffset ) const
131{
132 Size aSliderWindowSize = GetOutputSizePixel();
133 const long nControlWidth = aSliderWindowSize.Width();
134 sal_uInt16 nRet = 0;
135
136 if( nOffset < nSliderXOffset )
137 return mpImpl->mnMinZoom;
138 if( nOffset > nControlWidth - nSliderXOffset )
139 return mpImpl->mnMaxZoom;
140
141 // check for snapping points:
142 auto aSnappingPointIter = std::find_if(mpImpl->maSnappingPointOffsets.begin(), mpImpl->maSnappingPointOffsets.end(),
143 [nOffset](const long nCurrent) { return std::abs(nCurrent - nOffset) < nSnappingEpsilon; });
144 if (aSnappingPointIter != mpImpl->maSnappingPointOffsets.end())
145 {
146 nOffset = *aSnappingPointIter;
147 auto nCount = static_cast<sal_uInt16>(std::distance(mpImpl->maSnappingPointOffsets.begin(), aSnappingPointIter));
148 nRet = mpImpl->maSnappingPointZooms[ nCount ];
149 }
150
151 if( 0 == nRet )
152 {
153 if( nOffset < nControlWidth / 2 )
154 {
155 // first half of slider
156 const long nFirstHalfRange = gnSliderCenter - mpImpl->mnMinZoom;
157 const long nHalfSliderWidth = nControlWidth/2 - nSliderXOffset;
158 const long nZoomPerSliderPixel = (1000 * nFirstHalfRange) / nHalfSliderWidth;
159 const long nOffsetToSliderLeft = nOffset - nSliderXOffset;
160 nRet = mpImpl->mnMinZoom + sal_uInt16( nOffsetToSliderLeft * nZoomPerSliderPixel / 1000 );
161 }
162 else
163 {
164 // second half of slider
165 const long nSecondHalfRange = mpImpl->mnMaxZoom - gnSliderCenter;
166 const long nHalfSliderWidth = nControlWidth/2 - nSliderXOffset;
167 const long nZoomPerSliderPixel = 1000 * nSecondHalfRange / nHalfSliderWidth;
168 const long nOffsetToSliderCenter = nOffset - nControlWidth/2;
169 nRet = gnSliderCenter + sal_uInt16( nOffsetToSliderCenter * nZoomPerSliderPixel / 1000 );
170 }
171 }
172
173 if( nRet < mpImpl->mnMinZoom )
174 return mpImpl->mnMinZoom;
175
176 else if( nRet > mpImpl->mnMaxZoom )
177 return mpImpl->mnMaxZoom;
178
179 return nRet;
180}
181
182long ScZoomSlider::Zoom2Offset( sal_uInt16 nCurrentZoom ) const
183{
184 Size aSliderWindowSize = GetOutputSizePixel();
185 const long nControlWidth = aSliderWindowSize.Width();
186 long nRect = nSliderXOffset;
187
188 const long nHalfSliderWidth = nControlWidth/2 - nSliderXOffset;
189 if( nCurrentZoom <= gnSliderCenter )
190 {
191 nCurrentZoom = nCurrentZoom - mpImpl->mnMinZoom;
192 const long nFirstHalfRange = gnSliderCenter - mpImpl->mnMinZoom;
193 const long nSliderPixelPerZoomPercent = 1000 * nHalfSliderWidth / nFirstHalfRange;
194 const long nOffset = (nSliderPixelPerZoomPercent * nCurrentZoom) / 1000;
195 nRect += nOffset;
196 }
197 else
198 {
199 nCurrentZoom = nCurrentZoom - gnSliderCenter;
200 const long nSecondHalfRange = mpImpl->mnMaxZoom - gnSliderCenter;
201 const long nSliderPixelPerZoomPercent = 1000 * nHalfSliderWidth / nSecondHalfRange;
202 const long nOffset = (nSliderPixelPerZoomPercent * nCurrentZoom) / 1000;
203 nRect += nHalfSliderWidth + nOffset;
204 }
205 return nRect;
206}
207
208ScZoomSliderWnd::ScZoomSliderWnd( vcl::Window* pParent,
209 const css::uno::Reference< css::frame::XDispatchProvider >& rDispatchProvider,
210 sal_uInt16 nCurrentZoom ):
211 InterimItemWindow(pParent, "modules/scalc/ui/zoombox.ui", "ZoomBox"),
212 mxWidget(new ScZoomSlider(rDispatchProvider, nCurrentZoom, pParent)),
213 mxWeld(new weld::CustomWeld(*m_xBuilder, "zoom", *mxWidget))
214{
215 Size aLogicalSize( 115, 40 );
216 Size aSliderSize = LogicToPixel(aLogicalSize, MapMode(MapUnit::Map10thMM));
217 Size aPreferredSize(aSliderSize.Width() * nSliderWidth-1, aSliderSize.Height() + nSliderHeight);
218 mxWidget->GetDrawingArea()->set_size_request(aPreferredSize.Width(), aPreferredSize.Height());
219 mxWidget->SetOutputSizePixel(aPreferredSize);
220 SetSizePixel(aPreferredSize);
221}
222
223ScZoomSliderWnd::~ScZoomSliderWnd()
224{
225 disposeOnce();
226}
227
228void ScZoomSliderWnd::dispose()
229{
230 mxWeld.reset();
231 mxWidget.reset();
232 InterimItemWindow::dispose();
233}
234
235ScZoomSlider::ScZoomSlider(const css::uno::Reference< css::frame::XDispatchProvider>& rDispatchProvider,
236 sal_uInt16 nCurrentZoom, vcl::Window* parentWindow)
237 : mpImpl(new ScZoomSliderWnd_Impl(nCurrentZoom, parentWindow))
238 , m_xDispatchProvider(rDispatchProvider)
239{
240 mpImpl->maSliderButton = Image(StockImage::Yes, RID_SVXBMP_SLIDERBUTTON"svx/res/slidezoombutton_10.png");
241 mpImpl->maIncreaseButton = Image(StockImage::Yes, RID_SVXBMP_SLIDERINCREASE"svx/res/slidezoomin_10.png");
242 mpImpl->maDecreaseButton = Image(StockImage::Yes, RID_SVXBMP_SLIDERDECREASE"svx/res/slidezoomout_10.png");
243}
244
245bool ScZoomSlider::MouseButtonDown( const MouseEvent& rMEvt )
246{
247 Size aSliderWindowSize = GetOutputSizePixel();
248
249 const Point aPoint = rMEvt.GetPosPixel();
250
251 const long nButtonLeftOffset = ( nSliderXOffset - nIncDecWidth )/2;
252 const long nButtonRightOffset = ( nSliderXOffset + nIncDecWidth )/2;
253
254 const long nOldZoom = mpImpl->mnCurrentZoom;
255
256 // click to - button
257 if ( aPoint.X() >= nButtonLeftOffset && aPoint.X() <= nButtonRightOffset )
258 {
259 mpImpl->mnCurrentZoom = mpImpl->mnCurrentZoom - 5;
260 }
261 // click to + button
262 else if ( aPoint.X() >= aSliderWindowSize.Width() - nSliderXOffset + nButtonLeftOffset &&
263 aPoint.X() <= aSliderWindowSize.Width() - nSliderXOffset + nButtonRightOffset )
264 {
265 mpImpl->mnCurrentZoom = mpImpl->mnCurrentZoom + 5;
266 }
267 else if( aPoint.X() >= nSliderXOffset && aPoint.X() <= aSliderWindowSize.Width() - nSliderXOffset )
268 {
269 mpImpl->mnCurrentZoom = Offset2Zoom( aPoint.X() );
270 }
271
272 if( mpImpl->mnCurrentZoom < mpImpl->mnMinZoom )
273 mpImpl->mnCurrentZoom = mpImpl->mnMinZoom;
274 else if( mpImpl->mnCurrentZoom > mpImpl->mnMaxZoom )
275 mpImpl->mnCurrentZoom = mpImpl->mnMaxZoom;
276
277 if( nOldZoom == mpImpl->mnCurrentZoom )
278 return true;
279
280 // need to invalidate parent since we rely on the toolbox drawing it's fancy gradient background
281 mpImpl->mxParentWindow->Invalidate();
282 mpImpl->mbOmitPaint = true;
283
284 SvxZoomSliderItem aZoomSliderItem( mpImpl->mnCurrentZoom );
285
286 css::uno::Any a;
287 aZoomSliderItem.QueryValue( a );
288
289 css::uno::Sequence< css::beans::PropertyValue > aArgs( 1 );
290 aArgs[0].Name = "ScalingFactor";
291 aArgs[0].Value = a;
292
293 SfxToolBoxControl::Dispatch( m_xDispatchProvider, ".uno:ScalingFactor", aArgs );
294
295 mpImpl->mbOmitPaint = false;
296
297 return true;
298}
299
300bool ScZoomSlider::MouseMove( const MouseEvent& rMEvt )
301{
302 Size aSliderWindowSize = GetOutputSizePixel();
303 const long nControlWidth = aSliderWindowSize.Width();
304 const short nButtons = rMEvt.GetButtons();
305
306 // check mouse move with button pressed
307 if ( 1 == nButtons )
308 {
309 const Point aPoint = rMEvt.GetPosPixel();
310
311 if ( aPoint.X() >= nSliderXOffset && aPoint.X() <= nControlWidth - nSliderXOffset )
312 {
313 mpImpl->mnCurrentZoom = Offset2Zoom( aPoint.X() );
314
315 // need to invalidate parent since we rely on the toolbox drawing it's fancy gradient background
316 mpImpl->mxParentWindow->Invalidate();
317
318 mpImpl->mbOmitPaint = true; // optimization: paint before executing command,
319
320 // commit state change
321 SvxZoomSliderItem aZoomSliderItem( mpImpl->mnCurrentZoom );
322
323 css::uno::Any a;
324 aZoomSliderItem.QueryValue( a );
325
326 css::uno::Sequence< css::beans::PropertyValue > aArgs( 1 );
327 aArgs[0].Name = "ScalingFactor";
328 aArgs[0].Value = a;
329
330 SfxToolBoxControl::Dispatch( m_xDispatchProvider, ".uno:ScalingFactor", aArgs );
331
332 mpImpl->mbOmitPaint = false;
333 }
334 }
335
336 return false;
337}
338
339void ScZoomSliderWnd::UpdateFromItem( const SvxZoomSliderItem* pZoomSliderItem )
340{
341 mxWidget->UpdateFromItem(pZoomSliderItem);
342}
343
344void ScZoomSlider::UpdateFromItem(const SvxZoomSliderItem* pZoomSliderItem)
345{
346 if( pZoomSliderItem )
347 {
348 mpImpl->mnCurrentZoom = pZoomSliderItem->GetValue();
349 mpImpl->mnMinZoom = pZoomSliderItem->GetMinZoom();
350 mpImpl->mnMaxZoom = pZoomSliderItem->GetMaxZoom();
351
352 OSL_ENSURE( mpImpl->mnMinZoom <= mpImpl->mnCurrentZoom &&do { if (true && (!(mpImpl->mnMinZoom <= mpImpl
->mnCurrentZoom && mpImpl->mnMinZoom < gnSliderCenter
&& mpImpl->mnMaxZoom >= mpImpl->mnCurrentZoom
&& mpImpl->mnMaxZoom > gnSliderCenter))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "356" ": "), "%s", "Looks like the zoom slider item is corrupted"
); } } while (false)
353 mpImpl->mnMinZoom < gnSliderCenter &&do { if (true && (!(mpImpl->mnMinZoom <= mpImpl
->mnCurrentZoom && mpImpl->mnMinZoom < gnSliderCenter
&& mpImpl->mnMaxZoom >= mpImpl->mnCurrentZoom
&& mpImpl->mnMaxZoom > gnSliderCenter))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "356" ": "), "%s", "Looks like the zoom slider item is corrupted"
); } } while (false)
354 mpImpl->mnMaxZoom >= mpImpl->mnCurrentZoom &&do { if (true && (!(mpImpl->mnMinZoom <= mpImpl
->mnCurrentZoom && mpImpl->mnMinZoom < gnSliderCenter
&& mpImpl->mnMaxZoom >= mpImpl->mnCurrentZoom
&& mpImpl->mnMaxZoom > gnSliderCenter))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "356" ": "), "%s", "Looks like the zoom slider item is corrupted"
); } } while (false)
355 mpImpl->mnMaxZoom > gnSliderCenter,do { if (true && (!(mpImpl->mnMinZoom <= mpImpl
->mnCurrentZoom && mpImpl->mnMinZoom < gnSliderCenter
&& mpImpl->mnMaxZoom >= mpImpl->mnCurrentZoom
&& mpImpl->mnMaxZoom > gnSliderCenter))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "356" ": "), "%s", "Looks like the zoom slider item is corrupted"
); } } while (false)
356 "Looks like the zoom slider item is corrupted" )do { if (true && (!(mpImpl->mnMinZoom <= mpImpl
->mnCurrentZoom && mpImpl->mnMinZoom < gnSliderCenter
&& mpImpl->mnMaxZoom >= mpImpl->mnCurrentZoom
&& mpImpl->mnMaxZoom > gnSliderCenter))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/cctrl/tbzoomsliderctrl.cxx"
":" "356" ": "), "%s", "Looks like the zoom slider item is corrupted"
); } } while (false);
357 const css::uno::Sequence < sal_Int32 >& rSnappingPoints = pZoomSliderItem->GetSnappingPoints();
358 mpImpl->maSnappingPointOffsets.clear();
359 mpImpl->maSnappingPointZooms.clear();
360
361 // get all snapping points:
362 std::set< sal_uInt16 > aTmpSnappingPoints;
363 std::transform(rSnappingPoints.begin(), rSnappingPoints.end(), std::inserter(aTmpSnappingPoints, aTmpSnappingPoints.end()),
364 [](const sal_Int32 nSnappingPoint) -> sal_uInt16 { return static_cast<sal_uInt16>(nSnappingPoint); });
365
366 // remove snapping points that are too close to each other:
367 long nLastOffset = 0;
368
369 for ( const sal_uInt16 nCurrent : aTmpSnappingPoints )
370 {
371 const long nCurrentOffset = Zoom2Offset( nCurrent );
372
373 if ( nCurrentOffset - nLastOffset >= nSnappingPointsMinDist )
374 {
375 mpImpl->maSnappingPointOffsets.push_back( nCurrentOffset );
376 mpImpl->maSnappingPointZooms.push_back( nCurrent );
377 nLastOffset = nCurrentOffset;
378 }
379 }
380 }
381
382 if ( !mpImpl->mbOmitPaint )
383 // need to invalidate parent since we rely on the toolbox drawing it's fancy gradient background
384 mpImpl->mxParentWindow->Invalidate();
385}
386
387void ScZoomSlider::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& /*rRect*/)
388{
389 DoPaint(rRenderContext);
1
Calling 'ScZoomSlider::DoPaint'
→
390}
391
392void ScZoomSlider::DoPaint(vcl::RenderContext& rRenderContext)
393{
394 if (mpImpl->mbOmitPaint)
2
←
Assuming field 'mbOmitPaint' is false
→
3
←
Taking false branch
→
395 return;
396
397 Size aSliderWindowSize(GetOutputSizePixel());
398 tools::Rectangle aRect(Point(0, 0), aSliderWindowSize);
399
400 ScopedVclPtrInstance< VirtualDevice > pVDev(rRenderContext, DeviceFormat::DEFAULT, DeviceFormat::BITMASK);
4
←
Calling constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
6
←
Returning from constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
401 pVDev->SetOutputSizePixel(aSliderWindowSize);
402 pVDev->SetFillColor( COL_TRANSPARENT );
403 pVDev->SetLineColor( COL_TRANSPARENT );
404 pVDev->DrawRect( aRect );
405
406 tools::Rectangle aSlider = aRect;
407
408 aSlider.AdjustTop((aSliderWindowSize.Height() - nSliderHeight) / 2 - 1 );
409 aSlider.SetBottom( aSlider.Top() + nSliderHeight );
410 aSlider.AdjustLeft(nSliderXOffset );
411 aSlider.AdjustRight( -nSliderXOffset );
412
413 tools::Rectangle aFirstLine(aSlider);
414 aFirstLine.SetBottom( aFirstLine.Top() );
415
416 tools::Rectangle aSecondLine(aSlider);
417 aSecondLine.SetTop( aSecondLine.Bottom() );
418
419 tools::Rectangle aLeft(aSlider);
420 aLeft.SetRight( aLeft.Left() );
421
422 tools::Rectangle aRight(aSlider);
423 aRight.SetLeft( aRight.Right() );
424
425 // draw slider
426 pVDev->SetLineColor(COL_WHITE);
427 pVDev->DrawRect(aSecondLine);
428 pVDev->DrawRect(aRight);
429
430 pVDev->SetLineColor(COL_GRAY);
431 pVDev->DrawRect(aFirstLine);
432 pVDev->DrawRect(aLeft);
433
434 // draw snapping points:
435 for (const auto& rSnappingPointOffset : mpImpl->maSnappingPointOffsets)
436 {
437 pVDev->SetLineColor(COL_GRAY);
438 tools::Rectangle aSnapping(aRect);
439 aSnapping.SetBottom( aSlider.Top() );
440 aSnapping.SetTop( aSnapping.Bottom() - nSnappingHeight );
441 aSnapping.AdjustLeft(rSnappingPointOffset );
442 aSnapping.SetRight( aSnapping.Left() );
443 pVDev->DrawRect(aSnapping);
444
445 aSnapping.AdjustTop(nSnappingHeight + nSliderHeight );
446 aSnapping.AdjustBottom(nSnappingHeight + nSliderHeight );
447 pVDev->DrawRect(aSnapping);
448 }
449
450 // draw slider button
451 Point aImagePoint = aRect.TopLeft();
452 aImagePoint.AdjustX(Zoom2Offset(mpImpl->mnCurrentZoom) );
453 aImagePoint.AdjustX( -(nButtonWidth / 2) );
454 aImagePoint.AdjustY( (aSliderWindowSize.Height() - nButtonHeight) / 2 );
455 pVDev->DrawImage(aImagePoint, mpImpl->maSliderButton);
456
457 // draw decrease button
458 aImagePoint = aRect.TopLeft();
459 aImagePoint.AdjustX((nSliderXOffset - nIncDecWidth) / 2 );
460 aImagePoint.AdjustY((aSliderWindowSize.Height() - nIncDecHeight) / 2 );
461 pVDev->DrawImage(aImagePoint, mpImpl->maDecreaseButton);
462
463 // draw increase button
464 aImagePoint.setX( aRect.TopLeft().X() + aSliderWindowSize.Width() - nIncDecWidth - (nSliderXOffset - nIncDecWidth) / 2 );
465 pVDev->DrawImage(aImagePoint, mpImpl->maIncreaseButton);
466
467 rRenderContext.DrawOutDev(Point(0, 0), aSliderWindowSize, Point(0, 0), aSliderWindowSize, *pVDev);
468}
7
←
Calling implicit destructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
8
←
Calling '~ScopedVclPtr'
→
469
470/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
10
←
Calling 'Reference::clear'
→
17
←
Returning; memory was released
→
205 if (aTmp.get()) {
18
←
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();
9
←
Calling 'VclPtr::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 )
5
←
Memory is allocated
→
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
)
11
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
12
←
Calling 'VclReferenceBase::release'
→
16
←
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;
19
←
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)
13
←
Assuming the condition is true
→
14
←
Taking true branch
→
40 delete this;
15
←
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