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

/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/gdimtftools.cxx

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21#include <sal/log.hxx>
22#include "gdimtftools.hxx"
23
24#include <com/sun/star/graphic/XGraphic.hpp>
25#include <com/sun/star/graphic/XGraphicRenderer.hpp>
26#include <com/sun/star/drawing/GraphicExportFilter.hpp>
27
28#include <cppuhelper/basemutex.hxx>
29#include <cppuhelper/compbase.hxx>
30
31#include <comphelper/fileformat.h>
32
33#include <vcl/canvastools.hxx>
34#include <vcl/metaact.hxx>
35#include <vcl/virdev.hxx>
36#include <vcl/gdimtf.hxx>
37#include <vcl/animate/Animation.hxx>
38#include <vcl/graph.hxx>
39
40#include <tools.hxx>
41
42using namespace ::com::sun::star;
43
44
45// free support functions
46// ======================
47
48namespace slideshow::internal
49{
50// TODO(E2): Detect the case when svx/drawing layer is not
51// in-process, or even not on the same machine, and
52// fallback to metafile streaming!
53
54// For fixing #i48102#, have to be a _lot_ more selective
55// on which metafiles to convert to bitmaps. The problem
56// here is that we _always_ get the shape content as a
57// metafile, even if we have a bitmap graphic shape. Thus,
58// calling GetBitmapEx on such a Graphic (see below) will
59// result in one poorly scaled bitmap into another,
60// somewhat arbitrarily sized bitmap.
61static bool hasUnsupportedActions( const GDIMetaFile& rMtf )
62{
63 // search metafile for RasterOp action
64 MetaAction* pCurrAct;
65
66 // TODO(Q3): avoid const-cast
67 for( pCurrAct = const_cast<GDIMetaFile&>(rMtf).FirstAction();
68 pCurrAct;
69 pCurrAct = const_cast<GDIMetaFile&>(rMtf).NextAction() )
70 {
71 switch( pCurrAct->GetType() )
72 {
73 case MetaActionType::RASTEROP:
74 // overpaint is okay - that's the default, anyway
75 if( RasterOp::OverPaint ==
76 static_cast<MetaRasterOpAction*>(pCurrAct)->GetRasterOp() )
77 {
78 break;
79 }
80 [[fallthrough]];
81 case MetaActionType::MOVECLIPREGION:
82 case MetaActionType::REFPOINT:
83 case MetaActionType::WALLPAPER:
84 return true; // at least one unsupported
85 // action encountered
86 default: break;
87 }
88 }
89
90 return false; // no unsupported action found
91}
92
93namespace {
94
95typedef ::cppu::WeakComponentImplHelper< graphic::XGraphicRenderer > DummyRenderer_Base;
96
97class DummyRenderer: public cppu::BaseMutex, public DummyRenderer_Base
98{
99public:
100 DummyRenderer() :
101 DummyRenderer_Base( m_aMutex ),
102 mxGraphic()
103 {
104 }
105
106 //--- XGraphicRenderer -----------------------------------
107 virtual void SAL_CALL render( const uno::Reference< graphic::XGraphic >& rGraphic ) override
108 {
109 ::osl::MutexGuard aGuard( m_aMutex );
110 mxGraphic = rGraphic;
111 }
112
113 /** Retrieve GDIMetaFile from renderer
114
115 @param bForeignSource
116 When true, the source of the metafile might be a
117 foreign application. The metafile is checked
118 against unsupported content, and, if necessary,
119 returned as a pre-rendered bitmap.
120 */
121 GDIMetaFileSharedPtr getMtf( bool bForeignSource ) const
122 {
123 ::osl::MutexGuard aGuard( m_aMutex );
124
125 Graphic aGraphic( mxGraphic );
126
127 if( aGraphic.GetType() == GraphicType::Bitmap ||
128 (bForeignSource &&
129 hasUnsupportedActions(aGraphic.GetGDIMetaFile()) ) )
130 {
131 // wrap bitmap into GDIMetafile
132 GDIMetaFileSharedPtr xMtf = std::make_shared<GDIMetaFile>();
133
134 ::BitmapEx aBmpEx( aGraphic.GetBitmapEx() );
135
136 xMtf->AddAction( new MetaBmpExAction( Point(),
137 aBmpEx ) );
138 xMtf->SetPrefSize( aBmpEx.GetPrefSize() );
139 xMtf->SetPrefMapMode( aBmpEx.GetPrefMapMode() );
140
141 return xMtf;
142 }
143 return std::make_shared<GDIMetaFile>(aGraphic.GetGDIMetaFile());
144 }
145
146private:
147 uno::Reference< graphic::XGraphic > mxGraphic;
148};
149
150} // anon namespace
151
152// Quick'n'dirty way: tunnel Graphic (only works for
153// in-process slideshow, of course)
154GDIMetaFileSharedPtr getMetaFile( const uno::Reference< lang::XComponent >& xSource,
155 const uno::Reference< drawing::XDrawPage >& xContainingPage,
156 int mtfLoadFlags,
157 const uno::Reference< uno::XComponentContext >& rxContext )
158{
159 if (!rxContext.is())
160 {
161 SAL_WARN("slideshow.opengl", "getMetaFile(): Invalid context" )do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "slideshow.opengl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break
; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "getMetaFile(): Invalid context"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("slideshow.opengl"
), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/gdimtftools.cxx"
":" "161" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "getMetaFile(): Invalid context"), 0);
} else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "getMetaFile(): Invalid context"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("slideshow.opengl"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/gdimtftools.cxx"
":" "161" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "getMetaFile(): Invalid context") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("slideshow.opengl"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/gdimtftools.cxx"
":" "161" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "getMetaFile(): Invalid context"), 0);
} else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "getMetaFile(): Invalid context"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("slideshow.opengl"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/gdimtftools.cxx"
":" "161" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
162 return GDIMetaFileSharedPtr();
163 }
164
165 // create dummy XGraphicRenderer, which receives the
166 // generated XGraphic from the GraphicExporter
167
168 // TODO(P3): Move creation of DummyRenderer out of the
169 // loop! Either by making it static, or transforming
170 // the whole thing here into a class.
171 DummyRenderer* pRenderer( new DummyRenderer() );
172 uno::Reference< graphic::XGraphicRenderer > xRenderer( pRenderer );
173
174 // creating the graphic exporter
175 uno::Reference< drawing::XGraphicExportFilter > xExporter =
176 drawing::GraphicExportFilter::create(rxContext);
177
178 uno::Sequence< beans::PropertyValue > aProps(3);
179 aProps[0].Name = "FilterName";
180 aProps[0].Value <<= OUString("SVM");
181
182 aProps[1].Name = "GraphicRenderer";
183 aProps[1].Value <<= xRenderer;
184
185 uno::Sequence< beans::PropertyValue > aFilterData(4);
186 aFilterData[0].Name = "ScrollText";
187 aFilterData[0].Value <<= ((mtfLoadFlags & MTF_LOAD_SCROLL_TEXT_MTF) != 0);
188
189 aFilterData[1].Name = "ExportOnlyBackground";
190 aFilterData[1].Value <<= ((mtfLoadFlags & MTF_LOAD_BACKGROUND_ONLY) != 0);
191
192 aFilterData[2].Name = "Version";
193 aFilterData[2].Value <<= static_cast<sal_Int32>( SOFFICE_FILEFORMAT_505050 );
194
195 aFilterData[3].Name = "CurrentPage";
196 aFilterData[3].Value <<= uno::Reference< uno::XInterface >( xContainingPage,
197 uno::UNO_QUERY_THROW );
198
199 aProps[2].Name = "FilterData";
200 aProps[2].Value <<= aFilterData;
201
202 xExporter->setSourceDocument( xSource );
203 if( !xExporter->filter( aProps ) )
204 return GDIMetaFileSharedPtr();
205
206 GDIMetaFileSharedPtr xMtf = pRenderer->getMtf( (mtfLoadFlags & MTF_LOAD_FOREIGN_SOURCE) != 0 );
207
208 // pRenderer is automatically destroyed when xRenderer
209 // goes out of scope
210
211 // TODO(E3): Error handling. Exporter might have
212 // generated nothing, a bitmap, threw an exception,
213 // whatever.
214 return xMtf;
215}
216
217sal_Int32 getNextActionOffset( MetaAction * pCurrAct )
218{
219 // Special handling for actions that represent
220 // more than one indexable action
221 // ===========================================
222
223 switch (pCurrAct->GetType()) {
224 case MetaActionType::TEXT: {
225 MetaTextAction * pAct = static_cast<MetaTextAction *>(pCurrAct);
226 sal_Int32 nLen = std::min(pAct->GetLen(), pAct->GetText().getLength() - pAct->GetIndex());
227 return nLen;
228 }
229 case MetaActionType::TEXTARRAY: {
230 MetaTextArrayAction * pAct =
231 static_cast<MetaTextArrayAction *>(pCurrAct);
232 sal_Int32 nLen = std::min(pAct->GetLen(), pAct->GetText().getLength() - pAct->GetIndex());
233 return nLen;
234 }
235 case MetaActionType::STRETCHTEXT: {
236 MetaStretchTextAction * pAct =
237 static_cast<MetaStretchTextAction *>(pCurrAct);
238 sal_Int32 nLen = std::min(pAct->GetLen(), pAct->GetText().getLength() - pAct->GetIndex());
239 return nLen;
240 }
241 case MetaActionType::FLOATTRANSPARENT: {
242 MetaFloatTransparentAction * pAct =
243 static_cast<MetaFloatTransparentAction*>(pCurrAct);
244 // TODO(F2): Recurse into action metafile
245 // (though this is currently not used from the
246 // DrawingLayer - shape transparency gradients
247 // don't affect shape text)
248 return pAct->GetGDIMetaFile().GetActionSize();
249 }
250 default:
251 return 1;
252 }
253}
254
255bool getAnimationFromGraphic( VectorOfMtfAnimationFrames& o_rFrames,
256 sal_uInt32& o_rLoopCount,
257 const Graphic& rGraphic )
258{
259 o_rFrames.clear();
260
261 if( !rGraphic.IsAnimated() )
1
Assuming the condition is false
→
2
←
Taking false branch
→
262 return false;
263
264 // some loop invariants
265 ::Animation aAnimation( rGraphic.GetAnimation() );
266 const Point aEmptyPoint;
267 const Size aAnimSize( aAnimation.GetDisplaySizePixel() );
268
269 // setup VDev, into which all bitmaps are painted (want to
270 // normalize animations to n bitmaps of same size. An Animation,
271 // though, can contain bitmaps of varying sizes and different
272 // update modes)
273 ScopedVclPtrInstance< VirtualDevice > pVDev;
274 pVDev->SetOutputSizePixel( aAnimSize );
275 pVDev->EnableMapMode( false );
276
277 // setup mask VDev (alpha VDev is currently rather slow)
278 ScopedVclPtrInstance<VirtualDevice> pVDevMask(DeviceFormat::BITMASK);
3
←
Calling constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
5
←
Returning from constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
279 pVDevMask->SetOutputSizePixel( aAnimSize );
280 pVDevMask->EnableMapMode( false );
281
282 o_rLoopCount = aAnimation.GetLoopCount();
283
284 for( sal_uInt16 i=0, nCount=aAnimation.Count(); i<nCount; ++i )
6
←
Assuming 'i' is >= 'nCount'
→
7
←
Loop condition is false. Execution continues on line 382
→
285 {
286 const AnimationBitmap& rAnimationBitmap( aAnimation.Get(i) );
287 switch(rAnimationBitmap.meDisposal)
288 {
289 case Disposal::Not:
290 {
291 pVDev->DrawBitmapEx(rAnimationBitmap.maPositionPixel,
292 rAnimationBitmap.maBitmapEx);
293 Bitmap aMask = rAnimationBitmap.maBitmapEx.GetMask();
294
295 if( aMask.IsEmpty() )
296 {
297 const tools::Rectangle aRect(aEmptyPoint,
298 pVDevMask->GetOutputSizePixel());
299 const Wallpaper aWallpaper(COL_BLACK);
300 pVDevMask->DrawWallpaper(aRect,
301 aWallpaper);
302 }
303 else
304 {
305 BitmapEx aTmpMask(aMask, aMask);
306 pVDevMask->DrawBitmapEx(rAnimationBitmap.maPositionPixel,
307 aTmpMask );
308 }
309 break;
310 }
311
312 case Disposal::Back:
313 {
314 // #i70772# react on no mask
315 const Bitmap aMask(rAnimationBitmap.maBitmapEx.GetMask());
316 const Bitmap & rContent(rAnimationBitmap.maBitmapEx.GetBitmap());
317
318 pVDevMask->Erase();
319 pVDev->DrawBitmap(rAnimationBitmap.maPositionPixel, rContent);
320
321 if(aMask.IsEmpty())
322 {
323 const tools::Rectangle aRect(rAnimationBitmap.maPositionPixel, rContent.GetSizePixel());
324 pVDevMask->SetFillColor( COL_BLACK);
325 pVDevMask->SetLineColor();
326 pVDevMask->DrawRect(aRect);
327 }
328 else
329 {
330 pVDevMask->DrawBitmap(rAnimationBitmap.maPositionPixel, aMask);
331 }
332 break;
333 }
334
335 case Disposal::Previous :
336 {
337 pVDev->DrawBitmapEx(rAnimationBitmap.maPositionPixel,
338 rAnimationBitmap.maBitmapEx);
339 pVDevMask->DrawBitmap(rAnimationBitmap.maPositionPixel,
340 rAnimationBitmap.maBitmapEx.GetMask());
341 break;
342 }
343 }
344
345 // extract current aVDev content into a new animation
346 // frame
347 GDIMetaFileSharedPtr pMtf = std::make_shared<GDIMetaFile>();
348 pMtf->AddAction(
349 new MetaBmpExAction( aEmptyPoint,
350 BitmapEx(
351 pVDev->GetBitmap(
352 aEmptyPoint,
353 aAnimSize ),
354 pVDevMask->GetBitmap(
355 aEmptyPoint,
356 aAnimSize ))));
357
358 // setup mtf dimensions and pref map mode (for
359 // simplicity, keep it all in pixel. the metafile
360 // renderer scales it down to (1, 1) box anyway)
361 pMtf->SetPrefMapMode( MapMode() );
362 pMtf->SetPrefSize( aAnimSize );
363
364 // Take care of special value for MultiPage TIFFs. ATM these shall just
365 // show their first page for _quite_ some time.
366 sal_Int32 nWaitTime100thSeconds(rAnimationBitmap.mnWait);
367 if( ANIMATION_TIMEOUT_ON_CLICK2147483647L == nWaitTime100thSeconds )
368 {
369 // ATM the huge value would block the timer, so use a long
370 // time to show first page (whole day)
371 nWaitTime100thSeconds = 100 * 60 * 60 * 24;
372 }
373
374 // There are animated GIFs with no WaitTime set. Take 0.1 sec, the
375 // same duration that is used by the edit view.
376 if( nWaitTime100thSeconds == 0 )
377 nWaitTime100thSeconds = 10;
378
379 o_rFrames.emplace_back( pMtf, nWaitTime100thSeconds / 100.0 );
380 }
381
382 return !o_rFrames.empty();
8
←
Assuming the condition is false
→
9
←
Calling implicit destructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
10
←
Calling '~ScopedVclPtr'
→
383}
384
385bool getRectanglesFromScrollMtf( ::basegfx::B2DRectangle& o_rScrollRect,
386 ::basegfx::B2DRectangle& o_rPaintRect,
387 const GDIMetaFileSharedPtr& rMtf )
388{
389 // extract bounds: scroll rect, paint rect
390 bool bScrollRectSet(false);
391 bool bPaintRectSet(false);
392
393 for ( MetaAction * pCurrAct = rMtf->FirstAction();
394 pCurrAct != nullptr; pCurrAct = rMtf->NextAction() )
395 {
396 if (pCurrAct->GetType() == MetaActionType::COMMENT)
397 {
398 MetaCommentAction * pAct =
399 static_cast<MetaCommentAction *>(pCurrAct);
400 // skip comment if not a special XTEXT... comment
401 if( pAct->GetComment().matchIgnoreAsciiCase( "XTEXT" ) )
402 {
403 if (pAct->GetComment().equalsIgnoreAsciiCase("XTEXT_SCROLLRECT"))
404 {
405 o_rScrollRect = vcl::unotools::b2DRectangleFromRectangle(
406 *reinterpret_cast<tools::Rectangle const *>(
407 pAct->GetData() ));
408
409 bScrollRectSet = true;
410 }
411 else if (pAct->GetComment().equalsIgnoreAsciiCase("XTEXT_PAINTRECT") )
412 {
413 o_rPaintRect = vcl::unotools::b2DRectangleFromRectangle(
414 *reinterpret_cast<tools::Rectangle const *>(
415 pAct->GetData() ));
416
417 bPaintRectSet = true;
418 }
419 }
420 }
421 }
422
423 return bScrollRectSet && bPaintRectSet;
424}
425
426}
427
428/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
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 ;-)
12
←
Calling 'Reference::clear'
→
19
←
Returning; memory was released
→
205 if (aTmp.get()) {
20
←
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();
11
←
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 )
4
←
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
12.1
Field 'm_pBody' is non-null
12.1
Field 'm_pBody' is non-null
12.1
Field 'm_pBody' is non-null
12.1
Field 'm_pBody' is non-null
)
13
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
14
←
Calling 'VclReferenceBase::release'
→
18
←
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;
21
←
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)
15
←
Assuming the condition is true
→
16
←
Taking true branch
→
40 delete this;
17
←
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