Bug Summary

File:home/maarten/src/libreoffice/core/include/rtl/ref.hxx
Warning:line 192, column 9
Use of memory after it is freed

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-unknown-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name optpath.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D CUI_DLLIMPLEMENTATION -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/qrcodegen/cpp/ -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/liborcus/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/liborcus/include -I /home/maarten/src/libreoffice/core/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/workdir/UnpackedTarball/curl/include -I /home/maarten/src/libreoffice/core/external/clew/source/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/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/cui/inc -I /home/maarten/src/libreoffice/core/cui/source/inc -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx

/home/maarten/src/libreoffice/core/cui/source/options/optpath.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 <svx/svxdlg.hxx>
21#include <sfx2/filedlghelper.hxx>
22#include <sfx2/app.hxx>
23#include <tools/urlobj.hxx>
24#include <unotools/defaultoptions.hxx>
25#include <unotools/pathoptions.hxx>
26#include <unotools/moduleoptions.hxx>
27#include <unotools/viewoptions.hxx>
28
29#include <bitmaps.hlst>
30#include <dialmgr.hxx>
31#include <optpath.hxx>
32#include <strings.hrc>
33#include <comphelper/processfactory.hxx>
34#include <comphelper/string.hxx>
35#include <com/sun/star/uno/Exception.hpp>
36#include <com/sun/star/beans/PropertyAttribute.hpp>
37#include <com/sun/star/ui/dialogs/ExecutableDialogResults.hpp>
38#include <com/sun/star/ui/dialogs/XAsynchronousExecutableDialog.hpp>
39#include <com/sun/star/ui/dialogs/FolderPicker.hpp>
40#include <com/sun/star/ui/dialogs/FilePicker.hpp>
41#include <com/sun/star/ui/dialogs/TemplateDescription.hpp>
42#include <com/sun/star/util/thePathSettings.hpp>
43#include <tools/diagnose_ex.h>
44#include <sal/log.hxx>
45
46using namespace css;
47using namespace css::beans;
48using namespace css::lang;
49using namespace css::ui::dialogs;
50using namespace css::uno;
51using namespace svx;
52
53// define ----------------------------------------------------------------
54
55#define POSTFIX_INTERNAL"_internal" "_internal"
56#define POSTFIX_USER"_user" "_user"
57#define POSTFIX_WRITABLE"_writable" "_writable"
58#define VAR_ONE"%1" "%1"
59#define IODLG_CONFIGNAME"FilePicker_Save" "FilePicker_Save"
60
61// struct OptPath_Impl ---------------------------------------------------
62
63struct OptPath_Impl
64{
65 SvtDefaultOptions m_aDefOpt;
66 OUString m_sMultiPathDlg;
67 Reference< css::util::XPathSettings > m_xPathSettings;
68
69 OptPath_Impl()
70 : m_sMultiPathDlg(CuiResId(RID_SVXSTR_EDIT_PATHSreinterpret_cast<char const *>("optpathspage|editpaths"
"\004" u8"Edit Paths: %1")
))
71 {
72 }
73};
74
75namespace {
76
77struct PathUserData_Impl
78{
79 sal_uInt16 nRealId;
80 SfxItemState eState;
81 OUString sUserPath;
82 OUString sWritablePath;
83 bool bReadOnly;
84
85 explicit PathUserData_Impl(sal_uInt16 nId)
86 : nRealId(nId)
87 , eState(SfxItemState::UNKNOWN)
88 , bReadOnly(false)
89 {
90 }
91};
92
93struct Handle2CfgNameMapping_Impl
94{
95 sal_uInt16 m_nHandle;
96 const char* m_pCfgName;
97};
98
99}
100
101Handle2CfgNameMapping_Impl const Hdl2CfgMap_Impl[] =
102{
103 { SvtPathOptions::PATH_AUTOCORRECT, "AutoCorrect" },
104 { SvtPathOptions::PATH_AUTOTEXT, "AutoText" },
105 { SvtPathOptions::PATH_BACKUP, "Backup" },
106 { SvtPathOptions::PATH_GALLERY, "Gallery" },
107 { SvtPathOptions::PATH_GRAPHIC, "Graphic" },
108 { SvtPathOptions::PATH_TEMP, "Temp" },
109 { SvtPathOptions::PATH_TEMPLATE, "Template" },
110 { SvtPathOptions::PATH_WORK, "Work" },
111 { SvtPathOptions::PATH_DICTIONARY, "Dictionary" },
112 { SvtPathOptions::PATH_CLASSIFICATION, "Classification" },
113#if OSL_DEBUG_LEVEL1 > 1
114 { SvtPathOptions::PATH_LINGUISTIC, "Linguistic" },
115#endif
116 { USHRT_MAX(32767 *2 +1), nullptr }
117};
118
119static OUString getCfgName_Impl( sal_uInt16 _nHandle )
120{
121 OUString sCfgName;
122 sal_uInt16 nIndex = 0;
123 while ( Hdl2CfgMap_Impl[ nIndex ].m_nHandle != USHRT_MAX(32767 *2 +1) )
124 {
125 if ( Hdl2CfgMap_Impl[ nIndex ].m_nHandle == _nHandle )
126 {
127 // config name found
128 sCfgName = OUString::createFromAscii( Hdl2CfgMap_Impl[ nIndex ].m_pCfgName );
129 break;
130 }
131 ++nIndex;
132 }
133
134 return sCfgName;
135}
136
137#define MULTIPATH_DELIMITER';' ';'
138
139static OUString Convert_Impl( const OUString& rValue )
140{
141 if (rValue.isEmpty())
142 return OUString();
143
144 sal_Int32 nPos = 0;
145 OUStringBuffer aReturn;
146 for (;;)
147 {
148 OUString aValue = rValue.getToken( 0, MULTIPATH_DELIMITER';', nPos );
149 INetURLObject aObj( aValue );
150 if ( aObj.GetProtocol() == INetProtocol::File )
151 aReturn.append(aObj.PathToFileName());
152 if ( nPos < 0 )
153 break;
154 aReturn.append(MULTIPATH_DELIMITER';');
155 }
156
157 return aReturn.makeStringAndClear();
158}
159
160// functions -------------------------------------------------------------
161
162static bool IsMultiPath_Impl( const sal_uInt16 nIndex )
163{
164#if OSL_DEBUG_LEVEL1 > 1
165 return ( SvtPathOptions::PATH_AUTOCORRECT == nIndex ||
166 SvtPathOptions::PATH_AUTOTEXT == nIndex ||
167 SvtPathOptions::PATH_BASIC == nIndex ||
168 SvtPathOptions::PATH_GALLERY == nIndex ||
169 SvtPathOptions::PATH_TEMPLATE == nIndex );
170#else
171 return ( SvtPathOptions::PATH_AUTOCORRECT == nIndex ||
172 SvtPathOptions::PATH_AUTOTEXT == nIndex ||
173 SvtPathOptions::PATH_BASIC == nIndex ||
174 SvtPathOptions::PATH_GALLERY == nIndex ||
175 SvtPathOptions::PATH_TEMPLATE == nIndex ||
176 SvtPathOptions::PATH_LINGUISTIC == nIndex ||
177 SvtPathOptions::PATH_DICTIONARY == nIndex );
178#endif
179}
180
181// class SvxPathTabPage --------------------------------------------------
182
183SvxPathTabPage::SvxPathTabPage(weld::Container* pPage, weld::DialogController* pController, const SfxItemSet& rSet)
184 : SfxTabPage( pPage, pController, "cui/ui/optpathspage.ui", "OptPathsPage", &rSet)
185 , pImpl(new OptPath_Impl)
186 , xDialogListener ( new ::svt::DialogClosedListener() )
187 , m_xStandardBtn(m_xBuilder->weld_button("default"))
188 , m_xPathBtn(m_xBuilder->weld_button("edit"))
189 , m_xPathBox(m_xBuilder->weld_tree_view("paths"))
190{
191 m_xStandardBtn->connect_clicked(LINK(this, SvxPathTabPage, StandardHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<SvxPathTabPage
*>(this), &SvxPathTabPage::LinkStubStandardHdl_Impl)
);
192 m_xPathBtn->connect_clicked( LINK( this, SvxPathTabPage, PathHdl_Impl )::tools::detail::makeLink( ::tools::detail::castTo<SvxPathTabPage
*>(this), &SvxPathTabPage::LinkStubPathHdl_Impl)
);
193
194 m_xPathBox->set_size_request(m_xPathBox->get_approximate_digit_width() * 60,
195 m_xPathBox->get_height_rows(20));
196
197 m_xPathBox->connect_row_activated( LINK( this, SvxPathTabPage, DoubleClickPathHdl_Impl )::tools::detail::makeLink( ::tools::detail::castTo<SvxPathTabPage
*>(this), &SvxPathTabPage::LinkStubDoubleClickPathHdl_Impl
)
);
198 m_xPathBox->connect_changed( LINK( this, SvxPathTabPage, PathSelect_Impl )::tools::detail::makeLink( ::tools::detail::castTo<SvxPathTabPage
*>(this), &SvxPathTabPage::LinkStubPathSelect_Impl)
);
199 m_xPathBox->set_selection_mode(SelectionMode::Multiple);
200
201 xDialogListener->SetDialogClosedLink( LINK( this, SvxPathTabPage, DialogClosedHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvxPathTabPage
*>(this), &SvxPathTabPage::LinkStubDialogClosedHdl)
);
202}
203
204SvxPathTabPage::~SvxPathTabPage()
205{
206 for (int i = 0, nEntryCount = m_xPathBox->n_children(); i < nEntryCount; ++i)
207 delete reinterpret_cast<PathUserData_Impl*>(m_xPathBox->get_id(i).toInt64());
208}
209
210std::unique_ptr<SfxTabPage> SvxPathTabPage::Create( weld::Container* pPage, weld::DialogController* pController,
211 const SfxItemSet* rAttrSet )
212{
213 return std::make_unique<SvxPathTabPage>( pPage, pController, *rAttrSet );
214}
215
216bool SvxPathTabPage::FillItemSet( SfxItemSet* )
217{
218 for (int i = 0, nEntryCount = m_xPathBox->n_children(); i < nEntryCount; ++i)
219 {
220 PathUserData_Impl* pPathImpl = reinterpret_cast<PathUserData_Impl*>(m_xPathBox->get_id(i).toInt64());
221 sal_uInt16 nRealId = pPathImpl->nRealId;
222 if (pPathImpl->eState == SfxItemState::SET)
223 SetPathList( nRealId, pPathImpl->sUserPath, pPathImpl->sWritablePath );
224 }
225 return true;
226}
227
228void SvxPathTabPage::Reset( const SfxItemSet* )
229{
230 m_xPathBox->clear();
231
232 std::unique_ptr<weld::TreeIter> xIter = m_xPathBox->make_iterator();
233 for( sal_uInt16 i = 0; i <= sal_uInt16(SvtPathOptions::PATH_CLASSIFICATION); ++i )
234 {
235 // only writer uses autotext
236 if ( i == SvtPathOptions::PATH_AUTOTEXT
237 && !SvtModuleOptions().IsModuleInstalled( SvtModuleOptions::EModule::WRITER ) )
238 continue;
239
240 const char* pId = nullptr;
241
242 switch (i)
243 {
244 case SvtPathOptions::PATH_AUTOCORRECT:
245 pId = RID_SVXSTR_KEY_AUTOCORRECT_DIRreinterpret_cast<char const *>("RID_SVXSTR_KEY_AUTOCORRECT_DIR"
"\004" u8"AutoCorrect")
;
246 break;
247 case SvtPathOptions::PATH_AUTOTEXT:
248 pId = RID_SVXSTR_KEY_GLOSSARY_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_GLOSSARY_PATH"
"\004" u8"AutoText")
;
249 break;
250 case SvtPathOptions::PATH_BACKUP:
251 pId = RID_SVXSTR_KEY_BACKUP_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_BACKUP_PATH"
"\004" u8"Backups")
;
252 break;
253 case SvtPathOptions::PATH_GALLERY:
254 pId = RID_SVXSTR_KEY_GALLERY_DIRreinterpret_cast<char const *>("RID_SVXSTR_KEY_GALLERY_DIR"
"\004" u8"Gallery")
;
255 break;
256 case SvtPathOptions::PATH_GRAPHIC:
257 pId = RID_SVXSTR_KEY_GRAPHICS_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_GRAPHICS_PATH"
"\004" u8"Images")
;
258 break;
259 case SvtPathOptions::PATH_TEMP:
260 pId = RID_SVXSTR_KEY_TEMP_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_TEMP_PATH"
"\004" u8"Temporary files")
;
261 break;
262 case SvtPathOptions::PATH_TEMPLATE:
263 pId = RID_SVXSTR_KEY_TEMPLATE_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_TEMPLATE_PATH"
"\004" u8"Templates")
;
264 break;
265 case SvtPathOptions::PATH_DICTIONARY:
266 pId = RID_SVXSTR_KEY_DICTIONARY_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_DICTIONARY_PATH"
"\004" u8"Dictionaries")
;
267 break;
268 case SvtPathOptions::PATH_CLASSIFICATION:
269 pId = RID_SVXSTR_KEY_CLASSIFICATION_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_CLASSIFICATION_PATH"
"\004" u8"Classification")
;
270 break;
271#if OSL_DEBUG_LEVEL1 > 1
272 case SvtPathOptions::PATH_LINGUISTIC:
273 pId = RID_SVXSTR_KEY_LINGUISTIC_DIRreinterpret_cast<char const *>("RID_SVXSTR_KEY_LINGUISTIC_DIR"
"\004" u8"Writing aids")
;
274 break;
275#endif
276 case SvtPathOptions::PATH_WORK:
277 pId = RID_SVXSTR_KEY_WORK_PATHreinterpret_cast<char const *>("RID_SVXSTR_KEY_WORK_PATH"
"\004" u8"My Documents")
;
278 break;
279 }
280
281 if (pId)
282 {
283 m_xPathBox->append(xIter.get());
284
285 OUString aStr(CuiResId(pId));
286 m_xPathBox->set_text(*xIter, aStr, 0);
287
288 OUString sInternal, sUser, sWritable;
289 bool bReadOnly = false;
290 GetPathList( i, sInternal, sUser, sWritable, bReadOnly );
291
292 if (bReadOnly)
293 m_xPathBox->set_image(*xIter, RID_SVXBMP_LOCK"res/lock.png");
294
295 OUString sTmpPath = sUser;
296 if ( !sTmpPath.isEmpty() && !sWritable.isEmpty() )
297 sTmpPath += OUStringChar(MULTIPATH_DELIMITER';');
298 sTmpPath += sWritable;
299 const OUString aValue = Convert_Impl( sTmpPath );
300
301 m_xPathBox->set_text(*xIter, aValue, 1);
302
303 const OUString aValueInternal = Convert_Impl( sInternal );
304
305 m_xPathBox->set_text(*xIter, aValueInternal, 2);
306
307 m_xPathBox->set_sensitive(*xIter, !bReadOnly, 0);
308 m_xPathBox->set_sensitive(*xIter, !bReadOnly, 1);
309 m_xPathBox->set_sensitive(*xIter, !bReadOnly, 2);
310
311 PathUserData_Impl* pPathImpl = new PathUserData_Impl(i);
312 pPathImpl->sUserPath = sUser;
313 pPathImpl->sWritablePath = sWritable;
314 pPathImpl->bReadOnly = bReadOnly;
315
316 OUString sId = OUString::number(reinterpret_cast<sal_Int64>(pPathImpl));
317 m_xPathBox->set_id(*xIter, sId);
318 }
319 }
320
321 m_xPathBox->columns_autosize();
322 PathSelect_Impl(*m_xPathBox);
323}
324
325IMPL_LINK_NOARG(SvxPathTabPage, PathSelect_Impl, weld::TreeView&, void)void SvxPathTabPage::LinkStubPathSelect_Impl(void * instance,
weld::TreeView& data) { return static_cast<SvxPathTabPage
*>(instance)->PathSelect_Impl(data); } void SvxPathTabPage
::PathSelect_Impl(__attribute__ ((unused)) weld::TreeView&
)
326{
327 bool bEnable = false;
328 int nEntry = m_xPathBox->get_selected_index();
329 if (nEntry != -1)
330 {
331 PathUserData_Impl* pPathImpl = reinterpret_cast<PathUserData_Impl*>(m_xPathBox->get_id(nEntry).toInt64());
332 bEnable = !pPathImpl->bReadOnly;
333 }
334 sal_uInt16 nSelCount = m_xPathBox->count_selected_rows();
335 m_xPathBtn->set_sensitive(1 == nSelCount && bEnable);
336 m_xStandardBtn->set_sensitive(nSelCount > 0 && bEnable);
337}
338
339IMPL_LINK_NOARG(SvxPathTabPage, StandardHdl_Impl, weld::Button&, void)void SvxPathTabPage::LinkStubStandardHdl_Impl(void * instance
, weld::Button& data) { return static_cast<SvxPathTabPage
*>(instance)->StandardHdl_Impl(data); } void SvxPathTabPage
::StandardHdl_Impl(__attribute__ ((unused)) weld::Button&
)
340{
341 m_xPathBox->selected_foreach([this](weld::TreeIter& rEntry){
342 PathUserData_Impl* pPathImpl = reinterpret_cast<PathUserData_Impl*>(m_xPathBox->get_id(rEntry).toInt64());
343 OUString aOldPath = pImpl->m_aDefOpt.GetDefaultPath( pPathImpl->nRealId );
344
345 if ( !aOldPath.isEmpty() )
346 {
347 OUString sInternal, sUser, sWritable, sTemp;
348 bool bReadOnly = false;
349 GetPathList( pPathImpl->nRealId, sInternal, sUser, sWritable, bReadOnly );
350
351 sal_Int32 nOldPos = 0;
352 do
353 {
354 bool bFound = false;
355 const OUString sOnePath = aOldPath.getToken( 0, MULTIPATH_DELIMITER';', nOldPos );
356 if ( !sInternal.isEmpty() )
357 {
358 sal_Int32 nInternalPos = 0;
359 do
360 {
361 if ( sInternal.getToken( 0, MULTIPATH_DELIMITER';', nInternalPos ) == sOnePath )
362 bFound = true;
363 }
364 while ( !bFound && nInternalPos >= 0 );
365 }
366 if ( !bFound )
367 {
368 if ( !sTemp.isEmpty() )
369 sTemp += OUStringChar(MULTIPATH_DELIMITER';');
370 sTemp += sOnePath;
371 }
372 }
373 while ( nOldPos >= 0 );
374
375 OUString sWritablePath;
376 OUStringBuffer sUserPath;
377 if ( !sTemp.isEmpty() )
378 {
379 sal_Int32 nNextPos = 0;
380 for (;;)
381 {
382 const OUString sToken = sTemp.getToken( 0, MULTIPATH_DELIMITER';', nNextPos );
383 if ( nNextPos<0 )
384 {
385 // Last token need a different handling
386 sWritablePath = sToken;
387 break;
388 }
389 if ( !sUserPath.isEmpty() )
390 sUserPath.append(MULTIPATH_DELIMITER';');
391 sUserPath.append(sToken);
392 }
393 }
394 m_xPathBox->set_text(rEntry, Convert_Impl(sTemp), 1);
395 pPathImpl->eState = SfxItemState::SET;
396 pPathImpl->sUserPath = sUserPath.makeStringAndClear();
397 pPathImpl->sWritablePath = sWritablePath;
398 }
399 return false;
400 });
401}
402
403void SvxPathTabPage::ChangeCurrentEntry( const OUString& _rFolder )
404{
405 int nEntry = m_xPathBox->get_cursor_index();
406 if (nEntry == -1)
407 {
408 SAL_WARN( "cui.options", "SvxPathTabPage::ChangeCurrentEntry(): no entry" )do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "cui.options")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break;
case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "SvxPathTabPage::ChangeCurrentEntry(): no entry"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"
), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "408" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvxPathTabPage::ChangeCurrentEntry(): no entry"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "SvxPathTabPage::ChangeCurrentEntry(): no entry"; ::
sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"
), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "408" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "SvxPathTabPage::ChangeCurrentEntry(): no entry")
== 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"
), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "408" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvxPathTabPage::ChangeCurrentEntry(): no entry"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "SvxPathTabPage::ChangeCurrentEntry(): no entry"; ::
sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"
), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "408" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
;
409 return;
410 }
411
412 OUString sInternal, sUser, sWritable;
413 PathUserData_Impl* pPathImpl = reinterpret_cast<PathUserData_Impl*>(m_xPathBox->get_id(nEntry).toInt64());
414 bool bReadOnly = false;
415 GetPathList( pPathImpl->nRealId, sInternal, sUser, sWritable, bReadOnly );
416 sUser = pPathImpl->sUserPath;
417 sWritable = pPathImpl->sWritablePath;
418
419 // old path is a URL?
420 INetURLObject aObj( sWritable );
421 bool bURL = ( aObj.GetProtocol() != INetProtocol::NotValid );
422 INetURLObject aNewObj( _rFolder );
423 aNewObj.removeFinalSlash();
424
425 // then the new path also a URL else system path
426 OUString sNewPathStr = bURL ? _rFolder : aNewObj.getFSysPath( FSysStyle::Detect );
427
428 bool bChanged =
429#ifdef UNX1
430// Unix is case sensitive
431 ( sNewPathStr != sWritable );
432#else
433 !sNewPathStr.equalsIgnoreAsciiCase( sWritable );
434#endif
435
436 if ( !bChanged )
437 return;
438
439 m_xPathBox->set_text(nEntry, Convert_Impl(sNewPathStr), 1);
440 pPathImpl->eState = SfxItemState::SET;
441 pPathImpl->sWritablePath = sNewPathStr;
442 if ( SvtPathOptions::PATH_WORK == pPathImpl->nRealId )
443 {
444 // Remove view options entry so the new work path
445 // will be used for the next open dialog.
446 SvtViewOptions aDlgOpt( EViewType::Dialog, IODLG_CONFIGNAME"FilePicker_Save" );
447 aDlgOpt.Delete();
448 // Reset also last used dir in the sfx application instance
449 SfxApplication *pSfxApp = SfxGetpApp();
450 pSfxApp->ResetLastDir();
451 }
452}
453
454IMPL_LINK_NOARG(SvxPathTabPage, DoubleClickPathHdl_Impl, weld::TreeView&, bool)bool SvxPathTabPage::LinkStubDoubleClickPathHdl_Impl(void * instance
, weld::TreeView& data) { return static_cast<SvxPathTabPage
*>(instance)->DoubleClickPathHdl_Impl(data); } bool SvxPathTabPage
::DoubleClickPathHdl_Impl(__attribute__ ((unused)) weld::TreeView
&)
455{
456 PathHdl_Impl(*m_xPathBtn);
457 return true;
458}
459
460IMPL_LINK_NOARG(SvxPathTabPage, PathHdl_Impl, weld::Button&, void)void SvxPathTabPage::LinkStubPathHdl_Impl(void * instance, weld
::Button& data) { return static_cast<SvxPathTabPage *>
(instance)->PathHdl_Impl(data); } void SvxPathTabPage::PathHdl_Impl
(__attribute__ ((unused)) weld::Button&)
1
Calling 'SvxPathTabPage::PathHdl_Impl'
461{
462 int nEntry = m_xPathBox->get_cursor_index();
463 PathUserData_Impl* pPathImpl = nEntry != -1 ? reinterpret_cast<PathUserData_Impl*>(m_xPathBox->get_id(nEntry).toInt64()) : nullptr;
2
Assuming the condition is true
3
'?' condition is true
464 if (!pPathImpl || pPathImpl->bReadOnly)
4
Assuming 'pPathImpl' is non-null
5
Assuming field 'bReadOnly' is false
6
Taking false branch
465 return;
466
467 sal_uInt16 nPos = pPathImpl->nRealId;
468 OUString sInternal, sUser, sWritable;
469 bool bPickFile = false;
470 bool bReadOnly = false;
471 GetPathList( pPathImpl->nRealId, sInternal, sUser, sWritable, bReadOnly );
472 sUser = pPathImpl->sUserPath;
473 sWritable = pPathImpl->sWritablePath;
474 bPickFile = pPathImpl->nRealId == SvtPathOptions::PATH_CLASSIFICATION;
7
Assuming field 'nRealId' is not equal to PATH_CLASSIFICATION
475
476 if (IsMultiPath_Impl(nPos))
8
Taking true branch
477 {
478 SvxAbstractDialogFactory* pFact = SvxAbstractDialogFactory::Create();
479 ScopedVclPtr<AbstractSvxMultiPathDialog> pMultiDlg(
9
Calling constructor for 'ScopedVclPtr<AbstractSvxMultiPathDialog>'
16
Returning from constructor for 'ScopedVclPtr<AbstractSvxMultiPathDialog>'
480 pFact->CreateSvxMultiPathDialog(GetFrameWeld()));
17
Calling implicit destructor for 'VclPtr<AbstractSvxMultiPathDialog>'
18
Calling '~Reference'
25
Returning from '~Reference'
26
Returning from destructor for 'VclPtr<AbstractSvxMultiPathDialog>'
481
482 OUString sPath( sUser );
483 if ( !sPath.isEmpty() )
27
Taking false branch
484 sPath += OUStringChar(MULTIPATH_DELIMITER';');
485 sPath += sWritable;
486 pMultiDlg->SetPath( sPath );
28
Calling 'VclPtr::operator->'
487
488 const OUString sPathName = m_xPathBox->get_text(nEntry, 0);
489 const OUString sNewTitle = pImpl->m_sMultiPathDlg.replaceFirst( VAR_ONE"%1", sPathName );
490 pMultiDlg->SetTitle( sNewTitle );
491
492 if (pMultiDlg->Execute() == RET_OK)
493 {
494 sUser.clear();
495 sWritable.clear();
496 OUString sFullPath;
497 OUString sNewPath = pMultiDlg->GetPath();
498 if ( !sNewPath.isEmpty() )
499 {
500 sal_Int32 nNextPos = 0;
501 for (;;)
502 {
503 const OUString sToken(sNewPath.getToken( 0, MULTIPATH_DELIMITER';', nNextPos ));
504 if ( nNextPos<0 )
505 {
506 // Last token need a different handling
507 sWritable = sToken;
508 break;
509 }
510 if ( !sUser.isEmpty() )
511 sUser += OUStringChar(MULTIPATH_DELIMITER';');
512 sUser += sToken;
513 }
514 sFullPath = sUser;
515 if ( !sFullPath.isEmpty() )
516 sFullPath += OUStringChar(MULTIPATH_DELIMITER';');
517 sFullPath += sWritable;
518 }
519
520 m_xPathBox->set_text(nEntry, Convert_Impl(sFullPath), 1);
521 // save modified flag
522 pPathImpl->eState = SfxItemState::SET;
523 pPathImpl->sUserPath = sUser;
524 pPathImpl->sWritablePath = sWritable;
525 }
526 }
527 else if (!bPickFile)
528 {
529 try
530 {
531 Reference < XComponentContext > xContext( ::comphelper::getProcessComponentContext() );
532 xFolderPicker = FolderPicker::create(xContext);
533
534 INetURLObject aURL( sWritable, INetProtocol::File );
535 xFolderPicker->setDisplayDirectory( aURL.GetMainURL( INetURLObject::DecodeMechanism::NONE ) );
536
537 Reference< XAsynchronousExecutableDialog > xAsyncDlg( xFolderPicker, UNO_QUERY );
538 if ( xAsyncDlg.is() )
539 xAsyncDlg->startExecuteModal( xDialogListener.get() );
540 else
541 {
542 short nRet = xFolderPicker->execute();
543 if (ExecutableDialogResults::OK != nRet)
544 return;
545
546 OUString sFolder(xFolderPicker->getDirectory());
547 ChangeCurrentEntry(sFolder);
548 }
549 }
550 catch( Exception const & )
551 {
552 TOOLS_WARN_EXCEPTION( "cui.options", "SvxPathTabPage::PathHdl_Impl: exception from folder picker" )do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "cui.options")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break;
case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "SvxPathTabPage::PathHdl_Impl: exception from folder picker"
<< " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "552" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvxPathTabPage::PathHdl_Impl: exception from folder picker"
<< " " << exceptionToString(tools_warn_exception
)), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "SvxPathTabPage::PathHdl_Impl: exception from folder picker"
<< " " << exceptionToString(tools_warn_exception
); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"
), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "552" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "SvxPathTabPage::PathHdl_Impl: exception from folder picker"
<< " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "552" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvxPathTabPage::PathHdl_Impl: exception from folder picker"
<< " " << exceptionToString(tools_warn_exception
)), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "SvxPathTabPage::PathHdl_Impl: exception from folder picker"
<< " " << exceptionToString(tools_warn_exception
); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"
), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "552" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false)
;
553 }
554 }
555 else
556 {
557 try
558 {
559 uno::Reference<uno::XComponentContext> xComponentContext(comphelper::getProcessComponentContext());
560 uno::Reference<ui::dialogs::XFilePicker3> xFilePicker = ui::dialogs::FilePicker::createWithMode(xComponentContext, ui::dialogs::TemplateDescription::FILEOPEN_SIMPLE);
561 xFilePicker->appendFilter(OUString(), "*.xml");
562 if (xFilePicker->execute() == ui::dialogs::ExecutableDialogResults::OK)
563 {
564 uno::Sequence<OUString> aPathSeq(xFilePicker->getSelectedFiles());
565 ChangeCurrentEntry(aPathSeq[0]);
566 }
567 }
568 catch (const uno::Exception&)
569 {
570 DBG_UNHANDLED_EXCEPTION("cui.options", "exception from file picker")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "570" ": ", "cui.options", "exception from file picker" )
;
;
571 }
572 }
573}
574
575IMPL_LINK( SvxPathTabPage, DialogClosedHdl, DialogClosedEvent*, pEvt, void )void SvxPathTabPage::LinkStubDialogClosedHdl(void * instance,
DialogClosedEvent* data) { return static_cast<SvxPathTabPage
*>(instance)->DialogClosedHdl(data); } void SvxPathTabPage
::DialogClosedHdl(DialogClosedEvent* pEvt)
576{
577 if (RET_OK == pEvt->DialogResult)
578 {
579 assert(xFolderPicker.is() && "SvxPathTabPage::DialogClosedHdl(): no folder picker")(static_cast <bool> (xFolderPicker.is() && "SvxPathTabPage::DialogClosedHdl(): no folder picker"
) ? void (0) : __assert_fail ("xFolderPicker.is() && \"SvxPathTabPage::DialogClosedHdl(): no folder picker\""
, "/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
, 579, __extension__ __PRETTY_FUNCTION__))
;
580 OUString sURL = xFolderPicker->getDirectory();
581 ChangeCurrentEntry( sURL );
582 }
583}
584
585void SvxPathTabPage::GetPathList(
586 sal_uInt16 _nPathHandle, OUString& _rInternalPath,
587 OUString& _rUserPath, OUString& _rWritablePath, bool& _rReadOnly )
588{
589 OUString sCfgName = getCfgName_Impl( _nPathHandle );
590
591 try
592 {
593 // load PathSettings service if necessary
594 if ( !pImpl->m_xPathSettings.is() )
595 {
596 Reference< XComponentContext > xContext = comphelper::getProcessComponentContext();
597 pImpl->m_xPathSettings = css::util::thePathSettings::get( xContext );
598 }
599
600 // load internal paths
601 Any aAny = pImpl->m_xPathSettings->getPropertyValue(
602 sCfgName + POSTFIX_INTERNAL"_internal");
603 Sequence< OUString > aPathSeq;
604 if ( aAny >>= aPathSeq )
605 {
606 long i, nCount = aPathSeq.getLength();
607 const OUString* pPaths = aPathSeq.getConstArray();
608
609 for ( i = 0; i < nCount; ++i )
610 {
611 if ( !_rInternalPath.isEmpty() )
612 _rInternalPath += ";";
613 _rInternalPath += pPaths[i];
614 }
615 }
616 // load user paths
617 aAny = pImpl->m_xPathSettings->getPropertyValue(
618 sCfgName + POSTFIX_USER"_user");
619 if ( aAny >>= aPathSeq )
620 {
621 long i, nCount = aPathSeq.getLength();
622 const OUString* pPaths = aPathSeq.getConstArray();
623
624 for ( i = 0; i < nCount; ++i )
625 {
626 if ( !_rUserPath.isEmpty() )
627 _rUserPath += ";";
628 _rUserPath += pPaths[i];
629 }
630 }
631 // then the writable path
632 aAny = pImpl->m_xPathSettings->getPropertyValue(
633 sCfgName + POSTFIX_WRITABLE"_writable");
634 OUString sWritablePath;
635 if ( aAny >>= sWritablePath )
636 _rWritablePath = sWritablePath;
637
638 // and the readonly flag
639 Reference< XPropertySetInfo > xInfo = pImpl->m_xPathSettings->getPropertySetInfo();
640 Property aProp = xInfo->getPropertyByName(sCfgName);
641 _rReadOnly = ( ( aProp.Attributes & PropertyAttribute::READONLY ) == PropertyAttribute::READONLY );
642 }
643 catch( const Exception& )
644 {
645 TOOLS_WARN_EXCEPTION( "cui.options", "SvxPathTabPage::GetPathList()" )do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "cui.options")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break;
case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "SvxPathTabPage::GetPathList()"
<< " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "645" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvxPathTabPage::GetPathList()" <<
" " << exceptionToString(tools_warn_exception)), 0); }
else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "SvxPathTabPage::GetPathList()" << " " <<
exceptionToString(tools_warn_exception); ::sal::detail::log(
(::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "645" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "SvxPathTabPage::GetPathList()" << " " <<
exceptionToString(tools_warn_exception)) == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "645" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvxPathTabPage::GetPathList()" <<
" " << exceptionToString(tools_warn_exception)), 0); }
else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "SvxPathTabPage::GetPathList()" << " " <<
exceptionToString(tools_warn_exception); ::sal::detail::log(
(::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "645" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false)
;
646 }
647}
648
649
650void SvxPathTabPage::SetPathList(
651 sal_uInt16 _nPathHandle, const OUString& _rUserPath, const OUString& _rWritablePath )
652{
653 OUString sCfgName = getCfgName_Impl( _nPathHandle );
654
655 try
656 {
657 // load PathSettings service if necessary
658 if ( !pImpl->m_xPathSettings.is() )
659 {
660 Reference< XComponentContext > xContext = comphelper::getProcessComponentContext();
661 pImpl->m_xPathSettings = css::util::thePathSettings::get( xContext );
662 }
663
664 // save user paths
665 const sal_Int32 nCount = comphelper::string::getTokenCount(_rUserPath, MULTIPATH_DELIMITER';');
666 Sequence< OUString > aPathSeq( nCount );
667 OUString* pArray = aPathSeq.getArray();
668 sal_Int32 nPos = 0;
669 for ( sal_Int32 i = 0; i < nCount; ++i )
670 pArray[i] = _rUserPath.getToken( 0, MULTIPATH_DELIMITER';', nPos );
671 Any aValue( aPathSeq );
672 pImpl->m_xPathSettings->setPropertyValue(
673 sCfgName + POSTFIX_USER"_user", aValue);
674
675 // then the writable path
676 aValue <<= _rWritablePath;
677 pImpl->m_xPathSettings->setPropertyValue(
678 sCfgName + POSTFIX_WRITABLE"_writable", aValue);
679 }
680 catch( const Exception& )
681 {
682 TOOLS_WARN_EXCEPTION("cui.options", "")do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "cui.options")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break;
case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "" << " " <<
exceptionToString(tools_warn_exception)) == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "682" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "682" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "" << " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "682" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("cui.options"), ("/home/maarten/src/libreoffice/core/cui/source/options/optpath.cxx"
":" "682" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false)
;
683 }
684}
685
686/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__))
;
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
;
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
29
Calling 'Reference::get'
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
10
Calling implicit copy constructor for 'VclPtr<AbstractSvxMultiPathDialog>'
11
Calling copy constructor for 'Reference<AbstractSvxMultiPathDialog>'
14
Returning from copy constructor for 'Reference<AbstractSvxMultiPathDialog>'
15
Returning from copy constructor for 'VclPtr<AbstractSvxMultiPathDialog>'
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)
12
Assuming field 'm_pBody' is non-null
13
Taking true branch
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody
18.1
Field 'm_pBody' is non-null
18.1
Field 'm_pBody' is non-null
18.1
Field 'm_pBody' is non-null
18.1
Field 'm_pBody' is non-null
)
19
Taking true branch
113 m_pBody->release();
20
Calling 'VclReferenceBase::release'
24
Returning; memory was released
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
30
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
21
Assuming the condition is true
22
Taking true branch
40 delete this;
23
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