File: | home/maarten/src/libreoffice/core/include/rtl/ref.hxx |
Warning: | line 192, column 9 Use of memory after it is freed |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ | |||
2 | /* | |||
3 | * This file is part of the LibreOffice project. | |||
4 | * | |||
5 | * This Source Code Form is subject to the terms of the Mozilla Public | |||
6 | * License, v. 2.0. If a copy of the MPL was not distributed with this | |||
7 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. | |||
8 | * | |||
9 | * This file incorporates work covered by the following license notice: | |||
10 | * | |||
11 | * Licensed to the Apache Software Foundation (ASF) under one or more | |||
12 | * contributor license agreements. See the NOTICE file distributed | |||
13 | * with this work for additional information regarding copyright | |||
14 | * ownership. The ASF licenses this file to you under the Apache | |||
15 | * License, Version 2.0 (the "License"); you may not use this file | |||
16 | * except in compliance with the License. You may obtain a copy of | |||
17 | * the License at http://www.apache.org/licenses/LICENSE-2.0 . | |||
18 | */ | |||
19 | ||||
20 | #include <sal/config.h> | |||
21 | ||||
22 | #include <tools/gen.hxx> | |||
23 | #include <vcl/outdev.hxx> | |||
24 | #include <vcl/alpha.hxx> | |||
25 | #include <vcl/virdev.hxx> | |||
26 | #include <vcl/GraphicObject.hxx> | |||
27 | #include <memory> | |||
28 | ||||
29 | struct ImplTileInfo | |||
30 | { | |||
31 | ImplTileInfo() : aTileTopLeft(), aNextTileTopLeft(), aTileSizePixel(), nTilesEmptyX(0), nTilesEmptyY(0) {} | |||
32 | ||||
33 | Point aTileTopLeft; // top, left position of the rendered tile | |||
34 | Point aNextTileTopLeft; // top, left position for next recursion | |||
35 | // level's tile | |||
36 | Size aTileSizePixel; // size of the generated tile (might | |||
37 | // differ from | |||
38 | // aNextTileTopLeft-aTileTopLeft, because | |||
39 | // this is nExponent*prevTileSize. The | |||
40 | // generated tile is always nExponent | |||
41 | // times the previous tile, such that it | |||
42 | // can be used in the next stage. The | |||
43 | // required area coverage is often | |||
44 | // less. The extraneous area covered is | |||
45 | // later overwritten by the next stage) | |||
46 | int nTilesEmptyX; // number of original tiles empty right of | |||
47 | // this tile. This counts from | |||
48 | // aNextTileTopLeft, i.e. the additional | |||
49 | // area covered by aTileSizePixel is not | |||
50 | // considered here. This is for | |||
51 | // unification purposes, as the iterative | |||
52 | // calculation of the next level's empty | |||
53 | // tiles has to be based on this value. | |||
54 | int nTilesEmptyY; // as above, for Y | |||
55 | }; | |||
56 | ||||
57 | ||||
58 | bool GraphicObject::ImplRenderTempTile( VirtualDevice& rVDev, | |||
59 | int nNumTilesX, int nNumTilesY, | |||
60 | const Size& rTileSizePixel, | |||
61 | const GraphicAttr* pAttr ) | |||
62 | { | |||
63 | // how many tiles to generate per recursion step | |||
64 | const int nExponent = 2; | |||
65 | ||||
66 | // determine MSB factor | |||
67 | int nMSBFactor( 1 ); | |||
68 | while( nNumTilesX / nMSBFactor != 0 || | |||
69 | nNumTilesY / nMSBFactor != 0 ) | |||
70 | { | |||
71 | nMSBFactor *= nExponent; | |||
72 | } | |||
73 | ||||
74 | // one less | |||
75 | if(nMSBFactor > 1) | |||
76 | { | |||
77 | nMSBFactor /= nExponent; | |||
78 | } | |||
79 | ImplTileInfo aTileInfo; | |||
80 | ||||
81 | // #105229# Switch off mapping (converting to logic and back to | |||
82 | // pixel might cause roundoff errors) | |||
83 | bool bOldMap( rVDev.IsMapModeEnabled() ); | |||
84 | rVDev.EnableMapMode( false ); | |||
85 | ||||
86 | bool bRet( ImplRenderTileRecursive( rVDev, nExponent, nMSBFactor, nNumTilesX, nNumTilesY, | |||
87 | nNumTilesX, nNumTilesY, rTileSizePixel, pAttr, aTileInfo ) ); | |||
88 | ||||
89 | rVDev.EnableMapMode( bOldMap ); | |||
90 | ||||
91 | return bRet; | |||
92 | } | |||
93 | ||||
94 | // define for debug drawings | |||
95 | //#define DBG_TEST | |||
96 | ||||
97 | // see header comment. this works similar to base conversion of a | |||
98 | // number, i.e. if the exponent is 10, then the number for every tile | |||
99 | // size is given by the decimal place of the corresponding decimal | |||
100 | // representation. | |||
101 | bool GraphicObject::ImplRenderTileRecursive( VirtualDevice& rVDev, int nExponent, int nMSBFactor, | |||
102 | int nNumOrigTilesX, int nNumOrigTilesY, | |||
103 | int nRemainderTilesX, int nRemainderTilesY, | |||
104 | const Size& rTileSizePixel, const GraphicAttr* pAttr, | |||
105 | ImplTileInfo& rTileInfo ) | |||
106 | { | |||
107 | // gets loaded with our tile bitmap | |||
108 | std::unique_ptr<GraphicObject> xTmpGraphic; | |||
109 | GraphicObject* pTileGraphic; | |||
110 | ||||
111 | // stores a flag that renders the zero'th tile position | |||
112 | // (i.e. (0,0)+rCurrPos) only if we're at the bottom of the | |||
113 | // recursion stack. All other position already have that tile | |||
114 | // rendered, because the lower levels painted their generated tile | |||
115 | // there. | |||
116 | bool bNoFirstTileDraw( false ); | |||
117 | ||||
118 | // what's left when we're done with our tile size | |||
119 | const int nNewRemainderX( nRemainderTilesX % nMSBFactor ); | |||
120 | const int nNewRemainderY( nRemainderTilesY % nMSBFactor ); | |||
121 | ||||
122 | // gets filled out from the recursive call with info of what's | |||
123 | // been generated | |||
124 | ImplTileInfo aTileInfo; | |||
125 | ||||
126 | // check for recursion's end condition: LSB place reached? | |||
127 | if( nMSBFactor == 1 ) | |||
128 | { | |||
129 | pTileGraphic = this; | |||
130 | ||||
131 | // set initial tile size -> orig size | |||
132 | aTileInfo.aTileSizePixel = rTileSizePixel; | |||
133 | aTileInfo.nTilesEmptyX = nNumOrigTilesX; | |||
134 | aTileInfo.nTilesEmptyY = nNumOrigTilesY; | |||
135 | } | |||
136 | else if( ImplRenderTileRecursive( rVDev, nExponent, nMSBFactor/nExponent, | |||
137 | nNumOrigTilesX, nNumOrigTilesY, | |||
138 | nNewRemainderX, nNewRemainderY, | |||
139 | rTileSizePixel, pAttr, aTileInfo ) ) | |||
140 | { | |||
141 | // extract generated tile -> see comment on the first loop below | |||
142 | BitmapEx aTileBitmap( rVDev.GetBitmap( aTileInfo.aTileTopLeft, aTileInfo.aTileSizePixel ) ); | |||
143 | ||||
144 | xTmpGraphic.reset(new GraphicObject(aTileBitmap)); | |||
145 | pTileGraphic = xTmpGraphic.get(); | |||
146 | ||||
147 | // fill stripes left over from upstream levels: | |||
148 | ||||
149 | // x0000 | |||
150 | // 0 | |||
151 | // 0 | |||
152 | // 0 | |||
153 | // 0 | |||
154 | ||||
155 | // where x denotes the place filled by our recursive predecessors | |||
156 | ||||
157 | // check whether we have to fill stripes here. Although not | |||
158 | // obvious, there is one case where we can skip this step: if | |||
159 | // the previous recursion level (the one who filled our | |||
160 | // aTileInfo) had zero area to fill, then there are no white | |||
161 | // stripes left, naturally. This happens if the digit | |||
162 | // associated to that level has a zero, and can be checked via | |||
163 | // aTileTopLeft==aNextTileTopLeft. | |||
164 | if( aTileInfo.aTileTopLeft != aTileInfo.aNextTileTopLeft ) | |||
165 | { | |||
166 | // now fill one row from aTileInfo.aNextTileTopLeft.X() all | |||
167 | // the way to the right | |||
168 | // current output position while drawing | |||
169 | Point aCurrPos(aTileInfo.aNextTileTopLeft.X(), aTileInfo.aTileTopLeft.Y()); | |||
170 | for (int nX=0; nX < aTileInfo.nTilesEmptyX; nX += nMSBFactor) | |||
171 | { | |||
172 | if (!pTileGraphic->Draw(&rVDev, aCurrPos, aTileInfo.aTileSizePixel, pAttr)) | |||
173 | return false; | |||
174 | ||||
175 | aCurrPos.AdjustX(aTileInfo.aTileSizePixel.Width() ); | |||
176 | } | |||
177 | ||||
178 | #ifdef DBG_TEST | |||
179 | // rVDev.SetFillCOL_WHITE ); | |||
180 | rVDev.SetFillColor(); | |||
181 | rVDev.SetLineColor( Color( 255 * nExponent / nMSBFactor, 255 - 255 * nExponent / nMSBFactor, 128 - 255 * nExponent / nMSBFactor ) ); | |||
182 | rVDev.DrawEllipse( tools::Rectangle(aTileInfo.aNextTileTopLeft.X(), aTileInfo.aTileTopLeft.Y(), | |||
183 | aTileInfo.aNextTileTopLeft.X() - 1 + (aTileInfo.nTilesEmptyX/nMSBFactor)*aTileInfo.aTileSizePixel.Width(), | |||
184 | aTileInfo.aTileTopLeft.Y() + aTileInfo.aTileSizePixel.Height() - 1) ); | |||
185 | #endif | |||
186 | ||||
187 | // now fill one column from aTileInfo.aNextTileTopLeft.Y() all | |||
188 | // the way to the bottom | |||
189 | aCurrPos.setX( aTileInfo.aTileTopLeft.X() ); | |||
190 | aCurrPos.setY( aTileInfo.aNextTileTopLeft.Y() ); | |||
191 | for (int nY=0; nY < aTileInfo.nTilesEmptyY; nY += nMSBFactor) | |||
192 | { | |||
193 | if (!pTileGraphic->Draw(&rVDev, aCurrPos, aTileInfo.aTileSizePixel, pAttr)) | |||
194 | return false; | |||
195 | ||||
196 | aCurrPos.AdjustY(aTileInfo.aTileSizePixel.Height() ); | |||
197 | } | |||
198 | ||||
199 | #ifdef DBG_TEST | |||
200 | rVDev.DrawEllipse( tools::Rectangle(aTileInfo.aTileTopLeft.X(), aTileInfo.aNextTileTopLeft.Y(), | |||
201 | aTileInfo.aTileTopLeft.X() + aTileInfo.aTileSizePixel.Width() - 1, | |||
202 | aTileInfo.aNextTileTopLeft.Y() - 1 + (aTileInfo.nTilesEmptyY/nMSBFactor)*aTileInfo.aTileSizePixel.Height()) ); | |||
203 | #endif | |||
204 | } | |||
205 | else | |||
206 | { | |||
207 | // Thought that aTileInfo.aNextTileTopLeft tile has always | |||
208 | // been drawn already, but that's wrong: typically, | |||
209 | // _parts_ of that tile have been drawn, since the | |||
210 | // previous level generated the tile there. But when | |||
211 | // aTileInfo.aNextTileTopLeft!=aTileInfo.aTileTopLeft, the | |||
212 | // difference between these two values is missing in the | |||
213 | // lower right corner of this first tile. So, can do that | |||
214 | // only here. | |||
215 | bNoFirstTileDraw = true; | |||
216 | } | |||
217 | } | |||
218 | else | |||
219 | { | |||
220 | return false; | |||
221 | } | |||
222 | ||||
223 | // calc number of original tiles in our drawing area without | |||
224 | // remainder | |||
225 | nRemainderTilesX -= nNewRemainderX; | |||
226 | nRemainderTilesY -= nNewRemainderY; | |||
227 | ||||
228 | // fill tile info for calling method | |||
229 | rTileInfo.aTileTopLeft = aTileInfo.aNextTileTopLeft; | |||
230 | rTileInfo.aNextTileTopLeft = Point( rTileInfo.aTileTopLeft.X() + rTileSizePixel.Width()*nRemainderTilesX, | |||
231 | rTileInfo.aTileTopLeft.Y() + rTileSizePixel.Height()*nRemainderTilesY ); | |||
232 | rTileInfo.aTileSizePixel = Size( rTileSizePixel.Width()*nMSBFactor*nExponent, | |||
233 | rTileSizePixel.Height()*nMSBFactor*nExponent ); | |||
234 | rTileInfo.nTilesEmptyX = aTileInfo.nTilesEmptyX - nRemainderTilesX; | |||
235 | rTileInfo.nTilesEmptyY = aTileInfo.nTilesEmptyY - nRemainderTilesY; | |||
236 | ||||
237 | // init output position | |||
238 | Point aCurrPos = aTileInfo.aNextTileTopLeft; | |||
239 | ||||
240 | // fill our drawing area. Fill possibly more, to create the next | |||
241 | // bigger tile size -> see bitmap extraction above. This does no | |||
242 | // harm, since everything right or below our actual area is | |||
243 | // overdrawn by our caller. Just in case we're in the last level, | |||
244 | // we don't draw beyond the right or bottom border. | |||
245 | for (int nY=0; nY < aTileInfo.nTilesEmptyY && nY < nExponent*nMSBFactor; nY += nMSBFactor) | |||
246 | { | |||
247 | aCurrPos.setX( aTileInfo.aNextTileTopLeft.X() ); | |||
248 | ||||
249 | for (int nX=0; nX < aTileInfo.nTilesEmptyX && nX < nExponent*nMSBFactor; nX += nMSBFactor) | |||
250 | { | |||
251 | if( bNoFirstTileDraw ) | |||
252 | bNoFirstTileDraw = false; // don't draw first tile position | |||
253 | else if (!pTileGraphic->Draw(&rVDev, aCurrPos, aTileInfo.aTileSizePixel, pAttr)) | |||
254 | return false; | |||
255 | ||||
256 | aCurrPos.AdjustX(aTileInfo.aTileSizePixel.Width() ); | |||
257 | } | |||
258 | ||||
259 | aCurrPos.AdjustY(aTileInfo.aTileSizePixel.Height() ); | |||
260 | } | |||
261 | ||||
262 | #ifdef DBG_TEST | |||
263 | // rVDev.SetFillCOL_WHITE ); | |||
264 | rVDev.SetFillColor(); | |||
265 | rVDev.SetLineColor( Color( 255 * nExponent / nMSBFactor, 255 - 255 * nExponent / nMSBFactor, 128 - 255 * nExponent / nMSBFactor ) ); | |||
266 | rVDev.DrawRect( tools::Rectangle((rTileInfo.aTileTopLeft.X())*rTileSizePixel.Width(), | |||
267 | (rTileInfo.aTileTopLeft.Y())*rTileSizePixel.Height(), | |||
268 | (rTileInfo.aNextTileTopLeft.X())*rTileSizePixel.Width()-1, | |||
269 | (rTileInfo.aNextTileTopLeft.Y())*rTileSizePixel.Height()-1) ); | |||
270 | #endif | |||
271 | ||||
272 | return true; | |||
273 | } | |||
274 | ||||
275 | bool GraphicObject::ImplDrawTiled( OutputDevice* pOut, const tools::Rectangle& rArea, const Size& rSizePixel, | |||
276 | const Size& rOffset, const GraphicAttr* pAttr, int nTileCacheSize1D ) | |||
277 | { | |||
278 | const MapMode aOutMapMode( pOut->GetMapMode() ); | |||
279 | const MapMode aMapMode( aOutMapMode.GetMapUnit(), Point(), aOutMapMode.GetScaleX(), aOutMapMode.GetScaleY() ); | |||
280 | bool bRet( false ); | |||
281 | ||||
282 | // #i42643# Casting to Int64, to avoid integer overflow for | |||
283 | // huge-DPI output devices | |||
284 | if( GetGraphic().GetType() == GraphicType::Bitmap && | |||
| ||||
285 | static_cast<sal_Int64>(rSizePixel.Width()) * rSizePixel.Height() < | |||
286 | static_cast<sal_Int64>(nTileCacheSize1D)*nTileCacheSize1D ) | |||
287 | { | |||
288 | // First combine very small bitmaps into a larger tile | |||
289 | ||||
290 | ||||
291 | ScopedVclPtrInstance< VirtualDevice > aVDev; | |||
292 | const int nNumTilesInCacheX( (nTileCacheSize1D + rSizePixel.Width()-1) / rSizePixel.Width() ); | |||
293 | const int nNumTilesInCacheY( (nTileCacheSize1D + rSizePixel.Height()-1) / rSizePixel.Height() ); | |||
294 | ||||
295 | aVDev->SetOutputSizePixel( Size( nNumTilesInCacheX*rSizePixel.Width(), | |||
296 | nNumTilesInCacheY*rSizePixel.Height() ) ); | |||
297 | aVDev->SetMapMode( aMapMode ); | |||
298 | ||||
299 | // draw bitmap content | |||
300 | if( ImplRenderTempTile( *aVDev, nNumTilesInCacheX, | |||
301 | nNumTilesInCacheY, rSizePixel, pAttr ) ) | |||
302 | { | |||
303 | BitmapEx aTileBitmap( aVDev->GetBitmap( Point(0,0), aVDev->GetOutputSize() ) ); | |||
304 | ||||
305 | // draw alpha content, if any | |||
306 | if( IsTransparent() ) | |||
307 | { | |||
308 | GraphicObject aAlphaGraphic; | |||
309 | ||||
310 | if( GetGraphic().IsAlpha() ) | |||
311 | aAlphaGraphic.SetGraphic(BitmapEx(GetGraphic().GetBitmapEx().GetAlpha().GetBitmap())); | |||
312 | else | |||
313 | aAlphaGraphic.SetGraphic(BitmapEx(GetGraphic().GetBitmapEx().GetMask())); | |||
314 | ||||
315 | if( aAlphaGraphic.ImplRenderTempTile( *aVDev, nNumTilesInCacheX, | |||
316 | nNumTilesInCacheY, rSizePixel, pAttr ) ) | |||
317 | { | |||
318 | // Combine bitmap and alpha/mask | |||
319 | if( GetGraphic().IsAlpha() ) | |||
320 | aTileBitmap = BitmapEx( aTileBitmap.GetBitmap(), | |||
321 | AlphaMask( aVDev->GetBitmap( Point(0,0), aVDev->GetOutputSize() ) ) ); | |||
322 | else | |||
323 | aTileBitmap = BitmapEx( aTileBitmap.GetBitmap(), | |||
324 | aVDev->GetBitmap( Point(0,0), aVDev->GetOutputSize() ).CreateMask( COL_WHITE ) ); | |||
325 | } | |||
326 | } | |||
327 | ||||
328 | // paint generated tile | |||
329 | GraphicObject aTmpGraphic( aTileBitmap ); | |||
330 | bRet = aTmpGraphic.ImplDrawTiled( pOut, rArea, | |||
331 | aTileBitmap.GetSizePixel(), | |||
332 | rOffset, pAttr, nTileCacheSize1D ); | |||
333 | } | |||
334 | } | |||
335 | else | |||
336 | { | |||
337 | const Size aOutOffset( pOut->LogicToPixel( rOffset, aOutMapMode ) ); | |||
338 | const tools::Rectangle aOutArea( pOut->LogicToPixel( rArea, aOutMapMode ) ); | |||
339 | ||||
340 | // number of invisible (because out-of-area) tiles | |||
341 | int nInvisibleTilesX; | |||
342 | int nInvisibleTilesY; | |||
343 | ||||
344 | // round towards -infty for negative offset | |||
345 | if( aOutOffset.Width() < 0 ) | |||
346 | nInvisibleTilesX = (aOutOffset.Width() - rSizePixel.Width() + 1) / rSizePixel.Width(); | |||
347 | else | |||
348 | nInvisibleTilesX = aOutOffset.Width() / rSizePixel.Width(); | |||
349 | ||||
350 | // round towards -infty for negative offset | |||
351 | if( aOutOffset.Height() < 0 ) | |||
352 | nInvisibleTilesY = (aOutOffset.Height() - rSizePixel.Height() + 1) / rSizePixel.Height(); | |||
353 | else | |||
354 | nInvisibleTilesY = aOutOffset.Height() / rSizePixel.Height(); | |||
355 | ||||
356 | // origin from where to 'virtually' start drawing in pixel | |||
357 | const Point aOutOrigin( pOut->LogicToPixel( Point( rArea.Left() - rOffset.Width(), | |||
358 | rArea.Top() - rOffset.Height() ) ) ); | |||
359 | // position in pixel from where to really start output | |||
360 | const Point aOutStart( aOutOrigin.X() + nInvisibleTilesX*rSizePixel.Width(), | |||
361 | aOutOrigin.Y() + nInvisibleTilesY*rSizePixel.Height() ); | |||
362 | ||||
363 | pOut->Push( PushFlags::CLIPREGION ); | |||
364 | pOut->IntersectClipRegion( rArea ); | |||
365 | ||||
366 | // Paint all tiles | |||
367 | ||||
368 | ||||
369 | bRet = ImplDrawTiled( *pOut, aOutStart, | |||
370 | (aOutArea.GetWidth() + aOutArea.Left() - aOutStart.X() + rSizePixel.Width() - 1) / rSizePixel.Width(), | |||
371 | (aOutArea.GetHeight() + aOutArea.Top() - aOutStart.Y() + rSizePixel.Height() - 1) / rSizePixel.Height(), | |||
372 | rSizePixel, pAttr ); | |||
373 | ||||
374 | pOut->Pop(); | |||
375 | } | |||
376 | ||||
377 | return bRet; | |||
378 | } | |||
379 | ||||
380 | bool GraphicObject::ImplDrawTiled( OutputDevice& rOut, const Point& rPosPixel, | |||
381 | int nNumTilesX, int nNumTilesY, | |||
382 | const Size& rTileSizePixel, const GraphicAttr* pAttr ) | |||
383 | { | |||
384 | Point aCurrPos( rPosPixel ); | |||
385 | Size aTileSizeLogic( rOut.PixelToLogic( rTileSizePixel ) ); | |||
386 | int nX, nY; | |||
387 | ||||
388 | // #107607# Use logical coordinates for metafile playing, too | |||
389 | bool bDrawInPixel( rOut.GetConnectMetaFile() == nullptr && GraphicType::Bitmap == GetType() ); | |||
390 | bool bRet = false; | |||
391 | ||||
392 | // #105229# Switch off mapping (converting to logic and back to | |||
393 | // pixel might cause roundoff errors) | |||
394 | bool bOldMap( rOut.IsMapModeEnabled() ); | |||
395 | ||||
396 | if( bDrawInPixel ) | |||
397 | rOut.EnableMapMode( false ); | |||
398 | ||||
399 | for( nY=0; nY < nNumTilesY; ++nY ) | |||
400 | { | |||
401 | aCurrPos.setX( rPosPixel.X() ); | |||
402 | ||||
403 | for( nX=0; nX < nNumTilesX; ++nX ) | |||
404 | { | |||
405 | // #105229# work with pixel coordinates here, mapping is disabled! | |||
406 | // #104004# don't disable mapping for metafile recordings | |||
407 | // #108412# don't quit the loop if one draw fails | |||
408 | ||||
409 | // update return value. This method should return true, if | |||
410 | // at least one of the looped Draws succeeded. | |||
411 | bRet |= Draw( &rOut, | |||
412 | bDrawInPixel ? aCurrPos : rOut.PixelToLogic( aCurrPos ), | |||
413 | bDrawInPixel ? rTileSizePixel : aTileSizeLogic, | |||
414 | pAttr ); | |||
415 | ||||
416 | aCurrPos.AdjustX(rTileSizePixel.Width() ); | |||
417 | } | |||
418 | ||||
419 | aCurrPos.AdjustY(rTileSizePixel.Height() ); | |||
420 | } | |||
421 | ||||
422 | if( bDrawInPixel ) | |||
423 | rOut.EnableMapMode( bOldMap ); | |||
424 | ||||
425 | return bRet; | |||
426 | } | |||
427 | ||||
428 | void GraphicObject::ImplTransformBitmap( BitmapEx& rBmpEx, | |||
429 | const GraphicAttr& rAttr, | |||
430 | const Size& rCropLeftTop, | |||
431 | const Size& rCropRightBottom, | |||
432 | const tools::Rectangle& rCropRect, | |||
433 | const Size& rDstSize, | |||
434 | bool bEnlarge ) const | |||
435 | { | |||
436 | // #107947# Extracted from svdograf.cxx | |||
437 | ||||
438 | // #104115# Crop the bitmap | |||
439 | if( rAttr.IsCropped() ) | |||
440 | { | |||
441 | rBmpEx.Crop( rCropRect ); | |||
442 | ||||
443 | // #104115# Negative crop sizes mean: enlarge bitmap and pad | |||
444 | if( bEnlarge && ( | |||
445 | rCropLeftTop.Width() < 0 || | |||
446 | rCropLeftTop.Height() < 0 || | |||
447 | rCropRightBottom.Width() < 0 || | |||
448 | rCropRightBottom.Height() < 0 ) ) | |||
449 | { | |||
450 | Size aBmpSize( rBmpEx.GetSizePixel() ); | |||
451 | sal_Int32 nPadLeft( rCropLeftTop.Width() < 0 ? -rCropLeftTop.Width() : 0 ); | |||
452 | sal_Int32 nPadTop( rCropLeftTop.Height() < 0 ? -rCropLeftTop.Height() : 0 ); | |||
453 | sal_Int32 nPadTotalWidth( aBmpSize.Width() + nPadLeft + (rCropRightBottom.Width() < 0 ? -rCropRightBottom.Width() : 0) ); | |||
454 | sal_Int32 nPadTotalHeight( aBmpSize.Height() + nPadTop + (rCropRightBottom.Height() < 0 ? -rCropRightBottom.Height() : 0) ); | |||
455 | ||||
456 | BitmapEx aBmpEx2; | |||
457 | ||||
458 | if( rBmpEx.IsTransparent() ) | |||
459 | { | |||
460 | if( rBmpEx.IsAlpha() ) | |||
461 | aBmpEx2 = BitmapEx( rBmpEx.GetBitmap(), rBmpEx.GetAlpha() ); | |||
462 | else | |||
463 | aBmpEx2 = BitmapEx( rBmpEx.GetBitmap(), rBmpEx.GetMask() ); | |||
464 | } | |||
465 | else | |||
466 | { | |||
467 | // #104115# Generate mask bitmap and init to zero | |||
468 | Bitmap aMask( aBmpSize, 1 ); | |||
469 | aMask.Erase( Color(0,0,0) ); | |||
470 | ||||
471 | // #104115# Always generate transparent bitmap, we need the border transparent | |||
472 | aBmpEx2 = BitmapEx( rBmpEx.GetBitmap(), aMask ); | |||
473 | ||||
474 | // #104115# Add opaque mask to source bitmap, otherwise the destination remains transparent | |||
475 | rBmpEx = aBmpEx2; | |||
476 | } | |||
477 | ||||
478 | aBmpEx2.Scale(Size(nPadTotalWidth, nPadTotalHeight)); | |||
479 | aBmpEx2.Erase( Color(0xFF,0,0,0) ); | |||
480 | aBmpEx2.CopyPixel( tools::Rectangle( Point(nPadLeft, nPadTop), aBmpSize ), tools::Rectangle( Point(0, 0), aBmpSize ), &rBmpEx ); | |||
481 | rBmpEx = aBmpEx2; | |||
482 | } | |||
483 | } | |||
484 | ||||
485 | const Size aSizePixel( rBmpEx.GetSizePixel() ); | |||
486 | ||||
487 | if( rAttr.GetRotation() == 0 || IsAnimated() ) | |||
488 | return; | |||
489 | ||||
490 | if( !(aSizePixel.Width() && aSizePixel.Height() && rDstSize.Width() && rDstSize.Height()) ) | |||
491 | return; | |||
492 | ||||
493 | double fSrcWH = static_cast<double>(aSizePixel.Width()) / aSizePixel.Height(); | |||
494 | double fDstWH = static_cast<double>(rDstSize.Width()) / rDstSize.Height(); | |||
495 | double fScaleX = 1.0, fScaleY = 1.0; | |||
496 | ||||
497 | // always choose scaling to shrink bitmap | |||
498 | if( fSrcWH < fDstWH ) | |||
499 | fScaleY = aSizePixel.Width() / ( fDstWH * aSizePixel.Height() ); | |||
500 | else | |||
501 | fScaleX = fDstWH * aSizePixel.Height() / aSizePixel.Width(); | |||
502 | ||||
503 | rBmpEx.Scale( fScaleX, fScaleY ); | |||
504 | } | |||
505 | ||||
506 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
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 | |
36 | class VclReferenceBase; |
37 | |
38 | namespace vcl::detail { |
39 | |
40 | template<typename> |
41 | constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; } |
42 | |
43 | template<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 | */ |
56 | template <class reference_type> |
57 | class 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 | |
66 | public: |
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 ;-) |
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 | |
218 | template<typename T1, typename T2> |
219 | inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
220 | return p1.get() == p2.get(); |
221 | } |
222 | |
223 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2) |
224 | { |
225 | return p1.get() == p2; |
226 | } |
227 | |
228 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) { |
229 | return p1.get() == p2; |
230 | } |
231 | |
232 | template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2) |
233 | { |
234 | return p1 == p2.get(); |
235 | } |
236 | |
237 | template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) { |
238 | return p1 == p2.get(); |
239 | } |
240 | |
241 | template<typename T1, typename T2> |
242 | inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
243 | return !(p1 == p2); |
244 | } |
245 | |
246 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2) |
247 | { |
248 | return !(p1 == p2); |
249 | } |
250 | |
251 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) { |
252 | return !(p1 == p2); |
253 | } |
254 | |
255 | template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2) |
256 | { |
257 | return !(p1 == p2); |
258 | } |
259 | |
260 | template<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 | */ |
274 | template <class reference_type> |
275 | class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type> |
276 | { |
277 | public: |
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 | |
290 | template <class reference_type> |
291 | class ScopedVclPtr : public VclPtr<reference_type> |
292 | { |
293 | public: |
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 | |
378 | private: |
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 | |
387 | protected: |
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 |
406 | template <class reference_type> |
407 | class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type> |
408 | { |
409 | public: |
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 | |
421 | private: |
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: */ |
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 | |||||||||
34 | namespace rtl | ||||||||
35 | { | ||||||||
36 | |||||||||
37 | /** Template reference class for reference type. | ||||||||
38 | */ | ||||||||
39 | template <class reference_type> | ||||||||
40 | class Reference | ||||||||
41 | { | ||||||||
42 | /** The <b>reference_type</b> body pointer. | ||||||||
43 | */ | ||||||||
44 | reference_type * m_pBody; | ||||||||
45 | |||||||||
46 | |||||||||
47 | public: | ||||||||
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
| ||||||||
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; | ||||||||
| |||||||||
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 | ||||||||
277 | namespace 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 | */ | ||||||||
286 | template<typename T> | ||||||||
287 | struct 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: */ |
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 | |
25 | class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase |
26 | { |
27 | mutable oslInterlockedCount mnRefCnt; |
28 | |
29 | template<typename T> friend class VclPtr; |
30 | |
31 | public: |
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) |
40 | delete this; |
41 | } |
42 | #ifdef DBG_UTIL |
43 | #ifndef _WIN32 |
44 | sal_Int32 getRefCount() const { return mnRefCnt; } |
45 | #endif |
46 | #endif |
47 | |
48 | |
49 | private: |
50 | VclReferenceBase(const VclReferenceBase&) = delete; |
51 | VclReferenceBase& operator=(const VclReferenceBase&) = delete; |
52 | |
53 | bool mbDisposed : 1; |
54 | |
55 | protected: |
56 | VclReferenceBase(); |
57 | protected: |
58 | virtual ~VclReferenceBase(); |
59 | |
60 | protected: |
61 | virtual void dispose(); |
62 | |
63 | public: |
64 | void disposeOnce(); |
65 | bool isDisposed() const { return mbDisposed; } |
66 | |
67 | }; |
68 | #endif |