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 DesignView.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 -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 EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -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/reportdesign/inc -I /home/maarten/src/libreoffice/core/reportdesign/source/inc -I /home/maarten/src/libreoffice/core/reportdesign/source/ui/inc -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/reportdesign/source/ui/report/DesignView.cxx

/home/maarten/src/libreoffice/core/reportdesign/source/ui/report/DesignView.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 <DesignView.hxx>
21#include <ReportController.hxx>
22#include <svtools/acceleratorexecute.hxx>
23#include <unotools/viewoptions.hxx>
24#include <RptDef.hxx>
25#include <UITools.hxx>
26#include <RptObject.hxx>
27#include <propbrw.hxx>
28#include <helpids.h>
29#include <SectionView.hxx>
30#include <ReportSection.hxx>
31#include <rptui_slotid.hrc>
32#include <AddField.hxx>
33#include <ScrollHelper.hxx>
34#include <Navigator.hxx>
35#include <SectionWindow.hxx>
36
37#include <vcl/settings.hxx>
38#include <vcl/svapp.hxx>
39
40namespace rptui
41{
42using namespace ::dbaui;
43using namespace ::utl;
44using namespace ::com::sun::star;
45using namespace uno;
46using namespace lang;
47using namespace beans;
48using namespace container;
49
50#define START_SIZE_TASKPANE30 30
51#define COLSET_ID1 1
52#define REPORT_ID2 2
53#define TASKPANE_ID3 3
54
55namespace {
56
57class OTaskWindow : public vcl::Window
58{
59 VclPtr<PropBrw> m_pPropWin;
60public:
61 explicit OTaskWindow(vcl::Window* _pParent) : Window(_pParent),m_pPropWin(nullptr){}
62 virtual ~OTaskWindow() override { disposeOnce(); }
63 virtual void dispose() override { m_pPropWin.clear(); vcl::Window::dispose(); }
64
65 void setPropertyBrowser(PropBrw* _pPropWin)
66 {
67 m_pPropWin = _pPropWin;
68 }
69
70 virtual void Resize() override
71 {
72 const Size aSize = GetOutputSizePixel();
73 if ( m_pPropWin && aSize.Height() && aSize.Width() )
74 m_pPropWin->SetSizePixel(aSize);
75 }
76};
77
78}
79
80
81
82ODesignView::ODesignView( vcl::Window* pParent,
83 const Reference< XComponentContext >& _rxOrb,
84 OReportController& _rController) :
85 ODataView( pParent, _rController, _rxOrb, WB_DIALOGCONTROL )
86 ,m_aSplitWin(VclPtr<SplitWindow>::Create(this))
87 ,m_rReportController( _rController )
88 ,m_aScrollWindow(VclPtr<rptui::OScrollWindowHelper>::Create(this))
89 ,m_pPropWin(nullptr)
90 ,m_pCurrentView(nullptr)
91 ,m_eMode( DlgEdMode::Select )
92 ,m_eActObj( OBJ_NONE )
93 ,m_aGridSizeCoarse( 1000, 1000 ) // #i93595# 100TH_MM changed to grid using coarse 1 cm grid
94 ,m_aGridSizeFine( 250, 250 ) // and a 0,25 cm subdivision for better visualisation
95 ,m_bDeleted( false )
96{
97 SetHelpId(UID_RPT_RPT_APP_VIEW"REPORTDESIGN_UID_RPT_RPT_APP_VIEW");
98 ImplInitSettings();
99
100 SetMapMode( MapMode( MapUnit::Map100thMM ) );
101
102 // now create the task pane on the right side :-)
103 m_pTaskPane = VclPtr<OTaskWindow>::Create(this);
104
105 m_aSplitWin->InsertItem( COLSET_ID1,100,SPLITWINDOW_APPEND(sal_uInt16(0xFFFF)), 0, SplitWindowItemFlags::PercentSize | SplitWindowItemFlags::ColSet );
106 m_aSplitWin->InsertItem( REPORT_ID2, m_aScrollWindow.get(), 100, SPLITWINDOW_APPEND(sal_uInt16(0xFFFF)), COLSET_ID1, SplitWindowItemFlags::PercentSize);
107
108 // set up splitter
109 m_aSplitWin->SetSplitHdl(LINK(this, ODesignView,SplitHdl)::tools::detail::makeLink( ::tools::detail::castTo<ODesignView
*>(this), &ODesignView::LinkStubSplitHdl)
);
110 m_aSplitWin->SetAlign(WindowAlign::Left);
111 m_aSplitWin->Show();
112
113 m_aMarkIdle.SetInvokeHandler( LINK( this, ODesignView, MarkTimeout )::tools::detail::makeLink( ::tools::detail::castTo<ODesignView
*>(this), &ODesignView::LinkStubMarkTimeout)
);
114}
115
116
117ODesignView::~ODesignView()
118{
119 disposeOnce();
120}
121
122void ODesignView::dispose()
123{
124 m_bDeleted = true;
125 Hide();
126 m_aScrollWindow->Hide();
127 m_aMarkIdle.Stop();
128 if ( m_pPropWin )
1
Taking true branch
129 {
130 notifySystemWindow(this,m_pPropWin,::comphelper::mem_fun(&TaskPaneList::RemoveWindow));
131 m_pPropWin.disposeAndClear();
2
Calling 'VclPtr::disposeAndClear'
132 }
133 if ( m_xAddField )
134 {
135 SvtViewOptions aDlgOpt( EViewType::Window, UID_RPT_RPT_APP_VIEW"REPORTDESIGN_UID_RPT_RPT_APP_VIEW" );
136 aDlgOpt.SetWindowState(OStringToOUString(m_xAddField->getDialog()->get_window_state(WindowStateMask::All), RTL_TEXTENCODING_ASCII_US(((rtl_TextEncoding) 11))));
137
138 if (m_xAddField->getDialog()->get_visible())
139 m_xAddField->response(RET_CANCEL);
140
141 m_xAddField.reset();
142 }
143 if ( m_xReportExplorer )
144 {
145 SvtViewOptions aDlgOpt(EViewType::Window, OStringToOUString(m_xReportExplorer->get_help_id(), RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76))));
146 aDlgOpt.SetWindowState(OStringToOUString(m_xReportExplorer->getDialog()->get_window_state(WindowStateMask::All), RTL_TEXTENCODING_ASCII_US(((rtl_TextEncoding) 11))));
147
148 if (m_xReportExplorer->getDialog()->get_visible())
149 m_xReportExplorer->response(RET_CANCEL);
150
151 m_xReportExplorer.reset();
152 }
153
154 m_pTaskPane.disposeAndClear();
155 m_aScrollWindow.disposeAndClear();
156 m_aSplitWin.disposeAndClear();
157 dbaui::ODataView::dispose();
158}
159
160void ODesignView::initialize()
161{
162 SetMapMode( MapMode( MapUnit::Map100thMM ) );
163 m_aScrollWindow->initialize();
164 m_aScrollWindow->Show();
165}
166
167void ODesignView::DataChanged( const DataChangedEvent& rDCEvt )
168{
169 ODataView::DataChanged( rDCEvt );
170
171 if ( (rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
172 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) )
173 {
174 ImplInitSettings();
175 Invalidate();
176 }
177}
178
179bool ODesignView::PreNotify( NotifyEvent& rNEvt )
180{
181 bool bRet = ODataView::PreNotify(rNEvt); // 1 := has to be handled here
182 switch(rNEvt.GetType())
183 {
184 case MouseNotifyEvent::KEYINPUT:
185 {
186 if ( m_pPropWin && m_pPropWin->HasChildPathFocus() )
187 return false;
188 if (m_xAddField && m_xAddField->getDialog()->has_toplevel_focus())
189 return false;
190 if ( m_xReportExplorer && m_xReportExplorer->getDialog()->has_toplevel_focus())
191 return false;
192 const KeyEvent* pKeyEvent = rNEvt.GetKeyEvent();
193 if ( handleKeyEvent(*pKeyEvent) )
194 bRet = true;
195 else if ( bRet && m_pAccel )
196 {
197 const vcl::KeyCode& rCode = pKeyEvent->GetKeyCode();
198 util::URL aUrl;
199 aUrl.Complete = m_pAccel->findCommand(svt::AcceleratorExecute::st_VCLKey2AWTKey(rCode));
200 if ( aUrl.Complete.isEmpty() || !m_xController->isCommandEnabled( aUrl.Complete ) )
201 bRet = false;
202 }
203 break;
204 }
205 default:
206 break;
207 }
208
209 return bRet;
210}
211
212void ODesignView::resizeDocumentView(tools::Rectangle& _rPlayground)
213{
214 if ( !_rPlayground.IsEmpty() )
215 {
216 const Size aPlaygroundSize( _rPlayground.GetSize() );
217
218 // calc the split pos, and forward it to the controller
219 sal_Int32 nSplitPos = getController().getSplitPos();
220 if ( 0 != aPlaygroundSize.Width() )
221 {
222 if ( ( -1 == nSplitPos )
223 || ( nSplitPos >= aPlaygroundSize.Width() )
224 )
225 {
226 long nMinWidth = static_cast<long>(0.1*aPlaygroundSize.Width());
227 if ( m_pPropWin && m_pPropWin->IsVisible() )
228 nMinWidth = m_pPropWin->GetMinOutputSizePixel().Width();
229 nSplitPos = static_cast<sal_Int32>(_rPlayground.Right() - nMinWidth);
230 getController().setSplitPos(nSplitPos);
231 }
232 }
233
234 if ( m_aSplitWin->IsItemValid(TASKPANE_ID3) )
235 {
236 // normalize the split pos
237 const long nSplitterWidth = StyleSettings::GetSplitSize();
238 Point aTaskPanePos(nSplitPos + nSplitterWidth, _rPlayground.Top());
239 if (m_pTaskPane && m_pTaskPane->IsVisible() && m_pPropWin)
240 {
241 aTaskPanePos.setX( aPlaygroundSize.Width() - m_pTaskPane->GetSizePixel().Width() );
242 sal_Int32 nMinWidth = m_pPropWin->getMinimumSize().Width();
243 if ( nMinWidth > (aPlaygroundSize.Width() - aTaskPanePos.X()) )
244 {
245 aTaskPanePos.setX( aPlaygroundSize.Width() - nMinWidth );
246 }
247 nSplitPos = aTaskPanePos.X() - nSplitterWidth;
248 getController().setSplitPos(nSplitPos);
249
250 const long nTaskPaneSize = static_cast<long>((aPlaygroundSize.Width() - aTaskPanePos.X())*100/aPlaygroundSize.Width());
251 if ( m_aSplitWin->GetItemSize( TASKPANE_ID3 ) != nTaskPaneSize )
252 {
253 m_aSplitWin->SetItemSize( REPORT_ID2, 99 - nTaskPaneSize );
254 m_aSplitWin->SetItemSize( TASKPANE_ID3, nTaskPaneSize );
255 }
256 }
257 }
258 // set the size of the report window
259 m_aSplitWin->SetPosSizePixel( _rPlayground.TopLeft(),aPlaygroundSize );
260 }
261 // just for completeness: there is no space left, we occupied it all ...
262 _rPlayground.SetPos( _rPlayground.BottomRight() );
263 _rPlayground.SetSize( Size( 0, 0 ) );
264
265}
266
267IMPL_LINK_NOARG(ODesignView, MarkTimeout, Timer *, void)void ODesignView::LinkStubMarkTimeout(void * instance, Timer *
data) { return static_cast<ODesignView *>(instance)->
MarkTimeout(data); } void ODesignView::MarkTimeout(__attribute__
((unused)) Timer *)
268{
269 if ( m_pPropWin && m_pPropWin->IsVisible() )
270 {
271 m_pPropWin->Update(m_pCurrentView);
272 uno::Reference<beans::XPropertySet> xProp(m_xReportComponent,uno::UNO_QUERY);
273 if ( xProp.is() )
274 {
275 m_pPropWin->Update(xProp);
276 static_cast<OTaskWindow*>(m_pTaskPane.get())->Resize();
277 }
278 Resize();
279 }
280}
281
282
283void ODesignView::SetMode( DlgEdMode _eNewMode )
284{
285 m_eMode = _eNewMode;
286 if ( m_eMode == DlgEdMode::Select )
287 m_eActObj = OBJ_NONE;
288
289 m_aScrollWindow->SetMode(_eNewMode);
290}
291
292void ODesignView::SetInsertObj( sal_uInt16 eObj,const OUString& _sShapeType )
293{
294 m_eActObj = eObj;
295 m_aScrollWindow->SetInsertObj( eObj,_sShapeType );
296}
297
298OUString const & ODesignView::GetInsertObjString() const
299{
300 return m_aScrollWindow->GetInsertObjString();
301}
302
303
304void ODesignView::Cut()
305{
306 Copy();
307 Delete();
308}
309
310
311void ODesignView::Copy()
312{
313 m_aScrollWindow->Copy();
314}
315
316
317void ODesignView::Paste()
318{
319 m_aScrollWindow->Paste();
320}
321
322void ODesignView::Delete()
323{
324 m_aScrollWindow->Delete();
325}
326
327bool ODesignView::HasSelection() const
328{
329 return m_aScrollWindow->HasSelection();
330}
331
332
333bool ODesignView::IsPasteAllowed() const
334{
335 return m_aScrollWindow->IsPasteAllowed();
336}
337
338
339void ODesignView::UpdatePropertyBrowserDelayed(OSectionView& _rView)
340{
341 if ( m_pCurrentView != &_rView )
342 {
343 if ( m_pCurrentView )
344 m_aScrollWindow->setMarked(m_pCurrentView,false);
345 m_pCurrentView = &_rView;
346 m_aScrollWindow->setMarked(m_pCurrentView, true);
347 m_xReportComponent.clear();
348 DlgEdHint aHint( RPTUI_HINT_SELECTIONCHANGED );
349 Broadcast( aHint );
350 }
351 m_aMarkIdle.Start();
352}
353
354
355void ODesignView::toggleGrid(bool _bGridVisible)
356{
357 m_aScrollWindow->toggleGrid(_bGridVisible);
358}
359
360sal_uInt16 ODesignView::getSectionCount() const
361{
362 return m_aScrollWindow->getSectionCount();
363}
364
365void ODesignView::showRuler(bool _bShow)
366{
367 m_aScrollWindow->showRuler(_bShow);
368}
369
370void ODesignView::removeSection(sal_uInt16 _nPosition)
371{
372 m_aScrollWindow->removeSection(_nPosition);
373}
374
375void ODesignView::addSection(const uno::Reference< report::XSection >& _xSection,const OUString& _sColorEntry,sal_uInt16 _nPosition)
376{
377 m_aScrollWindow->addSection(_xSection,_sColorEntry,_nPosition);
378}
379
380void ODesignView::GetFocus()
381{
382 Window::GetFocus();
383
384 if ( !m_bDeleted )
385 {
386 OSectionWindow* pSectionWindow = m_aScrollWindow->getMarkedSection();
387 if ( pSectionWindow )
388 pSectionWindow->GrabFocus();
389 }
390}
391
392void ODesignView::ImplInitSettings()
393{
394 SetBackground( Wallpaper( Application::GetSettings().GetStyleSettings().GetFaceColor() ));
395 SetFillColor( Application::GetSettings().GetStyleSettings().GetFaceColor() );
396 SetTextFillColor( Application::GetSettings().GetStyleSettings().GetFaceColor() );
397}
398
399IMPL_LINK_NOARG( ODesignView, SplitHdl, SplitWindow*, void )void ODesignView::LinkStubSplitHdl(void * instance, SplitWindow
* data) { return static_cast<ODesignView *>(instance)->
SplitHdl(data); } void ODesignView::SplitHdl(__attribute__ ((
unused)) SplitWindow*)
400{
401 const Size aOutputSize = GetOutputSizePixel();
402 const long nTest = aOutputSize.Width() * m_aSplitWin->GetItemSize(TASKPANE_ID3) / 100;
403 long nMinWidth = static_cast<long>(0.1*aOutputSize.Width());
404 if ( m_pPropWin && m_pPropWin->IsVisible() )
405 nMinWidth = m_pPropWin->GetMinOutputSizePixel().Width();
406
407 if ( (aOutputSize.Width() - nTest) >= nMinWidth && nTest > m_aScrollWindow->getMaxMarkerWidth() )
408 {
409 getController().setSplitPos(nTest);
410 }
411}
412
413void ODesignView::SelectAll(const sal_uInt16 _nObjectType)
414{
415 m_aScrollWindow->SelectAll(_nObjectType);
416}
417
418void ODesignView::unmarkAllObjects()
419{
420 m_aScrollWindow->unmarkAllObjects();
421}
422
423void ODesignView::togglePropertyBrowser(bool _bToggleOn)
424{
425 if ( !m_pPropWin && _bToggleOn )
426 {
427 m_pPropWin = VclPtr<PropBrw>::Create(getController().getORB(), m_pTaskPane,this);
428 m_pPropWin->Invalidate();
429 static_cast<OTaskWindow*>(m_pTaskPane.get())->setPropertyBrowser(m_pPropWin);
430 notifySystemWindow(this,m_pPropWin,::comphelper::mem_fun(&TaskPaneList::AddWindow));
431 }
432 if ( !(m_pPropWin && _bToggleOn != m_pPropWin->IsVisible()) )
433 return;
434
435 if ( !m_pCurrentView && !m_xReportComponent.is() )
436 m_xReportComponent = getController().getReportDefinition();
437
438 const bool bWillBeVisible = _bToggleOn;
439 m_pPropWin->Show(bWillBeVisible);
440 m_pTaskPane->Show(bWillBeVisible);
441 m_pTaskPane->Invalidate();
442
443 if ( bWillBeVisible )
444 m_aSplitWin->InsertItem( TASKPANE_ID3, m_pTaskPane,START_SIZE_TASKPANE30, SPLITWINDOW_APPEND(sal_uInt16(0xFFFF)), COLSET_ID1, SplitWindowItemFlags::PercentSize);
445 else
446 m_aSplitWin->RemoveItem(TASKPANE_ID3);
447
448 if ( bWillBeVisible )
449 m_aMarkIdle.Start();
450}
451
452void ODesignView::showProperties(const uno::Reference< uno::XInterface>& _xReportComponent)
453{
454 if ( m_xReportComponent != _xReportComponent )
455 {
456 m_xReportComponent = _xReportComponent;
457 if ( m_pCurrentView )
458 m_aScrollWindow->setMarked(m_pCurrentView,false);
459 m_pCurrentView = nullptr;
460 m_aMarkIdle.Start();
461 }
462}
463
464bool ODesignView::isReportExplorerVisible() const
465{
466 return m_xReportExplorer && m_xReportExplorer->getDialog()->get_visible();
467}
468
469void ODesignView::toggleReportExplorer()
470{
471 if ( !m_xReportExplorer )
472 {
473 OReportController& rReportController = getController();
474 m_xReportExplorer = std::make_shared<ONavigator>(GetFrameWeld(), rReportController);
475 SvtViewOptions aDlgOpt(EViewType::Window, OStringToOUString(m_xReportExplorer->get_help_id(), RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76))));
476 if ( aDlgOpt.Exists() )
477 m_xReportExplorer->getDialog()->set_window_state(OUStringToOString(aDlgOpt.GetWindowState(), RTL_TEXTENCODING_ASCII_US(((rtl_TextEncoding) 11))));
478 }
479
480 if (!m_xReportExplorer->getDialog()->get_visible())
481 weld::DialogController::runAsync(m_xReportExplorer, [this](sal_Int32 /*nResult*/) { m_xReportExplorer.reset(); });
482 else
483 m_xReportExplorer->response(RET_CANCEL);
484}
485
486bool ODesignView::isAddFieldVisible() const
487{
488 return m_xAddField && m_xAddField->getDialog()->get_visible();
489}
490
491void ODesignView::toggleAddField()
492{
493 if (!m_xAddField)
494 {
495 uno::Reference< report::XReportDefinition > xReport(m_xReportComponent,uno::UNO_QUERY);
496 uno::Reference< report::XReportComponent > xReportComponent(m_xReportComponent,uno::UNO_QUERY);
497 OReportController& rReportController = getController();
498 if ( !m_pCurrentView && !xReport.is() )
499 {
500 if ( xReportComponent.is() )
501 xReport = xReportComponent->getSection()->getReportDefinition();
502 else
503 xReport = rReportController.getReportDefinition().get();
504 }
505 else if ( m_pCurrentView )
506 {
507 uno::Reference< report::XSection > xSection = m_pCurrentView->getReportSection()->getSection();
508 xReport = xSection->getReportDefinition();
509 }
510 uno::Reference < beans::XPropertySet > xSet(rReportController.getRowSet(),uno::UNO_QUERY);
511 m_xAddField = std::make_shared<OAddFieldWindow>(GetFrameWeld(), xSet);
512 m_xAddField->SetCreateHdl(LINK( &rReportController, OReportController, OnCreateHdl )::tools::detail::makeLink( ::tools::detail::castTo<OReportController
*>(&rReportController), &OReportController::LinkStubOnCreateHdl
)
);
513 SvtViewOptions aDlgOpt( EViewType::Window, UID_RPT_RPT_APP_VIEW"REPORTDESIGN_UID_RPT_RPT_APP_VIEW" );
514 if ( aDlgOpt.Exists() )
515 m_xAddField->getDialog()->set_window_state(OUStringToOString(aDlgOpt.GetWindowState(), RTL_TEXTENCODING_ASCII_US(((rtl_TextEncoding) 11))));
516 m_xAddField->Update();
517 }
518 if (!m_xAddField->getDialog()->get_visible())
519 weld::DialogController::runAsync(m_xAddField, [this](sal_Int32 /*nResult*/) { m_xAddField.reset(); });
520 else
521 m_xAddField->response(RET_CANCEL);
522}
523
524uno::Reference< report::XSection > ODesignView::getCurrentSection() const
525{
526 uno::Reference< report::XSection > xSection;
527 if ( m_pCurrentView )
528 xSection = m_pCurrentView->getReportSection()->getSection();
529
530 return xSection;
531}
532
533uno::Reference< report::XReportComponent > ODesignView::getCurrentControlModel() const
534{
535 uno::Reference< report::XReportComponent > xModel;
536 if ( m_pCurrentView )
537 {
538 xModel = m_pCurrentView->getReportSection()->getCurrentControlModel();
539 }
540 return xModel;
541}
542
543OSectionWindow* ODesignView::getMarkedSection(NearSectionAccess nsa) const
544{
545 return m_aScrollWindow->getMarkedSection(nsa);
546}
547
548OSectionWindow* ODesignView::getSectionWindow(const css::uno::Reference< css::report::XSection>& _xSection) const
549{
550 return m_aScrollWindow->getSectionWindow(_xSection);
551}
552
553void ODesignView::markSection(const sal_uInt16 _nPos)
554{
555 m_aScrollWindow->markSection(_nPos);
556}
557
558void ODesignView::fillCollapsedSections(::std::vector<sal_uInt16>& _rCollapsedPositions) const
559{
560 m_aScrollWindow->fillCollapsedSections(_rCollapsedPositions);
561}
562
563void ODesignView::collapseSections(const uno::Sequence< beans::PropertyValue>& _aCollapsedSections)
564{
565 m_aScrollWindow->collapseSections(_aCollapsedSections);
566}
567
568OUString ODesignView::getCurrentPage() const
569{
570 return m_pPropWin ? m_pPropWin->getCurrentPage() : OUString();
571}
572
573void ODesignView::setCurrentPage(const OUString& _sLastActivePage)
574{
575 if ( m_pPropWin )
576 m_pPropWin->setCurrentPage(_sLastActivePage);
577}
578
579void ODesignView::alignMarkedObjects(ControlModification _nControlModification,bool _bAlignAtSection)
580{
581 m_aScrollWindow->alignMarkedObjects(_nControlModification, _bAlignAtSection);
582}
583
584bool ODesignView::handleKeyEvent(const KeyEvent& _rEvent)
585{
586 if ( m_pPropWin && m_pPropWin->HasChildPathFocus() )
587 return false;
588 if (m_xAddField && m_xAddField->getDialog()->has_toplevel_focus())
589 return false;
590 if (m_xReportExplorer && m_xReportExplorer->getDialog()->has_toplevel_focus())
591 return false;
592 return m_aScrollWindow->handleKeyEvent(_rEvent);
593}
594
595void ODesignView::setMarked(const uno::Reference< report::XSection>& _xSection,bool _bMark)
596{
597 m_aScrollWindow->setMarked(_xSection,_bMark);
598 if ( _bMark )
599 UpdatePropertyBrowserDelayed(getMarkedSection()->getReportSection().getSectionView());
600 else
601 m_pCurrentView = nullptr;
602}
603
604void ODesignView::setMarked(const uno::Sequence< uno::Reference< report::XReportComponent> >& _aShapes,bool _bMark)
605{
606 m_aScrollWindow->setMarked(_aShapes,_bMark);
607 if ( _aShapes.hasElements() && _bMark )
608 showProperties(_aShapes[0]);
609 else
610 m_xReportComponent.clear();
611}
612
613void ODesignView::MouseButtonDown( const MouseEvent& rMEvt )
614{
615 if ( rMEvt.IsLeft() )
616 {
617 const uno::Sequence< beans::PropertyValue> aArgs;
618 getController().executeChecked(SID_SELECT_REPORT( ((((((((((10000 + 1499) + 1) + 499) + 1) + 100) + 1) + 149)
+ 1) + 200) + 1) + 12 )
,aArgs);
619 }
620 ODataView::MouseButtonDown(rMEvt);
621}
622
623uno::Any ODesignView::getCurrentlyShownProperty() const
624{
625 uno::Any aRet;
626 OSectionWindow* pSectionWindow = getMarkedSection();
627 if ( pSectionWindow )
628 {
629 ::std::vector< uno::Reference< uno::XInterface > > aSelection;
630 pSectionWindow->getReportSection().fillControlModelSelection(aSelection);
631 if ( !aSelection.empty() )
632 {
633 uno::Sequence< uno::Reference< report::XReportComponent > > aSeq(aSelection.size());
634 sal_Int32 i = 0;
635 for(const auto& rxInterface : aSelection)
636 {
637 aSeq[i].set(rxInterface,uno::UNO_QUERY);
638 ++i;
639 }
640 aRet <<= aSeq;
641 }
642 }
643 return aRet;
644}
645
646void ODesignView::fillControlModelSelection(::std::vector< uno::Reference< uno::XInterface > >& _rSelection) const
647{
648 m_aScrollWindow->fillControlModelSelection(_rSelection);
649}
650
651void ODesignView::setGridSnap(bool bOn)
652{
653 m_aScrollWindow->setGridSnap(bOn);
654
655}
656
657void ODesignView::setDragStripes(bool bOn)
658{
659 m_aScrollWindow->setDragStripes(bOn);
660}
661
662bool ODesignView::isHandleEvent() const
663{
664 return m_pPropWin && m_pPropWin->HasChildPathFocus();
665}
666
667sal_uInt32 ODesignView::getMarkedObjectCount() const
668{
669 return m_aScrollWindow->getMarkedObjectCount();
670}
671
672void ODesignView::zoom(const Fraction& _aZoom)
673{
674 m_aScrollWindow->zoom(_aZoom);
675}
676
677sal_uInt16 ODesignView::getZoomFactor(SvxZoomType _eType) const
678{
679 return m_aScrollWindow->getZoomFactor(_eType);
680}
681
682} // rptui
683
684
685/* 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 ;-)
3
Calling 'Reference::clear'
10
Returning; memory was released
205 if (aTmp.get()) {
11
Calling 'Reference::get'
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
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
3.1
Field 'm_pBody' is non-null
3.1
Field 'm_pBody' is non-null
3.1
Field 'm_pBody' is non-null
3.1
Field 'm_pBody' is non-null
)
4
Taking true branch
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
5
Calling 'VclReferenceBase::release'
9
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;
12
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)
6
Assuming the condition is true
7
Taking true branch
40 delete this;
8
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