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 indexdialog.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D DBACCESS_DLLIMPLEMENTATION -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/external/unixODBC/inc -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/dbaccess/inc -I /home/maarten/src/libreoffice/core/dbaccess/source/inc -I /home/maarten/src/libreoffice/core/dbaccess/source/ui/inc -I /home/maarten/src/libreoffice/core/workdir/YaccTarget/connectivity/source/parse -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx

/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.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 <sal/config.h>
21
22#include <set>
23
24#include <core_resource.hxx>
25#include <indexdialog.hxx>
26#include <strings.hrc>
27#include <bitmaps.hlst>
28#include <indexfieldscontrol.hxx>
29#include <indexcollection.hxx>
30#include <vcl/svapp.hxx>
31#include <vcl/weld.hxx>
32#include <com/sun/star/sdb/SQLContext.hpp>
33#include <connectivity/dbtools.hxx>
34#include <osl/diagnose.h>
35
36namespace dbaui
37{
38
39 using namespace ::com::sun::star::uno;
40 using namespace ::com::sun::star::container;
41 using namespace ::com::sun::star::sdbc;
42 using namespace ::com::sun::star::sdb;
43 using namespace ::com::sun::star::lang;
44 using namespace ::dbtools;
45
46 // helper
47 static bool operator ==(const OIndexField& _rLHS, const OIndexField& _rRHS)
48 {
49 return (_rLHS.sFieldName == _rRHS.sFieldName)
50 && (_rLHS.bSortAscending == _rRHS.bSortAscending);
51 }
52
53 static bool operator ==(const IndexFields& _rLHS, const IndexFields& _rRHS)
54 {
55 return std::equal(_rLHS.begin(), _rLHS.end(), _rRHS.begin(), _rRHS.end());
56 }
57
58 static bool operator !=(const IndexFields& _rLHS, const IndexFields& _rRHS)
59 {
60 return !(_rLHS == _rRHS);
61 }
62
63 // DbaIndexDialog
64 DbaIndexDialog::DbaIndexDialog(weld::Window* pParent, const Sequence< OUString >& _rFieldNames,
65 const Reference< XNameAccess >& _rxIndexes,
66 const Reference< XConnection >& _rxConnection,
67 const Reference< XComponentContext >& _rxContext)
68 : GenericDialogController(pParent, "dbaccess/ui/indexdesigndialog.ui", "IndexDesignDialog")
69 , m_xConnection(_rxConnection)
70 , m_bEditingActive(false)
71 , m_bEditAgain(false)
72 , m_bNoHandlerCall(false)
73 , m_xContext(_rxContext)
74 , m_xActions(m_xBuilder->weld_toolbar("ACTIONS"))
75 , m_xIndexList(m_xBuilder->weld_tree_view("INDEX_LIST"))
76 , m_xIndexDetails(m_xBuilder->weld_label("INDEX_DETAILS"))
77 , m_xDescriptionLabel(m_xBuilder->weld_label("DESC_LABEL"))
78 , m_xDescription(m_xBuilder->weld_label("DESCRIPTION"))
79 , m_xUnique(m_xBuilder->weld_check_button("UNIQUE"))
80 , m_xFieldsLabel(m_xBuilder->weld_label("FIELDS_LABEL"))
81 , m_xClose(m_xBuilder->weld_button("close"))
82 , m_xTable(m_xBuilder->weld_container("FIELDS"))
83 , m_xTableCtrlParent(m_xTable->CreateChildFrame())
84 , m_xFields(VclPtr<IndexFieldsControl>::Create(m_xTableCtrlParent))
85 {
86 m_xIndexList->set_size_request(m_xIndexList->get_approximate_digit_width() * 17,
87 m_xIndexList->get_height_rows(12));
88
89 int nWidth = m_xIndexList->get_approximate_digit_width() * 60;
90 int nHeight = m_xIndexList->get_height_rows(8);
91 m_xTable->set_size_request(nWidth, nHeight);
92
93 m_xActions->connect_clicked(LINK(this, DbaIndexDialog, OnIndexAction)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnIndexAction));
94
95 m_xIndexList->connect_changed(LINK(this, DbaIndexDialog, OnIndexSelected)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnIndexSelected));
96 m_xIndexList->connect_editing(LINK(this, DbaIndexDialog, OnEntryEditing)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnEntryEditing),
97 LINK(this, DbaIndexDialog, OnEntryEdited)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnEntryEdited));
98
99 m_xFields->SetSizePixel(Size(nWidth, 100));
100 m_xFields->Init(_rFieldNames, ::dbtools::getBooleanDataSourceSetting( m_xConnection, "AddIndexAppendix" ));
101 m_xFields->Show();
102
103 m_xIndexes.reset(new OIndexCollection());
104 try
105 {
106 m_xIndexes->attach(_rxIndexes);
107 }
108 catch(SQLException& e)
109 {
110 ::dbtools::showError(SQLExceptionInfo(e), pParent->GetXWindow(), _rxContext);
111 }
112 catch(Exception&)
113 {
114 OSL_FAIL("DbaIndexDialog::DbaIndexDialog: could not retrieve basic information from the UNO collection!")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "114" ": "), "%s", "DbaIndexDialog::DbaIndexDialog: could not retrieve basic information from the UNO collection!"
); } } while (false);
115 }
116
117 fillIndexList();
118
119 m_xUnique->connect_clicked(LINK(this, DbaIndexDialog, OnModifiedClick)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnModifiedClick));
120 m_xFields->SetModifyHdl(LINK(this, DbaIndexDialog, OnModified)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnModified));
121
122 m_xClose->connect_clicked(LINK(this, DbaIndexDialog, OnCloseDialog)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnCloseDialog));
123
124 // if all of the indexes have an empty description, we're not interested in displaying it
125 bool bFound = false;
126 for (auto const& check : *m_xIndexes)
127 {
128 if (!check.sDescription.isEmpty())
129 {
130 bFound = true;
131 break;
132 }
133 }
134 if (!bFound)
135 {
136 // hide the controls which are necessary for the description
137 m_xDescription->hide();
138 m_xDescriptionLabel->hide();
139 }
140 }
141
142 void DbaIndexDialog::updateToolbox()
143 {
144 m_xActions->set_item_sensitive("ID_INDEX_NEW", !m_bEditingActive);
145
146 int nSelected = m_xIndexList->get_selected_index();
147 bool bSelectedAnything = nSelected != -1;
148 if (bSelectedAnything)
149 {
150 // is the current entry modified?
151 Indexes::const_iterator aSelectedPos = m_xIndexes->begin() + m_xIndexList->get_id(nSelected).toUInt32();
152 m_xActions->set_item_sensitive("ID_INDEX_SAVE", aSelectedPos->isModified() || aSelectedPos->isNew());
153 m_xActions->set_item_sensitive("ID_INDEX_RESET", aSelectedPos->isModified() || aSelectedPos->isNew());
154 bSelectedAnything = !aSelectedPos->bPrimaryKey;
155 }
156 else
157 {
158 m_xActions->set_item_sensitive("ID_INDEX_SAVE", false);
159 m_xActions->set_item_sensitive("ID_INDEX_RESET", false);
160 }
161 m_xActions->set_item_sensitive("ID_INDEX_DROP", bSelectedAnything);
162 m_xActions->set_item_sensitive("ID_INDEX_RENAME", bSelectedAnything);
163 }
164
165 void DbaIndexDialog::fillIndexList()
166 {
167 OUString aPKeyIcon(BMP_PKEYICON"dbaccess/res/pkey.png");
168 // fill the list with the index names
169 m_xIndexList->clear();
170 sal_uInt32 nPos = 0;
171 for (auto const& indexLoop : *m_xIndexes)
172 {
173 m_xIndexList->append(OUString::number(nPos), indexLoop.sName);
174 if (indexLoop.bPrimaryKey)
175 m_xIndexList->set_image(nPos, aPKeyIcon);
176 ++nPos;
177 }
178
179 if (nPos)
180 m_xIndexList->select(0);
181
182 IndexSelected();
183 }
184
185 DbaIndexDialog::~DbaIndexDialog( )
186 {
187 m_xIndexes.reset();
188 m_xFields.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
189 m_xTableCtrlParent->dispose();
190 m_xTableCtrlParent.clear();
191 }
192
193 bool DbaIndexDialog::implCommit(const weld::TreeIter* pEntry)
194 {
195 assert(pEntry && "DbaIndexDialog::implCommit: invalid entry!")(static_cast <bool> (pEntry && "DbaIndexDialog::implCommit: invalid entry!"
) ? void (0) : __assert_fail ("pEntry && \"DbaIndexDialog::implCommit: invalid entry!\""
, "/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
, 195, __extension__ __PRETTY_FUNCTION__));
196
197 Indexes::iterator aCommitPos = m_xIndexes->begin() + m_xIndexList->get_id(*pEntry).toUInt32();
198
199 // if it's not a new index, remove it
200 // (we can't modify indexes, only drop'n'insert)
201 if (!aCommitPos->isNew())
202 if (!implDropIndex(pEntry, false))
203 return false;
204
205 // create the new index
206 SQLExceptionInfo aExceptionInfo;
207 try
208 {
209 m_xIndexes->commitNewIndex(aCommitPos);
210 }
211 catch(SQLContext& e) { aExceptionInfo = SQLExceptionInfo(e); }
212 catch(SQLWarning& e) { aExceptionInfo = SQLExceptionInfo(e); }
213 catch(SQLException& e) { aExceptionInfo = SQLExceptionInfo(e); }
214
215 // reflect the new selection in the toolbox
216 updateToolbox();
217
218 if (aExceptionInfo.isValid())
219 showError(aExceptionInfo, m_xDialog->GetXWindow(), m_xContext);
220 else
221 {
222 m_xUnique->save_state();
223 m_xFields->SaveValue();
224 }
225
226 return !aExceptionInfo.isValid();
227 }
228
229 void DbaIndexDialog::OnNewIndex()
230 {
231 // commit the current entry, if necessary
232 if (!implCommitPreviouslySelected())
233 return;
234
235 // get a new unique name for the new index
236 OUString sNewIndexName;
237 const OUString sNewIndexNameBase(DBA_RES(STR_LOGICAL_INDEX_NAME)::dbaccess::ResourceManager::loadString( reinterpret_cast<
char const *>("STR_LOGICAL_INDEX_NAME" "\004" u8"index") ));
238 sal_Int32 i;
239
240 for ( i = 1; i < 0x7FFFFFFF; ++i )
241 {
242 sNewIndexName = sNewIndexNameBase + OUString::number(i);
243 if (m_xIndexes->end() == m_xIndexes->find(sNewIndexName))
244 break;
245 }
246 if (i == 0x7FFFFFFF)
247 {
248 OSL_FAIL("DbaIndexDialog::OnNewIndex: no free index name found!")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "248" ": "), "%s", "DbaIndexDialog::OnNewIndex: no free index name found!"
); } } while (false);
249 // can't do anything ... of course we try another base, but this could end with the same result ...
250 return;
251 }
252
253 std::unique_ptr<weld::TreeIter> xNewEntry(m_xIndexList->make_iterator());
254 m_xIndexList->insert(nullptr, -1, &sNewIndexName, nullptr, nullptr, nullptr, false, xNewEntry.get());
255 m_xIndexes->insert(sNewIndexName);
256
257 // update the user data on the entries in the list box:
258 // they're iterators of the index collection, and thus they have changed when removing the index
259 m_xIndexList->all_foreach([this](weld::TreeIter& rEntry){
260 Indexes::const_iterator aAfterInsertPos = m_xIndexes->find(m_xIndexList->get_text(rEntry));
261 OSL_ENSURE(aAfterInsertPos != m_xIndexes->end(), "DbaIndexDialog::OnNewIndex: problems with one of the entries!")do { if (true && (!(aAfterInsertPos != m_xIndexes->
end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "261" ": "), "%s", "DbaIndexDialog::OnNewIndex: problems with one of the entries!"
); } } while (false);
262 m_xIndexList->set_id(rEntry, OUString::number(aAfterInsertPos - m_xIndexes->begin()));
263 return false;
264 });
265
266 // select the entry and start in-place editing
267 m_bNoHandlerCall = true;
268 m_xIndexList->select(*xNewEntry);
269 m_bNoHandlerCall = false;
270 IndexSelected();
271 m_xIndexList->grab_focus();
272 m_xIndexList->start_editing(*xNewEntry);
273 updateToolbox();
274 }
275
276 void DbaIndexDialog::OnDropIndex(bool _bConfirm)
277 {
278 std::unique_ptr<weld::TreeIter> xSelected(m_xIndexList->make_iterator());
279 // the selected index
280 if (!m_xIndexList->get_selected(xSelected.get()))
281 return;
282
283 // let the user confirm the drop
284 if (_bConfirm)
285 {
286 OUString sConfirm(DBA_RES(STR_CONFIRM_DROP_INDEX)::dbaccess::ResourceManager::loadString( reinterpret_cast<
char const *>("STR_CONFIRM_DROP_INDEX" "\004" u8"Do you really want to delete the index '$name$'?"
) ));
287 sConfirm = sConfirm.replaceFirst("$name$", m_xIndexList->get_text(*xSelected));
288 std::unique_ptr<weld::MessageDialog> xConfirm(Application::CreateMessageDialog(m_xDialog.get(),
289 VclMessageType::Question, VclButtonsType::YesNo,
290 sConfirm));
291 if (RET_YES != xConfirm->run())
292 return;
293 }
294
295 // do the drop
296 implDropIndex(xSelected.get(), true);
297
298 // reflect the new selection in the toolbox
299 updateToolbox();
300 }
301
302 bool DbaIndexDialog::implDropIndex(const weld::TreeIter* pEntry, bool _bRemoveFromCollection)
303 {
304 // do the drop
305 Indexes::iterator aDropPos = m_xIndexes->begin() + m_xIndexList->get_id(*pEntry).toUInt32();
306 OSL_ENSURE(aDropPos != m_xIndexes->end(), "DbaIndexDialog::OnDropIndex: did not find the index in my collection!")do { if (true && (!(aDropPos != m_xIndexes->end())
)) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "306" ": "), "%s", "DbaIndexDialog::OnDropIndex: did not find the index in my collection!"
); } } while (false);
307
308 SQLExceptionInfo aExceptionInfo;
309 bool bSuccess = false;
310 try
311 {
312 if (_bRemoveFromCollection)
313 bSuccess = m_xIndexes->drop(aDropPos);
314 else
315 bSuccess = m_xIndexes->dropNoRemove(aDropPos);
316 }
317 catch(SQLContext& e) { aExceptionInfo = SQLExceptionInfo(e); }
318 catch(SQLWarning& e) { aExceptionInfo = SQLExceptionInfo(e); }
319 catch(SQLException& e) { aExceptionInfo = SQLExceptionInfo(e); }
320
321 if (aExceptionInfo.isValid())
322 showError(aExceptionInfo, m_xDialog->GetXWindow(), m_xContext);
323 else if (bSuccess && _bRemoveFromCollection)
324 {
325 m_bNoHandlerCall = true;
326
327 // if the entry to remove is the selected on...
328 if (m_xPreviousSelection && m_xPreviousSelection->equal(*pEntry))
329 m_xPreviousSelection.reset();
330 m_xIndexList->remove(*pEntry);
331
332 m_bNoHandlerCall = false;
333
334 // update the user data on the entries in the list box:
335 // they're iterators of the index collection, and thus they have changed when removing the index
336 m_xIndexList->all_foreach([this](weld::TreeIter& rEntry){
337 Indexes::const_iterator aAfterDropPos = m_xIndexes->find(m_xIndexList->get_text(rEntry));
338 OSL_ENSURE(aAfterDropPos != m_xIndexes->end(), "DbaIndexDialog::OnDropIndex: problems with one of the remaining entries!")do { if (true && (!(aAfterDropPos != m_xIndexes->end
()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "338" ": "), "%s", "DbaIndexDialog::OnDropIndex: problems with one of the remaining entries!"
); } } while (false);
339 m_xIndexList->set_id(rEntry, OUString::number(aAfterDropPos - m_xIndexes->begin()));
340 return false;
341 });
342
343 // the Remove automatically selected another entry (if possible), but we disabled the calling of the handler
344 // to prevent that we missed something... call the handler directly
345 IndexSelected();
346 }
347
348 return !aExceptionInfo.isValid();
349 }
350
351 void DbaIndexDialog::OnRenameIndex()
352 {
353 // the selected iterator
354 std::unique_ptr<weld::TreeIter> xSelected(m_xIndexList->make_iterator());
355 if (!m_xIndexList->get_selected(xSelected.get()))
356 return;
357
358 // save the changes made 'til here
359 // Upon leaving the edit mode, the control will be re-initialized with the
360 // settings from the current entry
361 implSaveModified(false);
362
363 m_xIndexList->grab_focus();
364 m_xIndexList->start_editing(*xSelected);
365 updateToolbox();
366 }
367
368 void DbaIndexDialog::OnSaveIndex()
369 {
370 // the selected index
371 implCommitPreviouslySelected();
372 updateToolbox();
373 }
374
375 void DbaIndexDialog::OnResetIndex()
376 {
377 // the selected index
378 std::unique_ptr<weld::TreeIter> xSelected(m_xIndexList->make_iterator());
379 // the selected index
380 if (!m_xIndexList->get_selected(xSelected.get()))
381 xSelected.reset();
382 OSL_ENSURE(xSelected, "DbaIndexDialog::OnResetIndex: invalid call!")do { if (true && (!(xSelected))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "382" ": "), "%s", "DbaIndexDialog::OnResetIndex: invalid call!"
); } } while (false);
383 if (!xSelected)
384 return;
385
386 Indexes::iterator aResetPos = m_xIndexes->begin() + m_xIndexList->get_id(*xSelected).toUInt32();
387
388 if (aResetPos->isNew())
389 {
390 OnDropIndex(false);
391 return;
392 }
393
394 SQLExceptionInfo aExceptionInfo;
395 try
396 {
397 m_xIndexes->resetIndex(aResetPos);
398 }
399 catch(SQLContext& e) { aExceptionInfo = SQLExceptionInfo(e); }
400 catch(SQLWarning& e) { aExceptionInfo = SQLExceptionInfo(e); }
401 catch(SQLException& e) { aExceptionInfo = SQLExceptionInfo(e); }
402
403 if (aExceptionInfo.isValid())
404 showError(aExceptionInfo, m_xDialog->GetXWindow(), m_xContext);
405 else
406 m_xIndexList->set_text(*xSelected, aResetPos->sName);
407
408 updateControls(xSelected.get());
409 updateToolbox();
410 }
411
412 IMPL_LINK(DbaIndexDialog, OnIndexAction, const OString&, rClicked, void)void DbaIndexDialog::LinkStubOnIndexAction(void * instance, const
OString& data) { return static_cast<DbaIndexDialog *>
(instance)->OnIndexAction(data); } void DbaIndexDialog::OnIndexAction
(const OString& rClicked)
413 {
414 if (rClicked == "ID_INDEX_NEW")
415 OnNewIndex();
416 else if (rClicked == "ID_INDEX_DROP")
417 OnDropIndex();
418 else if (rClicked == "ID_INDEX_RENAME")
419 OnRenameIndex();
420 else if (rClicked == "ID_INDEX_SAVE")
421 OnSaveIndex();
422 else if (rClicked == "ID_INDEX_RESET")
423 OnResetIndex();
424 }
425
426 IMPL_LINK_NOARG(DbaIndexDialog, OnCloseDialog, weld::Button&, void)void DbaIndexDialog::LinkStubOnCloseDialog(void * instance, weld
::Button& data) { return static_cast<DbaIndexDialog *>
(instance)->OnCloseDialog(data); } void DbaIndexDialog::OnCloseDialog
(__attribute__ ((unused)) weld::Button&)
427 {
428 if (m_bEditingActive)
429 {
430 OSL_ENSURE(!m_bEditAgain, "DbaIndexDialog::OnCloseDialog: somebody was faster than hell!")do { if (true && (!(!m_bEditAgain))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "430" ": "), "%s", "DbaIndexDialog::OnCloseDialog: somebody was faster than hell!"
); } } while (false);
431 // this means somebody entered a new name, which was invalid, which cause us to posted us an event,
432 // and before the event arrived the user clicked onto "close". VERY fast, this user...
433 m_xIndexList->end_editing();
434 if (m_bEditAgain)
435 // could not commit the new name (started a new - asynchronous - edit trial)
436 return;
437 }
438
439 // the currently selected entry
440 std::unique_ptr<weld::TreeIter> xSelected(m_xIndexList->make_iterator());
441 // the selected index
442 if (!m_xIndexList->get_selected(xSelected.get()))
443 xSelected.reset();
444
445 OSL_ENSURE(xSelected && m_xPreviousSelection && xSelected->equal(*m_xPreviousSelection), "DbaIndexDialog::OnCloseDialog: inconsistence!")do { if (true && (!(xSelected && m_xPreviousSelection
&& xSelected->equal(*m_xPreviousSelection)))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "445" ": "), "%s", "DbaIndexDialog::OnCloseDialog: inconsistence!"
); } } while (false);
446
447 sal_Int32 nResponse = RET_NO;
448 if (xSelected)
449 {
450 // the descriptor
451 Indexes::const_iterator aSelected = m_xIndexes->begin() + m_xIndexList->get_id(*xSelected).toUInt32();
452 if (aSelected->isModified() || aSelected->isNew())
453 {
454 std::unique_ptr<weld::Builder> xBuilder(Application::CreateBuilder(m_xDialog.get(), "dbaccess/ui/saveindexdialog.ui"));
455 std::unique_ptr<weld::MessageDialog> xQuery(xBuilder->weld_message_dialog("SaveIndexDialog"));
456 nResponse = xQuery->run();
457 }
458 }
459
460 switch (nResponse)
461 {
462 case RET_YES:
463 if (!implCommitPreviouslySelected())
464 return;
465 break;
466 case RET_NO:
467 break;
468 default:
469 return;
470 }
471
472 m_xDialog->response(RET_OK);
473 }
474
475 IMPL_LINK(DbaIndexDialog, OnEditIndexAgain, void*, p, void)void DbaIndexDialog::LinkStubOnEditIndexAgain(void * instance
, void* data) { return static_cast<DbaIndexDialog *>(instance
)->OnEditIndexAgain(data); } void DbaIndexDialog::OnEditIndexAgain
(void* p)
476 {
477 weld::TreeIter* pEntry = static_cast<weld::TreeIter*>(p);
478 m_bEditAgain = false;
479 m_xIndexList->grab_focus();
480 m_xIndexList->start_editing(*pEntry);
481 delete pEntry;
482 }
483
484 IMPL_LINK_NOARG(DbaIndexDialog, OnEntryEditing, const weld::TreeIter&, bool)bool DbaIndexDialog::LinkStubOnEntryEditing(void * instance, const
weld::TreeIter& data) { return static_cast<DbaIndexDialog
*>(instance)->OnEntryEditing(data); } bool DbaIndexDialog
::OnEntryEditing(__attribute__ ((unused)) const weld::TreeIter
&)
485 {
486 m_bEditingActive = true;
487 return true;
488 }
489
490 IMPL_LINK(DbaIndexDialog, OnEntryEdited, const IterString&, rIterString, bool)bool DbaIndexDialog::LinkStubOnEntryEdited(void * instance, const
IterString& data) { return static_cast<DbaIndexDialog
*>(instance)->OnEntryEdited(data); } bool DbaIndexDialog
::OnEntryEdited(const IterString& rIterString)
491 {
492 m_bEditingActive = false;
493
494 const weld::TreeIter& rEntry = rIterString.first;
495 OUString sNewName = rIterString.second;
496
497 Indexes::iterator aPosition = m_xIndexes->begin() + m_xIndexList->get_id(rEntry).toUInt32();
498
499 OSL_ENSURE(aPosition >= m_xIndexes->begin() && aPosition < m_xIndexes->end(),do { if (true && (!(aPosition >= m_xIndexes->begin
() && aPosition < m_xIndexes->end()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "500" ": "), "%s", "DbaIndexDialog::OnEntryEdited: invalid entry!"
); } } while (false)
500 "DbaIndexDialog::OnEntryEdited: invalid entry!")do { if (true && (!(aPosition >= m_xIndexes->begin
() && aPosition < m_xIndexes->end()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
":" "500" ": "), "%s", "DbaIndexDialog::OnEntryEdited: invalid entry!"
); } } while (false);
501
502 Indexes::const_iterator aSameName = m_xIndexes->find(sNewName);
503 if (aSameName != aPosition && m_xIndexes->end() != aSameName)
504 {
505 OUString sError(DBA_RES(STR_INDEX_NAME_ALREADY_USED)::dbaccess::ResourceManager::loadString( reinterpret_cast<
char const *>("STR_INDEX_NAME_ALREADY_USED" "\004" u8"There is already another index named \"$name$\"."
) ));
506 sError = sError.replaceFirst("$name$", sNewName);
507 std::unique_ptr<weld::MessageDialog> xError(Application::CreateMessageDialog(m_xDialog.get(),
508 VclMessageType::Warning, VclButtonsType::Ok,
509 sError));
510 xError->run();
511
512 updateToolbox();
513 m_bEditAgain = true;
514 std::unique_ptr<weld::TreeIter> xEntry(m_xIndexList->make_iterator(&rEntry));
515 Application::PostUserEvent(LINK(this, DbaIndexDialog, OnEditIndexAgain)::tools::detail::makeLink( ::tools::detail::castTo<DbaIndexDialog
*>(this), &DbaIndexDialog::LinkStubOnEditIndexAgain), xEntry.release());
516 return false;
517 }
518
519 aPosition->sName = sNewName;
520
521 // rename can be done by a drop/insert combination only
522 if (aPosition->isNew())
523 {
524 updateToolbox();
525 // no commitment needed here...
526 return true;
527 }
528
529 if (aPosition->sName != aPosition->getOriginalName())
530 {
531 aPosition->setModified(true);
532 updateToolbox();
533 }
534
535 return true;
536 }
537
538 bool DbaIndexDialog::implSaveModified(bool _bPlausibility)
539 {
540 if (m_xPreviousSelection)
541 {
542 // try to commit the previously selected index
543 if (m_xFields->IsModified() && !m_xFields->SaveModified())
544 return false;
545
546 Indexes::iterator aPreviouslySelected = m_xIndexes->begin() + m_xIndexList->get_id(*m_xPreviousSelection).toUInt32();
547
548 // the unique flag
549 aPreviouslySelected->bUnique = m_xUnique->get_active();
550 if (m_xUnique->get_state_changed_from_saved())
551 aPreviouslySelected->setModified(true);
552
553 // the fields
554 m_xFields->commitTo(aPreviouslySelected->aFields);
555 if (m_xFields->GetSavedValue() != aPreviouslySelected->aFields)
556 aPreviouslySelected->setModified(true);
557
558 // plausibility checks
559 if (_bPlausibility && !implCheckPlausibility(aPreviouslySelected))
560 return false;
561 }
562
563 return true;
564 }
565
566 bool DbaIndexDialog::implCheckPlausibility(const Indexes::const_iterator& _rPos)
567 {
568 // need at least one field
569 if (_rPos->aFields.empty())
570 {
571 std::unique_ptr<weld::MessageDialog> xError(Application::CreateMessageDialog(m_xDialog.get(),
572 VclMessageType::Warning, VclButtonsType::Ok,
573 DBA_RES(STR_NEED_INDEX_FIELDS)::dbaccess::ResourceManager::loadString( reinterpret_cast<
char const *>("STR_NEED_INDEX_FIELDS" "\004" u8"The index must contain at least one field."
) )));
574 xError->run();
575 m_xFields->GrabFocus();
576 return false;
577 }
578
579 // no double fields
580 std::set< OUString > aExistentFields;
581 for (auto const& fieldCheck : _rPos->aFields)
582 {
583 if (aExistentFields.end() != aExistentFields.find(fieldCheck.sFieldName))
584 {
585 // a column is specified twice ... won't work anyway, so prevent this here and now
586 OUString sMessage(DBA_RES(STR_INDEXDESIGN_DOUBLE_COLUMN_NAME)::dbaccess::ResourceManager::loadString( reinterpret_cast<
char const *>("STR_INDEXDESIGN_DOUBLE_COLUMN_NAME" "\004" u8"In an index definition, no table column may occur more than once. However, you have entered column \"$name$\" twice."
) ));
587 sMessage = sMessage.replaceFirst("$name$", fieldCheck.sFieldName);
588 std::unique_ptr<weld::MessageDialog> xError(Application::CreateMessageDialog(m_xDialog.get(),
589 VclMessageType::Warning, VclButtonsType::Ok,
590 sMessage));
591 xError->run();
592 m_xFields->GrabFocus();
593 return false;
594 }
595 aExistentFields.insert(fieldCheck.sFieldName);
596 }
597
598 return true;
599 }
600
601 bool DbaIndexDialog::implCommitPreviouslySelected()
602 {
603 if (m_xPreviousSelection)
604 {
605 Indexes::const_iterator aPreviouslySelected = m_xIndexes->begin() + m_xIndexList->get_id(*m_xPreviousSelection).toUInt32();
606
607 if (!implSaveModified())
608 return false;
609
610 // commit the index (if necessary)
611 if (aPreviouslySelected->isModified() && !implCommit(m_xPreviousSelection.get()))
612 return false;
613 }
614
615 return true;
616 }
617
618 IMPL_LINK_NOARG(DbaIndexDialog, OnModifiedClick, weld::Button&, void)void DbaIndexDialog::LinkStubOnModifiedClick(void * instance,
weld::Button& data) { return static_cast<DbaIndexDialog
*>(instance)->OnModifiedClick(data); } void DbaIndexDialog
::OnModifiedClick(__attribute__ ((unused)) weld::Button&)
619 {
620 OnModified(*m_xFields);
621 }
622
623 IMPL_LINK_NOARG( DbaIndexDialog, OnModified, IndexFieldsControl&, void )void DbaIndexDialog::LinkStubOnModified(void * instance, IndexFieldsControl
& data) { return static_cast<DbaIndexDialog *>(instance
)->OnModified(data); } void DbaIndexDialog::OnModified(__attribute__
((unused)) IndexFieldsControl&)
624 {
625 assert(m_xPreviousSelection && "DbaIndexDialog, OnModified: invalid call!")(static_cast <bool> (m_xPreviousSelection && "DbaIndexDialog, OnModified: invalid call!"
) ? void (0) : __assert_fail ("m_xPreviousSelection && \"DbaIndexDialog, OnModified: invalid call!\""
, "/home/maarten/src/libreoffice/core/dbaccess/source/ui/dlg/indexdialog.cxx"
, 625, __extension__ __PRETTY_FUNCTION__));
626 Indexes::iterator aPosition = m_xIndexes->begin() + m_xIndexList->get_id(*m_xPreviousSelection).toUInt32();
627
628 aPosition->setModified(true);
629 updateToolbox();
630 }
631
632 void DbaIndexDialog::updateControls(const weld::TreeIter* pEntry)
633 {
634 if (pEntry)
635 {
636 // the descriptor of the selected index
637 Indexes::const_iterator aSelectedIndex = m_xIndexes->begin() + m_xIndexList->get_id(*pEntry).toUInt32();
638
639 // fill the controls
640 m_xUnique->set_active(aSelectedIndex->bUnique);
641 m_xUnique->set_sensitive(!aSelectedIndex->bPrimaryKey);
642 m_xUnique->save_state();
643
644 m_xFields->initializeFrom(aSelectedIndex->aFields);
645 m_xFields->Enable(!aSelectedIndex->bPrimaryKey);
646 m_xFields->SaveValue();
647
648 m_xDescription->set_label(aSelectedIndex->sDescription);
649 m_xDescription->set_sensitive(!aSelectedIndex->bPrimaryKey);
650
651 m_xDescriptionLabel->set_sensitive(!aSelectedIndex->bPrimaryKey);
652 }
653 else
654 {
655 m_xUnique->set_active(false);
656 m_xFields->initializeFrom(IndexFields());
657 m_xDescription->set_label(OUString());
658 }
659 }
660
661 void DbaIndexDialog::IndexSelected()
662 {
663 if (m_bEditingActive)
664 m_xIndexList->end_editing();
665
666 std::unique_ptr<weld::TreeIter> xSelected(m_xIndexList->make_iterator());
667 if (!m_xIndexList->get_selected(xSelected.get()))
668 xSelected.reset();
669
670 // commit the old data
671 if (m_xPreviousSelection && (!xSelected || !m_xPreviousSelection->equal(*xSelected)))
672 {
673 // (this call may happen in case somebody ended an in-place edit with 'return', so we need to check this before committing)
674 if (!implCommitPreviouslySelected())
675 {
676 m_bNoHandlerCall = true;
677 m_xIndexList->select(*m_xPreviousSelection);
678 m_bNoHandlerCall = false;
679 return;
680 }
681 }
682
683 // disable/enable the detail controls
684 m_xIndexDetails->set_sensitive(xSelected != nullptr);
685 m_xUnique->set_sensitive(xSelected != nullptr);
686 m_xDescriptionLabel->set_sensitive(xSelected != nullptr);
687 m_xFieldsLabel->set_sensitive(xSelected != nullptr);
688 m_xFields->Enable(xSelected != nullptr);
689
690 updateControls(xSelected.get());
691 if (xSelected)
692 m_xIndexList->grab_focus();
693
694 m_xPreviousSelection = std::move(xSelected);
695
696 updateToolbox();
697 }
698
699 IMPL_LINK_NOARG(DbaIndexDialog, OnIndexSelected, weld::TreeView&, void)void DbaIndexDialog::LinkStubOnIndexSelected(void * instance,
weld::TreeView& data) { return static_cast<DbaIndexDialog
*>(instance)->OnIndexSelected(data); } void DbaIndexDialog
::OnIndexSelected(__attribute__ ((unused)) weld::TreeView&
)
700 {
701 if (m_bNoHandlerCall)
702 return;
703 IndexSelected();
704 }
705} // namespace dbaui
706
707/* 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);
2
←
Calling copy constructor for 'Reference<dbaui::IndexFieldsControl>'
→
5
←
Returning from copy constructor for 'Reference<dbaui::IndexFieldsControl>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
6
←
Calling 'Reference::clear'
→
13
←
Returning; memory was released
→
205 if (aTmp.get()) {
14
←
Calling 'Reference::get'
→
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

/home/maarten/src/libreoffice/core/include/rtl/ref.hxx

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
3
←
Assuming field 'm_pBody' is non-null
→
4
←
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
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
)
7
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
8
←
Calling 'VclReferenceBase::release'
→
12
←
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;
15
←
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)
9
←
Assuming the condition is true
→
10
←
Taking true branch
→
40 delete this;
11
←
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