Bug Summary

File:home/maarten/src/libreoffice/core/include/rtl/ref.hxx
Warning:line 113, column 13
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 filtnav.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 SVX_DLLIMPLEMENTATION -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/svx/inc -I /home/maarten/src/libreoffice/core/svx/source/inc -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -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/svx/source/form/filtnav.cxx

/home/maarten/src/libreoffice/core/svx/source/form/filtnav.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 <memory>
21#include <filtnav.hxx>
22#include <fmexch.hxx>
23#include <helpids.h>
24#include <fmprop.hxx>
25#include <svx/strings.hrc>
26
27#include <com/sun/star/awt/XControl.hpp>
28#include <com/sun/star/form/runtime/XFormController.hpp>
29#include <com/sun/star/util/NumberFormatter.hpp>
30#include <com/sun/star/sdb/SQLContext.hpp>
31
32#include <comphelper/processfactory.hxx>
33#include <comphelper/string.hxx>
34#include <connectivity/dbtools.hxx>
35#include <connectivity/sqlnode.hxx>
36#include <cppuhelper/implbase.hxx>
37#include <i18nlangtag/languagetag.hxx>
38#include <fmshimp.hxx>
39#include <o3tl/safeint.hxx>
40#include <sfx2/objitem.hxx>
41#include <sfx2/request.hxx>
42#include <svx/dialmgr.hxx>
43#include <svx/fmshell.hxx>
44#include <svx/fmtools.hxx>
45#include <svx/svxids.hrc>
46#include <vcl/settings.hxx>
47#include <tools/diagnose_ex.h>
48#include <vcl/commandevent.hxx>
49#include <vcl/event.hxx>
50#include <vcl/svapp.hxx>
51
52#include <bitmaps.hlst>
53
54#include <functional>
55
56using namespace ::svxform;
57using namespace ::connectivity;
58using namespace ::dbtools;
59
60namespace svxform
61{
62 using ::com::sun::star::uno::Reference;
63 using ::com::sun::star::container::XIndexAccess;
64 using ::com::sun::star::uno::UNO_QUERY;
65 using ::com::sun::star::beans::XPropertySet;
66 using ::com::sun::star::form::runtime::XFormController;
67 using ::com::sun::star::form::runtime::XFilterController;
68 using ::com::sun::star::form::runtime::XFilterControllerListener;
69 using ::com::sun::star::form::runtime::FilterEvent;
70 using ::com::sun::star::lang::EventObject;
71 using ::com::sun::star::form::XForm;
72 using ::com::sun::star::container::XChild;
73 using ::com::sun::star::awt::XControl;
74 using ::com::sun::star::sdbc::XConnection;
75 using ::com::sun::star::util::XNumberFormatsSupplier;
76 using ::com::sun::star::util::XNumberFormatter;
77 using ::com::sun::star::util::NumberFormatter;
78 using ::com::sun::star::sdbc::XRowSet;
79 using ::com::sun::star::lang::Locale;
80 using ::com::sun::star::sdb::SQLContext;
81 using ::com::sun::star::uno::XInterface;
82 using ::com::sun::star::uno::UNO_QUERY_THROW;
83 using ::com::sun::star::uno::UNO_SET_THROW;
84 using ::com::sun::star::uno::Exception;
85 using ::com::sun::star::uno::Sequence;
86
87
88OFilterItemExchange::OFilterItemExchange()
89 : m_pFormItem(nullptr)
90{
91}
92
93void OFilterItemExchange::AddSupportedFormats()
94{
95 AddFormat(getFormatId());
96}
97
98SotClipboardFormatId OFilterItemExchange::getFormatId()
99{
100 static SotClipboardFormatId s_nFormat =
101 SotExchange::RegisterFormatName("application/x-openoffice;windows_formatname=\"form.FilterControlExchange\"");
102 DBG_ASSERT(static_cast<SotClipboardFormatId>(-1) != s_nFormat, "OFilterExchangeHelper::getFormatId: bad exchange id!")do { if (true && (!(static_cast<SotClipboardFormatId
>(-1) != s_nFormat))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "102" ": "), "%s", "OFilterExchangeHelper::getFormatId: bad exchange id!"
); } } while (false)
;
103 return s_nFormat;
104}
105
106OLocalExchange* OFilterExchangeHelper::createExchange() const
107{
108 return new OFilterItemExchange;
109}
110
111OUString FmFilterData::GetImage() const
112{
113 return OUString();
114}
115
116FmParentData::~FmParentData()
117{
118}
119
120OUString FmFormItem::GetImage() const
121{
122 return RID_SVXBMP_FORM"res/sx10593.png";
123}
124
125FmFilterItem* FmFilterItems::Find( const ::sal_Int32 _nFilterComponentIndex ) const
126{
127 for ( auto & pData : m_aChildren )
128 {
129 FmFilterItem& rCondition = dynamic_cast<FmFilterItem&>(*pData);
130 if ( _nFilterComponentIndex == rCondition.GetComponentIndex() )
131 return &rCondition;
132 }
133 return nullptr;
134}
135
136OUString FmFilterItems::GetImage() const
137{
138 return RID_SVXBMP_FILTER"res/sx10715.png";
139}
140
141FmFilterItem::FmFilterItem( FmFilterItems* pParent,
142 const OUString& aFieldName,
143 const OUString& aText,
144 const sal_Int32 _nComponentIndex )
145 :FmFilterData(pParent, aText)
146 ,m_aFieldName(aFieldName)
147 ,m_nComponentIndex( _nComponentIndex )
148{
149}
150
151OUString FmFilterItem::GetImage() const
152{
153 return RID_SVXBMP_FIELD"res/sx18027.png";
154}
155
156// Hints for communication between model and view
157
158namespace {
159
160class FmFilterHint : public SfxHint
161{
162 FmFilterData* m_pData;
163
164public:
165 explicit FmFilterHint(FmFilterData* pData):m_pData(pData){}
166 FmFilterData* GetData() const { return m_pData; }
167};
168
169class FmFilterInsertedHint : public FmFilterHint
170{
171 size_t m_nPos; // Position relative to the parent of the data
172
173public:
174 FmFilterInsertedHint(FmFilterData* pData, size_t nRelPos)
175 :FmFilterHint(pData)
176 ,m_nPos(nRelPos){}
177
178 size_t GetPos() const { return m_nPos; }
179};
180
181class FmFilterRemovedHint : public FmFilterHint
182{
183public:
184 explicit FmFilterRemovedHint(FmFilterData* pData)
185 :FmFilterHint(pData){}
186};
187
188
189class FmFilterTextChangedHint : public FmFilterHint
190{
191public:
192 explicit FmFilterTextChangedHint(FmFilterData* pData)
193 :FmFilterHint(pData){}
194};
195
196class FilterClearingHint : public SfxHint
197{
198public:
199 FilterClearingHint(){}
200};
201
202class FmFilterCurrentChangedHint : public SfxHint
203{
204public:
205 FmFilterCurrentChangedHint(){}
206};
207
208}
209
210// class FmFilterAdapter, listener at the FilterControls
211class FmFilterAdapter : public ::cppu::WeakImplHelper< XFilterControllerListener >
212{
213 FmFilterModel* m_pModel;
214 Reference< XIndexAccess > m_xControllers;
215
216public:
217 FmFilterAdapter(FmFilterModel* pModel, const Reference< XIndexAccess >& xControllers);
218
219// XEventListener
220 virtual void SAL_CALL disposing(const EventObject& Source) override;
221
222// XFilterControllerListener
223 virtual void SAL_CALL predicateExpressionChanged( const FilterEvent& Event ) override;
224 virtual void SAL_CALL disjunctiveTermRemoved( const FilterEvent& Event ) override;
225 virtual void SAL_CALL disjunctiveTermAdded( const FilterEvent& Event ) override;
226
227// helpers
228 /// @throws RuntimeException
229 void dispose();
230
231 void AddOrRemoveListener( const Reference< XIndexAccess >& _rxControllers, const bool _bAdd );
232
233 static void setText(sal_Int32 nPos,
234 const FmFilterItem* pFilterItem,
235 const OUString& rText);
236};
237
238
239FmFilterAdapter::FmFilterAdapter(FmFilterModel* pModel, const Reference< XIndexAccess >& xControllers)
240 :m_pModel( pModel )
241 ,m_xControllers( xControllers )
242{
243 AddOrRemoveListener( m_xControllers, true );
244}
245
246
247void FmFilterAdapter::dispose()
248{
249 AddOrRemoveListener( m_xControllers, false );
250}
251
252
253void FmFilterAdapter::AddOrRemoveListener( const Reference< XIndexAccess >& _rxControllers, const bool _bAdd )
254{
255 for (sal_Int32 i = 0, nLen = _rxControllers->getCount(); i < nLen; ++i)
256 {
257 Reference< XIndexAccess > xElement( _rxControllers->getByIndex(i), UNO_QUERY );
258
259 // step down
260 AddOrRemoveListener( xElement, _bAdd );
261
262 // handle this particular controller
263 Reference< XFilterController > xController( xElement, UNO_QUERY );
264 OSL_ENSURE( xController.is(), "FmFilterAdapter::InsertElements: no XFilterController, cannot sync data!" )do { if (true && (!(xController.is()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "264" ": "), "%s", "FmFilterAdapter::InsertElements: no XFilterController, cannot sync data!"
); } } while (false)
;
265 if ( xController.is() )
266 {
267 if ( _bAdd )
268 xController->addFilterControllerListener( this );
269 else
270 xController->removeFilterControllerListener( this );
271 }
272 }
273}
274
275
276void FmFilterAdapter::setText(sal_Int32 nRowPos,
277 const FmFilterItem* pFilterItem,
278 const OUString& rText)
279{
280 FmFormItem* pFormItem = dynamic_cast<FmFormItem*>( pFilterItem->GetParent()->GetParent() );
281 assert(pFormItem)(static_cast <bool> (pFormItem) ? void (0) : __assert_fail
("pFormItem", "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
, 281, __extension__ __PRETTY_FUNCTION__))
;
282 try
283 {
284 Reference< XFilterController > xController( pFormItem->GetController(), UNO_QUERY_THROW );
285 xController->setPredicateExpression( pFilterItem->GetComponentIndex(), nRowPos, rText );
286 }
287 catch( const Exception& )
288 {
289 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "289" ": ", "svx" );
;
290 }
291}
292
293
294// XEventListener
295
296void SAL_CALL FmFilterAdapter::disposing(const EventObject& /*e*/)
297{
298}
299
300
301namespace
302{
303 OUString lcl_getLabelName_nothrow( const Reference< XControl >& _rxControl )
304 {
305 OUString sLabelName;
306 try
307 {
308 Reference< XPropertySet > xModel( _rxControl->getModel(), UNO_QUERY_THROW );
309 sLabelName = getLabelName( xModel );
310 }
311 catch( const Exception& )
312 {
313 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "313" ": ", "svx" );
;
314 }
315 return sLabelName;
316 }
317
318 Reference< XPropertySet > lcl_getBoundField_nothrow( const Reference< XControl >& _rxControl )
319 {
320 Reference< XPropertySet > xField;
321 try
322 {
323 Reference< XPropertySet > xModelProps( _rxControl->getModel(), UNO_QUERY_THROW );
324 xField.set( xModelProps->getPropertyValue( FM_PROP_BOUNDFIELD"BoundField" ), UNO_QUERY_THROW );
325 }
326 catch( const Exception& )
327 {
328 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "328" ": ", "svx" );
;
329 }
330 return xField;
331 }
332}
333
334// XFilterControllerListener
335void FmFilterAdapter::predicateExpressionChanged( const FilterEvent& Event )
336{
337 SolarMutexGuard aGuard;
338
339 if ( !m_pModel )
340 return;
341
342 // the controller which sent the event
343 Reference< XFormController > xController( Event.Source, UNO_QUERY_THROW );
344 Reference< XFilterController > xFilterController( Event.Source, UNO_QUERY_THROW );
345 Reference< XForm > xForm( xController->getModel(), UNO_QUERY_THROW );
346
347 FmFormItem* pFormItem = m_pModel->Find( m_pModel->m_aChildren, xForm );
348 OSL_ENSURE( pFormItem, "FmFilterAdapter::predicateExpressionChanged: don't know this form!" )do { if (true && (!(pFormItem))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "348" ": "), "%s", "FmFilterAdapter::predicateExpressionChanged: don't know this form!"
); } } while (false)
;
349 if ( !pFormItem )
350 return;
351
352 const sal_Int32 nActiveTerm( xFilterController->getActiveTerm() );
353
354 FmFilterData* pData = pFormItem->GetChildren()[nActiveTerm].get();
355 FmFilterItems& rFilter = dynamic_cast<FmFilterItems&>(*pData);
356 FmFilterItem* pFilterItem = rFilter.Find( Event.FilterComponent );
357 if ( pFilterItem )
358 {
359 if ( !Event.PredicateExpression.isEmpty())
360 {
361 pFilterItem->SetText( Event.PredicateExpression );
362 // notify the UI
363 FmFilterTextChangedHint aChangeHint(pFilterItem);
364 m_pModel->Broadcast( aChangeHint );
365 }
366 else
367 {
368 // no text anymore so remove the condition
369 m_pModel->Remove(pFilterItem);
370 }
371 }
372 else
373 {
374 // searching the component by field name
375 OUString aFieldName( lcl_getLabelName_nothrow( xFilterController->getFilterComponent( Event.FilterComponent ) ) );
376
377 std::unique_ptr<FmFilterItem> pNewFilterItem(new FmFilterItem(&rFilter, aFieldName, Event.PredicateExpression, Event.FilterComponent));
378 m_pModel->Insert(rFilter.GetChildren().end(), std::move(pNewFilterItem));
379 }
380
381 // ensure there's one empty term in the filter, just in case the active term was previously empty
382 m_pModel->EnsureEmptyFilterRows( *pFormItem );
383}
384
385
386void SAL_CALL FmFilterAdapter::disjunctiveTermRemoved( const FilterEvent& Event )
387{
388 SolarMutexGuard aGuard;
389
390 Reference< XFormController > xController( Event.Source, UNO_QUERY_THROW );
391 Reference< XFilterController > xFilterController( Event.Source, UNO_QUERY_THROW );
392 Reference< XForm > xForm( xController->getModel(), UNO_QUERY_THROW );
393
394 FmFormItem* pFormItem = m_pModel->Find( m_pModel->m_aChildren, xForm );
395 OSL_ENSURE( pFormItem, "FmFilterAdapter::disjunctiveTermRemoved: don't know this form!" )do { if (true && (!(pFormItem))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "395" ": "), "%s", "FmFilterAdapter::disjunctiveTermRemoved: don't know this form!"
); } } while (false)
;
396 if ( !pFormItem )
397 return;
398
399 auto& rTermItems = pFormItem->GetChildren();
400 const bool bValidIndex = ( Event.DisjunctiveTerm >= 0 ) && ( o3tl::make_unsigned(Event.DisjunctiveTerm) < rTermItems.size() );
401 OSL_ENSURE( bValidIndex, "FmFilterAdapter::disjunctiveTermRemoved: invalid term index!" )do { if (true && (!(bValidIndex))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "401" ": "), "%s", "FmFilterAdapter::disjunctiveTermRemoved: invalid term index!"
); } } while (false)
;
402 if ( !bValidIndex )
403 return;
404
405 // if the first term was removed, then the to-be first term needs its text updated
406 if ( Event.DisjunctiveTerm == 0 )
407 {
408 rTermItems[1]->SetText( SvxResId(RID_STR_FILTER_FILTER_FORreinterpret_cast<char const *>("RID_STR_FILTER_FILTER_FOR"
"\004" u8"Filter for")
));
409 FmFilterTextChangedHint aChangeHint( rTermItems[1].get() );
410 m_pModel->Broadcast( aChangeHint );
411 }
412
413 // finally remove the entry from the model
414 m_pModel->Remove( rTermItems.begin() + Event.DisjunctiveTerm );
415
416 // ensure there's one empty term in the filter, just in case the currently removed one was the last empty one
417 m_pModel->EnsureEmptyFilterRows( *pFormItem );
418}
419
420
421void SAL_CALL FmFilterAdapter::disjunctiveTermAdded( const FilterEvent& Event )
422{
423 SolarMutexGuard aGuard;
424
425 Reference< XFormController > xController( Event.Source, UNO_QUERY_THROW );
426 Reference< XFilterController > xFilterController( Event.Source, UNO_QUERY_THROW );
427 Reference< XForm > xForm( xController->getModel(), UNO_QUERY_THROW );
428
429 FmFormItem* pFormItem = m_pModel->Find( m_pModel->m_aChildren, xForm );
430 OSL_ENSURE( pFormItem, "FmFilterAdapter::disjunctiveTermAdded: don't know this form!" )do { if (true && (!(pFormItem))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "430" ": "), "%s", "FmFilterAdapter::disjunctiveTermAdded: don't know this form!"
); } } while (false)
;
431 if ( !pFormItem )
432 return;
433
434 const sal_Int32 nInsertPos = Event.DisjunctiveTerm;
435 bool bValidIndex = ( nInsertPos >= 0 ) && ( o3tl::make_unsigned(nInsertPos) <= pFormItem->GetChildren().size() );
436 if ( !bValidIndex )
437 {
438 OSL_FAIL( "FmFilterAdapter::disjunctiveTermAdded: invalid index!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "438" ": "), "%s", "FmFilterAdapter::disjunctiveTermAdded: invalid index!"
); } } while (false)
;
439 return;
440 }
441
442 auto insertPos = pFormItem->GetChildren().begin() + nInsertPos;
443
444 // "Filter for" for first position, "Or" for the other positions
445 std::unique_ptr<FmFilterItems> pFilterItems(new FmFilterItems(pFormItem, (nInsertPos?SvxResId(RID_STR_FILTER_FILTER_ORreinterpret_cast<char const *>("RID_STR_FILTER_FILTER_OR"
"\004" u8"Or")
):SvxResId(RID_STR_FILTER_FILTER_FORreinterpret_cast<char const *>("RID_STR_FILTER_FILTER_FOR"
"\004" u8"Filter for")
))));
446 m_pModel->Insert( insertPos, std::move(pFilterItems) );
447}
448
449
450FmFilterModel::FmFilterModel()
451 :FmParentData(nullptr, OUString())
452 ,OSQLParserClient(comphelper::getProcessComponentContext())
453 ,m_pCurrentItems(nullptr)
454{
455}
456
457
458FmFilterModel::~FmFilterModel()
459{
460 Clear();
461}
462
463
464void FmFilterModel::Clear()
465{
466 // notify
467 FilterClearingHint aClearedHint;
468 Broadcast( aClearedHint );
469
470 // lose endings
471 if (m_pAdapter.is())
472 {
473 m_pAdapter->dispose();
474 m_pAdapter.clear();
475 }
476
477 m_pCurrentItems = nullptr;
478 m_xController = nullptr;
479 m_xControllers = nullptr;
480
481 m_aChildren.clear();
482}
483
484
485void FmFilterModel::Update(const Reference< XIndexAccess > & xControllers, const Reference< XFormController > & xCurrent)
486{
487 if ( xCurrent == m_xController )
488 return;
489
490 if (!xControllers.is())
491 {
492 Clear();
493 return;
494 }
495
496 // there is only a new current controller
497 if ( m_xControllers != xControllers )
498 {
499 Clear();
500
501 m_xControllers = xControllers;
502 Update(m_xControllers, this);
503
504 DBG_ASSERT(xCurrent.is(), "FmFilterModel::Update(...) no current controller")do { if (true && (!(xCurrent.is()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "504" ": "), "%s", "FmFilterModel::Update(...) no current controller"
); } } while (false)
;
505
506 // Listening for TextChanges
507 m_pAdapter = new FmFilterAdapter(this, xControllers);
508
509 SetCurrentController(xCurrent);
510 EnsureEmptyFilterRows( *this );
511 }
512 else
513 SetCurrentController(xCurrent);
514}
515
516
517void FmFilterModel::Update(const Reference< XIndexAccess > & xControllers, FmParentData* pParent)
518{
519 try
520 {
521 sal_Int32 nCount = xControllers->getCount();
522 for ( sal_Int32 i = 0; i < nCount; ++i )
523 {
524 Reference< XFormController > xController( xControllers->getByIndex(i), UNO_QUERY_THROW );
525
526 Reference< XPropertySet > xFormProperties( xController->getModel(), UNO_QUERY_THROW );
527 OUString aName;
528 OSL_VERIFY( xFormProperties->getPropertyValue( FM_PROP_NAME ) >>= aName )do { if (!(xFormProperties->getPropertyValue( "Name" ) >>=
aName)) do { if (true && (!(0))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "528" ": "), "OSL_ASSERT: %s", "0"); } } while (false); }
while (0)
;
529
530 // Insert a new item for the form
531 FmFormItem* pFormItem = new FmFormItem( pParent, xController, aName );
532 Insert( pParent->GetChildren().end(), std::unique_ptr<FmFilterData>(pFormItem) );
533
534 Reference< XFilterController > xFilterController( pFormItem->GetFilterController(), UNO_SET_THROW );
535
536 // insert the existing filters for the form
537 OUString aTitle(SvxResId(RID_STR_FILTER_FILTER_FORreinterpret_cast<char const *>("RID_STR_FILTER_FILTER_FOR"
"\004" u8"Filter for")
));
538
539 const Sequence< Sequence< OUString > > aExpressions = xFilterController->getPredicateExpressions();
540 for ( auto const & conjunctionTerm : aExpressions )
541 {
542 // we always display one row, even if there's no term to be displayed
543 FmFilterItems* pFilterItems = new FmFilterItems( pFormItem, aTitle );
544 Insert( pFormItem->GetChildren().end(), std::unique_ptr<FmFilterData>(pFilterItems) );
545
546 const Sequence< OUString >& rDisjunction( conjunctionTerm );
547 sal_Int32 nComponentIndex = -1;
548 for ( const OUString& rDisjunctiveTerm : rDisjunction )
549 {
550 ++nComponentIndex;
551
552 if ( rDisjunctiveTerm.isEmpty() )
553 // no condition for this particular component in this particular conjunction term
554 continue;
555
556 // determine the display name of the control
557 const Reference< XControl > xFilterControl( xFilterController->getFilterComponent( nComponentIndex ) );
558 const OUString sDisplayName( lcl_getLabelName_nothrow( xFilterControl ) );
559
560 // insert a new entry
561 std::unique_ptr<FmFilterItem> pANDCondition(new FmFilterItem( pFilterItems, sDisplayName, rDisjunctiveTerm, nComponentIndex ));
562 Insert( pFilterItems->GetChildren().end(), std::move(pANDCondition) );
563 }
564
565 // title for the next conditions
566 aTitle = SvxResId( RID_STR_FILTER_FILTER_ORreinterpret_cast<char const *>("RID_STR_FILTER_FILTER_OR"
"\004" u8"Or")
);
567 }
568
569 // now add dependent controllers
570 Update( xController, pFormItem );
571 }
572 }
573 catch( const Exception& )
574 {
575 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "575" ": ", "svx" );
;
576 }
577}
578
579
580FmFormItem* FmFilterModel::Find(const ::std::vector<std::unique_ptr<FmFilterData>>& rItems, const Reference< XFormController > & xController) const
581{
582 for (const auto& rItem : rItems)
583 {
584 FmFormItem* pForm = dynamic_cast<FmFormItem*>( rItem.get() );
585 if (pForm)
586 {
587 if ( xController == pForm->GetController() )
588 return pForm;
589 else
590 {
591 pForm = Find(pForm->GetChildren(), xController);
592 if (pForm)
593 return pForm;
594 }
595 }
596 }
597 return nullptr;
598}
599
600
601FmFormItem* FmFilterModel::Find(const ::std::vector<std::unique_ptr<FmFilterData>>& rItems, const Reference< XForm >& xForm) const
602{
603 for (const auto& rItem : rItems)
604 {
605 FmFormItem* pForm = dynamic_cast<FmFormItem*>( rItem.get() );
606 if (pForm)
607 {
608 if (xForm == pForm->GetController()->getModel())
609 return pForm;
610 else
611 {
612 pForm = Find(pForm->GetChildren(), xForm);
613 if (pForm)
614 return pForm;
615 }
616 }
617 }
618 return nullptr;
619}
620
621void FmFilterModel::SetCurrentController(const Reference< XFormController > & xCurrent)
622{
623 if ( xCurrent == m_xController )
624 return;
625
626 m_xController = xCurrent;
627
628 FmFormItem* pItem = Find( m_aChildren, xCurrent );
629 if ( !pItem )
630 return;
631
632 try
633 {
634 Reference< XFilterController > xFilterController( m_xController, UNO_QUERY_THROW );
635 const sal_Int32 nActiveTerm( xFilterController->getActiveTerm() );
636 if (nActiveTerm != -1 && pItem->GetChildren().size() > o3tl::make_unsigned(nActiveTerm))
637 {
638 SetCurrentItems( static_cast< FmFilterItems* >( pItem->GetChildren()[ nActiveTerm ].get() ) );
639 }
640 }
641 catch( const Exception& )
642 {
643 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "643" ": ", "svx" );
;
644 }
645}
646
647void FmFilterModel::AppendFilterItems( FmFormItem& _rFormItem )
648{
649 // insert the condition behind the last filter items
650 auto iter = std::find_if(_rFormItem.GetChildren().rbegin(), _rFormItem.GetChildren().rend(),
651 [](const std::unique_ptr<FmFilterData>& rChild) { return dynamic_cast<const FmFilterItems*>(rChild.get()) != nullptr; });
652
653 sal_Int32 nInsertPos = iter.base() - _rFormItem.GetChildren().begin();
654 // delegate this to the FilterController, it will notify us, which will let us update our model
655 try
656 {
657 Reference< XFilterController > xFilterController( _rFormItem.GetFilterController(), UNO_SET_THROW );
658 if ( nInsertPos >= xFilterController->getDisjunctiveTerms() )
659 xFilterController->appendEmptyDisjunctiveTerm();
660 }
661 catch( const Exception& )
662 {
663 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "663" ": ", "svx" );
;
664 }
665}
666
667void FmFilterModel::Insert(const ::std::vector<std::unique_ptr<FmFilterData>>::iterator& rPos, std::unique_ptr<FmFilterData> pData)
668{
669 auto pTemp = pData.get();
670 size_t nPos;
671 ::std::vector<std::unique_ptr<FmFilterData>>& rItems = pData->GetParent()->GetChildren();
672 if (rPos == rItems.end())
673 {
674 nPos = rItems.size();
675 rItems.push_back(std::move(pData));
676 }
677 else
678 {
679 nPos = rPos - rItems.begin();
680 rItems.insert(rPos, std::move(pData));
681 }
682
683 // notify the UI
684 FmFilterInsertedHint aInsertedHint(pTemp, nPos);
685 Broadcast( aInsertedHint );
686}
687
688void FmFilterModel::Remove(FmFilterData* pData)
689{
690 FmParentData* pParent = pData->GetParent();
691 ::std::vector<std::unique_ptr<FmFilterData>>& rItems = pParent->GetChildren();
692
693 // erase the item from the model
694 auto i = ::std::find_if(rItems.begin(), rItems.end(),
695 [&](const std::unique_ptr<FmFilterData>& p) { return p.get() == pData; } );
696 DBG_ASSERT(i != rItems.end(), "FmFilterModel::Remove(): unknown Item")do { if (true && (!(i != rItems.end()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "696" ": "), "%s", "FmFilterModel::Remove(): unknown Item"
); } } while (false)
;
697 // position within the parent
698 sal_Int32 nPos = i - rItems.begin();
699 if (dynamic_cast<const FmFilterItems*>( pData) != nullptr)
700 {
701 FmFormItem* pFormItem = static_cast<FmFormItem*>(pParent);
702
703 try
704 {
705 Reference< XFilterController > xFilterController( pFormItem->GetFilterController(), UNO_SET_THROW );
706
707 bool bEmptyLastTerm = ( ( nPos == 0 ) && xFilterController->getDisjunctiveTerms() == 1 );
708 if ( bEmptyLastTerm )
709 {
710 // remove all children (by setting an empty predicate expression)
711 ::std::vector< std::unique_ptr<FmFilterData> >& rChildren = static_cast<FmFilterItems*>(pData)->GetChildren();
712 while ( !rChildren.empty() )
713 {
714 auto removePos = rChildren.end() - 1;
715 if (FmFilterItem* pFilterItem = dynamic_cast<FmFilterItem*>( removePos->get() ))
716 {
717 FmFilterAdapter::setText( nPos, pFilterItem, OUString() );
718 }
719 Remove( removePos );
720 }
721 }
722 else
723 {
724 xFilterController->removeDisjunctiveTerm( nPos );
725 }
726 }
727 catch( const Exception& )
728 {
729 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "729" ": ", "svx" );
;
730 }
731 }
732 else // FormItems can not be deleted
733 {
734 FmFilterItem& rFilterItem = dynamic_cast<FmFilterItem&>(*pData);
735
736 // if it's the last condition remove the parent
737 if (rItems.size() == 1)
738 Remove(rFilterItem.GetParent());
739 else
740 {
741 // find the position of the father within his father
742 ::std::vector<std::unique_ptr<FmFilterData>>& rParentParentItems = pData->GetParent()->GetParent()->GetChildren();
743 auto j = ::std::find_if(rParentParentItems.begin(), rParentParentItems.end(),
744 [&](const std::unique_ptr<FmFilterData>& p) { return p.get() == rFilterItem.GetParent(); });
745 DBG_ASSERT(j != rParentParentItems.end(), "FmFilterModel::Remove(): unknown Item")do { if (true && (!(j != rParentParentItems.end()))) {
sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "745" ": "), "%s", "FmFilterModel::Remove(): unknown Item"
); } } while (false)
;
746 sal_Int32 nParentPos = j - rParentParentItems.begin();
747
748 // EmptyText removes the filter
749 FmFilterAdapter::setText(nParentPos, &rFilterItem, OUString());
750 Remove( i );
751 }
752 }
753}
754
755void FmFilterModel::Remove( const ::std::vector<std::unique_ptr<FmFilterData>>::iterator& rPos )
756{
757 // remove from parent's child list
758 std::unique_ptr<FmFilterData> pData = std::move(*rPos);
759 pData->GetParent()->GetChildren().erase( rPos );
760
761 // notify the view, this will remove the actual SvTreeListEntry
762 FmFilterRemovedHint aRemoveHint( pData.get() );
763 Broadcast( aRemoveHint );
764}
765
766
767bool FmFilterModel::ValidateText(FmFilterItem const * pItem, OUString& rText, OUString& rErrorMsg) const
768{
769 FmFormItem* pFormItem = dynamic_cast<FmFormItem*>( pItem->GetParent()->GetParent() );
770 assert(pFormItem)(static_cast <bool> (pFormItem) ? void (0) : __assert_fail
("pFormItem", "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
, 770, __extension__ __PRETTY_FUNCTION__))
;
771 try
772 {
773 Reference< XFormController > xFormController( pFormItem->GetController() );
774 // obtain the connection of the form belonging to the controller
775 Reference< XRowSet > xRowSet( xFormController->getModel(), UNO_QUERY_THROW );
776 Reference< XConnection > xConnection( getConnection( xRowSet ) );
777
778 // obtain a number formatter for this connection
779 // TODO: shouldn't this be cached?
780 Reference< XNumberFormatsSupplier > xFormatSupplier = getNumberFormats( xConnection, true );
781 Reference< XNumberFormatter > xFormatter( NumberFormatter::create( comphelper::getProcessComponentContext() ), UNO_QUERY_THROW );
782 xFormatter->attachNumberFormatsSupplier( xFormatSupplier );
783
784 // get the field (database column) which the item is responsible for
785 Reference< XFilterController > xFilterController( xFormController, UNO_QUERY_THROW );
786 Reference< XPropertySet > xField( lcl_getBoundField_nothrow( xFilterController->getFilterComponent( pItem->GetComponentIndex() ) ), UNO_SET_THROW );
787
788 // parse the given text as filter predicate
789 OUString aErr, aTxt( rText );
790 std::unique_ptr< OSQLParseNode > pParseNode = predicateTree( aErr, aTxt, xFormatter, xField );
791 rErrorMsg = aErr;
792 rText = aTxt;
793 if ( pParseNode != nullptr )
794 {
795 OUString aPreparedText;
796 Locale aAppLocale = Application::GetSettings().GetUILanguageTag().getLocale();
797 pParseNode->parseNodeToPredicateStr(
798 aPreparedText, xConnection, xFormatter, xField, OUString(), aAppLocale, OUString("."), getParseContext() );
799 rText = aPreparedText;
800 return true;
801 }
802 }
803 catch( const Exception& )
804 {
805 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "805" ": ", "svx" );
;
806 }
807
808 return false;
809}
810
811
812void FmFilterModel::Append(FmFilterItems* pItems, std::unique_ptr<FmFilterItem> pFilterItem)
813{
814 Insert(pItems->GetChildren().end(), std::move(pFilterItem));
815}
816
817
818void FmFilterModel::SetTextForItem(FmFilterItem* pItem, const OUString& rText)
819{
820 ::std::vector<std::unique_ptr<FmFilterData>>& rItems = pItem->GetParent()->GetParent()->GetChildren();
821 auto i = ::std::find_if(rItems.begin(), rItems.end(),
822 [&](const std::unique_ptr<FmFilterData>& p) { return p.get() == pItem->GetParent(); });
823 sal_Int32 nParentPos = i - rItems.begin();
824
825 FmFilterAdapter::setText(nParentPos, pItem, rText);
826
827 if (rText.isEmpty())
828 Remove(pItem);
829 else
830 {
831 // Change the text
832 pItem->SetText(rText);
833 FmFilterTextChangedHint aChangeHint(pItem);
834 Broadcast( aChangeHint );
835 }
836}
837
838
839void FmFilterModel::SetCurrentItems(FmFilterItems* pCurrent)
840{
841 if (m_pCurrentItems == pCurrent)
842 return;
843
844 // search for the condition
845 if (pCurrent)
846 {
847 FmFormItem* pFormItem = static_cast<FmFormItem*>(pCurrent->GetParent());
848 ::std::vector<std::unique_ptr<FmFilterData>>& rItems = pFormItem->GetChildren();
849 auto i = ::std::find_if(rItems.begin(), rItems.end(),
850 [&](const std::unique_ptr<FmFilterData>& p) { return p.get() == pCurrent; });
851
852 if (i != rItems.end())
853 {
854 // determine the filter position
855 sal_Int32 nPos = i - rItems.begin();
856 try
857 {
858 Reference< XFilterController > xFilterController( pFormItem->GetFilterController(), UNO_SET_THROW );
859 xFilterController->setActiveTerm( nPos );
860 }
861 catch( const Exception& )
862 {
863 DBG_UNHANDLED_EXCEPTION("svx")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "863" ": ", "svx" );
;
864 }
865
866 if ( m_xController != pFormItem->GetController() )
867 // calls SetCurrentItems again
868 SetCurrentController( pFormItem->GetController() );
869 else
870 m_pCurrentItems = pCurrent;
871 }
872 else
873 m_pCurrentItems = nullptr;
874 }
875 else
876 m_pCurrentItems = nullptr;
877
878
879 // notify the UI
880 FmFilterCurrentChangedHint aHint;
881 Broadcast( aHint );
882}
883
884
885void FmFilterModel::EnsureEmptyFilterRows( FmParentData& _rItem )
886{
887 // checks whether for each form there's one free level for input
888 ::std::vector< std::unique_ptr<FmFilterData> >& rChildren = _rItem.GetChildren();
889 bool bAppendLevel = dynamic_cast<const FmFormItem*>(&_rItem) != nullptr;
890
891 for ( const auto& rpChild : rChildren )
892 {
893 FmFilterItems* pItems = dynamic_cast<FmFilterItems*>( rpChild.get() );
894 if ( pItems && pItems->GetChildren().empty() )
895 {
896 bAppendLevel = false;
897 break;
898 }
899
900 FmFormItem* pFormItem = dynamic_cast<FmFormItem*>( rpChild.get() );
901 if (pFormItem)
902 {
903 EnsureEmptyFilterRows( *pFormItem );
904 continue;
905 }
906 }
907
908 if ( bAppendLevel )
909 {
910 FmFormItem* pFormItem = dynamic_cast<FmFormItem*>( &_rItem );
911 OSL_ENSURE( pFormItem, "FmFilterModel::EnsureEmptyFilterRows: no FmFormItem, but a FmFilterItems child?" )do { if (true && (!(pFormItem))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "911" ": "), "%s", "FmFilterModel::EnsureEmptyFilterRows: no FmFormItem, but a FmFilterItems child?"
); } } while (false)
;
912 if ( pFormItem )
913 AppendFilterItems( *pFormItem );
914 }
915}
916
917const int nxD = 4;
918const int nxDBmp = 12;
919
920IMPL_STATIC_LINK(FmFilterNavigator, CustomGetSizeHdl, weld::TreeView::get_size_args, aPayload, Size)Size FmFilterNavigator::LinkStubCustomGetSizeHdl(void * instance
, weld::TreeView::get_size_args data) { return CustomGetSizeHdl
(static_cast<FmFilterNavigator *>(instance), data); } Size
FmFilterNavigator::CustomGetSizeHdl(__attribute__ ((unused))
FmFilterNavigator *, weld::TreeView::get_size_args aPayload)
921{
922 vcl::RenderContext& rRenderContext = aPayload.first;
923 const OUString& rId = aPayload.second;
924
925 Size aSize;
926
927 FmFilterData* pData = reinterpret_cast<FmFilterData*>(rId.toUInt64());
928 OUString sText = pData->GetText();
929
930 if (FmFilterItem* pItem = dynamic_cast<FmFilterItem*>(pData))
931 {
932 rRenderContext.Push(PushFlags::FONT);
933 vcl::Font aFont(rRenderContext.GetFont());
934 aFont.SetWeight(WEIGHT_BOLD);
935 rRenderContext.SetFont(aFont);
936
937 OUString sName = pItem->GetFieldName() + ": ";
938 aSize = Size(rRenderContext.GetTextWidth(sName), rRenderContext.GetTextHeight());
939
940 rRenderContext.Pop();
941
942 aSize.AdjustWidth(rRenderContext.GetTextWidth(sText) + nxD);
943 }
944 else
945 {
946 aSize = Size(rRenderContext.GetTextWidth(sText), rRenderContext.GetTextHeight());
947 if (dynamic_cast<FmFilterItems*>(pData))
948 aSize.AdjustWidth(nxDBmp);
949 }
950
951 return aSize;
952}
953
954IMPL_STATIC_LINK(FmFilterNavigator, CustomRenderHdl, weld::TreeView::render_args, aPayload, void)void FmFilterNavigator::LinkStubCustomRenderHdl(void * instance
, weld::TreeView::render_args data) { return CustomRenderHdl(
static_cast<FmFilterNavigator *>(instance), data); } void
FmFilterNavigator::CustomRenderHdl(__attribute__ ((unused)) FmFilterNavigator
*, weld::TreeView::render_args aPayload)
955{
956 vcl::RenderContext& rRenderContext = std::get<0>(aPayload);
957 const ::tools::Rectangle& rRect = std::get<1>(aPayload);
958 ::tools::Rectangle aRect(rRect.TopLeft(), Size(rRenderContext.GetOutputSize().Width() - rRect.Left(), rRect.GetHeight()));
959 bool bSelected = std::get<2>(aPayload);
960 const OUString& rId = std::get<3>(aPayload);
961
962 rRenderContext.Push(PushFlags::TEXTCOLOR);
963 const StyleSettings& rStyleSettings = Application::GetSettings().GetStyleSettings();
964 if (bSelected)
965 rRenderContext.SetTextColor(rStyleSettings.GetHighlightTextColor());
966 else
967 rRenderContext.SetTextColor(rStyleSettings.GetDialogTextColor());
968
969 FmFilterData* pData = reinterpret_cast<FmFilterData*>(rId.toUInt64());
970 OUString sText = pData->GetText();
971 Point aPos(aRect.TopLeft());
972
973 if (FmFilterItem* pFilter = dynamic_cast<FmFilterItem*>(pData))
974 {
975 vcl::Font aFont(rRenderContext.GetFont());
976 aFont.SetWeight(WEIGHT_BOLD);
977
978 rRenderContext.Push(PushFlags::FONT);
979 rRenderContext.SetFont(aFont);
980
981 OUString sName = pFilter->GetFieldName() + ": ";
982 rRenderContext.DrawText(aPos, sName);
983
984 // position for the second text
985 aPos.AdjustX(rRenderContext.GetTextWidth(sName) + nxD);
986 rRenderContext.Pop();
987
988 rRenderContext.DrawText(aPos, sText);
989 }
990 else if (FmFilterItems* pRow = dynamic_cast<FmFilterItems*>(pData))
991 {
992 FmFormItem* pForm = static_cast<FmFormItem*>(pRow->GetParent());
993
994 // current filter is significant painted
995 const bool bIsCurrentFilter = pForm->GetChildren()[ pForm->GetFilterController()->getActiveTerm() ].get() == pRow;
996 if (bIsCurrentFilter)
997 {
998 rRenderContext.Push(PushFlags::LINECOLOR);
999 rRenderContext.SetLineColor(rRenderContext.GetTextColor());
1000
1001 Point aFirst(aPos.X(), aRect.Bottom() - 6);
1002 Point aSecond(aFirst .X() + 2, aFirst.Y() + 3);
1003
1004 rRenderContext.DrawLine(aFirst, aSecond);
1005
1006 aFirst = aSecond;
1007 aFirst.AdjustX(1);
1008 aSecond.AdjustX(6);
1009 aSecond.AdjustY(-5);
1010
1011 rRenderContext.DrawLine(aFirst, aSecond);
1012 rRenderContext.Pop();
1013 }
1014
1015 rRenderContext.DrawText(Point(aPos.X() + nxDBmp, aPos.Y()), sText);
1016 }
1017 else
1018 rRenderContext.DrawText(aPos, sText);
1019
1020 rRenderContext.Pop();
1021}
1022
1023FmFilterNavigatorDropTarget::FmFilterNavigatorDropTarget(FmFilterNavigator& rTreeView)
1024 : DropTargetHelper(rTreeView.get_widget().get_drop_target())
1025 , m_rTreeView(rTreeView)
1026{
1027}
1028
1029sal_Int8 FmFilterNavigatorDropTarget::AcceptDrop(const AcceptDropEvent& rEvt)
1030{
1031 sal_Int8 nAccept = m_rTreeView.AcceptDrop(rEvt);
1032
1033 if (nAccept != DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE)
1034 {
1035 // to enable the autoscroll when we're close to the edges
1036 weld::TreeView& rWidget = m_rTreeView.get_widget();
1037 rWidget.get_dest_row_at_pos(rEvt.maPosPixel, nullptr, true);
1038 }
1039
1040 return nAccept;
1041}
1042
1043sal_Int8 FmFilterNavigatorDropTarget::ExecuteDrop(const ExecuteDropEvent& rEvt)
1044{
1045 return m_rTreeView.ExecuteDrop(rEvt);
1046}
1047
1048FmFilterNavigator::FmFilterNavigator(vcl::Window* pTopLevel, std::unique_ptr<weld::TreeView> xTreeView)
1049 : m_xTopLevel(pTopLevel)
1050 , m_xTreeView(std::move(xTreeView))
1051 , m_aDropTargetHelper(*this)
1052 , m_aControlExchange()
1053 , m_nAsyncRemoveEvent(nullptr)
1054{
1055 m_xTreeView->set_help_id(HID_FILTER_NAVIGATOR"SVX_HID_FILTER_NAVIGATOR");
1056
1057 m_xTreeView->set_selection_mode(SelectionMode::Multiple);
1058
1059 m_pModel.reset( new FmFilterModel() );
1060 StartListening( *m_pModel );
1061
1062 m_xTreeView->connect_custom_get_size(LINK(this, FmFilterNavigator, CustomGetSizeHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubCustomGetSizeHdl
)
);
1063 m_xTreeView->connect_custom_render(LINK(this, FmFilterNavigator, CustomRenderHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubCustomRenderHdl
)
);
1064 m_xTreeView->set_column_custom_renderer(0, true);
1065
1066 m_xTreeView->connect_changed(LINK(this, FmFilterNavigator, SelectHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubSelectHdl)
);
1067 m_xTreeView->connect_key_press(LINK(this, FmFilterNavigator, KeyInputHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubKeyInputHdl)
);
1068 m_xTreeView->connect_popup_menu(LINK(this, FmFilterNavigator, PopupMenuHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubPopupMenuHdl)
);
1069 m_xTreeView->connect_editing(LINK(this, FmFilterNavigator, EditingEntryHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubEditingEntryHdl
)
,
1070 LINK(this, FmFilterNavigator, EditedEntryHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubEditedEntryHdl)
);
1071 m_xTreeView->connect_drag_begin(LINK(this, FmFilterNavigator, DragBeginHdl)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubDragBeginHdl)
);
1072}
1073
1074FmFilterNavigator::~FmFilterNavigator()
1075{
1076 if (m_nAsyncRemoveEvent)
1077 Application::RemoveUserEvent(m_nAsyncRemoveEvent);
1078 EndListening(*m_pModel);
1079 m_pModel.reset();
1080}
1081
1082void FmFilterNavigator::UpdateContent(const Reference< XIndexAccess > & xControllers, const Reference< XFormController > & xCurrent)
1083{
1084 if (xCurrent == m_pModel->GetCurrentController())
1085 return;
1086
1087 m_pModel->Update(xControllers, xCurrent);
1088
1089 // expand the filters for the current controller
1090 std::unique_ptr<weld::TreeIter> xEntry = FindEntry(m_pModel->GetCurrentForm());
1091 if (!xEntry || m_xTreeView->get_row_expanded(*xEntry))
1092 return;
1093
1094 m_xTreeView->unselect_all();
1095
1096 m_xTreeView->expand_row(*xEntry);
1097
1098 xEntry = FindEntry(m_pModel->GetCurrentItems());
1099 if (xEntry)
1100 {
1101 if (!m_xTreeView->get_row_expanded(*xEntry))
1102 m_xTreeView->expand_row(*xEntry);
1103 m_xTreeView->select(*xEntry);
1104 SelectHdl(*m_xTreeView);
1105 }
1106}
1107
1108IMPL_LINK(FmFilterNavigator, EditingEntryHdl, const weld::TreeIter&, rIter, bool)bool FmFilterNavigator::LinkStubEditingEntryHdl(void * instance
, const weld::TreeIter& data) { return static_cast<FmFilterNavigator
*>(instance)->EditingEntryHdl(data); } bool FmFilterNavigator
::EditingEntryHdl(const weld::TreeIter& rIter)
1109{
1110 // returns true to allow editing
1111 if (dynamic_cast<const FmFilterItem*>(reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(rIter).toUInt64())))
1112 {
1113 m_xEditingCurrently = m_xTreeView->make_iterator(&rIter);
1114 return true;
1115 }
1116 m_xEditingCurrently.reset();
1117 return false;
1118}
1119
1120IMPL_LINK(FmFilterNavigator, EditedEntryHdl, const IterString&, rIterString, bool)bool FmFilterNavigator::LinkStubEditedEntryHdl(void * instance
, const IterString& data) { return static_cast<FmFilterNavigator
*>(instance)->EditedEntryHdl(data); } bool FmFilterNavigator
::EditedEntryHdl(const IterString& rIterString)
1121{
1122 const weld::TreeIter& rIter = rIterString.first;
1123 const OUString& rNewText = rIterString.second;
1124
1125 assert(m_xEditingCurrently && m_xTreeView->iter_compare(rIter, *m_xEditingCurrently) == 0 &&(static_cast <bool> (m_xEditingCurrently && m_xTreeView
->iter_compare(rIter, *m_xEditingCurrently) == 0 &&
"FmFilterNavigator::EditedEntry: suspicious entry!") ? void (
0) : __assert_fail ("m_xEditingCurrently && m_xTreeView->iter_compare(rIter, *m_xEditingCurrently) == 0 && \"FmFilterNavigator::EditedEntry: suspicious entry!\""
, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
, 1126, __extension__ __PRETTY_FUNCTION__))
1126 "FmFilterNavigator::EditedEntry: suspicious entry!")(static_cast <bool> (m_xEditingCurrently && m_xTreeView
->iter_compare(rIter, *m_xEditingCurrently) == 0 &&
"FmFilterNavigator::EditedEntry: suspicious entry!") ? void (
0) : __assert_fail ("m_xEditingCurrently && m_xTreeView->iter_compare(rIter, *m_xEditingCurrently) == 0 && \"FmFilterNavigator::EditedEntry: suspicious entry!\""
, "/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
, 1126, __extension__ __PRETTY_FUNCTION__))
;
1127 m_xEditingCurrently.reset();
1128
1129 FmFilterData* pData = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(rIter).toUInt64());
1130
1131 DBG_ASSERT(dynamic_cast<const FmFilterItem*>(pData) != nullptr,do { if (true && (!(dynamic_cast<const FmFilterItem
*>(pData) != nullptr))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "1132" ": "), "%s", "FmFilterNavigator::EditedEntry() wrong entry"
); } } while (false)
1132 "FmFilterNavigator::EditedEntry() wrong entry")do { if (true && (!(dynamic_cast<const FmFilterItem
*>(pData) != nullptr))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/svx/source/form/filtnav.cxx"
":" "1132" ": "), "%s", "FmFilterNavigator::EditedEntry() wrong entry"
); } } while (false)
;
1133
1134 OUString aText(comphelper::string::strip(rNewText, ' '));
1135 if (aText.isEmpty())
1136 {
1137 // deleting the entry asynchron
1138 m_nAsyncRemoveEvent = Application::PostUserEvent(LINK(this, FmFilterNavigator, OnRemove)::tools::detail::makeLink( ::tools::detail::castTo<FmFilterNavigator
*>(this), &FmFilterNavigator::LinkStubOnRemove)
, pData);
1139 }
1140 else
1141 {
1142 OUString aErrorMsg;
1143
1144 if (m_pModel->ValidateText(static_cast<FmFilterItem*>(pData), aText, aErrorMsg))
1145 {
1146 // this will set the text at the FmFilterItem, as well as update any filter controls
1147 // which are connected to this particular entry
1148 m_pModel->SetTextForItem(static_cast<FmFilterItem*>(pData), aText);
1149 m_xTreeView->set_text(rIter, aText);
1150 }
1151 else
1152 {
1153 // display the error and return sal_False
1154 SQLContext aError;
1155 aError.Message = SvxResId(RID_STR_SYNTAXERRORreinterpret_cast<char const *>("RID_STR_SYNTAXERROR" "\004"
u8"Syntax error in query expression")
);
1156 aError.Details = aErrorMsg;
1157 displayException(aError, m_xTopLevel);
1158
1159 return false;
1160 }
1161 }
1162 return true;
1163}
1164
1165IMPL_LINK( FmFilterNavigator, OnRemove, void*, p, void )void FmFilterNavigator::LinkStubOnRemove(void * instance, void
* data) { return static_cast<FmFilterNavigator *>(instance
)->OnRemove(data); } void FmFilterNavigator::OnRemove(void
* p)
1166{
1167 m_nAsyncRemoveEvent = nullptr;
1168 // now remove the entry
1169 m_pModel->Remove(static_cast<FmFilterData*>(p));
1170}
1171
1172sal_Int8 FmFilterNavigator::AcceptDrop( const AcceptDropEvent& rEvt )
1173{
1174 if (!m_aControlExchange.isDragSource())
1175 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1176
1177 if (!OFilterItemExchange::hasFormat(m_aDropTargetHelper.GetDataFlavorExVector()))
1178 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1179
1180 // do we contain the formitem?
1181 if (!FindEntry(m_aControlExchange->getFormItem()))
1182 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1183
1184 Point aDropPos = rEvt.maPosPixel;
1185 std::unique_ptr<weld::TreeIter> xDropTarget(m_xTreeView->make_iterator());
1186 // get_dest_row_at_pos with false cause we must drop exactly "on" a node to paste a condition into it
1187 if (!m_xTreeView->get_dest_row_at_pos(aDropPos, xDropTarget.get(), false))
1188 xDropTarget.reset();
1189
1190 if (!xDropTarget)
1191 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1192
1193 FmFilterData* pData = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(*xDropTarget).toUInt64());
1194 FmFormItem* pForm = nullptr;
1195 if (dynamic_cast<const FmFilterItem*>(pData) != nullptr)
1196 {
1197 pForm = dynamic_cast<FmFormItem*>( pData->GetParent()->GetParent() );
1198 if (pForm != m_aControlExchange->getFormItem())
1199 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1200 }
1201 else if (dynamic_cast<const FmFilterItems*>( pData) != nullptr)
1202 {
1203 pForm = dynamic_cast<FmFormItem*>( pData->GetParent() );
1204 if (pForm != m_aControlExchange->getFormItem())
1205 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1206 }
1207 else
1208 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1209
1210 return rEvt.mnAction;
1211}
1212
1213namespace
1214{
1215 FmFilterItems* getTargetItems(const weld::TreeView& rTreeView, const weld::TreeIter& rTarget)
1216 {
1217 FmFilterData* pData = reinterpret_cast<FmFilterData*>(rTreeView.get_id(rTarget).toUInt64());
1218 FmFilterItems* pTargetItems = dynamic_cast<FmFilterItems*>(pData);
1219 if (!pTargetItems)
1220 pTargetItems = dynamic_cast<FmFilterItems*>(pData->GetParent());
1221 return pTargetItems;
1222 }
1223}
1224
1225sal_Int8 FmFilterNavigator::ExecuteDrop( const ExecuteDropEvent& rEvt )
1226{
1227 if (!m_aControlExchange.isDragSource())
1228 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1229
1230 Point aDropPos = rEvt.maPosPixel;
1231 std::unique_ptr<weld::TreeIter> xDropTarget(m_xTreeView->make_iterator());
1232 // get_dest_row_at_pos with false cause we must drop exactly "on" a node to paste a condition into it
1233 if (!m_xTreeView->get_dest_row_at_pos(aDropPos, xDropTarget.get(), false))
1234 xDropTarget.reset();
1235 if (!xDropTarget)
1236 return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE;
1237
1238 // search the container where to add the items
1239 FmFilterItems* pTargetItems = getTargetItems(*m_xTreeView, *xDropTarget);
1240 m_xTreeView->unselect_all();
1241 std::unique_ptr<weld::TreeIter> xEntry = FindEntry(pTargetItems);
1242 m_xTreeView->select(*xEntry);
1243 m_xTreeView->set_cursor(*xEntry);
1244
1245 insertFilterItem(m_aControlExchange->getDraggedEntries(),pTargetItems,DND_ACTION_COPYcss::datatransfer::dnd::DNDConstants::ACTION_COPY == rEvt.mnAction);
1246
1247 return DND_ACTION_COPYcss::datatransfer::dnd::DNDConstants::ACTION_COPY;
1248}
1249
1250IMPL_LINK_NOARG(FmFilterNavigator, SelectHdl, weld::TreeView&, void)void FmFilterNavigator::LinkStubSelectHdl(void * instance, weld
::TreeView& data) { return static_cast<FmFilterNavigator
*>(instance)->SelectHdl(data); } void FmFilterNavigator
::SelectHdl(__attribute__ ((unused)) weld::TreeView&)
1251{
1252 std::unique_ptr<weld::TreeIter> xIter(m_xTreeView->make_iterator());
1253 if (!m_xTreeView->get_selected(xIter.get()))
1254 return;
1255
1256 FmFilterData* pData = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(*xIter).toUInt64());
1257
1258 FmFormItem* pFormItem = nullptr;
1259 if (FmFilterItem* pItem = dynamic_cast<FmFilterItem*>(pData))
1260 pFormItem = static_cast<FmFormItem*>(pItem->GetParent()->GetParent());
1261 else if (FmFilterItems* pItems = dynamic_cast<FmFilterItems*>(pData))
1262 pFormItem = static_cast<FmFormItem*>(pItems->GetParent()->GetParent());
1263 else
1264 pFormItem = dynamic_cast<FmFormItem*>(pData);
1265
1266 if (pFormItem)
1267 {
1268 // will the controller be exchanged?
1269 if (FmFilterItem* pItem = dynamic_cast<FmFilterItem*>(pData))
1270 m_pModel->SetCurrentItems(static_cast<FmFilterItems*>(pItem->GetParent()));
1271 else if (FmFilterItems* pItems = dynamic_cast<FmFilterItems*>(pData))
1272 m_pModel->SetCurrentItems(pItems);
1273 else
1274 m_pModel->SetCurrentController(pFormItem->GetController());
1275 }
1276}
1277
1278void FmFilterNavigator::Notify( SfxBroadcaster& /*rBC*/, const SfxHint& rHint )
1279{
1280 if (const FmFilterInsertedHint* pInsertHint = dynamic_cast<const FmFilterInsertedHint*>(&rHint))
1281 {
1282 Insert(pInsertHint->GetData(), pInsertHint->GetPos());
1283 }
1284 else if( dynamic_cast<const FilterClearingHint*>(&rHint) )
1285 {
1286 m_xTreeView->clear();
1287 }
1288 else if (const FmFilterRemovedHint* pRemoveHint = dynamic_cast<const FmFilterRemovedHint*>(&rHint))
1289 {
1290 Remove(pRemoveHint->GetData());
1291 }
1292 else if (const FmFilterTextChangedHint *pChangeHint = dynamic_cast<const FmFilterTextChangedHint*>(&rHint))
1293 {
1294 std::unique_ptr<weld::TreeIter> xEntry = FindEntry(pChangeHint->GetData());
1295 if (xEntry)
1296 m_xTreeView->set_text(*xEntry, pChangeHint->GetData()->GetText());
1297 }
1298 else if( dynamic_cast<const FmFilterCurrentChangedHint*>(&rHint) )
1299 {
1300 m_xTreeView->queue_draw();
1301 }
1302}
1303
1304std::unique_ptr<weld::TreeIter> FmFilterNavigator::FindEntry(const FmFilterData* pItem) const
1305{
1306 if (!pItem)
1307 return nullptr;
1308 std::unique_ptr<weld::TreeIter> xEntry = m_xTreeView->make_iterator();
1309 if (!m_xTreeView->get_iter_first(*xEntry))
1310 return nullptr;
1311 do
1312 {
1313 FmFilterData* pEntryItem = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(*xEntry).toUInt64());
1314 if (pEntryItem == pItem)
1315 return xEntry;
1316 }
1317 while (m_xTreeView->iter_next(*xEntry));
1318
1319 return nullptr;
1320}
1321
1322void FmFilterNavigator::Insert(FmFilterData* pItem, int nPos)
1323{
1324 const FmParentData* pParent = pItem->GetParent() ? pItem->GetParent() : m_pModel.get();
1325
1326 // insert the item
1327 std::unique_ptr<weld::TreeIter> xParentEntry = FindEntry(pParent);
1328
1329 OUString sId(OUString::number(reinterpret_cast<sal_uIntPtr>(pItem)));
1330 std::unique_ptr<weld::TreeIter> xRet(m_xTreeView->make_iterator());
1331 m_xTreeView->insert(xParentEntry.get(), nPos, &pItem->GetText(), &sId,
1332 nullptr, nullptr, false, xRet.get());
1333 m_xTreeView->set_image(*xRet, pItem->GetImage());
1334
1335 if (!xParentEntry)
1336 return;
1337 m_xTreeView->expand_row(*xParentEntry);
1338}
1339
1340void FmFilterNavigator::EndEditing()
1341{
1342 if (m_xEditingCurrently)
1343 {
1344 // end editing
1345 m_xTreeView->end_editing();
1346 m_xEditingCurrently.reset();
1347 }
1348}
1349
1350void FmFilterNavigator::Remove(FmFilterData const * pItem)
1351{
1352 // the entry for the data
1353 std::unique_ptr<weld::TreeIter> xEntry = FindEntry(pItem);
1354 if (!xEntry)
1355 return;
1356
1357 if (m_xEditingCurrently && m_xTreeView->iter_compare(*xEntry, *m_xEditingCurrently) == 0)
1358 EndEditing();
1359
1360 m_xTreeView->remove(*xEntry);
1361}
1362
1363FmFormItem* FmFilterNavigator::getSelectedFilterItems(::std::vector<FmFilterItem*>& _rItemList)
1364{
1365 // be sure that the data is only used within only one form!
1366 FmFormItem* pFirstItem = nullptr;
1367
1368 bool bHandled = true;
1369 bool bFoundSomething = false;
1370
1371 m_xTreeView->selected_foreach([this, &bHandled, &bFoundSomething, &pFirstItem, &_rItemList](weld::TreeIter& rEntry) {
1372 FmFilterData* pFilterEntry = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(rEntry).toInt64());
1373 FmFilterItem* pFilter = dynamic_cast<FmFilterItem*>(pFilterEntry);
1374 if (pFilter)
1375 {
1376 FmFormItem* pForm = dynamic_cast<FmFormItem*>( pFilter->GetParent()->GetParent() );
1377 if (!pForm)
1378 bHandled = false;
1379 else if (!pFirstItem)
1380 pFirstItem = pForm;
1381 else if (pFirstItem != pForm)
1382 bHandled = false;
1383
1384 if (bHandled)
1385 {
1386 _rItemList.push_back(pFilter);
1387 bFoundSomething = true;
1388 }
1389 }
1390 return !bHandled;
1391 });
1392
1393 if ( !bHandled || !bFoundSomething )
1394 pFirstItem = nullptr;
1395 return pFirstItem;
1396}
1397
1398void FmFilterNavigator::insertFilterItem(const ::std::vector<FmFilterItem*>& _rFilterList,FmFilterItems* _pTargetItems,bool _bCopy)
1399{
1400 for (FmFilterItem* pLookupItem : _rFilterList)
1401 {
1402 if ( pLookupItem->GetParent() == _pTargetItems )
1403 continue;
1404
1405 FmFilterItem* pFilterItem = _pTargetItems->Find( pLookupItem->GetComponentIndex() );
1406 OUString aText = pLookupItem->GetText();
1407 if ( !pFilterItem )
1408 {
1409 pFilterItem = new FmFilterItem( _pTargetItems, pLookupItem->GetFieldName(), aText, pLookupItem->GetComponentIndex() );
1410 m_pModel->Append( _pTargetItems, std::unique_ptr<FmFilterItem>(pFilterItem) );
1411 }
1412
1413 if ( !_bCopy )
1414 m_pModel->Remove( pLookupItem );
1415
1416 // now set the text for the new dragged item
1417 m_pModel->SetTextForItem( pFilterItem, aText );
1418 }
1419
1420 m_pModel->EnsureEmptyFilterRows( *_pTargetItems->GetParent() );
1421}
1422
1423IMPL_LINK(FmFilterNavigator, DragBeginHdl, bool&, rUnsetDragIcon, bool)bool FmFilterNavigator::LinkStubDragBeginHdl(void * instance,
bool& data) { return static_cast<FmFilterNavigator *>
(instance)->DragBeginHdl(data); } bool FmFilterNavigator::
DragBeginHdl(bool& rUnsetDragIcon)
1424{
1425 rUnsetDragIcon = false;
1426
1427 // be sure that the data is only used within an only one form!
1428 m_aControlExchange.prepareDrag();
1429
1430 ::std::vector<FmFilterItem*> aItemList;
1431 if (FmFormItem* pFirstItem = getSelectedFilterItems(aItemList))
1432 {
1433 m_aControlExchange->setDraggedEntries(aItemList);
1434 m_aControlExchange->setFormItem(pFirstItem);
1435
1436 OFilterItemExchange& rExchange = *m_aControlExchange;
1437 rtl::Reference<TransferDataContainer> xHelper(&rExchange);
1438 m_xTreeView->enable_drag_source(xHelper, DND_ACTION_COPYMOVEcss::datatransfer::dnd::DNDConstants::ACTION_COPY_OR_MOVE);
1439 rExchange.setDragging(true);
1440
1441 return false;
1442 }
1443 return true;
1444}
1445
1446IMPL_LINK(FmFilterNavigator, PopupMenuHdl, const CommandEvent&, rEvt, bool)bool FmFilterNavigator::LinkStubPopupMenuHdl(void * instance,
const CommandEvent& data) { return static_cast<FmFilterNavigator
*>(instance)->PopupMenuHdl(data); } bool FmFilterNavigator
::PopupMenuHdl(const CommandEvent& rEvt)
1447{
1448 bool bHandled = false;
1449 switch (rEvt.GetCommand())
1450 {
1451 case CommandEventId::ContextMenu:
1452 {
1453 // the place where it was clicked
1454 Point aWhere;
1455 std::unique_ptr<weld::TreeIter> xClicked(m_xTreeView->make_iterator());
1456 if (rEvt.IsMouseEvent())
1457 {
1458 aWhere = rEvt.GetMousePosPixel();
1459 if (!m_xTreeView->get_dest_row_at_pos(aWhere, xClicked.get(), false))
1460 break;
1461
1462 if (!m_xTreeView->is_selected(*xClicked))
1463 {
1464 m_xTreeView->unselect_all();
1465 m_xTreeView->select(*xClicked);
1466 m_xTreeView->set_cursor(*xClicked);
1467 }
1468 }
1469 else
1470 {
1471 if (!m_xTreeView->get_cursor(xClicked.get()))
1472 break;
1473 aWhere = m_xTreeView->get_row_area(*xClicked).Center();
1474 }
1475
1476 ::std::vector<FmFilterData*> aSelectList;
1477 m_xTreeView->selected_foreach([this, &aSelectList](weld::TreeIter& rEntry) {
1478 FmFilterData* pFilterEntry = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(rEntry).toInt64());
1479
1480 // don't delete forms
1481 FmFormItem* pForm = dynamic_cast<FmFormItem*>(pFilterEntry);
1482 if (!pForm)
1483 aSelectList.push_back(pFilterEntry);
1484
1485 return false;
1486 });
1487
1488 if (aSelectList.size() == 1)
1489 {
1490 // don't delete the only empty row of a form
1491 FmFilterItems* pFilterItems = dynamic_cast<FmFilterItems*>( aSelectList[0] );
1492 if (pFilterItems && pFilterItems->GetChildren().empty()
1493 && pFilterItems->GetParent()->GetChildren().size() == 1)
1494 aSelectList.clear();
1495 }
1496
1497 std::unique_ptr<weld::Builder> xBuilder(Application::CreateBuilder(m_xTreeView.get(), "svx/ui/filtermenu.ui"));
1498 std::unique_ptr<weld::Menu> xContextMenu(xBuilder->weld_menu("menu"));
1499
1500 // every condition could be deleted except the first one if it's the only one
1501 bool bNoDelete = false;
1502 if (aSelectList.empty())
1503 {
1504 bNoDelete = true;
1505 xContextMenu->remove("delete");
1506 }
1507
1508 FmFilterData* pFilterEntry = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(*xClicked).toInt64());
1509 bool bEdit = dynamic_cast<FmFilterItem*>(pFilterEntry) != nullptr &&
1510 m_xTreeView->is_selected(*xClicked) && m_xTreeView->count_selected_rows() == 1;
1511
1512 if (bNoDelete && !bEdit)
1513 {
1514 // nothing is in the menu, don't bother
1515 return true;
1516 }
1517
1518 if (!bEdit)
1519 {
1520 xContextMenu->remove("edit");
1521 xContextMenu->remove("isnull");
1522 xContextMenu->remove("isnotnull");
1523 }
1524
1525 OString sIdent = xContextMenu->popup_at_rect(m_xTreeView.get(), tools::Rectangle(aWhere, ::Size(1, 1)));
1526 if (sIdent == "edit")
1527 {
1528 m_xTreeView->start_editing(*xClicked);
1529 }
1530 else if (sIdent == "isnull")
1531 {
1532 OUString aErrorMsg;
1533 OUString aText = "IS NULL";
1534 m_pModel->ValidateText(static_cast<FmFilterItem*>(pFilterEntry),
1535 aText, aErrorMsg);
1536 m_pModel->SetTextForItem(static_cast<FmFilterItem*>(pFilterEntry), aText);
1537 }
1538 else if (sIdent == "isnotnull")
1539 {
1540 OUString aErrorMsg;
1541 OUString aText = "IS NOT NULL";
1542
1543 m_pModel->ValidateText(static_cast<FmFilterItem*>(pFilterEntry),
1544 aText, aErrorMsg);
1545 m_pModel->SetTextForItem(static_cast<FmFilterItem*>(pFilterEntry), aText);
1546 }
1547 else if (sIdent == "delete")
1548 {
1549 DeleteSelection();
1550 }
1551 bHandled = true;
1552 }
1553 break;
1554 default: break;
1555 }
1556
1557 return bHandled;
1558}
1559
1560typedef std::vector<std::unique_ptr<weld::TreeIter>> iter_vector;
1561
1562bool FmFilterNavigator::getNextEntry(weld::TreeIter& rEntry)
1563{
1564 bool bEntry = m_xTreeView->iter_next(rEntry);
1565 // we need the next filter entry
1566 if (bEntry)
1567 {
1568 while (!m_xTreeView->iter_has_child(rEntry))
1569 {
1570 std::unique_ptr<weld::TreeIter> xNext = m_xTreeView->make_iterator(&rEntry);
1571 if (!m_xTreeView->iter_next(*xNext))
1572 break;
1573 m_xTreeView->copy_iterator(*xNext, rEntry);
1574 }
1575 }
1576 return bEntry;
1577}
1578
1579bool FmFilterNavigator::getPrevEntry(weld::TreeIter& rEntry)
1580{
1581 bool bEntry = m_xTreeView->iter_previous(rEntry);
1582 // check if the previous entry is a filter, if so get the next prev
1583 if (bEntry && m_xTreeView->iter_has_child(rEntry))
1584 {
1585 bEntry = m_xTreeView->iter_previous(rEntry);
1586 // if the entry is still no leaf return
1587 if (bEntry && m_xTreeView->iter_has_child(rEntry))
1588 bEntry = false;
1589 }
1590 return bEntry;
1591}
1592IMPL_LINK(FmFilterNavigator, KeyInputHdl, const ::KeyEvent&, rKEvt, bool)bool FmFilterNavigator::LinkStubKeyInputHdl(void * instance, const
::KeyEvent& data) { return static_cast<FmFilterNavigator
*>(instance)->KeyInputHdl(data); } bool FmFilterNavigator
::KeyInputHdl(const ::KeyEvent& rKEvt)
1593{
1594 const vcl::KeyCode& rKeyCode = rKEvt.GetKeyCode();
1595
1596 switch ( rKeyCode.GetCode() )
1597 {
1598 case KEY_UP:
1599 case KEY_DOWN:
1600 {
1601 if ( !rKeyCode.IsMod1() || !rKeyCode.IsMod2() || rKeyCode.IsShift() )
1602 break;
1603
1604 ::std::vector<FmFilterItem*> aItemList;
1605 if ( !getSelectedFilterItems( aItemList ) )
1606 break;
1607
1608
1609 iter_vector aSelected;
1610 m_xTreeView->selected_foreach([this, &aSelected](weld::TreeIter& rEntry){
1611 aSelected.emplace_back(m_xTreeView->make_iterator(&rEntry));
1612 return false;
1613 });
1614
1615 std::unique_ptr<weld::TreeIter> xTarget;
1616 ::std::function<bool(FmFilterNavigator*, weld::TreeIter&)> getter;
1617
1618 if (rKeyCode.GetCode() == KEY_UP)
1619 {
1620 xTarget = m_xTreeView->make_iterator(aSelected.front().get());
1621 getter = ::std::mem_fn(&FmFilterNavigator::getPrevEntry);
1622 }
1623 else
1624 {
1625 xTarget = m_xTreeView->make_iterator(aSelected.back().get());
1626 getter = ::std::mem_fn(&FmFilterNavigator::getNextEntry);
1627 }
1628
1629 bool bTarget = getter(this, *xTarget);
1630 if (!bTarget)
1631 break;
1632
1633 FmFilterItems* pTargetItems = getTargetItems(*m_xTreeView, *xTarget);
1634 if (!pTargetItems)
1635 break;
1636
1637 ::std::vector<FmFilterItem*>::const_iterator aEnd = aItemList.end();
1638 bool bNextTargetItem = true;
1639 while ( bNextTargetItem )
1640 {
1641 ::std::vector<FmFilterItem*>::const_iterator i = aItemList.begin();
1642 for (; i != aEnd; ++i)
1643 {
1644 if ( (*i)->GetParent() == pTargetItems )
1645 {
1646 bTarget = getter(this, *xTarget);
1647 if (!bTarget)
1648 return true;
1649 pTargetItems = getTargetItems(*m_xTreeView, *xTarget);
1650 break;
1651 }
1652 else
1653 {
1654 FmFilterItem* pFilterItem = pTargetItems->Find( (*i)->GetComponentIndex() );
1655 // we found the text component so jump above
1656 if ( pFilterItem )
1657 {
1658 bTarget = getter(this, *xTarget);
1659 if (!bTarget)
1660 return true;
1661
1662 pTargetItems = getTargetItems(*m_xTreeView, *xTarget);
1663 break;
1664 }
1665 }
1666 }
1667 bNextTargetItem = i != aEnd && pTargetItems;
1668 }
1669
1670 if ( pTargetItems )
1671 {
1672 insertFilterItem( aItemList, pTargetItems, false );
1673 return true;
1674 }
1675 }
1676 break;
1677
1678 case KEY_DELETE:
1679 {
1680 if ( rKeyCode.GetModifier() )
1681 break;
1682
1683 std::unique_ptr<weld::TreeIter> xEntry = m_xTreeView->make_iterator();
1684 if (m_xTreeView->get_iter_first(*xEntry) && !m_xTreeView->is_selected(*xEntry))
1685 DeleteSelection();
1686
1687 return true;
1688 }
1689 }
1690
1691 return false;
1692}
1693
1694void FmFilterNavigator::DeleteSelection()
1695{
1696 // to avoid the deletion of an entry twice (e.g. deletion of a parent and afterward
1697 // the deletion of its child, I have to shrink the selection list
1698 std::vector<FmFilterData*> aEntryList;
1699
1700 m_xTreeView->selected_foreach([this, &aEntryList](weld::TreeIter& rEntry) {
1701 FmFilterData* pFilterEntry = reinterpret_cast<FmFilterData*>(m_xTreeView->get_id(rEntry).toInt64());
1702
1703 if (dynamic_cast<FmFilterItem*>(pFilterEntry))
1704 {
1705 std::unique_ptr<weld::TreeIter> xParent(m_xTreeView->make_iterator(&rEntry));
1706 if (m_xTreeView->iter_parent(*xParent) && m_xTreeView->is_selected(*xParent))
1707 return false;
1708 }
1709
1710 FmFormItem* pForm = dynamic_cast<FmFormItem*>(pFilterEntry);
1711 if (!pForm)
1712 aEntryList.emplace_back(pFilterEntry);
1713
1714 return false;
1715 });
1716
1717 // Remove the selection
1718 m_xTreeView->unselect_all();
1719
1720 for (auto i = aEntryList.rbegin(); i != aEntryList.rend(); ++i)
1721 m_pModel->Remove(*i);
1722}
1723
1724FmFilterNavigatorWin::FmFilterNavigatorWin(SfxBindings* _pBindings, SfxChildWindow* _pMgr,
1725 vcl::Window* _pParent)
1726 : SfxDockingWindow(_pBindings, _pMgr, _pParent, "FilterNavigator", "svx/ui/filternavigator.ui")
1727 , SfxControllerItem( SID_FM_FILTER_NAVIGATOR_CONTROL( 10000 + 752 ), *_pBindings )
1728 , m_xNavigatorTree(new FmFilterNavigator(this, m_xBuilder->weld_tree_view("treeview")))
1729{
1730 SetHelpId( HID_FILTER_NAVIGATOR_WIN"SVX_HID_FILTER_NAVIGATOR_WIN" );
1731
1732 SetText( SvxResId(RID_STR_FILTER_NAVIGATORreinterpret_cast<char const *>("RID_STR_FILTER_NAVIGATOR"
"\004" u8"Filter navigator")
) );
1733 SfxDockingWindow::SetFloatingSize( Size(200,200) );
1734}
1735
1736FmFilterNavigatorWin::~FmFilterNavigatorWin()
1737{
1738 disposeOnce();
1739}
1740
1741void FmFilterNavigatorWin::dispose()
1742{
1743 m_xNavigatorTree.reset();
1744 ::SfxControllerItem::dispose();
1745 SfxDockingWindow::dispose();
1746}
1747
1748void FmFilterNavigatorWin::UpdateContent(FmFormShell const * pFormShell)
1749{
1750 if (!m_xNavigatorTree)
1751 return;
1752
1753 if (!pFormShell)
1754 m_xNavigatorTree->UpdateContent( nullptr, nullptr );
1755 else
1756 {
1757 Reference<XFormController> const xController(pFormShell->GetImpl()->getActiveInternalController_Lock());
1758 Reference< XIndexAccess > xContainer;
1759 if (xController.is())
1760 {
1761 Reference< XChild > xChild = xController;
1762 for (Reference< XInterface > xParent(xChild->getParent());
1763 xParent.is();
1764 xParent = xChild.is() ? xChild->getParent() : Reference< XInterface > ())
1765 {
1766 xContainer.set(xParent, UNO_QUERY);
1767 xChild.set(xParent, UNO_QUERY);
1768 }
1769 }
1770 m_xNavigatorTree->UpdateContent(xContainer, xController);
1771 }
1772}
1773
1774void FmFilterNavigatorWin::StateChanged( sal_uInt16 nSID, SfxItemState eState, const SfxPoolItem* pState )
1775{
1776 if( !pState || SID_FM_FILTER_NAVIGATOR_CONTROL( 10000 + 752 ) != nSID )
1777 return;
1778
1779 if( eState >= SfxItemState::DEFAULT )
1780 {
1781 FmFormShell* pShell = dynamic_cast<FmFormShell*>( static_cast<const SfxObjectItem*>(pState)->GetShell() );
1782 UpdateContent( pShell );
1783 }
1784 else
1785 UpdateContent( nullptr );
1786}
1787
1788bool FmFilterNavigatorWin::Close()
1789{
1790 if (m_xNavigatorTree)
1791 m_xNavigatorTree->EndEditing();
1792
1793 UpdateContent( nullptr );
1794 return SfxDockingWindow::Close();
1795}
1796
1797void FmFilterNavigatorWin::FillInfo( SfxChildWinInfo& rInfo ) const
1798{
1799 SfxDockingWindow::FillInfo( rInfo );
1800 rInfo.bVisible = false;
1801}
1802
1803Size FmFilterNavigatorWin::CalcDockingSize( SfxChildAlignment eAlign )
1804{
1805 if ( ( eAlign == SfxChildAlignment::TOP ) || ( eAlign == SfxChildAlignment::BOTTOM ) )
1806 return Size();
1807
1808 return SfxDockingWindow::CalcDockingSize( eAlign );
1809}
1810
1811SfxChildAlignment FmFilterNavigatorWin::CheckAlignment( SfxChildAlignment eActAlign, SfxChildAlignment eAlign )
1812{
1813 switch (eAlign)
1814 {
1815 case SfxChildAlignment::LEFT:
1816 case SfxChildAlignment::RIGHT:
1817 case SfxChildAlignment::NOALIGNMENT:
1818 return eAlign;
1819 default:
1820 break;
1821 }
1822
1823 return eActAlign;
1824}
1825
1826void FmFilterNavigatorWin::GetFocus()
1827{
1828 // oj #97405#
1829 if (m_xNavigatorTree)
1830 m_xNavigatorTree->GrabFocus();
1831 else
1832 SfxDockingWindow::GetFocus();
1833}
1834
1835SFX_IMPL_DOCKINGWINDOW( FmFilterNavigatorWinMgr, SID_FM_FILTER_NAVIGATOR )std::unique_ptr<SfxChildWindow> FmFilterNavigatorWinMgr
::CreateImpl( vcl::Window *pParent, sal_uInt16 nId, SfxBindings
*pBindings, SfxChildWinInfo* pInfo ) { return std::make_unique
<FmFilterNavigatorWinMgr>(pParent, nId, pBindings, pInfo
); } void FmFilterNavigatorWinMgr::RegisterChildWindow (bool bVis
, SfxModule *pMod, SfxChildWindowFlags nFlags) { auto pFact =
std::make_unique<SfxChildWinFactory>( FmFilterNavigatorWinMgr
::CreateImpl, ( 10000 + 732 ), (32767 *2 +1) ); pFact->aInfo
.nFlags |= nFlags; pFact->aInfo.bVisible = bVis; SfxChildWindow
::RegisterChildWindow(pMod, std::move(pFact)); } SfxChildWinInfo
FmFilterNavigatorWinMgr::GetInfo() const { SfxChildWinInfo aInfo
= SfxChildWindow::GetInfo(); static_cast<SfxDockingWindow
*>(GetWindow())->FillInfo( aInfo ); return aInfo; }
1
Calling 'make_unique<svxform::FmFilterNavigatorWinMgr, vcl::Window *&, unsigned short &, SfxBindings *&, SfxChildWinInfo *&>'
1836
1837
1838FmFilterNavigatorWinMgr::FmFilterNavigatorWinMgr( vcl::Window *_pParent, sal_uInt16 _nId,
1839 SfxBindings *_pBindings, SfxChildWinInfo* _pInfo )
1840 :SfxChildWindow( _pParent, _nId )
1841{
1842 SetWindow( VclPtr<FmFilterNavigatorWin>::Create( _pBindings, this, _pParent ) );
3
Calling 'VclPtr::Create'
5
Returned allocated memory
6
Calling implicit destructor for 'VclPtr<vcl::Window>'
7
Calling '~Reference'
14
Returning from '~Reference'
15
Returning from destructor for 'VclPtr<vcl::Window>'
16
Calling implicit destructor for 'VclPtr<svxform::FmFilterNavigatorWin>'
17
Calling '~Reference'
1843 static_cast<SfxDockingWindow*>(GetWindow())->Initialize( _pInfo );
1844}
1845
1846
1847}
1848
1849/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/bits/unique_ptr.h

