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 graphicprimitivehelper2d.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 DRAWINGLAYER_DLLIMPLEMENTATION -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/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/drawinglayer/inc -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/drawinglayer/source/primitive2d/graphicprimitivehelper2d.cxx

/home/maarten/src/libreoffice/core/drawinglayer/source/primitive2d/graphicprimitivehelper2d.cxx

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#include <sal/config.h>
21
22#include <algorithm>
23
24#include <primitive2d/graphicprimitivehelper2d.hxx>
25#include <drawinglayer/animation/animationtiming.hxx>
26#include <drawinglayer/primitive2d/bitmapprimitive2d.hxx>
27#include <drawinglayer/primitive2d/animatedprimitive2d.hxx>
28#include <drawinglayer/primitive2d/metafileprimitive2d.hxx>
29#include <drawinglayer/primitive2d/transformprimitive2d.hxx>
30#include <drawinglayer/primitive2d/maskprimitive2d.hxx>
31#include <drawinglayer/primitive2d/modifiedcolorprimitive2d.hxx>
32#include <drawinglayer/geometry/viewinformation2d.hxx>
33#include <basegfx/polygon/b2dpolygon.hxx>
34#include <basegfx/polygon/b2dpolygontools.hxx>
35#include <basegfx/numeric/ftools.hxx>
36
37// helper class for animated graphics
38
39#include <vcl/animate/Animation.hxx>
40#include <vcl/graph.hxx>
41#include <vcl/virdev.hxx>
42#include <vcl/svapp.hxx>
43#include <toolkit/helper/vclunohelper.hxx>
44#include <vcl/skia/SkiaHelper.hxx>
45
46namespace drawinglayer::primitive2d
47{
48 namespace {
49
50 class AnimatedGraphicPrimitive2D : public AnimatedSwitchPrimitive2D
1
Calling implicit destructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
2
←
Calling '~ScopedVclPtr'
→
51 {
52 private:
53 /// the geometric definition
54 basegfx::B2DHomMatrix maTransform;
55
56 /** the Graphic with all its content possibilities, here only
57 animated is allowed and gets checked by isValidData().
58 an instance of Graphic is used here since it's ref-counted
59 and thus a safe copy for now
60 */
61 const Graphic maGraphic;
62
63 /// local animation processing data, excerpt from maGraphic
64 ::Animation maAnimation;
65
66 /// the on-demand created VirtualDevices for frame creation
67 ScopedVclPtrInstance< VirtualDevice > maVirtualDevice;
68 ScopedVclPtrInstance< VirtualDevice > maVirtualDeviceMask;
69
70 // index of the next frame that would be regularly prepared
71 sal_uInt32 mnNextFrameToPrepare;
72
73 /// buffering of 1st frame (always active)
74 Primitive2DReference maBufferedFirstFrame;
75
76 /// buffering of all frames
77 Primitive2DContainer maBufferedPrimitives;
78 bool mbBufferingAllowed;
79
80 /// set if the animation is huge so that just always the next frame
81 /// is used instead of using timing
82 bool mbHugeSize;
83
84 /// helper methods
85 bool isValidData() const
86 {
87 return (GraphicType::Bitmap == maGraphic.GetType()
88 && maGraphic.IsAnimated()
89 && maAnimation.Count());
90 }
91
92 void ensureVirtualDeviceSizeAndState()
93 {
94 if (!isValidData())
95 return;
96
97 const Size aCurrent(maVirtualDevice->GetOutputSizePixel());
98 const Size aTarget(maAnimation.GetDisplaySizePixel());
99
100 if (aCurrent != aTarget)
101 {
102 maVirtualDevice->EnableMapMode(false);
103 maVirtualDeviceMask->EnableMapMode(false);
104 maVirtualDevice->SetOutputSizePixel(aTarget);
105 maVirtualDeviceMask->SetOutputSizePixel(aTarget);
106 }
107
108 maVirtualDevice->Erase();
109 maVirtualDeviceMask->Erase();
110 const ::tools::Rectangle aRect(Point(0, 0), aTarget);
111 maVirtualDeviceMask->SetFillColor(COL_BLACK);
112 maVirtualDeviceMask->SetLineColor();
113 maVirtualDeviceMask->DrawRect(aRect);
114 }
115
116 sal_uInt32 generateStepTime(sal_uInt32 nIndex) const
117 {
118 const AnimationBitmap& rAnimationBitmap = maAnimation.Get(sal_uInt16(nIndex));
119 sal_uInt32 nWaitTime(rAnimationBitmap.mnWait * 10);
120
121 // Take care of special value for MultiPage TIFFs. ATM these shall just
122 // show their first page. Later we will offer some switching when object
123 // is selected.
124 if (ANIMATION_TIMEOUT_ON_CLICK2147483647L == rAnimationBitmap.mnWait)
125 {
126 // ATM the huge value would block the timer, so
127 // use a long time to show first page (whole day)
128 nWaitTime = 100 * 60 * 60 * 24;
129 }
130
131 // Bad trap: There are animated gifs with no set WaitTime (!).
132 // In that case use a default value.
133 if (0 == nWaitTime)
134 {
135 nWaitTime = 100;
136 }
137
138 return nWaitTime;
139 }
140
141 void createAndSetAnimationTiming()
142 {
143 if (!isValidData())
144 return;
145
146 animation::AnimationEntryLoop aAnimationLoop(maAnimation.GetLoopCount() ? maAnimation.GetLoopCount() : 0xffff);
147 const sal_uInt32 nCount(maAnimation.Count());
148
149 for (sal_uInt32 a(0); a < nCount; a++)
150 {
151 const sal_uInt32 aStepTime(generateStepTime(a));
152 const animation::AnimationEntryFixed aTime(static_cast<double>(aStepTime), static_cast<double>(a) / static_cast<double>(nCount));
153
154 aAnimationLoop.append(aTime);
155 }
156
157 animation::AnimationEntryList aAnimationEntryList;
158 aAnimationEntryList.append(aAnimationLoop);
159
160 setAnimationEntry(aAnimationEntryList);
161 }
162
163 Primitive2DReference createFromBuffer() const
164 {
165 // create BitmapEx by extracting from VirtualDevices
166 const Bitmap aMainBitmap(maVirtualDevice->GetBitmap(Point(), maVirtualDevice->GetOutputSizePixel()));
167 bool useAlphaMask = false;
168#if defined(MACOSX) || defined(IOS)
169 useAlphaMask = true;
170#else
171 // GetBitmap()-> AlphaMask is optimized with SkiaSalBitmap::InterpretAs8Bit(), 1bpp mask is not.
172 if( SkiaHelper::isVCLSkiaEnabled())
173 useAlphaMask = true;
174#endif
175 BitmapEx bitmap;
176 if( useAlphaMask )
177 {
178 const AlphaMask aMaskBitmap(maVirtualDeviceMask->GetBitmap(Point(), maVirtualDeviceMask->GetOutputSizePixel()));
179 bitmap = BitmapEx(aMainBitmap, aMaskBitmap);
180 }
181 else
182 {
183 const Bitmap aMaskBitmap(maVirtualDeviceMask->GetBitmap(Point(), maVirtualDeviceMask->GetOutputSizePixel()));
184 bitmap = BitmapEx(aMainBitmap, aMaskBitmap);
185 }
186
187 return Primitive2DReference(
188 new BitmapPrimitive2D(
189 VCLUnoHelper::CreateVCLXBitmap(bitmap),
190 getTransform()));
191 }
192
193 void checkSafeToBuffer(sal_uInt32 nIndex)
194 {
195 if (mbBufferingAllowed)
196 {
197 // all frames buffered
198 if (!maBufferedPrimitives.empty() && nIndex < maBufferedPrimitives.size())
199 {
200 if (!maBufferedPrimitives[nIndex].is())
201 {
202 maBufferedPrimitives[nIndex] = createFromBuffer();
203
204 // check if buffering is complete
205 bool bBufferingComplete(true);
206
207 for (auto const & a: maBufferedPrimitives)
208 {
209 if (!a.is())
210 {
211 bBufferingComplete = false;
212 break;
213 }
214 }
215
216 if (bBufferingComplete)
217 {
218 maVirtualDevice.disposeAndClear();
219 maVirtualDeviceMask.disposeAndClear();
220 }
221 }
222 }
223 }
224 else
225 {
226 // always buffer first frame
227 if (0 == nIndex && !maBufferedFirstFrame.is())
228 {
229 maBufferedFirstFrame = createFromBuffer();
230 }
231 }
232 }
233
234 void createFrame(sal_uInt32 nTarget)
235 {
236 // mnNextFrameToPrepare is the target frame to create next (which implies that
237 // mnNextFrameToPrepare-1 *is* currently in the VirtualDevice when
238 // 0 != mnNextFrameToPrepare. nTarget is the target frame.
239 if (!isValidData())
240 return;
241
242 if (mnNextFrameToPrepare > nTarget)
243 {
244 // we are ahead request, reset mechanism to start at frame zero
245 ensureVirtualDeviceSizeAndState();
246 mnNextFrameToPrepare = 0;
247 }
248
249 while (mnNextFrameToPrepare <= nTarget)
250 {
251 // prepare step
252 const AnimationBitmap& rAnimationBitmap = maAnimation.Get(sal_uInt16(mnNextFrameToPrepare));
253
254 switch (rAnimationBitmap.meDisposal)
255 {
256 case Disposal::Not:
257 {
258 maVirtualDevice->DrawBitmapEx(rAnimationBitmap.maPositionPixel, rAnimationBitmap.maBitmapEx);
259 Bitmap aMask = rAnimationBitmap.maBitmapEx.GetMask();
260
261 if (aMask.IsEmpty())
262 {
263 const Point aEmpty;
264 const ::tools::Rectangle aRect(aEmpty, maVirtualDeviceMask->GetOutputSizePixel());
265 const Wallpaper aWallpaper(COL_BLACK);
266 maVirtualDeviceMask->DrawWallpaper(aRect, aWallpaper);
267 }
268 else
269 {
270 BitmapEx aExpandVisibilityMask(aMask, aMask);
271 maVirtualDeviceMask->DrawBitmapEx(rAnimationBitmap.maPositionPixel, aExpandVisibilityMask);
272 }
273
274 break;
275 }
276 case Disposal::Back:
277 {
278 // #i70772# react on no mask, for primitives, too.
279 const Bitmap & rMask(rAnimationBitmap.maBitmapEx.GetMask());
280 const Bitmap & rContent(rAnimationBitmap.maBitmapEx.GetBitmap());
281
282 maVirtualDeviceMask->Erase();
283 maVirtualDevice->DrawBitmap(rAnimationBitmap.maPositionPixel, rContent);
284
285 if (rMask.IsEmpty())
286 {
287 const ::tools::Rectangle aRect(rAnimationBitmap.maPositionPixel, rContent.GetSizePixel());
288 maVirtualDeviceMask->SetFillColor(COL_BLACK);
289 maVirtualDeviceMask->SetLineColor();
290 maVirtualDeviceMask->DrawRect(aRect);
291 }
292 else
293 {
294 BitmapEx aExpandVisibilityMask(rMask, rMask);
295 maVirtualDeviceMask->DrawBitmapEx(rAnimationBitmap.maPositionPixel, aExpandVisibilityMask);
296 }
297
298 break;
299 }
300 case Disposal::Previous:
301 {
302 maVirtualDevice->DrawBitmapEx(rAnimationBitmap.maPositionPixel, rAnimationBitmap.maBitmapEx);
303 BitmapEx aExpandVisibilityMask(rAnimationBitmap.maBitmapEx.GetMask(), rAnimationBitmap.maBitmapEx.GetMask());
304 maVirtualDeviceMask->DrawBitmapEx(rAnimationBitmap.maPositionPixel, aExpandVisibilityMask);
305 break;
306 }
307 }
308
309 // to not waste created data, check adding to buffers
310 checkSafeToBuffer(mnNextFrameToPrepare);
311
312 mnNextFrameToPrepare++;
313 }
314 }
315
316 Primitive2DReference tryTogetFromBuffer(sal_uInt32 nIndex) const
317 {
318 if (mbBufferingAllowed)
319 {
320 // all frames buffered, check if available
321 if (!maBufferedPrimitives.empty() && nIndex < maBufferedPrimitives.size())
322 {
323 if (maBufferedPrimitives[nIndex].is())
324 {
325 return maBufferedPrimitives[nIndex];
326 }
327 }
328 }
329 else
330 {
331 // always buffer first frame, it's sometimes requested out-of-order
332 if (0 == nIndex && maBufferedFirstFrame.is())
333 {
334 return maBufferedFirstFrame;
335 }
336 }
337
338 return Primitive2DReference();
339 }
340
341 public:
342 /// constructor
343 AnimatedGraphicPrimitive2D(
344 const Graphic& rGraphic,
345 const basegfx::B2DHomMatrix& rTransform);
346
347 /// data read access
348 const basegfx::B2DHomMatrix& getTransform() const { return maTransform; }
349
350 /// compare operator
351 virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;
352
353 /// override to deliver the correct expected frame dependent of timing
354 virtual void get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const override;
355 };
356
357 }
358
359 AnimatedGraphicPrimitive2D::AnimatedGraphicPrimitive2D(
360 const Graphic& rGraphic,
361 const basegfx::B2DHomMatrix& rTransform)
362 : AnimatedSwitchPrimitive2D(
363 animation::AnimationEntryList(),
364 Primitive2DContainer(),
365 false),
366 maTransform(rTransform),
367 maGraphic(rGraphic),
368 maAnimation(rGraphic.GetAnimation()),
369 maVirtualDevice(*Application::GetDefaultDevice()),
370 maVirtualDeviceMask(*Application::GetDefaultDevice(), DeviceFormat::BITMASK),
371 mnNextFrameToPrepare(SAL_MAX_UINT32((sal_uInt32) 0xFFFFFFFF)),
372 maBufferedFirstFrame(),
373 maBufferedPrimitives(),
374 mbBufferingAllowed(false),
375 mbHugeSize(false)
376 {
377 // initialize AnimationTiming, needed to detect which frame is requested
378 // in get2DDecomposition
379 createAndSetAnimationTiming();
380
381 // check if we allow buffering
382 if (isValidData())
383 {
384 // allow buffering up to a size of:
385 // - 64 frames
386 // - sizes of 256x256 pixels
387 // This may be offered in option values if needed
388 static const sal_uInt64 nAllowedSize(64 * 256 * 256);
389 static const sal_uInt64 nHugeSize(10000000);
390 const Size aTarget(maAnimation.GetDisplaySizePixel());
391 const sal_uInt64 nUsedSize(static_cast<sal_uInt64>(maAnimation.Count()) * aTarget.Width() * aTarget.Height());
392
393 if (nUsedSize < nAllowedSize)
394 {
395 mbBufferingAllowed = true;
396 }
397
398 if (nUsedSize > nHugeSize)
399 {
400 mbHugeSize = true;
401 }
402 }
403
404 // prepare buffer space
405 if (mbBufferingAllowed && isValidData())
406 {
407 maBufferedPrimitives = Primitive2DContainer(maAnimation.Count());
408 }
409 }
410
411 bool AnimatedGraphicPrimitive2D::operator==(const BasePrimitive2D& rPrimitive) const
412 {
413 // do not use 'GroupPrimitive2D::operator==' here, that would compare
414 // the children. Also do not use 'BasePrimitive2D::operator==', that would
415 // check the ID-Type. Since we are a simple derivation without own ID,
416 // use the dynamic_cast RTTI directly
417 const AnimatedGraphicPrimitive2D* pCompare = dynamic_cast<const AnimatedGraphicPrimitive2D*>(&rPrimitive);
418
419 // use operator== of Graphic - if that is equal, the basic definition is equal
420 return (nullptr != pCompare
421 && getTransform() == pCompare->getTransform()
422 && maGraphic == pCompare->maGraphic);
423 }
424
425 void AnimatedGraphicPrimitive2D::get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const
426 {
427 if (!isValidData())
428 return;
429
430 Primitive2DReference aRetval;
431 const double fState(getAnimationEntry().getStateAtTime(rViewInformation.getViewTime()));
432 const sal_uInt32 nLen(maAnimation.Count());
433 sal_uInt32 nIndex(basegfx::fround(fState * static_cast<double>(nLen)));
434
435 // nIndex is the requested frame - it is in range [0..nLen[
436 // create frame representation in VirtualDevices
437 if (nIndex >= nLen)
438 {
439 nIndex = nLen - 1;
440 }
441
442 // check buffering shortcuts, may already be created
443 aRetval = tryTogetFromBuffer(nIndex);
444
445 if (aRetval.is())
446 {
447 rVisitor.append(aRetval);
448 return;
449 }
450
451 // if huge size (and not the buffered 1st frame) simply
452 // create next frame
453 if (mbHugeSize && 0 != nIndex && mnNextFrameToPrepare <= nIndex)
454 {
455 nIndex = mnNextFrameToPrepare % nLen;
456 }
457
458 // frame not (yet) buffered or no buffering allowed, create it
459 const_cast<AnimatedGraphicPrimitive2D*>(this)->createFrame(nIndex);
460
461 // try to get from buffer again, may have been added from createFrame
462 aRetval = tryTogetFromBuffer(nIndex);
463
464 if (aRetval.is())
465 {
466 rVisitor.append(aRetval);
467 return;
468 }
469
470 // did not work (not buffered and not 1st frame), create from buffer
471 aRetval = createFromBuffer();
472
473 rVisitor.append(aRetval);
474 }
475
476} // end of namespace
477
478namespace drawinglayer::primitive2d
479{
480 void create2DDecompositionOfGraphic(
481 Primitive2DContainer& rContainer,
482 const Graphic& rGraphic,
483 const basegfx::B2DHomMatrix& rTransform)
484 {
485 Primitive2DContainer aRetval;
486
487 switch(rGraphic.GetType())
488 {
489 case GraphicType::Bitmap :
490 {
491 if(rGraphic.IsAnimated())
492 {
493 // prepare specialized AnimatedGraphicPrimitive2D
494 aRetval.resize(1);
495 aRetval[0] = new AnimatedGraphicPrimitive2D(
496 rGraphic,
497 rTransform);
498 }
499 else if(rGraphic.getVectorGraphicData())
500 {
501 // embedded Vector Graphic Data fill, create embed transform
502 const basegfx::B2DRange& rSvgRange(rGraphic.getVectorGraphicData()->getRange());
503
504 if(basegfx::fTools::more(rSvgRange.getWidth(), 0.0) && basegfx::fTools::more(rSvgRange.getHeight(), 0.0))
505 {
506 // translate back to origin, scale to unit coordinates
507 basegfx::B2DHomMatrix aEmbedVectorGraphic(
508 basegfx::utils::createTranslateB2DHomMatrix(
509 -rSvgRange.getMinX(),
510 -rSvgRange.getMinY()));
511
512 aEmbedVectorGraphic.scale(
513 1.0 / rSvgRange.getWidth(),
514 1.0 / rSvgRange.getHeight());
515
516 // apply created object transformation
517 aEmbedVectorGraphic = rTransform * aEmbedVectorGraphic;
518
519 // add Vector Graphic Data primitives embedded
520 aRetval.resize(1);
521 aRetval[0] = new TransformPrimitive2D(
522 aEmbedVectorGraphic,
523 rGraphic.getVectorGraphicData()->getPrimitive2DSequence());
524 }
525 }
526 else
527 {
528 aRetval.resize(1);
529 aRetval[0] = new BitmapPrimitive2D(
530 VCLUnoHelper::CreateVCLXBitmap(rGraphic.GetBitmapEx()),
531 rTransform);
532 }
533
534 break;
535 }
536
537 case GraphicType::GdiMetafile :
538 {
539 // create MetafilePrimitive2D
540 const GDIMetaFile& rMetafile = rGraphic.GetGDIMetaFile();
541
542 aRetval.resize(1);
543 aRetval[0] = new MetafilePrimitive2D(
544 rTransform,
545 rMetafile);
546
547 // #i100357# find out if clipping is needed for this primitive. Unfortunately,
548 // there exist Metafiles who's content is bigger than the proposed PrefSize set
549 // at them. This is an error, but we need to work around this
550 const Size aMetaFilePrefSize(rMetafile.GetPrefSize());
551 const Size aMetaFileRealSize(
552 rMetafile.GetBoundRect(
553 *Application::GetDefaultDevice()).GetSize());
554
555 if(aMetaFileRealSize.getWidth() > aMetaFilePrefSize.getWidth()
556 || aMetaFileRealSize.getHeight() > aMetaFilePrefSize.getHeight())
557 {
558 // clipping needed. Embed to MaskPrimitive2D. Create children and mask polygon
559 basegfx::B2DPolygon aMaskPolygon(basegfx::utils::createUnitPolygon());
560 aMaskPolygon.transform(rTransform);
561
562 Primitive2DReference mask = new MaskPrimitive2D(
563 basegfx::B2DPolyPolygon(aMaskPolygon),
564 aRetval);
565 aRetval[0] = mask;
566 }
567 break;
568 }
569
570 default:
571 {
572 // nothing to create
573 break;
574 }
575 }
576
577 rContainer.insert(rContainer.end(), aRetval.begin(), aRetval.end());
578 }
579
580 Primitive2DContainer create2DColorModifierEmbeddingsAsNeeded(
581 const Primitive2DContainer& rChildren,
582 GraphicDrawMode aGraphicDrawMode,
583 double fLuminance,
584 double fContrast,
585 double fRed,
586 double fGreen,
587 double fBlue,
588 double fGamma,
589 bool bInvert)
590 {
591 Primitive2DContainer aRetval;
592
593 if(rChildren.empty())
594 {
595 // no child content, done
596 return aRetval;
597 }
598
599 // set child content as retval; that is what will be used as child content in all
600 // embeddings from here
601 aRetval = rChildren;
602
603 if(GraphicDrawMode::Watermark == aGraphicDrawMode)
604 {
605 // this is solved by applying fixed values additionally to luminance
606 // and contrast, do it here and reset DrawMode to GraphicDrawMode::Standard
607 // original in svtools uses:
608 // #define WATERMARK_LUM_OFFSET 50
609 // #define WATERMARK_CON_OFFSET -70
610 fLuminance = std::clamp(fLuminance + 0.5, -1.0, 1.0);
611 fContrast = std::clamp(fContrast - 0.7, -1.0, 1.0);
612 aGraphicDrawMode = GraphicDrawMode::Standard;
613 }
614
615 // DrawMode (GraphicDrawMode::Watermark already handled)
616 switch(aGraphicDrawMode)
617 {
618 case GraphicDrawMode::Greys:
619 {
620 // convert to grey
621 const Primitive2DReference aPrimitiveGrey(
622 new ModifiedColorPrimitive2D(
623 aRetval,
624 std::make_shared<basegfx::BColorModifier_gray>()));
625
626 aRetval = Primitive2DContainer { aPrimitiveGrey };
627 break;
628 }
629 case GraphicDrawMode::Mono:
630 {
631 // convert to mono (black/white with threshold 0.5)
632 const Primitive2DReference aPrimitiveBlackAndWhite(
633 new ModifiedColorPrimitive2D(
634 aRetval,
635 std::make_shared<basegfx::BColorModifier_black_and_white>(0.5)));
636
637 aRetval = Primitive2DContainer { aPrimitiveBlackAndWhite };
638 break;
639 }
640 default: // case GraphicDrawMode::Standard:
641 {
642 assert((static_cast <bool> (aGraphicDrawMode != GraphicDrawMode
::Watermark && "OOps, GraphicDrawMode::Watermark should already be handled (see above)"
) ? void (0) : __assert_fail ("aGraphicDrawMode != GraphicDrawMode::Watermark && \"OOps, GraphicDrawMode::Watermark should already be handled (see above)\""
, "/home/maarten/src/libreoffice/core/drawinglayer/source/primitive2d/graphicprimitivehelper2d.cxx"
, 644, __extension__ __PRETTY_FUNCTION__))
643 aGraphicDrawMode != GraphicDrawMode::Watermark(static_cast <bool> (aGraphicDrawMode != GraphicDrawMode
::Watermark && "OOps, GraphicDrawMode::Watermark should already be handled (see above)"
) ? void (0) : __assert_fail ("aGraphicDrawMode != GraphicDrawMode::Watermark && \"OOps, GraphicDrawMode::Watermark should already be handled (see above)\""
, "/home/maarten/src/libreoffice/core/drawinglayer/source/primitive2d/graphicprimitivehelper2d.cxx"
, 644, __extension__ __PRETTY_FUNCTION__))
644 && "OOps, GraphicDrawMode::Watermark should already be handled (see above)")(static_cast <bool> (aGraphicDrawMode != GraphicDrawMode
::Watermark && "OOps, GraphicDrawMode::Watermark should already be handled (see above)"
) ? void (0) : __assert_fail ("aGraphicDrawMode != GraphicDrawMode::Watermark && \"OOps, GraphicDrawMode::Watermark should already be handled (see above)\""
, "/home/maarten/src/libreoffice/core/drawinglayer/source/primitive2d/graphicprimitivehelper2d.cxx"
, 644, __extension__ __PRETTY_FUNCTION__));
645 // nothing to do
646 break;
647 }
648 }
649
650 // mnContPercent, mnLumPercent, mnRPercent, mnGPercent, mnBPercent
651 // handled in a single call
652 if(!basegfx::fTools::equalZero(fLuminance)
653 || !basegfx::fTools::equalZero(fContrast)
654 || !basegfx::fTools::equalZero(fRed)
655 || !basegfx::fTools::equalZero(fGreen)
656 || !basegfx::fTools::equalZero(fBlue))
657 {
658 const Primitive2DReference aPrimitiveRGBLuminannceContrast(
659 new ModifiedColorPrimitive2D(
660 aRetval,
661 std::make_shared<basegfx::BColorModifier_RGBLuminanceContrast>(
662 fRed,
663 fGreen,
664 fBlue,
665 fLuminance,
666 fContrast)));
667
668 aRetval = Primitive2DContainer { aPrimitiveRGBLuminannceContrast };
669 }
670
671 // gamma (boolean)
672 if(!basegfx::fTools::equal(fGamma, 1.0))
673 {
674 const Primitive2DReference aPrimitiveGamma(
675 new ModifiedColorPrimitive2D(
676 aRetval,
677 std::make_shared<basegfx::BColorModifier_gamma>(
678 fGamma)));
679
680 aRetval = Primitive2DContainer { aPrimitiveGamma };
681 }
682
683 // invert (boolean)
684 if(bInvert)
685 {
686 const Primitive2DReference aPrimitiveInvert(
687 new ModifiedColorPrimitive2D(
688 aRetval,
689 std::make_shared<basegfx::BColorModifier_invert>()));
690
691 aRetval = Primitive2DContainer { aPrimitiveInvert };
692 }
693
694 return aRetval;
695 }
696
697} // end of namespace
698
699/* 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);
4
←
Calling copy constructor for 'Reference<VirtualDevice>'
→
7
←
Returning from copy constructor for 'Reference<VirtualDevice>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
8
←
Calling 'Reference::clear'
→
15
←
Returning; memory was released
→
205 if (aTmp.get()) {
16
←
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();
3
←
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 )
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)
5
←
Assuming field 'm_pBody' is non-null
→
6
←
Taking true branch
→
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
8.1
Field 'm_pBody' is non-null
8.1
Field 'm_pBody' is non-null
8.1
Field 'm_pBody' is non-null
8.1
Field 'm_pBody' is non-null
)
9
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
10
←
Calling 'VclReferenceBase::release'
→
14
←
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;
17
←
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)
11
←
Assuming the condition is true
→
12
←
Taking true branch
→
40 delete this;
13
←
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