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 AppView.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 DBACCESS_DLLIMPLEMENTATION -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/external/unixODBC/inc -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/dbaccess/inc -I /home/maarten/src/libreoffice/core/dbaccess/source/inc -I /home/maarten/src/libreoffice/core/dbaccess/source/ui/inc -I /home/maarten/src/libreoffice/core/workdir/YaccTarget/connectivity/source/parse -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/dbaccess/source/ui/app/AppView.cxx

/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.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 "AppView.hxx"
21#include <strings.hrc>
22#include <tools/diagnose_ex.h>
23#include <vcl/event.hxx>
24#include <vcl/weld.hxx>
25#include <com/sun/star/sdbcx/XTablesSupplier.hpp>
26#include <com/sun/star/sdb/XQueriesSupplier.hpp>
27#include "AppDetailView.hxx"
28#include "AppSwapWindow.hxx"
29#include <vcl/settings.hxx>
30#include "AppTitleWindow.hxx"
31#include "AppController.hxx"
32
33using namespace ::dbaui;
34using namespace ::com::sun::star::uno;
35using namespace ::com::sun::star::ucb;
36using namespace ::com::sun::star::beans;
37using namespace ::com::sun::star::sdb;
38using namespace ::com::sun::star::sdbc;
39using namespace ::com::sun::star::sdbcx;
40using namespace ::com::sun::star::datatransfer::clipboard;
41using namespace ::com::sun::star::lang;
42using namespace ::com::sun::star::container;
43using ::com::sun::star::sdb::application::NamedDatabaseObject;
44
45OAppBorderWindow::OAppBorderWindow(OApplicationView* pParent, PreviewMode ePreviewMode)
46 : InterimItemWindow(pParent, "dbaccess/ui/appborderwindow.ui", "AppBorderWindow", false)
47 , m_xPanelParent(m_xBuilder->weld_container("panel"))
48 , m_xDetailViewParent(m_xBuilder->weld_container("detail"))
49 , m_xView(pParent)
50{
51 SetStyle(GetStyle() | WB_DIALOGCONTROL);
52
53 m_xPanel.reset(new OTitleWindow(m_xPanelParent.get(), STR_DATABASEreinterpret_cast<char const *>("STR_DATABASE" "\004" u8"Database"
)
));
54 std::shared_ptr<OChildWindow> xSwap = std::make_shared<OApplicationSwapWindow>(m_xPanel->getChildContainer(), *this);
55
56 m_xPanel->setChildWindow(xSwap);
57
58 m_xDetailView.reset(new OApplicationDetailView(m_xDetailViewParent.get(), *this, ePreviewMode));
59
60 ImplInitSettings();
61}
62
63OAppBorderWindow::~OAppBorderWindow()
64{
65 disposeOnce();
66}
67
68void OAppBorderWindow::dispose()
69{
70 // destroy children
71 m_xPanel.reset();
72 m_xDetailView.reset();
73 m_xPanelParent.reset();
74 m_xDetailViewParent.reset();
75 m_xView.clear();
76 InterimItemWindow::dispose();
77}
78
79void OAppBorderWindow::GetFocus()
80{
81 if (m_xPanel)
82 m_xPanel->GrabFocus();
83}
84
85OApplicationSwapWindow* OAppBorderWindow::getPanel() const
86{
87 return static_cast<OApplicationSwapWindow*>(m_xPanel->getChildWindow());
88}
89
90OApplicationView::OApplicationView( vcl::Window* pParent
91 ,const Reference< XComponentContext >& _rxOrb
92 ,OApplicationController& _rAppController
93 ,PreviewMode _ePreviewMode
94 ) :
95 ODataView( pParent, _rAppController, _rxOrb, WB_DIALOGCONTROL )
96 ,m_rAppController( _rAppController )
97{
98 m_pWin = VclPtr<OAppBorderWindow>::Create(this,_ePreviewMode);
99 m_pWin->Show();
100
101 ImplInitSettings();
102}
103
104OApplicationView::~OApplicationView()
105{
106 disposeOnce();
107}
108
109void OApplicationView::dispose()
110{
111 stopComponentListening(m_xObject);
112 m_xObject.clear();
113 m_pWin->Hide();
114 m_pWin.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
115 ODataView::dispose();
116}
117
118void OApplicationView::createIconAutoMnemonics( MnemonicGenerator& _rMnemonics )
119{
120 if ( m_pWin && m_pWin->getPanel() )
121 m_pWin->getPanel()->createIconAutoMnemonics( _rMnemonics );
122}
123
124void OApplicationView::setTaskExternalMnemonics( MnemonicGenerator const & _rMnemonics )
125{
126 if ( m_pWin && m_pWin->getDetailView() )
127 m_pWin->getDetailView()->setTaskExternalMnemonics( _rMnemonics );
128}
129
130void OApplicationView::DataChanged( const DataChangedEvent& rDCEvt )
131{
132 ODataView::DataChanged( rDCEvt );
133
134 if ( (rDCEvt.GetType() == DataChangedEventType::FONTS) ||
135 (rDCEvt.GetType() == DataChangedEventType::DISPLAY) ||
136 (rDCEvt.GetType() == DataChangedEventType::FONTSUBSTITUTION) ||
137 ((rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
138 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE)) )
139 {
140 ImplInitSettings();
141 Invalidate();
142 }
143}
144
145void OApplicationView::resizeDocumentView(tools::Rectangle& _rPlayground)
146{
147 if ( m_pWin && !_rPlayground.IsEmpty() )
148 {
149 Size aFLSize = LogicToPixel(Size(3, 3), MapMode(MapUnit::MapAppFont));
150 _rPlayground.Move( aFLSize.Width(),aFLSize.Height() );
151 Size aOldSize = _rPlayground.GetSize();
152 _rPlayground.SetSize( Size(aOldSize.Width() - 2*aFLSize.Width(), aOldSize.Height() - 2*aFLSize.Height()) );
153
154 m_pWin->SetPosSizePixel(_rPlayground.TopLeft() , _rPlayground.GetSize() );
155 }
156 // just for completeness: there is no space left, we occupied it all ...
157 _rPlayground.SetPos( _rPlayground.BottomRight() );
158 _rPlayground.SetSize( Size( 0, 0 ) );
159}
160
161OApplicationView::ChildFocusState OApplicationView::getChildFocus() const
162{
163 ChildFocusState eChildFocus;
164 if( m_pWin && getPanel() && getPanel()->HasChildPathFocus() )
165 eChildFocus = PANELSWAP;
166 else if ( m_pWin && getDetailView() && getDetailView()->HasChildPathFocus() )
167 eChildFocus = DETAIL;
168 else
169 eChildFocus = NONE;
170 return eChildFocus;
171}
172
173bool OApplicationView::PreNotify( NotifyEvent& rNEvt )
174{
175 switch(rNEvt.GetType())
176 {
177 case MouseNotifyEvent::KEYINPUT:
178 {
179 const KeyEvent* pKeyEvent = rNEvt.GetKeyEvent();
180 // give the pane the chance to intercept mnemonic accelerators
181 // #i34790#
182 if ( getPanel() && getPanel()->interceptKeyInput( *pKeyEvent ) )
183 return true;
184 }
185 break;
186 default:
187 break;
188 }
189
190 return ODataView::PreNotify(rNEvt);
191}
192
193IClipboardTest* OApplicationView::getActiveChild() const
194{
195 IClipboardTest* pTest = nullptr;
196 if (getChildFocus() == DETAIL)
197 pTest = getDetailView();
198 return pTest;
199}
200
201bool OApplicationView::isCopyAllowed()
202{
203 IClipboardTest* pTest = getActiveChild();
204 return pTest && pTest->isCopyAllowed();
205}
206
207bool OApplicationView::isCutAllowed()
208{
209 IClipboardTest* pTest = getActiveChild();
210 return pTest && pTest->isCutAllowed();
211}
212
213bool OApplicationView::isPasteAllowed()
214{
215 IClipboardTest* pTest = getActiveChild();
216 return pTest && pTest->isPasteAllowed();
217}
218
219void OApplicationView::copy()
220{
221 IClipboardTest* pTest = getActiveChild();
222 if ( pTest )
223 pTest->copy();
224}
225
226void OApplicationView::cut()
227{
228 IClipboardTest* pTest = getActiveChild();
229 if ( pTest )
230 pTest->cut();
231}
232
233void OApplicationView::paste()
234{
235 IClipboardTest* pTest = getActiveChild();
236 if ( pTest )
237 pTest->paste();
238}
239
240OUString OApplicationView::getQualifiedName(const weld::TreeIter* _pEntry) const
241{
242 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "242" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
243 return getDetailView()->getQualifiedName( _pEntry );
244}
245
246bool OApplicationView::isLeaf(const weld::TreeView& rTreeView, const weld::TreeIter& rEntry) const
247{
248 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "248" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
249 return OApplicationDetailView::isLeaf(rTreeView, rEntry);
250}
251
252bool OApplicationView::isALeafSelected() const
253{
254 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "254" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
255 return getDetailView()->isALeafSelected();
256}
257
258void OApplicationView::selectAll()
259{
260 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "260" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
261 getDetailView()->selectAll();
262}
263
264bool OApplicationView::isSortUp() const
265{
266 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "266" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
267 return getDetailView()->isSortUp();
268}
269
270void OApplicationView::sortDown()
271{
272 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "272" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
273 getDetailView()->sortDown();
274}
275
276void OApplicationView::sortUp()
277{
278 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "278" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
279 getDetailView()->sortUp();
280}
281
282bool OApplicationView::isFilled() const
283{
284 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "284" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
285 return getDetailView()->isFilled();
286}
287
288ElementType OApplicationView::getElementType() const
289{
290 OSL_ENSURE(m_pWin && getDetailView() && getPanel(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
&& getPanel()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "290" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
291 return getDetailView()->HasChildPathFocus() ? getDetailView()->getElementType() : getPanel()->getElementType();
292}
293
294sal_Int32 OApplicationView::getSelectionCount() const
295{
296 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "296" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
297 return getDetailView()->getSelectionCount();
298}
299
300sal_Int32 OApplicationView::getElementCount() const
301{
302 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "302" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
303 return getDetailView()->getElementCount();
304}
305
306void OApplicationView::getSelectionElementNames( std::vector< OUString>& _rNames ) const
307{
308 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "308" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
309 getDetailView()->getSelectionElementNames( _rNames );
310}
311
312void OApplicationView::describeCurrentSelectionForControl(const weld::TreeView& rControl, Sequence<NamedDatabaseObject>& out_rSelectedObjects)
313{
314 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "314" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
315 getDetailView()->describeCurrentSelectionForControl(rControl, out_rSelectedObjects);
316}
317
318vcl::Window* OApplicationView::getMenuParent() const
319{
320 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "320" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
321 return getDetailView()->getMenuParent();
322}
323
324void OApplicationView::adjustMenuPosition(const weld::TreeView& rControl, ::Point& rPos) const
325{
326 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "326" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
327 return getDetailView()->adjustMenuPosition(rControl, rPos);
328}
329
330void OApplicationView::describeCurrentSelectionForType( const ElementType _eType, Sequence< NamedDatabaseObject >& _out_rSelectedObjects )
331{
332 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "332" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
333 getDetailView()->describeCurrentSelectionForType( _eType, _out_rSelectedObjects );
334}
335
336void OApplicationView::selectElements(const Sequence< OUString>& _aNames)
337{
338 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "338" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
339 getDetailView()->selectElements( _aNames );
340}
341
342std::unique_ptr<weld::TreeIter> OApplicationView::elementAdded(ElementType eType,const OUString& _rName, const Any& _rObject )
343{
344 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "344" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
345 return getDetailView()->elementAdded(eType,_rName,_rObject);
346}
347
348void OApplicationView::elementRemoved(ElementType eType,const OUString& _rName )
349{
350 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "350" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
351 getDetailView()->elementRemoved(eType,_rName);
352}
353
354void OApplicationView::elementReplaced(ElementType _eType
355 ,const OUString& _rOldName
356 ,const OUString& _rNewName )
357{
358 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "358" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
359 getDetailView()->elementReplaced(_eType, _rOldName, _rNewName );
360}
361
362void OApplicationView::clearPages()
363{
364 OSL_ENSURE(m_pWin && getDetailView() && getPanel(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
&& getPanel()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "364" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
365 getPanel()->clearSelection();
366 getDetailView()->clearPages();
367}
368
369void OApplicationView::selectContainer(ElementType _eType)
370{
371 OSL_ENSURE(m_pWin && getPanel(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getPanel()))) {
sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "371" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
372 weld::WaitObject aWO(GetFrameWeld());
373 getPanel()->selectContainer(_eType);
374}
375
376std::unique_ptr<weld::TreeIter> OApplicationView::getEntry(const Point& rPosPixel) const
377{
378 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "378" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
379 return getDetailView()->getEntry(rPosPixel);
380}
381
382PreviewMode OApplicationView::getPreviewMode() const
383{
384 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "384" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
385 return getDetailView()->getPreviewMode();
386}
387
388bool OApplicationView::isPreviewEnabled() const
389{
390 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "390" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
391 return getDetailView()->isPreviewEnabled();
392}
393
394void OApplicationView::switchPreview(PreviewMode _eMode)
395{
396 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "396" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
397 getDetailView()->switchPreview(_eMode);
398}
399
400void OApplicationView::showPreview(const Reference< XContent >& _xContent)
401{
402 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "402" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
403 stopComponentListening(m_xObject);
404 m_xObject = nullptr;
405 getDetailView()->showPreview(_xContent);
406}
407
408void OApplicationView::showPreview( const OUString& _sDataSourceName,
409 const css::uno::Reference< css::sdbc::XConnection>& _xConnection,
410 const OUString& _sName,
411 bool _bTable)
412{
413 OSL_ENSURE(m_pWin && getDetailView(),"Detail view is NULL! -> GPF")do { if (true && (!(m_pWin && getDetailView()
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "413" ": "), "%s", "Detail view is NULL! -> GPF"); } }
while (false)
;
414 if ( !isPreviewEnabled() )
415 return;
416
417 stopComponentListening(m_xObject);
418 m_xObject = nullptr;
419 try
420 {
421 Reference<XNameAccess> xNameAccess;
422 if ( _bTable )
423 {
424 Reference<XTablesSupplier> xSup(_xConnection,UNO_QUERY);
425 if ( xSup.is() )
426 xNameAccess = xSup->getTables();
427 }
428 else
429 {
430 Reference<XQueriesSupplier> xSup(_xConnection,UNO_QUERY);
431 if ( xSup.is() )
432 xNameAccess = xSup->getQueries();
433 }
434 if ( xNameAccess.is() && xNameAccess->hasByName(_sName) )
435 m_xObject.set(xNameAccess->getByName(_sName),UNO_QUERY);
436 }
437 catch( const Exception& )
438 {
439 DBG_UNHANDLED_EXCEPTION("dbaccess")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/dbaccess/source/ui/app/AppView.cxx"
":" "439" ": ", "dbaccess" );
;
440 }
441 if ( m_xObject.is() )
442 startComponentListening(m_xObject);
443 getDetailView()->showPreview(_sDataSourceName,_sName,_bTable);
444}
445
446void OApplicationView::GetFocus()
447{
448 if (m_pWin && getChildFocus() == NONE)
449 m_pWin->GrabFocus();
450}
451
452void OApplicationView::_disposing( const css::lang::EventObject& /*_rSource*/ )
453{
454 if ( m_pWin && getDetailView() )
455 showPreview(nullptr);
456}
457
458void OApplicationView::ImplInitSettings()
459{
460 // FIXME RenderContext
461 const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
462
463 vcl::Font aFont = rStyleSettings.GetFieldFont();
464 aFont.SetColor( rStyleSettings.GetWindowTextColor() );
465 SetPointFont(*this, aFont);
466
467 SetTextColor( rStyleSettings.GetFieldTextColor() );
468 SetTextFillColor();
469
470 SetBackground( rStyleSettings.GetFieldColor() );
471}
472
473/* 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 ;-)
2
Calling 'Reference::clear'
9
Returning; memory was released
205 if (aTmp.get()) {
10
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
2.1
Field 'm_pBody' is non-null
2.1
Field 'm_pBody' is non-null
2.1
Field 'm_pBody' is non-null
2.1
Field 'm_pBody' is non-null
)
3
Taking true branch
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
4
Calling 'VclReferenceBase::release'
8
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;
11
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)
5
Assuming the condition is true
6
Taking true branch
40 delete this;
7
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