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 linkdlg.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/dialogs/linkdlg.cxx

/home/maarten/src/libreoffice/core/cui/source/dialogs/linkdlg.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 <linkdlg.hxx>
21#include <vcl/svapp.hxx>
22
23#include <tools/diagnose_ex.h>
24#include <tools/debug.hxx>
25#include <tools/urlobj.hxx>
26#include <vcl/idle.hxx>
27#include <vcl/timer.hxx>
28#include <vcl/weld.hxx>
29#include <vcl/window.hxx>
30
31#include <strings.hrc>
32#include <sfx2/linkmgr.hxx>
33#include <sfx2/linksrc.hxx>
34#include <sfx2/lnkbase.hxx>
35#include <sfx2/objsh.hxx>
36
37#include <com/sun/star/ui/dialogs/ExecutableDialogResults.hpp>
38#include <com/sun/star/ui/dialogs/FolderPicker.hpp>
39#include <comphelper/processfactory.hxx>
40
41#include <dialmgr.hxx>
42
43
44using namespace sfx2;
45using namespace ::com::sun::star;
46
47namespace {
48
49class SvBaseLinkMemberList {
50private:
51 std::vector<SvBaseLink*> mLinks;
52
53public:
54 ~SvBaseLinkMemberList()
55 {
56 for (auto const& link : mLinks)
57 {
58 if( link )
59 link->ReleaseRef();
60 }
61 }
62
63 size_t size() const { return mLinks.size(); }
64
65 SvBaseLink *operator[](size_t i) const { return mLinks[i]; }
66
67 void push_back(SvBaseLink* p)
68 {
69 mLinks.push_back(p);
70 p->AddFirstRef();
71 }
72};
73
74}
75
76SvBaseLinksDlg::SvBaseLinksDlg(weld::Window * pParent, LinkManager* pMgr, bool bHtmlMode)
77 : GenericDialogController(pParent, "cui/ui/baselinksdialog.ui", "BaseLinksDialog")
78 , aStrAutolink( CuiResId( STR_AUTOLINKreinterpret_cast<char const *>("STR_AUTOLINK" "\004" u8"Automatic"
) ) )
79 , aStrManuallink( CuiResId( STR_MANUALLINKreinterpret_cast<char const *>("STR_MANUALLINK" "\004" u8"Manual"
) ) )
80 , aStrBrokenlink( CuiResId( STR_BROKENLINKreinterpret_cast<char const *>("STR_BROKENLINK" "\004" u8"Not available"
) ) )
81 , aStrCloselinkmsg( CuiResId( STR_CLOSELINKMSGreinterpret_cast<char const *>("STR_CLOSELINKMSG" "\004"
u8"Are you sure you want to remove the selected link?") ) )
82 , aStrCloselinkmsgMulti( CuiResId( STR_CLOSELINKMSG_MULTIreinterpret_cast<char const *>("STR_CLOSELINKMSG_MULTI"
"\004" u8"Are you sure you want to remove the selected link?"
) ) )
83 , aStrWaitinglink( CuiResId( STR_WAITINGLINKreinterpret_cast<char const *>("STR_WAITINGLINK" "\004"
u8"Waiting") ) )
84 , pLinkMgr( nullptr )
85 , aUpdateIdle("cui SvBaseLinksDlg UpdateIdle")
86 , m_xTbLinks(m_xBuilder->weld_tree_view("TB_LINKS"))
87 , m_xFtFullFileName(m_xBuilder->weld_link_button("FULL_FILE_NAME"))
88 , m_xFtFullSourceName(m_xBuilder->weld_label("FULL_SOURCE_NAME"))
89 , m_xFtFullTypeName(m_xBuilder->weld_label("FULL_TYPE_NAME"))
90 , m_xRbAutomatic(m_xBuilder->weld_radio_button("AUTOMATIC"))
91 , m_xRbManual(m_xBuilder->weld_radio_button("MANUAL"))
92 , m_xPbUpdateNow(m_xBuilder->weld_button("UPDATE_NOW"))
93 , m_xPbChangeSource(m_xBuilder->weld_button("CHANGE_SOURCE"))
94 , m_xPbBreakLink(m_xBuilder->weld_button("BREAK_LINK"))
95 , m_xVirDev(VclPtr<VirtualDevice>::Create())
96{
97 // expand the point size of the desired font to the equivalent pixel size
98 if (vcl::Window* pDefaultDevice = dynamic_cast<vcl::Window*>(Application::GetDefaultDevice()))
99 pDefaultDevice->SetPointFont(*m_xVirDev, m_xTbLinks->get_font());
100 m_xTbLinks->set_size_request(m_xTbLinks->get_approximate_digit_width() * 90,
101 m_xTbLinks->get_height_rows(12));
102
103 m_xTbLinks->set_selection_mode(SelectionMode::Multiple);
104
105 std::vector<int> aWidths;
106 aWidths.push_back(m_xTbLinks->get_approximate_digit_width() * 30);
107 aWidths.push_back(m_xTbLinks->get_approximate_digit_width() * 20);
108 aWidths.push_back(m_xTbLinks->get_approximate_digit_width() * 20);
109 m_xTbLinks->set_column_fixed_widths(aWidths);
110
111 // UpdateTimer for DDE-/Grf-links, which are waited for
112 aUpdateIdle.SetInvokeHandler( LINK( this, SvBaseLinksDlg, UpdateWaitingHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubUpdateWaitingHdl) );
113 aUpdateIdle.SetPriority( TaskPriority::LOWEST );
114
115 m_xTbLinks->connect_changed( LINK( this, SvBaseLinksDlg, LinksSelectHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubLinksSelectHdl) );
116 m_xTbLinks->connect_row_activated( LINK( this, SvBaseLinksDlg, LinksDoubleClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubLinksDoubleClickHdl
) );
117 m_xRbAutomatic->connect_clicked( LINK( this, SvBaseLinksDlg, AutomaticClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubAutomaticClickHdl) );
118 m_xRbManual->connect_clicked( LINK( this, SvBaseLinksDlg, ManualClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubManualClickHdl) );
119 m_xPbUpdateNow->connect_clicked( LINK( this, SvBaseLinksDlg, UpdateNowClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubUpdateNowClickHdl) );
120 m_xPbChangeSource->connect_clicked( LINK( this, SvBaseLinksDlg, ChangeSourceClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubChangeSourceClickHdl
) );
121 if(!bHtmlMode)
122 m_xPbBreakLink->connect_clicked( LINK( this, SvBaseLinksDlg, BreakLinkClickHdl )::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubBreakLinkClickHdl) );
123 else
124 m_xPbBreakLink->hide();
125
126 SetManager( pMgr );
127}
128
129SvBaseLinksDlg::~SvBaseLinksDlg()
130{
131}
1
Calling '~ScopedVclPtr'
→
132
133/*************************************************************************
134|* SvBaseLinksDlg::Handler()
135*************************************************************************/
136IMPL_LINK(SvBaseLinksDlg, LinksSelectHdl, weld::TreeView&, rTreeView, void)void SvBaseLinksDlg::LinkStubLinksSelectHdl(void * instance, weld
::TreeView& data) { return static_cast<SvBaseLinksDlg *
>(instance)->LinksSelectHdl(data); } void SvBaseLinksDlg
::LinksSelectHdl(weld::TreeView& rTreeView)
137{
138 LinksSelectHdl(&rTreeView);
139}
140
141void SvBaseLinksDlg::LinksSelectHdl(weld::TreeView* pSvTabListBox)
142{
143 const int nSelectionCount = pSvTabListBox ?
144 pSvTabListBox->count_selected_rows() : 0;
145 if (nSelectionCount > 1)
146 {
147 // possibly deselect old entries in case of multi-selection
148 int nSelEntry = pSvTabListBox->get_selected_index();
149 SvBaseLink* pLink = reinterpret_cast<SvBaseLink*>(pSvTabListBox->get_id(nSelEntry).toInt64());
150 SvBaseLinkObjectType nObjectType = pLink->GetObjType();
151 if(!isClientFileType(nObjectType))
152 {
153 pSvTabListBox->unselect_all();
154 pSvTabListBox->select(nSelEntry);
155 }
156 else
157 {
158 std::vector<int> aRows = pSvTabListBox->get_selected_rows();
159 for (auto nEntry : aRows)
160 {
161 pLink = reinterpret_cast<SvBaseLink*>(pSvTabListBox->get_id(nEntry).toInt64());
162 DBG_ASSERT(pLink, "Where is the Link?")do { if (true && (!(pLink))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/cui/source/dialogs/linkdlg.cxx"
":" "162" ": "), "%s", "Where is the Link?"); } } while (false
);
163 if (!pLink)
164 continue;
165 if( !isClientFileType(pLink->GetObjType()) )
166 pSvTabListBox->unselect(nEntry);
167 }
168 }
169
170 m_xPbUpdateNow->set_sensitive(true);
171 m_xRbAutomatic->set_sensitive(false);
172 m_xRbManual->set_active(true);
173 m_xRbManual->set_sensitive(false);
174 }
175 else
176 {
177 int nPos;
178 SvBaseLink* pLink = GetSelEntry( &nPos );
179 if( !pLink )
180 return;
181
182 m_xPbUpdateNow->set_sensitive(true);
183
184 OUString sType, sLink;
185 OUString *pLinkNm = &sLink, *pFilter = nullptr;
186
187 if( isClientFileType(pLink->GetObjType()) )
188 {
189 m_xRbAutomatic->set_sensitive(false);
190 m_xRbManual->set_active(true);
191 m_xRbManual->set_sensitive(false);
192 if( SvBaseLinkObjectType::ClientGraphic == pLink->GetObjType() )
193 {
194 pLinkNm = nullptr;
195 pFilter = &sLink;
196 }
197 }
198 else
199 {
200 m_xRbAutomatic->set_sensitive(true);
201 m_xRbManual->set_sensitive(true);
202
203 if( SfxLinkUpdateMode::ALWAYS == pLink->GetUpdateMode() )
204 m_xRbAutomatic->set_active(true);
205 else
206 m_xRbManual->set_active(true);
207 }
208
209 OUString aFileName;
210 sfx2::LinkManager::GetDisplayNames( pLink, &sType, &aFileName, pLinkNm, pFilter );
211 aFileName = INetURLObject::decode(aFileName, INetURLObject::DecodeMechanism::Unambiguous);
212 m_xFtFullFileName->set_label( aFileName );
213 m_xFtFullFileName->set_uri( aFileName );
214 m_xFtFullSourceName->set_label( sLink );
215 m_xFtFullTypeName->set_label( sType );
216 }
217}
218
219IMPL_LINK_NOARG( SvBaseLinksDlg, LinksDoubleClickHdl, weld::TreeView&, bool )bool SvBaseLinksDlg::LinkStubLinksDoubleClickHdl(void * instance
, weld::TreeView& data) { return static_cast<SvBaseLinksDlg
*>(instance)->LinksDoubleClickHdl(data); } bool SvBaseLinksDlg
::LinksDoubleClickHdl(__attribute__ ((unused)) weld::TreeView
&)
220{
221 ChangeSourceClickHdl(*m_xPbChangeSource);
222 return true;
223}
224
225IMPL_LINK_NOARG( SvBaseLinksDlg, AutomaticClickHdl, weld::Button&, void )void SvBaseLinksDlg::LinkStubAutomaticClickHdl(void * instance
, weld::Button& data) { return static_cast<SvBaseLinksDlg
*>(instance)->AutomaticClickHdl(data); } void SvBaseLinksDlg
::AutomaticClickHdl(__attribute__ ((unused)) weld::Button&
)
226{
227 int nPos;
228 SvBaseLink* pLink = GetSelEntry( &nPos );
229 if( pLink && !isClientFileType( pLink->GetObjType() ) &&
230 SfxLinkUpdateMode::ALWAYS != pLink->GetUpdateMode() )
231 SetType( *pLink, nPos, SfxLinkUpdateMode::ALWAYS );
232}
233
234IMPL_LINK_NOARG( SvBaseLinksDlg, ManualClickHdl, weld::Button&, void )void SvBaseLinksDlg::LinkStubManualClickHdl(void * instance, weld
::Button& data) { return static_cast<SvBaseLinksDlg *>
(instance)->ManualClickHdl(data); } void SvBaseLinksDlg::ManualClickHdl
(__attribute__ ((unused)) weld::Button&)
235{
236 int nPos;
237 SvBaseLink* pLink = GetSelEntry( &nPos );
238 if( pLink && !isClientFileType( pLink->GetObjType() ) &&
239 SfxLinkUpdateMode::ONCALL != pLink->GetUpdateMode())
240 SetType( *pLink, nPos, SfxLinkUpdateMode::ONCALL );
241}
242
243IMPL_LINK_NOARG(SvBaseLinksDlg, UpdateNowClickHdl, weld::Button&, void)void SvBaseLinksDlg::LinkStubUpdateNowClickHdl(void * instance
, weld::Button& data) { return static_cast<SvBaseLinksDlg
*>(instance)->UpdateNowClickHdl(data); } void SvBaseLinksDlg
::UpdateNowClickHdl(__attribute__ ((unused)) weld::Button&
)
244{
245 std::vector< SvBaseLink* > aLnkArr;
246 std::vector< sal_Int16 > aPosArr;
247
248 std::vector<int> aRows = m_xTbLinks->get_selected_rows();
249 for (int nFndPos : aRows)
250 {
251 aLnkArr.push_back( reinterpret_cast<SvBaseLink*>( m_xTbLinks->get_id(nFndPos).toInt64() ) );
252 aPosArr.push_back( nFndPos );
253 }
254
255 if( aLnkArr.empty() )
256 return;
257
258 for( size_t n = 0; n < aLnkArr.size(); ++n )
259 {
260 tools::SvRef<SvBaseLink> xLink = aLnkArr[ n ];
261
262 // first look for the entry in the array
263 for(const auto & i : pLinkMgr->GetLinks())
264 if( xLink == i )
265 {
266 SetType( *xLink, aPosArr[ n ], xLink->GetUpdateMode() );
267 break;
268 }
269 }
270
271 // if somebody is of the opinion to swap his links (SD)
272 LinkManager* pNewMgr = pLinkMgr;
273 pLinkMgr = nullptr;
274 SetManager( pNewMgr );
275
276
277 OUString sId = OUString::number(reinterpret_cast<sal_Int64>(aLnkArr[0]));
278 int nE = m_xTbLinks->find_id(sId);
279 if (nE == -1)
280 nE = m_xTbLinks->get_selected_index();
281 int nSelEntry = m_xTbLinks->get_selected_index();
282 if (nE != nSelEntry)
283 m_xTbLinks->unselect(nSelEntry);
284 m_xTbLinks->select(nE);
285 m_xTbLinks->scroll_to_row(nE);
286
287 pNewMgr->CloseCachedComps();
288}
289
290IMPL_LINK_NOARG(SvBaseLinksDlg, ChangeSourceClickHdl, weld::Button&, void)void SvBaseLinksDlg::LinkStubChangeSourceClickHdl(void * instance
, weld::Button& data) { return static_cast<SvBaseLinksDlg
*>(instance)->ChangeSourceClickHdl(data); } void SvBaseLinksDlg
::ChangeSourceClickHdl(__attribute__ ((unused)) weld::Button&
)
291{
292 std::vector<int> aRows = m_xTbLinks->get_selected_rows();
293 if (aRows.size() > 1)
294 {
295 try
296 {
297 uno::Reference<ui::dialogs::XFolderPicker2> xFolderPicker = ui::dialogs::FolderPicker::create(comphelper::getProcessComponentContext());
298
299 OUString sType, sFile, sLinkName;
300 OUString sFilter;
301 SvBaseLink* pLink = reinterpret_cast<SvBaseLink*>(m_xTbLinks->get_id(aRows[0]).toInt64());
302 sfx2::LinkManager::GetDisplayNames( pLink, &sType, &sFile );
303 INetURLObject aUrl(sFile);
304 if(aUrl.GetProtocol() == INetProtocol::File)
305 {
306 OUString sOldPath(aUrl.PathToFileName());
307 sal_Int32 nLen = aUrl.GetLastName().getLength();
308 sOldPath = sOldPath.copy(0, sOldPath.getLength() - nLen);
309 xFolderPicker->setDisplayDirectory(sOldPath);
310 }
311 if (xFolderPicker->execute() == ui::dialogs::ExecutableDialogResults::OK)
312 {
313 OUString aPath = xFolderPicker->getDirectory();
314
315 for (auto nRow : aRows)
316 {
317 pLink = reinterpret_cast<SvBaseLink*>(m_xTbLinks->get_id(nRow).toInt64());
318 DBG_ASSERT(pLink,"Where is the link?")do { if (true && (!(pLink))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/cui/source/dialogs/linkdlg.cxx"
":" "318" ": "), "%s", "Where is the link?"); } } while (false
);
319 if (!pLink)
320 continue;
321 sfx2::LinkManager::GetDisplayNames( pLink, &sType, &sFile, &sLinkName, &sFilter );
322 INetURLObject aUrl_(sFile);
323 INetURLObject aUrl2(aPath, INetProtocol::File);
324 aUrl2.insertName( aUrl_.getName() );
325 OUString sNewLinkName;
326 MakeLnkName( sNewLinkName, nullptr ,
327 aUrl2.GetMainURL(INetURLObject::DecodeMechanism::ToIUri), sLinkName, &sFilter);
328 pLink->SetLinkSourceName( sNewLinkName );
329 pLink->Update();
330 }
331 if( pLinkMgr->GetPersist() )
332 pLinkMgr->GetPersist()->SetModified();
333 LinkManager* pNewMgr = pLinkMgr;
334 pLinkMgr = nullptr;
335 SetManager( pNewMgr );
336 }
337 }
338 catch (const uno::Exception &)
339 {
340 TOOLS_WARN_EXCEPTION("cui.dialogs", "SvBaseLinksDlg")do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "cui.dialogs")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break;
case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "SvBaseLinksDlg" <<
" " << exceptionToString(tools_warn_exception)) == 1) {
::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.dialogs"
), ("/home/maarten/src/libreoffice/core/cui/source/dialogs/linkdlg.cxx"
":" "340" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvBaseLinksDlg" << " " <<
exceptionToString(tools_warn_exception)), 0); } else { ::std
::ostringstream sal_detail_stream; sal_detail_stream <<
"SvBaseLinksDlg" << " " << exceptionToString(tools_warn_exception
); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.dialogs"
), ("/home/maarten/src/libreoffice/core/cui/source/dialogs/linkdlg.cxx"
":" "340" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "SvBaseLinksDlg" << " " << exceptionToString
(tools_warn_exception)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("cui.dialogs"), ("/home/maarten/src/libreoffice/core/cui/source/dialogs/linkdlg.cxx"
":" "340" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SvBaseLinksDlg" << " " <<
exceptionToString(tools_warn_exception)), 0); } else { ::std
::ostringstream sal_detail_stream; sal_detail_stream <<
"SvBaseLinksDlg" << " " << exceptionToString(tools_warn_exception
); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("cui.dialogs"
), ("/home/maarten/src/libreoffice/core/cui/source/dialogs/linkdlg.cxx"
":" "340" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false);
341 }
342 }
343 else
344 {
345 int nPos;
346 SvBaseLink* pLink = GetSelEntry( &nPos );
347 if ( pLink && !pLink->GetLinkSourceName().isEmpty() )
348 pLink->Edit(m_xDialog.get(), LINK(this, SvBaseLinksDlg, EndEditHdl)::tools::detail::makeLink( ::tools::detail::castTo<SvBaseLinksDlg
*>(this), &SvBaseLinksDlg::LinkStubEndEditHdl));
349 }
350}
351
352IMPL_LINK_NOARG( SvBaseLinksDlg, BreakLinkClickHdl, weld::Button&, void )void SvBaseLinksDlg::LinkStubBreakLinkClickHdl(void * instance
, weld::Button& data) { return static_cast<SvBaseLinksDlg
*>(instance)->BreakLinkClickHdl(data); } void SvBaseLinksDlg
::BreakLinkClickHdl(__attribute__ ((unused)) weld::Button&
)
353{
354 bool bModified = false;
355 if (m_xTbLinks->count_selected_rows() <= 1)
356 {
357 int nPos;
358 tools::SvRef<SvBaseLink> xLink = GetSelEntry( &nPos );
359 if( !xLink.is() )
360 return;
361
362 std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(m_xDialog.get(),
363 VclMessageType::Question, VclButtonsType::YesNo,
364 aStrCloselinkmsg));
365 xQueryBox->set_default_response(RET_YES);
366
367 if (RET_YES == xQueryBox->run())
368 {
369 m_xTbLinks->remove(nPos);
370
371 // close object, if it's still existing
372 bool bNewLnkMgr = SvBaseLinkObjectType::ClientFile == xLink->GetObjType();
373
374 // tell the link that it will be resolved!
375 xLink->Closed();
376
377 // if somebody has forgotten to deregister himself
378 if( xLink.is() )
379 pLinkMgr->Remove( xLink.get() );
380
381 if( bNewLnkMgr )
382 {
383 LinkManager* pNewMgr = pLinkMgr;
384 pLinkMgr = nullptr;
385 SetManager( pNewMgr );
386 m_xTbLinks->set_cursor(nPos ? --nPos : 0);
387 }
388 bModified = true;
389 }
390 }
391 else
392 {
393 std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(m_xDialog.get(),
394 VclMessageType::Question, VclButtonsType::YesNo,
395 aStrCloselinkmsgMulti));
396 xQueryBox->set_default_response(RET_YES);
397
398 if (RET_YES == xQueryBox->run())
399 {
400 std::vector<int> aRows = m_xTbLinks->get_selected_rows();
401 SvBaseLinkMemberList aLinkList;
402 for (auto nRow : aRows)
403 {
404 SvBaseLink* pLink = reinterpret_cast<SvBaseLink*>(m_xTbLinks->get_id(nRow).toInt64());
405 if (pLink)
406 aLinkList.push_back(pLink);
407 }
408 std::sort(aRows.begin(), aRows.end());
409 for (auto it = aRows.rbegin(); it != aRows.rend(); ++it)
410 m_xTbLinks->remove(*it);
411 for (size_t i = 0; i < aLinkList.size(); ++i)
412 {
413 tools::SvRef<SvBaseLink> xLink = aLinkList[i];
414 // tell the link that it will be resolved!
415 xLink->Closed();
416
417 // if somebody has forgotten to deregister himself
418 pLinkMgr->Remove( xLink.get() );
419 bModified = true;
420 }
421 // then remove all selected entries
422 }
423 }
424 if(!bModified)
425 return;
426
427 if (!m_xTbLinks->n_children())
428 {
429 m_xRbAutomatic->set_sensitive(false);
430 m_xRbManual->set_sensitive(false);
431 m_xPbUpdateNow->set_sensitive(false);
432 m_xPbChangeSource->set_sensitive(false);
433 m_xPbBreakLink->set_sensitive(false);
434
435 m_xFtFullSourceName->set_label( "" );
436 m_xFtFullTypeName->set_label( "" );
437 }
438 if( pLinkMgr && pLinkMgr->GetPersist() )
439 pLinkMgr->GetPersist()->SetModified();
440}
441
442IMPL_LINK_NOARG( SvBaseLinksDlg, UpdateWaitingHdl, Timer*, void )void SvBaseLinksDlg::LinkStubUpdateWaitingHdl(void * instance
, Timer* data) { return static_cast<SvBaseLinksDlg *>(instance
)->UpdateWaitingHdl(data); } void SvBaseLinksDlg::UpdateWaitingHdl
(__attribute__ ((unused)) Timer*)
443{
444 m_xTbLinks->freeze();
445 for (int nPos = m_xTbLinks->n_children(); nPos; --nPos)
446 {
447 tools::SvRef<SvBaseLink> xLink( reinterpret_cast<SvBaseLink*>(m_xTbLinks->get_id(nPos).toInt64()) );
448 if( xLink.is() )
449 {
450 OUString sCur( ImplGetStateStr( *xLink ) ),
451 sOld( m_xTbLinks->get_text(nPos, 3) );
452 if( sCur != sOld )
453 m_xTbLinks->set_text(nPos, sCur, 3);
454 }
455 }
456 m_xTbLinks->thaw();
457}
458
459IMPL_LINK( SvBaseLinksDlg, EndEditHdl, sfx2::SvBaseLink&, _rLink, void )void SvBaseLinksDlg::LinkStubEndEditHdl(void * instance, sfx2
::SvBaseLink& data) { return static_cast<SvBaseLinksDlg
*>(instance)->EndEditHdl(data); } void SvBaseLinksDlg::
EndEditHdl(sfx2::SvBaseLink& _rLink)
460{
461 int nPos;
462 GetSelEntry( &nPos );
463
464 if( !_rLink.WasLastEditOK() )
465 return;
466
467 // StarImpress/Draw swap the LinkObjects themselves!
468 // So search for the link in the manager; if it does not exist
469 // anymore, fill the list completely new. Otherwise only the
470 // edited link needs to be refreshed.
471 bool bLinkFnd = false;
472 for( size_t n = pLinkMgr->GetLinks().size(); n; )
473 if( &_rLink == &(*pLinkMgr->GetLinks()[ --n ]) )
474 {
475 bLinkFnd = true;
476 break;
477 }
478
479 if( bLinkFnd )
480 {
481 m_xTbLinks->remove(nPos);
482 int nToUnselect = m_xTbLinks->get_selected_index();
483 InsertEntry(_rLink, nPos, true);
484 if (nToUnselect != -1)
485 m_xTbLinks->unselect(nToUnselect);
486 }
487 else
488 {
489 LinkManager* pNewMgr = pLinkMgr;
490 pLinkMgr = nullptr;
491 SetManager( pNewMgr );
492 }
493 if (pLinkMgr && pLinkMgr->GetPersist())
494 pLinkMgr->GetPersist()->SetModified();
495}
496
497OUString SvBaseLinksDlg::ImplGetStateStr( const SvBaseLink& rLnk )
498{
499 OUString sRet;
500 if( !rLnk.GetObj() )
501 sRet = aStrBrokenlink;
502 else if( rLnk.GetObj()->IsPending() )
503 {
504 sRet = aStrWaitinglink;
505 aUpdateIdle.Start();
506 }
507 else if( SfxLinkUpdateMode::ALWAYS == rLnk.GetUpdateMode() )
508 sRet = aStrAutolink;
509 else
510 sRet = aStrManuallink;
511
512 return sRet;
513}
514
515void SvBaseLinksDlg::SetManager( LinkManager* pNewMgr )
516{
517 if( pLinkMgr == pNewMgr )
518 return;
519
520 if (pNewMgr)
521 {
522 // update has to be stopped before clear
523 m_xTbLinks->freeze();
524 }
525
526 m_xTbLinks->clear();
527 pLinkMgr = pNewMgr;
528
529 if( !pLinkMgr )
530 return;
531
532 SvBaseLinks& rLnks = const_cast<SvBaseLinks&>(pLinkMgr->GetLinks());
533 for( size_t n = 0; n < rLnks.size(); ++n )
534 {
535 tools::SvRef<SvBaseLink>& rLinkRef = rLnks[ n ];
536 if( !rLinkRef.is() )
537 {
538 rLnks.erase( rLnks.begin() + n );
539 --n;
540 continue;
541 }
542 if( rLinkRef->IsVisible() )
543 InsertEntry( *rLinkRef );
544 }
545
546 m_xTbLinks->thaw();
547
548 if( !rLnks.empty() )
549 {
550 m_xTbLinks->set_cursor(0);
551 m_xTbLinks->select(0);
552 LinksSelectHdl( nullptr );
553 }
554}
555
556void SvBaseLinksDlg::InsertEntry(const SvBaseLink& rLink, int nPos, bool bSelect)
557{
558 OUString sFileNm, sLinkNm, sTypeNm, sFilter;
559
560 sfx2::LinkManager::GetDisplayNames( &rLink, &sTypeNm, &sFileNm, &sLinkNm, &sFilter );
561
562 auto nWidthPixel = m_xTbLinks->get_column_width(0);
563 OUString aTxt = m_xVirDev->GetEllipsisString(sFileNm, nWidthPixel, DrawTextFlags::PathEllipsis);
564 INetURLObject aPath( sFileNm, INetProtocol::File );
565 OUString aFileName = aPath.getName(
566 INetURLObject::LAST_SEGMENT, true, INetURLObject::DecodeMechanism::Unambiguous);
567
568 if( aFileName.getLength() > aTxt.getLength() )
569 aTxt = aFileName;
570 else if (!aFileName.isEmpty() && aTxt.indexOf(aFileName, aTxt.getLength() - aFileName.getLength()) == -1)
571 // filename not in string
572 aTxt = aFileName;
573
574 if (nPos == -1)
575 nPos = m_xTbLinks->n_children();
576 m_xTbLinks->insert(nPos);
577 m_xTbLinks->set_text(nPos, aTxt, 0);
578 m_xTbLinks->set_id(nPos, OUString::number(reinterpret_cast<sal_Int64>(&rLink)));
579 if( SvBaseLinkObjectType::ClientGraphic == rLink.GetObjType() )
580 m_xTbLinks->set_text(nPos, sFilter, 1);
581 else
582 m_xTbLinks->set_text(nPos, sLinkNm, 1);
583 m_xTbLinks->set_text(nPos, sTypeNm, 2);
584 m_xTbLinks->set_text(nPos, ImplGetStateStr(rLink), 3);
585 if (bSelect)
586 m_xTbLinks->select(nPos);
587}
588
589SvBaseLink* SvBaseLinksDlg::GetSelEntry(int* pPos)
590{
591 int nPos = m_xTbLinks->get_selected_index();
592 if (nPos != -1)
593 {
594 if (pPos)
595 *pPos = nPos;
596 return reinterpret_cast<SvBaseLink*>(m_xTbLinks->get_id(nPos).toInt64());
597 }
598 return nullptr;
599}
600
601void SvBaseLinksDlg::SetType(SvBaseLink& rLink,
602 int nSelPos,
603 SfxLinkUpdateMode nType)
604{
605 rLink.SetUpdateMode( nType );
606 rLink.Update();
607 m_xTbLinks->set_text(nSelPos, ImplGetStateStr(rLink), 3);
608 if (pLinkMgr->GetPersist())
609 pLinkMgr->GetPersist()->SetModified();
610}
611
612void SvBaseLinksDlg::SetActLink( SvBaseLink const * pLink )
613{
614 if( !pLinkMgr )
615 return;
616
617 const SvBaseLinks& rLnks = pLinkMgr->GetLinks();
618 int nSelect = 0;
619 for(const auto & rLinkRef : rLnks)
620 {
621 // #109573# only visible links have been inserted into the TreeListBox,
622 // invisible ones have to be skipped here
623 if( rLinkRef->IsVisible() )
624 {
625 if( pLink == rLinkRef.get() )
626 {
627 m_xTbLinks->select(nSelect);
628 LinksSelectHdl( nullptr );
629 return ;
630 }
631 ++nSelect;
632 }
633 }
634}
635
636/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

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

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

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