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 transparent.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/glm -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/libmount -isystem /usr/include/blkid -isystem /usr/include/cairo -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/pixman-1 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/libxml2 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D VCL_DLLIMPLEMENTATION -D DLLIMPLEMENTATION_UITEST -D CUI_DLL_NAME="libcuilo.so" -D DESKTOP_DETECTOR_DLL_NAME="libdesktop_detectorlo.so" -D TK_DLL_NAME="libtklo.so" -D SYSTEM_ZLIB -D GLM_FORCE_CTOR_INIT -D SK_USER_CONFIG_HEADER=</home/maarten/src/libreoffice/core/config_host/config_skia.h> -D SKIA_DLL -D ENABLE_CUPS -D HAVE_VALGRIND_HEADERS -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/core -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/effects -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/config -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/ports -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/third_party/vulkan -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/tools/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia -I /home/maarten/src/libreoffice/core/external/skia/inc/ -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/lcms2/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/harfbuzz/src -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/graphite/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium/public -D COMPONENT_BUILD -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libpng -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libjpeg-turbo -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/vcl/inc -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/libxml2 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/vcl/source/outdev/transparent.cxx

/home/maarten/src/libreoffice/core/vcl/source/outdev/transparent.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 <cassert>
21
22#include <sal/types.h>
23#include <tools/helpers.hxx>
24#include <rtl/math.hxx>
25
26#include <memory>
27
28#include <vcl/bitmapaccess.hxx>
29#include <vcl/gdimtf.hxx>
30#include <vcl/metaact.hxx>
31#include <vcl/outdev.hxx>
32#include <vcl/settings.hxx>
33#include <vcl/virdev.hxx>
34
35#include <outdata.hxx>
36#include <salgdi.hxx>
37#include <bitmapwriteaccess.hxx>
38
39namespace
40{
41 /**
42 * Perform a safe approximation of a polygon from double-precision
43 * coordinates to integer coordinates, to ensure that it has at least 2
44 * pixels in both X and Y directions.
45 */
46 tools::Polygon toPolygon( const basegfx::B2DPolygon& rPoly )
47 {
48 basegfx::B2DRange aRange = rPoly.getB2DRange();
49 double fW = aRange.getWidth(), fH = aRange.getHeight();
50 if (0.0 < fW && 0.0 < fH && (fW <= 1.0 || fH <= 1.0))
51 {
52 // This polygon not empty but is too small to display. Approximate it
53 // with a rectangle large enough to be displayed.
54 double nX = aRange.getMinX(), nY = aRange.getMinY();
55 double nW = std::max<double>(1.0, rtl::math::round(fW));
56 double nH = std::max<double>(1.0, rtl::math::round(fH));
57
58 tools::Polygon aTarget;
59 aTarget.Insert(0, Point(nX, nY));
60 aTarget.Insert(1, Point(nX+nW, nY));
61 aTarget.Insert(2, Point(nX+nW, nY+nH));
62 aTarget.Insert(3, Point(nX, nY+nH));
63 aTarget.Insert(4, Point(nX, nY));
64 return aTarget;
65 }
66 return tools::Polygon(rPoly);
67 }
68
69 tools::PolyPolygon toPolyPolygon( const basegfx::B2DPolyPolygon& rPolyPoly )
70 {
71 tools::PolyPolygon aTarget;
72 for (auto const& rB2DPolygon : rPolyPoly)
73 aTarget.Insert(toPolygon(rB2DPolygon));
74
75 return aTarget;
76 }
77}
78
79Color OutputDevice::ImplDrawModeToColor( const Color& rColor ) const
80{
81 Color aColor( rColor );
82 DrawModeFlags nDrawMode = GetDrawMode();
83
84 if( nDrawMode & ( DrawModeFlags::BlackLine | DrawModeFlags::WhiteLine |
85 DrawModeFlags::GrayLine |
86 DrawModeFlags::SettingsLine ) )
87 {
88 if( !ImplIsColorTransparent( aColor ) )
89 {
90 if( nDrawMode & DrawModeFlags::BlackLine )
91 {
92 aColor = COL_BLACK;
93 }
94 else if( nDrawMode & DrawModeFlags::WhiteLine )
95 {
96 aColor = COL_WHITE;
97 }
98 else if( nDrawMode & DrawModeFlags::GrayLine )
99 {
100 const sal_uInt8 cLum = aColor.GetLuminance();
101 aColor = Color( cLum, cLum, cLum );
102 }
103 else if( nDrawMode & DrawModeFlags::SettingsLine )
104 {
105 aColor = GetSettings().GetStyleSettings().GetFontColor();
106 }
107 }
108 }
109 return aColor;
110}
111
112void OutputDevice::ImplPrintTransparent( const Bitmap& rBmp, const Bitmap& rMask,
113 const Point& rDestPt, const Size& rDestSize,
114 const Point& rSrcPtPixel, const Size& rSrcSizePixel )
115{
116 Point aDestPt( LogicToPixel( rDestPt ) );
117 Size aDestSz( LogicToPixel( rDestSize ) );
118 tools::Rectangle aSrcRect( rSrcPtPixel, rSrcSizePixel );
119
120 aSrcRect.Justify();
121
122 if( rBmp.IsEmpty() || !aSrcRect.GetWidth() || !aSrcRect.GetHeight() || !aDestSz.Width() || !aDestSz.Height() )
123 return;
124
125 Bitmap aPaint( rBmp ), aMask( rMask );
126 BmpMirrorFlags nMirrFlags = BmpMirrorFlags::NONE;
127
128 if( aMask.GetBitCount() > 1 )
129 aMask.Convert( BmpConversion::N1BitThreshold );
130
131 // mirrored horizontically
132 if( aDestSz.Width() < 0 )
133 {
134 aDestSz.setWidth( -aDestSz.Width() );
135 aDestPt.AdjustX( -( aDestSz.Width() - 1 ) );
136 nMirrFlags |= BmpMirrorFlags::Horizontal;
137 }
138
139 // mirrored vertically
140 if( aDestSz.Height() < 0 )
141 {
142 aDestSz.setHeight( -aDestSz.Height() );
143 aDestPt.AdjustY( -( aDestSz.Height() - 1 ) );
144 nMirrFlags |= BmpMirrorFlags::Vertical;
145 }
146
147 // source cropped?
148 if( aSrcRect != tools::Rectangle( Point(), aPaint.GetSizePixel() ) )
149 {
150 aPaint.Crop( aSrcRect );
151 aMask.Crop( aSrcRect );
152 }
153
154 // destination mirrored
155 if( nMirrFlags != BmpMirrorFlags::NONE )
156 {
157 aPaint.Mirror( nMirrFlags );
158 aMask.Mirror( nMirrFlags );
159 }
160
161 // we always want to have a mask
162 if( aMask.IsEmpty() )
163 {
164 aMask = Bitmap( aSrcRect.GetSize(), 1 );
165 aMask.Erase( COL_BLACK );
166 }
167
168 // do painting
169 const long nSrcWidth = aSrcRect.GetWidth(), nSrcHeight = aSrcRect.GetHeight();
170 long nX, nY; // , nWorkX, nWorkY, nWorkWidth, nWorkHeight;
171 std::unique_ptr<long[]> pMapX(new long[ nSrcWidth + 1 ]);
172 std::unique_ptr<long[]> pMapY(new long[ nSrcHeight + 1 ]);
173 const bool bOldMap = mbMap;
174
175 mbMap = false;
176
177 // create forward mapping tables
178 for( nX = 0; nX <= nSrcWidth; nX++ )
179 pMapX[ nX ] = aDestPt.X() + FRound( static_cast<double>(aDestSz.Width()) * nX / nSrcWidth );
180
181 for( nY = 0; nY <= nSrcHeight; nY++ )
182 pMapY[ nY ] = aDestPt.Y() + FRound( static_cast<double>(aDestSz.Height()) * nY / nSrcHeight );
183
184 // walk through all rectangles of mask
185 const vcl::Region aWorkRgn(aMask.CreateRegion(COL_BLACK, tools::Rectangle(Point(), aMask.GetSizePixel())));
186 RectangleVector aRectangles;
187 aWorkRgn.GetRegionRectangles(aRectangles);
188
189 for (auto const& rectangle : aRectangles)
190 {
191 const Point aMapPt(pMapX[rectangle.Left()], pMapY[rectangle.Top()]);
192 const Size aMapSz( pMapX[rectangle.Right() + 1] - aMapPt.X(), // pMapX[L + W] -> L + ((R - L) + 1) -> R + 1
193 pMapY[rectangle.Bottom() + 1] - aMapPt.Y()); // same for Y
194 Bitmap aBandBmp(aPaint);
195
196 aBandBmp.Crop(rectangle);
197 DrawBitmap(aMapPt, aMapSz, Point(), aBandBmp.GetSizePixel(), aBandBmp);
198 }
199
200 mbMap = bOldMap;
201
202}
203
204// Caution: This method is nearly the same as
205// void OutputDevice::DrawPolyPolygon( const basegfx::B2DPolyPolygon& rB2DPolyPoly )
206// so when changes are made here do not forget to make changes there, too
207
208void OutputDevice::DrawTransparent(
209 const basegfx::B2DHomMatrix& rObjectTransform,
210 const basegfx::B2DPolyPolygon& rB2DPolyPoly,
211 double fTransparency)
212{
213 assert(!is_double_buffered_window())(static_cast <bool> (!is_double_buffered_window()) ? void
(0) : __assert_fail ("!is_double_buffered_window()", "/home/maarten/src/libreoffice/core/vcl/source/outdev/transparent.cxx"
, 213, __extension__ __PRETTY_FUNCTION__));
214
215 // AW: Do NOT paint empty PolyPolygons
216 if(!rB2DPolyPoly.count())
217 return;
218
219 // we need a graphics
220 if( !mpGraphics && !AcquireGraphics() )
221 return;
222
223 if( mbInitClipRegion )
224 InitClipRegion();
225
226 if( mbOutputClipped )
227 return;
228
229 if( mbInitLineColor )
230 InitLineColor();
231
232 if( mbInitFillColor )
233 InitFillColor();
234
235 if(mpGraphics->supportsOperation(OutDevSupportType::B2DDraw) &&
236 (RasterOp::OverPaint == GetRasterOp()) )
237 {
238 // b2dpolygon support not implemented yet on non-UNX platforms
239 basegfx::B2DPolyPolygon aB2DPolyPolygon(rB2DPolyPoly);
240
241 // ensure it is closed
242 if(!aB2DPolyPolygon.isClosed())
243 {
244 // maybe assert, prevents buffering due to making a copy
245 aB2DPolyPolygon.setClosed( true );
246 }
247
248 // create ObjectToDevice transformation
249 const basegfx::B2DHomMatrix aFullTransform(ImplGetDeviceTransformation() * rObjectTransform);
250 // TODO: this must not drop transparency for mpAlphaVDev case, but instead use premultiplied
251 // alpha... but that requires using premultiplied alpha also for already drawn data
252 const double fAdjustedTransparency = mpAlphaVDev ? 0 : fTransparency;
253 bool bDrawnOk(true);
254
255 if( IsFillColor() )
256 {
257 bDrawnOk = mpGraphics->DrawPolyPolygon(
258 aFullTransform,
259 aB2DPolyPolygon,
260 fAdjustedTransparency,
261 this);
262 }
263
264 if( bDrawnOk && IsLineColor() )
265 {
266 const bool bPixelSnapHairline(mnAntialiasing & AntialiasingFlags::PixelSnapHairline);
267
268 for(auto const& rPolygon : aB2DPolyPolygon)
269 {
270 mpGraphics->DrawPolyLine(
271 aFullTransform,
272 rPolygon,
273 fAdjustedTransparency,
274 0.0, // tdf#124848 hairline
275 nullptr, // MM01
276 basegfx::B2DLineJoin::NONE,
277 css::drawing::LineCap_BUTT,
278 basegfx::deg2rad(15.0), // not used with B2DLineJoin::NONE, but the correct default
279 bPixelSnapHairline,
280 this );
281 }
282 }
283
284 if( bDrawnOk )
285 {
286 if( mpMetaFile )
287 {
288 // tdf#119843 need transformed Polygon here
289 basegfx::B2DPolyPolygon aB2DPolyPoly(rB2DPolyPoly);
290 aB2DPolyPoly.transform(rObjectTransform);
291 mpMetaFile->AddAction(
292 new MetaTransparentAction(
293 tools::PolyPolygon(aB2DPolyPoly),
294 static_cast< sal_uInt16 >(fTransparency * 100.0)));
295 }
296
297 if (mpAlphaVDev)
298 mpAlphaVDev->DrawTransparent(rObjectTransform, rB2DPolyPoly, fTransparency);
299
300 return;
301 }
302 }
303
304 // fallback to old polygon drawing if needed
305 // tdf#119843 need transformed Polygon here
306 basegfx::B2DPolyPolygon aB2DPolyPoly(rB2DPolyPoly);
307 aB2DPolyPoly.transform(rObjectTransform);
308 DrawTransparent(
309 toPolyPolygon(aB2DPolyPoly),
310 static_cast<sal_uInt16>(fTransparency * 100.0));
311}
312
313void OutputDevice::DrawInvisiblePolygon( const tools::PolyPolygon& rPolyPoly )
314{
315 assert(!is_double_buffered_window())(static_cast <bool> (!is_double_buffered_window()) ? void
(0) : __assert_fail ("!is_double_buffered_window()", "/home/maarten/src/libreoffice/core/vcl/source/outdev/transparent.cxx"
, 315, __extension__ __PRETTY_FUNCTION__));
316
317 // short circuit if the polygon border is invisible too
318 if( !mbLineColor )
319 return;
320
321 // we assume that the border is NOT to be drawn transparently???
322 Push( PushFlags::FILLCOLOR );
323 SetFillColor();
324 DrawPolyPolygon( rPolyPoly );
325 Pop();
326}
327
328bool OutputDevice::DrawTransparentNatively ( const tools::PolyPolygon& rPolyPoly,
329 sal_uInt16 nTransparencePercent )
330{
331 assert(!is_double_buffered_window())(static_cast <bool> (!is_double_buffered_window()) ? void
(0) : __assert_fail ("!is_double_buffered_window()", "/home/maarten/src/libreoffice/core/vcl/source/outdev/transparent.cxx"
, 331, __extension__ __PRETTY_FUNCTION__));
332
333 bool bDrawn = false;
334
335 // debug helper:
336 static const char* pDisableNative = getenv( "SAL_DISABLE_NATIVE_ALPHA");
337
338 if( !pDisableNative &&
339 mpGraphics->supportsOperation( OutDevSupportType::B2DDraw )
340#if defined UNX1 && ! defined MACOSX && ! defined IOS
341 && GetBitCount() > 8
342#endif
343#ifdef _WIN32
344 // workaround bad dithering on remote displaying when using GDI+ with toolbar button highlighting
345 && !rPolyPoly.IsRect()
346#endif
347 )
348 {
349 // prepare the graphics device
350 if( mbInitClipRegion )
351 InitClipRegion();
352
353 if( mbOutputClipped )
354 return false;
355
356 if( mbInitLineColor )
357 InitLineColor();
358
359 if( mbInitFillColor )
360 InitFillColor();
361
362 // get the polygon in device coordinates
363 basegfx::B2DPolyPolygon aB2DPolyPolygon(rPolyPoly.getB2DPolyPolygon());
364 const basegfx::B2DHomMatrix aTransform(ImplGetDeviceTransformation());
365
366 const double fTransparency = 0.01 * nTransparencePercent;
367 if( mbFillColor )
368 {
369 // #i121591#
370 // CAUTION: Only non printing (pixel-renderer) VCL commands from OutputDevices
371 // should be used when printing. Normally this is avoided by the printer being
372 // non-AAed and thus e.g. on WIN GdiPlus calls are not used. It may be necessary
373 // to figure out a way of moving this code to its own function that is
374 // overridden by the Print class, which will mean we deliberately override the
375 // functionality and we use the fallback some lines below (which is not very good,
376 // though. For now, WinSalGraphics::drawPolyPolygon will detect printer usage and
377 // correct the wrong mapping (see there for details)
378 bDrawn = mpGraphics->DrawPolyPolygon(
379 aTransform,
380 aB2DPolyPolygon,
381 fTransparency,
382 this);
383 }
384
385 if( mbLineColor )
386 {
387 // disable the fill color for now
388 mpGraphics->SetFillColor();
389
390 // draw the border line
391 const bool bPixelSnapHairline(mnAntialiasing & AntialiasingFlags::PixelSnapHairline);
392
393 for(auto const& rPolygon : aB2DPolyPolygon)
394 {
395 bDrawn = mpGraphics->DrawPolyLine(
396 aTransform,
397 rPolygon,
398 fTransparency,
399 0.0, // tdf#124848 hairline
400 nullptr, // MM01
401 basegfx::B2DLineJoin::NONE,
402 css::drawing::LineCap_BUTT,
403 basegfx::deg2rad(15.0), // not used with B2DLineJoin::NONE, but the correct default
404 bPixelSnapHairline,
405 this );
406 }
407
408 // prepare to restore the fill color
409 mbInitFillColor = mbFillColor;
410 }
411 }
412
413 return bDrawn;
414}
415
416void OutputDevice::EmulateDrawTransparent ( const tools::PolyPolygon& rPolyPoly,
417 sal_uInt16 nTransparencePercent )
418{
419 // #110958# Disable alpha VDev, we perform the necessary
420 VirtualDevice* pOldAlphaVDev = mpAlphaVDev;
421
422 // operation explicitly further below.
423 if( mpAlphaVDev )
424 mpAlphaVDev = nullptr;
425
426 GDIMetaFile* pOldMetaFile = mpMetaFile;
427 mpMetaFile = nullptr;
428
429 tools::PolyPolygon aPolyPoly( LogicToPixel( rPolyPoly ) );
430 tools::Rectangle aPolyRect( aPolyPoly.GetBoundRect() );
431 tools::Rectangle aDstRect( Point(), GetOutputSizePixel() );
432
433 aDstRect.Intersection( aPolyRect );
434
435 ClipToPaintRegion( aDstRect );
436
437 if( !aDstRect.IsEmpty() )
438 {
439 bool bDrawn = false;
440
441 // debug helper:
442 static const char* pDisableNative = getenv( "SAL_DISABLE_NATIVE_ALPHA" );
443
444 // #i66849# Added fast path for exactly rectangular
445 // polygons
446 // #i83087# Naturally, system alpha blending cannot
447 // work with separate alpha VDev
448 if( !mpAlphaVDev && !pDisableNative && aPolyPoly.IsRect() )
449 {
450 // setup Graphics only here (other cases delegate
451 // to basic OutDev methods)
452 if ( mbInitClipRegion )
453 InitClipRegion();
454
455 if ( mbInitLineColor )
456 InitLineColor();
457
458 if ( mbInitFillColor )
459 InitFillColor();
460
461 tools::Rectangle aLogicPolyRect( rPolyPoly.GetBoundRect() );
462 tools::Rectangle aPixelRect( ImplLogicToDevicePixel( aLogicPolyRect ) );
463
464 if( !mbOutputClipped )
465 {
466 bDrawn = mpGraphics->DrawAlphaRect( aPixelRect.Left(), aPixelRect.Top(),
467 // #i98405# use methods with small g, else one pixel too much will be painted.
468 // This is because the source is a polygon which when painted would not paint
469 // the rightmost and lowest pixel line(s), so use one pixel less for the
470 // rectangle, too.
471 aPixelRect.getWidth(), aPixelRect.getHeight(),
472 sal::static_int_cast<sal_uInt8>(nTransparencePercent),
473 this );
474 }
475 else
476 {
477 bDrawn = true;
478 }
479 }
480
481 if( !bDrawn )
482 {
483 ScopedVclPtrInstance< VirtualDevice > aVDev(*this, DeviceFormat::BITMASK);
484 const Size aDstSz( aDstRect.GetSize() );
485 const sal_uInt8 cTrans = static_cast<sal_uInt8>(MinMax( FRound( nTransparencePercent * 2.55 ), 0, 255 ));
486
487 if( aDstRect.Left() || aDstRect.Top() )
488 aPolyPoly.Move( -aDstRect.Left(), -aDstRect.Top() );
489
490 if( aVDev->SetOutputSizePixel( aDstSz ) )
491 {
492 const bool bOldMap = mbMap;
493
494 EnableMapMode( false );
495
496 aVDev->SetLineColor( COL_BLACK );
497 aVDev->SetFillColor( COL_BLACK );
498 aVDev->DrawPolyPolygon( aPolyPoly );
499
500 Bitmap aPaint( GetBitmap( aDstRect.TopLeft(), aDstSz ) );
501 Bitmap aPolyMask( aVDev->GetBitmap( Point(), aDstSz ) );
502
503 // #107766# check for non-empty bitmaps before accessing them
504 if( !!aPaint && !!aPolyMask )
505 {
506 BitmapScopedWriteAccess pW(aPaint);
507 Bitmap::ScopedReadAccess pR(aPolyMask);
508
509 if( pW && pR )
510 {
511 BitmapColor aPixCol;
512 const BitmapColor aFillCol( GetFillColor() );
513 const BitmapColor aBlack( pR->GetBestMatchingColor( COL_BLACK ) );
514 const long nWidth = pW->Width();
515 const long nHeight = pW->Height();
516 const long nR = aFillCol.GetRed();
517 const long nG = aFillCol.GetGreen();
518 const long nB = aFillCol.GetBlue();
519 long nX, nY;
520
521 if( aPaint.GetBitCount() <= 8 )
522 {
523 const BitmapPalette& rPal = pW->GetPalette();
524 const sal_uInt16 nCount = rPal.GetEntryCount();
525 BitmapColor* pMap = reinterpret_cast<BitmapColor*>(new sal_uInt8[ nCount * sizeof( BitmapColor ) ]);
526
527 for( sal_uInt16 i = 0; i < nCount; i++ )
528 {
529 BitmapColor aCol( rPal[ i ] );
530 aCol.Merge( aFillCol, cTrans );
531 pMap[ i ] = BitmapColor( static_cast<sal_uInt8>(rPal.GetBestIndex( aCol )) );
532 }
533
534 if( pR->GetScanlineFormat() == ScanlineFormat::N1BitMsbPal &&
535 pW->GetScanlineFormat() == ScanlineFormat::N8BitPal )
536 {
537 const sal_uInt8 cBlack = aBlack.GetIndex();
538
539 for( nY = 0; nY < nHeight; nY++ )
540 {
541 Scanline pWScan = pW->GetScanline( nY );
542 Scanline pRScan = pR->GetScanline( nY );
543 sal_uInt8 cBit = 128;
544
545 for( nX = 0; nX < nWidth; nX++, cBit >>= 1, pWScan++ )
546 {
547 if( !cBit )
548 {
549 cBit = 128;
550 pRScan += 1;
551 }
552 if( ( *pRScan & cBit ) == cBlack )
553 {
554 *pWScan = pMap[ *pWScan ].GetIndex();
555 }
556 }
557 }
558 }
559 else
560 {
561 for( nY = 0; nY < nHeight; nY++ )
562 {
563 Scanline pScanline = pW->GetScanline(nY);
564 Scanline pScanlineRead = pR->GetScanline(nY);
565 for( nX = 0; nX < nWidth; nX++ )
566 {
567 if( pR->GetPixelFromData( pScanlineRead, nX ) == aBlack )
568 {
569 pW->SetPixelOnData( pScanline, nX, pMap[ pW->GetIndexFromData( pScanline, nX ) ] );
570 }
571 }
572 }
573 }
574 delete[] reinterpret_cast<sal_uInt8*>(pMap);
575 }
576 else
577 {
578 if( pR->GetScanlineFormat() == ScanlineFormat::N1BitMsbPal &&
579 pW->GetScanlineFormat() == ScanlineFormat::N24BitTcBgr )
580 {
581 const sal_uInt8 cBlack = aBlack.GetIndex();
582
583 for( nY = 0; nY < nHeight; nY++ )
584 {
585 Scanline pWScan = pW->GetScanline( nY );
586 Scanline pRScan = pR->GetScanline( nY );
587 sal_uInt8 cBit = 128;
588
589 for( nX = 0; nX < nWidth; nX++, cBit >>= 1, pWScan += 3 )
590 {
591 if( !cBit )
592 {
593 cBit = 128;
594 pRScan += 1;
595 }
596 if( ( *pRScan & cBit ) == cBlack )
597 {
598 pWScan[ 0 ] = ColorChannelMerge( pWScan[ 0 ], nB, cTrans );
599 pWScan[ 1 ] = ColorChannelMerge( pWScan[ 1 ], nG, cTrans );
600 pWScan[ 2 ] = ColorChannelMerge( pWScan[ 2 ], nR, cTrans );
601 }
602 }
603 }
604 }
605 else
606 {
607 for( nY = 0; nY < nHeight; nY++ )
608 {
609 Scanline pScanline = pW->GetScanline(nY);
610 Scanline pScanlineRead = pR->GetScanline(nY);
611 for( nX = 0; nX < nWidth; nX++ )
612 {
613 if( pR->GetPixelFromData( pScanlineRead, nX ) == aBlack )
614 {
615 aPixCol = pW->GetColor( nY, nX );
616 aPixCol.Merge(aFillCol, cTrans);
617 pW->SetPixelOnData(pScanline, nX, aPixCol);
618 }
619 }
620 }
621 }
622 }
623 }
624
625 pR.reset();
626 pW.reset();
627
628 DrawBitmap( aDstRect.TopLeft(), aPaint );
629
630 EnableMapMode( bOldMap );
631
632 if( mbLineColor )
633 {
634 Push( PushFlags::FILLCOLOR );
635 SetFillColor();
636 DrawPolyPolygon( rPolyPoly );
637 Pop();
638 }
639 }
640 }
641 else
642 {
643 DrawPolyPolygon( rPolyPoly );
644 }
645 }
646 }
647
648 mpMetaFile = pOldMetaFile;
649
650 // #110958# Restore disabled alpha VDev
651 mpAlphaVDev = pOldAlphaVDev;
652}
653
654void OutputDevice::DrawTransparent( const tools::PolyPolygon& rPolyPoly,
655 sal_uInt16 nTransparencePercent )
656{
657 assert(!is_double_buffered_window())(static_cast <bool> (!is_double_buffered_window()) ? void
(0) : __assert_fail ("!is_double_buffered_window()", "/home/maarten/src/libreoffice/core/vcl/source/outdev/transparent.cxx"
, 657, __extension__ __PRETTY_FUNCTION__));
658
659 // short circuit for drawing an opaque polygon
660 if( (nTransparencePercent < 1) || (mnDrawMode & DrawModeFlags::NoTransparency) )
661 {
662 DrawPolyPolygon( rPolyPoly );
663 return;
664 }
665
666 // short circuit for drawing an invisible polygon
667 if( !mbFillColor || (nTransparencePercent >= 100) )
668 {
669 DrawInvisiblePolygon( rPolyPoly );
670 return; // tdf#84294: do not record it in metafile
671 }
672
673 // handle metafile recording
674 if( mpMetaFile )
675 mpMetaFile->AddAction( new MetaTransparentAction( rPolyPoly, nTransparencePercent ) );
676
677 bool bDrawn = !IsDeviceOutputNecessary() || ImplIsRecordLayout();
678 if( bDrawn )
679 return;
680
681 // get the device graphics as drawing target
682 if( !mpGraphics && !AcquireGraphics() )
683 return;
684
685 // try hard to draw it directly, because the emulation layers are slower
686 bDrawn = DrawTransparentNatively( rPolyPoly, nTransparencePercent );
687
688 if (!bDrawn)
689 EmulateDrawTransparent( rPolyPoly, nTransparencePercent );
690
691 // #110958# Apply alpha value also to VDev alpha channel
692 if( mpAlphaVDev )
693 {
694 const Color aFillCol( mpAlphaVDev->GetFillColor() );
695 mpAlphaVDev->SetFillColor( Color(sal::static_int_cast<sal_uInt8>(255*nTransparencePercent/100),
696 sal::static_int_cast<sal_uInt8>(255*nTransparencePercent/100),
697 sal::static_int_cast<sal_uInt8>(255*nTransparencePercent/100)) );
698
699 mpAlphaVDev->DrawTransparent( rPolyPoly, nTransparencePercent );
700
701 mpAlphaVDev->SetFillColor( aFillCol );
702 }
703}
704
705void OutputDevice::DrawTransparent( const GDIMetaFile& rMtf, const Point& rPos,
706 const Size& rSize, const Gradient& rTransparenceGradient )
707{
708 assert(!is_double_buffered_window())(static_cast <bool> (!is_double_buffered_window()) ? void
(0) : __assert_fail ("!is_double_buffered_window()", "/home/maarten/src/libreoffice/core/vcl/source/outdev/transparent.cxx"
, 708, __extension__ __PRETTY_FUNCTION__));
1
Assuming the condition is true
→
2
←
'?' condition is true
→
709
710 const Color aBlack( COL_BLACK );
711
712 if( mpMetaFile )
3
←
Assuming field 'mpMetaFile' is null
→
4
←
Taking false branch
→
713 {
714 // missing here is to map the data using the DeviceTransformation
715 mpMetaFile->AddAction( new MetaFloatTransparentAction( rMtf, rPos, rSize, rTransparenceGradient ) );
716 }
717
718 if ( !IsDeviceOutputNecessary() )
5
←
Assuming the condition is false
→
6
←
Taking false branch
→
719 return;
720
721 if( ( rTransparenceGradient.GetStartColor() == aBlack && rTransparenceGradient.GetEndColor() == aBlack ) ||
7
←
Taking false branch
→
722 ( mnDrawMode & DrawModeFlags::NoTransparency ) )
723 {
724 const_cast<GDIMetaFile&>(rMtf).WindStart();
725 const_cast<GDIMetaFile&>(rMtf).Play( this, rPos, rSize );
726 const_cast<GDIMetaFile&>(rMtf).WindStart();
727 }
728 else
729 {
730 GDIMetaFile* pOldMetaFile = mpMetaFile;
731 tools::Rectangle aOutRect( LogicToPixel( rPos ), LogicToPixel( rSize ) );
732 Point aPoint;
733 tools::Rectangle aDstRect( aPoint, GetOutputSizePixel() );
734
735 mpMetaFile = nullptr;
736 aDstRect.Intersection( aOutRect );
737
738 ClipToPaintRegion( aDstRect );
739
740 if( !aDstRect.IsEmpty() )
8
←
Taking true branch
→
741 {
742 // Create transparent buffer
743 ScopedVclPtrInstance<VirtualDevice> xVDev(DeviceFormat::DEFAULT, DeviceFormat::DEFAULT);
9
←
Calling constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
11
←
Returning from constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
744
745 xVDev->mnDPIX = mnDPIX;
746 xVDev->mnDPIY = mnDPIY;
747
748 if( xVDev->SetOutputSizePixel( aDstRect.GetSize() ) )
12
←
Assuming the condition is false
→
13
←
Taking false branch
→
749 {
750 if(GetAntialiasing() != AntialiasingFlags::NONE)
751 {
752 // #i102109#
753 // For MetaFile replay (see task) it may now be necessary to take
754 // into account that the content is AntiAlialiased and needs to be masked
755 // like that. Instead of masking, i will use a copy-modify-paste cycle
756 // here (as i already use in the VclPrimiziveRenderer with success)
757 xVDev->SetAntialiasing(GetAntialiasing());
758
759 // create MapMode for buffer (offset needed) and set
760 MapMode aMap(GetMapMode());
761 const Point aOutPos(PixelToLogic(aDstRect.TopLeft()));
762 aMap.SetOrigin(Point(-aOutPos.X(), -aOutPos.Y()));
763 xVDev->SetMapMode(aMap);
764
765 // copy MapMode state and disable for target
766 const bool bOrigMapModeEnabled(IsMapModeEnabled());
767 EnableMapMode(false);
768
769 // copy MapMode state and disable for buffer
770 const bool bBufferMapModeEnabled(xVDev->IsMapModeEnabled());
771 xVDev->EnableMapMode(false);
772
773 // copy content from original to buffer
774 xVDev->DrawOutDev( aPoint, xVDev->GetOutputSizePixel(), // dest
775 aDstRect.TopLeft(), xVDev->GetOutputSizePixel(), // source
776 *this);
777
778 // draw MetaFile to buffer
779 xVDev->EnableMapMode(bBufferMapModeEnabled);
780 const_cast<GDIMetaFile&>(rMtf).WindStart();
781 const_cast<GDIMetaFile&>(rMtf).Play(xVDev.get(), rPos, rSize);
782 const_cast<GDIMetaFile&>(rMtf).WindStart();
783
784 // get content bitmap from buffer
785 xVDev->EnableMapMode(false);
786
787 const Bitmap aPaint(xVDev->GetBitmap(aPoint, xVDev->GetOutputSizePixel()));
788
789 // create alpha mask from gradient and get as Bitmap
790 xVDev->EnableMapMode(bBufferMapModeEnabled);
791 xVDev->SetDrawMode(DrawModeFlags::GrayGradient);
792 xVDev->DrawGradient(tools::Rectangle(rPos, rSize), rTransparenceGradient);
793 xVDev->SetDrawMode(DrawModeFlags::Default);
794 xVDev->EnableMapMode(false);
795
796 const AlphaMask aAlpha(xVDev->GetBitmap(aPoint, xVDev->GetOutputSizePixel()));
797
798 xVDev.disposeAndClear();
799
800 // draw masked content to target and restore MapMode
801 DrawBitmapEx(aDstRect.TopLeft(), BitmapEx(aPaint, aAlpha));
802 EnableMapMode(bOrigMapModeEnabled);
803 }
804 else
805 {
806 MapMode aMap( GetMapMode() );
807 Point aOutPos( PixelToLogic( aDstRect.TopLeft() ) );
808 const bool bOldMap = mbMap;
809
810 aMap.SetOrigin( Point( -aOutPos.X(), -aOutPos.Y() ) );
811 xVDev->SetMapMode( aMap );
812 const bool bVDevOldMap = xVDev->IsMapModeEnabled();
813
814 // create paint bitmap
815 const_cast<GDIMetaFile&>(rMtf).WindStart();
816 const_cast<GDIMetaFile&>(rMtf).Play( xVDev.get(), rPos, rSize );
817 const_cast<GDIMetaFile&>(rMtf).WindStart();
818 xVDev->EnableMapMode( false );
819 BitmapEx aPaint = xVDev->GetBitmapEx(Point(), xVDev->GetOutputSizePixel());
820 xVDev->EnableMapMode( bVDevOldMap ); // #i35331#: MUST NOT use EnableMapMode( sal_True ) here!
821
822 // create alpha mask from gradient
823 xVDev->SetDrawMode( DrawModeFlags::GrayGradient );
824 xVDev->DrawGradient( tools::Rectangle( rPos, rSize ), rTransparenceGradient );
825 xVDev->SetDrawMode( DrawModeFlags::Default );
826 xVDev->EnableMapMode( false );
827
828 AlphaMask aAlpha(xVDev->GetBitmap(Point(), xVDev->GetOutputSizePixel()));
829 aAlpha.BlendWith(aPaint.GetAlpha());
830
831 xVDev.disposeAndClear();
832
833 EnableMapMode( false );
834 DrawBitmapEx(aDstRect.TopLeft(), BitmapEx(aPaint.GetBitmap(), aAlpha));
835 EnableMapMode( bOldMap );
836 }
837 }
838 }
14
←
Calling implicit destructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
15
←
Calling '~ScopedVclPtr'
→
839
840 mpMetaFile = pOldMetaFile;
841 }
842}
843
844/* 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 ;-)
17
←
Calling 'Reference::clear'
→
24
←
Returning; memory was released
→
205 if (aTmp.get()) {
25
←
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();
16
←
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 )
10
←
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
17.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
)
18
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
19
←
Calling 'VclReferenceBase::release'
→
23
←
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;
26
←
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)
20
←
Assuming the condition is true
→
21
←
Taking true branch
→
40 delete this;
22
←
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