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 sdxfer.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 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -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 SD_DLLIMPLEMENTATION -D SDUI_DLL_NAME="libsduilo.so" -D SYSTEM_LIBXML -D ENABLE_SDREMOTE -D ENABLE_SDREMOTE_BLUETOOTH -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -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/external/bluez_bluetooth/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/sd/inc -I /home/maarten/src/libreoffice/core/sd/source/ui/inc -I /home/maarten/src/libreoffice/core/sd/source/ui/slidesorter/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sd/sdi -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/oox/generated -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /usr/include/glib-2.0 -I /usr/lib64/glib-2.0/include -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/sd/source/ui/app/sdxfer.cxx

/home/maarten/src/libreoffice/core/sd/source/ui/app/sdxfer.cxx

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#include <sal/config.h>
21
22#include <com/sun/star/embed/XEmbeddedObject.hpp>
23#include <com/sun/star/embed/XTransactedObject.hpp>
24#include <com/sun/star/embed/XEmbedPersist.hpp>
25#include <com/sun/star/embed/ElementModes.hpp>
26#include <com/sun/star/lang/XComponent.hpp>
27#include <comphelper/fileformat.h>
28#include <unotools/ucbstreamhelper.hxx>
29#include <unotools/tempfile.hxx>
30#include <editeng/flditem.hxx>
31#include <svx/svdpagv.hxx>
32#include <svx/svdoole2.hxx>
33#include <svx/svdograf.hxx>
34#include <svx/svdotext.hxx>
35#include <editeng/outlobj.hxx>
36#include <sot/storage.hxx>
37#include <editeng/editobj.hxx>
38#include <svx/fmglob.hxx>
39#include <svx/svdouno.hxx>
40#include <svx/ImageMapInfo.hxx>
41#include <sot/formats.hxx>
42#include <svl/urlbmk.hxx>
43
44#include <com/sun/star/form/FormButtonType.hpp>
45#include <com/sun/star/beans/XPropertySet.hpp>
46#include <unotools/streamwrap.hxx>
47
48#include <svx/svdotable.hxx>
49#include <svx/unomodel.hxx>
50#include <svx/svditer.hxx>
51#include <sfx2/docfile.hxx>
52#include <comphelper/storagehelper.hxx>
53#include <comphelper/servicehelper.hxx>
54#include <svtools/embedtransfer.hxx>
55#include <DrawDocShell.hxx>
56#include <View.hxx>
57#include <sdmod.hxx>
58#include <sdpage.hxx>
59#include <drawdoc.hxx>
60#include <stlpool.hxx>
61#include <sdxfer.hxx>
62#include <unomodel.hxx>
63#include <vcl/virdev.hxx>
64#include <vcl/svapp.hxx>
65
66using namespace ::com::sun::star;
67using namespace ::com::sun::star::lang;
68using namespace ::com::sun::star::uno;
69using namespace ::com::sun::star::io;
70using namespace ::com::sun::star::datatransfer;
71using namespace ::com::sun::star::datatransfer::clipboard;
72
73constexpr sal_uInt32 SDTRANSFER_OBJECTTYPE_DRAWMODEL = 1;
74constexpr sal_uInt32 SDTRANSFER_OBJECTTYPE_DRAWOLE = 2;
75
76SdTransferable::SdTransferable( SdDrawDocument* pSrcDoc, ::sd::View* pWorkView, bool bInitOnGetData )
77: mpPageDocShell( nullptr )
78, mpSdView( pWorkView )
79, mpSdViewIntern( pWorkView )
80, mpSdDrawDocument( nullptr )
81, mpSdDrawDocumentIntern( nullptr )
82, mpSourceDoc( pSrcDoc )
83, mpVDev( nullptr )
84, mbInternalMove( false )
85, mbOwnDocument( false )
86, mbOwnView( false )
87, mbLateInit( bInitOnGetData )
88, mbPageTransferable( false )
89, mbPageTransferablePersistent( false )
90, maUserData()
91{
92 if( mpSourceDoc )
93 StartListening( *mpSourceDoc );
94
95 if( pWorkView )
96 StartListening( *pWorkView );
97
98 if( !mbLateInit )
99 CreateData();
100}
101
102SdTransferable::~SdTransferable()
103{
104 SolarMutexGuard g;
105
106 if( mpSourceDoc )
1
Assuming field 'mpSourceDoc' is null
→
2
←
Taking false branch
→
107 EndListening( *mpSourceDoc );
108
109 if( mpSdView )
3
←
Assuming field 'mpSdView' is null
→
4
←
Taking false branch
→
110 EndListening( *const_cast< sd::View *>( mpSdView) );
111
112 ObjectReleased();
113
114 if( mbOwnView )
5
←
Assuming field 'mbOwnView' is false
→
6
←
Taking false branch
→
115 delete mpSdViewIntern;
116
117 mpOLEDataHelper.reset();
118
119 if( maDocShellRef.is() )
7
←
Taking false branch
→
120 {
121 SfxObjectShell* pObj = maDocShellRef.get();
122 ::sd::DrawDocShell* pDocSh = static_cast< ::sd::DrawDocShell*>(pObj);
123 pDocSh->DoClose();
124 }
125
126 maDocShellRef.clear();
127
128 if( mbOwnDocument )
8
←
Assuming field 'mbOwnDocument' is false
→
9
←
Taking false branch
→
129 delete mpSdDrawDocumentIntern;
130
131 mpGraphic.reset();
132 mpBookmark.reset();
133 mpImageMap.reset();
134
135 mpVDev.disposeAndClear();
10
←
Calling 'VclPtr::disposeAndClear'
→
136 mpObjDesc.reset();
137
138 //call explicitly at end of dtor to be covered by above SolarMutex
139 maUserData.clear();
140}
141
142void SdTransferable::CreateObjectReplacement( SdrObject* pObj )
143{
144 if( !pObj )
145 return;
146
147 mpOLEDataHelper.reset();
148 mpGraphic.reset();
149 mpBookmark.reset();
150 mpImageMap.reset();
151
152 if( nullptr!= dynamic_cast< const SdrOle2Obj* >( pObj ) )
153 {
154 try
155 {
156 uno::Reference < embed::XEmbeddedObject > xObj = static_cast< SdrOle2Obj* >( pObj )->GetObjRef();
157 uno::Reference < embed::XEmbedPersist > xPersist( xObj, uno::UNO_QUERY );
158 if( xObj.is() && xPersist.is() && xPersist->hasEntry() )
159 {
160 mpOLEDataHelper.reset( new TransferableDataHelper( new SvEmbedTransferHelper( xObj, static_cast< SdrOle2Obj* >( pObj )->GetGraphic(), static_cast< SdrOle2Obj* >( pObj )->GetAspect() ) ) );
161
162 // TODO/LATER: the standalone handling of the graphic should not be used any more in future
163 // The EmbedDataHelper should bring the graphic in future
164 const Graphic* pObjGr = static_cast< SdrOle2Obj* >( pObj )->GetGraphic();
165 if ( pObjGr )
166 mpGraphic.reset( new Graphic( *pObjGr ) );
167 }
168 }
169 catch( uno::Exception& )
170 {}
171 }
172 else if( dynamic_cast< const SdrGrafObj *>( pObj ) != nullptr && (mpSourceDoc && !SdDrawDocument::GetAnimationInfo( pObj )) )
173 {
174 mpGraphic.reset( new Graphic( static_cast< SdrGrafObj* >( pObj )->GetTransformedGraphic() ) );
175 }
176 else if( pObj->IsUnoObj() && SdrInventor::FmForm == pObj->GetObjInventor() && ( pObj->GetObjIdentifier() == sal_uInt16(OBJ_FM_BUTTON) ) )
177 {
178 SdrUnoObj* pUnoCtrl = static_cast< SdrUnoObj* >( pObj );
179
180 if (SdrInventor::FmForm == pUnoCtrl->GetObjInventor())
181 {
182 const Reference< css::awt::XControlModel >& xControlModel( pUnoCtrl->GetUnoControlModel() );
183
184 if( !xControlModel.is() )
185 return;
186
187 Reference< css::beans::XPropertySet > xPropSet( xControlModel, UNO_QUERY );
188
189 if( !xPropSet.is() )
190 return;
191
192 css::form::FormButtonType eButtonType;
193 Any aTmp( xPropSet->getPropertyValue( "ButtonType" ) );
194
195 if( aTmp >>= eButtonType )
196 {
197 OUString aLabel, aURL;
198
199 xPropSet->getPropertyValue( "Label" ) >>= aLabel;
200 xPropSet->getPropertyValue( "TargetURL" ) >>= aURL;
201
202 mpBookmark.reset( new INetBookmark( aURL, aLabel ) );
203 }
204 }
205 }
206 else if( dynamic_cast< const SdrTextObj *>( pObj ) != nullptr )
207 {
208 const OutlinerParaObject* pPara;
209
210 if( (pPara = static_cast< SdrTextObj* >( pObj )->GetOutlinerParaObject()) != nullptr )
211 {
212 const SvxFieldItem* pField;
213
214 if( (pField = pPara->GetTextObject().GetField()) != nullptr )
215 {
216 const SvxFieldData* pData = pField->GetField();
217
218 if( auto pURL = dynamic_cast< const SvxURLField *>( pData ) )
219 {
220 // #i63399# This special code identifies TextFrames which have just a URL
221 // as content and directly add this to the clipboard, probably to avoid adding
222 // an unnecessary DrawObject to the target where paste may take place. This is
223 // wanted only for SdrObjects with no fill and no line, else it is necessary to
224 // use the whole SdrObject. Test here for Line/FillStyle and take shortcut only
225 // when both are unused
226 if(!pObj->HasFillStyle() && !pObj->HasLineStyle())
227 {
228 mpBookmark.reset( new INetBookmark( pURL->GetURL(), pURL->GetRepresentation() ) );
229 }
230 }
231 }
232 }
233 }
234
235 SvxIMapInfo* pInfo = SvxIMapInfo::GetIMapInfo( pObj );
236
237 if( pInfo )
238 mpImageMap.reset( new ImageMap( pInfo->GetImageMap() ) );
239}
240
241void SdTransferable::CreateData()
242{
243 if( mpSdDrawDocument && !mpSdViewIntern )
244 {
245 mbOwnView = true;
246
247 SdPage* pPage = mpSdDrawDocument->GetSdPage(0, PageKind::Standard);
248
249 if( pPage && 1 == pPage->GetObjCount() )
250 CreateObjectReplacement( pPage->GetObj( 0 ) );
251
252 mpVDev = VclPtr<VirtualDevice>::Create( *Application::GetDefaultDevice() );
253 mpVDev->SetMapMode( MapMode( mpSdDrawDocumentIntern->GetScaleUnit(), Point(), mpSdDrawDocumentIntern->GetScaleFraction(), mpSdDrawDocumentIntern->GetScaleFraction() ) );
254 mpSdViewIntern = new ::sd::View( *mpSdDrawDocumentIntern, mpVDev );
255 mpSdViewIntern->EndListening(*mpSdDrawDocumentIntern );
256 mpSdViewIntern->hideMarkHandles();
257 SdrPageView* pPageView = mpSdViewIntern->ShowSdrPage(pPage);
258 mpSdViewIntern->MarkAllObj(pPageView);
259 }
260 else if( mpSdView && !mpSdDrawDocumentIntern )
261 {
262 const SdrMarkList& rMarkList = mpSdView->GetMarkedObjectList();
263
264 if( rMarkList.GetMarkCount() == 1 )
265 CreateObjectReplacement( rMarkList.GetMark( 0 )->GetMarkedSdrObj() );
266
267 if( mpSourceDoc )
268 mpSourceDoc->CreatingDataObj(this);
269 mpSdDrawDocumentIntern = static_cast<SdDrawDocument*>( mpSdView->CreateMarkedObjModel().release() );
270 if( mpSourceDoc )
271 mpSourceDoc->CreatingDataObj(nullptr);
272
273 if( !maDocShellRef.is() && mpSdDrawDocumentIntern->GetDocSh() )
274 maDocShellRef = mpSdDrawDocumentIntern->GetDocSh();
275
276 if( !maDocShellRef.is() )
277 {
278 OSL_FAIL( "SdTransferable::CreateData(), failed to create a model with persist, clipboard operation will fail for OLE objects!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sd/source/ui/app/sdxfer.cxx"
":" "278" ": "), "%s", "SdTransferable::CreateData(), failed to create a model with persist, clipboard operation will fail for OLE objects!"
); } } while (false);
279 mbOwnDocument = true;
280 }
281
282 // Use dimension of source page
283 SdrPageView* pPgView = mpSdView->GetSdrPageView();
284 SdPage* pOldPage = static_cast<SdPage*>( pPgView->GetPage() );
285 SdrModel* pOldModel = mpSdView->GetModel();
286 SdStyleSheetPool* pOldStylePool = static_cast<SdStyleSheetPool*>( pOldModel->GetStyleSheetPool() );
287 SdStyleSheetPool* pNewStylePool = static_cast<SdStyleSheetPool*>( mpSdDrawDocumentIntern->GetStyleSheetPool() );
288 SdPage* pPage = mpSdDrawDocumentIntern->GetSdPage( 0, PageKind::Standard );
289 OUString aOldLayoutName( pOldPage->GetLayoutName() );
290
291 pPage->SetSize( pOldPage->GetSize() );
292 pPage->SetLayoutName( aOldLayoutName );
293 pNewStylePool->CopyGraphicSheets( *pOldStylePool );
294 pNewStylePool->CopyCellSheets( *pOldStylePool );
295 pNewStylePool->CopyTableStyles( *pOldStylePool );
296 sal_Int32 nPos = aOldLayoutName.indexOf( SD_LT_SEPARATOR"~LT~" );
297 if( nPos != -1 )
298 aOldLayoutName = aOldLayoutName.copy( 0, nPos );
299 StyleSheetCopyResultVector aCreatedSheets;
300 pNewStylePool->CopyLayoutSheets( aOldLayoutName, *pOldStylePool, aCreatedSheets );
301 }
302
303 // set VisArea and adjust objects if necessary
304 if( !(maVisArea.IsEmpty() &&
305 mpSdDrawDocumentIntern && mpSdViewIntern &&
306 mpSdDrawDocumentIntern->GetPageCount()) )
307 return;
308
309 SdPage* pPage = mpSdDrawDocumentIntern->GetSdPage( 0, PageKind::Standard );
310
311 if( 1 == mpSdDrawDocumentIntern->GetPageCount() )
312 {
313 // #112978# need to use GetAllMarkedBoundRect instead of GetAllMarkedRect to get
314 // fat lines correctly
315 maVisArea = mpSdViewIntern->GetAllMarkedBoundRect();
316 Point aOrigin( maVisArea.TopLeft() );
317 Size aVector( -aOrigin.X(), -aOrigin.Y() );
318
319 for( size_t nObj = 0, nObjCount = pPage->GetObjCount(); nObj < nObjCount; ++nObj )
320 {
321 SdrObject* pObj = pPage->GetObj( nObj );
322 pObj->NbcMove( aVector );
323 }
324 }
325 else
326 maVisArea.SetSize( pPage->GetSize() );
327
328 // output is at the zero point
329 maVisArea.SetPos( Point() );
330}
331
332static bool lcl_HasOnlyControls( SdrModel* pModel )
333{
334 bool bOnlyControls = false; // default if there are no objects
335
336 if ( pModel )
337 {
338 SdrPage* pPage = pModel->GetPage(0);
339 if (pPage)
340 {
341 SdrObjListIter aIter( pPage, SdrIterMode::DeepNoGroups );
342 SdrObject* pObj = aIter.Next();
343 if ( pObj )
344 {
345 bOnlyControls = true; // only set if there are any objects at all
346 while ( pObj )
347 {
348 if (dynamic_cast< const SdrUnoObj *>( pObj ) == nullptr)
349 {
350 bOnlyControls = false;
351 break;
352 }
353 pObj = aIter.Next();
354 }
355 }
356 }
357 }
358
359 return bOnlyControls;
360}
361
362static bool lcl_HasOnlyOneTable( SdrModel* pModel )
363{
364 if ( pModel )
365 {
366 SdrPage* pPage = pModel->GetPage(0);
367 if (pPage && pPage->GetObjCount() == 1 )
368 {
369 if( dynamic_cast< sdr::table::SdrTableObj* >( pPage->GetObj(0) ) != nullptr )
370 return true;
371 }
372 }
373 return false;
374}
375
376void SdTransferable::AddSupportedFormats()
377{
378 if( mbPageTransferable && !mbPageTransferablePersistent )
379 return;
380
381 if( !mbLateInit )
382 CreateData();
383
384 if( mpObjDesc )
385 AddFormat( SotClipboardFormatId::OBJECTDESCRIPTOR );
386
387 if( mpOLEDataHelper )
388 {
389 AddFormat( SotClipboardFormatId::EMBED_SOURCE );
390
391 DataFlavorExVector aVector( mpOLEDataHelper->GetDataFlavorExVector() );
392
393 for( const auto& rItem : aVector )
394 AddFormat( rItem );
395 }
396 else if( mpGraphic )
397 {
398 // #i25616#
399 AddFormat( SotClipboardFormatId::DRAWING );
400
401 AddFormat( SotClipboardFormatId::SVXB );
402
403 if( mpGraphic->GetType() == GraphicType::Bitmap )
404 {
405 AddFormat( SotClipboardFormatId::PNG );
406 AddFormat( SotClipboardFormatId::BITMAP );
407 AddFormat( SotClipboardFormatId::GDIMETAFILE );
408 }
409 else
410 {
411 AddFormat( SotClipboardFormatId::GDIMETAFILE );
412 AddFormat( SotClipboardFormatId::PNG );
413 AddFormat( SotClipboardFormatId::BITMAP );
414 }
415 }
416 else if( mpBookmark )
417 {
418 AddFormat( SotClipboardFormatId::NETSCAPE_BOOKMARK );
419 AddFormat( SotClipboardFormatId::STRING );
420 }
421 else
422 {
423 AddFormat( SotClipboardFormatId::EMBED_SOURCE );
424 AddFormat( SotClipboardFormatId::DRAWING );
425 if( !mpSdDrawDocument || !lcl_HasOnlyControls( mpSdDrawDocument ) )
426 {
427 AddFormat( SotClipboardFormatId::GDIMETAFILE );
428 AddFormat( SotClipboardFormatId::PNG );
429 AddFormat( SotClipboardFormatId::BITMAP );
430 }
431
432 if( lcl_HasOnlyOneTable( mpSdDrawDocument ) ) {
433 AddFormat( SotClipboardFormatId::RTF );
434 AddFormat( SotClipboardFormatId::RICHTEXT );
435 }
436 }
437
438 if( mpImageMap )
439 AddFormat( SotClipboardFormatId::SVIM );
440}
441
442bool SdTransferable::GetData( const DataFlavor& rFlavor, const OUString& rDestDoc )
443{
444 if (SD_MOD()( static_cast<SdModule*>(SfxApplication::GetModule(SfxToolsModule
::Draw)) )==nullptr)
445 return false;
446
447 SotClipboardFormatId nFormat = SotExchange::GetFormat( rFlavor );
448 bool bOK = false;
449
450 CreateData();
451
452 if( nFormat == SotClipboardFormatId::RTF && lcl_HasOnlyOneTable( mpSdDrawDocument ) )
453 {
454 bOK = SetTableRTF( mpSdDrawDocument );
455 }
456 else if( mpOLEDataHelper && mpOLEDataHelper->HasFormat( rFlavor ) )
457 {
458 // TODO/LATER: support all the graphical formats, the embedded object scenario should not have separated handling
459 if( nFormat == SotClipboardFormatId::GDIMETAFILE && mpGraphic )
460 bOK = SetGDIMetaFile( mpGraphic->GetGDIMetaFile() );
461 else
462 bOK = SetAny( mpOLEDataHelper->GetAny(rFlavor, rDestDoc) );
463 }
464 else if( HasFormat( nFormat ) )
465 {
466 if( ( nFormat == SotClipboardFormatId::LINKSRCDESCRIPTOR || nFormat == SotClipboardFormatId::OBJECTDESCRIPTOR ) && mpObjDesc )
467 {
468 bOK = SetTransferableObjectDescriptor( *mpObjDesc );
469 }
470 else if( nFormat == SotClipboardFormatId::DRAWING )
471 {
472 SfxObjectShellRef aOldRef( maDocShellRef );
473
474 maDocShellRef.clear();
475
476 if( mpSdViewIntern )
477 {
478 SdDrawDocument& rInternDoc = mpSdViewIntern->GetDoc();
479 rInternDoc.CreatingDataObj(this);
480 SdDrawDocument* pDoc = dynamic_cast< SdDrawDocument* >( mpSdViewIntern->CreateMarkedObjModel().release() );
481 rInternDoc.CreatingDataObj(nullptr);
482
483 bOK = SetObject( pDoc, SDTRANSFER_OBJECTTYPE_DRAWMODEL, rFlavor );
484
485 if( maDocShellRef.is() )
486 {
487 maDocShellRef->DoClose();
488 }
489 else
490 {
491 delete pDoc;
492 }
493 }
494
495 maDocShellRef = aOldRef;
496 }
497 else if( nFormat == SotClipboardFormatId::GDIMETAFILE )
498 {
499 if (mpSdViewIntern)
500 {
501 const bool bToggleOnlineSpell = mpSdDrawDocumentIntern && mpSdDrawDocumentIntern->GetOnlineSpell();
502 if (bToggleOnlineSpell)
503 mpSdDrawDocumentIntern->SetOnlineSpell(false);
504 bOK = SetGDIMetaFile( mpSdViewIntern->GetMarkedObjMetaFile( true ) );
505 if (bToggleOnlineSpell)
506 mpSdDrawDocumentIntern->SetOnlineSpell(true);
507 }
508 }
509 else if( SotClipboardFormatId::BITMAP == nFormat || SotClipboardFormatId::PNG == nFormat )
510 {
511 if (mpSdViewIntern)
512 {
513 const bool bToggleOnlineSpell = mpSdDrawDocumentIntern && mpSdDrawDocumentIntern->GetOnlineSpell();
514 if (bToggleOnlineSpell)
515 mpSdDrawDocumentIntern->SetOnlineSpell(false);
516 bOK = SetBitmapEx( mpSdViewIntern->GetMarkedObjBitmapEx(true), rFlavor );
517 if (bToggleOnlineSpell)
518 mpSdDrawDocumentIntern->SetOnlineSpell(true);
519 }
520 }
521 else if( ( nFormat == SotClipboardFormatId::STRING ) && mpBookmark )
522 {
523 bOK = SetString( mpBookmark->GetURL(), rFlavor );
524 }
525 else if( ( nFormat == SotClipboardFormatId::SVXB ) && mpGraphic )
526 {
527 bOK = SetGraphic( *mpGraphic );
528 }
529 else if( ( nFormat == SotClipboardFormatId::SVIM ) && mpImageMap )
530 {
531 bOK = SetImageMap( *mpImageMap );
532 }
533 else if( mpBookmark )
534 {
535 bOK = SetINetBookmark( *mpBookmark, rFlavor );
536 }
537 else if( nFormat == SotClipboardFormatId::EMBED_SOURCE )
538 {
539 if( mpSdDrawDocumentIntern )
540 {
541 if( !maDocShellRef.is() )
542 {
543 maDocShellRef = new ::sd::DrawDocShell(
544 mpSdDrawDocumentIntern,
545 SfxObjectCreateMode::EMBEDDED,
546 true,
547 mpSdDrawDocumentIntern->GetDocumentType());
548 mbOwnDocument = false;
549 maDocShellRef->DoInitNew();
550 }
551
552 maDocShellRef->SetVisArea( maVisArea );
553 bOK = SetObject( maDocShellRef.get(), SDTRANSFER_OBJECTTYPE_DRAWOLE, rFlavor );
554 }
555 }
556 }
557
558 return bOK;
559}
560
561bool SdTransferable::WriteObject( tools::SvRef<SotStorageStream>& rxOStm, void* pObject, sal_uInt32 nObjectType, const DataFlavor& )
562{
563 bool bRet = false;
564
565 switch( nObjectType )
566 {
567 case SDTRANSFER_OBJECTTYPE_DRAWMODEL:
568 {
569 try
570 {
571 static const bool bDontBurnInStyleSheet = ( getenv( "AVOID_BURN_IN_FOR_GALLERY_THEME" ) != nullptr );
572 SdDrawDocument* pDoc = static_cast<SdDrawDocument*>(pObject);
573 if ( !bDontBurnInStyleSheet )
574 pDoc->BurnInStyleSheetAttributes();
575 rxOStm->SetBufferSize( 16348 );
576
577 Reference< XComponent > xComponent( new SdXImpressDocument( pDoc, true ) );
578 pDoc->setUnoModel( Reference< XInterface >::query( xComponent ) );
579
580 {
581 css::uno::Reference<css::io::XOutputStream> xDocOut( new utl::OOutputStreamWrapper( *rxOStm ) );
582 if( SvxDrawingLayerExport( pDoc, xDocOut, xComponent, (pDoc->GetDocumentType() == DocumentType::Impress) ? "com.sun.star.comp.Impress.XMLClipboardExporter" : "com.sun.star.comp.DrawingLayer.XMLExporter" ) )
583 rxOStm->Commit();
584 }
585
586 xComponent->dispose();
587 bRet = ( rxOStm->GetError() == ERRCODE_NONEErrCode(0) );
588 }
589 catch( Exception& )
590 {
591 OSL_FAIL( "sd::SdTransferable::WriteObject(), exception caught!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sd/source/ui/app/sdxfer.cxx"
":" "591" ": "), "%s", "sd::SdTransferable::WriteObject(), exception caught!"
); } } while (false);
592 bRet = false;
593 }
594 }
595 break;
596
597 case SDTRANSFER_OBJECTTYPE_DRAWOLE:
598 {
599 SfxObjectShell* pEmbObj = static_cast<SfxObjectShell*>(pObject);
600 ::utl::TempFile aTempFile;
601 aTempFile.EnableKillingFile();
602
603 try
604 {
605 uno::Reference< embed::XStorage > xWorkStore =
606 ::comphelper::OStorageHelper::GetStorageFromURL( aTempFile.GetURL(), embed::ElementModes::READWRITE );
607
608 // write document storage
609 pEmbObj->SetupStorage( xWorkStore, SOFFICE_FILEFORMAT_CURRENT6800, false );
610 // mba: no relative URLs for clipboard!
611 SfxMedium aMedium( xWorkStore, OUString() );
612 pEmbObj->DoSaveObjectAs( aMedium, false );
613 pEmbObj->DoSaveCompleted();
614
615 uno::Reference< embed::XTransactedObject > xTransact( xWorkStore, uno::UNO_QUERY );
616 if ( xTransact.is() )
617 xTransact->commit();
618
619 std::unique_ptr<SvStream> pSrcStm = ::utl::UcbStreamHelper::CreateStream( aTempFile.GetURL(), StreamMode::READ );
620 if( pSrcStm )
621 {
622 rxOStm->SetBufferSize( 0xff00 );
623 rxOStm->WriteStream( *pSrcStm );
624 pSrcStm.reset();
625 }
626
627 bRet = true;
628 rxOStm->Commit();
629 }
630 catch ( Exception& )
631 {}
632 }
633
634 break;
635
636 default:
637 break;
638 }
639
640 return bRet;
641}
642
643void SdTransferable::DragFinished( sal_Int8 nDropAction )
644{
645 if( mpSdView )
646 const_cast< ::sd::View* >(mpSdView)->DragFinished( nDropAction );
647}
648
649void SdTransferable::ObjectReleased()
650{
651 if( this == SD_MOD()( static_cast<SdModule*>(SfxApplication::GetModule(SfxToolsModule
::Draw)) )->pTransferClip )
652 SD_MOD()( static_cast<SdModule*>(SfxApplication::GetModule(SfxToolsModule
::Draw)) )->pTransferClip = nullptr;
653
654 if( this == SD_MOD()( static_cast<SdModule*>(SfxApplication::GetModule(SfxToolsModule
::Draw)) )->pTransferDrag )
655 SD_MOD()( static_cast<SdModule*>(SfxApplication::GetModule(SfxToolsModule
::Draw)) )->pTransferDrag = nullptr;
656
657 if( this == SD_MOD()( static_cast<SdModule*>(SfxApplication::GetModule(SfxToolsModule
::Draw)) )->pTransferSelection )
658 SD_MOD()( static_cast<SdModule*>(SfxApplication::GetModule(SfxToolsModule
::Draw)) )->pTransferSelection = nullptr;
659}
660
661void SdTransferable::SetObjectDescriptor( std::unique_ptr<TransferableObjectDescriptor> pObjDesc )
662{
663 mpObjDesc = std::move(pObjDesc);
664 PrepareOLE( *mpObjDesc );
665}
666
667void SdTransferable::SetPageBookmarks( const std::vector<OUString> &rPageBookmarks, bool bPersistent )
668{
669 if( !mpSourceDoc )
670 return;
671
672 if( mpSdViewIntern )
673 mpSdViewIntern->HideSdrPage();
674
675 mpSdDrawDocument->ClearModel(false);
676
677 mpPageDocShell = nullptr;
678
679 maPageBookmarks.clear();
680
681 if( bPersistent )
682 {
683 mpSdDrawDocument->CreateFirstPages(mpSourceDoc);
684 mpSdDrawDocument->InsertBookmarkAsPage( rPageBookmarks, nullptr, false, true, 1, true,
685 mpSourceDoc->GetDocSh(), true, true, false );
686 }
687 else
688 {
689 mpPageDocShell = mpSourceDoc->GetDocSh();
690 maPageBookmarks = rPageBookmarks;
691 }
692
693 if( mpSdViewIntern )
694 {
695 SdPage* pPage = mpSdDrawDocument->GetSdPage( 0, PageKind::Standard );
696
697 if( pPage )
698 {
699 mpSdViewIntern->MarkAllObj( mpSdViewIntern->ShowSdrPage( pPage ) );
700 }
701 }
702
703 // set flags for page transferable; if ( mbPageTransferablePersistent == sal_False ),
704 // don't offer any formats => it's just for internal purposes
705 mbPageTransferable = true;
706 mbPageTransferablePersistent = bPersistent;
707}
708
709sal_Int64 SAL_CALL SdTransferable::getSomething( const css::uno::Sequence< sal_Int8 >& rId )
710{
711 sal_Int64 nRet;
712
713 if( isUnoTunnelId<SdTransferable>(rId) )
714 {
715 nRet = sal::static_int_cast<sal_Int64>(reinterpret_cast<sal_IntPtr>(this));
716 }
717 else
718 {
719 nRet = 0;
720 }
721
722 return nRet;
723}
724
725void SdTransferable::AddUserData (const std::shared_ptr<UserData>& rpData)
726{
727 maUserData.push_back(rpData);
728}
729
730sal_Int32 SdTransferable::GetUserDataCount() const
731{
732 return maUserData.size();
733}
734
735std::shared_ptr<SdTransferable::UserData> SdTransferable::GetUserData (const sal_Int32 nIndex) const
736{
737 if (nIndex>=0 && nIndex<sal_Int32(maUserData.size()))
738 return maUserData[nIndex];
739 else
740 return std::shared_ptr<UserData>();
741}
742
743namespace
744{
745 class theSdTransferableUnoTunnelId : public rtl::Static< UnoTunnelIdInit, theSdTransferableUnoTunnelId > {};
746}
747
748const css::uno::Sequence< sal_Int8 >& SdTransferable::getUnoTunnelId()
749{
750 return theSdTransferableUnoTunnelId::get().getSeq();
751}
752
753SdTransferable* SdTransferable::getImplementation( const Reference< XInterface >& rxData ) throw()
754{
755 try
756 {
757 Reference< css::lang::XUnoTunnel > xUnoTunnel( rxData, UNO_QUERY_THROW );
758 return reinterpret_cast<SdTransferable*>(sal::static_int_cast<sal_uIntPtr>(xUnoTunnel->getSomething( SdTransferable::getUnoTunnelId()) ) );
759 }
760 catch( const css::uno::Exception& )
761 {
762 }
763 return nullptr;
764}
765
766void SdTransferable::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
767{
768 if (rHint.GetId() == SfxHintId::ThisIsAnSdrHint)
769 {
770 const SdrHint* pSdrHint = static_cast< const SdrHint* >( &rHint );
771 if( SdrHintKind::ModelCleared == pSdrHint->GetKind() )
772 {
773 EndListening(*mpSourceDoc);
774 mpSourceDoc = nullptr;
775 }
776 }
777 else
778 {
779 if( rHint.GetId() == SfxHintId::Dying )
780 {
781 if( &rBC == mpSourceDoc )
782 mpSourceDoc = nullptr;
783 if( &rBC == mpSdViewIntern )
784 mpSdViewIntern = nullptr;
785 if( &rBC == mpSdView )
786 mpSdView = nullptr;
787 }
788 }
789}
790
791void SdTransferable::SetView(const ::sd::View* pView)
792{
793 if (mpSdView)
794 EndListening(*const_cast<sd::View*>(mpSdView));
795 mpSdView = pView;
796 if (mpSdView)
797 StartListening(*const_cast<sd::View*>(mpSdView));
798}
799
800bool SdTransferable::SetTableRTF( SdDrawDocument* pModel )
801{
802 if ( pModel )
803 {
804 SdrPage* pPage = pModel->GetPage(0);
805 if (pPage && pPage->GetObjCount() == 1 )
806 {
807 sdr::table::SdrTableObj* pTableObj = dynamic_cast< sdr::table::SdrTableObj* >( pPage->GetObj(0) );
808 if( pTableObj )
809 {
810 SvMemoryStream aMemStm( 65535, 65535 );
811 sdr::table::ExportAsRTF( aMemStm, *pTableObj );
812 return SetAny( Any( Sequence< sal_Int8 >( static_cast< const sal_Int8* >( aMemStm.GetData() ), aMemStm.TellEnd() ) ) );
813 }
814 }
815 }
816
817 return false;
818}
819
820/* 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);
11
←
Calling copy constructor for 'Reference<VirtualDevice>'
→
14
←
Returning from copy constructor for 'Reference<VirtualDevice>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
15
←
Calling 'Reference::clear'
→
22
←
Returning; memory was released
→
205 if (aTmp.get()) {
23
←
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();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

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