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 arealink.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 SC_DLLIMPLEMENTATION -D SC_INFO_OSVERSION="LINUX" -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/liborcus/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/clew/source/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sc/source/core/inc -I /home/maarten/src/libreoffice/core/sc/source/filter/inc -I /home/maarten/src/libreoffice/core/sc/source/ui/inc -I /home/maarten/src/libreoffice/core/sc/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sc/sdi -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/UnoApiHeadersTarget/oovbaapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/sc/source/ui/docshell/arealink.cxx

/home/maarten/src/libreoffice/core/sc/source/ui/docshell/arealink.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 <sfx2/fcontnr.hxx>
21#include <sfx2/linkmgr.hxx>
22#include <vcl/svapp.hxx>
23#include <vcl/weld.hxx>
24#include <vcl/window.hxx>
25#include <unotools/charclass.hxx>
26#include <osl/diagnose.h>
27
28#include <arealink.hxx>
29
30#include <tablink.hxx>
31#include <document.hxx>
32#include <docsh.hxx>
33#include <rangenam.hxx>
34#include <dbdata.hxx>
35#include <undoblk.hxx>
36#include <globstr.hrc>
37#include <scresid.hxx>
38#include <markdata.hxx>
39#include <hints.hxx>
40#include <filter.hxx>
41
42#include <attrib.hxx>
43#include <patattr.hxx>
44#include <docpool.hxx>
45
46#include <scabstdlg.hxx>
47#include <clipparam.hxx>
48
49
50ScAreaLink::ScAreaLink( SfxObjectShell* pShell, const OUString& rFile,
51 const OUString& rFilter, const OUString& rOpt,
52 const OUString& rArea, const ScRange& rDest,
53 sal_uLong nRefresh ) :
54 ::sfx2::SvBaseLink(SfxLinkUpdateMode::ONCALL,SotClipboardFormatId::SIMPLE_FILE),
55 ScRefreshTimer ( nRefresh ),
56 m_pDocSh(static_cast<ScDocShell*>(pShell)),
57 aFileName (rFile),
58 aFilterName (rFilter),
59 aOptions (rOpt),
60 aSourceArea (rArea),
61 aDestArea (rDest),
62 bAddUndo (true),
63 bInCreate (false),
64 bDoInsert (true)
65{
66 OSL_ENSURE(dynamic_cast< const ScDocShell *>( pShell ) != nullptr, "ScAreaLink with wrong ObjectShell")do { if (true && (!(dynamic_cast< const ScDocShell
*>( pShell ) != nullptr))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/docshell/arealink.cxx"
":" "66" ": "), "%s", "ScAreaLink with wrong ObjectShell"); }
} while (false)
;
67 SetRefreshHandler( LINK( this, ScAreaLink, RefreshHdl )::tools::detail::makeLink( ::tools::detail::castTo<ScAreaLink
*>(this), &ScAreaLink::LinkStubRefreshHdl)
);
68 SetRefreshControl( &m_pDocSh->GetDocument().GetRefreshTimerControlAddress() );
69}
70
71ScAreaLink::~ScAreaLink()
72{
73 StopRefreshTimer();
74}
75
76void ScAreaLink::Edit(weld::Window* pParent, const Link<SvBaseLink&,void>& /* rEndEditHdl */ )
77{
78 // use own dialog instead of SvBaseLink::Edit...
79 ScAbstractDialogFactory* pFact = ScAbstractDialogFactory::Create();
80
81 ScopedVclPtr<AbstractScLinkedAreaDlg> pDlg(pFact->CreateScLinkedAreaDlg(pParent));
1
Calling constructor for 'ScopedVclPtr<AbstractScLinkedAreaDlg>'
8
Returning from constructor for 'ScopedVclPtr<AbstractScLinkedAreaDlg>'
9
Calling implicit destructor for 'VclPtr<AbstractScLinkedAreaDlg>'
10
Calling '~Reference'
17
Returning from '~Reference'
18
Returning from destructor for 'VclPtr<AbstractScLinkedAreaDlg>'
82 pDlg->InitFromOldLink( aFileName, aFilterName, aOptions, aSourceArea, GetRefreshDelay() );
19
Calling 'VclPtr::operator->'
83 if ( pDlg->Execute() == RET_OK )
84 {
85 aOptions = pDlg->GetOptions();
86 Refresh( pDlg->GetURL(), pDlg->GetFilter(),
87 pDlg->GetSource(), pDlg->GetRefresh() );
88
89 // copy source data from members (set in Refresh) into link name for dialog
90 OUString aNewLinkName;
91 sfx2::MakeLnkName( aNewLinkName, nullptr, aFileName, aSourceArea, &aFilterName );
92 SetName( aNewLinkName );
93 }
94}
95
96::sfx2::SvBaseLink::UpdateResult ScAreaLink::DataChanged(
97 const OUString&, const css::uno::Any& )
98{
99 // Do not do anything at bInCreate so that update can be called to set
100 // the status in the LinkManager without changing the data in the document
101
102 if (bInCreate)
103 return SUCCESS;
104
105 sfx2::LinkManager* pLinkManager=m_pDocSh->GetDocument().GetLinkManager();
106 if (pLinkManager!=nullptr)
107 {
108 OUString aFile, aArea, aFilter;
109 sfx2::LinkManager::GetDisplayNames(this, nullptr, &aFile, &aArea, &aFilter);
110
111 // the file dialog returns the filter name with the application prefix
112 // -> remove prefix
113 ScDocumentLoader::RemoveAppPrefix( aFilter );
114
115 // dialog doesn't set area, so keep old one
116 if (aArea.isEmpty())
117 {
118 aArea = aSourceArea;
119
120 // adjust in dialog:
121 OUString aNewLinkName;
122 OUString aTmp = aFilter;
123 sfx2::MakeLnkName(aNewLinkName, nullptr, aFile, aArea, &aTmp);
124 aFilter = aTmp;
125 SetName( aNewLinkName );
126 }
127
128 tools::SvRef<sfx2::SvBaseLink> const xThis(this); // keep yourself alive
129 Refresh( aFile, aFilter, aArea, GetRefreshDelay() );
130 }
131
132 return SUCCESS;
133}
134
135void ScAreaLink::Closed()
136{
137 // delete link: Undo
138
139 ScDocument& rDoc = m_pDocSh->GetDocument();
140 bool bUndo (rDoc.IsUndoEnabled());
141 if (bAddUndo && bUndo)
142 {
143 m_pDocSh->GetUndoManager()->AddUndoAction( std::make_unique<ScUndoRemoveAreaLink>( m_pDocSh,
144 aFileName, aFilterName, aOptions,
145 aSourceArea, aDestArea, GetRefreshDelay() ) );
146
147 bAddUndo = false; // only once
148 }
149
150 SCTAB nDestTab = aDestArea.aStart.Tab();
151 rDoc.SetStreamValid(nDestTab, false);
152
153 SvBaseLink::Closed();
154}
155
156void ScAreaLink::SetDestArea(const ScRange& rNew)
157{
158 aDestArea = rNew; // for Undo
159}
160
161void ScAreaLink::SetSource(const OUString& rDoc, const OUString& rFlt, const OUString& rOpt,
162 const OUString& rArea)
163{
164 aFileName = rDoc;
165 aFilterName = rFlt;
166 aOptions = rOpt;
167 aSourceArea = rArea;
168
169 // also update link name for dialog
170 OUString aNewLinkName;
171 sfx2::MakeLnkName( aNewLinkName, nullptr, aFileName, aSourceArea, &aFilterName );
172 SetName( aNewLinkName );
173}
174
175bool ScAreaLink::IsEqual( const OUString& rFile, const OUString& rFilter, const OUString& rOpt,
176 const OUString& rSource, const ScRange& rDest ) const
177{
178 return aFileName == rFile && aFilterName == rFilter && aOptions == rOpt &&
179 aSourceArea == rSource && aDestArea.aStart == rDest.aStart;
180}
181
182// find a range with name >rAreaName< in >rSrcDoc<, return it in >rRange<
183bool ScAreaLink::FindExtRange( ScRange& rRange, const ScDocument& rSrcDoc, const OUString& rAreaName )
184{
185 bool bFound = false;
186 OUString aUpperName = ScGlobal::getCharClassPtr()->uppercase(rAreaName);
187 ScRangeName* pNames = rSrcDoc.GetRangeName();
188 if (pNames) // named ranges
189 {
190 const ScRangeData* p = pNames->findByUpperName(aUpperName);
191 if (p && p->IsValidReference(rRange))
192 bFound = true;
193 }
194 if (!bFound) // database ranges
195 {
196 ScDBCollection* pDBColl = rSrcDoc.GetDBCollection();
197 if (pDBColl)
198 {
199 const ScDBData* pDB = pDBColl->getNamedDBs().findByUpperName(aUpperName);
200 if (pDB)
201 {
202 SCTAB nTab;
203 SCCOL nCol1, nCol2;
204 SCROW nRow1, nRow2;
205 pDB->GetArea(nTab,nCol1,nRow1,nCol2,nRow2);
206 rRange = ScRange( nCol1,nRow1,nTab, nCol2,nRow2,nTab );
207 bFound = true;
208 }
209 }
210 }
211 if (!bFound) // direct reference (range or cell)
212 {
213 ScAddress::Details aDetails(rSrcDoc.GetAddressConvention(), 0, 0);
214 if ( rRange.ParseAny( rAreaName, rSrcDoc, aDetails ) & ScRefFlags::VALID )
215 bFound = true;
216 }
217 return bFound;
218}
219
220// execute:
221
222bool ScAreaLink::Refresh( const OUString& rNewFile, const OUString& rNewFilter,
223 const OUString& rNewArea, sal_uLong nNewRefresh )
224{
225 // load document - like TabLink
226
227 if (rNewFile.isEmpty() || rNewFilter.isEmpty())
228 return false;
229
230 OUString aNewUrl( ScGlobal::GetAbsDocName( rNewFile, m_pDocSh ) );
231 bool bNewUrlName = (aNewUrl != aFileName);
232
233 std::shared_ptr<const SfxFilter> pFilter = m_pDocSh->GetFactory().GetFilterContainer()->GetFilter4FilterName(rNewFilter);
234 if (!pFilter)
235 return false;
236
237 ScDocument& rDoc = m_pDocSh->GetDocument();
238
239 bool bUndo (rDoc.IsUndoEnabled());
240 rDoc.SetInLinkUpdate( true );
241
242 // if new filter was selected, forget options
243 if ( rNewFilter != aFilterName )
244 aOptions.clear();
245
246 SfxMedium* pMed = ScDocumentLoader::CreateMedium( aNewUrl, pFilter, aOptions);
247
248 // aRef->DoClose() will be closed explicitly, but it is still more safe to use SfxObjectShellLock here
249 ScDocShell* pSrcShell = new ScDocShell(SfxModelFlags::EMBEDDED_OBJECT | SfxModelFlags::DISABLE_EMBEDDED_SCRIPTS);
250 SfxObjectShellLock aRef = pSrcShell;
251 pSrcShell->DoLoad(pMed);
252
253 ScDocument& rSrcDoc = pSrcShell->GetDocument();
254
255 // options could have been set
256 OUString aNewOpt = ScDocumentLoader::GetOptions(*pMed);
257 if (aNewOpt.isEmpty())
258 aNewOpt = aOptions;
259
260 // correct source range name list for web query import
261 OUString aTempArea;
262
263 if( rNewFilter == ScDocShell::GetWebQueryFilterName() )
264 aTempArea = ScFormatFilter::Get().GetHTMLRangeNameList( rSrcDoc, rNewArea );
265 else
266 aTempArea = rNewArea;
267
268 // find total size of source area
269 SCCOL nWidth = 0;
270 SCROW nHeight = 0;
271 ScRangeList aSourceRanges;
272
273 if (rNewFilter == SC_TEXT_CSV_FILTER_NAME"Text - txt - csv (StarCalc)" && aTempArea == "CSV_all")
274 {
275 // The dummy All range. All data, including top/left empty
276 // rows/columns.
277 aTempArea.clear();
278 SCCOL nEndCol = 0;
279 SCROW nEndRow = 0;
280 if (rSrcDoc.GetCellArea( 0, nEndCol, nEndRow))
281 {
282 aSourceRanges.push_back( ScRange( 0,0,0, nEndCol, nEndRow, 0));
283 nWidth = nEndCol + 1;
284 nHeight = nEndRow + 2;
285 }
286 }
287
288 if (!aTempArea.isEmpty())
289 {
290 sal_Int32 nIdx {0};
291 do
292 {
293 ScRange aTokenRange;
294 if( FindExtRange( aTokenRange, rSrcDoc, aTempArea.getToken( 0, ';', nIdx ) ) )
295 {
296 aSourceRanges.push_back( aTokenRange);
297 // columns: find maximum
298 nWidth = std::max( nWidth, static_cast<SCCOL>(aTokenRange.aEnd.Col() - aTokenRange.aStart.Col() + 1) );
299 // rows: add row range + 1 empty row
300 nHeight += aTokenRange.aEnd.Row() - aTokenRange.aStart.Row() + 2;
301 }
302 }
303 while (nIdx>0);
304 }
305 // remove the last empty row
306 if( nHeight > 0 )
307 nHeight--;
308
309 // delete old data / copy new
310
311 ScAddress aDestPos = aDestArea.aStart;
312 SCTAB nDestTab = aDestPos.Tab();
313 ScRange aOldRange = aDestArea;
314 ScRange aNewRange = aDestArea; // old range, if file not found or similar
315 if (nWidth > 0 && nHeight > 0)
316 {
317 aNewRange.aEnd.SetCol( aNewRange.aStart.Col() + nWidth - 1 );
318 aNewRange.aEnd.SetRow( aNewRange.aStart.Row() + nHeight - 1 );
319 }
320
321 //! check CanFitBlock only if bDoInsert is set?
322 bool bCanDo = rDoc.ValidColRow( aNewRange.aEnd.Col(), aNewRange.aEnd.Row() ) &&
323 rDoc.CanFitBlock( aOldRange, aNewRange );
324 if (bCanDo)
325 {
326 ScDocShellModificator aModificator( *m_pDocSh );
327
328 SCCOL nOldEndX = aOldRange.aEnd.Col();
329 SCROW nOldEndY = aOldRange.aEnd.Row();
330 SCCOL nNewEndX = aNewRange.aEnd.Col();
331 SCROW nNewEndY = aNewRange.aEnd.Row();
332 ScRange aMaxRange( aDestPos,
333 ScAddress(std::max(nOldEndX,nNewEndX), std::max(nOldEndY,nNewEndY), nDestTab) );
334
335 // initialise Undo
336
337 ScDocumentUniquePtr pUndoDoc;
338 if ( bAddUndo && bUndo )
339 {
340 pUndoDoc.reset(new ScDocument( SCDOCMODE_UNDO ));
341 if ( bDoInsert )
342 {
343 if ( nNewEndX != nOldEndX || nNewEndY != nOldEndY ) // range changed?
344 {
345 pUndoDoc->InitUndo( rDoc, 0, rDoc.GetTableCount()-1 );
346 rDoc.CopyToDocument(0, 0, 0, rDoc.MaxCol(), rDoc.MaxRow(), MAXTAB,
347 InsertDeleteFlags::FORMULA, false, *pUndoDoc); // all formulas
348 }
349 else
350 pUndoDoc->InitUndo( rDoc, nDestTab, nDestTab ); // only destination table
351 rDoc.CopyToDocument(aOldRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pUndoDoc);
352 }
353 else // without insertion
354 {
355 pUndoDoc->InitUndo( rDoc, nDestTab, nDestTab ); // only destination table
356 rDoc.CopyToDocument(aMaxRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pUndoDoc);
357 }
358 }
359
360 // insert / delete cells
361 // DeleteAreaTab also deletes MERGE_FLAG attributes
362
363 if (bDoInsert)
364 rDoc.FitBlock( aOldRange, aNewRange ); // incl. deletion
365 else
366 rDoc.DeleteAreaTab( aMaxRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE );
367
368 // copy data
369
370 if (nWidth > 0 && nHeight > 0)
371 {
372 ScDocument aClipDoc( SCDOCMODE_CLIP );
373 ScRange aNewTokenRange( aNewRange.aStart );
374 for (size_t nRange = 0; nRange < aSourceRanges.size(); ++nRange)
375 {
376 ScRange const & rTokenRange( aSourceRanges[nRange]);
377 SCTAB nSrcTab = rTokenRange.aStart.Tab();
378 ScMarkData aSourceMark(rSrcDoc.GetSheetLimits());
379 aSourceMark.SelectOneTable( nSrcTab ); // selecting for CopyToClip
380 aSourceMark.SetMarkArea( rTokenRange );
381
382 ScClipParam aClipParam(rTokenRange, false);
383 rSrcDoc.CopyToClip(aClipParam, &aClipDoc, &aSourceMark, false, false);
384
385 if ( aClipDoc.HasAttrib( 0,0,nSrcTab, rDoc.MaxCol(),rDoc.MaxRow(),nSrcTab,
386 HasAttrFlags::Merged | HasAttrFlags::Overlapped ) )
387 {
388 //! ResetAttrib at document !!!
389
390 ScPatternAttr aPattern( rSrcDoc.GetPool() );
391 aPattern.GetItemSet().Put( ScMergeAttr() ); // Defaults
392 aPattern.GetItemSet().Put( ScMergeFlagAttr() );
393 aClipDoc.ApplyPatternAreaTab( 0,0, rDoc.MaxCol(),rDoc.MaxRow(), nSrcTab, aPattern );
394 }
395
396 aNewTokenRange.aEnd.SetCol( aNewTokenRange.aStart.Col() + (rTokenRange.aEnd.Col() - rTokenRange.aStart.Col()) );
397 aNewTokenRange.aEnd.SetRow( aNewTokenRange.aStart.Row() + (rTokenRange.aEnd.Row() - rTokenRange.aStart.Row()) );
398 ScMarkData aDestMark(rDoc.GetSheetLimits());
399 aDestMark.SelectOneTable( nDestTab );
400 aDestMark.SetMarkArea( aNewTokenRange );
401 rDoc.CopyFromClip( aNewTokenRange, aDestMark, InsertDeleteFlags::ALL, nullptr, &aClipDoc, false );
402 aNewTokenRange.aStart.SetRow( aNewTokenRange.aEnd.Row() + 2 );
403 }
404 }
405 else
406 {
407 OUString aErr = ScResId(STR_LINKERRORreinterpret_cast<char const *>("STR_LINKERROR" "\004" u8"The link could not be updated."
)
);
408 rDoc.SetString( aDestPos.Col(), aDestPos.Row(), aDestPos.Tab(), aErr );
409 }
410
411 // enter Undo
412
413 if ( bAddUndo && bUndo)
414 {
415 ScDocumentUniquePtr pRedoDoc(new ScDocument( SCDOCMODE_UNDO ));
416 pRedoDoc->InitUndo( rDoc, nDestTab, nDestTab );
417 rDoc.CopyToDocument(aNewRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pRedoDoc);
418
419 m_pDocSh->GetUndoManager()->AddUndoAction(
420 std::make_unique<ScUndoUpdateAreaLink>( m_pDocSh,
421 aFileName, aFilterName, aOptions,
422 aSourceArea, aOldRange, GetRefreshDelay(),
423 aNewUrl, rNewFilter, aNewOpt,
424 rNewArea, aNewRange, nNewRefresh,
425 std::move(pUndoDoc), std::move(pRedoDoc), bDoInsert ) );
426 }
427
428 // remember new settings
429
430 if ( bNewUrlName )
431 aFileName = aNewUrl;
432 if ( rNewFilter != aFilterName )
433 aFilterName = rNewFilter;
434 if ( rNewArea != aSourceArea )
435 aSourceArea = rNewArea;
436 if ( aNewOpt != aOptions )
437 aOptions = aNewOpt;
438
439 if ( aNewRange != aDestArea )
440 aDestArea = aNewRange;
441
442 if ( nNewRefresh != GetRefreshDelay() )
443 SetRefreshDelay( nNewRefresh );
444
445 SCCOL nPaintEndX = std::max( aOldRange.aEnd.Col(), aNewRange.aEnd.Col() );
446 SCROW nPaintEndY = std::max( aOldRange.aEnd.Row(), aNewRange.aEnd.Row() );
447
448 if ( aOldRange.aEnd.Col() != aNewRange.aEnd.Col() )
449 nPaintEndX = rDoc.MaxCol();
450 if ( aOldRange.aEnd.Row() != aNewRange.aEnd.Row() )
451 nPaintEndY = rDoc.MaxRow();
452
453 if ( !m_pDocSh->AdjustRowHeight( aDestPos.Row(), nPaintEndY, nDestTab ) )
454 m_pDocSh->PostPaint(
455 ScRange(aDestPos.Col(), aDestPos.Row(), nDestTab, nPaintEndX, nPaintEndY, nDestTab),
456 PaintPartFlags::Grid);
457 aModificator.SetDocumentModified();
458 }
459 else
460 {
461 // CanFitBlock sal_False -> Problems with summarized cells or table boundary reached!
462 //! cell protection ???
463
464 //! Link dialog must set default parent
465 // "cannot insert rows"
466 vcl::Window* pWin = Application::GetDefDialogParent();
467 std::unique_ptr<weld::MessageDialog> xInfoBox(Application::CreateMessageDialog(pWin ? pWin->GetFrameWeld() : nullptr,
468 VclMessageType::Info, VclButtonsType::Ok,
469 ScResId(STR_MSSG_DOSUBTOTALS_2reinterpret_cast<char const *>("STR_MSSG_DOSUBTOTALS_2"
"\004" u8"Unable to insert rows")
)));
470 xInfoBox->run();
471 }
472
473 // clean up
474
475 aRef->DoClose();
476
477 rDoc.SetInLinkUpdate( false );
478
479 if (bCanDo)
480 {
481 // notify Uno objects (for XRefreshListener)
482 //! also notify Uno objects if file name was changed!
483 ScLinkRefreshedHint aHint;
484 aHint.SetAreaLink( aDestPos );
485 rDoc.BroadcastUno( aHint );
486 }
487
488 return bCanDo;
489}
490
491IMPL_LINK_NOARG(ScAreaLink, RefreshHdl, Timer *, void)void ScAreaLink::LinkStubRefreshHdl(void * instance, Timer * data
) { return static_cast<ScAreaLink *>(instance)->RefreshHdl
(data); } void ScAreaLink::RefreshHdl(__attribute__ ((unused)
) Timer *)
492{
493 Refresh( aFileName, aFilterName, aSourceArea, GetRefreshDelay() );
494}
495
496/* 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();
20
Calling 'Reference::get'
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
2
Calling implicit copy constructor for 'VclPtr<AbstractScLinkedAreaDlg>'
3
Calling copy constructor for 'Reference<AbstractScLinkedAreaDlg>'
6
Returning from copy constructor for 'Reference<AbstractScLinkedAreaDlg>'
7
Returning from copy constructor for 'VclPtr<AbstractScLinkedAreaDlg>'
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)
4
Assuming field 'm_pBody' is non-null
5
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
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
)
11
Taking true branch
113 m_pBody->release();
12
Calling 'VclReferenceBase::release'
16
Returning; memory was released
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
21
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)
13
Assuming the condition is true
14
Taking true branch
40 delete this;
15
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