1// unique_ptr implementation -*- C++ -*-
2
3// Copyright (C) 2008-2020 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library. This library is free
6// software; you can redistribute it and/or modify it under the
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 3, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// Under Section 7 of GPL version 3, you are granted additional
17// permissions described in the GCC Runtime Library Exception, version
18// 3.1, as published by the Free Software Foundation.
19
20// You should have received a copy of the GNU General Public License and
21// a copy of the GCC Runtime Library Exception along with this program;
22// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23// <http://www.gnu.org/licenses/>.
24
25/** @file bits/unique_ptr.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{memory}
28 */
29
30#ifndef _UNIQUE_PTR_H1
31#define _UNIQUE_PTR_H1 1
32
33#include <bits/c++config.h>
34#include <debug/assertions.h>
35#include <type_traits>
36#include <utility>
37#include <tuple>
38#include <bits/stl_function.h>
39#include <bits/functional_hash.h>
40#if __cplusplus201703L > 201703L
41# include <compare>
42# include <ostream>
43#endif
44
45namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default")))
46{
47_GLIBCXX_BEGIN_NAMESPACE_VERSION
48
49 /**
50 * @addtogroup pointer_abstractions
51 * @{
52 */
53
54#if _GLIBCXX_USE_DEPRECATED1
55#pragma GCC diagnostic push
56#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
57 template<typename> class auto_ptr;
58#pragma GCC diagnostic pop
59#endif
60
61 /// Primary template of default_delete, used by unique_ptr for single objects
62 template<typename _Tp>
63 struct default_delete
64 {
65 /// Default constructor
66 constexpr default_delete() noexcept = default;
67
68 /** @brief Converting constructor.
69 *
70 * Allows conversion from a deleter for objects of another type, `_Up`,
71 * only if `_Up*` is convertible to `_Tp*`.
72 */
73 template<typename _Up,
74 typename = _Require<is_convertible<_Up*, _Tp*>>>
75 default_delete(const default_delete<_Up>&) noexcept { }
76
77 /// Calls `delete __ptr`
78 void
79 operator()(_Tp* __ptr) const
80 {
81 static_assert(!is_void<_Tp>::value,
82 "can't delete pointer to incomplete type");
83 static_assert(sizeof(_Tp)>0,
84 "can't delete pointer to incomplete type");
85 delete __ptr;
86 }
87 };
88
89 // _GLIBCXX_RESOLVE_LIB_DEFECTS
90 // DR 740 - omit specialization for array objects with a compile time length
91
92 /// Specialization of default_delete for arrays, used by `unique_ptr<T[]>`
93 template<typename _Tp>
94 struct default_delete<_Tp[]>
95 {
96 public:
97 /// Default constructor
98 constexpr default_delete() noexcept = default;
99
100 /** @brief Converting constructor.
101 *
102 * Allows conversion from a deleter for arrays of another type, such as
103 * a const-qualified version of `_Tp`.
104 *
105 * Conversions from types derived from `_Tp` are not allowed because
106 * it is undefined to `delete[]` an array of derived types through a
107 * pointer to the base type.
108 */
109 template<typename _Up,
110 typename = _Require<is_convertible<_Up(*)[], _Tp(*)[]>>>
111 default_delete(const default_delete<_Up[]>&) noexcept { }
112
113 /// Calls `delete[] __ptr`
114 template<typename _Up>
115 typename enable_if<is_convertible<_Up(*)[], _Tp(*)[]>::value>::type
116 operator()(_Up* __ptr) const
117 {
118 static_assert(sizeof(_Tp)>0,
119 "can't delete pointer to incomplete type");
120 delete [] __ptr;
121 }
122 };
123
124 /// @cond undocumented
125
126 // Manages the pointer and deleter of a unique_ptr
127 template <typename _Tp, typename _Dp>
128 class __uniq_ptr_impl
129 {
130 template <typename _Up, typename _Ep, typename = void>
131 struct _Ptr
132 {
133 using type = _Up*;
134 };
135
136 template <typename _Up, typename _Ep>
137 struct
138 _Ptr<_Up, _Ep, __void_t<typename remove_reference<_Ep>::type::pointer>>
139 {
140 using type = typename remove_reference<_Ep>::type::pointer;
141 };
142
143 public:
144 using _DeleterConstraint = enable_if<
145 __and_<__not_<is_pointer<_Dp>>,
146 is_default_constructible<_Dp>>::value>;
147
148 using pointer = typename _Ptr<_Tp, _Dp>::type;
149
150 static_assert( !is_rvalue_reference<_Dp>::value,
151 "unique_ptr's deleter type must be a function object type"
152 " or an lvalue reference type" );
153
154 __uniq_ptr_impl() = default;
155 __uniq_ptr_impl(pointer __p) : _M_t() { _M_ptr() = __p; }
156
157 template<typename _Del>
158 __uniq_ptr_impl(pointer __p, _Del&& __d)
159 : _M_t(__p, std::forward<_Del>(__d)) { }
160
161 __uniq_ptr_impl(__uniq_ptr_impl&& __u) noexcept
162 : _M_t(std::move(__u._M_t))
163 { __u._M_ptr() = nullptr; }
164
165 __uniq_ptr_impl& operator=(__uniq_ptr_impl&& __u) noexcept
166 {
167 reset(__u.release());
168 _M_deleter() = std::forward<_Dp>(__u._M_deleter());
169 return *this;
170 }
171
172 pointer& _M_ptr() { return std::get<0>(_M_t); }
173 pointer _M_ptr() const { return std::get<0>(_M_t); }
174 _Dp& _M_deleter() { return std::get<1>(_M_t); }
175 const _Dp& _M_deleter() const { return std::get<1>(_M_t); }
176
177 void reset(pointer __p) noexcept
178 {
179 const pointer __old_p = _M_ptr();
180 _M_ptr() = __p;
181 if (__old_p)
182 _M_deleter()(__old_p);
183 }
184
185 pointer release() noexcept
186 {
187 pointer __p = _M_ptr();
188 _M_ptr() = nullptr;
189 return __p;
190 }
191
192 void
193 swap(__uniq_ptr_impl& __rhs) noexcept
194 {
195 using std::swap;
196 swap(this->_M_ptr(), __rhs._M_ptr());
197 swap(this->_M_deleter(), __rhs._M_deleter());
198 }
199
200 private:
201 tuple<pointer, _Dp> _M_t;
202 };
203
204 // Defines move construction + assignment as either defaulted or deleted.
205 template <typename _Tp, typename _Dp,
206 bool = is_move_constructible<_Dp>::value,
207 bool = is_move_assignable<_Dp>::value>
208 struct __uniq_ptr_data : __uniq_ptr_impl<_Tp, _Dp>
209 {
210 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
211 __uniq_ptr_data(__uniq_ptr_data&&) = default;
212 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default;
213 };
214
215 template <typename _Tp, typename _Dp>
216 struct __uniq_ptr_data<_Tp, _Dp, true, false> : __uniq_ptr_impl<_Tp, _Dp>
217 {
218 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
219 __uniq_ptr_data(__uniq_ptr_data&&) = default;
220 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete;
221 };
222
223 template <typename _Tp, typename _Dp>
224 struct __uniq_ptr_data<_Tp, _Dp, false, true> : __uniq_ptr_impl<_Tp, _Dp>
225 {
226 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
227 __uniq_ptr_data(__uniq_ptr_data&&) = delete;
228 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default;
229 };
230
231 template <typename _Tp, typename _Dp>
232 struct __uniq_ptr_data<_Tp, _Dp, false, false> : __uniq_ptr_impl<_Tp, _Dp>
233 {
234 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
235 __uniq_ptr_data(__uniq_ptr_data&&) = delete;
236 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete;
237 };
238 /// @endcond
239
240 /// 20.7.1.2 unique_ptr for single objects.
241 template <typename _Tp, typename _Dp = default_delete<_Tp>>
242 class unique_ptr
243 {
244 template <typename _Up>
245 using _DeleterConstraint =
246 typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type;
247
248 __uniq_ptr_data<_Tp, _Dp> _M_t;
249
250 public:
251 using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer;
252 using element_type = _Tp;
253 using deleter_type = _Dp;
254
255 private:
256 // helper template for detecting a safe conversion from another
257 // unique_ptr
258 template<typename _Up, typename _Ep>
259 using __safe_conversion_up = __and_<
260 is_convertible<typename unique_ptr<_Up, _Ep>::pointer, pointer>,
261 __not_<is_array<_Up>>
262 >;
263
264 public:
265 // Constructors.
266
267 /// Default constructor, creates a unique_ptr that owns nothing.
268 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
269 constexpr unique_ptr() noexcept
270 : _M_t()
271 { }
272
273 /** Takes ownership of a pointer.
274 *
275 * @param __p A pointer to an object of @c element_type
276 *
277 * The deleter will be value-initialized.
278 */
279 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
280 explicit
281 unique_ptr(pointer __p) noexcept
282 : _M_t(__p)
283 { }
284
285 /** Takes ownership of a pointer.
286 *
287 * @param __p A pointer to an object of @c element_type
288 * @param __d A reference to a deleter.
289 *
290 * The deleter will be initialized with @p __d
291 */
292 template<typename _Del = deleter_type,
293 typename = _Require<is_copy_constructible<_Del>>>
294 unique_ptr(pointer __p, const deleter_type& __d) noexcept
295 : _M_t(__p, __d) { }
296
297 /** Takes ownership of a pointer.
298 *
299 * @param __p A pointer to an object of @c element_type
300 * @param __d An rvalue reference to a (non-reference) deleter.
301 *
302 * The deleter will be initialized with @p std::move(__d)
303 */
304 template<typename _Del = deleter_type,
305 typename = _Require<is_move_constructible<_Del>>>
306 unique_ptr(pointer __p,
307 __enable_if_t<!is_lvalue_reference<_Del>::value,
308 _Del&&> __d) noexcept
309 : _M_t(__p, std::move(__d))
310 { }
311
312 template<typename _Del = deleter_type,
313 typename _DelUnref = typename remove_reference<_Del>::type>
314 unique_ptr(pointer,
315 __enable_if_t<is_lvalue_reference<_Del>::value,
316 _DelUnref&&>) = delete;
317
318 /// Creates a unique_ptr that owns nothing.
319 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
320 constexpr unique_ptr(nullptr_t) noexcept
321 : _M_t()
322 { }
323
324 // Move constructors.
325
326 /// Move constructor.
327 unique_ptr(unique_ptr&&) = default;
328
329 /** @brief Converting constructor from another type
330 *
331 * Requires that the pointer owned by @p __u is convertible to the
332 * type of pointer owned by this object, @p __u does not own an array,
333 * and @p __u has a compatible deleter type.
334 */
335 template<typename _Up, typename _Ep, typename = _Require<
336 __safe_conversion_up<_Up, _Ep>,
337 typename conditional<is_reference<_Dp>::value,
338 is_same<_Ep, _Dp>,
339 is_convertible<_Ep, _Dp>>::type>>
340 unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept
341 : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter()))
342 { }
343
344#if _GLIBCXX_USE_DEPRECATED1
345#pragma GCC diagnostic push
346#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
347 /// Converting constructor from @c auto_ptr
348 template<typename _Up, typename = _Require<
349 is_convertible<_Up*, _Tp*>, is_same<_Dp, default_delete<_Tp>>>>
350 unique_ptr(auto_ptr<_Up>&& __u) noexcept;
351#pragma GCC diagnostic pop
352#endif
353
354 /// Destructor, invokes the deleter if the stored pointer is not null.
355 ~unique_ptr() noexcept
356 {
357 static_assert(__is_invocable<deleter_type&, pointer>::value,
358 "unique_ptr's deleter must be invocable with a pointer");
359 auto& __ptr = _M_t._M_ptr();
360 if (__ptr != nullptr)
361 get_deleter()(std::move(__ptr));
362 __ptr = pointer();
363 }
364
365 // Assignment.
366
367 /** @brief Move assignment operator.
368 *
369 * Invokes the deleter if this object owns a pointer.
370 */
371 unique_ptr& operator=(unique_ptr&&) = default;
372
373 /** @brief Assignment from another type.
374 *
375 * @param __u The object to transfer ownership from, which owns a
376 * convertible pointer to a non-array object.
377 *
378 * Invokes the deleter if this object owns a pointer.
379 */
380 template<typename _Up, typename _Ep>
381 typename enable_if< __and_<
382 __safe_conversion_up<_Up, _Ep>,
383 is_assignable<deleter_type&, _Ep&&>
384 >::value,
385 unique_ptr&>::type
386 operator=(unique_ptr<_Up, _Ep>&& __u) noexcept
387 {
388 reset(__u.release());
389 get_deleter() = std::forward<_Ep>(__u.get_deleter());
390 return *this;
391 }
392
393 /// Reset the %unique_ptr to empty, invoking the deleter if necessary.
394 unique_ptr&
395 operator=(nullptr_t) noexcept
396 {
397 reset();
398 return *this;
399 }
400
401 // Observers.
402
403 /// Dereference the stored pointer.
404 typename add_lvalue_reference<element_type>::type
405 operator*() const
406 {
407 __glibcxx_assert(get() != pointer());
408 return *get();
409 }
410
411 /// Return the stored pointer.
412 pointer
413 operator->() const noexcept
414 {
415 _GLIBCXX_DEBUG_PEDASSERT(get() != pointer());
416 return get();
417 }
418
419 /// Return the stored pointer.
420 pointer
421 get() const noexcept
422 { return _M_t._M_ptr(); }
423
424 /// Return a reference to the stored deleter.
425 deleter_type&
426 get_deleter() noexcept
427 { return _M_t._M_deleter(); }
428
429 /// Return a reference to the stored deleter.
430 const deleter_type&
431 get_deleter() const noexcept
432 { return _M_t._M_deleter(); }
433
434 /// Return @c true if the stored pointer is not null.
435 explicit operator bool() const noexcept
436 { return get() == pointer() ? false : true; }
437
438 // Modifiers.
439
440 /// Release ownership of any stored pointer.
441 pointer
442 release() noexcept
443 { return _M_t.release(); }
444
445 /** @brief Replace the stored pointer.
446 *
447 * @param __p The new pointer to store.
448 *
449 * The deleter will be invoked if a pointer is already owned.
450 */
451 void
452 reset(pointer __p = pointer()) noexcept
453 {
454 static_assert(__is_invocable<deleter_type&, pointer>::value,
455 "unique_ptr's deleter must be invocable with a pointer");
456 _M_t.reset(std::move(__p));
457 }
458
459 /// Exchange the pointer and deleter with another object.
460 void
461 swap(unique_ptr& __u) noexcept
462 {
463 static_assert(__is_swappable<_Dp>::value, "deleter must be swappable");
464 _M_t.swap(__u._M_t);
465 }
466
467 // Disable copy from lvalue.
468 unique_ptr(const unique_ptr&) = delete;
469 unique_ptr& operator=(const unique_ptr&) = delete;
470 };
471
472 /// 20.7.1.3 unique_ptr for array objects with a runtime length
473 // [unique.ptr.runtime]
474 // _GLIBCXX_RESOLVE_LIB_DEFECTS
475 // DR 740 - omit specialization for array objects with a compile time length
476 template<typename _Tp, typename _Dp>
477 class unique_ptr<_Tp[], _Dp>
478 {
479 template <typename _Up>
480 using _DeleterConstraint =
481 typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type;
482
483 __uniq_ptr_data<_Tp, _Dp> _M_t;
484
485 template<typename _Up>
486 using __remove_cv = typename remove_cv<_Up>::type;
487
488 // like is_base_of<_Tp, _Up> but false if unqualified types are the same
489 template<typename _Up>
490 using __is_derived_Tp
491 = __and_< is_base_of<_Tp, _Up>,
492 __not_<is_same<__remove_cv<_Tp>, __remove_cv<_Up>>> >;
493
494 public:
495 using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer;
496 using element_type = _Tp;
497 using deleter_type = _Dp;
498
499 // helper template for detecting a safe conversion from another
500 // unique_ptr
501 template<typename _Up, typename _Ep,
502 typename _UPtr = unique_ptr<_Up, _Ep>,
503 typename _UP_pointer = typename _UPtr::pointer,
504 typename _UP_element_type = typename _UPtr::element_type>
505 using __safe_conversion_up = __and_<
506 is_array<_Up>,
507 is_same<pointer, element_type*>,
508 is_same<_UP_pointer, _UP_element_type*>,
509 is_convertible<_UP_element_type(*)[], element_type(*)[]>
510 >;
511
512 // helper template for detecting a safe conversion from a raw pointer
513 template<typename _Up>
514 using __safe_conversion_raw = __and_<
515 __or_<__or_<is_same<_Up, pointer>,
516 is_same<_Up, nullptr_t>>,
517 __and_<is_pointer<_Up>,
518 is_same<pointer, element_type*>,
519 is_convertible<
520 typename remove_pointer<_Up>::type(*)[],
521 element_type(*)[]>
522 >
523 >
524 >;
525
526 // Constructors.
527
528 /// Default constructor, creates a unique_ptr that owns nothing.
529 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
530 constexpr unique_ptr() noexcept
531 : _M_t()
532 { }
533
534 /** Takes ownership of a pointer.
535 *
536 * @param __p A pointer to an array of a type safely convertible
537 * to an array of @c element_type
538 *
539 * The deleter will be value-initialized.
540 */
541 template<typename _Up,
542 typename _Vp = _Dp,
543 typename = _DeleterConstraint<_Vp>,
544 typename = typename enable_if<
545 __safe_conversion_raw<_Up>::value, bool>::type>
546 explicit
547 unique_ptr(_Up __p) noexcept
548 : _M_t(__p)
549 { }
550
551 /** Takes ownership of a pointer.
552 *
553 * @param __p A pointer to an array of a type safely convertible
554 * to an array of @c element_type
555 * @param __d A reference to a deleter.
556 *
557 * The deleter will be initialized with @p __d
558 */
559 template<typename _Up, typename _Del = deleter_type,
560 typename = _Require<__safe_conversion_raw<_Up>,
561 is_copy_constructible<_Del>>>
562 unique_ptr(_Up __p, const deleter_type& __d) noexcept
563 : _M_t(__p, __d) { }
564
565 /** Takes ownership of a pointer.
566 *
567 * @param __p A pointer to an array of a type safely convertible
568 * to an array of @c element_type
569 * @param __d A reference to a deleter.
570 *
571 * The deleter will be initialized with @p std::move(__d)
572 */
573 template<typename _Up, typename _Del = deleter_type,
574 typename = _Require<__safe_conversion_raw<_Up>,
575 is_move_constructible<_Del>>>
576 unique_ptr(_Up __p,
577 __enable_if_t<!is_lvalue_reference<_Del>::value,
578 _Del&&> __d) noexcept
579 : _M_t(std::move(__p), std::move(__d))
580 { }
581
582 template<typename _Up, typename _Del = deleter_type,
583 typename _DelUnref = typename remove_reference<_Del>::type,
584 typename = _Require<__safe_conversion_raw<_Up>>>
585 unique_ptr(_Up,
586 __enable_if_t<is_lvalue_reference<_Del>::value,
587 _DelUnref&&>) = delete;
588
589 /// Move constructor.
590 unique_ptr(unique_ptr&&) = default;
591
592 /// Creates a unique_ptr that owns nothing.
593 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
594 constexpr unique_ptr(nullptr_t) noexcept
595 : _M_t()
596 { }
597
598 template<typename _Up, typename _Ep, typename = _Require<
599 __safe_conversion_up<_Up, _Ep>,
600 typename conditional<is_reference<_Dp>::value,
601 is_same<_Ep, _Dp>,
602 is_convertible<_Ep, _Dp>>::type>>
603 unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept
604 : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter()))
605 { }
606
607 /// Destructor, invokes the deleter if the stored pointer is not null.
608 ~unique_ptr()
609 {
610 auto& __ptr = _M_t._M_ptr();
611 if (__ptr != nullptr)
612 get_deleter()(__ptr);
613 __ptr = pointer();
614 }
615
616 // Assignment.
617
618 /** @brief Move assignment operator.
619 *
620 * Invokes the deleter if this object owns a pointer.
621 */
622 unique_ptr&
623 operator=(unique_ptr&&) = default;
624
625 /** @brief Assignment from another type.
626 *
627 * @param __u The object to transfer ownership from, which owns a
628 * convertible pointer to an array object.
629 *
630 * Invokes the deleter if this object owns a pointer.
631 */
632 template<typename _Up, typename _Ep>
633 typename
634 enable_if<__and_<__safe_conversion_up<_Up, _Ep>,
635 is_assignable<deleter_type&, _Ep&&>
636 >::value,
637 unique_ptr&>::type
638 operator=(unique_ptr<_Up, _Ep>&& __u) noexcept
639 {
640 reset(__u.release());
641 get_deleter() = std::forward<_Ep>(__u.get_deleter());
642 return *this;
643 }
644
645 /// Reset the %unique_ptr to empty, invoking the deleter if necessary.
646 unique_ptr&
647 operator=(nullptr_t) noexcept
648 {
649 reset();
650 return *this;
651 }
652
653 // Observers.
654
655 /// Access an element of owned array.
656 typename std::add_lvalue_reference<element_type>::type
657 operator[](size_t __i) const
658 {
659 __glibcxx_assert(get() != pointer());
660 return get()[__i];
661 }
662
663 /// Return the stored pointer.
664 pointer
665 get() const noexcept
666 { return _M_t._M_ptr(); }
667
668 /// Return a reference to the stored deleter.
669 deleter_type&
670 get_deleter() noexcept
671 { return _M_t._M_deleter(); }
672
673 /// Return a reference to the stored deleter.
674 const deleter_type&
675 get_deleter() const noexcept
676 { return _M_t._M_deleter(); }
677
678 /// Return @c true if the stored pointer is not null.
679 explicit operator bool() const noexcept
680 { return get() == pointer() ? false : true; }
681
682 // Modifiers.
683
684 /// Release ownership of any stored pointer.
685 pointer
686 release() noexcept
687 { return _M_t.release(); }
688
689 /** @brief Replace the stored pointer.
690 *
691 * @param __p The new pointer to store.
692 *
693 * The deleter will be invoked if a pointer is already owned.
694 */
695 template <typename _Up,
696 typename = _Require<
697 __or_<is_same<_Up, pointer>,
698 __and_<is_same<pointer, element_type*>,
699 is_pointer<_Up>,
700 is_convertible<
701 typename remove_pointer<_Up>::type(*)[],
702 element_type(*)[]
703 >
704 >
705 >
706 >>
707 void
708 reset(_Up __p) noexcept
709 { _M_t.reset(std::move(__p)); }
710
711 void reset(nullptr_t = nullptr) noexcept
712 { reset(pointer()); }
713
714 /// Exchange the pointer and deleter with another object.
715 void
716 swap(unique_ptr& __u) noexcept
717 {
718 static_assert(__is_swappable<_Dp>::value, "deleter must be swappable");
719 _M_t.swap(__u._M_t);
720 }
721
722 // Disable copy from lvalue.
723 unique_ptr(const unique_ptr&) = delete;
724 unique_ptr& operator=(const unique_ptr&) = delete;
725 };
726
727 /// @relates unique_ptr @{
728
729 /// Swap overload for unique_ptr
730 template<typename _Tp, typename _Dp>
731 inline
732#if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11
733 // Constrained free swap overload, see p0185r1
734 typename enable_if<__is_swappable<_Dp>::value>::type
735#else
736 void
737#endif
738 swap(unique_ptr<_Tp, _Dp>& __x,
739 unique_ptr<_Tp, _Dp>& __y) noexcept
740 { __x.swap(__y); }
741
742#if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11
743 template<typename _Tp, typename _Dp>
744 typename enable_if<!__is_swappable<_Dp>::value>::type
745 swap(unique_ptr<_Tp, _Dp>&,
746 unique_ptr<_Tp, _Dp>&) = delete;
747#endif
748
749 /// Equality operator for unique_ptr objects, compares the owned pointers
750 template<typename _Tp, typename _Dp,
751 typename _Up, typename _Ep>
752 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
753 operator==(const unique_ptr<_Tp, _Dp>& __x,
754 const unique_ptr<_Up, _Ep>& __y)
755 { return __x.get() == __y.get(); }
756
757 /// unique_ptr comparison with nullptr
758 template<typename _Tp, typename _Dp>
759 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
760 operator==(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept
761 { return !__x; }
762
763#ifndef __cpp_lib_three_way_comparison
764 /// unique_ptr comparison with nullptr
765 template<typename _Tp, typename _Dp>
766 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
767 operator==(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept
768 { return !__x; }
769
770 /// Inequality operator for unique_ptr objects, compares the owned pointers
771 template<typename _Tp, typename _Dp,
772 typename _Up, typename _Ep>
773 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
774 operator!=(const unique_ptr<_Tp, _Dp>& __x,
775 const unique_ptr<_Up, _Ep>& __y)
776 { return __x.get() != __y.get(); }
777
778 /// unique_ptr comparison with nullptr
779 template<typename _Tp, typename _Dp>
780 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
781 operator!=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept
782 { return (bool)__x; }
783
784 /// unique_ptr comparison with nullptr
785 template<typename _Tp, typename _Dp>
786 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
787 operator!=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept
788 { return (bool)__x; }
789#endif // three way comparison
790
791 /// Relational operator for unique_ptr objects, compares the owned pointers
792 template<typename _Tp, typename _Dp,
793 typename _Up, typename _Ep>
794 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
795 operator<(const unique_ptr<_Tp, _Dp>& __x,
796 const unique_ptr<_Up, _Ep>& __y)
797 {
798 typedef typename
799 std::common_type<typename unique_ptr<_Tp, _Dp>::pointer,
800 typename unique_ptr<_Up, _Ep>::pointer>::type _CT;
801 return std::less<_CT>()(__x.get(), __y.get());
802 }
803
804 /// unique_ptr comparison with nullptr
805 template<typename _Tp, typename _Dp>
806 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
807 operator<(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
808 {
809 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(),
810 nullptr);
811 }
812
813 /// unique_ptr comparison with nullptr
814 template<typename _Tp, typename _Dp>
815 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
816 operator<(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
817 {
818 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr,
819 __x.get());
820 }
821
822 /// Relational operator for unique_ptr objects, compares the owned pointers
823 template<typename _Tp, typename _Dp,
824 typename _Up, typename _Ep>
825 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
826 operator<=(const unique_ptr<_Tp, _Dp>& __x,
827 const unique_ptr<_Up, _Ep>& __y)
828 { return !(__y < __x); }
829
830 /// unique_ptr comparison with nullptr
831 template<typename _Tp, typename _Dp>
832 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
833 operator<=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
834 { return !(nullptr < __x); }
835
836 /// unique_ptr comparison with nullptr
837 template<typename _Tp, typename _Dp>
838 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
839 operator<=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
840 { return !(__x < nullptr); }
841
842 /// Relational operator for unique_ptr objects, compares the owned pointers
843 template<typename _Tp, typename _Dp,
844 typename _Up, typename _Ep>
845 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
846 operator>(const unique_ptr<_Tp, _Dp>& __x,
847 const unique_ptr<_Up, _Ep>& __y)
848 { return (__y < __x); }
849
850 /// unique_ptr comparison with nullptr
851 template<typename _Tp, typename _Dp>
852 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
853 operator>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
854 {
855 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr,
856 __x.get());
857 }
858
859 /// unique_ptr comparison with nullptr
860 template<typename _Tp, typename _Dp>
861 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
862 operator>(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
863 {
864 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(),
865 nullptr);
866 }
867
868 /// Relational operator for unique_ptr objects, compares the owned pointers
869 template<typename _Tp, typename _Dp,
870 typename _Up, typename _Ep>
871 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
872 operator>=(const unique_ptr<_Tp, _Dp>& __x,
873 const unique_ptr<_Up, _Ep>& __y)
874 { return !(__x < __y); }
875
876 /// unique_ptr comparison with nullptr
877 template<typename _Tp, typename _Dp>
878 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
879 operator>=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
880 { return !(__x < nullptr); }
881
882 /// unique_ptr comparison with nullptr
883 template<typename _Tp, typename _Dp>
884 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
885 operator>=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
886 { return !(nullptr < __x); }
887
888#ifdef __cpp_lib_three_way_comparison
889 template<typename _Tp, typename _Dp, typename _Up, typename _Ep>
890 requires three_way_comparable_with<typename unique_ptr<_Tp, _Dp>::pointer,
891 typename unique_ptr<_Up, _Ep>::pointer>
892 inline
893 compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer,
894 typename unique_ptr<_Up, _Ep>::pointer>
895 operator<=>(const unique_ptr<_Tp, _Dp>& __x,
896 const unique_ptr<_Up, _Ep>& __y)
897 { return compare_three_way()(__x.get(), __y.get()); }
898
899 template<typename _Tp, typename _Dp>
900 requires three_way_comparable<typename unique_ptr<_Tp, _Dp>::pointer>
901 inline
902 compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer>
903 operator<=>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
904 {
905 using pointer = typename unique_ptr<_Tp, _Dp>::pointer;
906 return compare_three_way()(__x.get(), static_cast<pointer>(nullptr));
907 }
908#endif
909 // @} relates unique_ptr
910
911 /// @cond undocumented
912 template<typename _Up, typename _Ptr = typename _Up::pointer,
913 bool = __poison_hash<_Ptr>::__enable_hash_call>
914 struct __uniq_ptr_hash
915#if ! _GLIBCXX_INLINE_VERSION0
916 : private __poison_hash<_Ptr>
917#endif
918 {
919 size_t
920 operator()(const _Up& __u) const
921 noexcept(noexcept(std::declval<hash<_Ptr>>()(std::declval<_Ptr>())))
922 { return hash<_Ptr>()(__u.get()); }
923 };
924
925 template<typename _Up, typename _Ptr>
926 struct __uniq_ptr_hash<_Up, _Ptr, false>
927 : private __poison_hash<_Ptr>
928 { };
929 /// @endcond
930
931 /// std::hash specialization for unique_ptr.
932 template<typename _Tp, typename _Dp>
933 struct hash<unique_ptr<_Tp, _Dp>>
934 : public __hash_base<size_t, unique_ptr<_Tp, _Dp>>,
935 public __uniq_ptr_hash<unique_ptr<_Tp, _Dp>>
936 { };
937
938#if __cplusplus201703L >= 201402L
939 /// @relates unique_ptr @{
940#define __cpp_lib_make_unique201304 201304
941
942 /// @cond undocumented
943
944 template<typename _Tp>
945 struct _MakeUniq
946 { typedef unique_ptr<_Tp> __single_object; };
947
948 template<typename _Tp>
949 struct _MakeUniq<_Tp[]>
950 { typedef unique_ptr<_Tp[]> __array; };
951
952 template<typename _Tp, size_t _Bound>
953 struct _MakeUniq<_Tp[_Bound]>
954 { struct __invalid_type { }; };
955
956 /// @endcond
957
958 /// std::make_unique for single objects
959 template<typename _Tp, typename... _Args>
960 inline typename _MakeUniq<_Tp>::__single_object
961 make_unique(_Args&&... __args)
962 { return unique_ptr<_Tp>(new _Tp(std::forward<_Args>(__args)...)); }
2
Calling constructor for 'FmFilterNavigatorWinMgr'
963
964 /// std::make_unique for arrays of unknown bound
965 template<typename _Tp>
966 inline typename _MakeUniq<_Tp>::__array
967 make_unique(size_t __num)
968 { return unique_ptr<_Tp>(new remove_extent_t<_Tp>[__num]()); }
969
970 /// Disable std::make_unique for arrays of known bound
971 template<typename _Tp, typename... _Args>
972 inline typename _MakeUniq<_Tp>::__invalid_type
973 make_unique(_Args&&...) = delete;
974 // @} relates unique_ptr
975#endif // C++14
976
977#if __cplusplus201703L > 201703L && __cpp_concepts
978 // _GLIBCXX_RESOLVE_LIB_DEFECTS
979 // 2948. unique_ptr does not define operator<< for stream output
980 /// Stream output operator for unique_ptr
981 template<typename _CharT, typename _Traits, typename _Tp, typename _Dp>
982 inline basic_ostream<_CharT, _Traits>&
983 operator<<(basic_ostream<_CharT, _Traits>& __os,
984 const unique_ptr<_Tp, _Dp>& __p)
985 requires requires { __os << __p.get(); }
986 {
987 __os << __p.get();
988 return __os;
989 }
990#endif // C++20
991
992 // @} group pointer_abstractions
993
994#if __cplusplus201703L >= 201703L
995 namespace __detail::__variant
996 {
997 template<typename> struct _Never_valueless_alt; // see <variant>
998
999 // Provide the strong exception-safety guarantee when emplacing a
1000 // unique_ptr into a variant.
1001 template<typename _Tp, typename _Del>
1002 struct _Never_valueless_alt<std::unique_ptr<_Tp, _Del>>
1003 : std::true_type
1004 { };
1005 } // namespace __detail::__variant
1006#endif // C++17
1007
1008_GLIBCXX_END_NAMESPACE_VERSION
1009} // namespace
1010
1011#endif /* _UNIQUE_PTR_H */

/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 );
4
Memory is allocated
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 ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
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
7.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
17.1
Field 'm_pBody' is non-null
)
8
Taking true branch
18
Taking true branch
113 m_pBody->release();
9
Calling 'VclReferenceBase::release'
13
Returning; memory was released
19
Use of memory after it is freed
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
10
Assuming the condition is true
11
Taking true branch
40 delete this;
12
Memory is released
41 }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44 sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47
48
49private:
50 VclReferenceBase(const VclReferenceBase&) = delete;
51 VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52
53 bool mbDisposed : 1;
54
55protected:
56 VclReferenceBase();
57protected:
58 virtual ~VclReferenceBase();
59
60protected:
61 virtual void dispose();
62
63public:
64 void disposeOnce();
65 bool isDisposed() const { return mbDisposed; }
66
67};
68#endif