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 bookmark.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 EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sw/inc -I /home/maarten/src/libreoffice/core/sw/source/uibase/inc -I /home/maarten/src/libreoffice/core/sw/source/ui/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sw/sdi -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/oovbaapi/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/sw/source/ui/misc/bookmark.cxx

/home/maarten/src/libreoffice/core/sw/source/ui/misc/bookmark.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 <rtl/ustrbuf.hxx>
21#include <sfx2/request.hxx>
22#include <svl/stritem.hxx>
23#include <vcl/weld.hxx>
24#include <com/sun/star/frame/XModel.hpp>
25#include <com/sun/star/text/XBookmarksSupplier.hpp>
26
27#include <swabstdlg.hxx>
28#include <swuiexp.hxx>
29#include <view.hxx>
30#include <wrtsh.hxx>
31#include <cmdid.h>
32#include <bookmark.hxx>
33#include <docsh.hxx>
34#include <ndtxt.hxx>
35#include <strings.hrc>
36#include <svtools/miscopt.hxx>
37#include <IDocumentSettingAccess.hxx>
38
39using namespace ::com::sun::star;
40
41const char BookmarkTable::cSeparator(';');
42
43// callback to modify EditBox
44IMPL_LINK_NOARG(SwInsertBookmarkDlg, ModifyHdl, weld::Entry&, void)void SwInsertBookmarkDlg::LinkStubModifyHdl(void * instance, weld
::Entry& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->ModifyHdl(data); } void SwInsertBookmarkDlg
::ModifyHdl(__attribute__ ((unused)) weld::Entry&)
45{
46 ValidateBookmarks();
47 m_xBookmarksBox->unselect_all();
48 // if a string has been pasted from the clipboard then
49 // there may be illegal characters in the box
50 // sanitization
51 OUString sTmp = m_xEditBox->get_text();
52 OUString sMsg;
53 const sal_Int32 nLen = sTmp.getLength();
54 for (sal_Int32 i = 0; i < BookmarkTable::aForbiddenChars.getLength(); i++)
55 {
56 const sal_Int32 nTmpLen = sTmp.getLength();
57 sTmp = sTmp.replaceAll(OUStringChar(BookmarkTable::aForbiddenChars.getStr()[i]), "");
58 if (sTmp.getLength() != nTmpLen)
59 sMsg += OUStringChar(BookmarkTable::aForbiddenChars.getStr()[i]);
60 }
61 const bool bHasForbiddenChars = sTmp.getLength() != nLen;
62 m_xForbiddenChars->set_visible(bHasForbiddenChars);
63 if (bHasForbiddenChars)
64 m_xEditBox->set_message_type(weld::EntryMessageType::Error);
65 else
66 m_xEditBox->set_message_type(weld::EntryMessageType::Normal);
67
68 sal_Int32 nSelectedEntries = 0;
69 sal_Int32 nEntries = 0;
70 sal_Int32 nTokenIndex = 0;
71 while (!sTmp.isEmpty() && nTokenIndex >= 0)
72 {
73 OUString aToken = sTmp.getToken(0, BookmarkTable::cSeparator, nTokenIndex);
74 if (m_xBookmarksBox->GetBookmarkByName(aToken))
75 {
76 m_xBookmarksBox->SelectByName(aToken);
77 nSelectedEntries++;
78 }
79 nEntries++;
80 }
81
82 // allow to add new bookmark only if one name provided and it's not taken
83 m_xInsertBtn->set_sensitive(nEntries == 1 && nSelectedEntries == 0 && !bHasForbiddenChars && !m_bAreProtected);
84
85 // allow to delete only if all bookmarks are recognized
86 m_xDeleteBtn->set_sensitive(nEntries > 0 && nSelectedEntries == nEntries && !m_bAreProtected);
87 m_xGotoBtn->set_sensitive(nEntries == 1 && nSelectedEntries == 1);
88 m_xRenameBtn->set_sensitive(nEntries == 1 && nSelectedEntries == 1 && !m_bAreProtected);
89}
90
91// callback to delete a text mark
92IMPL_LINK_NOARG(SwInsertBookmarkDlg, DeleteHdl, weld::Button&, void)void SwInsertBookmarkDlg::LinkStubDeleteHdl(void * instance, weld
::Button& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->DeleteHdl(data); } void SwInsertBookmarkDlg
::DeleteHdl(__attribute__ ((unused)) weld::Button&)
93{
94 if (!ValidateBookmarks())
95 return;
96
97 int nSelectedRows(0);
98
99 m_xBookmarksBox->selected_foreach([this, &nSelectedRows](weld::TreeIter& rEntry){
100 // remove from model
101 sw::mark::IMark* pBookmark = reinterpret_cast<sw::mark::IMark*>(m_xBookmarksBox->get_id(rEntry).toInt64());
102 OUString sRemoved = pBookmark->GetName();
103 IDocumentMarkAccess* const pMarkAccess = rSh.getIDocumentMarkAccess();
104 pMarkAccess->deleteMark(pMarkAccess->findMark(sRemoved));
105 SfxRequest aReq(rSh.GetView().GetViewFrame(), FN_DELETE_BOOKMARK((20000 + 300) + 1));
106 aReq.AppendItem(SfxStringItem(FN_DELETE_BOOKMARK((20000 + 300) + 1), sRemoved));
107 aReq.Done();
108 aTableBookmarks.erase(std::remove(aTableBookmarks.begin(), aTableBookmarks.end(),
109 std::make_pair(pBookmark, sRemoved)), aTableBookmarks.end());
110
111 ++nSelectedRows;
112
113 return false;
114 });
115
116 if (!nSelectedRows)
117 return;
118
119 // remove from BookmarkTable
120 m_xBookmarksBox->remove_selection();
121
122 ValidateBookmarks();
123
124 m_xDeleteBtn->set_sensitive(false);
125 m_xGotoBtn->set_sensitive(false);
126 m_xRenameBtn->set_sensitive(false);
127 m_xInsertBtn->set_sensitive(false);
128}
129
130// callback to a goto button
131IMPL_LINK_NOARG(SwInsertBookmarkDlg, GotoHdl, weld::Button&, void)void SwInsertBookmarkDlg::LinkStubGotoHdl(void * instance, weld
::Button& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->GotoHdl(data); } void SwInsertBookmarkDlg
::GotoHdl(__attribute__ ((unused)) weld::Button&)
132{
133 GotoSelectedBookmark();
134}
135
136IMPL_LINK_NOARG(SwInsertBookmarkDlg, DoubleClickHdl, weld::TreeView&, bool)bool SwInsertBookmarkDlg::LinkStubDoubleClickHdl(void * instance
, weld::TreeView& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->DoubleClickHdl(data); } bool SwInsertBookmarkDlg
::DoubleClickHdl(__attribute__ ((unused)) weld::TreeView&
)
137{
138 GotoSelectedBookmark();
139 return true;
140}
141
142IMPL_LINK_NOARG(SwInsertBookmarkDlg, SelectionChangedHdl, weld::TreeView&, void)void SwInsertBookmarkDlg::LinkStubSelectionChangedHdl(void * instance
, weld::TreeView& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->SelectionChangedHdl(data); } void SwInsertBookmarkDlg
::SelectionChangedHdl(__attribute__ ((unused)) weld::TreeView
&)
143{
144 if (!ValidateBookmarks())
145 return;
146 // this event should fired only if we change selection by clicking on BookmarkTable entry
147 if (!m_xBookmarksBox->has_focus())
148 return;
149
150 OUStringBuffer sEditBoxText;
151 int nSelectedRows = 0;
152 m_xBookmarksBox->selected_foreach([this, &sEditBoxText, &nSelectedRows](weld::TreeIter& rEntry){
153 sw::mark::IMark* pBookmark = reinterpret_cast<sw::mark::IMark*>(m_xBookmarksBox->get_id(rEntry).toInt64());
154 const OUString& sEntryName = pBookmark->GetName();
155 if (!sEditBoxText.isEmpty())
156 sEditBoxText.append(";");
157 sEditBoxText.append(sEntryName);
158 ++nSelectedRows;
159 return false;
160 });
161 if (nSelectedRows)
162 {
163 m_xInsertBtn->set_sensitive(false);
164 m_xGotoBtn->set_sensitive(nSelectedRows == 1);
165 m_xRenameBtn->set_sensitive(nSelectedRows == 1 && !m_bAreProtected);
166 m_xDeleteBtn->set_sensitive(!m_bAreProtected);
167 m_xEditBox->set_text(sEditBoxText.makeStringAndClear());
168 }
169 else
170 {
171 m_xInsertBtn->set_sensitive(!m_bAreProtected);
172 m_xGotoBtn->set_sensitive(false);
173 m_xRenameBtn->set_sensitive(false);
174 m_xDeleteBtn->set_sensitive(false);
175 }
176}
177
178IMPL_LINK_NOARG(SwInsertBookmarkDlg, RenameHdl, weld::Button&, void)void SwInsertBookmarkDlg::LinkStubRenameHdl(void * instance, weld
::Button& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->RenameHdl(data); } void SwInsertBookmarkDlg
::RenameHdl(__attribute__ ((unused)) weld::Button&)
1
Calling 'SwInsertBookmarkDlg::RenameHdl'
→
179{
180 if (!ValidateBookmarks())
2
←
Taking false branch
→
181 return;
182 auto xSelected = m_xBookmarksBox->get_selected();
183 if (!xSelected)
3
←
Taking false branch
→
184 return;
185
186 sw::mark::IMark* pBookmark = reinterpret_cast<sw::mark::IMark*>(m_xBookmarksBox->get_id(*xSelected).toInt64());
187 uno::Reference<frame::XModel> xModel = rSh.GetView().GetDocShell()->GetBaseModel();
188 uno::Reference<text::XBookmarksSupplier> xBkms(xModel, uno::UNO_QUERY);
189 uno::Reference<container::XNameAccess> xNameAccess = xBkms->getBookmarks();
190 uno::Any aObj = xNameAccess->getByName(pBookmark->GetName());
191 uno::Reference<uno::XInterface> xTmp;
192 aObj >>= xTmp;
193 uno::Reference<container::XNamed> xNamed(xTmp, uno::UNO_QUERY);
194 SwAbstractDialogFactory& rFact = swui::GetFactory();
195 ScopedVclPtr<AbstractSwRenameXNamedDlg> pDlg(rFact.CreateSwRenameXNamedDlg(m_xDialog.get(), xNamed, xNameAccess));
4
←
Calling constructor for 'ScopedVclPtr<AbstractSwRenameXNamedDlg>'
→
11
←
Returning from constructor for 'ScopedVclPtr<AbstractSwRenameXNamedDlg>'
→
12
←
Calling implicit destructor for 'VclPtr<AbstractSwRenameXNamedDlg>'
→
13
←
Calling '~Reference'
→
20
←
Returning from '~Reference'
→
21
←
Returning from destructor for 'VclPtr<AbstractSwRenameXNamedDlg>'
→
196 pDlg->SetForbiddenChars(BookmarkTable::aForbiddenChars + OUStringChar(BookmarkTable::cSeparator));
22
←
Calling 'VclPtr::operator->'
→
197
198 if (pDlg->Execute())
199 {
200 ValidateBookmarks();
201 m_xDeleteBtn->set_sensitive(false);
202 m_xGotoBtn->set_sensitive(false);
203 m_xRenameBtn->set_sensitive(false);
204 m_xInsertBtn->set_sensitive(false);
205 }
206}
207
208// callback to an insert button. Inserts a new text mark to the current position.
209IMPL_LINK_NOARG(SwInsertBookmarkDlg, InsertHdl, weld::Button&, void)void SwInsertBookmarkDlg::LinkStubInsertHdl(void * instance, weld
::Button& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->InsertHdl(data); } void SwInsertBookmarkDlg
::InsertHdl(__attribute__ ((unused)) weld::Button&)
210{
211 OUString sBookmark = m_xEditBox->get_text();
212 rSh.SetBookmark2(vcl::KeyCode(), sBookmark, m_xHideCB->get_active(), m_xConditionED->get_text());
213
214 m_xDialog->response(RET_OK);
215}
216
217IMPL_LINK(SwInsertBookmarkDlg, ChangeHideHdl, weld::ToggleButton&, rBox, void)void SwInsertBookmarkDlg::LinkStubChangeHideHdl(void * instance
, weld::ToggleButton& data) { return static_cast<SwInsertBookmarkDlg
*>(instance)->ChangeHideHdl(data); } void SwInsertBookmarkDlg
::ChangeHideHdl(weld::ToggleButton& rBox)
218{
219 bool bHide = rBox.get_active();
220 m_xConditionED->set_sensitive(bHide);
221 m_xConditionFT->set_sensitive(bHide);
222}
223
224void SwInsertBookmarkDlg::GotoSelectedBookmark()
225{
226 if (!ValidateBookmarks())
227 return;
228 // if no entries selected we can't jump anywhere
229 // shouldn't be needed as we disable GoTo button when jump is not possible
230 auto xSelected = m_xBookmarksBox->get_selected();
231 if (!xSelected)
232 return;
233
234 sw::mark::IMark* pBookmark = reinterpret_cast<sw::mark::IMark*>(m_xBookmarksBox->get_id(*xSelected).toInt64());
235
236 rSh.EnterStdMode();
237 rSh.GotoMark(pBookmark);
238}
239
240bool SwInsertBookmarkDlg::ValidateBookmarks()
241{
242 if (HaveBookmarksChanged())
243 {
244 PopulateTable();
245 m_xEditBox->set_text("");
246 return false;
247 }
248 return true;
249}
250
251bool SwInsertBookmarkDlg::HaveBookmarksChanged()
252{
253 IDocumentMarkAccess* const pMarkAccess = rSh.getIDocumentMarkAccess();
254 if (pMarkAccess->getBookmarksCount() != m_nLastBookmarksCount)
255 return true;
256
257 std::vector<std::pair<sw::mark::IMark*, OUString>>::const_iterator aListIter = aTableBookmarks.begin();
258 for (IDocumentMarkAccess::const_iterator_t ppBookmark = pMarkAccess->getBookmarksBegin();
259 ppBookmark != pMarkAccess->getBookmarksEnd(); ++ppBookmark)
260 {
261 if (IDocumentMarkAccess::MarkType::BOOKMARK == IDocumentMarkAccess::GetType(**ppBookmark))
262 {
263 // more bookmarks then expected
264 if (aListIter == aTableBookmarks.end())
265 return true;
266 if (aListIter->first != *ppBookmark ||
267 aListIter->second != (*ppBookmark)->GetName())
268 return true;
269 ++aListIter;
270 }
271 }
272 // less bookmarks then expected
273 return aListIter != aTableBookmarks.end();
274}
275
276void SwInsertBookmarkDlg::PopulateTable()
277{
278 aTableBookmarks.clear();
279 m_xBookmarksBox->clear();
280
281 IDocumentMarkAccess* const pMarkAccess = rSh.getIDocumentMarkAccess();
282 for (IDocumentMarkAccess::const_iterator_t ppBookmark = pMarkAccess->getBookmarksBegin();
283 ppBookmark != pMarkAccess->getBookmarksEnd(); ++ppBookmark)
284 {
285 if (IDocumentMarkAccess::MarkType::BOOKMARK == IDocumentMarkAccess::GetType(**ppBookmark))
286 {
287 m_xBookmarksBox->InsertBookmark(*ppBookmark);
288 aTableBookmarks.emplace_back(*ppBookmark, (*ppBookmark)->GetName());
289 }
290 }
291 m_nLastBookmarksCount = pMarkAccess->getBookmarksCount();
292}
293
294SwInsertBookmarkDlg::SwInsertBookmarkDlg(weld::Window* pParent, SwWrtShell& rS)
295 : SfxDialogController(pParent, "modules/swriter/ui/insertbookmark.ui", "InsertBookmarkDialog")
296 , rSh(rS)
297 , m_nLastBookmarksCount(0)
298 , m_bSorted(false)
299 , m_xEditBox(m_xBuilder->weld_entry("name"))
300 , m_xInsertBtn(m_xBuilder->weld_button("insert"))
301 , m_xDeleteBtn(m_xBuilder->weld_button("delete"))
302 , m_xGotoBtn(m_xBuilder->weld_button("goto"))
303 , m_xRenameBtn(m_xBuilder->weld_button("rename"))
304 , m_xHideCB(m_xBuilder->weld_check_button("hide"))
305 , m_xConditionFT(m_xBuilder->weld_label("condlabel"))
306 , m_xConditionED(new ConditionEdit(m_xBuilder->weld_entry("withcond")))
307 , m_xBookmarksBox(new BookmarkTable(m_xBuilder->weld_tree_view("bookmarks")))
308 , m_xForbiddenChars(m_xBuilder->weld_label("lbForbiddenChars"))
309{
310 m_xBookmarksBox->connect_changed(LINK(this, SwInsertBookmarkDlg, SelectionChangedHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubSelectionChangedHdl
));
311 m_xBookmarksBox->connect_row_activated(LINK(this, SwInsertBookmarkDlg, DoubleClickHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubDoubleClickHdl
));
312 m_xBookmarksBox->connect_column_clicked(LINK(this, SwInsertBookmarkDlg, HeaderBarClick)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubHeaderBarClick
));
313 m_xEditBox->connect_changed(LINK(this, SwInsertBookmarkDlg, ModifyHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubModifyHdl));
314 m_xInsertBtn->connect_clicked(LINK(this, SwInsertBookmarkDlg, InsertHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubInsertHdl));
315 m_xDeleteBtn->connect_clicked(LINK(this, SwInsertBookmarkDlg, DeleteHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubDeleteHdl));
316 m_xGotoBtn->connect_clicked(LINK(this, SwInsertBookmarkDlg, GotoHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubGotoHdl));
317 m_xRenameBtn->connect_clicked(LINK(this, SwInsertBookmarkDlg, RenameHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubRenameHdl));
318 m_xHideCB->connect_toggled(LINK(this, SwInsertBookmarkDlg, ChangeHideHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwInsertBookmarkDlg
*>(this), &SwInsertBookmarkDlg::LinkStubChangeHideHdl
));
319
320 m_xDeleteBtn->set_sensitive(false);
321 m_xGotoBtn->set_sensitive(false);
322 m_xRenameBtn->set_sensitive(false);
323
324 PopulateTable();
325
326 m_xEditBox->set_text(m_xBookmarksBox->GetNameProposal());
327 m_xEditBox->set_position(-1);
328
329 m_xForbiddenChars->set_label(SwResId(STR_BOOKMARK_FORBIDDENCHARSreinterpret_cast<char const *>("STR_BOOKMARK_FORBIDDENCHARS"
"\004" u8"Forbidden characters:")) + " " + BookmarkTable::aForbiddenChars);
330 m_xForbiddenChars->set_visible(false);
331
332 SvtMiscOptions aMiscOpt;
333 if ( !aMiscOpt.IsExperimentalMode() )
334 {
335 m_xHideCB->set_visible( false );
336 m_xConditionFT->set_visible( false );
337 m_xConditionED->set_visible( false );
338 }
339
340 m_bAreProtected = rSh.getIDocumentSettingAccess().get(DocumentSettingId::PROTECT_BOOKMARKS);
341
342 // disabled until "Hide" flag is not checked
343 m_xConditionED->set_sensitive(false);
344 m_xConditionFT->set_sensitive(false);
345}
346
347IMPL_LINK(SwInsertBookmarkDlg, HeaderBarClick, int, nColumn, void)void SwInsertBookmarkDlg::LinkStubHeaderBarClick(void * instance
, int data) { return static_cast<SwInsertBookmarkDlg *>
(instance)->HeaderBarClick(data); } void SwInsertBookmarkDlg
::HeaderBarClick(int nColumn)
348{
349 if (!m_bSorted)
350 {
351 m_xBookmarksBox->make_sorted();
352 m_bSorted = true;
353 }
354
355 bool bSortAtoZ = m_xBookmarksBox->get_sort_order();
356
357 //set new arrow positions in headerbar
358 if (nColumn == m_xBookmarksBox->get_sort_column())
359 {
360 bSortAtoZ = !bSortAtoZ;
361 m_xBookmarksBox->set_sort_order(bSortAtoZ);
362 }
363 else
364 {
365 int nOldSortColumn = m_xBookmarksBox->get_sort_column();
366 if (nOldSortColumn != -1)
367 m_xBookmarksBox->set_sort_indicator(TRISTATE_INDET, nOldSortColumn);
368 m_xBookmarksBox->set_sort_column(nColumn);
369 }
370
371 if (nColumn != -1)
372 {
373 //sort lists
374 m_xBookmarksBox->set_sort_indicator(bSortAtoZ ? TRISTATE_TRUE : TRISTATE_FALSE, nColumn);
375 }
376}
377
378SwInsertBookmarkDlg::~SwInsertBookmarkDlg()
379{
380}
381
382BookmarkTable::BookmarkTable(std::unique_ptr<weld::TreeView> xControl)
383 : m_xControl(std::move(xControl))
384{
385 m_xControl->set_size_request(450, 250);
386 std::vector<int> aWidths;
387 aWidths.push_back(40);
388 aWidths.push_back(110);
389 aWidths.push_back(150);
390 aWidths.push_back(60);
391 m_xControl->set_column_fixed_widths(aWidths);
392 m_xControl->set_selection_mode(SelectionMode::Multiple);
393}
394
395std::unique_ptr<weld::TreeIter> BookmarkTable::get_selected() const
396{
397 std::unique_ptr<weld::TreeIter> xIter(m_xControl->make_iterator());
398 if (!m_xControl->get_selected(xIter.get()))
399 xIter.reset();
400 return xIter;
401}
402
403void BookmarkTable::InsertBookmark(sw::mark::IMark* pMark)
404{
405 sw::mark::IBookmark* pBookmark = dynamic_cast<sw::mark::IBookmark*>(pMark);
406 assert(pBookmark)(static_cast <bool> (pBookmark) ? void (0) : __assert_fail
("pBookmark", "/home/maarten/src/libreoffice/core/sw/source/ui/misc/bookmark.cxx"
, 406, __extension__ __PRETTY_FUNCTION__));
407
408 OUString sBookmarkNodeText = pBookmark->GetMarkStart().nNode.GetNode().GetTextNode()->GetText();
409 sal_Int32 nBookmarkNodeTextPos = pBookmark->GetMarkStart().nContent.GetIndex();
410 sal_Int32 nBookmarkTextLen = 0;
411 bool bPulledAll = false;
412 bool bPulling = false;
413 static const sal_Int32 nMaxTextLen = 50;
414
415 if (pBookmark->IsExpanded())
416 {
417 nBookmarkTextLen = pBookmark->GetMarkEnd().nContent.GetIndex() - nBookmarkNodeTextPos;
418 }
419 else
420 {
421 if (nBookmarkNodeTextPos == sBookmarkNodeText.getLength()) // no text after bookmark
422 {
423 nBookmarkNodeTextPos = std::max<sal_Int32>(0, nBookmarkNodeTextPos - nMaxTextLen);
424 bPulling = true;
425 if (nBookmarkNodeTextPos == 0)
426 bPulledAll = true;
427 }
428 nBookmarkTextLen = sBookmarkNodeText.getLength() - nBookmarkNodeTextPos;
429 }
430 bool bExceedsLength = nBookmarkTextLen > nMaxTextLen;
431 nBookmarkTextLen = std::min<sal_Int32>(nMaxTextLen, nBookmarkTextLen);
432 sBookmarkNodeText = sBookmarkNodeText.copy(nBookmarkNodeTextPos, nBookmarkTextLen).trim();
433 if (bExceedsLength)
434 sBookmarkNodeText += "...";
435 else if (bPulling && !bPulledAll)
436 sBookmarkNodeText = "..." + sBookmarkNodeText;
437
438 OUString sHidden = SwResId(STR_BOOKMARK_NOreinterpret_cast<char const *>("STR_BOOKMARK_NO" "\004"
u8"No"));
439 if (pBookmark->IsHidden())
440 sHidden = SwResId(STR_BOOKMARK_YESreinterpret_cast<char const *>("STR_BOOKMARK_YES" "\004"
u8"Yes"));
441 const OUString& sHideCondition = pBookmark->GetHideCondition();
442 OUString sPageNum = OUString::number(SwPaM(pMark->GetMarkStart()).GetPageNum());
443 int nRow = m_xControl->n_children();
444 m_xControl->append(OUString::number(reinterpret_cast<sal_Int64>(pMark)), sPageNum);
445 m_xControl->set_text(nRow, pBookmark->GetName(), 1);
446 m_xControl->set_text(nRow, sBookmarkNodeText, 2);
447 m_xControl->set_text(nRow, sHidden, 3);
448 m_xControl->set_text(nRow, sHideCondition, 4);
449}
450
451std::unique_ptr<weld::TreeIter> BookmarkTable::GetRowByBookmarkName(const OUString& sName)
452{
453 std::unique_ptr<weld::TreeIter> xRet;
454 m_xControl->all_foreach([this, &sName, &xRet](weld::TreeIter& rEntry){
455 sw::mark::IMark* pBookmark = reinterpret_cast<sw::mark::IMark*>(m_xControl->get_id(rEntry).toInt64());
456 if (pBookmark->GetName() == sName)
457 {
458 xRet = m_xControl->make_iterator(&rEntry);
459 return true;
460 }
461 return false;
462 });
463 return xRet;
464}
465
466sw::mark::IMark* BookmarkTable::GetBookmarkByName(const OUString& sName)
467{
468 auto xEntry = GetRowByBookmarkName(sName);
469 if (!xEntry)
470 return nullptr;
471
472 return reinterpret_cast<sw::mark::IMark*>(m_xControl->get_id(*xEntry).toInt64());
473}
474
475void BookmarkTable::SelectByName(const OUString& sName)
476{
477 auto xEntry = GetRowByBookmarkName(sName);
478 if (!xEntry)
479 return;
480 select(*xEntry);
481}
482
483OUString BookmarkTable::GetNameProposal() const
484{
485 OUString sDefaultBookmarkName = SwResId(STR_BOOKMARK_DEF_NAMEreinterpret_cast<char const *>("STR_BOOKMARK_DEF_NAME" "\004"
u8"Bookmark"));
486 sal_Int32 nHighestBookmarkId = 0;
487 for (int i = 0, nCount = m_xControl->n_children(); i < nCount; ++i)
488 {
489 sw::mark::IMark* pBookmark = reinterpret_cast<sw::mark::IMark*>(m_xControl->get_id(i).toInt64());
490 const OUString& sName = pBookmark->GetName();
491 sal_Int32 nIndex = 0;
492 if (sName.getToken(0, ' ', nIndex) == sDefaultBookmarkName)
493 {
494 sal_Int32 nCurrBookmarkId = sName.getToken(0, ' ', nIndex).toInt32();
495 nHighestBookmarkId = std::max<sal_Int32>(nHighestBookmarkId, nCurrBookmarkId);
496 }
497 }
498 return sDefaultBookmarkName + " " + OUString::number(nHighestBookmarkId + 1);
499}
500
501/* 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();
23
←
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)
5
←
Calling implicit copy constructor for 'VclPtr<AbstractSwRenameXNamedDlg>'
→
6
←
Calling copy constructor for 'Reference<AbstractSwRenameXNamedDlg>'
→
9
←
Returning from copy constructor for 'Reference<AbstractSwRenameXNamedDlg>'
→
10
←
Returning from copy constructor for 'VclPtr<AbstractSwRenameXNamedDlg>'
→
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)
7
←
Assuming field 'm_pBody' is non-null
→
8
←
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
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
)
14
←
Taking true branch
→
113 m_pBody->release();
15
←
Calling 'VclReferenceBase::release'
→
19
←
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;
24
←
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)
16
←
Assuming the condition is true
→
17
←
Taking true branch
→
40 delete this;
18
←
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