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 backingwindow.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 SFX2_DLLIMPLEMENTATION -D ENABLE_CUPS -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/liborcus/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/sfx2/inc -I /home/maarten/src/libreoffice/core/sfx2/source/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sfx2/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 -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/sfx2/source/dialog/backingwindow.cxx

/home/maarten/src/libreoffice/core/sfx2/source/dialog/backingwindow.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 "backingwindow.hxx"
21
22#include <vcl/accel.hxx>
23#include <vcl/settings.hxx>
24#include <vcl/svapp.hxx>
25#include <vcl/syswin.hxx>
26#include <vcl/virdev.hxx>
27#include <vcl/fixed.hxx>
28
29#include <unotools/historyoptions.hxx>
30#include <unotools/moduleoptions.hxx>
31#include <svtools/openfiledroptargetlistener.hxx>
32#include <svtools/colorcfg.hxx>
33#include <svtools/langhelp.hxx>
34#include <templateviewitem.hxx>
35
36#include <vcl/menubtn.hxx>
37
38#include <comphelper/processfactory.hxx>
39#include <comphelper/propertysequence.hxx>
40
41#include <tools/diagnose_ex.h>
42
43#include <com/sun/star/configuration/theDefaultProvider.hpp>
44#include <com/sun/star/container/XNameAccess.hpp>
45#include <com/sun/star/datatransfer/dnd/XDropTarget.hpp>
46#include <com/sun/star/document/MacroExecMode.hpp>
47#include <com/sun/star/document/UpdateDocMode.hpp>
48#include <com/sun/star/frame/Desktop.hpp>
49#include <com/sun/star/lang/XMultiServiceFactory.hpp>
50#include <com/sun/star/system/SystemShellExecute.hpp>
51#include <com/sun/star/system/SystemShellExecuteFlags.hpp>
52#include <com/sun/star/util/URLTransformer.hpp>
53#include <com/sun/star/task/InteractionHandler.hpp>
54
55#include <officecfg/Office/Common.hxx>
56
57using namespace ::com::sun::star;
58using namespace ::com::sun::star::beans;
59using namespace ::com::sun::star::frame;
60using namespace ::com::sun::star::uno;
61using namespace ::com::sun::star::document;
62
63const char SERVICENAME_CFGREADACCESS[] = "com.sun.star.configuration.ConfigurationAccess";
64
65// increase size of the text in the buttons on the left fMultiplier-times
66float const fMultiplier = 1.4f;
67
68BackingWindow::BackingWindow( vcl::Window* i_pParent ) :
69 Window( i_pParent ),
70 mbLocalViewInitialized(false),
71 mbInitControls( false )
72{
73 m_pUIBuilder.reset(new VclBuilder(this, AllSettings::GetUIRootDir(), "sfx/ui/startcenter.ui", "StartCenter" ));
74
75 get(mpOpenButton, "open_all");
76 get(mpRemoteButton, "open_remote");
77 get(mpRecentButton, "open_recent");
78 get(mpTemplateButton, "templates_all");
79
80 get(mpCreateLabel, "create_label");
81
82 get(mpWriterAllButton, "writer_all");
83 get(mpCalcAllButton, "calc_all");
84 get(mpImpressAllButton, "impress_all");
85 get(mpDrawAllButton, "draw_all");
86 get(mpDBAllButton, "database_all");
87 get(mpMathAllButton, "math_all");
88
89 get(mpHelpButton, "help");
90 //set an alternative help label that doesn't hotkey the H of the Help menu
91 mpHelpButton->SetText(get<Window>("althelplabel")->GetText());
92 get(mpExtensionsButton, "extensions");
93
94 //Containers are invisible to cursor traversal
95 //So on pressing "right" when in Help the
96 //extension button is considered as a candidate
97
98 //But the containers are not invisible to the PushButton ctor which checks
99 //if the preceding window of its parent is a button and if it then
100 //defaults to grouping with it and if it is not a button defaults to
101 //setting itself as the start of a new group.
102
103 //So here take the second button and set it as explicitly not the start
104 //of a group, i.e. allow it to be grouped with the preceding
105 //PushButton so when seen as a candidate by cursor travelling
106 //it will be accepted as a continuation of the group.
107 WinBits nBits = mpExtensionsButton->GetStyle();
108 nBits &= ~WB_GROUP;
109 nBits |= WB_NOGROUP;
110 mpExtensionsButton->SetStyle(nBits);
111 assert(mpHelpButton->GetStyle() & WB_GROUP)(static_cast <bool> (mpHelpButton->GetStyle() & WB_GROUP
) ? void (0) : __assert_fail ("mpHelpButton->GetStyle() & WB_GROUP"
, "/home/maarten/src/libreoffice/core/sfx2/source/dialog/backingwindow.cxx"
, 111, __extension__ __PRETTY_FUNCTION__));
112 assert(!(mpExtensionsButton->GetStyle() & WB_GROUP))(static_cast <bool> (!(mpExtensionsButton->GetStyle(
) & WB_GROUP)) ? void (0) : __assert_fail ("!(mpExtensionsButton->GetStyle() & WB_GROUP)"
, "/home/maarten/src/libreoffice/core/sfx2/source/dialog/backingwindow.cxx"
, 112, __extension__ __PRETTY_FUNCTION__));
113
114 get(mpAllButtonsBox, "all_buttons_box");
115 get(mpButtonsBox, "buttons_box");
116 get(mpSmallButtonsBox, "small_buttons_box");
117
118 get(mpAllRecentThumbnails, "all_recent");
119 get(mpLocalView, "local_view");
120
121 maDndWindows.emplace_back(mpAllRecentThumbnails);
122
123 try
124 {
125 mxContext.set( ::comphelper::getProcessComponentContext(), uno::UNO_SET_THROW );
126 }
127 catch (const Exception&)
128 {
129 TOOLS_WARN_EXCEPTION( "fwk", "BackingWindow" )do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "fwk")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case SAL_DETAIL_LOG_ACTION_LOG
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "BackingWindow" << " " << exceptionToString
(tools_warn_exception)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("fwk"), ("/home/maarten/src/libreoffice/core/sfx2/source/dialog/backingwindow.cxx"
":" "129" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "BackingWindow" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "BackingWindow" << " " <<
exceptionToString(tools_warn_exception); ::sal::detail::log(
(::SAL_DETAIL_LOG_LEVEL_WARN), ("fwk"), ("/home/maarten/src/libreoffice/core/sfx2/source/dialog/backingwindow.cxx"
":" "129" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "BackingWindow" << " " << exceptionToString
(tools_warn_exception)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("fwk"), ("/home/maarten/src/libreoffice/core/sfx2/source/dialog/backingwindow.cxx"
":" "129" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "BackingWindow" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "BackingWindow" << " " <<
exceptionToString(tools_warn_exception); ::sal::detail::log(
(::SAL_DETAIL_LOG_LEVEL_WARN), ("fwk"), ("/home/maarten/src/libreoffice/core/sfx2/source/dialog/backingwindow.cxx"
":" "129" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false);
130 }
131
132 // fdo#34392: we do the layout dynamically, the layout depends on the font,
133 // so we should handle data changed events (font changing) of the last child
134 // control, at this point all the controls have updated settings (i.e. font).
135
136 EnableChildTransparentMode();
137
138 SetStyle( GetStyle() | WB_DIALOGCONTROL );
139
140 // get dispatch provider
141 Reference<XDesktop2> xDesktop = Desktop::create( comphelper::getProcessComponentContext() );
142 mxDesktopDispatchProvider = xDesktop;
143
144 // init background
145 SetBackground();
146}
147
148BackingWindow::~BackingWindow()
149{
150 disposeOnce();
151}
152
153void BackingWindow::dispose()
154{
155 // deregister drag&drop helper
156 if (mxDropTargetListener.is())
157 {
158 for (auto const & pDndWin : maDndWindows)
159 {
160 css::uno::Reference< css::datatransfer::dnd::XDropTarget > xDropTarget =
161 pDndWin->GetDropTarget();
162 if (xDropTarget.is())
163 {
164 xDropTarget->removeDropTargetListener(mxDropTargetListener);
165 xDropTarget->setActive(false);
166 }
167 }
168 mxDropTargetListener.clear();
169 }
170 disposeBuilder();
171 maDndWindows.clear();
172 mpOpenButton.clear();
173 mpRemoteButton.clear();
174 mpRecentButton.clear();
175 mpTemplateButton.clear();
176 mpCreateLabel.clear();
177 mpWriterAllButton.clear();
178 mpCalcAllButton.clear();
179 mpImpressAllButton.clear();
180 mpDrawAllButton.clear();
181 mpDBAllButton.clear();
182 mpMathAllButton.clear();
183 mpHelpButton.clear();
184 mpExtensionsButton.clear();
185 mpAllButtonsBox.clear();
186 mpButtonsBox.clear();
187 mpSmallButtonsBox.clear();
188 mpAllRecentThumbnails.clear();
189 mpLocalView.clear();
190 vcl::Window::dispose();
191}
192
193void BackingWindow::initControls()
194{
195 if( mbInitControls )
196 return;
197
198 mbInitControls = true;
199
200 // collect the URLs of the entries in the File/New menu
201 SvtModuleOptions aModuleOptions;
202
203 if (aModuleOptions.IsModuleInstalled(SvtModuleOptions::EModule::WRITER))
204 mpAllRecentThumbnails->mnFileTypes |= sfx2::ApplicationType::TYPE_WRITER;
205
206 if (aModuleOptions.IsModuleInstalled(SvtModuleOptions::EModule::CALC))
207 mpAllRecentThumbnails->mnFileTypes |= sfx2::ApplicationType::TYPE_CALC;
208
209 if (aModuleOptions.IsModuleInstalled(SvtModuleOptions::EModule::IMPRESS))
210 mpAllRecentThumbnails->mnFileTypes |= sfx2::ApplicationType::TYPE_IMPRESS;
211
212 if (aModuleOptions.IsModuleInstalled(SvtModuleOptions::EModule::DRAW))
213 mpAllRecentThumbnails->mnFileTypes |= sfx2::ApplicationType::TYPE_DRAW;
214
215 if (aModuleOptions.IsModuleInstalled(SvtModuleOptions::EModule::DATABASE))
216 mpAllRecentThumbnails->mnFileTypes |= sfx2::ApplicationType::TYPE_DATABASE;
217
218 if (aModuleOptions.IsModuleInstalled(SvtModuleOptions::EModule::MATH))
219 mpAllRecentThumbnails->mnFileTypes |= sfx2::ApplicationType::TYPE_MATH;
220
221 mpAllRecentThumbnails->mnFileTypes |= sfx2::ApplicationType::TYPE_OTHER;
222 mpAllRecentThumbnails->Reload();
223 mpAllRecentThumbnails->ShowTooltips( true );
224 mpRecentButton->SetActive(true);
225
226 //initialize Template view
227 mpLocalView->SetStyle( mpLocalView->GetStyle() | WB_VSCROLL);
228 mpLocalView->Hide();
229
230 mpTemplateButton->SetDelayMenu(true);
231 mpTemplateButton->SetDropDown(PushButtonDropdownStyle::SplitMenuButton);
232 mpRecentButton->SetDelayMenu(true);
233 mpRecentButton->SetDropDown(PushButtonDropdownStyle::SplitMenuButton);
234
235 //set handlers
236 mpLocalView->setCreateContextMenuHdl(LINK(this, BackingWindow, CreateContextMenuHdl)::tools::detail::makeLink( ::tools::detail::castTo<BackingWindow
*>(this), &BackingWindow::LinkStubCreateContextMenuHdl
));
237 mpLocalView->setOpenTemplateHdl(LINK(this, BackingWindow, OpenTemplateHdl)::tools::detail::makeLink( ::tools::detail::castTo<BackingWindow
*>(this), &BackingWindow::LinkStubOpenTemplateHdl));
238 mpLocalView->setEditTemplateHdl(LINK(this, BackingWindow, EditTemplateHdl)::tools::detail::makeLink( ::tools::detail::castTo<BackingWindow
*>(this), &BackingWindow::LinkStubEditTemplateHdl));
239 mpLocalView->ShowTooltips( true );
240
241 setupButton( mpOpenButton );
242 setupButton( mpRemoteButton );
243 setupButton( mpRecentButton );
244 setupButton( mpTemplateButton );
245 setupButton( mpWriterAllButton );
246 setupButton( mpDrawAllButton );
247 setupButton( mpCalcAllButton );
248 setupButton( mpDBAllButton );
249 setupButton( mpImpressAllButton );
250 setupButton( mpMathAllButton );
251
252 checkInstalledModules();
253
254 mpExtensionsButton->SetClickHdl(LINK(this, BackingWindow, ExtLinkClickHdl)::tools::detail::makeLink( ::tools::detail::castTo<BackingWindow
*>(this), &BackingWindow::LinkStubExtLinkClickHdl));
255
256 // setup nice colors
257 vcl::Font aFont(mpCreateLabel->GetSettings().GetStyleSettings().GetLabelFont());
258 aFont.SetFontSize(Size(0, aFont.GetFontSize().Height() * fMultiplier));
259 mpCreateLabel->SetControlFont(aFont);
260
261 // motif image under the buttons
262 Wallpaper aWallpaper(get<FixedImage>("motif")->GetImage().GetBitmapEx());
263 aWallpaper.SetStyle(WallpaperStyle::BottomRight);
264
265 mpButtonsBox->SetBackground(aWallpaper);
266
267 Resize();
268
269 // compute the menubar height
270 sal_Int32 nMenuHeight = 0;
271 SystemWindow* pSystemWindow = GetSystemWindow();
272 if (pSystemWindow)
273 {
274 MenuBar* pMenuBar = pSystemWindow->GetMenuBar();
275 if (pMenuBar)
276 nMenuHeight = pMenuBar->ImplGetWindow()->GetOutputSizePixel().Height();
277 }
278
279 set_width_request(mpAllRecentThumbnails->get_width_request() + mpAllButtonsBox->GetOptimalSize().Width());
280 set_height_request(nMenuHeight + mpAllButtonsBox->GetOptimalSize().Height());
281}
282
283void BackingWindow::initializeLocalView()
284{
285 if (!mbLocalViewInitialized)
286 {
287 mbLocalViewInitialized = true;
288 mpLocalView->Populate();
289 mpLocalView->filterItems(ViewFilter_Application(FILTER_APPLICATION::NONE));
290 mpLocalView->showAllTemplates();
291 }
292}
293
294void BackingWindow::setupButton( PushButton* pButton )
295{
296 // the buttons should have a bit bigger font
297 vcl::Font aFont(pButton->GetSettings().GetStyleSettings().GetPushButtonFont());
298 aFont.SetFontSize(Size(0, aFont.GetFontSize().Height() * fMultiplier));
299 pButton->SetControlFont(aFont);
300 pButton->SetClickHdl( LINK( this, BackingWindow, ClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<BackingWindow
*>(this), &BackingWindow::LinkStubClickHdl) );
301}
302
303void BackingWindow::setupButton( MenuToggleButton* pButton )
304{
305 vcl::Font aFont(pButton->GetSettings().GetStyleSettings().GetPushButtonFont());
306 aFont.SetFontSize(Size(0, aFont.GetFontSize().Height() * fMultiplier));
307 pButton->SetControlFont(aFont);
308
309 PopupMenu* pMenu = pButton->GetPopupMenu();
310 pMenu->SetMenuFlags(pMenu->GetMenuFlags() | MenuFlags::AlwaysShowDisabledEntries);
311
312 pButton->SetClickHdl(LINK(this, BackingWindow, ClickHdl)::tools::detail::makeLink( ::tools::detail::castTo<BackingWindow
*>(this), &BackingWindow::LinkStubClickHdl));
313 pButton->SetSelectHdl(LINK(this, BackingWindow, MenuSelectHdl)::tools::detail::makeLink( ::tools::detail::castTo<BackingWindow
*>(this), &BackingWindow::LinkStubMenuSelectHdl));
314}
315
316void BackingWindow::checkInstalledModules()
317{
318 SvtModuleOptions aModuleOpt;
319
320 mpWriterAllButton->Enable( aModuleOpt.IsModuleInstalled( SvtModuleOptions::EModule::WRITER ));
321
322 mpCalcAllButton->Enable( aModuleOpt.IsModuleInstalled( SvtModuleOptions::EModule::CALC ) );
323
324 mpImpressAllButton->Enable( aModuleOpt.IsModuleInstalled( SvtModuleOptions::EModule::IMPRESS ) );
325
326 mpDrawAllButton->Enable( aModuleOpt.IsModuleInstalled( SvtModuleOptions::EModule::DRAW ) );
327
328 mpMathAllButton->Enable(aModuleOpt.IsModuleInstalled( SvtModuleOptions::EModule::MATH ));
329
330 mpDBAllButton->Enable(aModuleOpt.IsModuleInstalled( SvtModuleOptions::EModule::DATABASE ));
331}
332
333void BackingWindow::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&)
334{
335 Resize();
336
337 Wallpaper aBack(svtools::ColorConfig().GetColorValue(::svtools::APPBACKGROUND).nColor);
338 vcl::Region aClip(tools::Rectangle(Point(0, 0), GetOutputSizePixel()));
339
340 aClip.Exclude(maStartCentButtons);
341
342 rRenderContext.Push(PushFlags::CLIPREGION);
343 rRenderContext.IntersectClipRegion(aClip);
344 rRenderContext.DrawWallpaper(tools::Rectangle(Point(0, 0), GetOutputSizePixel()), aBack);
345 rRenderContext.Pop();
346
347 ScopedVclPtrInstance<VirtualDevice> pVDev(rRenderContext);
1
Calling constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
3
←
Returning from constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
348 pVDev->EnableRTL(rRenderContext.IsRTLEnabled());
349 pVDev->SetOutputSizePixel(maStartCentButtons.GetSize());
350 Point aOffset(Point(0, 0) - maStartCentButtons.TopLeft());
351 pVDev->DrawWallpaper(tools::Rectangle(aOffset, GetOutputSizePixel()), aBack);
352
353 rRenderContext.DrawOutDev(maStartCentButtons.TopLeft(), maStartCentButtons.GetSize(),
354 Point(0, 0), maStartCentButtons.GetSize(),
355 *pVDev);
356}
4
←
Calling implicit destructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
5
←
Calling '~ScopedVclPtr'
→
357
358bool BackingWindow::PreNotify(NotifyEvent& rNEvt)
359{
360 if( rNEvt.GetType() == MouseNotifyEvent::KEYINPUT )
361 {
362 const KeyEvent* pEvt = rNEvt.GetKeyEvent();
363 const vcl::KeyCode& rKeyCode(pEvt->GetKeyCode());
364
365 // Subwindows of BackingWindow: Sidebar and Thumbnail view
366 if( rKeyCode.GetCode() == KEY_F6 )
367 {
368 if( rKeyCode.IsShift() ) // Shift + F6
369 {
370 if( mpAllRecentThumbnails->HasFocus() || mpLocalView->HasFocus())
371 {
372 mpOpenButton->GrabFocus();
373 return true;
374 }
375 }
376 else if ( rKeyCode.IsMod1() ) // Ctrl + F6
377 {
378 if(mpAllRecentThumbnails->IsVisible())
379 {
380 mpAllRecentThumbnails->GrabFocus();
381 return true;
382 }
383 else if(mpLocalView->IsVisible())
384 {
385 mpLocalView->GrabFocus();
386 return true;
387 }
388 }
389 else // F6
390 {
391 if( mpAllButtonsBox->HasChildPathFocus() )
392 {
393 if(mpAllRecentThumbnails->IsVisible())
394 {
395 mpAllRecentThumbnails->GrabFocus();
396 return true;
397 }
398 else if(mpLocalView->IsVisible())
399 {
400 mpLocalView->GrabFocus();
401 return true;
402 }
403 }
404 }
405 }
406
407 // try the 'normal' accelerators (so that eg. Ctrl+Q works)
408 if (!mpAccExec)
409 {
410 mpAccExec = svt::AcceleratorExecute::createAcceleratorHelper();
411 mpAccExec->init( comphelper::getProcessComponentContext(), mxFrame);
412 }
413
414 const OUString aCommand = mpAccExec->findCommand(svt::AcceleratorExecute::st_VCLKey2AWTKey(rKeyCode));
415 if ((aCommand != "vnd.sun.star.findbar:FocusToFindbar") && pEvt && mpAccExec->execute(rKeyCode))
416 return true;
417 }
418 else if (rNEvt.GetType() == MouseNotifyEvent::COMMAND)
419 {
420 Accelerator::ToggleMnemonicsOnHierarchy(*rNEvt.GetCommandEvent(), this);
421 }
422
423 return Window::PreNotify( rNEvt );
424}
425
426void BackingWindow::GetFocus()
427{
428 GetFocusFlags nFlags = GetParent()->GetGetFocusFlags();
429 if( nFlags & GetFocusFlags::F6 )
430 {
431 if( nFlags & GetFocusFlags::Forward ) // F6
432 {
433 mpOpenButton->GrabFocus();
434 return;
435 }
436 else // Shift + F6 or Ctrl + F6
437 {
438 mpAllRecentThumbnails->GrabFocus();
439 return;
440 }
441 }
442 Window::GetFocus();
443}
444
445void BackingWindow::setOwningFrame( const css::uno::Reference< css::frame::XFrame >& xFrame )
446{
447 mxFrame = xFrame;
448 if( ! mbInitControls )
449 initControls();
450
451 // establish drag&drop mode
452 mxDropTargetListener.set(new OpenFileDropTargetListener(mxContext, mxFrame));
453
454 for (auto const & pDndWin : maDndWindows)
455 {
456 css::uno::Reference< css::datatransfer::dnd::XDropTarget > xDropTarget =
457 pDndWin->GetDropTarget();
458 if (xDropTarget.is())
459 {
460 xDropTarget->addDropTargetListener(mxDropTargetListener);
461 xDropTarget->setActive(true);
462 }
463 }
464}
465
466void BackingWindow::Resize()
467{
468 maStartCentButtons = tools::Rectangle( Point(0, 0), GetOutputSizePixel() );
469
470 if (isLayoutEnabled(this))
471 VclContainer::setLayoutAllocation(*GetWindow(GetWindowType::FirstChild),
472 maStartCentButtons.TopLeft(), maStartCentButtons.GetSize());
473
474 if (!IsInPaint())
475 Invalidate();
476}
477
478IMPL_LINK(BackingWindow, ExtLinkClickHdl, Button*, pButton, void)void BackingWindow::LinkStubExtLinkClickHdl(void * instance, Button
* data) { return static_cast<BackingWindow *>(instance)
->ExtLinkClickHdl(data); } void BackingWindow::ExtLinkClickHdl
(Button* pButton)
479{
480 OUString aNode;
481
482 if (pButton == mpExtensionsButton)
483 aNode = "AddFeatureURL";
484
485 if (aNode.isEmpty())
486 return;
487
488 try
489 {
490 uno::Sequence<uno::Any> args(comphelper::InitAnyPropertySequence(
491 {
492 {"nodepath", uno::Any(OUString("/org.openoffice.Office.Common/Help/StartCenter"))}
493 }));
494
495 Reference<lang::XMultiServiceFactory> xConfig = configuration::theDefaultProvider::get( comphelper::getProcessComponentContext() );
496 Reference<container::XNameAccess> xNameAccess(xConfig->createInstanceWithArguments(SERVICENAME_CFGREADACCESS, args), UNO_QUERY);
497 if (xNameAccess.is())
498 {
499 OUString sURL;
500 Any value(xNameAccess->getByName(aNode));
501
502 sURL = value.get<OUString>();
503 localizeWebserviceURI(sURL);
504
505 Reference<css::system::XSystemShellExecute> const
506 xSystemShellExecute(
507 css::system::SystemShellExecute::create(
508 ::comphelper::getProcessComponentContext()));
509 xSystemShellExecute->execute(sURL, OUString(),
510 css::system::SystemShellExecuteFlags::URIS_ONLY);
511 }
512 }
513 catch (const Exception&)
514 {
515 }
516}
517
518IMPL_LINK( BackingWindow, ClickHdl, Button*, pButton, void )void BackingWindow::LinkStubClickHdl(void * instance, Button*
data) { return static_cast<BackingWindow *>(instance)->
ClickHdl(data); } void BackingWindow::ClickHdl(Button* pButton
)
519{
520 // dispatch the appropriate URL and end the dialog
521 if( pButton == mpWriterAllButton )
522 dispatchURL( "private:factory/swriter" );
523 else if( pButton == mpCalcAllButton )
524 dispatchURL( "private:factory/scalc" );
525 else if( pButton == mpImpressAllButton )
526 dispatchURL( "private:factory/simpress?slot=6686" );
527 else if( pButton == mpDrawAllButton )
528 dispatchURL( "private:factory/sdraw" );
529 else if( pButton == mpDBAllButton )
530 dispatchURL( "private:factory/sdatabase?Interactive" );
531 else if( pButton == mpMathAllButton )
532 dispatchURL( "private:factory/smath" );
533 else if( pButton == mpOpenButton )
534 {
535 Reference< XDispatchProvider > xFrame( mxFrame, UNO_QUERY );
536
537 Sequence< css::beans::PropertyValue > aArgs(1);
538 PropertyValue* pArg = aArgs.getArray();
539 pArg[0].Name = "Referer";
540 pArg[0].Value <<= OUString("private:user");
541
542 dispatchURL( ".uno:Open", OUString(), xFrame, aArgs );
543 }
544 else if( pButton == mpRemoteButton )
545 {
546 Reference< XDispatchProvider > xFrame( mxFrame, UNO_QUERY );
547
548 Sequence< css::beans::PropertyValue > aArgs(0);
549
550 dispatchURL( ".uno:OpenRemote", OUString(), xFrame, aArgs );
551 }
552 else if( pButton == mpRecentButton )
553 {
554 mpLocalView->Hide();
555 mpAllRecentThumbnails->Show();
556 mpAllRecentThumbnails->GrabFocus();
557 mpRecentButton->SetActive(true);
558 mpTemplateButton->SetActive(false);
559 mpTemplateButton->Invalidate();
560 }
561 else if( pButton == mpTemplateButton )
562 {
563 mpAllRecentThumbnails->Hide();
564 initializeLocalView();
565 mpLocalView->filterItems(ViewFilter_Application(FILTER_APPLICATION::NONE));
566 mpLocalView->Show();
567 mpLocalView->reload();
568 mpLocalView->GrabFocus();
569 mpRecentButton->SetActive(false);
570 mpRecentButton->Invalidate();
571 mpTemplateButton->SetActive(true);
572 }
573}
574
575IMPL_LINK( BackingWindow, MenuSelectHdl, MenuButton*, pButton, void )void BackingWindow::LinkStubMenuSelectHdl(void * instance, MenuButton
* data) { return static_cast<BackingWindow *>(instance)
->MenuSelectHdl(data); } void BackingWindow::MenuSelectHdl
(MenuButton* pButton)
576{
577 if(pButton == mpRecentButton)
578 {
579 SvtHistoryOptions().Clear(ePICKLIST);
580 mpAllRecentThumbnails->Reload();
581 return;
582 }
583 else if(pButton == mpTemplateButton)
584 {
585 initializeLocalView();
586
587 OString sId = pButton->GetCurItemIdent();
588
589 if( sId == "filter_writer" )
590 {
591 mpLocalView->filterItems(ViewFilter_Application(FILTER_APPLICATION::WRITER));
592 }
593 else if( sId == "filter_calc" )
594 {
595 mpLocalView->filterItems(ViewFilter_Application(FILTER_APPLICATION::CALC));
596 }
597 else if( sId == "filter_impress" )
598 {
599 mpLocalView->filterItems(ViewFilter_Application(FILTER_APPLICATION::IMPRESS));
600 }
601 else if( sId == "filter_draw" )
602 {
603 mpLocalView->filterItems(ViewFilter_Application(FILTER_APPLICATION::DRAW));
604 }
605 else if( sId == "manage" )
606 {
607 Reference< XDispatchProvider > xFrame( mxFrame, UNO_QUERY );
608
609 Sequence< css::beans::PropertyValue > aArgs(1);
610 PropertyValue* pArg = aArgs.getArray();
611 pArg[0].Name = "Referer";
612 pArg[0].Value <<= OUString("private:user");
613
614 dispatchURL( ".uno:NewDoc", OUString(), xFrame, aArgs );
615 return;
616 }
617
618 mpAllRecentThumbnails->Hide();
619 mpLocalView->Show();
620 mpLocalView->reload();
621 mpLocalView->GrabFocus();
622 mpRecentButton->SetActive(false);
623 mpTemplateButton->SetActive(true);
624 mpRecentButton->Invalidate();
625 }
626}
627
628IMPL_LINK(BackingWindow, CreateContextMenuHdl, ThumbnailViewItem*, pItem, void)void BackingWindow::LinkStubCreateContextMenuHdl(void * instance
, ThumbnailViewItem* data) { return static_cast<BackingWindow
*>(instance)->CreateContextMenuHdl(data); } void BackingWindow
::CreateContextMenuHdl(ThumbnailViewItem* pItem)
629{
630 const TemplateViewItem *pViewItem = dynamic_cast<TemplateViewItem*>(pItem);
631
632 if (pViewItem)
633 mpLocalView->createContextMenu();
634}
635
636IMPL_LINK(BackingWindow, OpenTemplateHdl, ThumbnailViewItem*, pItem, void)void BackingWindow::LinkStubOpenTemplateHdl(void * instance, ThumbnailViewItem
* data) { return static_cast<BackingWindow *>(instance)
->OpenTemplateHdl(data); } void BackingWindow::OpenTemplateHdl
(ThumbnailViewItem* pItem)
637{
638 uno::Sequence< PropertyValue > aArgs(4);
639 aArgs[0].Name = "AsTemplate";
640 aArgs[0].Value <<= true;
641 aArgs[1].Name = "MacroExecutionMode";
642 aArgs[1].Value <<= MacroExecMode::USE_CONFIG;
643 aArgs[2].Name = "UpdateDocMode";
644 aArgs[2].Value <<= UpdateDocMode::ACCORDING_TO_CONFIG;
645 aArgs[3].Name = "InteractionHandler";
646 aArgs[3].Value <<= task::InteractionHandler::createWithParent( ::comphelper::getProcessComponentContext(), nullptr );
647
648 TemplateViewItem *pTemplateItem = static_cast<TemplateViewItem*>(pItem);
649
650 Reference< XDispatchProvider > xFrame( mxFrame, UNO_QUERY );
651
652 try
653 {
654 dispatchURL( pTemplateItem->getPath(), "_default", xFrame, aArgs );
655 }
656 catch( const uno::Exception& )
657 {
658 }
659}
660
661IMPL_LINK(BackingWindow, EditTemplateHdl, ThumbnailViewItem*, pItem, void)void BackingWindow::LinkStubEditTemplateHdl(void * instance, ThumbnailViewItem
* data) { return static_cast<BackingWindow *>(instance)
->EditTemplateHdl(data); } void BackingWindow::EditTemplateHdl
(ThumbnailViewItem* pItem)
662{
663 uno::Sequence< PropertyValue > aArgs(3);
664 aArgs[0].Name = "AsTemplate";
665 aArgs[0].Value <<= false;
666 aArgs[1].Name = "MacroExecutionMode";
667 aArgs[1].Value <<= MacroExecMode::USE_CONFIG;
668 aArgs[2].Name = "UpdateDocMode";
669 aArgs[2].Value <<= UpdateDocMode::ACCORDING_TO_CONFIG;
670
671 TemplateViewItem *pViewItem = static_cast<TemplateViewItem*>(pItem);
672
673 Reference< XDispatchProvider > xFrame( mxFrame, UNO_QUERY );
674
675 try
676 {
677 dispatchURL( pViewItem->getPath(), "_default", xFrame, aArgs );
678 }
679 catch( const uno::Exception& )
680 {
681 }
682}
683
684namespace {
685
686struct ImplDelayedDispatch
687{
688 Reference< XDispatch > xDispatch;
689 css::util::URL aDispatchURL;
690 Sequence< PropertyValue > aArgs;
691
692 ImplDelayedDispatch( const Reference< XDispatch >& i_xDispatch,
693 const css::util::URL& i_rURL,
694 const Sequence< PropertyValue >& i_rArgs )
695 : xDispatch( i_xDispatch ),
696 aDispatchURL( i_rURL ),
697 aArgs( i_rArgs )
698 {
699 }
700};
701
702}
703
704static void implDispatchDelayed( void*, void* pArg )
705{
706 struct ImplDelayedDispatch* pDispatch = static_cast<ImplDelayedDispatch*>(pArg);
707 try
708 {
709 pDispatch->xDispatch->dispatch( pDispatch->aDispatchURL, pDispatch->aArgs );
710 }
711 catch (const Exception&)
712 {
713 }
714
715 // clean up
716 delete pDispatch;
717}
718
719void BackingWindow::dispatchURL( const OUString& i_rURL,
720 const OUString& rTarget,
721 const Reference< XDispatchProvider >& i_xProv,
722 const Sequence< PropertyValue >& i_rArgs )
723{
724 // if no special dispatch provider is given, get the desktop
725 Reference< XDispatchProvider > xProvider( i_xProv.is() ? i_xProv : mxDesktopDispatchProvider );
726
727 // check for dispatch provider
728 if( !xProvider.is())
729 return;
730
731 // get a URL transformer to clean up the URL
732 css::util::URL aDispatchURL;
733 aDispatchURL.Complete = i_rURL;
734
735 Reference < css::util::XURLTransformer > xURLTransformer(
736 css::util::URLTransformer::create( comphelper::getProcessComponentContext() ) );
737 try
738 {
739 // clean up the URL
740 xURLTransformer->parseStrict( aDispatchURL );
741 // get a Dispatch for the URL and target
742 Reference< XDispatch > xDispatch(
743 xProvider->queryDispatch( aDispatchURL, rTarget, 0 )
744 );
745 // dispatch the URL
746 if ( xDispatch.is() )
747 {
748 std::unique_ptr<ImplDelayedDispatch> pDisp(new ImplDelayedDispatch( xDispatch, aDispatchURL, i_rArgs ));
749 if( Application::PostUserEvent( Link<void*,void>( nullptr, implDispatchDelayed ), pDisp.get() ) )
750 pDisp.release();
751 }
752 }
753 catch (const css::uno::RuntimeException&)
754 {
755 throw;
756 }
757 catch (const css::uno::Exception&)
758 {
759 }
760}
761
762Size BackingWindow::GetOptimalSize() const
763{
764 if (isLayoutEnabled(this))
765 return VclContainer::getLayoutRequisition(*GetWindow(GetWindowType::FirstChild));
766
767 return Window::GetOptimalSize();
768}
769
770void BackingWindow::clearRecentFileList()
771{
772 mpAllRecentThumbnails->Clear();
773 set_width_request(mpAllRecentThumbnails->get_width_request() + mpAllButtonsBox->GetOptimalSize().Width());
774}
775/* 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 ;-)
7
←
Calling 'Reference::clear'
→
14
←
Returning; memory was released
→
205 if (aTmp.get()) {
15
←
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();
6
←
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 )
2
←
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
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
)
8
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
9
←
Calling 'VclReferenceBase::release'
→
13
←
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;
16
←
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)
10
←
Assuming the condition is true
→
11
←
Taking true branch
→
40 delete this;
12
←
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