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 workctrl.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 SW_DLLIMPLEMENTATION -D SWUI_DLL_NAME="libswuilo.so" -D SYSTEM_LIBXML -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/source/core/inc -I /home/maarten/src/libreoffice/core/sw/source/filter/inc -I /home/maarten/src/libreoffice/core/sw/source/uibase/inc -I /home/maarten/src/libreoffice/core/sw/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/CustomTarget/sw/generated -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/uibase/ribbar/workctrl.cxx

/home/maarten/src/libreoffice/core/sw/source/uibase/ribbar/workctrl.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 <string_view>
23
24#include <i18nutil/unicode.hxx>
25#include <vcl/InterimItemWindow.hxx>
26#include <sfx2/dispatch.hxx>
27#include <sfx2/bindings.hxx>
28#include <sfx2/viewfrm.hxx>
29#include <swmodule.hxx>
30#include <view.hxx>
31#include <initui.hxx>
32#include <docsh.hxx>
33#include <gloshdl.hxx>
34#include <gloslst.hxx>
35#include <workctrl.hxx>
36#include <strings.hrc>
37#include <cmdid.h>
38#include <helpids.h>
39#include <wrtsh.hxx>
40#include <cppuhelper/queryinterface.hxx>
41#include <cppuhelper/supportsservice.hxx>
42#include <vcl/event.hxx>
43#include <vcl/settings.hxx>
44#include <rtl/ustring.hxx>
45#include <swabstdlg.hxx>
46#include <sfx2/zoomitem.hxx>
47#include <vcl/svapp.hxx>
48#include <vcl/weldutils.hxx>
49#include <svx/dialmgr.hxx>
50#include <svx/strings.hrc>
51#include <bitmaps.hlst>
52#include <toolkit/helper/vclunohelper.hxx>
53#include <svx/srchdlg.hxx>
54#include <com/sun/star/frame/XDispatchProvider.hpp>
55#include <com/sun/star/frame/XFrame.hpp>
56#include <com/sun/star/lang/XServiceInfo.hpp>
57#include <com/sun/star/util/XURLTransformer.hpp>
58
59// Size check
60#define NAVI_ENTRIES18 18
61
62using namespace ::com::sun::star;
63using namespace ::com::sun::star::uno;
64using namespace ::com::sun::star::beans;
65using namespace ::com::sun::star::frame;
66
67SFX_IMPL_TOOLBOX_CONTROL( SwTbxAutoTextCtrl, SfxVoidItem )SfxToolBoxControl* SwTbxAutoTextCtrl::CreateImpl( sal_uInt16 nSlotId
, sal_uInt16 nId, ToolBox &rTbx ) { return new SwTbxAutoTextCtrl
( nSlotId, nId, rTbx ); } void SwTbxAutoTextCtrl::RegisterControl
(sal_uInt16 nSlotId, SfxModule *pMod) { SfxToolBoxControl::RegisterToolBoxControl
( pMod, SfxTbxCtrlFactory( SwTbxAutoTextCtrl::CreateImpl, typeid
(SfxVoidItem), nSlotId ) ); };
68
69SwTbxAutoTextCtrl::SwTbxAutoTextCtrl(
70 sal_uInt16 nSlotId,
71 sal_uInt16 nId,
72 ToolBox& rTbx ) :
73 SfxToolBoxControl( nSlotId, nId, rTbx )
74{
75 rTbx.SetItemBits( nId, ToolBoxItemBits::DROPDOWN | rTbx.GetItemBits( nId ) );
76}
77
78SwTbxAutoTextCtrl::~SwTbxAutoTextCtrl()
79{
80}
81
82void SwTbxAutoTextCtrl::CreatePopupWindow()
83{
84 SwView* pView = ::GetActiveView();
85 if(pView && !pView->GetDocShell()->IsReadOnly() &&
86 !pView->GetWrtShell().HasReadonlySel() )
87 {
88 Link<Menu*,bool> aLnk = LINK(this, SwTbxAutoTextCtrl, PopupHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwTbxAutoTextCtrl
*>(this), &SwTbxAutoTextCtrl::LinkStubPopupHdl);
89
90 ScopedVclPtrInstance<PopupMenu> pPopup;
91 SwGlossaryList* pGlossaryList = ::GetGlossaryList();
92 const size_t nGroupCount = pGlossaryList->GetGroupCount();
93 for(size_t i = 1; i <= nGroupCount; ++i)
94 {
95 OUString sTitle = pGlossaryList->GetGroupTitle(i - 1);
96 const sal_uInt16 nBlockCount = pGlossaryList->GetBlockCount(i -1);
97 if(nBlockCount)
98 {
99 sal_uInt16 nIndex = static_cast<sal_uInt16>(100*i);
100 // but insert without extension
101 pPopup->InsertItem( i, sTitle);
102 VclPtrInstance<PopupMenu> pSub;
103 pSub->SetSelectHdl(aLnk);
104 pPopup->SetPopupMenu(i, pSub);
105 for(sal_uInt16 j = 0; j < nBlockCount; j++)
106 {
107 OUString sLongName(pGlossaryList->GetBlockLongName(i - 1, j));
108 OUString sShortName(pGlossaryList->GetBlockShortName(i - 1, j));
109
110 OUString sEntry = sShortName + " - " + sLongName;
111 pSub->InsertItem(++nIndex, sEntry);
112 }
113 }
114 }
115
116 ToolBox* pToolBox = &GetToolBox();
117 sal_uInt16 nId = GetId();
118 pToolBox->SetItemDown( nId, true );
119
120 pPopup->Execute( pToolBox, pToolBox->GetItemRect( nId ),
121 (pToolBox->GetAlign() == WindowAlign::Top || pToolBox->GetAlign() == WindowAlign::Bottom) ?
122 PopupMenuFlags::ExecuteDown : PopupMenuFlags::ExecuteRight );
123
124 pToolBox->SetItemDown( nId, false );
125 }
126 GetToolBox().EndSelection();
127}
128
129void SwTbxAutoTextCtrl::StateChanged( sal_uInt16,
130 SfxItemState,
131 const SfxPoolItem* pState )
132{
133 GetToolBox().EnableItem( GetId(), (GetItemState(pState) != SfxItemState::DISABLED) );
134}
135
136IMPL_STATIC_LINK(SwTbxAutoTextCtrl, PopupHdl, Menu*, pMenu, bool)bool SwTbxAutoTextCtrl::LinkStubPopupHdl(void * instance, Menu
* data) { return PopupHdl(static_cast<SwTbxAutoTextCtrl *>
(instance), data); } bool SwTbxAutoTextCtrl::PopupHdl(__attribute__
((unused)) SwTbxAutoTextCtrl *, Menu* pMenu)
137{
138 sal_uInt16 nId = pMenu->GetCurItemId();
139
140 sal_uInt16 nBlock = nId / 100;
141
142 SwGlossaryList* pGlossaryList = ::GetGlossaryList();
143 OUString sGroup = pGlossaryList->GetGroupName(nBlock - 1);
144 OUString sShortName =
145 pGlossaryList->GetBlockShortName(nBlock - 1, nId - (100 * nBlock) - 1);
146
147 SwGlossaryHdl* pGlosHdl = ::GetActiveView()->GetGlosHdl();
148 SwAbstractDialogFactory* pFact = SwAbstractDialogFactory::Create();
149 ::GlossarySetActGroup fnSetActGroup = pFact->SetGlossaryActGroupFunc();
150 if ( fnSetActGroup )
151 (*fnSetActGroup)( sGroup );
152 pGlosHdl->SetCurGroup(sGroup, true);
153 pGlosHdl->InsertGlossary(sShortName);
154
155 return false;
156}
157
158// Navigation-Popup
159// determine the order of the toolbox items
160static sal_uInt16 aNavigationInsertIds[ NAVI_ENTRIES18 ] =
161{
162 NID_TBL20000,
163 NID_FRM20001,
164 NID_GRF20007,
165 NID_OLE20008,
166 NID_PGE20002,
167 NID_OUTL20009,
168 NID_MARK20012,
169 NID_DRW20003,
170 NID_CTRL20004,
171 NID_REG20005,
172 NID_BKM20006,
173 NID_SEL20010,
174 NID_FTN20011,
175 NID_POSTIT20013,
176 NID_SRCH_REP20014,
177 NID_INDEX_ENTRY20015,
178 NID_TABLE_FORMULA20016,
179 NID_TABLE_FORMULA_ERROR20017
180};
181
182std::u16string_view const aNavigationImgIds[ NAVI_ENTRIES18 ] =
183{
184 u"" RID_BMP_RIBBAR_TBL"sw/res/sr20002.png",
185 u"" RID_BMP_RIBBAR_FRM"sw/res/sr20003.png",
186 u"" RID_BMP_RIBBAR_GRF"sw/res/sr20009.png",
187 u"" RID_BMP_RIBBAR_OLE"sw/res/sr20010.png",
188 u"" RID_BMP_RIBBAR_PGE"sw/res/sr20004.png",
189 u"" RID_BMP_RIBBAR_OUTL"sw/res/sr20011.png",
190 u"" RID_BMP_RIBBAR_MARK"sw/res/sr20014.png",
191 u"" RID_BMP_RIBBAR_DRW"sw/res/sr20005.png",
192 u"" RID_BMP_RIBBAR_CTRL"sw/res/sr20006.png",
193 u"" RID_BMP_RIBBAR_REG"sw/res/sr20007.png",
194 u"" RID_BMP_RIBBAR_BKM"sw/res/sr20008.png",
195 u"" RID_BMP_RIBBAR_SEL"sw/res/sr20012.png",
196 u"" RID_BMP_RIBBAR_FTN"sw/res/sr20013.png",
197 u"" RID_BMP_RIBBAR_POSTIT"sw/res/sr20015.png",
198 u"" RID_BMP_RIBBAR_REP"sw/res/sr20016.png",
199 u"" RID_BMP_RIBBAR_ENTRY"sw/res/sr20017.png",
200 u"" RID_BMP_RIBBAR_FORMULA"sw/res/sr20018.png",
201 u"" RID_BMP_RIBBAR_ERROR"sw/res/sr20019.png"
202};
203
204static const char* aNavigationStrIds[ NAVI_ENTRIES18 ] =
205{
206 ST_TBLreinterpret_cast<char const *>("ST_TBL" "\004" u8"Table"
),
207 ST_FRMreinterpret_cast<char const *>("ST_FRM" "\004" u8"Text Frame"
),
208 ST_GRFreinterpret_cast<char const *>("ST_GRF" "\004" u8"Graphics"
),
209 ST_OLEreinterpret_cast<char const *>("ST_OLE" "\004" u8"OLE object"
),
210 ST_PGEreinterpret_cast<char const *>("ST_PGE" "\004" u8"Page"
),
211 ST_OUTLreinterpret_cast<char const *>("ST_OUTL" "\004" u8"Headings"
),
212 ST_MARKreinterpret_cast<char const *>("ST_MARK" "\004" u8"Reminder"
),
213 ST_DRWreinterpret_cast<char const *>("ST_DRW" "\004" u8"Drawing"
),
214 ST_CTRLreinterpret_cast<char const *>("ST_CTRL" "\004" u8"Control"
),
215 ST_REGreinterpret_cast<char const *>("ST_REG" "\004" u8"Section"
),
216 ST_BKMreinterpret_cast<char const *>("ST_BKM" "\004" u8"Bookmark"
),
217 ST_SELreinterpret_cast<char const *>("ST_SEL" "\004" u8"Selection"
),
218 ST_FTNreinterpret_cast<char const *>("ST_FTN" "\004" u8"Footnote"
),
219 ST_POSTITreinterpret_cast<char const *>("ST_POSTIT" "\004" u8"Comment"
),
220 ST_SRCH_REPreinterpret_cast<char const *>("ST_SRCH_REP" "\004" u8"Repeat search"
),
221 ST_INDEX_ENTRYreinterpret_cast<char const *>("ST_INDEX_ENTRY" "\004" u8"Index entry"
),
222 ST_TABLE_FORMULAreinterpret_cast<char const *>("ST_TABLE_FORMULA" "\004"
u8"Table formula"),
223 ST_TABLE_FORMULA_ERRORreinterpret_cast<char const *>("ST_TABLE_FORMULA_ERROR"
"\004" u8"Wrong table formula")
224};
225
226// these are global strings
227static const char* STR_IMGBTN_ARY[] =
228{
229 STR_IMGBTN_TBL_DOWNreinterpret_cast<char const *>("STR_IMGBTN_TBL_DOWN" "\004"
u8"Next table"),
230 STR_IMGBTN_FRM_DOWNreinterpret_cast<char const *>("STR_IMGBTN_FRM_DOWN" "\004"
u8"Next text frame"),
231 STR_IMGBTN_PGE_DOWNreinterpret_cast<char const *>("STR_IMGBTN_PGE_DOWN" "\004"
u8"Next page"),
232 STR_IMGBTN_DRW_DOWNreinterpret_cast<char const *>("STR_IMGBTN_DRW_DOWN" "\004"
u8"Next drawing"),
233 STR_IMGBTN_CTRL_DOWNreinterpret_cast<char const *>("STR_IMGBTN_CTRL_DOWN" "\004"
u8"Next control"),
234 STR_IMGBTN_REG_DOWNreinterpret_cast<char const *>("STR_IMGBTN_REG_DOWN" "\004"
u8"Next section"),
235 STR_IMGBTN_BKM_DOWNreinterpret_cast<char const *>("STR_IMGBTN_BKM_DOWN" "\004"
u8"Next bookmark"),
236 STR_IMGBTN_GRF_DOWNreinterpret_cast<char const *>("STR_IMGBTN_GRF_DOWN" "\004"
u8"Next graphic"),
237 STR_IMGBTN_OLE_DOWNreinterpret_cast<char const *>("STR_IMGBTN_OLE_DOWN" "\004"
u8"Next OLE object"),
238 STR_IMGBTN_OUTL_DOWNreinterpret_cast<char const *>("STR_IMGBTN_OUTL_DOWN" "\004"
u8"Next heading"),
239 STR_IMGBTN_SEL_DOWNreinterpret_cast<char const *>("STR_IMGBTN_SEL_DOWN" "\004"
u8"Next selection"),
240 STR_IMGBTN_FTN_DOWNreinterpret_cast<char const *>("STR_IMGBTN_FTN_DOWN" "\004"
u8"Next footnote"),
241 STR_IMGBTN_MARK_DOWNreinterpret_cast<char const *>("STR_IMGBTN_MARK_DOWN" "\004"
u8"Next Reminder"),
242 STR_IMGBTN_POSTIT_DOWNreinterpret_cast<char const *>("STR_IMGBTN_POSTIT_DOWN"
"\004" u8"Next Comment"),
243 STR_IMGBTN_SRCH_REP_DOWNreinterpret_cast<char const *>("STR_IMGBTN_SRCH_REP_DOWN"
"\004" u8"Continue search forward"),
244 STR_IMGBTN_INDEX_ENTRY_DOWNreinterpret_cast<char const *>("STR_IMGBTN_INDEX_ENTRY_DOWN"
"\004" u8"Next index entry"),
245 STR_IMGBTN_TBLFML_DOWNreinterpret_cast<char const *>("STR_IMGBTN_TBLFML_DOWN"
"\004" u8"Next table formula"),
246 STR_IMGBTN_TBLFML_ERR_DOWNreinterpret_cast<char const *>("STR_IMGBTN_TBLFML_ERR_DOWN"
"\004" u8"Next faulty table formula"),
247 STR_IMGBTN_TBL_UPreinterpret_cast<char const *>("STR_IMGBTN_TBL_UP" "\004"
u8"Previous table"),
248 STR_IMGBTN_FRM_UPreinterpret_cast<char const *>("STR_IMGBTN_FRM_UP" "\004"
u8"Previous text frame"),
249 STR_IMGBTN_PGE_UPreinterpret_cast<char const *>("STR_IMGBTN_PGE_UP" "\004"
u8"Previous page"),
250 STR_IMGBTN_DRW_UPreinterpret_cast<char const *>("STR_IMGBTN_DRW_UP" "\004"
u8"Previous drawing"),
251 STR_IMGBTN_CTRL_UPreinterpret_cast<char const *>("STR_IMGBTN_CTRL_UP" "\004"
u8"Previous control"),
252 STR_IMGBTN_REG_UPreinterpret_cast<char const *>("STR_IMGBTN_REG_UP" "\004"
u8"Previous section"),
253 STR_IMGBTN_BKM_UPreinterpret_cast<char const *>("STR_IMGBTN_BKM_UP" "\004"
u8"Previous bookmark"),
254 STR_IMGBTN_GRF_UPreinterpret_cast<char const *>("STR_IMGBTN_GRF_UP" "\004"
u8"Previous graphic"),
255 STR_IMGBTN_OLE_UPreinterpret_cast<char const *>("STR_IMGBTN_OLE_UP" "\004"
u8"Previous OLE object"),
256 STR_IMGBTN_OUTL_UPreinterpret_cast<char const *>("STR_IMGBTN_OUTL_UP" "\004"
u8"Previous heading"),
257 STR_IMGBTN_SEL_UPreinterpret_cast<char const *>("STR_IMGBTN_SEL_UP" "\004"
u8"Previous selection"),
258 STR_IMGBTN_FTN_UPreinterpret_cast<char const *>("STR_IMGBTN_FTN_UP" "\004"
u8"Previous footnote"),
259 STR_IMGBTN_MARK_UPreinterpret_cast<char const *>("STR_IMGBTN_MARK_UP" "\004"
u8"Previous Reminder"),
260 STR_IMGBTN_POSTIT_UPreinterpret_cast<char const *>("STR_IMGBTN_POSTIT_UP" "\004"
u8"Previous Comment"),
261 STR_IMGBTN_SRCH_REP_UPreinterpret_cast<char const *>("STR_IMGBTN_SRCH_REP_UP"
"\004" u8"Continue search backwards"),
262 STR_IMGBTN_INDEX_ENTRY_UPreinterpret_cast<char const *>("STR_IMGBTN_INDEX_ENTRY_UP"
"\004" u8"Previous index entry"),
263 STR_IMGBTN_TBLFML_UPreinterpret_cast<char const *>("STR_IMGBTN_TBLFML_UP" "\004"
u8"Previous table formula"),
264 STR_IMGBTN_TBLFML_ERR_UPreinterpret_cast<char const *>("STR_IMGBTN_TBLFML_ERR_UP"
"\004" u8"Previous faulty table formula")
265};
266
267static OUString lcl_GetScrollToolTip(bool bNext)
268{
269 sal_uInt16 nResId = SwView::GetMoveType();
270 if (!bNext)
271 nResId += NID_COUNT18;
272 const char* id = STR_IMGBTN_ARY[nResId - NID_START20000];
273 return id ? SwResId(id): OUString();
274}
275
276namespace {
277
278class SwZoomBox_Impl final : public InterimItemWindow
279{
280 std::unique_ptr<weld::ComboBox> m_xWidget;
281 sal_uInt16 nSlotId;
282 bool bRelease;
283
284 DECL_LINK(SelectHdl, weld::ComboBox&, void)static void LinkStubSelectHdl(void *, weld::ComboBox&); void
SelectHdl(weld::ComboBox&);
285 DECL_LINK(KeyInputHdl, const KeyEvent&, bool)static bool LinkStubKeyInputHdl(void *, const KeyEvent&);
bool KeyInputHdl(const KeyEvent&);
286 DECL_LINK(ActivateHdl, weld::ComboBox&, bool)static bool LinkStubActivateHdl(void *, weld::ComboBox&);
bool ActivateHdl(weld::ComboBox&);
287 DECL_LINK(FocusOutHdl, weld::Widget&, void)static void LinkStubFocusOutHdl(void *, weld::Widget&); void
FocusOutHdl(weld::Widget&);
288
289 void Select();
290
291 void ReleaseFocus();
292
293public:
294 SwZoomBox_Impl(vcl::Window* pParent, sal_uInt16 nSlot);
295
296 virtual void dispose() override
297 {
298 m_xWidget.reset();
299 InterimItemWindow::dispose();
300 }
301
302 void save_value()
303 {
304 m_xWidget->save_value();
305 }
306
307 void set_entry_text(const OUString& rText)
308 {
309 m_xWidget->set_entry_text(rText);
310 }
311
312 virtual ~SwZoomBox_Impl() override
313 {
314 disposeOnce();
315 }
316};
317
318}
319
320SwZoomBox_Impl::SwZoomBox_Impl(vcl::Window* pParent, sal_uInt16 nSlot)
321 : InterimItemWindow(pParent, "modules/swriter/ui/zoombox.ui", "ZoomBox")
322 , m_xWidget(m_xBuilder->weld_combo_box("zoom"))
323 , nSlotId(nSlot)
324 , bRelease(true)
325{
326 InitControlBase(m_xWidget.get());
327
328 m_xWidget->set_help_id(HID_PVIEW_ZOOM_LB"SW_HID_PVIEW_ZOOM_LB");
329 m_xWidget->set_entry_completion(false);
330 m_xWidget->connect_changed(LINK(this, SwZoomBox_Impl, SelectHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwZoomBox_Impl
*>(this), &SwZoomBox_Impl::LinkStubSelectHdl));
331 m_xWidget->connect_key_press(LINK(this, SwZoomBox_Impl, KeyInputHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwZoomBox_Impl
*>(this), &SwZoomBox_Impl::LinkStubKeyInputHdl));
332 m_xWidget->connect_entry_activate(LINK(this, SwZoomBox_Impl, ActivateHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwZoomBox_Impl
*>(this), &SwZoomBox_Impl::LinkStubActivateHdl));
333 m_xWidget->connect_focus_out(LINK(this, SwZoomBox_Impl, FocusOutHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwZoomBox_Impl
*>(this), &SwZoomBox_Impl::LinkStubFocusOutHdl));
334
335 const char* const aZoomValues[] =
336 { RID_SVXSTR_ZOOM_25reinterpret_cast<char const *>("RID_SVXSTR_ZOOM_25" "\004"
u8"25%") , RID_SVXSTR_ZOOM_50reinterpret_cast<char const *>("RID_SVXSTR_ZOOM_50" "\004"
u8"50%") ,
337 RID_SVXSTR_ZOOM_75reinterpret_cast<char const *>("RID_SVXSTR_ZOOM_75" "\004"
u8"75%") , RID_SVXSTR_ZOOM_100reinterpret_cast<char const *>("RID_SVXSTR_ZOOM_100" "\004"
u8"100%") ,
338 RID_SVXSTR_ZOOM_150reinterpret_cast<char const *>("RID_SVXSTR_ZOOM_150" "\004"
u8"150%") , RID_SVXSTR_ZOOM_200reinterpret_cast<char const *>("RID_SVXSTR_ZOOM_200" "\004"
u8"200%") ,
339 RID_SVXSTR_ZOOM_WHOLE_PAGEreinterpret_cast<char const *>("RID_SVXSTR_ZOOM_WHOLE_PAGE"
"\004" u8"Entire Page"), RID_SVXSTR_ZOOM_PAGE_WIDTHreinterpret_cast<char const *>("RID_SVXSTR_ZOOM_PAGE_WIDTH"
"\004" u8"Page Width") ,
340 RID_SVXSTR_ZOOM_OPTIMAL_VIEWreinterpret_cast<char const *>("RID_SVXSTR_ZOOM_OPTIMAL_VIEW"
"\004" u8"Optimal View") };
341 for(const char* pZoomValue : aZoomValues)
342 {
343 OUString sEntry = SvxResId(pZoomValue);
344 m_xWidget->append_text(sEntry);
345 }
346
347 int nWidth = m_xWidget->get_pixel_size(SvxResId(RID_SVXSTR_ZOOM_200reinterpret_cast<char const *>("RID_SVXSTR_ZOOM_200" "\004"
u8"200%"))).Width();
348 m_xWidget->set_entry_width_chars(std::ceil(nWidth / m_xWidget->get_approximate_digit_width()));
349
350 SetSizePixel(m_xWidget->get_preferred_size());
351}
352
353IMPL_LINK(SwZoomBox_Impl, SelectHdl, weld::ComboBox&, rComboBox, void)void SwZoomBox_Impl::LinkStubSelectHdl(void * instance, weld::
ComboBox& data) { return static_cast<SwZoomBox_Impl *>
(instance)->SelectHdl(data); } void SwZoomBox_Impl::SelectHdl
(weld::ComboBox& rComboBox)
354{
355 if (rComboBox.changed_by_direct_pick()) // only when picked from the list
356 Select();
357}
358
359IMPL_LINK_NOARG(SwZoomBox_Impl, ActivateHdl, weld::ComboBox&, bool)bool SwZoomBox_Impl::LinkStubActivateHdl(void * instance, weld
::ComboBox& data) { return static_cast<SwZoomBox_Impl *
>(instance)->ActivateHdl(data); } bool SwZoomBox_Impl::
ActivateHdl(__attribute__ ((unused)) weld::ComboBox&)
360{
361 Select();
362 return true;
363}
364
365void SwZoomBox_Impl::Select()
366{
367 if( FN_PREVIEW_ZOOM((20000 + 200) + 51) == nSlotId )
368 {
369 bool bNonNumeric = true;
370
371 OUString sEntry = m_xWidget->get_active_text().replaceAll("%", "");
372 SvxZoomItem aZoom(SvxZoomType::PERCENT,100);
373 if(sEntry == SvxResId( RID_SVXSTR_ZOOM_PAGE_WIDTHreinterpret_cast<char const *>("RID_SVXSTR_ZOOM_PAGE_WIDTH"
"\004" u8"Page Width") ) )
374 aZoom.SetType(SvxZoomType::PAGEWIDTH);
375 else if(sEntry == SvxResId( RID_SVXSTR_ZOOM_OPTIMAL_VIEWreinterpret_cast<char const *>("RID_SVXSTR_ZOOM_OPTIMAL_VIEW"
"\004" u8"Optimal View") ) )
376 aZoom.SetType(SvxZoomType::OPTIMAL);
377 else if(sEntry == SvxResId( RID_SVXSTR_ZOOM_WHOLE_PAGEreinterpret_cast<char const *>("RID_SVXSTR_ZOOM_WHOLE_PAGE"
"\004" u8"Entire Page")) )
378 aZoom.SetType(SvxZoomType::WHOLEPAGE);
379 else
380 {
381 bNonNumeric = false;
382
383 sal_uInt16 nZoom = static_cast<sal_uInt16>(sEntry.toInt32());
384 if(nZoom < MINZOOM20)
385 nZoom = MINZOOM20;
386 if(nZoom > MAXZOOM600)
387 nZoom = MAXZOOM600;
388 aZoom.SetValue(nZoom);
389 }
390
391 if (bNonNumeric)
392 {
393 // put old value back, in case its effectively the same
394 // as the picked option and no update to number comes
395 // back from writer
396 m_xWidget->set_entry_text(m_xWidget->get_saved_value());
397 }
398
399 SfxObjectShell* pCurrentShell = SfxObjectShell::Current();
400
401 pCurrentShell->GetDispatcher()->ExecuteList(SID_ATTR_ZOOMTypedWhichId<SvxZoomItem>(10000 + 0),
402 SfxCallMode::ASYNCHRON, { &aZoom });
403 }
404 ReleaseFocus();
405}
406
407IMPL_LINK(SwZoomBox_Impl, KeyInputHdl, const KeyEvent&, rKEvt, bool)bool SwZoomBox_Impl::LinkStubKeyInputHdl(void * instance, const
KeyEvent& data) { return static_cast<SwZoomBox_Impl *
>(instance)->KeyInputHdl(data); } bool SwZoomBox_Impl::
KeyInputHdl(const KeyEvent& rKEvt)
408{
409 bool bHandled = false;
410
411 sal_uInt16 nCode = rKEvt.GetKeyCode().GetCode();
412
413 switch (nCode)
414 {
415 case KEY_TAB:
416 bRelease = false;
417 Select();
418 break;
419
420 case KEY_ESCAPE:
421 m_xWidget->set_entry_text(m_xWidget->get_saved_value());
422 ReleaseFocus();
423 bHandled = true;
424 break;
425 }
426
427 return bHandled || ChildKeyInput(rKEvt);
428}
429
430IMPL_LINK_NOARG(SwZoomBox_Impl, FocusOutHdl, weld::Widget&, void)void SwZoomBox_Impl::LinkStubFocusOutHdl(void * instance, weld
::Widget& data) { return static_cast<SwZoomBox_Impl *>
(instance)->FocusOutHdl(data); } void SwZoomBox_Impl::FocusOutHdl
(__attribute__ ((unused)) weld::Widget&)
431{
432 if (!m_xWidget->has_focus()) // a combobox can be comprised of different subwidget so double-check if none of those has focus
433 m_xWidget->set_entry_text(m_xWidget->get_saved_value());
434}
435
436void SwZoomBox_Impl::ReleaseFocus()
437{
438 if ( !bRelease )
439 {
440 bRelease = true;
441 return;
442 }
443 SfxViewShell* pCurSh = SfxViewShell::Current();
444
445 if ( pCurSh )
446 {
447 vcl::Window* pShellWnd = pCurSh->GetWindow();
448
449 if ( pShellWnd )
450 pShellWnd->GrabFocus();
451 }
452}
453
454SFX_IMPL_TOOLBOX_CONTROL( SwPreviewZoomControl, SfxUInt16Item)SfxToolBoxControl* SwPreviewZoomControl::CreateImpl( sal_uInt16
nSlotId, sal_uInt16 nId, ToolBox &rTbx ) { return new SwPreviewZoomControl
( nSlotId, nId, rTbx ); } void SwPreviewZoomControl::RegisterControl
(sal_uInt16 nSlotId, SfxModule *pMod) { SfxToolBoxControl::RegisterToolBoxControl
( pMod, SfxTbxCtrlFactory( SwPreviewZoomControl::CreateImpl, typeid
(SfxUInt16Item), nSlotId ) ); };
455
456SwPreviewZoomControl::SwPreviewZoomControl(
457 sal_uInt16 nSlotId,
458 sal_uInt16 nId,
459 ToolBox& rTbx) :
460 SfxToolBoxControl( nSlotId, nId, rTbx )
461{
462}
463
464SwPreviewZoomControl::~SwPreviewZoomControl()
465{
466}
467
468void SwPreviewZoomControl::StateChanged( sal_uInt16 /*nSID*/,
469 SfxItemState eState,
470 const SfxPoolItem* pState )
471{
472 sal_uInt16 nId = GetId();
473 GetToolBox().EnableItem( nId, (GetItemState(pState) != SfxItemState::DISABLED) );
474 SwZoomBox_Impl* pBox = static_cast<SwZoomBox_Impl*>(GetToolBox().GetItemWindow( GetId() ));
475 if(SfxItemState::DEFAULT <= eState)
476 {
477 OUString sZoom(unicode::formatPercent(static_cast<const SfxUInt16Item*>(pState)->GetValue(),
478 Application::GetSettings().GetUILanguageTag()));
479 pBox->set_entry_text(sZoom);
480 pBox->save_value();
481 }
482}
483
484VclPtr<InterimItemWindow> SwPreviewZoomControl::CreateItemWindow( vcl::Window *pParent )
485{
486 VclPtrInstance<SwZoomBox_Impl> pRet( pParent, GetSlotId() );
487 return pRet.get();
488}
489
490namespace {
491
492class SwJumpToSpecificBox_Impl final : public InterimItemWindow
493{
494 std::unique_ptr<weld::Entry> m_xWidget;
495
496 sal_uInt16 nSlotId;
497
498 DECL_LINK(KeyInputHdl, const KeyEvent&, bool)static bool LinkStubKeyInputHdl(void *, const KeyEvent&);
bool KeyInputHdl(const KeyEvent&);
499 DECL_LINK(SelectHdl, weld::Entry&, bool)static bool LinkStubSelectHdl(void *, weld::Entry&); bool
SelectHdl(weld::Entry&);
500public:
501 SwJumpToSpecificBox_Impl(vcl::Window* pParent, sal_uInt16 nSlot);
502 virtual void dispose() override
503 {
504 m_xWidget.reset();
505 InterimItemWindow::dispose();
506 }
507 virtual ~SwJumpToSpecificBox_Impl() override
508 {
509 disposeOnce();
510 }
511};
512
513}
514
515IMPL_LINK(SwJumpToSpecificBox_Impl, KeyInputHdl, const KeyEvent&, rKEvt, bool)bool SwJumpToSpecificBox_Impl::LinkStubKeyInputHdl(void * instance
, const KeyEvent& data) { return static_cast<SwJumpToSpecificBox_Impl
*>(instance)->KeyInputHdl(data); } bool SwJumpToSpecificBox_Impl
::KeyInputHdl(const KeyEvent& rKEvt)
516{
517 return ChildKeyInput(rKEvt);
518}
519
520SwJumpToSpecificBox_Impl::SwJumpToSpecificBox_Impl(vcl::Window* pParent, sal_uInt16 nSlot)
521 : InterimItemWindow(pParent, "modules/swriter/ui/jumpposbox.ui", "JumpPosBox")
522 , m_xWidget(m_xBuilder->weld_entry("jumppos"))
523 , nSlotId(nSlot)
524{
525 InitControlBase(m_xWidget.get());
526
527 m_xWidget->connect_key_press(LINK(this, SwJumpToSpecificBox_Impl, KeyInputHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwJumpToSpecificBox_Impl
*>(this), &SwJumpToSpecificBox_Impl::LinkStubKeyInputHdl
));
528 m_xWidget->connect_activate(LINK(this, SwJumpToSpecificBox_Impl, SelectHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwJumpToSpecificBox_Impl
*>(this), &SwJumpToSpecificBox_Impl::LinkStubSelectHdl
));
529
530 SetSizePixel(m_xWidget->get_preferred_size());
531}
532
533IMPL_LINK_NOARG(SwJumpToSpecificBox_Impl, SelectHdl, weld::Entry&, bool)bool SwJumpToSpecificBox_Impl::LinkStubSelectHdl(void * instance
, weld::Entry& data) { return static_cast<SwJumpToSpecificBox_Impl
*>(instance)->SelectHdl(data); } bool SwJumpToSpecificBox_Impl
::SelectHdl(__attribute__ ((unused)) weld::Entry&)
534{
535 OUString sEntry(m_xWidget->get_text());
536 SfxUInt16Item aPageNum(nSlotId);
537 aPageNum.SetValue(static_cast<sal_uInt16>(sEntry.toInt32()));
538 SfxObjectShell* pCurrentShell = SfxObjectShell::Current();
539 pCurrentShell->GetDispatcher()->ExecuteList(nSlotId, SfxCallMode::ASYNCHRON,
540 { &aPageNum });
541 return true;
542}
543
544SFX_IMPL_TOOLBOX_CONTROL( SwJumpToSpecificPageControl, SfxUInt16Item)SfxToolBoxControl* SwJumpToSpecificPageControl::CreateImpl( sal_uInt16
nSlotId, sal_uInt16 nId, ToolBox &rTbx ) { return new SwJumpToSpecificPageControl
( nSlotId, nId, rTbx ); } void SwJumpToSpecificPageControl::RegisterControl
(sal_uInt16 nSlotId, SfxModule *pMod) { SfxToolBoxControl::RegisterToolBoxControl
( pMod, SfxTbxCtrlFactory( SwJumpToSpecificPageControl::CreateImpl
, typeid(SfxUInt16Item), nSlotId ) ); };
545
546SwJumpToSpecificPageControl::SwJumpToSpecificPageControl(
547 sal_uInt16 nSlotId,
548 sal_uInt16 nId,
549 ToolBox& rTbx) :
550 SfxToolBoxControl( nSlotId, nId, rTbx )
551{}
552
553SwJumpToSpecificPageControl::~SwJumpToSpecificPageControl()
554{}
555
556VclPtr<InterimItemWindow> SwJumpToSpecificPageControl::CreateItemWindow( vcl::Window *pParent )
557{
558 VclPtrInstance<SwJumpToSpecificBox_Impl> pRet( pParent, GetSlotId() );
559 return pRet.get();
560}
561
562namespace {
563
564class NavElementBox_Base;
565class NavElementBox_Impl;
566
567class NavElementToolBoxControl : public svt::ToolboxController,
568 public lang::XServiceInfo
569{
570 public:
571 explicit NavElementToolBoxControl(
572 const css::uno::Reference< css::uno::XComponentContext >& rServiceManager );
573
574 // XInterface
575 virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
576 virtual void SAL_CALL acquire() throw () override;
577 virtual void SAL_CALL release() throw () override;
578
579 // XServiceInfo
580 virtual OUString SAL_CALL getImplementationName() override;
581 virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
582 virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
583
584 // XComponent
585 virtual void SAL_CALL dispose() override;
586
587 // XStatusListener
588 virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& Event ) override;
589
590 // XToolbarController
591 virtual void SAL_CALL execute( sal_Int16 KeyModifier ) override;
592 virtual void SAL_CALL click() override;
593 virtual void SAL_CALL doubleClick() override;
594 virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createPopupWindow() override;
595 virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createItemWindow( const css::uno::Reference< css::awt::XWindow >& Parent ) override;
596
597 void dispatchCommand( const css::uno::Sequence< css::beans::PropertyValue >& rArgs );
598 using svt::ToolboxController::dispatchCommand;
599
600 private:
601 VclPtr<NavElementBox_Impl> m_xVclBox;
602 std::unique_ptr<NavElementBox_Base> m_xWeldBox;
603 NavElementBox_Base* m_pBox;
604};
605
606class NavElementBox_Base
607{
608public:
609 NavElementBox_Base(std::unique_ptr<weld::ComboBox> xWidget,
610 const uno::Reference<frame::XFrame>& _xFrame,
611 NavElementToolBoxControl& rCtrl);
612
613 virtual ~NavElementBox_Base()
614 {
615 }
616
617 void set_sensitive(bool bSensitive)
618 {
619 m_xWidget->set_sensitive(bSensitive);
620 }
621
622 void UpdateBox();
623
624protected:
625 std::unique_ptr<weld::ComboBox> m_xWidget;
626 NavElementToolBoxControl* m_pCtrl;
627 bool m_bRelease;
628 uno::Reference< frame::XFrame > m_xFrame;
629
630 virtual bool DoKeyInput(const KeyEvent& rKEvt);
631
632 DECL_LINK(SelectHdl, weld::ComboBox&, void)static void LinkStubSelectHdl(void *, weld::ComboBox&); void
SelectHdl(weld::ComboBox&);
633 DECL_LINK(KeyInputHdl, const KeyEvent&, bool)static bool LinkStubKeyInputHdl(void *, const KeyEvent&);
bool KeyInputHdl(const KeyEvent&);
634
635 void ReleaseFocus_Impl();
636};
637
638
639class NavElementBox_Impl final : public InterimItemWindow
640 , public NavElementBox_Base
641{
642public:
643 NavElementBox_Impl(vcl::Window* pParent,
644 const uno::Reference<frame::XFrame>& _xFrame,
645 NavElementToolBoxControl& rCtrl);
646
647 virtual void dispose() override
648 {
649 m_xWidget.reset();
650 InterimItemWindow::dispose();
651 }
652
653 virtual void GetFocus() override
654 {
655 if (m_xWidget)
656 m_xWidget->grab_focus();
657 InterimItemWindow::GetFocus();
658 }
659
660 virtual bool DoKeyInput(const KeyEvent& rKEvt) override;
661
662 virtual ~NavElementBox_Impl() override
663 {
664 disposeOnce();
665 }
666};
667
668}
669
670NavElementBox_Base::NavElementBox_Base(
671 std::unique_ptr<weld::ComboBox> xWidget,
672 const uno::Reference< frame::XFrame >& _xFrame,
673 NavElementToolBoxControl& _rCtrl )
674 : m_xWidget(std::move(xWidget))
675 , m_pCtrl(&_rCtrl)
676 , m_bRelease(true)
677 , m_xFrame(_xFrame)
678{
679 m_xWidget->set_size_request(150, -1);
680
681 m_xWidget->make_sorted();
682 m_xWidget->freeze();
683 for (sal_uInt16 i = 0; i < NID_COUNT18; i++)
684 m_xWidget->append(OUString::number(aNavigationInsertIds[i]), SwResId(aNavigationStrIds[i]), aNavigationImgIds[i]);
685 m_xWidget->thaw();
686
687 m_xWidget->connect_changed(LINK(this, NavElementBox_Base, SelectHdl)::tools::detail::makeLink( ::tools::detail::castTo<NavElementBox_Base
*>(this), &NavElementBox_Base::LinkStubSelectHdl));
688 m_xWidget->connect_key_press(LINK(this, NavElementBox_Base, KeyInputHdl)::tools::detail::makeLink( ::tools::detail::castTo<NavElementBox_Base
*>(this), &NavElementBox_Base::LinkStubKeyInputHdl));
689}
690
691NavElementBox_Impl::NavElementBox_Impl(
692 vcl::Window* _pParent,
693 const uno::Reference< frame::XFrame >& _xFrame,
694 NavElementToolBoxControl& _rCtrl )
695 : InterimItemWindow(_pParent, "modules/swriter/ui/combobox.ui", "ComboBox")
696 , NavElementBox_Base(m_xBuilder->weld_combo_box("combobox"), _xFrame, _rCtrl)
697{
698 SetSizePixel(m_xContainer->get_preferred_size());
699}
700
701void NavElementBox_Base::ReleaseFocus_Impl()
702{
703 if ( !m_bRelease )
704 {
705 m_bRelease = true;
706 return;
707 }
708
709 if ( m_xFrame.is() && m_xFrame->getContainerWindow().is() )
710 m_xFrame->getContainerWindow()->setFocus();
711}
712
713IMPL_LINK(NavElementBox_Base, SelectHdl, weld::ComboBox&, rComboBox, void)void NavElementBox_Base::LinkStubSelectHdl(void * instance, weld
::ComboBox& data) { return static_cast<NavElementBox_Base
*>(instance)->SelectHdl(data); } void NavElementBox_Base
::SelectHdl(weld::ComboBox& rComboBox)
714{
715 if (!rComboBox.changed_by_direct_pick()) // only when picked from the list
716 return;
717
718 SvxSearchDialogWrapper::SetSearchLabel( SearchLabel::Empty );
719
720 sal_uInt16 nMoveType = rComboBox.get_active_id().toUInt32();
721 SwView::SetMoveType( nMoveType );
722
723 css::uno::Sequence< css::beans::PropertyValue > aArgs;
724
725 /* #i33380# DR 2004-09-03 Moved the following line above the Dispatch() call.
726 This instance may be deleted in the meantime (i.e. when a dialog is opened
727 while in Dispatch()), accessing members will crash in this case. */
728 ReleaseFocus_Impl();
729
730 m_pCtrl->dispatchCommand( aArgs );
731}
732
733void NavElementBox_Base::UpdateBox()
734{
735 sal_uInt16 nMoveType = SwView::GetMoveType();
736 for ( size_t i = 0; i < SAL_N_ELEMENTS( aNavigationInsertIds )(sizeof(sal_n_array_size(aNavigationInsertIds))); ++i )
737 {
738 if ( nMoveType == aNavigationInsertIds[i] )
739 {
740 const char* id = aNavigationStrIds[i];
741 OUString sText = SwResId( id );
742 m_xWidget->set_active_text(sText);
743 break;
744 }
745 }
746}
747
748IMPL_LINK(NavElementBox_Base, KeyInputHdl, const KeyEvent&, rKEvt, bool)bool NavElementBox_Base::LinkStubKeyInputHdl(void * instance,
const KeyEvent& data) { return static_cast<NavElementBox_Base
*>(instance)->KeyInputHdl(data); } bool NavElementBox_Base
::KeyInputHdl(const KeyEvent& rKEvt)
749{
750 return DoKeyInput(rKEvt);
751}
752
753bool NavElementBox_Base::DoKeyInput(const KeyEvent& rKEvt)
754{
755 bool bHandled = false;
756
757 vcl::KeyCode aKeyCode = rKEvt.GetKeyCode();
758 sal_uInt16 nCode = aKeyCode.GetCode();
759
760 switch ( nCode )
761 {
762 case KEY_TAB:
763 {
764 m_bRelease = false;
765 SelectHdl(*m_xWidget);
766 break;
767 }
768 case KEY_RETURN:
769 {
770 bHandled = true;
771 SelectHdl(*m_xWidget);
772 break;
773 }
774 case KEY_ESCAPE:
775 ReleaseFocus_Impl();
776 bHandled = true;
777 break;
778 }
779
780 return bHandled;
781}
782
783bool NavElementBox_Impl::DoKeyInput(const KeyEvent& rKEvt)
784{
785 return NavElementBox_Base::DoKeyInput(rKEvt) || ChildKeyInput(rKEvt);
786}
787
788
789NavElementToolBoxControl::NavElementToolBoxControl( const uno::Reference< uno::XComponentContext >& rxContext )
790 : svt::ToolboxController( rxContext,
791 uno::Reference< frame::XFrame >(),
792 ".uno:NavElement" ),
793 m_pBox( nullptr )
794{
795}
796
797// XInterface
798css::uno::Any SAL_CALL NavElementToolBoxControl::queryInterface( const css::uno::Type& aType )
799{
800 uno::Any a = ToolboxController::queryInterface( aType );
801 if ( a.hasValue() )
802 return a;
803
804 return ::cppu::queryInterface( aType, static_cast< lang::XServiceInfo* >( this ) );
805}
806
807void SAL_CALL NavElementToolBoxControl::acquire() throw ()
808{
809 ToolboxController::acquire();
810}
811
812void SAL_CALL NavElementToolBoxControl::release() throw ()
813{
814 ToolboxController::release();
815}
816
817// XServiceInfo
818sal_Bool SAL_CALL NavElementToolBoxControl::supportsService( const OUString& ServiceName )
819{
820 return cppu::supportsService( this, ServiceName );
821}
822
823OUString SAL_CALL NavElementToolBoxControl::getImplementationName()
824{
825 return "lo.writer.NavElementToolBoxController";
826}
827
828uno::Sequence< OUString > SAL_CALL NavElementToolBoxControl::getSupportedServiceNames()
829{
830 return { "com.sun.star.frame.ToolbarController" };
831}
832
833// XComponent
834void SAL_CALL NavElementToolBoxControl::dispose()
835{
836 svt::ToolboxController::dispose();
837
838 SolarMutexGuard aSolarMutexGuard;
839 m_xVclBox.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
840 m_xWeldBox.reset();
841 m_pBox = nullptr;
842}
843
844// XStatusListener
845void SAL_CALL NavElementToolBoxControl::statusChanged( const frame::FeatureStateEvent& rEvent )
846{
847 if (!m_pBox)
848 return;
849
850 SolarMutexGuard aSolarMutexGuard;
851 if ( rEvent.FeatureURL.Path == "NavElement" )
852 {
853 if ( rEvent.IsEnabled )
854 {
855 m_pBox->set_sensitive(true);
856 m_pBox->UpdateBox();
857 }
858 else
859 m_pBox->set_sensitive(true);
860 }
861}
862
863// XToolbarController
864void SAL_CALL NavElementToolBoxControl::execute( sal_Int16 /*KeyModifier*/ )
865{
866}
867
868void SAL_CALL NavElementToolBoxControl::click()
869{
870}
871
872void SAL_CALL NavElementToolBoxControl::doubleClick()
873{
874}
875
876uno::Reference< awt::XWindow > SAL_CALL NavElementToolBoxControl::createPopupWindow()
877{
878 return uno::Reference< awt::XWindow >();
879}
880
881uno::Reference< awt::XWindow > SAL_CALL NavElementToolBoxControl::createItemWindow(
882 const uno::Reference< awt::XWindow >& xParent )
883{
884 uno::Reference< awt::XWindow > xItemWindow;
885
886 if (m_pBuilder)
887 {
888 SolarMutexGuard aSolarMutexGuard;
889
890 std::unique_ptr<weld::ComboBox> xWidget(m_pBuilder->weld_combo_box("NavElementWidget"));
891
892 xItemWindow = css::uno::Reference<css::awt::XWindow>(new weld::TransportAsXWindow(xWidget.get()));
893
894 m_xWeldBox.reset(new NavElementBox_Base(std::move(xWidget), m_xFrame, *this));
895 m_pBox = m_xWeldBox.get();
896 }
897 else
898 {
899 VclPtr<vcl::Window> pParent = VCLUnoHelper::GetWindow( xParent );
900 if ( pParent )
901 {
902 SolarMutexGuard aSolarMutexGuard;
903 m_xVclBox = VclPtr<NavElementBox_Impl>::Create( pParent, m_xFrame, *this );
904 m_pBox = m_xVclBox.get();
905 xItemWindow = VCLUnoHelper::GetInterface(m_xVclBox);
906 }
907 }
908
909 return xItemWindow;
910}
911
912void NavElementToolBoxControl::dispatchCommand(
913 const uno::Sequence< beans::PropertyValue >& rArgs )
914{
915 uno::Reference< frame::XDispatchProvider > xDispatchProvider( m_xFrame, uno::UNO_QUERY );
916 if ( xDispatchProvider.is() )
917 {
918 util::URL aURL;
919 uno::Reference< frame::XDispatch > xDispatch;
920 uno::Reference< util::XURLTransformer > xURLTransformer = getURLTransformer();
921
922 aURL.Complete = ".uno:NavElement";
923 xURLTransformer->parseStrict( aURL );
924 xDispatch = xDispatchProvider->queryDispatch( aURL, OUString(), 0 );
925 if ( xDispatch.is() )
926 xDispatch->dispatch( aURL, rArgs );
927 }
928}
929
930extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface *
931lo_writer_NavElementToolBoxController_get_implementation(
932 css::uno::XComponentContext *rxContext,
933 css::uno::Sequence<css::uno::Any> const &)
934{
935 return cppu::acquire( new NavElementToolBoxControl( rxContext ) );
936}
937
938namespace {
939
940class PrevNextScrollToolboxController : public svt::ToolboxController,
941 public css::lang::XServiceInfo
942{
943public:
944 enum Type { PREVIOUS, NEXT };
945
946 PrevNextScrollToolboxController( const css::uno::Reference< css::uno::XComponentContext >& rxContext, Type eType );
947
948 // XInterface
949 virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
950 virtual void SAL_CALL acquire() throw () override;
951 virtual void SAL_CALL release() throw () override;
952
953 // XServiceInfo
954 virtual OUString SAL_CALL getImplementationName() override;
955 virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
956 virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
957
958 // XComponent
959 virtual void SAL_CALL dispose() override;
960
961 // XStatusListener
962 virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& rEvent ) override;
963
964private:
965 Type meType;
966};
967
968}
969
970PrevNextScrollToolboxController::PrevNextScrollToolboxController( const css::uno::Reference< css::uno::XComponentContext > & rxContext, Type eType )
971 : svt::ToolboxController( rxContext,
972 css::uno::Reference< css::frame::XFrame >(),
973 (eType == PREVIOUS) ? OUString( ".uno:ScrollToPrevious" ): OUString( ".uno:ScrollToNext" ) ),
974 meType( eType )
975{
976 addStatusListener(".uno:NavElement");
977}
978
979// XInterface
980css::uno::Any SAL_CALL PrevNextScrollToolboxController::queryInterface( const css::uno::Type& aType )
981{
982 css::uno::Any a = ToolboxController::queryInterface( aType );
983 if ( a.hasValue() )
984 return a;
985
986 return ::cppu::queryInterface( aType, static_cast< css::lang::XServiceInfo* >( this ) );
987}
988
989void SAL_CALL PrevNextScrollToolboxController::acquire() throw ()
990{
991 ToolboxController::acquire();
992}
993
994void SAL_CALL PrevNextScrollToolboxController::release() throw ()
995{
996 ToolboxController::release();
997}
998
999// XServiceInfo
1000OUString SAL_CALL PrevNextScrollToolboxController::getImplementationName()
1001{
1002 return meType == PrevNextScrollToolboxController::PREVIOUS?
1003 OUString( "lo.writer.PreviousScrollToolboxController" ) :
1004 OUString( "lo.writer.NextScrollToolboxController" );
1005}
1006
1007sal_Bool SAL_CALL PrevNextScrollToolboxController::supportsService( const OUString& ServiceName )
1008{
1009 return cppu::supportsService(this, ServiceName);
1010}
1011
1012css::uno::Sequence< OUString > SAL_CALL PrevNextScrollToolboxController::getSupportedServiceNames()
1013{
1014 return { "com.sun.star.frame.ToolbarController" };
1015}
1016
1017// XComponent
1018void SAL_CALL PrevNextScrollToolboxController::dispose()
1019{
1020 SolarMutexGuard aSolarMutexGuard;
1021
1022 svt::ToolboxController::dispose();
1023}
1024
1025// XStatusListener
1026void SAL_CALL PrevNextScrollToolboxController::statusChanged( const css::frame::FeatureStateEvent& rEvent )
1027{
1028 if (rEvent.FeatureURL.Path == "NavElement")
1029 {
1030 if (m_pToolbar)
1031 m_pToolbar->set_item_tooltip_text(m_aCommandURL.toUtf8(), lcl_GetScrollToolTip(meType != PrevNextScrollToolboxController::PREVIOUS));
1032 else
1033 {
1034 ToolBox* pToolBox = nullptr;
1035 sal_uInt16 nId = 0;
1036 if (getToolboxId(nId, &pToolBox))
1037 pToolBox->SetQuickHelpText(nId, lcl_GetScrollToolTip(meType != PrevNextScrollToolboxController::PREVIOUS));
1038 }
1039 }
1040}
1041
1042extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface *
1043lo_writer_PreviousScrollToolboxController_get_implementation(
1044 css::uno::XComponentContext *context,
1045 css::uno::Sequence<css::uno::Any> const &)
1046{
1047 return cppu::acquire( new PrevNextScrollToolboxController( context, PrevNextScrollToolboxController::PREVIOUS ) );
1048}
1049
1050extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface *
1051lo_writer_NextScrollToolboxController_get_implementation(
1052 css::uno::XComponentContext *context,
1053 css::uno::Sequence<css::uno::Any> const &)
1054{
1055 return cppu::acquire( new PrevNextScrollToolboxController( context, PrevNextScrollToolboxController::NEXT ) );
1056}
1057
1058/* 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<(anonymous namespace)::NavElementBox_Impl>'
→
5
←
Returning from copy constructor for 'Reference<(anonymous namespace)::NavElementBox_Impl>'
→
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