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 galtheme.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D SVXCORE_DLLIMPLEMENTATION -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium/public -D COMPONENT_BUILD -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/svx/inc -I /home/maarten/src/libreoffice/core/svx/source/inc -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/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/svx/sdi -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/svx/source/gallery2/galtheme.cxx

/home/maarten/src/libreoffice/core/svx/source/gallery2/galtheme.cxx

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#include <config_features.h>
21
22#include <sal/config.h>
23#include <sal/log.hxx>
24
25#include <algorithm>
26
27#include <comphelper/fileformat.h>
28#include <comphelper/processfactory.hxx>
29#include <osl/file.hxx>
30#include <osl/thread.hxx>
31#include <tools/diagnose_ex.h>
32#include <tools/urlobj.hxx>
33#include <tools/vcompat.hxx>
34#include <tools/datetime.hxx>
35#include <unotools/datetime.hxx>
36#include <unotools/streamwrap.hxx>
37#include <unotools/ucbstreamhelper.hxx>
38#include <unotools/tempfile.hxx>
39#include <ucbhelper/content.hxx>
40#include <com/sun/star/ucb/ContentCreationException.hpp>
41#include <sot/storage.hxx>
42#include <sot/formats.hxx>
43#include <sot/filelist.hxx>
44#include <vcl/virdev.hxx>
45#include <vcl/cvtgrf.hxx>
46#include <avmedia/mediawindow.hxx>
47#include <svx/svdograf.hxx>
48#include "codec.hxx"
49#include <svx/unomodel.hxx>
50#include <svx/fmmodel.hxx>
51#include <svx/fmview.hxx>
52#include <svx/galmisc.hxx>
53#include <svx/galtheme.hxx>
54#include <svx/svdpage.hxx>
55#include <svx/galleryobjectcollection.hxx>
56#include <com/sun/star/sdbc/XResultSet.hpp>
57#include <com/sun/star/ucb/XContentAccess.hpp>
58#include <galobj.hxx>
59#include <svx/gallery1.hxx>
60#include "gallerydrawmodel.hxx"
61#include <memory>
62
63using namespace ::com::sun::star;
64
65GalleryTheme::GalleryTheme( Gallery* pGallery, GalleryThemeEntry* pThemeEntry )
66 : pParent(pGallery)
67 , pThm(pThemeEntry)
68 , mnThemeLockCount(0)
69 , mnBroadcasterLockCount(0)
70 , nDragPos(0)
71 , bDragging(false)
72 , bAbortActualize(false)
73{
74 mpGalleryStorageEngine = pThm->createGalleryStorageEngine(maGalleryObjectCollection);
75}
76
77GalleryTheme::~GalleryTheme()
78{
79 if(pThm->IsModified())
80 if(!mpGalleryStorageEngine->implWrite(*this, pThm))
81 ImplSetModified(false);
82
83 for (auto & pEntry : maGalleryObjectCollection.getObjectList())
84 {
85 Broadcast( GalleryHint( GalleryHintType::CLOSE_OBJECT, GetName(), pEntry.get() ) );
86 pEntry.reset();
87 }
88 maGalleryObjectCollection.clear();
89 mpGalleryStorageEngine->clearSotStorage();
90}
91
92void GalleryTheme::SetDestDir(const OUString& rDestDir, bool bRelative)
93{
94 mpGalleryStorageEngine->setDestDir(rDestDir, bRelative);
95}
96
97void GalleryTheme::ImplBroadcast(sal_uInt32 nUpdatePos)
98{
99 if( !IsBroadcasterLocked() )
100 {
101 if( GetObjectCount() && ( nUpdatePos >= GetObjectCount() ) )
102 nUpdatePos = GetObjectCount() - 1;
103
104 Broadcast( GalleryHint( GalleryHintType::THEME_UPDATEVIEW, GetName(), reinterpret_cast<void*>(nUpdatePos) ) );
105 }
106}
107
108bool GalleryTheme::UnlockTheme()
109{
110 DBG_ASSERT( mnThemeLockCount, "Theme is not locked" )do { if (true && (!(mnThemeLockCount))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/svx/source/gallery2/galtheme.cxx"
":" "110" ": "), "%s", "Theme is not locked"); } } while (false
);
111
112 bool bRet = false;
113
114 if( mnThemeLockCount )
115 {
116 --mnThemeLockCount;
117 bRet = true;
118 }
119
120 return bRet;
121}
122
123void GalleryTheme::UnlockBroadcaster()
124{
125 DBG_ASSERT( mnBroadcasterLockCount, "Broadcaster is not locked" )do { if (true && (!(mnBroadcasterLockCount))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/svx/source/gallery2/galtheme.cxx"
":" "125" ": "), "%s", "Broadcaster is not locked"); } } while
(false);
126
127 if( mnBroadcasterLockCount && !--mnBroadcasterLockCount )
128 ImplBroadcast( 0 );
129}
130
131bool GalleryTheme::InsertObject(const SgaObject& rObj, sal_uInt32 nInsertPos)
132{
133 if (!rObj.IsValid())
134 return false;
135
136 GalleryObject* pFoundEntry = nullptr;
137 sal_uInt32 iFoundPos = 0;
138 for (sal_uInt32 n = maGalleryObjectCollection.size(); iFoundPos < n; ++iFoundPos)
139 {
140 if (maGalleryObjectCollection.get(iFoundPos)->getURL() == rObj.GetURL())
141 {
142 pFoundEntry = maGalleryObjectCollection.get(iFoundPos).get();
143 break;
144 }
145 }
146
147 mpGalleryStorageEngine->insertObject(rObj, pFoundEntry, nInsertPos);
148
149 ImplSetModified(true);
150 ImplBroadcast(pFoundEntry? iFoundPos: nInsertPos);
151
152 return true;
153}
154
155std::unique_ptr<SgaObject> GalleryTheme::AcquireObject(sal_uInt32 nPos)
156{
157 return mpGalleryStorageEngine->implReadSgaObject(maGalleryObjectCollection.getForPosition(nPos));
158}
159
160void GalleryTheme::GetPreviewBitmapExAndStrings(sal_uInt32 nPos, BitmapEx& rBitmapEx, Size& rSize, OUString& rTitle, OUString& rPath)
161{
162 const GalleryObject* pGalleryObject = maGalleryObjectCollection.get(nPos).get();
163
164 rBitmapEx = pGalleryObject->maPreviewBitmapEx;
165 rSize = pGalleryObject->maPreparedSize;
166 rTitle = pGalleryObject->maTitle;
167 rPath = pGalleryObject->maPath;
168}
169
170void GalleryTheme::SetPreviewBitmapExAndStrings(sal_uInt32 nPos, const BitmapEx& rBitmapEx, const Size& rSize, const OUString& rTitle, const OUString& rPath)
171{
172 GalleryObject* pGalleryObject = maGalleryObjectCollection.get(nPos).get();
173
174 pGalleryObject->maPreviewBitmapEx = rBitmapEx;
175 pGalleryObject->maPreparedSize = rSize;
176 pGalleryObject->maTitle = rTitle;
177 pGalleryObject->maPath = rPath;
178}
179
180void GalleryTheme::RemoveObject(sal_uInt32 nPos)
181{
182 auto it = maGalleryObjectCollection.getObjectList().begin() + nPos;
183 std::unique_ptr<GalleryObject> pEntry = std::move(*it);
184 maGalleryObjectCollection.getObjectList().erase( it );
185
186 mpGalleryStorageEngine->removeObject(pEntry);
187
188 Broadcast( GalleryHint( GalleryHintType::CLOSE_OBJECT, GetName(), pEntry.get() ) );
189 pEntry.reset();
190
191 ImplSetModified( true );
192 ImplBroadcast( nPos );
193}
194
195bool GalleryTheme::ChangeObjectPos(sal_uInt32 nOldPos, sal_uInt32 nNewPos)
196{
197 if (nOldPos == nNewPos || nOldPos >= maGalleryObjectCollection.size())
198 return false;
199
200 std::unique_ptr<GalleryObject> pEntry = std::move(maGalleryObjectCollection.get(nOldPos));
201
202 maGalleryObjectCollection.getObjectList().insert(maGalleryObjectCollection.getObjectList().begin() + nNewPos, std::move(pEntry));
203
204 if (nNewPos < nOldPos)
205 nOldPos++;
206
207 auto it = maGalleryObjectCollection.getObjectList().begin() + nOldPos;
208 maGalleryObjectCollection.getObjectList().erase(it);
209
210 ImplSetModified(true);
211 ImplBroadcast((nNewPos < nOldPos)? nNewPos: (nNewPos - 1));
212
213 return true;
214}
215
216void GalleryTheme::Actualize( const Link<const INetURLObject&, void>& rActualizeLink, GalleryProgress* pProgress )
217{
218 if( IsReadOnly() )
219 return;
220
221 Graphic aGraphic;
222 OUString aFormat;
223 const sal_uInt32 nCount = maGalleryObjectCollection.size();
224
225 LockBroadcaster();
226 bAbortActualize = false;
227
228 // reset delete flag
229 for (sal_uInt32 i = 0; i < nCount; i++)
230 maGalleryObjectCollection.get(i)->mbDelete = false;
231
232 for (sal_uInt32 i = 0; ( i < nCount ) && !bAbortActualize; i++)
233 {
234 if( pProgress )
235 pProgress->Update( i, nCount - 1 );
236
237 GalleryObject* pEntry = maGalleryObjectCollection.get(i).get();
238
239 const INetURLObject aURL( pEntry->getURL());
240
241 rActualizeLink.Call( aURL );
242
243 // SvDraw objects will be updated later
244 if( pEntry->eObjKind != SgaObjKind::SvDraw )
245 {
246 // Still a function should be implemented,
247 // which assigns files to the relevant entry.
248 // insert graphics as graphic objects into the gallery
249 if( pEntry->eObjKind == SgaObjKind::Sound )
250 {
251 SgaObjectSound aObjSound( aURL );
252 if( !InsertObject( aObjSound ) )
253 pEntry->mbDelete = true;
254 }
255 else
256 {
257 aGraphic.Clear();
258
259 if ( GalleryGraphicImport( aURL, aGraphic, aFormat ) != GalleryGraphicImportRet::IMPORT_NONE )
260 {
261 std::unique_ptr<SgaObject> pNewObj;
262
263 if ( SgaObjKind::Inet == pEntry->eObjKind )
264 pNewObj.reset(new SgaObjectINet( aGraphic, aURL ));
265 else if ( aGraphic.IsAnimated() )
266 pNewObj.reset(new SgaObjectAnim( aGraphic, aURL ));
267 else
268 pNewObj.reset(new SgaObjectBmp( aGraphic, aURL ));
269
270 if( !InsertObject( *pNewObj ) )
271 pEntry->mbDelete = true;
272 }
273 else
274 pEntry->mbDelete = true; // set delete flag
275 }
276 }
277 else
278 {
279 //update SvDraw object
280 if ( mpGalleryStorageEngine->GetSvDrawStorage().is() )
281 {
282 SgaObjectSvDraw aNewObj = mpGalleryStorageEngine->updateSvDrawObject(pEntry);
283 if (aNewObj.IsValid() && !InsertObject(aNewObj))
284 pEntry->mbDelete = true;
285 }
286 }
287 }
288
289 // remove all entries with set flag
290 for ( auto it = maGalleryObjectCollection.getObjectList().begin(); it != maGalleryObjectCollection.getObjectList().end(); /* increment is in the body of loop */)
291 {
292 if( (*it)->mbDelete )
293 {
294 Broadcast( GalleryHint( GalleryHintType::CLOSE_OBJECT, GetName(), it->get() ) );
295 it = maGalleryObjectCollection.getObjectList().erase( it );
296 }
297 else
298 ++it;
299 }
300
301 // update theme
302 mpGalleryStorageEngine->updateTheme();
303 ImplSetModified( true );
304 if (pThm->IsModified())
305 if (!mpGalleryStorageEngine->implWrite(*this, pThm))
306 ImplSetModified(false);
307 UnlockBroadcaster();
308}
309
310bool GalleryTheme::GetThumb(sal_uInt32 nPos, BitmapEx& rBmp)
311{
312 std::unique_ptr<SgaObject> pObj = AcquireObject( nPos );
313 bool bRet = false;
314
315 if( pObj )
316 {
317 rBmp = pObj->GetThumbBmp();
318 bRet = true;
319 }
320
321 return bRet;
322}
323
324bool GalleryTheme::GetGraphic(sal_uInt32 nPos, Graphic& rGraphic)
325{
326 const GalleryObject* pObject = maGalleryObjectCollection.getForPosition( nPos );
327 bool bRet = false;
328
329 if( pObject )
1
Assuming 'pObject' is non-null
→
2
←
Taking true branch
→
330 {
331 const INetURLObject aURL( ImplGetURL( pObject ) );
332
333 switch( pObject->eObjKind )
3
←
Control jumps to 'case SvDraw:' at line 344
→
334 {
335 case SgaObjKind::Bitmap:
336 case SgaObjKind::Animation:
337 case SgaObjKind::Inet:
338 {
339 OUString aFilterDummy;
340 bRet = ( GalleryGraphicImport( aURL, rGraphic, aFilterDummy ) != GalleryGraphicImportRet::IMPORT_NONE );
341 }
342 break;
343
344 case SgaObjKind::SvDraw:
345 {
346 SvxGalleryDrawModel aModel;
347
348 if( aModel.GetModel() )
4
←
Assuming the condition is true
→
5
←
Taking true branch
→
349 {
350 if( GetModel( nPos, *aModel.GetModel() ) )
6
←
Assuming the condition is true
→
7
←
Taking true branch
→
351 {
352 ImageMap aIMap;
353
354 if( CreateIMapGraphic( *aModel.GetModel(), rGraphic, aIMap ) )
8
←
Assuming the condition is false
→
9
←
Taking false branch
→
355 bRet = true;
356 else
357 {
358 ScopedVclPtrInstance< VirtualDevice > pVDev;
10
←
Calling default constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
12
←
Returning from default constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
359 pVDev->SetMapMode( MapMode( MapUnit::Map100thMM ) );
360 FmFormView aView(*aModel.GetModel(), pVDev);
361
362 aView.hideMarkHandles();
363 aView.ShowSdrPage(aView.GetModel()->GetPage(0));
364 aView.MarkAll();
365 rGraphic = aView.GetAllMarkedGraphic();
366 bRet = true;
367 }
13
←
Calling implicit destructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
14
←
Calling '~ScopedVclPtr'
→
368 }
369 }
370 }
371 break;
372
373 case SgaObjKind::Sound:
374 {
375 std::unique_ptr<SgaObject> pObj = AcquireObject( nPos );
376
377 if( pObj )
378 {
379 rGraphic = pObj->GetThumbBmp();
380 //Bitmap aBmp( pObj->GetThumbBmp() );
381 //aBmp.Replace( COL_LIGHTMAGENTA, COL_WHITE );
382 //rGraphic = aBmp;
383 bRet = true;
384 }
385 }
386 break;
387
388 default:
389 break;
390 }
391 }
392
393 return bRet;
394}
395
396bool GalleryTheme::InsertGraphic(const Graphic& rGraphic, sal_uInt32 nInsertPos)
397{
398 bool bRet = false;
399
400 if( rGraphic.GetType() != GraphicType::NONE )
401 {
402 ConvertDataFormat nExportFormat = ConvertDataFormat::Unknown;
403 const GfxLink aGfxLink( rGraphic.GetGfxLink() );
404
405 if( aGfxLink.GetDataSize() )
406 {
407 switch( aGfxLink.GetType() )
408 {
409 case GfxLinkType::EpsBuffer: nExportFormat = ConvertDataFormat::SVM; break;
410 case GfxLinkType::NativeGif: nExportFormat = ConvertDataFormat::GIF; break;
411
412 // #i15508# added BMP type
413 // could not find/trigger a call to this, but should do no harm
414 case GfxLinkType::NativeBmp: nExportFormat = ConvertDataFormat::BMP; break;
415
416 case GfxLinkType::NativeJpg: nExportFormat = ConvertDataFormat::JPG; break;
417 case GfxLinkType::NativePng: nExportFormat = ConvertDataFormat::PNG; break;
418 case GfxLinkType::NativeTif: nExportFormat = ConvertDataFormat::TIF; break;
419 case GfxLinkType::NativeWmf: nExportFormat = ConvertDataFormat::WMF; break;
420 case GfxLinkType::NativeMet: nExportFormat = ConvertDataFormat::MET; break;
421 case GfxLinkType::NativePct: nExportFormat = ConvertDataFormat::PCT; break;
422 case GfxLinkType::NativeSvg: nExportFormat = ConvertDataFormat::SVG; break;
423 default:
424 break;
425 }
426 }
427 else
428 {
429 if( rGraphic.GetType() == GraphicType::Bitmap )
430 {
431 if( rGraphic.IsAnimated() )
432 nExportFormat = ConvertDataFormat::GIF;
433 else
434 nExportFormat = ConvertDataFormat::PNG;
435 }
436 else
437 nExportFormat = ConvertDataFormat::SVM;
438 }
439
440 const SgaObjectBmp aObjBmp = mpGalleryStorageEngine->insertGraphic(rGraphic, aGfxLink, nExportFormat, GetParent()->GetUserURL());
441
442 if (aObjBmp.IsValid())
443 bRet = InsertObject(aObjBmp, nInsertPos);
444 }
445
446 return bRet;
447}
448
449bool GalleryTheme::GetModel(sal_uInt32 nPos, SdrModel& rModel)
450{
451 const GalleryObject* pObject = maGalleryObjectCollection.getForPosition( nPos );
452 bool bRet = false;
453
454 if( pObject && ( SgaObjKind::SvDraw == pObject->eObjKind ) )
455 {
456 bRet = mpGalleryStorageEngine->readModel(pObject, rModel);
457 }
458
459 return bRet;
460}
461
462bool GalleryTheme::InsertModel(const FmFormModel& rModel, sal_uInt32 nInsertPos)
463{
464 bool bRet = false;
465 SgaObjectSvDraw aObjSvDraw = mpGalleryStorageEngine->insertModel(rModel, GetParent()->GetUserURL());
466 if(aObjSvDraw.IsValid())
467 bRet = InsertObject( aObjSvDraw, nInsertPos );
468 return bRet;
469}
470
471bool GalleryTheme::GetModelStream(sal_uInt32 nPos, tools::SvRef<SotStorageStream> const & rxModelStream)
472{
473 const GalleryObject* pObject = maGalleryObjectCollection.getForPosition( nPos );
474 bool bRet = false;
475
476 if( pObject && ( SgaObjKind::SvDraw == pObject->eObjKind ) )
477 {
478 bRet = mpGalleryStorageEngine->readModelStream(pObject, rxModelStream);
479 }
480
481 return bRet;
482}
483
484bool GalleryTheme::InsertModelStream(const tools::SvRef<SotStorageStream>& rxModelStream, sal_uInt32 nInsertPos)
485{
486 bool bRet = false;
487
488 const SgaObjectSvDraw aObjSvDraw = mpGalleryStorageEngine->insertModelStream(rxModelStream, GetParent()->GetUserURL());
489 if(aObjSvDraw.IsValid())
490 bRet = InsertObject( aObjSvDraw, nInsertPos );
491
492 return bRet;
493}
494
495bool GalleryTheme::GetURL(sal_uInt32 nPos, INetURLObject& rURL)
496{
497 const GalleryObject* pObject = maGalleryObjectCollection.getForPosition( nPos );
498 bool bRet = false;
499
500 if( pObject )
501 {
502 rURL = ImplGetURL( pObject );
503 bRet = true;
504 }
505
506 return bRet;
507}
508
509bool GalleryTheme::InsertURL(const INetURLObject& rURL, sal_uInt32 nInsertPos)
510{
511 Graphic aGraphic;
512 OUString aFormat;
513 std::unique_ptr<SgaObject> pNewObj;
514 const GalleryGraphicImportRet nImportRet = GalleryGraphicImport( rURL, aGraphic, aFormat );
515 bool bRet = false;
516
517 if( nImportRet != GalleryGraphicImportRet::IMPORT_NONE )
518 {
519 if ( aGraphic.IsAnimated() )
520 pNewObj.reset(new SgaObjectAnim( aGraphic, rURL ));
521 else
522 pNewObj.reset(new SgaObjectBmp( aGraphic, rURL ));
523 }
524#if HAVE_FEATURE_AVMEDIA1
525 else if( ::avmedia::MediaWindow::isMediaURL( rURL.GetMainURL( INetURLObject::DecodeMechanism::Unambiguous ), ""/*TODO?*/ ) )
526 pNewObj.reset(new SgaObjectSound( rURL ));
527#endif
528 if( pNewObj && InsertObject( *pNewObj, nInsertPos ) )
529 bRet = true;
530
531 return bRet;
532}
533
534bool GalleryTheme::InsertFileOrDirURL(const INetURLObject& rFileOrDirURL, sal_uInt32 nInsertPos)
535{
536 bool bRet = false;
537 std::vector< INetURLObject > aURLVector;
538 GalleryBinaryEngine::insertFileOrDirURL(rFileOrDirURL, aURLVector);
539
540 for( const auto& rURL : aURLVector )
541 bRet = bRet || InsertURL( rURL, nInsertPos );
542
543 return bRet;
544}
545
546bool GalleryTheme::InsertTransferable(const uno::Reference< datatransfer::XTransferable >& rxTransferable, sal_uInt32 nInsertPos)
547{
548 bool bRet = false;
549
550 if( rxTransferable.is() )
551 {
552 TransferableDataHelper aDataHelper( rxTransferable );
553 std::unique_ptr<Graphic> pGraphic;
554
555 if( aDataHelper.HasFormat( SotClipboardFormatId::DRAWING ) )
556 {
557 tools::SvRef<SotStorageStream> xModelStm;
558
559 if( aDataHelper.GetSotStorageStream( SotClipboardFormatId::DRAWING, xModelStm ) )
560 bRet = InsertModelStream( xModelStm, nInsertPos );
561 }
562 else if( aDataHelper.HasFormat( SotClipboardFormatId::FILE_LIST ) ||
563 aDataHelper.HasFormat( SotClipboardFormatId::SIMPLE_FILE ) )
564 {
565 FileList aFileList;
566
567 if( aDataHelper.HasFormat( SotClipboardFormatId::FILE_LIST ) )
568 aDataHelper.GetFileList( SotClipboardFormatId::FILE_LIST, aFileList );
569 else
570 {
571 OUString aFile;
572 if (aDataHelper.GetString(SotClipboardFormatId::SIMPLE_FILE, aFile) && !aFile.isEmpty())
573 aFileList.AppendFile( aFile );
574 }
575
576 for( sal_uInt32 i = 0, nCount = aFileList.Count(); i < nCount; ++i )
577 {
578 const OUString aFile( aFileList.GetFile( i ) );
579 INetURLObject aURL( aFile );
580
581 if( aURL.GetProtocol() == INetProtocol::NotValid )
582 {
583 OUString aLocalURL;
584
585 if( osl::FileBase::getFileURLFromSystemPath( aFile, aLocalURL ) == osl::FileBase::E_None )
586 aURL = INetURLObject( aLocalURL );
587 }
588
589 if( aURL.GetProtocol() != INetProtocol::NotValid )
590 bRet = InsertFileOrDirURL( aURL, nInsertPos );
591 }
592 }
593 else
594 {
595 Graphic aGraphic;
596 SotClipboardFormatId nFormat = SotClipboardFormatId::NONE;
597
598 if( aDataHelper.HasFormat( SotClipboardFormatId::SVXB ) )
599 nFormat = SotClipboardFormatId::SVXB;
600 else if( aDataHelper.HasFormat( SotClipboardFormatId::GDIMETAFILE ) )
601 nFormat = SotClipboardFormatId::GDIMETAFILE;
602 else if( aDataHelper.HasFormat( SotClipboardFormatId::BITMAP ) )
603 nFormat = SotClipboardFormatId::BITMAP;
604
605 if( nFormat != SotClipboardFormatId::NONE && aDataHelper.GetGraphic( nFormat, aGraphic ) )
606 pGraphic.reset(new Graphic( aGraphic ));
607 }
608
609 if( pGraphic )
610 {
611 bRet = false;
612
613 if( aDataHelper.HasFormat( SotClipboardFormatId::SVIM ) )
614 {
615
616 ImageMap aImageMap;
617
618 // according to KA we don't need a BaseURL here
619 if( aDataHelper.GetImageMap( SotClipboardFormatId::SVIM, aImageMap ) )
620 {
621 SvxGalleryDrawModel aModel;
622
623 if( aModel.GetModel() )
624 {
625 SdrPage* pPage = aModel.GetModel()->GetPage(0);
626 SdrGrafObj* pGrafObj = new SdrGrafObj(*aModel.GetModel(), *pGraphic );
627
628 pGrafObj->AppendUserData( std::unique_ptr<SdrObjUserData>(new SgaIMapInfo( aImageMap )) );
629 pPage->InsertObject( pGrafObj );
630 bRet = InsertModel( *aModel.GetModel(), nInsertPos );
631 }
632 }
633 }
634
635 if( !bRet )
636 bRet = InsertGraphic( *pGraphic, nInsertPos );
637 }
638 }
639
640 return bRet;
641}
642
643void GalleryTheme::CopyToClipboard(sal_uInt32 nPos)
644{
645 GalleryTransferable* pTransferable = new GalleryTransferable( this, nPos, false );
646 pTransferable->CopyToClipboard(GetSystemClipboard());
647}
648
649DateTime GalleryTheme::getModificationDate() const
650{
651 return mpGalleryStorageEngine->getModificationDate();
652}
653
654SvStream& GalleryTheme::ReadData( SvStream& rIStm )
655{
656 sal_uInt32 nCount;
657 sal_uInt16 nVersion;
658
659 rIStm.ReadUInt16( nVersion );
660 read_uInt16_lenPrefixed_uInt8s_ToOString(rIStm);
661 rIStm.ReadUInt32( nCount );
662
663 if( nVersion >= 0x0004 )
664 {
665 sal_uInt16 nTmp16;
666 rIStm.ReadUInt16( nTmp16 );
667 }
668
669 if( nCount <= ( 1 << 14 ) )
670 {
671 INetURLObject aRelURL1( GetParent()->GetRelativeURL() );
672 INetURLObject aRelURL2( GetParent()->GetUserURL() );
673 sal_uInt32 nId1, nId2;
674 bool bRel;
675
676 for(auto & i : maGalleryObjectCollection.getObjectList())
677 {
678 GalleryObject* pObj = i.get();
679 Broadcast( GalleryHint( GalleryHintType::CLOSE_OBJECT, GetName(), pObj ) );
680 i.reset();
681 }
682 maGalleryObjectCollection.clear();
683
684 for( sal_uInt32 i = 0; i < nCount; i++ )
685 {
686 std::unique_ptr<GalleryObject> pObj(new GalleryObject);
687
688 OUString aFileName;
689 sal_uInt16 nTemp;
690
691 rIStm.ReadCharAsBool( bRel );
692 OString aTempFileName = read_uInt16_lenPrefixed_uInt8s_ToOString(rIStm);
693 rIStm.ReadUInt32( pObj->nOffset );
694 rIStm.ReadUInt16( nTemp ); pObj->eObjKind = static_cast<SgaObjKind>(nTemp);
695
696 aFileName = OStringToOUString(aTempFileName, osl_getThreadTextEncoding());
697
698 pObj->m_pGalleryObjectStorage.reset();
699 pObj->m_pGalleryObjectStorage = std::make_unique<GalleryObjectBinaryStorage>();
700
701 if( bRel )
702 {
703 aFileName = aFileName.replaceAll( "\\", "/" );
704 OUString aPath = aRelURL1.GetMainURL( INetURLObject::DecodeMechanism::NONE );
705
706 if( aFileName[ 0 ] != '/' )
707 aPath += "/";
708
709 aPath += aFileName;
710
711 pObj->m_pGalleryObjectStorage->setURL(INetURLObject(aPath));
712
713 if (!FileExists(pObj->getURL()))
714 {
715 aPath = aRelURL2.GetMainURL( INetURLObject::DecodeMechanism::NONE );
716
717 if( aFileName[0] != '/' )
718 aPath += "/";
719
720 aPath += aFileName;
721
722 // assign this URL, even in the case it is not valid (#94482)
723 pObj->m_pGalleryObjectStorage->setURL(INetURLObject(aPath));
724 }
725 }
726 else
727 {
728 if( SgaObjKind::SvDraw == pObj->eObjKind )
729 {
730 OUString aDummyURL = "gallery/svdraw/" + aFileName;
731 pObj->m_pGalleryObjectStorage->setURL(INetURLObject(aDummyURL, INetProtocol::PrivSoffice));
732 }
733 else
734 {
735 OUString aLocalURL;
736
737 pObj->m_pGalleryObjectStorage->setURL(INetURLObject(aFileName));
738
739 if( ( pObj->getURL().GetProtocol() == INetProtocol::NotValid ) &&
740 osl::FileBase::getFileURLFromSystemPath( aFileName, aLocalURL ) == osl::FileBase::E_None )
741 {
742 pObj->m_pGalleryObjectStorage->setURL(INetURLObject(aLocalURL));
743 }
744 }
745 }
746 maGalleryObjectCollection.getObjectList().push_back( std::move(pObj) );
747 }
748
749 rIStm.ReadUInt32( nId1 ).ReadUInt32( nId2 );
750
751 // In newer versions a 512 byte reserve buffer is located at the end,
752 // the data is located at the beginning of this buffer and are clamped
753 // by a VersionCompat.
754 if( !rIStm.eof() &&
755 nId1 == COMPAT_FORMAT( 'G', 'A', 'L', 'R' ) &&
756 nId2 == COMPAT_FORMAT( 'E', 'S', 'R', 'V' ) )
757 {
758 VersionCompat aCompat( rIStm, StreamMode::READ );
759 sal_uInt32 nTemp32;
760 bool bThemeNameFromResource = false;
761
762 rIStm.ReadUInt32( nTemp32 );
763
764 if( aCompat.GetVersion() >= 2 )
765 {
766 rIStm.ReadCharAsBool( bThemeNameFromResource );
767 }
768
769 SetId( nTemp32, bThemeNameFromResource );
770 }
771 }
772 else
773 rIStm.SetError( SVSTREAM_READ_ERRORErrCode( ErrCodeArea::Io, ErrCodeClass::Read, 15 ) );
774
775 ImplSetModified( false );
776
777 return rIStm;
778}
779
780void GalleryTheme::ImplSetModified( bool bModified )
781{
782 pThm->SetModified(bModified);
783}
784
785sal_uInt32 GalleryTheme::GetId() const { return pThm->GetId(); }
786void GalleryTheme::SetId( sal_uInt32 nNewId, bool bResetThemeName ) { pThm->SetId( nNewId, bResetThemeName ); }
787bool GalleryTheme::IsReadOnly() const { return pThm->IsReadOnly(); }
788bool GalleryTheme::IsDefault() const { return pThm->IsDefault(); }
789
790const OUString& GalleryTheme::GetName() const { return pThm->GetThemeName(); }
791
792/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
16
←
Calling 'Reference::clear'
→
23
←
Returning; memory was released
→
205 if (aTmp.get()) {
24
←
Calling 'Reference::get'
→
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
15
←
Calling 'VclPtr::disposeAndClear'
→
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
11
←
Memory is allocated
→
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
)
17
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
18
←
Calling 'VclReferenceBase::release'
→
22
←
Returning; memory was released
→
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
25
←
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)
19
←
Assuming the condition is true
→
20
←
Taking true branch
→
40 delete this;
21
←
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