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 glossary.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/glossary.cxx

/home/maarten/src/libreoffice/core/sw/source/ui/misc/glossary.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 <hintids.hxx>
21
22#include <o3tl/any.hxx>
23#include <vcl/event.hxx>
24#include <vcl/svapp.hxx>
25#include <vcl/weld.hxx>
26#include <svl/stritem.hxx>
27#include <svl/macitem.hxx>
28#include <unotools/pathoptions.hxx>
29#include <sfx2/request.hxx>
30#include <sfx2/fcontnr.hxx>
31#include <sfx2/docfilt.hxx>
32
33#include <svx/svxdlg.hxx>
34#include <editeng/acorrcfg.hxx>
35#include <sfx2/viewfrm.hxx>
36#include <unotools.hxx>
37#include <comphelper/processfactory.hxx>
38#include <ucbhelper/content.hxx>
39#include <com/sun/star/text/AutoTextContainer.hpp>
40#include <com/sun/star/ui/dialogs/XFilePicker3.hpp>
41#include <com/sun/star/ui/dialogs/TemplateDescription.hpp>
42#include <svl/urihelper.hxx>
43#include <unotools/charclass.hxx>
44#include <swtypes.hxx>
45#include <wrtsh.hxx>
46#include <view.hxx>
47#include <glossary.hxx>
48#include <gloshdl.hxx>
49#include <glosbib.hxx>
50#include <initui.hxx>
51#include <glosdoc.hxx>
52#include <macassgn.hxx>
53#include <docsh.hxx>
54#include <shellio.hxx>
55
56#include <cmdid.h>
57#include <sfx2/filedlghelper.hxx>
58
59#include <memory>
60
61#include <strings.hrc>
62#include <iodetect.hxx>
63
64#include <officecfg/Office/Writer.hxx>
65
66using namespace ::com::sun::star;
67using namespace ::com::sun::star::lang;
68using namespace ::com::sun::star::uno;
69using namespace ::com::sun::star::text;
70using namespace ::com::sun::star::ucb;
71using namespace ::com::sun::star::ui::dialogs;
72using namespace ::ucbhelper;
73using namespace ::sfx2;
74
75static OUString lcl_GetValidShortCut( const OUString& rName )
76{
77 const sal_Int32 nSz = rName.getLength();
78
79 if ( 0 == nSz )
80 return rName;
81
82 sal_Int32 nStart = 1;
83 while( rName[nStart-1]==' ' && nStart < nSz )
84 nStart++;
85
86 OUStringBuffer aBuf;
87 aBuf.append(rName[nStart-1]);
88
89 for( ; nStart < nSz; ++nStart )
90 {
91 if( rName[nStart-1]==' ' && rName[nStart]!=' ')
92 aBuf.append(rName[nStart]);
93 }
94 return aBuf.makeStringAndClear();
95}
96
97struct GroupUserData
98{
99 OUString sGroupName;
100 sal_uInt16 nPathIdx;
101 bool bReadonly;
102
103 GroupUserData()
104 : nPathIdx(0),
105 bReadonly(false) {}
106};
107
108// dialog for new block name
109class SwNewGlosNameDlg : public weld::GenericDialogController
110{
111 TextFilter m_aNoSpaceFilter;
112 SwGlossaryDlg* m_pParent;
113
114 std::unique_ptr<weld::Entry> m_xNewName;
115 std::unique_ptr<weld::Entry> m_xNewShort;
116 std::unique_ptr<weld::Button> m_xOk;
117 std::unique_ptr<weld::Entry> m_xOldName;
118 std::unique_ptr<weld::Entry> m_xOldShort;
119
120protected:
121 DECL_LINK(Modify, weld::Entry&, void)static void LinkStubModify(void *, weld::Entry&); void Modify
(weld::Entry&)
;
122 DECL_LINK(Rename, weld::Button&, void)static void LinkStubRename(void *, weld::Button&); void Rename
(weld::Button&)
;
123 DECL_LINK(TextFilterHdl, OUString&, bool)static bool LinkStubTextFilterHdl(void *, OUString&); bool
TextFilterHdl(OUString&)
;
124
125public:
126 SwNewGlosNameDlg(SwGlossaryDlg* pParent,
127 const OUString& rOldName,
128 const OUString& rOldShort);
129
130 OUString GetNewName() const { return m_xNewName->get_text(); }
131 OUString GetNewShort() const { return m_xNewShort->get_text(); }
132};
133
134IMPL_LINK(SwNewGlosNameDlg, TextFilterHdl, OUString&, rTest, bool)bool SwNewGlosNameDlg::LinkStubTextFilterHdl(void * instance,
OUString& data) { return static_cast<SwNewGlosNameDlg
*>(instance)->TextFilterHdl(data); } bool SwNewGlosNameDlg
::TextFilterHdl(OUString& rTest)
135{
136 rTest = m_aNoSpaceFilter.filter(rTest);
137 return true;
138}
139
140SwNewGlosNameDlg::SwNewGlosNameDlg(SwGlossaryDlg* pParent, const OUString& rOldName, const OUString& rOldShort)
141 : GenericDialogController(pParent->getDialog(), "modules/swriter/ui/renameautotextdialog.ui", "RenameAutoTextDialog")
142 , m_pParent(pParent)
143 , m_xNewName(m_xBuilder->weld_entry("newname"))
144 , m_xNewShort(m_xBuilder->weld_entry("newsc"))
145 , m_xOk(m_xBuilder->weld_button("ok"))
146 , m_xOldName(m_xBuilder->weld_entry("oldname"))
147 , m_xOldShort(m_xBuilder->weld_entry("oldsc"))
148{
149 m_xNewShort->connect_insert_text(LINK(this, SwNewGlosNameDlg, TextFilterHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwNewGlosNameDlg
*>(this), &SwNewGlosNameDlg::LinkStubTextFilterHdl)
);
150
151 m_xOldName->set_text(rOldName);
152 m_xOldShort->set_text(rOldShort);
153 m_xNewName->connect_changed(LINK(this, SwNewGlosNameDlg, Modify )::tools::detail::makeLink( ::tools::detail::castTo<SwNewGlosNameDlg
*>(this), &SwNewGlosNameDlg::LinkStubModify)
);
154 m_xNewShort->connect_changed(LINK(this, SwNewGlosNameDlg, Modify )::tools::detail::makeLink( ::tools::detail::castTo<SwNewGlosNameDlg
*>(this), &SwNewGlosNameDlg::LinkStubModify)
);
155 m_xOk->connect_clicked(LINK(this, SwNewGlosNameDlg, Rename )::tools::detail::makeLink( ::tools::detail::castTo<SwNewGlosNameDlg
*>(this), &SwNewGlosNameDlg::LinkStubRename)
);
156 m_xNewName->grab_focus();
157}
158
159// query / set currently set group
160OUString SwGlossaryDlg::GetCurrGroup()
161{
162 if( !::GetCurrGlosGroup().isEmpty() )
163 return ::GetCurrGlosGroup();
164 return SwGlossaries::GetDefName();
165}
166
167void SwGlossaryDlg::SetActGroup(const OUString &rGrp)
168{
169 ::SetCurrGlosGroup(rGrp);
170}
171
172IMPL_LINK(SwGlossaryDlg, TextFilterHdl, OUString&, rTest, bool)bool SwGlossaryDlg::LinkStubTextFilterHdl(void * instance, OUString
& data) { return static_cast<SwGlossaryDlg *>(instance
)->TextFilterHdl(data); } bool SwGlossaryDlg::TextFilterHdl
(OUString& rTest)
173{
174 rTest = m_aNoSpaceFilter.filter(rTest);
175 return true;
176}
177
178SwGlossaryDlg::SwGlossaryDlg(SfxViewFrame const * pViewFrame,
179 SwGlossaryHdl * pGlosHdl, SwWrtShell *pWrtShell)
180 : SfxDialogController(pViewFrame->GetWindow().GetFrameWeld(), "modules/swriter/ui/autotext.ui", "AutoTextDialog")
181 , m_sReadonlyPath(SwResId(STR_READONLY_PATHreinterpret_cast<char const *>("STR_READONLY_PATH" "\004"
u8"The 'AutoText' directories are read-only. Do you want to call the path settings dialog?"
)
))
182 , m_pGlossaryHdl(pGlosHdl)
183 , m_bResume(false)
184 , m_bSelection(pWrtShell->IsSelection())
185 , m_bReadOnly(false)
186 , m_bIsOld(false)
187 , m_bIsDocReadOnly(false)
188 , m_pShell(pWrtShell)
189 , m_xInsertTipCB(m_xBuilder->weld_check_button("inserttip"))
190 , m_xNameED(m_xBuilder->weld_entry("name"))
191 , m_xShortNameLbl(m_xBuilder->weld_label("shortnameft"))
192 , m_xShortNameEdit(m_xBuilder->weld_entry("shortname"))
193 , m_xCategoryBox(m_xBuilder->weld_tree_view("category"))
194 , m_xFileRelCB(m_xBuilder->weld_check_button("relfile"))
195 , m_xNetRelCB(m_xBuilder->weld_check_button("relnet"))
196 , m_xInsertBtn(m_xBuilder->weld_button("ok"))
197 , m_xEditBtn(m_xBuilder->weld_menu_button("autotext"))
198 , m_xBibBtn(m_xBuilder->weld_button("categories"))
199 , m_xPathBtn(m_xBuilder->weld_button("path"))
200{
201 m_xCategoryBox->set_size_request(m_xCategoryBox->get_approximate_digit_width() * 52,
202 m_xCategoryBox->get_height_rows(12));
203
204 Link<SwOneExampleFrame&,void> aLink(LINK(this, SwGlossaryDlg, PreviewLoadedHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubPreviewLoadedHdl)
);
205 m_xExampleFrame.reset(new SwOneExampleFrame(EX_SHOW_ONLINE_LAYOUT0x01, &aLink));
206 m_xExampleFrameWin.reset(new weld::CustomWeld(*m_xBuilder, "example", *m_xExampleFrame));
207 Size aSize = m_xExampleFrame->GetDrawingArea()->get_ref_device().LogicToPixel(
208 Size(82, 124), MapMode(MapUnit::MapAppFont));
209 m_xExampleFrame->set_size_request(aSize.Width(), aSize.Height());
210
211 m_xShortNameEdit->connect_insert_text(LINK(this, SwGlossaryDlg, TextFilterHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubTextFilterHdl)
);
212
213 m_xEditBtn->connect_toggled(LINK(this, SwGlossaryDlg, EnableHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubEnableHdl)
);
214 m_xEditBtn->connect_selected(LINK(this, SwGlossaryDlg, MenuHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubMenuHdl)
);
215 m_xPathBtn->connect_clicked(LINK(this, SwGlossaryDlg, PathHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubPathHdl)
);
216
217 m_xNameED->connect_changed(LINK(this,SwGlossaryDlg,NameModify)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubNameModify)
);
218 m_xShortNameEdit->connect_changed(LINK(this,SwGlossaryDlg,NameModify)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubNameModify)
);
219
220 m_xCategoryBox->connect_row_activated(LINK(this, SwGlossaryDlg, NameDoubleClick)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubNameDoubleClick)
);
221 m_xCategoryBox->connect_changed(LINK(this, SwGlossaryDlg, GrpSelect)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubGrpSelect)
);
222 m_xCategoryBox->connect_key_press(LINK(this, SwGlossaryDlg, KeyInputHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubKeyInputHdl)
);
223 m_xBibBtn->connect_clicked(LINK(this,SwGlossaryDlg,BibHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubBibHdl)
);
224
225 m_xInsertBtn->connect_clicked(LINK(this,SwGlossaryDlg,InsertHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubInsertHdl)
);
226
227 ShowPreview();
228
229 m_bIsDocReadOnly = m_pShell->GetView().GetDocShell()->IsReadOnly() ||
230 m_pShell->HasReadonlySel();
231 if( m_bIsDocReadOnly )
232 m_xInsertBtn->set_sensitive(false);
233 m_xNameED->grab_focus();
234 m_xCategoryBox->make_sorted();
235 m_xCategoryBox->set_sort_order(true);
236
237 Init();
238}
239
240SwGlossaryDlg::~SwGlossaryDlg()
241{
242}
243
244namespace
245{
246
247OUString getCurrentGlossary()
248{
249 const OUString sTemp{ ::GetCurrGlosGroup() };
250
251 // the zeroth path is not being recorded!
252 if (sTemp.getToken(1, GLOS_DELIMu'*').startsWith("0"))
253 return sTemp.getToken(0, GLOS_DELIMu'*');
254
255 return sTemp;
256}
257
258}
259
260// select new group
261IMPL_LINK(SwGlossaryDlg, GrpSelect, weld::TreeView&, rBox, void)void SwGlossaryDlg::LinkStubGrpSelect(void * instance, weld::
TreeView& data) { return static_cast<SwGlossaryDlg *>
(instance)->GrpSelect(data); } void SwGlossaryDlg::GrpSelect
(weld::TreeView& rBox)
262{
263 std::unique_ptr<weld::TreeIter> xEntry = rBox.make_iterator();
264 if (!rBox.get_selected(xEntry.get()))
265 return;
266
267 std::unique_ptr<weld::TreeIter> xParent = rBox.make_iterator(xEntry.get());
268 weld::TreeIter* pParent;
269 if (rBox.get_iter_depth(*xParent))
270 {
271 rBox.iter_parent(*xParent);
272 pParent = xParent.get();
273 }
274 else
275 pParent = xEntry.get();
276 GroupUserData* pGroupData = reinterpret_cast<GroupUserData*>(rBox.get_id(*pParent).toInt64());
277 ::SetCurrGlosGroup(pGroupData->sGroupName
278 + OUStringChar(GLOS_DELIMu'*')
279 + OUString::number(pGroupData->nPathIdx));
280 m_pGlossaryHdl->SetCurGroup(::GetCurrGlosGroup());
281 // set current text block
282 m_bReadOnly = m_pGlossaryHdl->IsReadOnly();
283 EnableShortName( !m_bReadOnly );
284 m_xEditBtn->set_sensitive(!m_bReadOnly);
285 m_bIsOld = m_pGlossaryHdl->IsOld();
286 if( pParent != xEntry.get())
287 {
288 OUString aName(rBox.get_text(*xEntry));
289 m_xNameED->set_text(aName);
290 m_xShortNameEdit->set_text(rBox.get_id(*xEntry));
291 m_xInsertBtn->set_sensitive( !m_bIsDocReadOnly);
292 ShowAutoText(::GetCurrGlosGroup(), m_xShortNameEdit->get_text());
293 }
294 else
295 {
296 m_xNameED->set_text("");
297 m_xShortNameEdit->set_text("");
298 m_xShortNameEdit->set_sensitive(false);
299 ShowAutoText("", "");
300 }
301 // update controls
302 NameModify(*m_xShortNameEdit);
303 if( SfxRequest::HasMacroRecorder( m_pShell->GetView().GetViewFrame() ) )
304 {
305 SfxRequest aReq( m_pShell->GetView().GetViewFrame(), FN_SET_ACT_GLOSSARY((20000 + 2200) + 91) );
306 aReq.AppendItem(SfxStringItem(FN_SET_ACT_GLOSSARY((20000 + 2200) + 91), getCurrentGlossary()));
307 aReq.Done();
308 }
309}
310
311short SwGlossaryDlg::run()
312{
313 short nRet = SfxDialogController::run();
314 if (nRet == RET_OK)
315 Apply();
316 return nRet;
317}
318
319void SwGlossaryDlg::Apply()
320{
321 const OUString aGlosName(m_xShortNameEdit->get_text());
322 if (!aGlosName.isEmpty())
323 {
324 m_pGlossaryHdl->InsertGlossary(aGlosName);
325 }
326 if( SfxRequest::HasMacroRecorder( m_pShell->GetView().GetViewFrame() ) )
327 {
328 SfxRequest aReq( m_pShell->GetView().GetViewFrame(), FN_INSERT_GLOSSARY((20000 + 2200) + 89) );
329 aReq.AppendItem(SfxStringItem(FN_INSERT_GLOSSARY((20000 + 2200) + 89), getCurrentGlossary()));
330 aReq.AppendItem(SfxStringItem(FN_PARAM_1((20000 + 1100)+60), aGlosName));
331 aReq.Done();
332 }
333}
334
335void SwGlossaryDlg::EnableShortName(bool bOn)
336{
337 m_xShortNameLbl->set_sensitive(bOn);
338 m_xShortNameEdit->set_sensitive(bOn);
339}
340
341// does the title exist in the selected group?
342std::unique_ptr<weld::TreeIter> SwGlossaryDlg::DoesBlockExist(const OUString& rBlock,
343 const OUString& rShort)
344{
345 // look for possible entry in TreeListBox
346 std::unique_ptr<weld::TreeIter> xEntry = m_xCategoryBox->make_iterator();
347 if (m_xCategoryBox->get_selected(xEntry.get()))
348 {
349 if (m_xCategoryBox->get_iter_depth(*xEntry))
350 m_xCategoryBox->iter_parent(*xEntry);
351 if (!m_xCategoryBox->iter_children(*xEntry))
352 return nullptr;
353 do
354 {
355 if (rBlock == m_xCategoryBox->get_text(*xEntry) &&
356 (rShort.isEmpty() ||
357 rShort == m_xCategoryBox->get_id(*xEntry))
358 )
359 {
360 return xEntry;
361 }
362 }
363 while (m_xCategoryBox->iter_next_sibling(*xEntry));
364 }
365 return nullptr;
366}
367
368IMPL_LINK(SwGlossaryDlg, NameModify, weld::Entry&, rEdit, void)void SwGlossaryDlg::LinkStubNameModify(void * instance, weld::
Entry& data) { return static_cast<SwGlossaryDlg *>(
instance)->NameModify(data); } void SwGlossaryDlg::NameModify
(weld::Entry& rEdit)
369{
370 const OUString aName(m_xNameED->get_text());
371 bool bNameED = &rEdit == m_xNameED.get();
372 if( aName.isEmpty() )
373 {
374 if(bNameED)
375 m_xShortNameEdit->set_text(aName);
376 m_xInsertBtn->set_sensitive(false);
377 return;
378 }
379 const bool bNotFound = !DoesBlockExist(aName, bNameED ? OUString() : rEdit.get_text());
380 if(bNameED)
381 {
382 // did the text get in to the Listbox in the Edit with a click?
383 if(bNotFound)
384 {
385 m_xShortNameEdit->set_text( lcl_GetValidShortCut( aName ) );
386 EnableShortName();
387 }
388 else
389 {
390 m_xShortNameEdit->set_text(m_pGlossaryHdl->GetGlossaryShortName(aName));
391 EnableShortName(!m_bReadOnly);
392 }
393 m_xInsertBtn->set_sensitive(!bNotFound && !m_bIsDocReadOnly);
394 }
395 else
396 {
397 //ShortNameEdit
398 if(!bNotFound)
399 {
400 m_xInsertBtn->set_sensitive(!m_bIsDocReadOnly);
401 }
402 }
403}
404
405IMPL_LINK( SwGlossaryDlg, NameDoubleClick, weld::TreeView&, rBox, bool )bool SwGlossaryDlg::LinkStubNameDoubleClick(void * instance, weld
::TreeView& data) { return static_cast<SwGlossaryDlg *
>(instance)->NameDoubleClick(data); } bool SwGlossaryDlg
::NameDoubleClick(weld::TreeView& rBox)
406{
407 std::unique_ptr<weld::TreeIter> xEntry = rBox.make_iterator();
408 if (rBox.get_selected(xEntry.get()) && rBox.get_iter_depth(*xEntry) && !m_bIsDocReadOnly)
409 m_xDialog->response(RET_OK);
410 return true;
411}
412
413IMPL_LINK_NOARG( SwGlossaryDlg, EnableHdl, weld::ToggleButton&, void )void SwGlossaryDlg::LinkStubEnableHdl(void * instance, weld::
ToggleButton& data) { return static_cast<SwGlossaryDlg
*>(instance)->EnableHdl(data); } void SwGlossaryDlg::EnableHdl
(__attribute__ ((unused)) weld::ToggleButton&)
414{
415 std::unique_ptr<weld::TreeIter> xEntry = m_xCategoryBox->make_iterator();
416 bool bEntry = m_xCategoryBox->get_selected(xEntry.get());
417
418 const OUString aEditText(m_xNameED->get_text());
419 const bool bHasEntry = !aEditText.isEmpty() && !m_xShortNameEdit->get_text().isEmpty();
420 const bool bExists = nullptr != DoesBlockExist(aEditText, m_xShortNameEdit->get_text());
421 const bool bIsGroup = bEntry && !m_xCategoryBox->get_iter_depth(*xEntry);
422 m_xEditBtn->set_item_visible("new", m_bSelection && bHasEntry && !bExists);
423 m_xEditBtn->set_item_visible("newtext", m_bSelection && bHasEntry && !bExists);
424 m_xEditBtn->set_item_visible("copy", bExists && !bIsGroup);
425 m_xEditBtn->set_item_visible("replace", m_bSelection && bExists && !bIsGroup && !m_bIsOld );
426 m_xEditBtn->set_item_visible("replacetext", m_bSelection && bExists && !bIsGroup && !m_bIsOld );
427 m_xEditBtn->set_item_visible("edit", bExists && !bIsGroup );
428 m_xEditBtn->set_item_visible("rename", bExists && !bIsGroup );
429 m_xEditBtn->set_item_visible("delete", bExists && !bIsGroup );
430 m_xEditBtn->set_item_visible("macro", bExists && !bIsGroup && !m_bIsOld &&
431 !m_pGlossaryHdl->IsReadOnly() );
432 m_xEditBtn->set_item_visible("import", bIsGroup && !m_bIsOld && !m_pGlossaryHdl->IsReadOnly() );
433}
434
435IMPL_LINK(SwGlossaryDlg, MenuHdl, const OString&, rItemIdent, void)void SwGlossaryDlg::LinkStubMenuHdl(void * instance, const OString
& data) { return static_cast<SwGlossaryDlg *>(instance
)->MenuHdl(data); } void SwGlossaryDlg::MenuHdl(const OString
& rItemIdent)
436{
437 if (rItemIdent == "edit")
438 {
439 std::unique_ptr<SwTextBlocks> pGroup = ::GetGlossaries()->GetGroupDoc ( GetCurrGrpName () );
440 pGroup.reset();
441 m_xDialog->response(RET_EDIT);
442 }
443 else if (rItemIdent == "replace")
444 {
445 m_pGlossaryHdl->NewGlossary(m_xNameED->get_text(),
446 m_xShortNameEdit->get_text());
447 }
448 else if (rItemIdent == "replacetext")
449 {
450 m_pGlossaryHdl->NewGlossary(m_xNameED->get_text(),
451 m_xShortNameEdit->get_text(),
452 false, true);
453 }
454 else if (rItemIdent == "new" || rItemIdent == "newtext")
455 {
456 bool bNoAttr = rItemIdent == "newtext";
457
458 const OUString aStr(m_xNameED->get_text());
459 const OUString aShortName(m_xShortNameEdit->get_text());
460 if(m_pGlossaryHdl->HasShortName(aShortName))
461 {
462 std::unique_ptr<weld::MessageDialog> xInfoBox(Application::CreateMessageDialog(m_xDialog.get(),
463 VclMessageType::Info, VclButtonsType::Ok,
464 SwResId(STR_DOUBLE_SHORTNAMEreinterpret_cast<char const *>("STR_DOUBLE_SHORTNAME" "\004"
u8"Shortcut name already exists. Please choose another name."
)
)));
465 xInfoBox->run();
466 m_xShortNameEdit->select_region(0, -1);
467 m_xShortNameEdit->grab_focus();
468 }
469 if(m_pGlossaryHdl->NewGlossary(aStr, aShortName, false, bNoAttr ))
470 {
471 std::unique_ptr<weld::TreeIter> xEntry = m_xCategoryBox->make_iterator();
472 if (!m_xCategoryBox->get_selected(xEntry.get()))
473 xEntry.reset();
474 else if (m_xCategoryBox->get_iter_depth(*xEntry))
475 m_xCategoryBox->iter_parent(*xEntry);
476 m_xCategoryBox->insert(xEntry.get(), -1, &aStr, &aShortName,
477 nullptr, nullptr, false, nullptr);
478
479 m_xNameED->set_text(aStr);
480 m_xShortNameEdit->set_text(aShortName);
481 NameModify(*m_xNameED); // for toggling the buttons
482
483 if( SfxRequest::HasMacroRecorder( m_pShell->GetView().GetViewFrame() ) )
484 {
485 SfxRequest aReq(m_pShell->GetView().GetViewFrame(), FN_NEW_GLOSSARY((20000 + 2200) + 90));
486 aReq.AppendItem(SfxStringItem(FN_NEW_GLOSSARY((20000 + 2200) + 90), getCurrentGlossary()));
487 aReq.AppendItem(SfxStringItem(FN_PARAM_1((20000 + 1100)+60), aShortName));
488 aReq.AppendItem(SfxStringItem(FN_PARAM_2((20000 + 1100)+61), aStr));
489 aReq.Done();
490 }
491 }
492 }
493 else if (rItemIdent == "copy")
494 {
495 m_pGlossaryHdl->CopyToClipboard(*m_pShell, m_xShortNameEdit->get_text());
496 }
497 else if (rItemIdent == "rename")
498 {
499 m_xShortNameEdit->set_text(m_pGlossaryHdl->GetGlossaryShortName(m_xNameED->get_text()));
500 SwNewGlosNameDlg aNewNameDlg(this, m_xNameED->get_text(), m_xShortNameEdit->get_text());
501 if (aNewNameDlg.run() == RET_OK && m_pGlossaryHdl->Rename(m_xShortNameEdit->get_text(),
502 aNewNameDlg.GetNewShort(),
503 aNewNameDlg.GetNewName()))
504 {
505 std::unique_ptr<weld::TreeIter> xEntry = m_xCategoryBox->make_iterator();
506 if (m_xCategoryBox->get_selected(xEntry.get()))
507 {
508 std::unique_ptr<weld::TreeIter> xOldEntry = m_xCategoryBox->make_iterator(xEntry.get());
509 if (m_xCategoryBox->get_iter_depth(*xEntry))
510 m_xCategoryBox->iter_parent(*xEntry);
511
512 std::unique_ptr<weld::TreeIter> xNewEntry = m_xCategoryBox->make_iterator();
513 OUString sId(aNewNameDlg.GetNewShort());
514 OUString sName(aNewNameDlg.GetNewName());
515
516 m_xCategoryBox->insert(xEntry.get(), -1, &sName, &sId,
517 nullptr, nullptr, false, xNewEntry.get());
518
519 m_xCategoryBox->remove(*xOldEntry);
520 m_xCategoryBox->select(*xNewEntry);
521 m_xCategoryBox->scroll_to_row(*xNewEntry);
522 }
523 }
524 GrpSelect(*m_xCategoryBox);
525 }
526 else if (rItemIdent == "delete")
527 {
528 DeleteEntry();
529 }
530 else if (rItemIdent == "macro")
531 {
532 SfxItemSet aSet( m_pShell->GetAttrPool(), svl::Items<RES_FRMMACRO, RES_FRMMACRO, SID_EVENTCONFIG(5000 + 1101), SID_EVENTCONFIG(5000 + 1101)>{} );
533
534 SvxMacro aStart(OUString(), OUString(), STARBASIC);
535 SvxMacro aEnd(OUString(), OUString(), STARBASIC);
536 m_pGlossaryHdl->GetMacros(m_xShortNameEdit->get_text(), aStart, aEnd );
537
538 SvxMacroItem aItem(RES_FRMMACRO);
539 if( aStart.HasMacro() )
540 aItem.SetMacro( SvMacroItemId::SwStartInsGlossary, aStart );
541 if( aEnd.HasMacro() )
542 aItem.SetMacro( SvMacroItemId::SwEndInsGlossary, aEnd );
543
544 aSet.Put( aItem );
545 aSet.Put( SwMacroAssignDlg::AddEvents( MACASSGN_AUTOTEXT ) );
546
547 const SfxPoolItem* pItem;
548 SvxAbstractDialogFactory* pFact = SvxAbstractDialogFactory::Create();
549 ScopedVclPtr<SfxAbstractDialog> pMacroDlg(pFact->CreateEventConfigDialog(m_xDialog.get(), aSet,
550 m_pShell->GetView().GetViewFrame()->GetFrame().GetFrameInterface() ));
551 if ( pMacroDlg && pMacroDlg->Execute() == RET_OK &&
552 SfxItemState::SET == pMacroDlg->GetOutputItemSet()->GetItemState( RES_FRMMACRO, false, &pItem ) )
553 {
554 const SvxMacroTableDtor& rTable = static_cast<const SvxMacroItem*>(pItem)->GetMacroTable();
555 m_pGlossaryHdl->SetMacros( m_xShortNameEdit->get_text(),
556 rTable.Get( SvMacroItemId::SwStartInsGlossary ),
557 rTable.Get( SvMacroItemId::SwEndInsGlossary ) );
558 }
559 }
560 else if (rItemIdent == "import")
561 {
562 // call the FileOpenDialog do find WinWord - Files with templates
563 FileDialogHelper aDlgHelper(TemplateDescription::FILEOPEN_SIMPLE,
564 FileDialogFlags::NONE, m_xDialog.get());
565 uno::Reference < XFilePicker3 > xFP = aDlgHelper.GetFilePicker();
566
567 SvtPathOptions aPathOpt;
568 xFP->setDisplayDirectory(aPathOpt.GetWorkPath() );
569
570 SfxFilterMatcher aMatcher( SwDocShell::Factory().GetFactoryName() );
571 SfxFilterMatcherIter aIter( aMatcher );
572 std::shared_ptr<const SfxFilter> pFilter = aIter.First();
573 while ( pFilter )
574 {
575 if( pFilter->GetUserData() == FILTER_WW8"CWW8" )
576 {
577 xFP->appendFilter( pFilter->GetUIName(),
578 pFilter->GetWildcard().getGlob() );
579 xFP->setCurrentFilter( pFilter->GetUIName() ) ;
580 }
581 else if( pFilter->GetUserData() == FILTER_DOCX"OXML" )
582 {
583 xFP->appendFilter( pFilter->GetUIName(),
584 pFilter->GetWildcard().getGlob() );
585 xFP->setCurrentFilter( pFilter->GetUIName() ) ;
586 }
587
588 pFilter = aIter.Next();
589 }
590
591 if( aDlgHelper.Execute() == ERRCODE_NONEErrCode(0) )
592 {
593 if( m_pGlossaryHdl->ImportGlossaries( xFP->getSelectedFiles().getConstArray()[0] ))
594 Init();
595 else
596 {
597 std::unique_ptr<weld::MessageDialog> xInfoBox(Application::CreateMessageDialog(m_xDialog.get(),
598 VclMessageType::Info, VclButtonsType::Ok,
599 SwResId(STR_NO_GLOSSARIESreinterpret_cast<char const *>("STR_NO_GLOSSARIES" "\004"
u8"There is no AutoText in this file.")
)));
600 xInfoBox->run();
601 }
602 }
603 }
604}
605
606// dialog manage regions
607IMPL_LINK_NOARG(SwGlossaryDlg, BibHdl, weld::Button&, void)void SwGlossaryDlg::LinkStubBibHdl(void * instance, weld::Button
& data) { return static_cast<SwGlossaryDlg *>(instance
)->BibHdl(data); } void SwGlossaryDlg::BibHdl(__attribute__
((unused)) weld::Button&)
608{
609 SwGlossaries* pGloss = ::GetGlossaries();
610 if( pGloss->IsGlosPathErr() )
611 pGloss->ShowError();
612 else
613 {
614 //check if at least one glossary path is write enabled
615 SvtPathOptions aPathOpt;
616 const OUString& sGlosPath( aPathOpt.GetAutoTextPath() );
617 bool bIsWritable = false;
618 sal_Int32 nIdx {sGlosPath.isEmpty() ? -1 : 0};
619 while (nIdx>=0)
620 {
621 const OUString sPath = URIHelper::SmartRel2Abs(
622 INetURLObject(), sGlosPath.getToken(0, ';', nIdx),
623 URIHelper::GetMaybeFileHdl());
624 try
625 {
626 Content aTestContent( sPath,
627 uno::Reference< XCommandEnvironment >(),
628 comphelper::getProcessComponentContext() );
629 Any aAny = aTestContent.getPropertyValue( "IsReadOnly" );
630 if(aAny.hasValue())
631 {
632 bIsWritable = !*o3tl::doAccess<bool>(aAny);
633 }
634 }
635 catch (const Exception&)
636 {
637 }
638 if(bIsWritable)
639 break;
640 }
641 if(bIsWritable)
642 {
643
644 SwGlossaryGroupDlg aDlg(m_xDialog.get(), pGloss->GetPathArray(), m_pGlossaryHdl);
645 if (aDlg.run() == RET_OK)
646 {
647 Init();
648 //if new groups were created - select one of them
649 const OUString sNewGroup = aDlg.GetCreatedGroupName();
650
651 std::unique_ptr<weld::TreeIter> xEntry = m_xCategoryBox->make_iterator();
652 bool bEntry = m_xCategoryBox->get_iter_first(*xEntry);
653
654 while (!sNewGroup.isEmpty() && bEntry)
655 {
656 if (!m_xCategoryBox->get_iter_depth(*xEntry))
657 {
658 GroupUserData* pGroupData = reinterpret_cast<GroupUserData*>(m_xCategoryBox->get_id(*xEntry).toInt64());
659 const OUString sGroup = pGroupData->sGroupName
660 + OUStringChar(GLOS_DELIMu'*')
661 + OUString::number(pGroupData->nPathIdx);
662 if(sGroup == sNewGroup)
663 {
664 m_xCategoryBox->select(*xEntry);
665 m_xCategoryBox->scroll_to_row(*xEntry);
666 GrpSelect(*m_xCategoryBox);
667 break;
668 }
669 }
670 bEntry = m_xCategoryBox->iter_next(*xEntry);
671 }
672
673 }
674 }
675 else
676 {
677 std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(m_xDialog.get(),
678 VclMessageType::Question, VclButtonsType::YesNo,
679 m_sReadonlyPath));
680 if (RET_YES == xBox->run())
681 PathHdl(*m_xPathBtn);
682 }
683 }
684}
685
686// initialisation; from Ctor and after editing regions
687void SwGlossaryDlg::Init()
688{
689 m_xCategoryBox->freeze();
690 m_xCategoryBox->clear();
691 m_xGroupData.clear();
692 m_xCategoryBox->make_unsorted();
693
694 // display text block regions
695 const size_t nCnt = m_pGlossaryHdl->GetGroupCnt();
696 std::unique_ptr<weld::TreeIter> xSelEntry;
697 const OUString sSelStr(::GetCurrGlosGroup().getToken(0, GLOS_DELIMu'*'));
698 const sal_Int32 nSelPath = ::GetCurrGlosGroup().getToken(1, GLOS_DELIMu'*').toInt32();
699 // #i66304# - "My AutoText" comes from mytexts.bau, but should be translated
700 const OUString sMyAutoTextEnglish("My AutoText");
701 const OUString sMyAutoTextTranslated(SwResId(STR_MY_AUTOTEXTreinterpret_cast<char const *>("STR_MY_AUTOTEXT" "\004"
u8"My AutoText")
));
702 for(size_t nId = 0; nId < nCnt; ++nId )
703 {
704 OUString sTitle;
705 OUString sGroupName(m_pGlossaryHdl->GetGroupName(nId, &sTitle));
706 if(sGroupName.isEmpty())
707 continue;
708 sal_Int32 nIdx{ 0 };
709 const OUString sName{ sGroupName.getToken( 0, GLOS_DELIMu'*', nIdx ) };
710 if(sTitle.isEmpty())
711 sTitle = sName;
712 if(sTitle == sMyAutoTextEnglish)
713 sTitle = sMyAutoTextTranslated;
714
715 std::unique_ptr<weld::TreeIter> xEntry = m_xCategoryBox->make_iterator();
716 m_xCategoryBox->append(xEntry.get());
717 m_xCategoryBox->set_text(*xEntry, sTitle, 0);
718 const sal_Int32 nPath = sGroupName.getToken( 0, GLOS_DELIMu'*', nIdx ).toInt32();
719
720 GroupUserData* pData = new GroupUserData;
721 pData->sGroupName = sName;
722 pData->nPathIdx = static_cast< sal_uInt16 >(nPath);
723 pData->bReadonly = m_pGlossaryHdl->IsReadOnly(&sGroupName);
724 m_xGroupData.emplace_back(pData);
725
726 m_xCategoryBox->set_id(*xEntry, OUString::number(reinterpret_cast<sal_Int64>(pData)));
727 if (sSelStr == pData->sGroupName && nSelPath == nPath)
728 xSelEntry = m_xCategoryBox->make_iterator(xEntry.get());
729
730 // fill entries for the groups
731 {
732 m_pGlossaryHdl->SetCurGroup(sGroupName, false, true);
733 const sal_uInt16 nCount = m_pGlossaryHdl->GetGlossaryCnt();
734 for(sal_uInt16 i = 0; i < nCount; ++i)
735 {
736 OUString sEntryName = m_pGlossaryHdl->GetGlossaryName(i);
737 OUString sId = m_pGlossaryHdl->GetGlossaryShortName(i);
738 m_xCategoryBox->insert(xEntry.get(), -1, &sEntryName, &sId,
739 nullptr, nullptr, false, nullptr);
740 }
741 }
742 }
743 // set current group and display text blocks
744 if (!xSelEntry)
745 {
746 //find a non-readonly group
747 std::unique_ptr<weld::TreeIter> xSearch = m_xCategoryBox->make_iterator();
748 if (m_xCategoryBox->get_iter_first(*xSearch))
749 {
750 do
751 {
752 if (!m_xCategoryBox->get_iter_depth(*xSearch))
753 {
754 GroupUserData* pData = reinterpret_cast<GroupUserData*>(m_xCategoryBox->get_id(*xSearch).toInt64());
755 if (!pData->bReadonly)
756 {
757 xSelEntry = std::move(xSearch);
758 break;
759 }
760 }
761 }
762 while (m_xCategoryBox->iter_next(*xSearch));
763 }
764 if (!xSelEntry)
765 {
766 xSelEntry = std::move(xSearch);
767 if (!m_xCategoryBox->get_iter_first(*xSelEntry))
768 xSelEntry.reset();
769 }
770 }
771
772 m_xCategoryBox->thaw();
773 m_xCategoryBox->make_sorted();
774
775 if (xSelEntry)
776 {
777 m_xCategoryBox->expand_row(*xSelEntry);
778 m_xCategoryBox->select(*xSelEntry);
779 m_xCategoryBox->scroll_to_row(*xSelEntry);
780 GrpSelect(*m_xCategoryBox);
781 }
782
783 const SvxAutoCorrCfg& rCfg = SvxAutoCorrCfg::Get();
784 m_xFileRelCB->set_active( rCfg.IsSaveRelFile() );
785 m_xFileRelCB->connect_toggled(LINK(this, SwGlossaryDlg, CheckBoxHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubCheckBoxHdl)
);
786 m_xNetRelCB->set_active( rCfg.IsSaveRelNet() );
787 m_xNetRelCB->connect_toggled(LINK(this, SwGlossaryDlg, CheckBoxHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubCheckBoxHdl)
);
788 m_xInsertTipCB->set_active( rCfg.IsAutoTextTip() );
789 m_xInsertTipCB->set_sensitive(!officecfg::Office::Writer::AutoFunction::Text::ShowToolTip::isReadOnly());
790 m_xInsertTipCB->connect_toggled(LINK(this, SwGlossaryDlg, CheckBoxHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwGlossaryDlg
*>(this), &SwGlossaryDlg::LinkStubCheckBoxHdl)
);
791}
792
793// KeyInput for ShortName - Edits without Spaces
794IMPL_LINK( SwNewGlosNameDlg, Modify, weld::Entry&, rBox, void )void SwNewGlosNameDlg::LinkStubModify(void * instance, weld::
Entry& data) { return static_cast<SwNewGlosNameDlg *>
(instance)->Modify(data); } void SwNewGlosNameDlg::Modify(
weld::Entry& rBox)
795{
796 OUString aName(m_xNewName->get_text());
797 SwGlossaryDlg* pDlg = m_pParent;
798 if (&rBox == m_xNewName.get())
799 m_xNewShort->set_text(lcl_GetValidShortCut(aName));
800
801 bool bEnable = !aName.isEmpty() && !m_xNewShort->get_text().isEmpty() &&
802 (!pDlg->DoesBlockExist(aName, m_xNewShort->get_text())
803 || aName == m_xOldName->get_text());
804 m_xOk->set_sensitive(bEnable);
805}
806
807IMPL_LINK_NOARG(SwNewGlosNameDlg, Rename, weld::Button&, void)void SwNewGlosNameDlg::LinkStubRename(void * instance, weld::
Button& data) { return static_cast<SwNewGlosNameDlg *>
(instance)->Rename(data); } void SwNewGlosNameDlg::Rename(
__attribute__ ((unused)) weld::Button&)
808{
809 SwGlossaryDlg* pDlg = m_pParent;
810 OUString sNew = GetAppCharClass().uppercase(m_xNewShort->get_text());
811 if (pDlg->m_pGlossaryHdl->HasShortName(m_xNewShort->get_text())
812 && sNew != m_xOldShort->get_text())
813 {
814 std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(m_xDialog.get(),
815 VclMessageType::Info, VclButtonsType::Ok,
816 SwResId(STR_DOUBLE_SHORTNAMEreinterpret_cast<char const *>("STR_DOUBLE_SHORTNAME" "\004"
u8"Shortcut name already exists. Please choose another name."
)
)));
817 xBox->run();
818 m_xNewShort->grab_focus();
819 }
820 else
821 m_xDialog->response(RET_OK);
822}
823
824IMPL_LINK(SwGlossaryDlg, CheckBoxHdl, weld::ToggleButton&, rBox, void)void SwGlossaryDlg::LinkStubCheckBoxHdl(void * instance, weld
::ToggleButton& data) { return static_cast<SwGlossaryDlg
*>(instance)->CheckBoxHdl(data); } void SwGlossaryDlg::
CheckBoxHdl(weld::ToggleButton& rBox)
825{
826 SvxAutoCorrCfg& rCfg = SvxAutoCorrCfg::Get();
827 bool bCheck = rBox.get_active();
828 if (&rBox == m_xInsertTipCB.get())
829 rCfg.SetAutoTextTip(bCheck);
830 else if (&rBox == m_xFileRelCB.get())
831 rCfg.SetSaveRelFile(bCheck);
832 else
833 rCfg.SetSaveRelNet(bCheck);
834 rCfg.Commit();
835}
836
837IMPL_LINK(SwGlossaryDlg, KeyInputHdl, const KeyEvent&, rKEvt, bool)bool SwGlossaryDlg::LinkStubKeyInputHdl(void * instance, const
KeyEvent& data) { return static_cast<SwGlossaryDlg *>
(instance)->KeyInputHdl(data); } bool SwGlossaryDlg::KeyInputHdl
(const KeyEvent& rKEvt)
838{
839 if (rKEvt.GetKeyCode().GetCode() == KEY_DELETE)
840 {
841 DeleteEntry();
842 return true;
843 }
844 return false;
845}
846
847OUString SwGlossaryDlg::GetCurrGrpName() const
848{
849 std::unique_ptr<weld::TreeIter> xEntry = m_xCategoryBox->make_iterator();
850 if (m_xCategoryBox->get_selected(xEntry.get()))
851 {
852 if (m_xCategoryBox->get_iter_depth(*xEntry))
853 m_xCategoryBox->iter_parent(*xEntry);
854 GroupUserData* pGroupData = reinterpret_cast<GroupUserData*>(m_xCategoryBox->get_id(*xEntry).toInt64());
855 return pGroupData->sGroupName + OUStringChar(GLOS_DELIMu'*') + OUString::number(pGroupData->nPathIdx);
856 }
857 return OUString();
858}
859
860IMPL_LINK_NOARG( SwGlossaryDlg, PathHdl, weld::Button&, void )void SwGlossaryDlg::LinkStubPathHdl(void * instance, weld::Button
& data) { return static_cast<SwGlossaryDlg *>(instance
)->PathHdl(data); } void SwGlossaryDlg::PathHdl(__attribute__
((unused)) weld::Button&)
1
Calling 'SwGlossaryDlg::PathHdl'
861{
862 SvxAbstractDialogFactory* pFact = SvxAbstractDialogFactory::Create();
863 ScopedVclPtr<AbstractSvxMultiPathDialog> pDlg(pFact->CreateSvxPathSelectDialog(m_xDialog.get()));
2
Calling constructor for 'ScopedVclPtr<AbstractSvxMultiPathDialog>'
9
Returning from constructor for 'ScopedVclPtr<AbstractSvxMultiPathDialog>'
10
Calling implicit destructor for 'VclPtr<AbstractSvxMultiPathDialog>'
11
Calling '~Reference'
18
Returning from '~Reference'
19
Returning from destructor for 'VclPtr<AbstractSvxMultiPathDialog>'
864 SvtPathOptions aPathOpt;
865 const OUString sGlosPath( aPathOpt.GetAutoTextPath() );
866 pDlg->SetPath(sGlosPath);
20
Calling 'VclPtr::operator->'
867 if(RET_OK == pDlg->Execute())
868 {
869 const OUString sTmp(pDlg->GetPath());
870 if(sTmp != sGlosPath)
871 {
872 aPathOpt.SetAutoTextPath( sTmp );
873 ::GetGlossaries()->UpdateGlosPath( true );
874 Init();
875 }
876 }
877}
878
879IMPL_LINK_NOARG(SwGlossaryDlg, InsertHdl, weld::Button&, void)void SwGlossaryDlg::LinkStubInsertHdl(void * instance, weld::
Button& data) { return static_cast<SwGlossaryDlg *>
(instance)->InsertHdl(data); } void SwGlossaryDlg::InsertHdl
(__attribute__ ((unused)) weld::Button&)
880{
881 m_xDialog->response(RET_OK);
882}
883
884void SwGlossaryDlg::ShowPreview()
885{
886 ShowAutoText(::GetCurrGlosGroup(), m_xShortNameEdit->get_text());
887};
888
889IMPL_LINK_NOARG(SwGlossaryDlg, PreviewLoadedHdl, SwOneExampleFrame&, void)void SwGlossaryDlg::LinkStubPreviewLoadedHdl(void * instance,
SwOneExampleFrame& data) { return static_cast<SwGlossaryDlg
*>(instance)->PreviewLoadedHdl(data); } void SwGlossaryDlg
::PreviewLoadedHdl(__attribute__ ((unused)) SwOneExampleFrame
&)
890{
891 ResumeShowAutoText();
892}
893
894void SwGlossaryDlg::ShowAutoText(const OUString& rGroup, const OUString& rShortName)
895{
896 if (m_xExampleFrameWin->get_visible())
897 {
898 SetResumeData(rGroup, rShortName);
899 //try to make an Undo()
900 m_xExampleFrame->ClearDocument();
901 }
902}
903
904void SwGlossaryDlg::ResumeShowAutoText()
905{
906 OUString sGroup;
907 OUString sShortName;
908 if(GetResumeData(sGroup, sShortName) && m_xExampleFrameWin->get_visible())
909 {
910 if(!m_xAutoText.is())
911 {
912 //now the AutoText ListBoxes have to be filled
913 m_xAutoText = text::AutoTextContainer::create( comphelper::getProcessComponentContext() );
914 }
915
916 uno::Reference< XTextCursor > & xCursor = m_xExampleFrame->GetTextCursor();
917 if(xCursor.is())
918 {
919 if (!sShortName.isEmpty())
920 {
921 uno::Any aGroup = m_xAutoText->getByName(sGroup);
922 uno::Reference< XAutoTextGroup > xGroup;
923 if((aGroup >>= xGroup) && xGroup->hasByName(sShortName))
924 {
925 uno::Any aEntry(xGroup->getByName(sShortName));
926 uno::Reference< XAutoTextEntry > xEntry;
927 aEntry >>= xEntry;
928 xEntry->applyTo(xCursor);
929 }
930 }
931 }
932 }
933 m_bResume = false;
934}
935
936void SwGlossaryDlg::DeleteEntry()
937{
938 bool bEntry = m_xCategoryBox->get_selected(nullptr);
939
940 const OUString aTitle(m_xNameED->get_text());
941 const OUString aShortName(m_xShortNameEdit->get_text());
942
943 std::unique_ptr<weld::TreeIter> xParent;
944 std::unique_ptr<weld::TreeIter> xChild = DoesBlockExist(aTitle, aShortName);
945 if (xChild && m_xCategoryBox->get_iter_depth(*xChild))
946 {
947 xParent = m_xCategoryBox->make_iterator(xChild.get());
948 m_xCategoryBox->iter_parent(*xParent);
949 }
950
951 const bool bExists = nullptr != xChild;
952 const bool bIsGroup = bEntry && !xParent;
953
954 std::unique_ptr<weld::MessageDialog> xQuery(Application::CreateMessageDialog(m_xDialog.get(),
955 VclMessageType::Question, VclButtonsType::YesNo,
956 SwResId(STR_QUERY_DELETEreinterpret_cast<char const *>("STR_QUERY_DELETE" "\004"
u8"Delete AutoText?")
)));
957 if (bExists && !bIsGroup && RET_YES == xQuery->run())
958 {
959 if (!aTitle.isEmpty() && m_pGlossaryHdl->DelGlossary(aShortName))
960 {
961 OSL_ENSURE(xChild, "entry not found!")do { if (true && (!(xChild))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/ui/misc/glossary.cxx"
":" "961" ": "), "%s", "entry not found!"); } } while (false
)
;
962 m_xCategoryBox->select(*xParent);
963 m_xCategoryBox->remove(*xChild);
964 m_xNameED->set_text(OUString());
965 NameModify(*m_xNameED);
966 }
967 }
968}
969
970/* 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();
21
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)
3
Calling implicit copy constructor for 'VclPtr<AbstractSvxMultiPathDialog>'
4
Calling copy constructor for 'Reference<AbstractSvxMultiPathDialog>'
7
Returning from copy constructor for 'Reference<AbstractSvxMultiPathDialog>'
8
Returning from copy constructor for 'VclPtr<AbstractSvxMultiPathDialog>'
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

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