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 canvasdemo.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D 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/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/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/canvas/workben/canvasdemo.cxx

/home/maarten/src/libreoffice/core/canvas/workben/canvasdemo.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// This code strongly inspired by Miguel / Federico's Gnome Canvas demo code.
21
22#include <sal/config.h>
23
24#include <basegfx/polygon/b2dpolygon.hxx>
25#include <basegfx/polygon/b2dpolygontools.hxx>
26#include <basegfx/utils/canvastools.hxx>
27#include <com/sun/star/lang/XMultiServiceFactory.hpp>
28#include <com/sun/star/rendering/CompositeOperation.hpp>
29#include <com/sun/star/rendering/FillRule.hpp>
30#include <com/sun/star/rendering/PathCapType.hpp>
31#include <com/sun/star/rendering/PathJoinType.hpp>
32#include <com/sun/star/rendering/RenderState.hpp>
33#include <com/sun/star/rendering/ViewState.hpp>
34#include <com/sun/star/rendering/XBitmap.hpp>
35#include <com/sun/star/rendering/XCanvas.hpp>
36#include <com/sun/star/rendering/XGraphicDevice.hpp>
37#include <com/sun/star/rendering/XSpriteCanvas.hpp>
38#include <com/sun/star/ucb/UniversalContentBroker.hpp>
39#include <comphelper/processfactory.hxx>
40#include <comphelper/random.hxx>
41#include <cppuhelper/bootstrap.hxx>
42#include <vcl/canvastools.hxx>
43#include <vcl/svapp.hxx>
44#include <vcl/vclmain.hxx>
45#include <vcl/virdev.hxx>
46#include <vcl/window.hxx>
47#include <vcl/wrkwin.hxx>
48
49using namespace ::com::sun::star;
50
51static void PrintHelp()
52{
53 fprintf( stdoutstdout, "canvasdemo - Exercise the new canvas impl\n" );
54}
55
56namespace {
57
58class TestWindow : public WorkWindow
59{
60 public:
61 TestWindow() : WorkWindow(nullptr, WB_APP | WB_STDWORK)
62 {
63 SetText("Canvas test");
64 SetSizePixel( Size( 600, 450 ) );
65 EnablePaint( true );
66 Show();
67 }
68 virtual ~TestWindow() override {}
69 virtual void MouseButtonUp( const MouseEvent& /*rMEvt*/ ) override
70 {
71 //TODO: do something cool
72 Application::Quit();
73 }
74 virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) override;
75};
76
77class DemoRenderer
78{
79 public:
80 Size maSize;
81 Size maBox;
82 rendering::ViewState maViewState;
83 rendering::RenderState maRenderState;
84 uno::Sequence< double > maColorBlack;
85 uno::Sequence< double > maColorRed;
86 uno::Reference< rendering::XCanvas > mxCanvas;
87 uno::Reference< rendering::XCanvasFont > mxDefaultFont;
88 uno::Reference< rendering::XGraphicDevice > mxDevice;
89
90 DemoRenderer( uno::Reference< rendering::XGraphicDevice > xDevice,
91 uno::Reference< rendering::XCanvas > xCanvas,
92 Size aSize ) :
93 maSize(aSize),
94 maBox(),
95 maViewState(),
96 maRenderState(),
97 maColorBlack( vcl::unotools::colorToStdColorSpaceSequence( COL_BLACK) ),
98 maColorRed( vcl::unotools::colorToStdColorSpaceSequence( COL_RED) ),
99 mxCanvas(xCanvas),
100 mxDefaultFont(),
101 mxDevice( xDevice )
102 {
103 // Geometry init
104 geometry::AffineMatrix2D aUnit( 1,0, 0,
105 0,1, 0 );
106 maViewState.AffineTransform = aUnit;
107 maRenderState.AffineTransform = aUnit;
108 maRenderState.DeviceColor = maColorBlack;
109
110 //I can't figure out what the compositeoperation stuff does
111 //it doesn't seem to do anything in either VCL or cairocanvas
112 //I was hoping that CLEAR would clear the canvas before we paint,
113 //but nothing changes
114 maRenderState.CompositeOperation = rendering::CompositeOperation::OVER;
115
116 maBox.setWidth(aSize.Width() / 3);
117 maBox.setHeight(aSize.Height() / 3);
118
119 lang::Locale aLocale;
120 rendering::FontInfo aFontInfo;
121 aFontInfo.FamilyName = "Swiss";
122 aFontInfo.StyleName = "SansSerif";
123 geometry::Matrix2D aFontMatrix( 1, 0,
124 0, 1 );
125 rendering::FontRequest aFontRequest( aFontInfo, 12.0, 0.0, aLocale );
126 uno::Sequence< beans::PropertyValue > aExtraFontProperties;
127 mxDefaultFont = xCanvas->createFont( aFontRequest, aExtraFontProperties, aFontMatrix );
128 if( !mxDefaultFont.is() )
129 fprintf( stderrstderr, "Failed to create font\n" );
130 }
131
132 void drawGrid()
133 {
134 long d, dIncr = maSize.Width() / 3;
135 for ( d = 0; d <= maSize.Width(); d += dIncr )
136 mxCanvas->drawLine( geometry::RealPoint2D( d, 0 ),
137 geometry::RealPoint2D( d, maSize.Height() ),
138 maViewState, maRenderState );
139 dIncr = maSize.Height() / 3;
140 for ( d = 0; d <= maSize.Height(); d += dIncr )
141 mxCanvas->drawLine( geometry::RealPoint2D( 0, d ),
142 geometry::RealPoint2D( maSize.Width(), d ),
143 maViewState, maRenderState );
144 }
145
146 void drawStringAt( OString aString, double x, double y )
147 {
148 rendering::StringContext aText;
149 aText.Text = OStringToOUString( aString, RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76)) );
150 aText.StartPosition = 0;
151 aText.Length = aString.getLength();
152 rendering::RenderState aRenderState( maRenderState );
153 aRenderState.AffineTransform.m02 += x;
154 aRenderState.AffineTransform.m12 += y;
155
156 mxCanvas->drawText( aText, mxDefaultFont, maViewState, aRenderState, 0);
157 }
158
159 void drawRect( tools::Rectangle rRect, const uno::Sequence< double > &aColor, int /*nWidth*/ )
160 {
161 uno::Sequence< geometry::RealPoint2D > aPoints(4);
162 uno::Reference< rendering::XLinePolyPolygon2D > xPoly;
163
164 aPoints[0] = geometry::RealPoint2D( rRect.Left(), rRect.Top() );
165 aPoints[1] = geometry::RealPoint2D( rRect.Left(), rRect.Bottom() );
166 aPoints[2] = geometry::RealPoint2D( rRect.Right(), rRect.Bottom() );
167 aPoints[3] = geometry::RealPoint2D( rRect.Right(), rRect.Top() );
168
169 uno::Sequence< uno::Sequence< geometry::RealPoint2D > > aPolys(1);
170 aPolys[0] = aPoints;
171 xPoly = mxDevice->createCompatibleLinePolyPolygon( aPolys );
172 xPoly->setClosed( 0, true );
173
174 rendering::RenderState aRenderState( maRenderState );
175 aRenderState.DeviceColor = aColor;
176 mxCanvas->drawPolyPolygon( xPoly, maViewState, aRenderState );
177 }
178
179 void translate( double x, double y)
180 {
181 maRenderState.AffineTransform.m02 += x;
182 maRenderState.AffineTransform.m12 += y;
183 }
184
185 void drawPolishDiamond( double center_x, double center_y)
186 {
187 const int VERTICES = 10;
188 const double RADIUS = 60.0;
189 int i, j;
190
191 rendering::RenderState maOldRenderState = maRenderState; // push
192 translate( center_x, center_y );
193
194 for (i = 0; i < VERTICES; i++)
195 {
196 double a = 2.0 * M_PI3.14159265358979323846 * i / VERTICES;
197 geometry::RealPoint2D aSrc( RADIUS * cos (a), RADIUS * sin (a) );
198
199 for (j = i + 1; j < VERTICES; j++)
200 {
201 a = 2.0 * M_PI3.14159265358979323846 * j / VERTICES;
202
203// FIXME: set cap_style to 'ROUND'
204 mxCanvas->drawLine( aSrc,
205 geometry::RealPoint2D( RADIUS * cos (a),
206 RADIUS * sin (a) ),
207 maViewState, maRenderState );
208 }
209 }
210
211 maRenderState = maOldRenderState; // pop
212 }
213
214 void drawHilbert( double anchor_x, double anchor_y )
215 {
216 const double SCALE=7.0;
217 const char hilbert[] = "urdrrulurulldluuruluurdrurddldrrruluurdrurddldrddlulldrdldrrurd";
218 int nLength = SAL_N_ELEMENTS( hilbert )(sizeof(sal_n_array_size(hilbert)));
219
220 uno::Sequence< geometry::RealPoint2D > aPoints( nLength );
221 uno::Reference< rendering::XLinePolyPolygon2D > xPoly;
222
223 aPoints[0] = geometry::RealPoint2D( anchor_x, anchor_y );
224 for (int i = 0; i < nLength; i++ )
225 {
226 switch( hilbert[i] )
227 {
228 case 'u':
229 aPoints[i+1] = geometry::RealPoint2D( aPoints[i].X,
230 aPoints[i].Y - SCALE );
231 break;
232 case 'd':
233 aPoints[i+1] = geometry::RealPoint2D( aPoints[i].X,
234 aPoints[i].Y + SCALE );
235 break;
236 case 'l':
237 aPoints[i+1] = geometry::RealPoint2D( aPoints[i].X - SCALE,
238 aPoints[i].Y );
239 break;
240 case 'r':
241 aPoints[i+1] = geometry::RealPoint2D( aPoints[i].X + SCALE,
242 aPoints[i].Y );
243 break;
244 }
245 }
246
247 uno::Sequence< uno::Sequence< geometry::RealPoint2D > > aPolys(1);
248 aPolys[0] = aPoints;
249
250 xPoly = mxDevice->createCompatibleLinePolyPolygon( aPolys );
251 xPoly->setClosed( 0, false );
252
253 rendering::RenderState aRenderState( maRenderState );
254 aRenderState.DeviceColor = maColorRed;
255// aRenderState.DeviceColor[3] = 0.5;
256 rendering::StrokeAttributes aStrokeAttrs;
257 aStrokeAttrs.StrokeWidth = 4.0;
258 aStrokeAttrs.MiterLimit = 2.0; // ?
259 aStrokeAttrs.StartCapType = rendering::PathCapType::BUTT;
260 aStrokeAttrs.EndCapType = rendering::PathCapType::BUTT;
261 aStrokeAttrs.JoinType = rendering::PathJoinType::MITER;
262 //fprintf( stderr, "FIXME: stroking a tools::PolyPolygon doesn't show up\n" );
263 //yes it does
264 mxCanvas->strokePolyPolygon( xPoly, maViewState, aRenderState, aStrokeAttrs );
265 // FIXME: do this instead:
266 //mxCanvas->drawPolyPolygon( xPoly, maViewState, aRenderState );
267 }
268
269 void drawTitle( OString aTitle )
270 {
271 // FIXME: text anchoring to be done
272 double nStringWidth = aTitle.getLength() * 8.0;
273 drawStringAt ( aTitle, (maBox.Width() - nStringWidth) / 2, 15 );
274 }
275
276 void drawRectangles()
277 {
278 rendering::RenderState maOldRenderState = maRenderState; // push
279
280 drawTitle( OString( "Rectangles" ) );
281
282 drawRect( tools::Rectangle( 20, 30, 70, 60 ), maColorRed, 8 );
283 // color mediumseagreen, stipple fill, outline black
284 drawRect( tools::Rectangle( 90, 40, 180, 100 ), maColorBlack, 4 );
285 // color steelblue, filled, no outline
286 drawRect( tools::Rectangle( 10, 80, 80, 140 ), maColorBlack, 1 );
287
288 maRenderState = maOldRenderState; // pop
289 }
290
291 void drawEllipses()
292 {
293 rendering::RenderState maOldRenderState = maRenderState; // push
294 translate( maBox.Width(), 0.0 );
295
296 drawTitle( OString( "Ellipses" ) );
297
298 const basegfx::B2DPoint aCenter( maBox.Width()*.5,
299 maBox.Height()*.5 );
300 const basegfx::B2DPoint aRadii( maBox.Width()*.3,
301 maBox.Height()*.3 );
302 const basegfx::B2DPolygon& rEllipse(
303 basegfx::utils::createPolygonFromEllipse( aCenter,
304 aRadii.getX(),
305 aRadii.getY() ));
306
307 uno::Reference< rendering::XPolyPolygon2D > xPoly(
308 basegfx::unotools::xPolyPolygonFromB2DPolygon(mxDevice,
309 rEllipse) );
310
311 rendering::StrokeAttributes aStrokeAttrs;
312 aStrokeAttrs.StrokeWidth = 4.0;
313 aStrokeAttrs.MiterLimit = 2.0; // ?
314 aStrokeAttrs.StartCapType = rendering::PathCapType::BUTT;
315 aStrokeAttrs.EndCapType = rendering::PathCapType::BUTT;
316 aStrokeAttrs.JoinType = rendering::PathJoinType::MITER;
317 mxCanvas->strokePolyPolygon( xPoly, maViewState, maRenderState, aStrokeAttrs );
318
319 maRenderState = maOldRenderState; // pop
320 }
321
322 void drawText()
323 {
324 rendering::RenderState maOldRenderState = maRenderState; // push
325 translate( maBox.Width() * 2.0, 0.0 );
326
327 drawTitle( OString( "Text" ) );
328
329 translate( 0.0,
330 maBox.Height() * .5 );
331 drawTitle( OString( "This is lame" ) );
332
333 maRenderState = maOldRenderState; // pop
334 }
335
336 void drawImages()
337 {
338 rendering::RenderState maOldRenderState = maRenderState; // push
339 translate( 0.0, maBox.Height() );
340
341 drawTitle( OString( "Images" ) );
342
343 uno::Reference< rendering::XBitmap > xBitmap(mxCanvas, uno::UNO_QUERY);
344
345 if( !xBitmap.is() )
346 return;
347
348 translate( maBox.Width()*0.1, maBox.Height()*0.2 );
349 maRenderState.AffineTransform.m00 *= 4.0/15;
350 maRenderState.AffineTransform.m11 *= 3.0/15;
351
352 mxCanvas->drawBitmap(xBitmap, maViewState, maRenderState);
353
354 // uno::Reference< rendering::XBitmap > xBitmap2( xBitmap->getScaledBitmap(geometry::RealSize2D(48, 48), false) );
355 // mxCanvas->drawBitmap(xBitmap2, maViewState, maRenderState); //yes, but where?
356 //cairo-canvas says:
357 //called CanvasHelper::getScaledBitmap, we return NULL, TODO
358 //Exception 'BitmapEx vclcanvas::tools::bitmapExFromXBitmap(const css::uno::Reference<css::rendering::XBitmap>&),
359 //bitmapExFromXBitmap(): could not extract BitmapEx' thrown
360
361 //vcl-canvas says:
362 //Exception 'BitmapEx vclcanvas::tools::bitmapExFromXBitmap(const css::uno::Reference<css::rendering::XBitmap>&),
363 //bitmapExFromXBitmap(): could not extract bitmap' thrown
364 // Thorsten says that this is a bug, and Thorsten never lies.
365
366 maRenderState = maOldRenderState; // pop
367 }
368
369 void drawLines()
370 {
371 rendering::RenderState maOldRenderState = maRenderState; // push
372 translate( maBox.Width(), maBox.Height() );
373
374 drawTitle( OString( "Lines" ) );
375
376 drawPolishDiamond( 70.0, 80.0 );
377 drawHilbert( 140.0, 140.0 );
378
379 maRenderState = maOldRenderState; // pop
380 }
381
382 void drawCurves()
383 {
384 rendering::RenderState maOldRenderState = maRenderState; // push
385 translate( maBox.Width() * 2.0, maBox.Height() );
386
387 drawTitle( OString( "Curves" ) );
388
389 translate( maBox.Width() * .5, maBox.Height() * .5 );
390
391 const double r= 30.0;
392 const int num_curves = 3;
393
394 //hacky hack hack
395 uno::Sequence< geometry::RealBezierSegment2D > aBeziers (num_curves);
396 uno::Reference< rendering::XBezierPolyPolygon2D > xPoly;
397
398 for (int i= 0; i < num_curves; i++)
399 aBeziers[i]= geometry::RealBezierSegment2D( r * cos(i*2*M_PI3.14159265358979323846/num_curves), //Px
400 r * sin(i*2*M_PI3.14159265358979323846/num_curves), //py
401 r * 2 * cos((i*2*M_PI3.14159265358979323846 + 2*M_PI3.14159265358979323846)/num_curves), //C1x
402 r * 2 * sin((i*2*M_PI3.14159265358979323846 + 2*M_PI3.14159265358979323846)/num_curves), //C1y
403 r * 2 * cos((i*2*M_PI3.14159265358979323846 + 2*M_PI3.14159265358979323846)/num_curves), //C2x
404 r * 2 * sin((i*2*M_PI3.14159265358979323846 + 2*M_PI3.14159265358979323846)/num_curves)); //C2y
405 uno::Sequence< uno::Sequence< geometry::RealBezierSegment2D > > aPolys(1);
406 aPolys[0] = aBeziers;
407 xPoly = mxDevice->createCompatibleBezierPolyPolygon(aPolys);
408 xPoly->setClosed( 0, true );
409 //uno::Reference< rendering::XBezierPolyPolygon2D> xPP( xPoly, uno::UNO_QUERY );
410 //compiles, but totally screws up. I think it is interpreting the bezier as a line
411
412 rendering::StrokeAttributes aStrokeAttrs;
413 aStrokeAttrs.StrokeWidth = 4.0;
414 aStrokeAttrs.MiterLimit = 2.0; // ?
415 aStrokeAttrs.StartCapType = rendering::PathCapType::BUTT;
416 aStrokeAttrs.EndCapType = rendering::PathCapType::BUTT;
417 aStrokeAttrs.JoinType = rendering::PathJoinType::MITER;
418 mxCanvas->strokePolyPolygon( xPoly, maViewState, maRenderState, aStrokeAttrs );
419 //you can't draw a BezierPolyPolygon2D with this, even though it is derived from it
420 //mxCanvas->drawPolyPolygon( xPoly, maViewState, maRenderState );
421
422 maRenderState = maOldRenderState; // pop
423 }
424
425 double gimmerand()
426 {
427 return comphelper::rng::uniform_real_distribution(0, 100);
428 }
429
430 void drawArcs()
431 {
432 rendering::RenderState maOldRenderState = maRenderState; // push
433 translate( 0.0, maBox.Height() * 2.0 );
434
435 drawTitle( OString( "Arcs" ) );
436
437
438 //begin hacks
439 //This stuff doesn't belong here, but probably in curves
440 //This stuff doesn't work in VCL b/c vcl doesn't do beziers
441 //Hah! Every time the window redraws, we do this
442 double bx;
443 double by;
444 bx= gimmerand();
445 by= gimmerand();
446
447 for (int i= 0; i < 1; i++)
448 {
449 double ax;
450 double ay;
451 //point a= point b;
452 ax= bx;
453 ay= by;
454 //point b= rand;
455 bx= gimmerand();
456 by= gimmerand();
457 double c1x= gimmerand();
458 double c1y= gimmerand();
459 double c2x= gimmerand();
460 double c2y= gimmerand();
461 maRenderState.DeviceColor = maColorRed;
462 mxCanvas->drawLine(geometry::RealPoint2D(ax, ay), geometry::RealPoint2D(c1x, c1y), maViewState, maRenderState);
463 mxCanvas->drawLine(geometry::RealPoint2D(c1x, c1y), geometry::RealPoint2D(c2x, c2y), maViewState, maRenderState);
464 mxCanvas->drawLine(geometry::RealPoint2D(bx, by), geometry::RealPoint2D(c2x, c2y), maViewState, maRenderState);
465 //draw from a to b
466 geometry::RealBezierSegment2D aBezierSegment(
467 ax, //Px
468 ay, //Py
469 c1x,
470 c1x,
471 c2x,
472 c2y
473 );
474 geometry::RealPoint2D aEndPoint(bx, by);
475 maRenderState.DeviceColor = maColorBlack;
476 mxCanvas->drawBezier(
477 aBezierSegment,
478 aEndPoint,
479 maViewState, maRenderState );
480 }
481 maRenderState = maOldRenderState; // pop
482 }
483
484
485 void drawRegularPolygon(double centerx, double centery, int sides, double r)
486 {
487 //hacky hack hack
488 uno::Sequence< geometry::RealPoint2D > aPoints (sides);
489 uno::Reference< rendering::XLinePolyPolygon2D > xPoly;
490
491 for (int i= 0; i < sides; i++)
492 {
493 aPoints[i]= geometry::RealPoint2D( centerx + r * cos(i*2 * M_PI3.14159265358979323846/sides),
494 centery + r * sin(i*2 * M_PI3.14159265358979323846/sides));
495 }
496 uno::Sequence< uno::Sequence< geometry::RealPoint2D > > aPolys(1);
497 aPolys[0] = aPoints;
498 xPoly = mxDevice->createCompatibleLinePolyPolygon( aPolys );
499 xPoly->setClosed( 0, true );
500 rendering::RenderState aRenderState( maRenderState );
501 aRenderState.DeviceColor = maColorRed;
502 mxCanvas->drawPolyPolygon( xPoly, maViewState, aRenderState);
503 mxCanvas->fillPolyPolygon( xPoly,
504 maViewState,
505 aRenderState );
506 }
507
508 void drawPolygons()
509 {
510 rendering::RenderState maOldRenderState = maRenderState; // push
511 translate( maBox.Width() * 1.0, maBox.Height() * 2.0 );
512
513 drawTitle( OString( "Polygons" ) );
514
515 int sides= 3;
516 for (int i= 1; i <= 4; i++)
517 {
518 drawRegularPolygon(35*i, 35, sides, 15);
519 sides++;
520 }
521
522 maRenderState = maOldRenderState; // pop
523 }
524
525 void drawWidgets() // FIXME: prolly makes no sense
526 {
527 rendering::RenderState maOldRenderState = maRenderState; // push
528 translate( maBox.Width() * 2.0, maBox.Height() * 2.0 );
529
530 drawTitle( OString( "Widgets" ) );
531
532 maRenderState = maOldRenderState; // pop
533 }
534};
535
536}
537
538void TestWindow::Paint(vcl::RenderContext&, const tools::Rectangle&)
539{
540 try
541 {
542 uno::Reference< rendering::XCanvas > xVDevCanvas( GetCanvas(),
543 uno::UNO_SET_THROW );
544 uno::Reference< rendering::XGraphicDevice > xVDevDevice( xVDevCanvas->getDevice(),
545 uno::UNO_SET_THROW );
546 DemoRenderer aVDevRenderer( xVDevDevice, xVDevCanvas, GetSizePixel());
547 xVDevCanvas->clear();
548 aVDevRenderer.drawGrid();
549 aVDevRenderer.drawRectangles();
550 aVDevRenderer.drawEllipses();
551 aVDevRenderer.drawText();
552 aVDevRenderer.drawLines();
553 aVDevRenderer.drawCurves();
554 aVDevRenderer.drawArcs();
555 aVDevRenderer.drawPolygons();
556
557 uno::Reference< rendering::XCanvas > xCanvas( GetSpriteCanvas(),
558 uno::UNO_QUERY_THROW );
559 uno::Reference< rendering::XGraphicDevice > xDevice( xCanvas->getDevice(),
560 uno::UNO_SET_THROW );
561
562 DemoRenderer aRenderer( xDevice, xCanvas, GetSizePixel() );
563 xCanvas->clear();
564 aRenderer.drawGrid();
565 aRenderer.drawRectangles();
566 aRenderer.drawEllipses();
567 aRenderer.drawText();
568 aRenderer.drawLines();
569 aRenderer.drawCurves();
570 aRenderer.drawArcs();
571 aRenderer.drawPolygons();
572 aRenderer.drawWidgets();
573 aRenderer.drawImages();
574
575 // check whether virdev actually contained something
576 uno::Reference< rendering::XBitmap > xBitmap(xVDevCanvas, uno::UNO_QUERY);
577 if( !xBitmap.is() )
578 return;
579
580 aRenderer.maRenderState.AffineTransform.m02 += 100;
581 aRenderer.maRenderState.AffineTransform.m12 += 100;
582 xCanvas->drawBitmap(xBitmap, aRenderer.maViewState, aRenderer.maRenderState);
583
584 uno::Reference< rendering::XSpriteCanvas > xSpriteCanvas( xCanvas,
585 uno::UNO_QUERY );
586 if( xSpriteCanvas.is() )
587 xSpriteCanvas->updateScreen( true ); // without
588 // updateScreen(),
589 // nothing is
590 // visible
591 }
592 catch (const uno::Exception &e)
593 {
594 fprintf( stderrstderr, "Exception '%s' thrown\n" ,
595 OUStringToOString( e.Message, RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76)) ).getStr() );
596 }
597}
598
599namespace {
600
601class DemoApp : public Application
602{
603public:
604 virtual int Main() override;
605 virtual void Exception(ExceptionCategory nCategory) override;
606
607protected:
608 void Init() override;
609 void DeInit() override;
610};
611
612}
613
614int DemoApp::Main()
615{
616 bool bHelp = false;
617
618 for( unsigned int i = 0; i < GetCommandLineParamCount(); i++ )
1
Assuming the condition is false
2
Loop condition is false. Execution continues on line 626
619 {
620 OUString aParam = GetCommandLineParam( i );
621
622 if( aParam == "--help" || aParam == "-h" )
623 bHelp = true;
624 }
625
626 if( bHelp
2.1
'bHelp' is false
2.1
'bHelp' is false
2.1
'bHelp' is false
2.1
'bHelp' is false
)
3
Taking false branch
627 {
628 PrintHelp();
629 return 1;
630 }
631
632 ScopedVclPtr<TestWindow> aWindow = VclPtr<TestWindow>::Create();
4
Calling 'VclPtr::Create'
6
Returned allocated memory
7
Calling implicit destructor for 'VclPtr<(anonymous namespace)::TestWindow>'
8
Calling '~Reference'
15
Returning from '~Reference'
16
Returning from destructor for 'VclPtr<(anonymous namespace)::TestWindow>'
633 aWindow->Show();
17
Calling 'VclPtr::operator->'
634
635 Application::Execute();
636 return 0;
637}
638
639void DemoApp::Exception( ExceptionCategory )
640{
641}
642
643void DemoApp::Init()
644{
645 try
646 {
647 uno::Reference<uno::XComponentContext> xComponentContext
648 = ::cppu::defaultBootstrap_InitialComponentContext();
649 uno::Reference<lang::XMultiServiceFactory> xMSF;
650 xMSF.set(xComponentContext->getServiceManager(), uno::UNO_QUERY);
651 if(!xMSF.is())
652 Application::Abort("Bootstrap failure - no service manager");
653
654 ::comphelper::setProcessServiceFactory(xMSF);
655 }
656 catch (const uno::Exception &e)
657 {
658 Application::Abort("Bootstrap exception " + e.Message);
659 }
660}
661
662void DemoApp::DeInit()
663{
664 uno::Reference< lang::XComponent >(
665 comphelper::getProcessComponentContext(),
666 uno::UNO_QUERY_THROW)-> dispose();
667 ::comphelper::setProcessServiceFactory(nullptr);
668}
669
670void vclmain::createApplication()
671{
672 static DemoApp aApp;
673}
674
675// TODO
676// - bouncing clip-rectangle mode - bounce a clip-rect around the window...
677// - complete all of pre-existing canvas bits
678// - affine transform tweakage...
679
680/* 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 );
5
Memory is allocated
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
18
Calling 'Reference::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 ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
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
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
113 m_pBody->release();
10
Calling 'VclReferenceBase::release'
14
Returning; memory was released
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)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
19
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
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