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 tabcont.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/view/tabcont.cxx

/home/maarten/src/libreoffice/core/sc/source/ui/view/tabcont.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/viewfrm.hxx>
21#include <sfx2/dispatch.hxx>
22#include <sfx2/docfile.hxx>
23#include <tools/urlobj.hxx>
24#include <vcl/commandevent.hxx>
25#include <vcl/svapp.hxx>
26#include <tabcont.hxx>
27#include <tabvwsh.hxx>
28#include <docsh.hxx>
29#include <scmod.hxx>
30#include <sc.hrc>
31#include <globstr.hrc>
32#include <transobj.hxx>
33#include <clipparam.hxx>
34#include <dragdata.hxx>
35#include <markdata.hxx>
36#include <gridwin.hxx>
37#include <LibreOfficeKit/LibreOfficeKitEnums.h>
38#include <comphelper/lok.hxx>
39
40ScTabControl::ScTabControl( vcl::Window* pParent, ScViewData* pData )
41 : TabBar(pParent, WB_3DLOOK | WB_MINSCROLL(WinBits(0x20000000)) | WB_SCROLL | WB_RANGESELECT(WinBits(0x00200000)) | WB_MULTISELECT(WinBits(0x00400000)) | WB_DRAG)
42 , DropTargetHelper(this)
43 , DragSourceHelper(this)
44 , pViewData(pData)
45 , nMouseClickPageId(TabBar::PAGE_NOT_FOUND)
46 , nSelPageIdByMouse(TabBar::PAGE_NOT_FOUND)
47 , bErrorShown(false)
48{
49 ScDocument& rDoc = pViewData->GetDocument();
50
51 OUString aString;
52 Color aTabBgColor;
53 SCTAB nCount = rDoc.GetTableCount();
54 for (SCTAB i=0; i<nCount; i++)
55 {
56 if (rDoc.IsVisible(i))
57 {
58 if (rDoc.GetName(i,aString))
59 {
60 if ( rDoc.IsScenario(i) )
61 InsertPage( static_cast<sal_uInt16>(i)+1, aString, TabBarPageBits::Blue);
62 else
63 InsertPage( static_cast<sal_uInt16>(i)+1, aString );
64
65 if ( rDoc.IsTabProtected(i) )
66 SetProtectionSymbol(static_cast<sal_uInt16>(i)+1, true);
67
68 if ( !rDoc.IsDefaultTabBgColor(i) )
69 {
70 aTabBgColor = rDoc.GetTabBgColor(i);
71 SetTabBgColor( static_cast<sal_uInt16>(i)+1, aTabBgColor );
72 }
73 }
74 }
75 }
76
77 SetCurPageId( static_cast<sal_uInt16>(pViewData->GetTabNo()) + 1 );
78
79 SetSizePixel( Size(SC_TABBAR_DEFWIDTH270, 0) );
80
81 SetSplitHdl( LINK( pViewData->GetView(), ScTabView, TabBarResize )::tools::detail::makeLink( ::tools::detail::castTo<ScTabView
*>(pViewData->GetView()), &ScTabView::LinkStubTabBarResize
) );
82
83 EnableEditMode();
84 UpdateInputContext();
85
86 SetScrollAlwaysEnabled(false);
87
88 SetScrollAreaContextHdl( LINK( this, ScTabControl, ShowPageList )::tools::detail::makeLink( ::tools::detail::castTo<ScTabControl
*>(this), &ScTabControl::LinkStubShowPageList) );
89}
90
91IMPL_LINK(ScTabControl, ShowPageList, const CommandEvent &, rEvent, void)void ScTabControl::LinkStubShowPageList(void * instance, const
CommandEvent & data) { return static_cast<ScTabControl
*>(instance)->ShowPageList(data); } void ScTabControl::
ShowPageList(const CommandEvent & rEvent)
1
Calling 'ScTabControl::ShowPageList'
→
92{
93 ScopedVclPtrInstance<PopupMenu> aPopup;
2
←
Calling default constructor for 'ScopedVclPtrInstance<PopupMenu>'
→
4
←
Returning from default constructor for 'ScopedVclPtrInstance<PopupMenu>'
→
94
95 sal_uInt16 nCurPageId = GetCurPageId();
96
97 ScDocument& rDoc = pViewData->GetDocument();
98 SCTAB nCount = rDoc.GetTableCount();
99 for (SCTAB i=0; i<nCount; ++i)
5
←
Assuming 'i' is >= 'nCount'
→
6
←
Loop condition is false. Execution continues on line 114
→
100 {
101 if (rDoc.IsVisible(i))
102 {
103 OUString aString;
104 if (rDoc.GetName(i, aString))
105 {
106 sal_uInt16 nId = static_cast<sal_uInt16>(i)+1;
107 aPopup->InsertItem(nId, aString, MenuItemBits::CHECKABLE);
108 if (nId == nCurPageId)
109 aPopup->CheckItem(nId);
110 }
111 }
112 }
113
114 sal_uInt16 nItemId = aPopup->Execute( this, rEvent.GetMousePosPixel() );
115 SwitchToPageId(nItemId);
116}
7
←
Calling implicit destructor for 'ScopedVclPtrInstance<PopupMenu>'
→
8
←
Calling '~ScopedVclPtr'
→
117
118ScTabControl::~ScTabControl()
119{
120 disposeOnce();
121}
122
123void ScTabControl::dispose()
124{
125 DragSourceHelper::dispose();
126 DropTargetHelper::dispose();
127 TabBar::dispose();
128}
129
130sal_uInt16 ScTabControl::GetMaxId() const
131{
132 sal_uInt16 nVisCnt = GetPageCount();
133 if (nVisCnt)
134 return GetPageId(nVisCnt-1);
135
136 return 0;
137}
138
139SCTAB ScTabControl::GetPrivatDropPos(const Point& rPos )
140{
141 sal_uInt16 nPos = ShowDropPos(rPos);
142
143 SCTAB nRealPos = static_cast<SCTAB>(nPos);
144
145 if(nPos !=0 )
146 {
147 ScDocument& rDoc = pViewData->GetDocument();
148
149 SCTAB nCount = rDoc.GetTableCount();
150
151 sal_uInt16 nViewPos=0;
152 nRealPos = nCount;
153 for (SCTAB i=0; i<nCount; i++)
154 {
155 if (rDoc.IsVisible(i))
156 {
157 nViewPos++;
158 if(nViewPos==nPos)
159 {
160 SCTAB j;
161 for (j=i+1; j<nCount; j++)
162 {
163 if (rDoc.IsVisible(j))
164 {
165 break;
166 }
167 }
168 nRealPos =j;
169 break;
170 }
171 }
172 }
173 }
174 return nRealPos ;
175}
176
177void ScTabControl::MouseButtonDown( const MouseEvent& rMEvt )
178{
179 ScModule* pScMod = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) );
180 if ( !pScMod->IsModalMode() && !pScMod->IsFormulaMode() && !IsInEditMode() )
181 {
182 // activate View
183 pViewData->GetViewShell()->SetActive(); // Appear and SetViewFrame
184 pViewData->GetView()->ActiveGrabFocus();
185 }
186
187 if (rMEvt.IsLeft() && rMEvt.GetModifier() == 0)
188 nMouseClickPageId = GetPageId(rMEvt.GetPosPixel());
189
190 TabBar::MouseButtonDown( rMEvt );
191}
192
193void ScTabControl::MouseButtonUp( const MouseEvent& rMEvt )
194{
195 Point aPos = PixelToLogic( rMEvt.GetPosPixel() );
196
197 // mouse button down and up on same page?
198 if( nMouseClickPageId != GetPageId(aPos))
199 nMouseClickPageId = TabBar::PAGE_NOT_FOUND;
200
201 if ( rMEvt.GetClicks() == 2 && rMEvt.IsLeft() && nMouseClickPageId != 0 && nMouseClickPageId != TabBar::PAGE_NOT_FOUND )
202 {
203 SfxDispatcher* pDispatcher = pViewData->GetViewShell()->GetViewFrame()->GetDispatcher();
204 pDispatcher->Execute( FID_TAB_MENU_RENAME((((((((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 22
)) + 20)) + 29))), SfxCallMode::SYNCHRON | SfxCallMode::RECORD );
205 return;
206 }
207
208 if( nMouseClickPageId == 0 )
209 {
210 // Click in the area next to the existing tabs:
211 // #i70320# if several sheets are selected, deselect all except the current sheet,
212 // otherwise add new sheet
213 sal_uInt16 nSlot = ( GetSelectPageCount() > 1 ) ? FID_TAB_DESELECTALL((((((((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 22
)) + 20)) + 29))+7) : FID_INS_TABLE((((((((26000 + 200) + 20)) + 20)) + 20)) + 9);
214 SfxDispatcher* pDispatcher = pViewData->GetViewShell()->GetViewFrame()->GetDispatcher();
215 pDispatcher->Execute( nSlot, SfxCallMode::SYNCHRON | SfxCallMode::RECORD );
216 // forget page ID, to be really sure that the dialog is not called twice
217 nMouseClickPageId = TabBar::PAGE_NOT_FOUND;
218 }
219
220 TabBar::MouseButtonUp( rMEvt );
221}
222
223void ScTabControl::AddTabClick()
224{
225 TabBar::AddTabClick();
226
227 // Insert a new sheet at the right end, with default name.
228 ScDocument& rDoc = pViewData->GetDocument();
229 ScModule* pScMod = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) );
230 if (!rDoc.IsDocEditable() || pScMod->IsTableLocked())
231 return;
232 OUString aName;
233 rDoc.CreateValidTabName(aName);
234 SCTAB nTabCount = rDoc.GetTableCount();
235 pViewData->GetViewShell()->InsertTable(aName, nTabCount);
236}
237
238void ScTabControl::Select()
239{
240 /* Remember last clicked page ID. */
241 nSelPageIdByMouse = nMouseClickPageId;
242 /* Reset nMouseClickPageId, so that next Select() call may invalidate
243 nSelPageIdByMouse (i.e. if called from keyboard). */
244 nMouseClickPageId = TabBar::PAGE_NOT_FOUND;
245
246 ScModule* pScMod = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) );
247 ScDocument& rDoc = pViewData->GetDocument();
248 ScMarkData& rMark = pViewData->GetMarkData();
249 SCTAB nCount = rDoc.GetTableCount();
250 SCTAB i;
251
252 if ( pScMod->IsTableLocked() ) // may not be switched now ?
253 {
254 // restore the old state of TabControls
255
256 for (i=0; i<nCount; i++)
257 SelectPage( static_cast<sal_uInt16>(i)+1, rMark.GetTableSelect(i) );
258 SetCurPageId( static_cast<sal_uInt16>(pViewData->GetTabNo()) + 1 );
259
260 return;
261 }
262
263 sal_uInt16 nCurId = GetCurPageId();
264 if (!nCurId) return; // for Excel import it can happen that everything is hidden
265 sal_uInt16 nPage = nCurId - 1;
266
267 // OLE-inplace deactivate
268 if ( nPage != static_cast<sal_uInt16>(pViewData->GetTabNo()) )
269 pViewData->GetView()->DrawMarkListHasChanged();
270
271 // InputEnterHandler onlw when not reference input
272
273 bool bRefMode = pScMod->IsFormulaMode();
274 if (!bRefMode)
275 pScMod->InputEnterHandler();
276
277 for (i=0; i<nCount; i++)
278 rMark.SelectTable( i, IsPageSelected(static_cast<sal_uInt16>(i)+1) );
279
280 SfxDispatcher& rDisp = pViewData->GetDispatcher();
281 if (rDisp.IsLocked())
282 pViewData->GetView()->SetTabNo( static_cast<SCTAB>(nPage) );
283 else
284 {
285 // sheet for basic is 1-based
286 SfxUInt16Item aItem( SID_CURRENTTAB((26000) + 42), nPage + 1 );
287 rDisp.ExecuteList(SID_CURRENTTAB((26000) + 42),
288 SfxCallMode::SLOT | SfxCallMode::RECORD, { &aItem });
289 }
290
291 SfxBindings& rBind = pViewData->GetBindings();
292 rBind.Invalidate( FID_FILL_TAB((((26000 + 200) + 20)) + 8) );
293 rBind.Invalidate( FID_TAB_DESELECTALL((((((((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 22
)) + 20)) + 29))+7) );
294
295 rBind.Invalidate( FID_INS_TABLE((((((((26000 + 200) + 20)) + 20)) + 20)) + 9) );
296 rBind.Invalidate( FID_TAB_APPEND((((((((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 22
)) + 20)) + 29))+4) );
297 rBind.Invalidate( FID_TAB_MOVE((((((((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 22
)) + 20)) + 29))+2) );
298 rBind.Invalidate( FID_TAB_RENAME((((((((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 22
)) + 20)) + 29))+1) );
299 rBind.Invalidate( FID_DELETE_TABLE((((26000 + 200) + 20)) + 3) );
300 rBind.Invalidate( FID_TABLE_SHOW((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 10) );
301 rBind.Invalidate( FID_TABLE_HIDE((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 9) );
302 rBind.Invalidate( FID_TAB_SET_TAB_BG_COLOR((((((((((((((((26000 + 200) + 20)) + 20)) + 20)) + 25)) + 22
)) + 20)) + 29)) + 9) );
303
304 // Recalculate status bar functions.
305 rBind.Invalidate( SID_TABLE_CELL( 10000 + 225 ) );
306
307 // SetReference onlw when the consolidate dialog is open
308 // (for references over multiple sheets)
309 // for others this is only needed fidgeting
310
311 if ( bRefMode && pViewData->GetRefType() == SC_REFTYPE_REF )
312 if ( pViewData->GetViewShell()->GetViewFrame()->HasChildWindow(SID_OPENDLG_CONSOLIDATE((26000 + 100) + 50)) )
313 {
314 ScRange aRange(
315 pViewData->GetRefStartX(), pViewData->GetRefStartY(), pViewData->GetRefStartZ(),
316 pViewData->GetRefEndX(), pViewData->GetRefEndY(), pViewData->GetRefEndZ() );
317 pScMod->SetReference( aRange, rDoc, &rMark );
318 pScMod->EndReference(); // due to Auto-Hide
319 }
320}
321
322void ScTabControl::UpdateInputContext()
323{
324 ScDocument& rDoc = pViewData->GetDocument();
325 WinBits nStyle = GetStyle();
326 if (rDoc.GetDocumentShell()->IsReadOnly())
327 // no insert sheet tab for readonly doc.
328 SetStyle(nStyle & ~WB_INSERTTAB(WinBits(0x40000000)));
329 else
330 SetStyle(nStyle | WB_INSERTTAB(WinBits(0x40000000)));
331}
332
333void ScTabControl::UpdateStatus()
334{
335 ScDocument& rDoc = pViewData->GetDocument();
336 ScMarkData& rMark = pViewData->GetMarkData();
337 bool bActive = pViewData->IsActive();
338
339 SCTAB nCount = rDoc.GetTableCount();
340 SCTAB i;
341 OUString aString;
342 SCTAB nMaxCnt = std::max( nCount, static_cast<SCTAB>(GetMaxId()) );
343 Color aTabBgColor;
344
345 bool bModified = false; // sheet name
346 for (i=0; i<nMaxCnt && !bModified; i++)
347 {
348 if (rDoc.IsVisible(i))
349 {
350 rDoc.GetName(i,aString);
351 aTabBgColor = rDoc.GetTabBgColor(i);
352 }
353 else
354 {
355 aString.clear();
356 }
357
358 if ( aString != GetPageText(static_cast<sal_uInt16>(i)+1) || (GetTabBgColor(static_cast<sal_uInt16>(i)+1) != aTabBgColor) )
359 bModified = true;
360 }
361
362 if (bModified)
363 {
364 Clear();
365 for (i=0; i<nCount; i++)
366 {
367 if (rDoc.IsVisible(i))
368 {
369 if (rDoc.GetName(i,aString))
370 {
371 if ( rDoc.IsScenario(i) )
372 InsertPage(static_cast<sal_uInt16>(i)+1, aString, TabBarPageBits::Blue);
373 else
374 InsertPage( static_cast<sal_uInt16>(i)+1, aString );
375
376 if ( rDoc.IsTabProtected(i) )
377 SetProtectionSymbol(static_cast<sal_uInt16>(i)+1, true);
378
379 if ( !rDoc.IsDefaultTabBgColor(i) )
380 {
381 aTabBgColor = rDoc.GetTabBgColor(i);
382 SetTabBgColor(static_cast<sal_uInt16>(i)+1, aTabBgColor );
383 }
384 }
385 }
386 }
387 }
388 SetCurPageId( static_cast<sal_uInt16>(pViewData->GetTabNo()) + 1 );
389
390 if (bActive)
391 {
392 bModified = false; // selection
393 for (i=0; i<nMaxCnt && !bModified; i++)
394 if ( rMark.GetTableSelect(i) != IsPageSelected(static_cast<sal_uInt16>(i)+1) )
395 bModified = true;
396
397 if ( bModified )
398 for (i=0; i<nCount; i++)
399 SelectPage( static_cast<sal_uInt16>(i)+1, rMark.GetTableSelect(i) );
400 }
401}
402
403void ScTabControl::SetSheetLayoutRTL( bool bSheetRTL )
404{
405 SetEffectiveRTL( bSheetRTL );
406 nSelPageIdByMouse = TabBar::PAGE_NOT_FOUND;
407}
408
409void ScTabControl::SwitchToPageId(sal_uInt16 nId)
410{
411 if (!nId)
412 return;
413
414 bool bAlreadySelected = IsPageSelected( nId );
415 //make the clicked page the current one
416 SetCurPageId( nId );
417 //change the selection when the current one is not already
418 //selected or part of a multi selection
419 if(bAlreadySelected)
420 return;
421
422 sal_uInt16 nCount = GetMaxId();
423
424 for (sal_uInt16 i=1; i<=nCount; i++)
425 SelectPage( i, i==nId );
426 Select();
427
428 if (comphelper::LibreOfficeKit::isActive())
429 {
430 // notify LibreOfficeKit about changed page
431 OString aPayload = OString::number(nId - 1);
432 pViewData->GetViewShell()->libreOfficeKitViewCallback(LOK_CALLBACK_SET_PART, aPayload.getStr());
433 }
434}
435
436void ScTabControl::Command( const CommandEvent& rCEvt )
437{
438 ScModule* pScMod = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) );
439 ScTabViewShell* pViewSh = pViewData->GetViewShell();
440 bool bDisable = pScMod->IsFormulaMode() || pScMod->IsModalMode();
441
442 // first activate ViewFrame (Bug 19493):
443 pViewSh->SetActive();
444
445 if (rCEvt.GetCommand() != CommandEventId::ContextMenu || bDisable)
446 return;
447
448 // #i18735# select the page that is under the mouse cursor
449 // if multiple tables are selected and the one under the cursor
450 // is not part of them then unselect them
451 sal_uInt16 nId = GetPageId( rCEvt.GetMousePosPixel() );
452 SwitchToPageId(nId);
453
454 // #i52073# OLE inplace editing has to be stopped before showing the sheet tab context menu
455 pViewSh->DeactivateOle();
456
457 // Popup-Menu:
458 // get Dispatcher from ViewData (ViewFrame) instead of Shell (Frame), so it can't be null
459 pViewData->GetDispatcher().ExecutePopup( "sheettab" );
460}
461
462void ScTabControl::StartDrag( sal_Int8 /* nAction */, const Point& rPosPixel )
463{
464 ScModule* pScMod = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) );
465 bool bDisable = pScMod->IsFormulaMode() || pScMod->IsModalMode();
466
467 if (!bDisable)
468 {
469 vcl::Region aRegion( tools::Rectangle(0,0,0,0) );
470 CommandEvent aCEvt( rPosPixel, CommandEventId::StartDrag, true ); // needed for StartDrag
471 if (TabBar::StartDrag( aCEvt, aRegion ))
472 DoDrag();
473 }
474}
475
476void ScTabControl::DoDrag()
477{
478 ScDocShell* pDocSh = pViewData->GetDocShell();
479 ScDocument& rDoc = pDocSh->GetDocument();
480
481 SCTAB nTab = pViewData->GetTabNo();
482 ScRange aTabRange( 0, 0, nTab, rDoc.MaxCol(), rDoc.MaxRow(), nTab );
483 ScMarkData aTabMark = pViewData->GetMarkData();
484 aTabMark.ResetMark(); // doesn't change marked table information
485 aTabMark.SetMarkArea( aTabRange );
486
487 ScDocumentUniquePtr pClipDoc(new ScDocument( SCDOCMODE_CLIP ));
488 ScClipParam aClipParam(aTabRange, false);
489 rDoc.CopyToClip(aClipParam, pClipDoc.get(), &aTabMark, false, false);
490
491 TransferableObjectDescriptor aObjDesc;
492 pDocSh->FillTransferableObjectDescriptor( aObjDesc );
493 aObjDesc.maDisplayName = pDocSh->GetMedium()->GetURLObject().GetURLNoPass();
494 // maSize is set in ScTransferObj ctor
495
496 rtl::Reference<ScTransferObj> pTransferObj = new ScTransferObj( std::move(pClipDoc), aObjDesc );
497
498 pTransferObj->SetDragSourceFlags(ScDragSrc::Table);
499
500 pTransferObj->SetDragSource( pDocSh, aTabMark );
501
502 pTransferObj->SetSourceCursorPos( pViewData->GetCurX(), pViewData->GetCurY() );
503
504 vcl::Window* pWindow = pViewData->GetActiveWin();
505 SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) )->SetDragObject( pTransferObj.get(), nullptr ); // for internal D&D
506 pTransferObj->StartDrag( pWindow, DND_ACTION_COPYMOVEcss::datatransfer::dnd::DNDConstants::ACTION_COPY_OR_MOVE | DND_ACTION_LINKcss::datatransfer::dnd::DNDConstants::ACTION_LINK );
507}
508
509static sal_uInt16 lcl_DocShellNr( const ScDocument& rDoc )
510{
511 sal_uInt16 nShellCnt = 0;
512 SfxObjectShell* pShell = SfxObjectShell::GetFirst();
513 while ( pShell )
514 {
515 if ( dynamic_cast<const ScDocShell *>(pShell) != nullptr )
516 {
517 if ( &static_cast<ScDocShell*>(pShell)->GetDocument() == &rDoc )
518 return nShellCnt;
519
520 ++nShellCnt;
521 }
522 pShell = SfxObjectShell::GetNext( *pShell );
523 }
524
525 OSL_FAIL("Document not found")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/view/tabcont.cxx"
":" "525" ": "), "%s", "Document not found"); } } while (false
);
526 return 0;
527}
528
529sal_Int8 ScTabControl::ExecuteDrop( const ExecuteDropEvent& rEvt )
530{
531 EndSwitchPage();
532
533 ScDocument& rDoc = pViewData->GetDocument();
534 const ScDragData& rData = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) )->GetDragData();
535 if ( rData.pCellTransfer && (rData.pCellTransfer->GetDragSourceFlags() & ScDragSrc::Table) &&
536 rData.pCellTransfer->GetSourceDocument() == &rDoc )
537 {
538 // moving of tables within the document
539 SCTAB nPos = GetPrivatDropPos( rEvt.maPosPixel );
540 HideDropPos();
541
542 if ( nPos == rData.pCellTransfer->GetVisibleTab() && rEvt.mnAction == DND_ACTION_MOVEcss::datatransfer::dnd::DNDConstants::ACTION_MOVE )
543 {
544 // #i83005# do nothing - don't move to the same position
545 // (too easily triggered unintentionally, and might take a long time in large documents)
546 }
547 else
548 {
549 if ( !rDoc.GetChangeTrack() && rDoc.IsDocEditable() )
550 {
551 //! use table selection from the tab control where dragging was started?
552 pViewData->GetView()->MoveTable( lcl_DocShellNr(rDoc), nPos, rEvt.mnAction != DND_ACTION_MOVEcss::datatransfer::dnd::DNDConstants::ACTION_MOVE );
553
554 rData.pCellTransfer->SetDragWasInternal(); // don't delete
555 return DND_ACTION_COPYcss::datatransfer::dnd::DNDConstants::ACTION_COPY;
556 }
557 }
558 }
559
560 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
561}
562
563sal_Int8 ScTabControl::AcceptDrop( const AcceptDropEvent& rEvt )
564{
565 if ( rEvt.mbLeaving )
566 {
567 EndSwitchPage();
568 HideDropPos();
569 return rEvt.mnAction;
570 }
571
572 const ScDocument& rDoc = pViewData->GetDocument();
573 const ScDragData& rData = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) )->GetDragData();
574 if ( rData.pCellTransfer && (rData.pCellTransfer->GetDragSourceFlags() & ScDragSrc::Table) &&
575 rData.pCellTransfer->GetSourceDocument() == &rDoc )
576 {
577 // moving of tables within the document
578 if ( !rDoc.GetChangeTrack() && rDoc.IsDocEditable() )
579 {
580 ShowDropPos( rEvt.maPosPixel );
581 return rEvt.mnAction;
582 }
583 }
584 else // switch sheets for all formats
585 {
586 SwitchPage( rEvt.maPosPixel ); // switch sheet after timeout
587 return 0; // nothing can be dropped here
588 }
589
590 return 0;
591}
592
593bool ScTabControl::StartRenaming()
594{
595 return pViewData->GetDocument().IsDocEditable();
596}
597
598TabBarAllowRenamingReturnCode ScTabControl::AllowRenaming()
599{
600 ScTabViewShell* pViewSh = pViewData->GetViewShell();
601 OSL_ENSURE( pViewSh, "pViewData->GetViewShell()" )do { if (true && (!(pViewSh))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/view/tabcont.cxx"
":" "601" ": "), "%s", "pViewData->GetViewShell()"); } } while
(false);
602
603 TabBarAllowRenamingReturnCode nRet = TABBAR_RENAMING_CANCEL;
604 sal_uInt16 nId = GetEditPageId();
605 if ( nId )
606 {
607 SCTAB nTab = nId - 1;
608 OUString aNewName = GetEditText();
609 bool bDone = pViewSh->RenameTable( aNewName, nTab );
610 if ( bDone )
611 nRet = TABBAR_RENAMING_YES;
612 else if ( bErrorShown )
613 {
614 // if the error message from this TabControl is currently visible,
615 // don't end edit mode now, to avoid problems when returning to
616 // the other call (showing the error) - this should not happen
617 OSL_FAIL("ScTabControl::AllowRenaming: nested calls")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/view/tabcont.cxx"
":" "617" ": "), "%s", "ScTabControl::AllowRenaming: nested calls"
); } } while (false);
618 nRet = TABBAR_RENAMING_NO;
619 }
620 else if ( Application::IsInModalMode() )
621 {
622 // don't show error message above any modal dialog
623 // instead cancel renaming without error message
624 nRet = TABBAR_RENAMING_CANCEL;
625 }
626 else
627 {
628 bErrorShown = true;
629 pViewSh->ErrorMessage( STR_INVALIDTABNAMEreinterpret_cast<char const *>("STR_INVALIDTABNAME" "\004"
u8"Invalid sheet name.\nThe sheet name must not be empty or a duplicate of \nan existing name and may not contain the characters [ ] * ? : / \\ \nor the character ' (apostrophe) as first or last character."
) );
630 bErrorShown = false;
631 nRet = TABBAR_RENAMING_NO;
632 }
633 }
634 return nRet;
635}
636
637void ScTabControl::EndRenaming()
638{
639 if ( HasFocus() )
640 pViewData->GetView()->ActiveGrabFocus();
641}
642
643void ScTabControl::Mirror()
644{
645 TabBar::Mirror();
646 if( nSelPageIdByMouse != TabBar::PAGE_NOT_FOUND )
647 {
648 tools::Rectangle aRect( GetPageRect( GetCurPageId() ) );
649 if( !aRect.IsEmpty() )
650 SetPointerPosPixel( aRect.Center() );
651 nSelPageIdByMouse = TabBar::PAGE_NOT_FOUND; // only once after a Select()
652 }
653}
654
655/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
10
←
Calling 'Reference::clear'
→
17
←
Returning; memory was released
→
205 if (aTmp.get()) {
18
←
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();
9
←
Calling 'VclPtr::disposeAndClear'
→
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
3
←
Memory is allocated
→
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
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
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
12
←
Calling 'VclReferenceBase::release'
→
16
←
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;
19
←
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__));
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__));
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

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