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 view0.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 SW_DLLIMPLEMENTATION -D SWUI_DLL_NAME="libswuilo.so" -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sw/source/core/inc -I /home/maarten/src/libreoffice/core/sw/source/filter/inc -I /home/maarten/src/libreoffice/core/sw/source/uibase/inc -I /home/maarten/src/libreoffice/core/sw/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sw/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/CustomTarget/sw/generated -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/sw/source/uibase/uiview/view0.cxx

/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/view0.cxx

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#include <config_features.h>
21
22#include <SwSpellDialogChildWindow.hxx>
23#include <svl/eitem.hxx>
24#include <unotools/configmgr.hxx>
25#include <unotools/linguprops.hxx>
26#include <unotools/lingucfg.hxx>
27#include <viewopt.hxx>
28#include <globals.h>
29#include <sfx2/infobar.hxx>
30#include <sfx2/request.hxx>
31#include <svl/whiter.hxx>
32#include <svx/srchdlg.hxx>
33#include <sfx2/viewfrm.hxx>
34#include <sfx2/bindings.hxx>
35#include <sfx2/sidebar/SidebarChildWindow.hxx>
36#include <uivwimp.hxx>
37#include <avmedia/mediaplayer.hxx>
38#include <swmodule.hxx>
39#include <com/sun/star/linguistic2/XLinguProperties.hpp>
40
41#include <sfx2/objface.hxx>
42#include <wrtsh.hxx>
43#include <edtwin.hxx>
44#include <view.hxx>
45#include <docsh.hxx>
46#include <doc.hxx>
47#include <globals.hrc>
48#include <cmdid.h>
49#include <globdoc.hxx>
50#include <wview.hxx>
51
52#define ShellClass_SwView
53#define ShellClass_Text
54#define ShellClass_TextDrawText
55
56#include <sfx2/msg.hxx>
57#include <swslots.hxx>
58#include <PostItMgr.hxx>
59
60using namespace ::com::sun::star;
61
62#include <unotools/moduleoptions.hxx>
63#include <sfx2/viewfac.hxx>
64
65#include <memory>
66#include <swabstdlg.hxx>
67
68SFX_IMPL_NAMED_VIEWFACTORY(SwView, "Default")SfxViewFactory* SwView::pFactory; SfxViewShell* SwView::CreateInstance
(SfxViewFrame *pFrame, SfxViewShell *pOldView) { return new SwView
(pFrame, pOldView); } void SwView::RegisterFactory( SfxInterfaceId
nPrio ) { pFactory = new SfxViewFactory(&CreateInstance,
nPrio,"Default"); InitFactory(); } void SwView::InitFactory()
69{
70 if (utl::ConfigManager::IsFuzzing() || SvtModuleOptions().IsWriter())
71 {
72 SFX_VIEW_REGISTRATION(SwDocShell)SwDocShell::Factory().RegisterViewFactory( *Factory() );
73 SFX_VIEW_REGISTRATION(SwGlobalDocShell)SwGlobalDocShell::Factory().RegisterViewFactory( *Factory() );
74 }
75}
76
77SFX_IMPL_INTERFACE(SwView, SfxViewShell)SfxInterface* SwView::pInterface = nullptr; SfxInterface* SwView
::GetStaticInterface() { if ( !pInterface ) { pInterface = new
SfxInterface( "SwView", false, GetInterfaceId(), SfxViewShell
::GetStaticInterface(), aSwViewSlots_Impl[0], sal_uInt16(sizeof
(aSwViewSlots_Impl) / sizeof(SfxSlot) ) ); InitInterface_Impl
(); } return pInterface; } SfxInterface* SwView::GetInterface
() const { return GetStaticInterface(); } void SwView::RegisterInterface
(const SfxModule* pMod) { GetStaticInterface()->Register(pMod
); }
78
79void SwView::InitInterface_Impl()
80{
81 GetStaticInterface()->RegisterChildWindow(SID_NAVIGATOR(10000 + 366), true);
82
83 GetStaticInterface()->RegisterChildWindow(::sfx2::sidebar::SidebarChildWindow::GetChildWindowId());
84
85 GetStaticInterface()->RegisterChildWindow(SfxInfoBarContainerChild::GetChildWindowId());
86 GetStaticInterface()->RegisterChildWindow(SvxSearchDialogWrapper::GetChildWindowId());
87 GetStaticInterface()->RegisterChildWindow(SwSpellDialogChildWindow::GetChildWindowId());
88 GetStaticInterface()->RegisterChildWindow(FN_REDLINE_ACCEPT((20000 + 1800) + 29));
89 GetStaticInterface()->RegisterChildWindow(SID_HYPERLINK_DIALOG(5000 + 678));
90 GetStaticInterface()->RegisterChildWindow(FN_WORDCOUNT_DIALOG((20000 + 2200) + 98));
91#if HAVE_FEATURE_AVMEDIA1
92 GetStaticInterface()->RegisterChildWindow(::avmedia::MediaPlayer::GetChildWindowId());
93#endif
94 GetStaticInterface()->RegisterChildWindow(FN_INSERT_FIELD_DATA_ONLY((20000 + 300) + 19));
95
96 GetStaticInterface()->RegisterChildWindow(FN_SYNC_LABELS((20000 + 1600) + 143), false, SfxShellFeature::SwChildWindowLabel);
97
98 GetStaticInterface()->RegisterObjectBar(SFX_OBJECTBAR_TOOLS2, SfxVisibilityFlags::Standard|SfxVisibilityFlags::Server,
99 ToolbarId::Tools_Toolbox);
100}
101
102
103ShellMode SwView::GetShellMode() const
104{
105 return m_pViewImpl->GetShellMode();
106}
107
108view::XSelectionSupplier* SwView::GetUNOObject()
109{
110 return m_pViewImpl->GetUNOObject();
111}
112
113void SwView::ApplyAccessibilityOptions(SvtAccessibilityOptions const & rAccessibilityOptions)
114{
115 m_pWrtShell->ApplyAccessibilityOptions(rAccessibilityOptions);
116 //to enable the right state of the selection cursor in readonly documents
117 if(GetDocShell()->IsReadOnly())
118 m_pWrtShell->ShowCursor();
119
120}
121
122void SwView::SetMailMergeConfigItem(std::shared_ptr<SwMailMergeConfigItem> const & rConfigItem)
123{
124 m_pViewImpl->SetMailMergeConfigItem(rConfigItem);
125 UIFeatureChanged();
126}
127
128std::shared_ptr<SwMailMergeConfigItem> const & SwView::GetMailMergeConfigItem() const
129{
130 return m_pViewImpl->GetMailMergeConfigItem();
131}
132
133static bool lcl_IsViewMarks( const SwViewOption& rVOpt )
134{
135 return rVOpt.IsHardBlank() &&
136 rVOpt.IsSoftHyph() &&
137 SwViewOption::IsFieldShadings();
138}
139static void lcl_SetViewMarks(SwViewOption& rVOpt, bool bOn )
140{
141 rVOpt.SetHardBlank(bOn);
142 rVOpt.SetSoftHyph(bOn);
143 SwViewOption::SetAppearanceFlag(
144 ViewOptFlags::FieldShadings, bOn, true);
145}
146
147static void lcl_SetViewMetaChars( SwViewOption& rVOpt, bool bOn)
148{
149 rVOpt.SetViewMetaChars( bOn );
150 if(bOn && !(rVOpt.IsParagraph() ||
151 rVOpt.IsTab() ||
152 rVOpt.IsLineBreak() ||
153 rVOpt.IsShowHiddenChar() ||
154 rVOpt.IsShowBookmarks() ||
155 rVOpt.IsBlank()))
156 {
157 rVOpt.SetParagraph(bOn);
158 rVOpt.SetTab(bOn);
159 rVOpt.SetLineBreak(bOn);
160 rVOpt.SetBlank(bOn);
161 rVOpt.SetShowHiddenChar(bOn);
162 rVOpt.SetShowBookmarks(bOn);
163 }
164}
165
166void SwView::RecheckBrowseMode()
167{
168 // OS: pay attention to numerical order!
169 static sal_uInt16 const aInva[] =
170 {
171 //SID_NEWWINDOW,/*5620*/
172 SID_BROWSER_MODE(5000 + 1313), /*6313*/
173 SID_RULER_BORDERSTypedWhichId<SvxRulerItem>( 10000 + 80 ), SID_RULER_PAGE_POSTypedWhichId<SvxRulerItem>( 10000 + 82 ),
174 //SID_ATTR_LONG_LRSPACE,
175 SID_HTML_MODE(10000 + 414),
176 SID_RULER_PROTECT( 10000 + 415 ), /* 10915 */
177 //SID_AUTOSPELL_CHECK,
178 //SID_AUTOSPELL_MARKOFF,
179 SID_TOGGLE_RESOLVED_NOTES( 10000 + 1190 ), /* 11672*/
180 FN_RULER((20000 + 200) + 11), /*20211*/
181 FN_VIEW_GRAPHIC((20000 + 200) + 13), /*20213*/
182 FN_VIEW_BOUNDS((20000 + 200) + 14), /**/
183 FN_VIEW_FIELDS((20000 + 200) + 15), /*20215*/
184 FN_VLINEAL((20000 + 200) + 16), /*20216*/
185 FN_VSCROLLBAR((20000 + 200) + 17), /*20217*/
186 FN_HSCROLLBAR((20000 + 200) + 18), /*20218*/
187 FN_VIEW_META_CHARS((20000 + 200) + 24), /**/
188 FN_VIEW_MARKS((20000 + 200) + 25), /**/
189 //FN_VIEW_FIELDNAME, /**/
190 FN_VIEW_TABLEGRID((20000 + 200) + 27), /*20227*/
191 FN_PRINT_LAYOUT((20000 + 200) + 37), /*20237*/
192 FN_QRY_MERGE((20000 + 300) + 67), /*20364*/
193 FN_SHADOWCURSOR((20000 + 2200) + 4), /**/
194 0
195 };
196 // the view must not exist!
197 GetViewFrame()->GetBindings().Invalidate(aInva);
198 CheckVisArea();
199
200 SvxZoomType eType;
201 if( GetWrtShell().GetViewOptions()->getBrowseMode() && SvxZoomType::PERCENT != (eType =
202 GetWrtShell().GetViewOptions()->GetZoomType()) )
203 SetZoom( eType );
204 InvalidateBorder();
205}
206
207// State of view options
208
209void SwView::StateViewOptions(SfxItemSet &rSet)
210{
211 SfxWhichIter aIter(rSet);
212 sal_uInt16 nWhich = aIter.FirstWhich();
213 SfxBoolItem aBool;
214 const SwViewOption* pOpt = GetWrtShell().GetViewOptions();
215
216 while(nWhich)
217 {
218 bool bReadonly = GetDocShell()->IsReadOnly();
219 if ( bReadonly && nWhich != FN_VIEW_GRAPHIC((20000 + 200) + 13) )
220 {
221 rSet.DisableItem(nWhich);
222 nWhich = 0;
223 }
224 switch(nWhich)
225 {
226 case FN_RULER((20000 + 200) + 11):
227 {
228 if(!pOpt->IsViewHRuler(true) && !pOpt->IsViewVRuler(true))
229 {
230 rSet.DisableItem(nWhich);
231 nWhich = 0;
232 }
233 else
234 aBool.SetValue( pOpt->IsViewAnyRuler());
235 }
236 break;
237 case SID_BROWSER_MODE(5000 + 1313):
238 case FN_PRINT_LAYOUT((20000 + 200) + 37):
239 {
240 bool bState = pOpt->getBrowseMode();
241 if(FN_PRINT_LAYOUT((20000 + 200) + 37) == nWhich)
242 bState = !bState;
243 aBool.SetValue( bState );
244 }
245 break;
246 case FN_VIEW_BOUNDS((20000 + 200) + 14):
247 aBool.SetValue( SwViewOption::IsDocBoundaries()); break;
248 case FN_VIEW_GRAPHIC((20000 + 200) + 13):
249 aBool.SetValue( pOpt->IsGraphic() ); break;
250 case FN_VIEW_FIELDS((20000 + 200) + 15):
251 aBool.SetValue( SwViewOption::IsFieldShadings() ); break;
252 case FN_VIEW_FIELDNAME((20000 + 200) + 26):
253 aBool.SetValue( pOpt->IsFieldName() ); break;
254 case FN_VIEW_MARKS((20000 + 200) + 25):
255 aBool.SetValue( lcl_IsViewMarks(*pOpt) ); break;
256 case FN_VIEW_META_CHARS((20000 + 200) + 24):
257 aBool.SetValue( pOpt->IsViewMetaChars() ); break;
258 case FN_VIEW_TABLEGRID((20000 + 200) + 27):
259 aBool.SetValue( SwViewOption::IsTableBoundaries() ); break;
260 case SID_TOGGLE_NOTES( 10000 + 1098 ):
261 {
262 if (!GetPostItMgr()->HasNotes())
263 {
264 rSet.DisableItem(nWhich);
265 nWhich = 0;
266 }
267 else
268 aBool.SetValue( pOpt->IsPostIts());
269 break;
270 }
271 case SID_TOGGLE_RESOLVED_NOTES( 10000 + 1190 ):
272 {
273 if (!GetPostItMgr()->HasNotes())
274 {
275 rSet.DisableItem(nWhich);
276 nWhich = 0;
277 }
278 else
279 aBool.SetValue( pOpt->IsResolvedPostIts());
280 break;
281 }
282 case FN_VIEW_HIDDEN_PARA((20000 + 200) + 42):
283 aBool.SetValue( pOpt->IsShowHiddenPara()); break;
284 case FN_VIEW_HIDE_WHITESPACE((20000 + 200) + 59):
285 {
286 if (pOpt->getBrowseMode() || !pOpt->CanHideWhitespace())
287 {
288 rSet.DisableItem(nWhich);
289 nWhich = 0;
290 }
291 else
292 aBool.SetValue(pOpt->IsHideWhitespaceMode());
293 break;
294 }
295 case FN_VIEW_SHOW_WHITESPACE((20000 + 200) + 62):
296 {
297 aBool.SetValue(!pOpt->IsHideWhitespaceMode());
298 break;
299 }
300 case SID_GRID_VISIBLE(27000 +322):
301 aBool.SetValue( pOpt->IsGridVisible() ); break;
302 case SID_GRID_USE(27000 +154):
303 aBool.SetValue( pOpt->IsSnap() ); break;
304 case SID_HELPLINES_MOVE(27000 +153):
305 aBool.SetValue( pOpt->IsCrossHair() ); break;
306 case FN_VIEW_SMOOTH_SCROLL((20000 + 200) + 43):
307 aBool.SetValue( pOpt->IsSmoothScroll()); break;
308 case FN_VLINEAL((20000 + 200) + 16):
309 aBool.SetValue( StatVRuler() ); break;
310 case FN_HSCROLLBAR((20000 + 200) + 18):
311 if( pOpt->getBrowseMode() )
312 {
313 rSet.DisableItem(nWhich);
314 nWhich = 0;
315 }
316 else
317 aBool.SetValue( IsHScrollbarVisible() );
318 break;
319 case FN_VSCROLLBAR((20000 + 200) + 17):
320 aBool.SetValue( IsVScrollbarVisible() ); break;
321 case SID_AUTOSPELL_CHECK(((((10000 + 1499) + 1) + 499) + 1) + 21):
322 aBool.SetValue( pOpt->IsOnlineSpell() );
323 break;
324 case FN_SHADOWCURSOR((20000 + 2200) + 4):
325 if ( pOpt->getBrowseMode() )
326 {
327 rSet.DisableItem( nWhich );
328 nWhich = 0;
329 }
330 else
331 aBool.SetValue( pOpt->IsShadowCursor() );
332 break;
333 case FN_SHOW_INLINETOOLTIPS((20000 + 200) + 60):
334 aBool.SetValue( pOpt->IsShowInlineTooltips() );
335 break;
336 case FN_USE_HEADERFOOTERMENU((20000 + 200) + 61):
337 aBool.SetValue( pOpt->IsUseHeaderFooterMenu() );
338 break;
339 case FN_SHOW_OUTLINECONTENTVISIBILITYBUTTON((20000 + 200) + 63):
340 aBool.SetValue( pOpt->IsShowOutlineContentVisibilityButton() );
341 break;
342 }
343
344 if( nWhich )
345 {
346 aBool.SetWhich( nWhich );
347 rSet.Put( aBool );
348 }
349 nWhich = aIter.NextWhich();
350 }
351}
352
353// execute view options
354
355void SwView::ExecViewOptions(SfxRequest &rReq)
356{
357 std::unique_ptr<SwViewOption> pOpt(new SwViewOption( *GetWrtShell().GetViewOptions() ));
358 bool bModified = GetWrtShell().IsModified();
359
360 int eState = STATE_TOGGLE;
361 bool bSet = false;
362 bool bBrowseModeChanged = false;
363
364 const SfxItemSet *pArgs = rReq.GetArgs();
365 sal_uInt16 nSlot = rReq.GetSlot();
366 const SfxPoolItem* pAttr=nullptr;
367
368 if( pArgs && SfxItemState::SET == pArgs->GetItemState( nSlot , false, &pAttr ))
369 {
370 bSet = static_cast<const SfxBoolItem*>(pAttr)->GetValue();
371 eState = bSet ? STATE_ON : STATE_OFF;
372 }
373
374 bool bFlag = STATE_ON == eState;
375 uno::Reference< linguistic2::XLinguProperties > xLngProp( ::GetLinguPropertySet() );
376
377 switch ( nSlot )
378 {
379 case FN_VIEW_GRAPHIC((20000 + 200) + 13):
380 if( STATE_TOGGLE == eState )
381 bFlag = !pOpt->IsGraphic();
382 pOpt->SetGraphic( bFlag );
383 break;
384
385 case FN_VIEW_FIELDS((20000 + 200) + 15):
386 if( STATE_TOGGLE == eState )
387 bFlag = !SwViewOption::IsFieldShadings() ;
388 SwViewOption::SetAppearanceFlag(ViewOptFlags::FieldShadings, bFlag, true );
389 break;
390
391 case FN_VIEW_BOUNDS((20000 + 200) + 14):
392 if( STATE_TOGGLE == eState )
393 bFlag = !SwViewOption::IsDocBoundaries();
394 SwViewOption::SetAppearanceFlag(ViewOptFlags::DocBoundaries, bFlag, true );
395 break;
396
397 case SID_GRID_VISIBLE(27000 +322):
398 if( STATE_TOGGLE == eState )
399 bFlag = !pOpt->IsGridVisible();
400
401 pOpt->SetGridVisible( bFlag );
402 break;
403
404 case SID_GRID_USE(27000 +154):
405 if( STATE_TOGGLE == eState )
406 bFlag = !pOpt->IsSnap();
407
408 pOpt->SetSnap( bFlag );
409 break;
410
411 case SID_HELPLINES_MOVE(27000 +153):
412 if( STATE_TOGGLE == eState )
413 bFlag = !pOpt->IsCrossHair();
414
415 pOpt->SetCrossHair( bFlag );
416 break;
417
418 case SID_BROWSER_MODE(5000 + 1313):
419 bBrowseModeChanged = !pOpt->getBrowseMode();
420 pOpt->setBrowseMode(true );
421 break;
422
423 case FN_PRINT_LAYOUT((20000 + 200) + 37):
424 bBrowseModeChanged = pOpt->getBrowseMode();
425 pOpt->setBrowseMode( false );
426 break;
427
428 case SID_TOGGLE_NOTES( 10000 + 1098 ):
429 if ( STATE_TOGGLE == eState )
430 bFlag = !pOpt->IsPostIts();
431
432 GetPostItMgr()->SetLayout();
433 pOpt->SetPostIts( bFlag );
434 if (pOpt->IsPostIts())
435 GetPostItMgr()->CheckMetaText();
436 break;
437
438 case SID_TOGGLE_RESOLVED_NOTES( 10000 + 1190 ):
439 if ( STATE_TOGGLE == eState )
440 bFlag = pOpt->IsResolvedPostIts();
441
442 GetPostItMgr()->ShowHideResolvedNotes(!bFlag);
443
444 GetPostItMgr()->SetLayout();
445 pOpt->SetResolvedPostIts( !bFlag );
446
447 break;
448
449 case FN_VIEW_HIDDEN_PARA((20000 + 200) + 42):
450 if ( STATE_TOGGLE == eState )
451 bFlag = !pOpt->IsShowHiddenPara();
452
453 pOpt->SetShowHiddenPara( bFlag );
454 break;
455
456 case FN_VIEW_HIDE_WHITESPACE((20000 + 200) + 59):
457 if ( STATE_TOGGLE == eState )
458 bFlag = !pOpt->IsHideWhitespaceMode();
459
460 pOpt->SetHideWhitespaceMode(bFlag);
461 break;
462
463 case FN_VIEW_SHOW_WHITESPACE((20000 + 200) + 62):
464 if ( STATE_TOGGLE == eState )
465 bFlag = pOpt->IsHideWhitespaceMode();
466
467 pOpt->SetHideWhitespaceMode(!bFlag);
468 break;
469
470 case FN_VIEW_SMOOTH_SCROLL((20000 + 200) + 43):
471
472 if ( STATE_TOGGLE == eState )
473 bFlag = !pOpt->IsSmoothScroll();
474
475 pOpt->SetSmoothScroll( bFlag );
476 break;
477
478 case FN_VLINEAL((20000 + 200) + 16):
479 if( STATE_TOGGLE == eState )
480 bFlag = !pOpt->IsViewVRuler();
481
482 pOpt->SetViewVRuler( bFlag );
483 break;
484
485 case FN_VSCROLLBAR((20000 + 200) + 17):
486 if( STATE_TOGGLE == eState )
487 bFlag = !pOpt->IsViewVScrollBar();
488
489 pOpt->SetViewVScrollBar( bFlag );
490 break;
491
492 case FN_HSCROLLBAR((20000 + 200) + 18):
493 if( STATE_TOGGLE == eState )
494 bFlag = !pOpt->IsViewHScrollBar();
495
496 pOpt->SetViewHScrollBar( bFlag );
497 break;
498
499 case FN_RULER((20000 + 200) + 11):
500 if( STATE_TOGGLE == eState )
501 bFlag = !pOpt->IsViewAnyRuler();
502
503 pOpt->SetViewAnyRuler( bFlag );
504 break;
505
506 case FN_VIEW_TABLEGRID((20000 + 200) + 27):
507 if( STATE_TOGGLE == eState )
508 bFlag = !SwViewOption::IsTableBoundaries();
509 SwViewOption::SetAppearanceFlag(ViewOptFlags::TableBoundaries, bFlag, true );
510 break;
511
512 case FN_VIEW_FIELDNAME((20000 + 200) + 26):
513 if( STATE_TOGGLE == eState )
514 bFlag = !pOpt->IsFieldName() ;
515
516 pOpt->SetFieldName( bFlag );
517 break;
518
519 case FN_VIEW_MARKS((20000 + 200) + 25):
520 if( STATE_TOGGLE == eState )
521 bFlag = !lcl_IsViewMarks(*pOpt) ;
522
523 lcl_SetViewMarks( *pOpt, bFlag );
524 break;
525
526 case FN_VIEW_META_CHARS((20000 + 200) + 24):
527 if( STATE_TOGGLE == eState )
528 bFlag = !pOpt->IsViewMetaChars();
529
530 lcl_SetViewMetaChars( *pOpt, bFlag );
531 break;
532
533 case SID_AUTOSPELL_CHECK(((((10000 + 1499) + 1) + 499) + 1) + 21):
534 if( STATE_TOGGLE == eState )
535 {
536 bFlag = !pOpt->IsOnlineSpell();
537 bSet = bFlag;
538 }
539
540 pOpt->SetOnlineSpell(bSet);
541 {
542 SvtLinguConfig aCfg;
543 aCfg.SetProperty( UPN_IS_SPELL_AUTO"IsSpellAuto", uno::makeAny( bSet ) );
544
545 if (xLngProp.is())
546 xLngProp->setIsSpellAuto( bSet );
547
548 // for the time being we do not have a specific option for grammarchecking.
549 // thus we'll use the one for spell checking...
550 if (bSet)
551 {
552 SwDocShell *pDocSh = GetDocShell();
553 SwDoc *pDoc = pDocSh? pDocSh->GetDoc() : nullptr;
554
555 // right now we don't have view options for automatic grammar checking. Thus...
556 bool bIsAutoGrammar = false;
557 aCfg.GetProperty( UPN_IS_GRAMMAR_AUTO"IsAutoGrammarCheck" ) >>= bIsAutoGrammar;
558
559 if (pDoc && bIsAutoGrammar)
560 pDoc->StartGrammarChecking();
561 }
562 }
563 break;
564
565 case FN_SHADOWCURSOR((20000 + 2200) + 4):
566 if( STATE_TOGGLE == eState )
567 {
568 bFlag = !pOpt->IsShadowCursor();
569 bSet = bFlag;
570 }
571
572 pOpt->SetShadowCursor(bSet);
573 break;
574
575 case FN_SHOW_INLINETOOLTIPS((20000 + 200) + 60):
576 if( STATE_TOGGLE == eState )
577 bFlag = !pOpt->IsShowInlineTooltips();
578
579 pOpt->SetShowInlineTooltips( bFlag );
580 break;
581
582 case FN_USE_HEADERFOOTERMENU((20000 + 200) + 61):
583 if( STATE_TOGGLE == eState )
584 bFlag = !pOpt->IsUseHeaderFooterMenu();
585
586 pOpt->SetUseHeaderFooterMenu( bFlag );
587 break;
588
589 case FN_SHOW_OUTLINECONTENTVISIBILITYBUTTON((20000 + 200) + 63):
590 if( STATE_TOGGLE == eState )
591 bFlag = !pOpt->IsShowOutlineContentVisibilityButton();
592
593 pOpt->SetShowOutlineContentVisibilityButton( bFlag );
594 break;
595
596 default:
597 OSL_FAIL("wrong request method")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/view0.cxx"
":" "597" ": "), "%s", "wrong request method"); } } while (false
);
598 return;
599 }
600
601 // Set UserPrefs, mark request as modified
602 bool bWebView = dynamic_cast<const SwWebView*>(this) != nullptr;
603 SwWrtShell &rSh = GetWrtShell();
604 rSh.StartAction();
605 SwModule* pModule = SW_MOD()( static_cast<SwModule*>(SfxApplication::GetModule(SfxToolsModule
::Writer)));
606 if( *rSh.GetViewOptions() != *pOpt )
607 {
608 rSh.ApplyViewOptions( *pOpt );
609 if( bBrowseModeChanged )
610 {
611 GetDocShell()->ToggleLayoutMode(this);
612 }
613
614 // The UsrPref must be marked as modified.
615 // call for initialization
616 pModule->GetUsrPref(bWebView);
617 SwModule::CheckSpellChanges( pOpt->IsOnlineSpell(), false, false, false );
618 }
619 //OS: Set back modified again, because view/fields sets the Doc modified.
620 if( !bModified )
621 rSh.ResetModified();
622
623 pModule->ApplyUsrPref( *pOpt, this, bWebView ? SvViewOpt::DestWeb : SvViewOpt::DestText );
624
625 // #i6193# let postits know about new spellcheck setting
626 if ( nSlot == SID_AUTOSPELL_CHECK(((((10000 + 1499) + 1) + 499) + 1) + 21) )
627 GetPostItMgr()->SetSpellChecking();
628
629 if (nSlot == FN_SHOW_OUTLINECONTENTVISIBILITYBUTTON((20000 + 200) + 63))
630 GetEditWin().SetOutlineContentVisibilityButtons();
631
632 const bool bLockedView = rSh.IsViewLocked();
633 rSh.LockView( true ); //lock visible section
634 GetWrtShell().EndAction();
635 if( bBrowseModeChanged && !bFlag )
636 CalcVisArea( GetEditWin().GetOutputSizePixel() );
637 rSh.LockView( bLockedView );
638
639 pOpt.reset();
640 Invalidate(rReq.GetSlot());
641 if(!pArgs)
642 rReq.AppendItem(SfxBoolItem(nSlot, bFlag));
643 rReq.Done();
644}
645
646void SwView::ExecFormatFootnote()
647{
648 SwAbstractDialogFactory* pFact = SwAbstractDialogFactory::Create();
649 ScopedVclPtr<VclAbstractDialog> pDlg(pFact->CreateSwFootNoteOptionDlg(GetFrameWeld(), GetWrtShell()));
650 pDlg->Execute();
651}
652
653void SwView::ExecNumberingOutline(SfxItemPool & rPool)
654{
655 SfxItemSet aTmp(rPool, svl::Items<FN_PARAM_1((20000 + 1100)+60), FN_PARAM_1((20000 + 1100)+60)>{});
656 SwAbstractDialogFactory* pFact = SwAbstractDialogFactory::Create();
657 ScopedVclPtr<SfxAbstractTabDialog> pDlg(pFact->CreateOutlineTabDialog(GetFrameWeld(), &aTmp, GetWrtShell()));
1
Calling constructor for 'ScopedVclPtr<SfxAbstractTabDialog>'
→
8
←
Returning from constructor for 'ScopedVclPtr<SfxAbstractTabDialog>'
→
9
←
Calling implicit destructor for 'VclPtr<SfxAbstractTabDialog>'
→
10
←
Calling '~Reference'
→
17
←
Returning from '~Reference'
→
18
←
Returning from destructor for 'VclPtr<SfxAbstractTabDialog>'
→
658 pDlg->Execute();
19
←
Calling 'VclPtr::operator->'
→
659}
660
661/* 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<SfxAbstractTabDialog>'
→
3
←
Calling copy constructor for 'Reference<SfxAbstractTabDialog>'
→
6
←
Returning from copy constructor for 'Reference<SfxAbstractTabDialog>'
→
7
←
Returning from copy constructor for 'VclPtr<SfxAbstractTabDialog>'
→
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