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 fontwork.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D SVX_DLLIMPLEMENTATION -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/svx/inc -I /home/maarten/src/libreoffice/core/svx/source/inc -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/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -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/svx/source/dialog/fontwork.cxx

/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.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 <sfx2/module.hxx>
21#include <sfx2/dispatch.hxx>
22
23#include <svx/colorbox.hxx>
24#include <svx/dialmgr.hxx>
25#include <svx/strings.hrc>
26#include <svx/xftadit.hxx>
27#include <svx/xftdiit.hxx>
28#include <svx/xftstit.hxx>
29#include <svx/xftmrit.hxx>
30#include <svx/xftouit.hxx>
31#include <svx/xftshit.hxx>
32#include <svx/xftshcit.hxx>
33#include <svx/xftshxy.hxx>
34#include <svx/xtextit0.hxx>
35
36#include <svtools/unitconv.hxx>
37#include <svx/svxids.hrc>
38#include <bitmaps.hlst>
39#include <svx/fontwork.hxx>
40
41#define WIDTH_CHARS10 10
42
43SFX_IMPL_DOCKINGWINDOW_WITHID( SvxFontWorkChildWindow, SID_FONTWORK )std::unique_ptr<SfxChildWindow> SvxFontWorkChildWindow::
CreateImpl( vcl::Window *pParent, sal_uInt16 nId, SfxBindings
*pBindings, SfxChildWinInfo* pInfo ) { return std::make_unique
<SvxFontWorkChildWindow>(pParent, nId, pBindings, pInfo
); } void SvxFontWorkChildWindow::RegisterChildWindow (bool bVis
, SfxModule *pMod, SfxChildWindowFlags nFlags) { auto pFact =
std::make_unique<SfxChildWinFactory>( SvxFontWorkChildWindow
::CreateImpl, ( 10000 + 256 ), (32767 *2 +1) ); pFact->aInfo
.nFlags |= nFlags; pFact->aInfo.bVisible = bVis; SfxChildWindow
::RegisterChildWindow(pMod, std::move(pFact)); } sal_uInt16 SvxFontWorkChildWindow
::GetChildWindowId () { return ( 10000 + 256 ); } SfxChildWinInfo
SvxFontWorkChildWindow::GetInfo() const { SfxChildWinInfo aInfo
= SfxChildWindow::GetInfo(); static_cast<SfxDockingWindow
*>(GetWindow())->FillInfo( aInfo ); return aInfo; }
;
1
Calling 'make_unique<SvxFontWorkChildWindow, vcl::Window *&, unsigned short &, SfxBindings *&, SfxChildWinInfo *&>'
44
45// ControllerItem for Fontwork
46
47SvxFontWorkControllerItem::SvxFontWorkControllerItem
48(
49 sal_uInt16 _nId,
50 SvxFontWorkDialog& rDlg,
51 SfxBindings& rBindings
52) :
53
54 SfxControllerItem( _nId, rBindings ),
55
56 rFontWorkDlg( rDlg )
57{
58}
59
60// StateChanged method for FontWork items
61
62void SvxFontWorkControllerItem::StateChanged( sal_uInt16 /*nSID*/, SfxItemState /*eState*/,
63 const SfxPoolItem* pItem )
64{
65 switch ( GetId() )
66 {
67 case SID_FORMTEXT_STYLE( 10000 + 257 ):
68 {
69 const XFormTextStyleItem* pStateItem =
70 dynamic_cast<const XFormTextStyleItem*>( pItem );
71 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextStyleItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "71" ": "), "%s", "XFormTextStyleItem expected"); } } while
(false)
;
72 rFontWorkDlg.SetStyle_Impl(pStateItem);
73 break;
74 }
75 case SID_FORMTEXT_ADJUST( 10000 + 258 ):
76 {
77 const XFormTextAdjustItem* pStateItem =
78 dynamic_cast<const XFormTextAdjustItem*>( pItem );
79 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextAdjustItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "79" ": "), "%s", "XFormTextAdjustItem expected"); } } while
(false)
;
80 rFontWorkDlg.SetAdjust_Impl(pStateItem);
81 break;
82 }
83 case SID_FORMTEXT_DISTANCE( 10000 + 259 ):
84 {
85 const XFormTextDistanceItem* pStateItem =
86 dynamic_cast<const XFormTextDistanceItem*>( pItem );
87 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextDistanceItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "87" ": "), "%s", "XFormTextDistanceItem expected"); } }
while (false)
;
88 rFontWorkDlg.SetDistance_Impl(pStateItem);
89 break;
90 }
91 case SID_FORMTEXT_START( 10000 + 260 ):
92 {
93 const XFormTextStartItem* pStateItem =
94 dynamic_cast<const XFormTextStartItem*>( pItem );
95 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextStartItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "95" ": "), "%s", "XFormTextStartItem expected"); } } while
(false)
;
96 rFontWorkDlg.SetStart_Impl(pStateItem);
97 break;
98 }
99 case SID_FORMTEXT_MIRROR( 10000 + 261 ):
100 {
101 const XFormTextMirrorItem* pStateItem =
102 dynamic_cast<const XFormTextMirrorItem*>( pItem );
103 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextMirrorItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "103" ": "), "%s", "XFormTextMirrorItem expected"); } } while
(false)
;
104 rFontWorkDlg.SetMirror_Impl(pStateItem);
105 break;
106 }
107 case SID_FORMTEXT_HIDEFORM( 10000 + 268 ):
108 {
109 const XFormTextHideFormItem* pStateItem =
110 dynamic_cast<const XFormTextHideFormItem*>( pItem );
111 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextHideFormItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "111" ": "), "%s", "XFormTextHideFormItem expected"); } }
while (false)
;
112 rFontWorkDlg.SetShowForm_Impl(pStateItem);
113 break;
114 }
115 case SID_FORMTEXT_OUTLINE( 10000 + 262 ):
116 {
117 const XFormTextOutlineItem* pStateItem =
118 dynamic_cast<const XFormTextOutlineItem*>( pItem );
119 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextOutlineItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "119" ": "), "%s", "XFormTextOutlineItem expected"); } }
while (false)
;
120 rFontWorkDlg.SetOutline_Impl(pStateItem);
121 break;
122 }
123 case SID_FORMTEXT_SHADOW( 10000 + 263 ):
124 {
125 const XFormTextShadowItem* pStateItem =
126 dynamic_cast<const XFormTextShadowItem*>( pItem );
127 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextShadowItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "127" ": "), "%s", "XFormTextShadowItem expected"); } } while
(false)
;
128 rFontWorkDlg.SetShadow_Impl(pStateItem);
129 break;
130 }
131 case SID_FORMTEXT_SHDWCOLOR( 10000 + 264 ):
132 {
133 const XFormTextShadowColorItem* pStateItem =
134 dynamic_cast<const XFormTextShadowColorItem*>( pItem );
135 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextShadowColorItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "135" ": "), "%s", "XFormTextShadowColorItem expected");
} } while (false)
;
136 rFontWorkDlg.SetShadowColor_Impl(pStateItem);
137 break;
138 }
139 case SID_FORMTEXT_SHDWXVAL( 10000 + 265 ):
140 {
141 const XFormTextShadowXValItem* pStateItem =
142 dynamic_cast<const XFormTextShadowXValItem*>( pItem );
143 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextShadowXValItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "143" ": "), "%s", "XFormTextShadowXValItem expected"); }
} while (false)
;
144 rFontWorkDlg.SetShadowXVal_Impl(pStateItem);
145 break;
146 }
147 case SID_FORMTEXT_SHDWYVAL( 10000 + 266 ):
148 {
149 const XFormTextShadowYValItem* pStateItem =
150 dynamic_cast<const XFormTextShadowYValItem*>( pItem );
151 DBG_ASSERT(pStateItem || pItem == nullptr, "XFormTextShadowYValItem expected")do { if (true && (!(pStateItem || pItem == nullptr)))
{ sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"
), ("/home/maarten/src/libreoffice/core/svx/source/dialog/fontwork.cxx"
":" "151" ": "), "%s", "XFormTextShadowYValItem expected"); }
} while (false)
;
152 rFontWorkDlg.SetShadowYVal_Impl(pStateItem);
153 break;
154 }
155 }
156}
157
158// Derivation from SfxChildWindow as "containers" for Fontwork dialog
159
160SvxFontWorkChildWindow::SvxFontWorkChildWindow
161(
162 vcl::Window* _pParent,
163 sal_uInt16 nId,
164 SfxBindings* pBindings,
165 SfxChildWinInfo* pInfo
166) :
167 SfxChildWindow( _pParent, nId )
168{
169 VclPtrInstance<SvxFontWorkDialog> pDlg(pBindings, this, _pParent);
3
Calling constructor for 'VclPtrInstance<SvxFontWorkDialog>'
5
Returning from constructor for 'VclPtrInstance<SvxFontWorkDialog>'
170 SetWindow(pDlg);
6
Calling implicit destructor for 'VclPtr<vcl::Window>'
7
Calling '~Reference'
14
Returning from '~Reference'
15
Returning from destructor for 'VclPtr<vcl::Window>'
171
172 pDlg->Initialize( pInfo );
16
Calling 'VclPtr::operator->'
173}
174
175// Floating Window to the attribution of text effects
176SvxFontWorkDialog::SvxFontWorkDialog(SfxBindings *pBindinx,
177 SfxChildWindow *pCW,
178 vcl::Window* _pParent)
179 : SfxDockingWindow(pBindinx, pCW, _pParent, "DockingFontwork", "svx/ui/dockingfontwork.ui")
180 , rBindings(*pBindinx)
181 , aInputIdle("SvxFontWorkDialog Input")
182 , nSaveShadowX(0)
183 , nSaveShadowY(0)
184 , nSaveShadowAngle(450)
185 , nSaveShadowSize (100)
186 , m_xTbxStyle(m_xBuilder->weld_toolbar("style"))
187 , m_xTbxAdjust(m_xBuilder->weld_toolbar("adjust"))
188 , m_xMtrFldDistance(m_xBuilder->weld_metric_spin_button("distance", FieldUnit::CM))
189 , m_xMtrFldTextStart(m_xBuilder->weld_metric_spin_button("indent", FieldUnit::CM))
190 , m_xTbxShadow(m_xBuilder->weld_toolbar("shadow"))
191 , m_xFbShadowX(m_xBuilder->weld_image("shadowx"))
192 , m_xMtrFldShadowX(m_xBuilder->weld_metric_spin_button("distancex", FieldUnit::CM))
193 , m_xFbShadowY(m_xBuilder->weld_image("shadowy"))
194 , m_xMtrFldShadowY(m_xBuilder->weld_metric_spin_button("distancey", FieldUnit::CM))
195 , m_xShadowColorLB(new ColorListBox(m_xBuilder->weld_menu_button("color"), GetFrameWeld()))
196{
197 SetText(SvxResId(RID_SVXSTR_FONTWORKreinterpret_cast<char const *>("RID_SVXSTR_FONTWORK" "\004"
u8"Fontwork")
));
198
199 ApplyImageList();
200
201 pCtrlItems[0] = new SvxFontWorkControllerItem(SID_FORMTEXT_STYLE( 10000 + 257 ), *this, rBindings);
202 pCtrlItems[1] = new SvxFontWorkControllerItem(SID_FORMTEXT_ADJUST( 10000 + 258 ), *this, rBindings);
203 pCtrlItems[2] = new SvxFontWorkControllerItem(SID_FORMTEXT_DISTANCE( 10000 + 259 ), *this, rBindings);
204 pCtrlItems[3] = new SvxFontWorkControllerItem(SID_FORMTEXT_START( 10000 + 260 ), *this, rBindings);
205 pCtrlItems[4] = new SvxFontWorkControllerItem(SID_FORMTEXT_MIRROR( 10000 + 261 ), *this, rBindings);
206 pCtrlItems[5] = new SvxFontWorkControllerItem(SID_FORMTEXT_HIDEFORM( 10000 + 268 ), *this, rBindings);
207 pCtrlItems[6] = new SvxFontWorkControllerItem(SID_FORMTEXT_OUTLINE( 10000 + 262 ), *this, rBindings);
208 pCtrlItems[7] = new SvxFontWorkControllerItem(SID_FORMTEXT_SHADOW( 10000 + 263 ), *this, rBindings);
209 pCtrlItems[8] = new SvxFontWorkControllerItem(SID_FORMTEXT_SHDWCOLOR( 10000 + 264 ), *this, rBindings);
210 pCtrlItems[9] = new SvxFontWorkControllerItem(SID_FORMTEXT_SHDWXVAL( 10000 + 265 ), *this, rBindings);
211 pCtrlItems[10] = new SvxFontWorkControllerItem(SID_FORMTEXT_SHDWYVAL( 10000 + 266 ), *this, rBindings);
212
213 m_xTbxStyle->connect_clicked(LINK(this, SvxFontWorkDialog, SelectStyleHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<SvxFontWorkDialog
*>(this), &SvxFontWorkDialog::LinkStubSelectStyleHdl_Impl
)
);
214 m_xTbxAdjust->connect_clicked(LINK(this, SvxFontWorkDialog, SelectAdjustHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<SvxFontWorkDialog
*>(this), &SvxFontWorkDialog::LinkStubSelectAdjustHdl_Impl
)
);
215 m_xTbxShadow->connect_clicked(LINK(this, SvxFontWorkDialog, SelectShadowHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<SvxFontWorkDialog
*>(this), &SvxFontWorkDialog::LinkStubSelectShadowHdl_Impl
)
);
216
217 Link<weld::MetricSpinButton&,void> aLink = LINK(this, SvxFontWorkDialog, ModifyInputHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<SvxFontWorkDialog
*>(this), &SvxFontWorkDialog::LinkStubModifyInputHdl_Impl
)
;
218 m_xMtrFldDistance->connect_value_changed( aLink );
219 m_xMtrFldTextStart->connect_value_changed( aLink );
220 m_xMtrFldShadowX->connect_value_changed( aLink );
221 m_xMtrFldShadowY->connect_value_changed( aLink );
222
223 // Set System metric
224 const FieldUnit eDlgUnit = rBindings.GetDispatcher()->GetModule()->GetFieldUnit();
225 SetFieldUnit(*m_xMtrFldDistance, eDlgUnit, true);
226 SetFieldUnit(*m_xMtrFldTextStart, eDlgUnit, true);
227 SetFieldUnit(*m_xMtrFldShadowX, eDlgUnit, true);
228 SetFieldUnit(*m_xMtrFldShadowY, eDlgUnit, true);
229 if( eDlgUnit == FieldUnit::MM )
230 {
231 m_xMtrFldDistance->set_increments(50, 500, FieldUnit::NONE);
232 m_xMtrFldTextStart->set_increments(50, 500, FieldUnit::NONE);
233 m_xMtrFldShadowX->set_increments(50, 500, FieldUnit::NONE);
234 m_xMtrFldShadowY->set_increments(50, 500, FieldUnit::NONE);
235 }
236 else
237 {
238 m_xMtrFldDistance->set_increments(10, 100, FieldUnit::NONE);
239 m_xMtrFldTextStart->set_increments(10, 100, FieldUnit::NONE);
240 m_xMtrFldShadowX->set_increments(10, 100, FieldUnit::NONE);
241 m_xMtrFldShadowY->set_increments(10, 100, FieldUnit::NONE);
242 }
243 m_xMtrFldShadowX->set_width_chars(WIDTH_CHARS10);
244 m_xMtrFldShadowY->set_width_chars(WIDTH_CHARS10);
245
246 m_xShadowColorLB->SetSelectHdl( LINK(this, SvxFontWorkDialog, ColorSelectHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<SvxFontWorkDialog
*>(this), &SvxFontWorkDialog::LinkStubColorSelectHdl_Impl
)
);
247
248 aInputIdle.SetPriority(TaskPriority::LOWEST);
249 aInputIdle.SetInvokeHandler(LINK(this, SvxFontWorkDialog, InputTimeoutHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<SvxFontWorkDialog
*>(this), &SvxFontWorkDialog::LinkStubInputTimeoutHdl_Impl
)
);
250}
251
252SvxFontWorkDialog::~SvxFontWorkDialog()
253{
254 disposeOnce();
255}
256
257void SvxFontWorkDialog::dispose()
258{
259 for (SvxFontWorkControllerItem* pCtrlItem : pCtrlItems)
260 pCtrlItem->dispose();
261 m_xTbxStyle.reset();
262 m_xTbxAdjust.reset();
263 m_xMtrFldDistance.reset();
264 m_xMtrFldTextStart.reset();
265 m_xTbxShadow.reset();
266 m_xFbShadowX.reset();
267 m_xMtrFldShadowX.reset();
268 m_xFbShadowY.reset();
269 m_xMtrFldShadowY.reset();
270 m_xShadowColorLB.reset();
271 SfxDockingWindow::dispose();
272}
273
274SfxChildAlignment SvxFontWorkDialog::CheckAlignment( SfxChildAlignment eActAlign,
275 SfxChildAlignment eAlign )
276{
277 SfxChildAlignment eAlignment;
278
279 switch ( eAlign )
280 {
281 case SfxChildAlignment::TOP:
282 case SfxChildAlignment::HIGHESTTOP:
283 case SfxChildAlignment::LOWESTTOP:
284 case SfxChildAlignment::BOTTOM:
285 case SfxChildAlignment::LOWESTBOTTOM:
286 case SfxChildAlignment::HIGHESTBOTTOM:
287 {
288 eAlignment = eActAlign;
289 }
290 break;
291
292 case SfxChildAlignment::LEFT:
293 case SfxChildAlignment::RIGHT:
294 case SfxChildAlignment::FIRSTLEFT:
295 case SfxChildAlignment::LASTLEFT:
296 case SfxChildAlignment::FIRSTRIGHT:
297 case SfxChildAlignment::LASTRIGHT:
298 {
299 eAlignment = eAlign;
300 }
301 break;
302
303 default:
304 {
305 eAlignment = eAlign;
306 }
307 break;
308 }
309
310 return eAlignment;
311}
312
313// Set style buttons
314void SvxFontWorkDialog::SetStyle_Impl(const XFormTextStyleItem* pItem)
315{
316 if ( pItem )
317 {
318 OString sId = "off";
319
320 switch ( pItem->GetValue() )
321 {
322 case XFormTextStyle::Rotate : sId = "rotate"; break;
323 case XFormTextStyle::Upright: sId = "upright"; break;
324 case XFormTextStyle::SlantX : sId = "hori"; break;
325 case XFormTextStyle::SlantY : sId = "vert"; break;
326 default: ;//prevent warning
327 }
328 m_xTbxStyle->set_sensitive(true);
329
330 // Make sure that there is always exactly one checked toolbox item.
331 if ( pItem->GetValue() == XFormTextStyle::NONE )
332 {
333 m_xTbxStyle->set_item_active("rotate", false);
334 m_xTbxStyle->set_item_active("upright", false);
335 m_xTbxStyle->set_item_active("hori", false);
336 m_xTbxStyle->set_item_active("vert", false);
337
338 m_xTbxStyle->set_item_active("off", true);
339 }
340 else
341 {
342 m_xTbxStyle->set_item_active("off", false);
343 m_xTbxStyle->set_item_active(sId, true);
344 }
345
346 m_sLastStyleTbxId = sId;
347 }
348 else
349 m_xTbxStyle->set_sensitive(false);
350}
351
352// Set adjust buttons
353
354void SvxFontWorkDialog::SetAdjust_Impl(const XFormTextAdjustItem* pItem)
355{
356 if ( pItem )
357 {
358 OString sId;
359
360 m_xTbxAdjust->set_sensitive(true);
361 m_xMtrFldDistance->set_sensitive(true);
362
363 if ( pItem->GetValue() == XFormTextAdjust::Left || pItem->GetValue() == XFormTextAdjust::Right )
364 {
365 if (pItem->GetValue() == XFormTextAdjust::Left)
366 sId = "left";
367 else
368 sId = "right";
369 m_xMtrFldTextStart->set_sensitive(true);
370 }
371 else
372 {
373 if (pItem->GetValue() == XFormTextAdjust::Center)
374 sId = "center";
375 else
376 sId = "autosize";
377 m_xMtrFldTextStart->set_sensitive(false);
378 }
379
380 if (!m_xTbxAdjust->get_item_active(sId))
381 m_xTbxAdjust->set_item_active(sId, true);
382
383 m_sLastAdjustTbxId = sId;
384 }
385 else
386 {
387 m_xTbxAdjust->set_sensitive(false);
388 m_xMtrFldTextStart->set_sensitive(false);
389 m_xMtrFldDistance->set_sensitive(false);
390 }
391}
392
393// Enter Distance value in the edit field
394
395void SvxFontWorkDialog::SetDistance_Impl(const XFormTextDistanceItem* pItem)
396{
397 if (pItem && !m_xMtrFldDistance->has_focus())
398 {
399 SetMetricValue(*m_xMtrFldDistance, pItem->GetValue(), MapUnit::Map100thMM);
400 }
401}
402
403// Enter indent value in the edit field
404
405void SvxFontWorkDialog::SetStart_Impl(const XFormTextStartItem* pItem)
406{
407 if (pItem && !m_xMtrFldTextStart->has_focus())
408 {
409 SetMetricValue(*m_xMtrFldTextStart, pItem->GetValue(), MapUnit::Map100thMM);
410 }
411}
412
413// Set button for reversing the direction of text
414
415void SvxFontWorkDialog::SetMirror_Impl(const XFormTextMirrorItem* pItem)
416{
417 if ( pItem )
418 m_xTbxAdjust->set_item_active("orientation", pItem->GetValue());
419}
420
421// Set button for contour display
422
423void SvxFontWorkDialog::SetShowForm_Impl(const XFormTextHideFormItem* pItem)
424{
425 if ( pItem )
426 m_xTbxShadow->set_item_active("contour", !pItem->GetValue());
427}
428
429// Set button for text border
430
431void SvxFontWorkDialog::SetOutline_Impl(const XFormTextOutlineItem* pItem)
432{
433 if ( pItem )
434 m_xTbxShadow->set_item_active("textcontour", pItem->GetValue());
435}
436
437// Set shadow buttons
438
439void SvxFontWorkDialog::SetShadow_Impl(const XFormTextShadowItem* pItem,
440 bool bRestoreValues)
441{
442 if ( pItem )
443 {
444 OString sId;
445
446 m_xTbxShadow->set_sensitive(true);
447
448 if ( pItem->GetValue() == XFormTextShadow::NONE )
449 {
450 sId = "noshadow";
451 m_xFbShadowX->hide();
452 m_xFbShadowY->hide();
453 m_xMtrFldShadowX->set_sensitive(false);
454 m_xMtrFldShadowY->set_sensitive(false);
455 m_xShadowColorLB->set_sensitive(false);
456 }
457 else
458 {
459 m_xFbShadowX->show();
460 m_xFbShadowY->show();
461 m_xMtrFldShadowX->set_sensitive(true);
462 m_xMtrFldShadowY->set_sensitive(true);
463 m_xShadowColorLB->set_sensitive(true);
464
465 if ( pItem->GetValue() == XFormTextShadow::Normal )
466 {
467 sId = "vertical";
468 const FieldUnit eDlgUnit = rBindings.GetDispatcher()->GetModule()->GetFieldUnit();
469
470 m_xMtrFldShadowX->set_unit( eDlgUnit );
471 m_xMtrFldShadowX->set_digits(2);
472 m_xMtrFldShadowX->set_range(INT_MIN(-2147483647 -1), INT_MAX2147483647, FieldUnit::NONE);
473 if( eDlgUnit == FieldUnit::MM )
474 m_xMtrFldShadowX->set_increments(50, 500, FieldUnit::NONE);
475 else
476 m_xMtrFldShadowX->set_increments(10, 100, FieldUnit::NONE);
477 m_xMtrFldShadowX->set_width_chars(WIDTH_CHARS10);
478
479 m_xMtrFldShadowY->set_unit( eDlgUnit );
480 m_xMtrFldShadowY->set_digits(2);
481 m_xMtrFldShadowY->set_range(INT_MIN(-2147483647 -1), INT_MAX2147483647, FieldUnit::NONE);
482 if( eDlgUnit == FieldUnit::MM )
483 m_xMtrFldShadowY->set_increments(50, 500, FieldUnit::NONE);
484 else
485 m_xMtrFldShadowY->set_increments(10, 100, FieldUnit::NONE);
486 m_xMtrFldShadowY->set_width_chars(WIDTH_CHARS10);
487
488 if ( bRestoreValues )
489 {
490 SetMetricValue(*m_xMtrFldShadowX, nSaveShadowX, MapUnit::Map100thMM);
491 SetMetricValue(*m_xMtrFldShadowY, nSaveShadowY, MapUnit::Map100thMM);
492
493 XFormTextShadowXValItem aXItem( nSaveShadowX );
494 XFormTextShadowYValItem aYItem( nSaveShadowY );
495
496 GetBindings().GetDispatcher()->ExecuteList(
497 SID_FORMTEXT_SHDWXVAL( 10000 + 265 ), SfxCallMode::RECORD,
498 { &aXItem, &aYItem });
499 }
500 }
501 else
502 {
503 sId = "slant";
504
505 m_xMtrFldShadowX->set_unit(FieldUnit::DEGREE);
506 m_xMtrFldShadowX->set_digits(1);
507 m_xMtrFldShadowX->set_range(-1800, 1800, FieldUnit::NONE);
508 m_xMtrFldShadowX->set_increments(10, 100, FieldUnit::NONE);
509 m_xMtrFldShadowX->set_width_chars(WIDTH_CHARS10);
510
511 m_xMtrFldShadowY->set_unit(FieldUnit::PERCENT);
512 m_xMtrFldShadowY->set_digits(0);
513 m_xMtrFldShadowY->set_range(-999, 999, FieldUnit::NONE);
514 m_xMtrFldShadowY->set_increments(10, 100, FieldUnit::NONE);
515 m_xMtrFldShadowY->set_width_chars(WIDTH_CHARS10);
516
517 if ( bRestoreValues )
518 {
519 m_xMtrFldShadowX->set_value(nSaveShadowAngle, FieldUnit::NONE);
520 m_xMtrFldShadowY->set_value(nSaveShadowSize, FieldUnit::NONE);
521 XFormTextShadowXValItem aXItem(nSaveShadowAngle);
522 XFormTextShadowYValItem aYItem(nSaveShadowSize);
523 GetBindings().GetDispatcher()->ExecuteList(
524 SID_FORMTEXT_SHDWXVAL( 10000 + 265 ), SfxCallMode::RECORD,
525 { &aXItem, &aYItem });
526 }
527 }
528 }
529
530 if (!m_xTbxShadow->get_item_active(sId))
531 m_xTbxShadow->set_item_active(sId, true);
532 m_sLastShadowTbxId = sId;
533
534 ApplyImageList();
535 }
536 else
537 {
538 m_xTbxShadow->set_sensitive(false);
539 m_xMtrFldShadowX->set_sensitive(false);
540 m_xMtrFldShadowY->set_sensitive(false);
541 m_xShadowColorLB->set_sensitive(false);
542 }
543}
544
545// Insert shadow color in listbox
546
547void SvxFontWorkDialog::SetShadowColor_Impl(const XFormTextShadowColorItem* pItem)
548{
549 if ( pItem )
550 m_xShadowColorLB->SelectEntry(pItem->GetColorValue());
551}
552
553// Enter X-value for shadow in edit field
554void SvxFontWorkDialog::SetShadowXVal_Impl(const XFormTextShadowXValItem* pItem)
555{
556 if (!pItem || m_xMtrFldShadowX->has_focus())
557 return;
558
559 // #i19251#
560 // sal_Int32 nValue = pItem->GetValue();
561
562 // #i19251#
563 // The two involved fields/items are used double and contain/give different
564 // values regarding to the access method. Thus, here we need to separate the access
565 // methods regarding to the kind of value accessed.
566 if (m_xTbxShadow->get_item_active("slant"))
567 {
568 // #i19251#
569 // There is no value correction necessary at all, i think this
570 // was only tried to be done without understanding that the two
571 // involved fields/items are used double and contain/give different
572 // values regarding to the access method.
573 // nValue = nValue - ( int( float( nValue ) / 360.0 ) * 360 );
574 m_xMtrFldShadowX->set_value(pItem->GetValue(), FieldUnit::NONE);
575 }
576 else
577 {
578 SetMetricValue(*m_xMtrFldShadowX, pItem->GetValue(), MapUnit::Map100thMM);
579 }
580}
581
582// Enter Y-value for shadow in edit field
583void SvxFontWorkDialog::SetShadowYVal_Impl(const XFormTextShadowYValItem* pItem)
584{
585 if (!pItem || m_xMtrFldShadowY->has_focus())
586 return;
587
588 // #i19251#
589 // The two involved fields/items are used double and contain/give different
590 // values regarding to the access method. Thus, here we need to separate the access
591 // methods regarding to the kind of value accessed.
592 if (m_xTbxShadow->get_item_active("slant"))
593 {
594 m_xMtrFldShadowY->set_value(pItem->GetValue(), FieldUnit::NONE);
595 }
596 else
597 {
598 SetMetricValue(*m_xMtrFldShadowY, pItem->GetValue(), MapUnit::Map100thMM);
599 }
600}
601
602IMPL_LINK(SvxFontWorkDialog, SelectStyleHdl_Impl, const OString&, rId, void)void SvxFontWorkDialog::LinkStubSelectStyleHdl_Impl(void * instance
, const OString& data) { return static_cast<SvxFontWorkDialog
*>(instance)->SelectStyleHdl_Impl(data); } void SvxFontWorkDialog
::SelectStyleHdl_Impl(const OString& rId)
603{
604 // Execute this block when a different toolbox item has been clicked or
605 // when the off item has been clicked. The later is necessary to
606 // override the toolbox behaviour of unchecking the item after second
607 // click on it: One of the items has to be checked at all times (when
608 // enabled that is.)
609 if (rId != "off" && rId == m_sLastStyleTbxId)
610 return;
611
612 XFormTextStyle eStyle = XFormTextStyle::NONE;
613
614 if (rId == "rotate")
615 eStyle = XFormTextStyle::Rotate;
616 else if (rId == "upright")
617 eStyle = XFormTextStyle::Upright;
618 else if (rId == "hori")
619 eStyle = XFormTextStyle::SlantX;
620 else if (rId == "vert")
621 eStyle = XFormTextStyle::SlantY;
622
623 XFormTextStyleItem aItem( eStyle );
624 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_STYLE( 10000 + 257 ),
625 SfxCallMode::RECORD, { &aItem });
626 SetStyle_Impl( &aItem );
627 m_sLastStyleTbxId = rId;
628}
629
630IMPL_LINK(SvxFontWorkDialog, SelectAdjustHdl_Impl, const OString&, rId, void)void SvxFontWorkDialog::LinkStubSelectAdjustHdl_Impl(void * instance
, const OString& data) { return static_cast<SvxFontWorkDialog
*>(instance)->SelectAdjustHdl_Impl(data); } void SvxFontWorkDialog
::SelectAdjustHdl_Impl(const OString& rId)
631{
632 if (rId == "orientation")
633 {
634 XFormTextMirrorItem aItem(m_xTbxAdjust->get_item_active(rId));
635 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_MIRROR( 10000 + 261 ),
636 SfxCallMode::SLOT, { &aItem });
637 }
638 else if (rId != m_sLastAdjustTbxId)
639 {
640 XFormTextAdjust eAdjust = XFormTextAdjust::AutoSize;
641
642 if (rId == "left")
643 eAdjust = XFormTextAdjust::Left;
644 else if (rId == "center")
645 eAdjust = XFormTextAdjust::Center;
646 else if (rId == "right")
647 eAdjust = XFormTextAdjust::Right;
648
649 XFormTextAdjustItem aItem(eAdjust);
650 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_ADJUST( 10000 + 258 ),
651 SfxCallMode::RECORD, { &aItem });
652 SetAdjust_Impl(&aItem);
653 m_sLastAdjustTbxId = rId;
654 }
655}
656
657IMPL_LINK(SvxFontWorkDialog, SelectShadowHdl_Impl, const OString&, rId, void)void SvxFontWorkDialog::LinkStubSelectShadowHdl_Impl(void * instance
, const OString& data) { return static_cast<SvxFontWorkDialog
*>(instance)->SelectShadowHdl_Impl(data); } void SvxFontWorkDialog
::SelectShadowHdl_Impl(const OString& rId)
658{
659 if (rId == "contour")
660 {
661 XFormTextHideFormItem aItem(!m_xTbxShadow->get_item_active(rId));
662 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_HIDEFORM( 10000 + 268 ),
663 SfxCallMode::RECORD, { &aItem });
664 }
665 else if (rId == "textcontour")
666 {
667 XFormTextOutlineItem aItem(m_xTbxShadow->get_item_active(rId));
668 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_OUTLINE( 10000 + 262 ),
669 SfxCallMode::RECORD, { &aItem });
670 }
671 else if (rId != m_sLastShadowTbxId)
672 {
673 XFormTextShadow eShadow = XFormTextShadow::NONE;
674
675 if (m_sLastShadowTbxId == "vertical")
676 {
677 nSaveShadowX = GetCoreValue(*m_xMtrFldShadowX, MapUnit::Map100thMM);
678 nSaveShadowY = GetCoreValue(*m_xMtrFldShadowY, MapUnit::Map100thMM);
679 }
680 else if (m_sLastShadowTbxId == "slant")
681 {
682 nSaveShadowAngle = m_xMtrFldShadowX->get_value(FieldUnit::NONE);
683 nSaveShadowSize = m_xMtrFldShadowY->get_value(FieldUnit::NONE);
684 }
685 m_sLastShadowTbxId = rId;
686
687 if ( rId == "vertical") eShadow = XFormTextShadow::Normal;
688 else if (rId == "slant") eShadow = XFormTextShadow::Slant;
689
690 XFormTextShadowItem aItem(eShadow);
691 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_SHADOW( 10000 + 263 ),
692 SfxCallMode::RECORD, { &aItem });
693 SetShadow_Impl(&aItem, true);
694 }
695}
696
697IMPL_LINK_NOARG(SvxFontWorkDialog, ModifyInputHdl_Impl, weld::MetricSpinButton&, void)void SvxFontWorkDialog::LinkStubModifyInputHdl_Impl(void * instance
, weld::MetricSpinButton& data) { return static_cast<SvxFontWorkDialog
*>(instance)->ModifyInputHdl_Impl(data); } void SvxFontWorkDialog
::ModifyInputHdl_Impl(__attribute__ ((unused)) weld::MetricSpinButton
&)
698{
699 aInputIdle.Start();
700}
701
702IMPL_LINK_NOARG(SvxFontWorkDialog, InputTimeoutHdl_Impl, Timer*, void)void SvxFontWorkDialog::LinkStubInputTimeoutHdl_Impl(void * instance
, Timer* data) { return static_cast<SvxFontWorkDialog *>
(instance)->InputTimeoutHdl_Impl(data); } void SvxFontWorkDialog
::InputTimeoutHdl_Impl(__attribute__ ((unused)) Timer*)
703{
704 // Possibly set the Metric system again. This should be done with a
705 // listen, this is however not possible at the moment due to compatibility
706 // issues.
707 const FieldUnit eDlgUnit = rBindings.GetDispatcher()->GetModule()->GetFieldUnit();
708 if( eDlgUnit != m_xMtrFldDistance->get_unit() )
709 {
710 SetFieldUnit(*m_xMtrFldDistance, eDlgUnit, true);
711 SetFieldUnit(*m_xMtrFldTextStart, eDlgUnit, true);
712 if (eDlgUnit == FieldUnit::MM)
713 {
714 m_xMtrFldDistance->set_increments(50, 500, FieldUnit::NONE);
715 m_xMtrFldTextStart->set_increments(50, 500, FieldUnit::NONE);
716 }
717 else
718 {
719 m_xMtrFldDistance->set_increments(10, 100, FieldUnit::NONE);
720 m_xMtrFldTextStart->set_increments(10, 100, FieldUnit::NONE);
721 }
722 }
723 if( eDlgUnit != m_xMtrFldShadowX->get_unit() &&
724 m_xTbxShadow->get_item_active("vertical") )
725 {
726 SetFieldUnit(*m_xMtrFldShadowX, eDlgUnit, true);
727 SetFieldUnit(*m_xMtrFldShadowY, eDlgUnit, true);
728
729 if (eDlgUnit == FieldUnit::MM)
730 {
731 m_xMtrFldShadowX->set_increments(50, 500, FieldUnit::NONE);
732 m_xMtrFldShadowY->set_increments(50, 500, FieldUnit::NONE);
733 }
734 else
735 {
736 m_xMtrFldShadowX->set_increments(10, 100, FieldUnit::NONE);
737 m_xMtrFldShadowY->set_increments(10, 100, FieldUnit::NONE);
738 }
739 }
740
741 long nValue = GetCoreValue(*m_xMtrFldDistance, MapUnit::Map100thMM);
742 XFormTextDistanceItem aDistItem( nValue );
743 nValue = GetCoreValue(*m_xMtrFldTextStart, MapUnit::Map100thMM);
744 XFormTextStartItem aStartItem( nValue );
745
746 sal_Int32 nValueX(0);
747 sal_Int32 nValueY(0);
748
749 // #i19251#
750 // The two involved fields/items are used double and contain/give different
751 // values regarding to the access method. Thus, here we need to separate the access
752 // method regarding to the kind of value accessed.
753 if (m_sLastShadowTbxId == "vertical")
754 {
755 nValueX = GetCoreValue(*m_xMtrFldShadowX, MapUnit::Map100thMM);
756 nValueY = GetCoreValue(*m_xMtrFldShadowY, MapUnit::Map100thMM);
757 }
758 else if (m_sLastShadowTbxId == "slant")
759 {
760 nValueX = m_xMtrFldShadowX->get_value(FieldUnit::NONE);
761 nValueY = m_xMtrFldShadowY->get_value(FieldUnit::NONE);
762 }
763
764 XFormTextShadowXValItem aShadowXItem( nValueX );
765 XFormTextShadowYValItem aShadowYItem( nValueY );
766
767 // Slot-ID does not matter, the Exec method evaluates the entire item set
768 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_DISTANCE( 10000 + 259 ),
769 SfxCallMode::RECORD,
770 { &aDistItem, &aStartItem, &aShadowXItem, &aShadowYItem });
771}
772
773IMPL_LINK_NOARG(SvxFontWorkDialog, ColorSelectHdl_Impl, ColorListBox&, void)void SvxFontWorkDialog::LinkStubColorSelectHdl_Impl(void * instance
, ColorListBox& data) { return static_cast<SvxFontWorkDialog
*>(instance)->ColorSelectHdl_Impl(data); } void SvxFontWorkDialog
::ColorSelectHdl_Impl(__attribute__ ((unused)) ColorListBox&
)
774{
775 XFormTextShadowColorItem aItem( "", m_xShadowColorLB->GetSelectEntryColor() );
776 GetBindings().GetDispatcher()->ExecuteList(SID_FORMTEXT_SHDWCOLOR( 10000 + 264 ),
777 SfxCallMode::RECORD, { &aItem });
778}
779
780void SvxFontWorkDialog::ApplyImageList()
781{
782 if (m_sLastShadowTbxId == "slant")
783 {
784 m_xFbShadowX->set_from_icon_name(RID_SVXBMP_SHADOW_ANGLE"svx/res/fw018.png");
785 m_xFbShadowY->set_from_icon_name(RID_SVXBMP_SHADOW_SIZE"svx/res/fw019.png");
786 }
787 else
788 {
789 m_xFbShadowX->set_from_icon_name(RID_SVXBMP_SHADOW_XDIST"svx/res/fw016.png");
790 m_xFbShadowY->set_from_icon_name(RID_SVXBMP_SHADOW_YDIST"svx/res/fw017.png");
791 }
792}
793
794/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/bits/unique_ptr.h

1// unique_ptr implementation -*- C++ -*-
2
3// Copyright (C) 2008-2020 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library. This library is free
6// software; you can redistribute it and/or modify it under the
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 3, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// Under Section 7 of GPL version 3, you are granted additional
17// permissions described in the GCC Runtime Library Exception, version
18// 3.1, as published by the Free Software Foundation.
19
20// You should have received a copy of the GNU General Public License and
21// a copy of the GCC Runtime Library Exception along with this program;
22// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23// <http://www.gnu.org/licenses/>.
24
25/** @file bits/unique_ptr.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{memory}
28 */
29
30#ifndef _UNIQUE_PTR_H1
31#define _UNIQUE_PTR_H1 1
32
33#include <bits/c++config.h>
34#include <debug/assertions.h>
35#include <type_traits>
36#include <utility>
37#include <tuple>
38#include <bits/stl_function.h>
39#include <bits/functional_hash.h>
40#if __cplusplus201703L > 201703L
41# include <compare>
42# include <ostream>
43#endif
44
45namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default")))
46{
47_GLIBCXX_BEGIN_NAMESPACE_VERSION
48
49 /**
50 * @addtogroup pointer_abstractions
51 * @{
52 */
53
54#if _GLIBCXX_USE_DEPRECATED1
55#pragma GCC diagnostic push
56#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
57 template<typename> class auto_ptr;
58#pragma GCC diagnostic pop
59#endif
60
61 /// Primary template of default_delete, used by unique_ptr for single objects
62 template<typename _Tp>
63 struct default_delete
64 {
65 /// Default constructor
66 constexpr default_delete() noexcept = default;
67
68 /** @brief Converting constructor.
69 *
70 * Allows conversion from a deleter for objects of another type, `_Up`,
71 * only if `_Up*` is convertible to `_Tp*`.
72 */
73 template<typename _Up,
74 typename = _Require<is_convertible<_Up*, _Tp*>>>
75 default_delete(const default_delete<_Up>&) noexcept { }
76
77 /// Calls `delete __ptr`
78 void
79 operator()(_Tp* __ptr) const
80 {
81 static_assert(!is_void<_Tp>::value,
82 "can't delete pointer to incomplete type");
83 static_assert(sizeof(_Tp)>0,
84 "can't delete pointer to incomplete type");
85 delete __ptr;
86 }
87 };
88
89 // _GLIBCXX_RESOLVE_LIB_DEFECTS
90 // DR 740 - omit specialization for array objects with a compile time length
91
92 /// Specialization of default_delete for arrays, used by `unique_ptr<T[]>`
93 template<typename _Tp>
94 struct default_delete<_Tp[]>
95 {
96 public:
97 /// Default constructor
98 constexpr default_delete() noexcept = default;
99
100 /** @brief Converting constructor.
101 *
102 * Allows conversion from a deleter for arrays of another type, such as
103 * a const-qualified version of `_Tp`.
104 *
105 * Conversions from types derived from `_Tp` are not allowed because
106 * it is undefined to `delete[]` an array of derived types through a
107 * pointer to the base type.
108 */
109 template<typename _Up,
110 typename = _Require<is_convertible<_Up(*)[], _Tp(*)[]>>>
111 default_delete(const default_delete<_Up[]>&) noexcept { }
112
113 /// Calls `delete[] __ptr`
114 template<typename _Up>
115 typename enable_if<is_convertible<_Up(*)[], _Tp(*)[]>::value>::type
116 operator()(_Up* __ptr) const
117 {
118 static_assert(sizeof(_Tp)>0,
119 "can't delete pointer to incomplete type");
120 delete [] __ptr;
121 }
122 };
123
124 /// @cond undocumented
125
126 // Manages the pointer and deleter of a unique_ptr
127 template <typename _Tp, typename _Dp>
128 class __uniq_ptr_impl
129 {
130 template <typename _Up, typename _Ep, typename = void>
131 struct _Ptr
132 {
133 using type = _Up*;
134 };
135
136 template <typename _Up, typename _Ep>
137 struct
138 _Ptr<_Up, _Ep, __void_t<typename remove_reference<_Ep>::type::pointer>>
139 {
140 using type = typename remove_reference<_Ep>::type::pointer;
141 };
142
143 public:
144 using _DeleterConstraint = enable_if<
145 __and_<__not_<is_pointer<_Dp>>,
146 is_default_constructible<_Dp>>::value>;
147
148 using pointer = typename _Ptr<_Tp, _Dp>::type;
149
150 static_assert( !is_rvalue_reference<_Dp>::value,
151 "unique_ptr's deleter type must be a function object type"
152 " or an lvalue reference type" );
153
154 __uniq_ptr_impl() = default;
155 __uniq_ptr_impl(pointer __p) : _M_t() { _M_ptr() = __p; }
156
157 template<typename _Del>
158 __uniq_ptr_impl(pointer __p, _Del&& __d)
159 : _M_t(__p, std::forward<_Del>(__d)) { }
160
161 __uniq_ptr_impl(__uniq_ptr_impl&& __u) noexcept
162 : _M_t(std::move(__u._M_t))
163 { __u._M_ptr() = nullptr; }
164
165 __uniq_ptr_impl& operator=(__uniq_ptr_impl&& __u) noexcept
166 {
167 reset(__u.release());
168 _M_deleter() = std::forward<_Dp>(__u._M_deleter());
169 return *this;
170 }
171
172 pointer& _M_ptr() { return std::get<0>(_M_t); }
173 pointer _M_ptr() const { return std::get<0>(_M_t); }
174 _Dp& _M_deleter() { return std::get<1>(_M_t); }
175 const _Dp& _M_deleter() const { return std::get<1>(_M_t); }
176
177 void reset(pointer __p) noexcept
178 {
179 const pointer __old_p = _M_ptr();
180 _M_ptr() = __p;
181 if (__old_p)
182 _M_deleter()(__old_p);
183 }
184
185 pointer release() noexcept
186 {
187 pointer __p = _M_ptr();
188 _M_ptr() = nullptr;
189 return __p;
190 }
191
192 void
193 swap(__uniq_ptr_impl& __rhs) noexcept
194 {
195 using std::swap;
196 swap(this->_M_ptr(), __rhs._M_ptr());
197 swap(this->_M_deleter(), __rhs._M_deleter());
198 }
199
200 private:
201 tuple<pointer, _Dp> _M_t;
202 };
203
204 // Defines move construction + assignment as either defaulted or deleted.
205 template <typename _Tp, typename _Dp,
206 bool = is_move_constructible<_Dp>::value,
207 bool = is_move_assignable<_Dp>::value>
208 struct __uniq_ptr_data : __uniq_ptr_impl<_Tp, _Dp>
209 {
210 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
211 __uniq_ptr_data(__uniq_ptr_data&&) = default;
212 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default;
213 };
214
215 template <typename _Tp, typename _Dp>
216 struct __uniq_ptr_data<_Tp, _Dp, true, false> : __uniq_ptr_impl<_Tp, _Dp>
217 {
218 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
219 __uniq_ptr_data(__uniq_ptr_data&&) = default;
220 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete;
221 };
222
223 template <typename _Tp, typename _Dp>
224 struct __uniq_ptr_data<_Tp, _Dp, false, true> : __uniq_ptr_impl<_Tp, _Dp>
225 {
226 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
227 __uniq_ptr_data(__uniq_ptr_data&&) = delete;
228 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default;
229 };
230
231 template <typename _Tp, typename _Dp>
232 struct __uniq_ptr_data<_Tp, _Dp, false, false> : __uniq_ptr_impl<_Tp, _Dp>
233 {
234 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
235 __uniq_ptr_data(__uniq_ptr_data&&) = delete;
236 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete;
237 };
238 /// @endcond
239
240 /// 20.7.1.2 unique_ptr for single objects.
241 template <typename _Tp, typename _Dp = default_delete<_Tp>>
242 class unique_ptr
243 {
244 template <typename _Up>
245 using _DeleterConstraint =
246 typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type;
247
248 __uniq_ptr_data<_Tp, _Dp> _M_t;
249
250 public:
251 using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer;
252 using element_type = _Tp;
253 using deleter_type = _Dp;
254
255 private:
256 // helper template for detecting a safe conversion from another
257 // unique_ptr
258 template<typename _Up, typename _Ep>
259 using __safe_conversion_up = __and_<
260 is_convertible<typename unique_ptr<_Up, _Ep>::pointer, pointer>,
261 __not_<is_array<_Up>>
262 >;
263
264 public:
265 // Constructors.
266
267 /// Default constructor, creates a unique_ptr that owns nothing.
268 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
269 constexpr unique_ptr() noexcept
270 : _M_t()
271 { }
272
273 /** Takes ownership of a pointer.
274 *
275 * @param __p A pointer to an object of @c element_type
276 *
277 * The deleter will be value-initialized.
278 */
279 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
280 explicit
281 unique_ptr(pointer __p) noexcept
282 : _M_t(__p)
283 { }
284
285 /** Takes ownership of a pointer.
286 *
287 * @param __p A pointer to an object of @c element_type
288 * @param __d A reference to a deleter.
289 *
290 * The deleter will be initialized with @p __d
291 */
292 template<typename _Del = deleter_type,
293 typename = _Require<is_copy_constructible<_Del>>>
294 unique_ptr(pointer __p, const deleter_type& __d) noexcept
295 : _M_t(__p, __d) { }
296
297 /** Takes ownership of a pointer.
298 *
299 * @param __p A pointer to an object of @c element_type
300 * @param __d An rvalue reference to a (non-reference) deleter.
301 *
302 * The deleter will be initialized with @p std::move(__d)
303 */
304 template<typename _Del = deleter_type,
305 typename = _Require<is_move_constructible<_Del>>>
306 unique_ptr(pointer __p,
307 __enable_if_t<!is_lvalue_reference<_Del>::value,
308 _Del&&> __d) noexcept
309 : _M_t(__p, std::move(__d))
310 { }
311
312 template<typename _Del = deleter_type,
313 typename _DelUnref = typename remove_reference<_Del>::type>
314 unique_ptr(pointer,
315 __enable_if_t<is_lvalue_reference<_Del>::value,
316 _DelUnref&&>) = delete;
317
318 /// Creates a unique_ptr that owns nothing.
319 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
320 constexpr unique_ptr(nullptr_t) noexcept
321 : _M_t()
322 { }
323
324 // Move constructors.
325
326 /// Move constructor.
327 unique_ptr(unique_ptr&&) = default;
328
329 /** @brief Converting constructor from another type
330 *
331 * Requires that the pointer owned by @p __u is convertible to the
332 * type of pointer owned by this object, @p __u does not own an array,
333 * and @p __u has a compatible deleter type.
334 */
335 template<typename _Up, typename _Ep, typename = _Require<
336 __safe_conversion_up<_Up, _Ep>,
337 typename conditional<is_reference<_Dp>::value,
338 is_same<_Ep, _Dp>,
339 is_convertible<_Ep, _Dp>>::type>>
340 unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept
341 : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter()))
342 { }
343
344#if _GLIBCXX_USE_DEPRECATED1
345#pragma GCC diagnostic push
346#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
347 /// Converting constructor from @c auto_ptr
348 template<typename _Up, typename = _Require<
349 is_convertible<_Up*, _Tp*>, is_same<_Dp, default_delete<_Tp>>>>
350 unique_ptr(auto_ptr<_Up>&& __u) noexcept;
351#pragma GCC diagnostic pop
352#endif
353
354 /// Destructor, invokes the deleter if the stored pointer is not null.
355 ~unique_ptr() noexcept
356 {
357 static_assert(__is_invocable<deleter_type&, pointer>::value,
358 "unique_ptr's deleter must be invocable with a pointer");
359 auto& __ptr = _M_t._M_ptr();
360 if (__ptr != nullptr)
361 get_deleter()(std::move(__ptr));
362 __ptr = pointer();
363 }
364
365 // Assignment.
366
367 /** @brief Move assignment operator.
368 *
369 * Invokes the deleter if this object owns a pointer.
370 */
371 unique_ptr& operator=(unique_ptr&&) = default;
372
373 /** @brief Assignment from another type.
374 *
375 * @param __u The object to transfer ownership from, which owns a
376 * convertible pointer to a non-array object.
377 *
378 * Invokes the deleter if this object owns a pointer.
379 */
380 template<typename _Up, typename _Ep>
381 typename enable_if< __and_<
382 __safe_conversion_up<_Up, _Ep>,
383 is_assignable<deleter_type&, _Ep&&>
384 >::value,
385 unique_ptr&>::type
386 operator=(unique_ptr<_Up, _Ep>&& __u) noexcept
387 {
388 reset(__u.release());
389 get_deleter() = std::forward<_Ep>(__u.get_deleter());
390 return *this;
391 }
392
393 /// Reset the %unique_ptr to empty, invoking the deleter if necessary.
394 unique_ptr&
395 operator=(nullptr_t) noexcept
396 {
397 reset();
398 return *this;
399 }
400
401 // Observers.
402
403 /// Dereference the stored pointer.
404 typename add_lvalue_reference<element_type>::type
405 operator*() const
406 {
407 __glibcxx_assert(get() != pointer());
408 return *get();
409 }
410
411 /// Return the stored pointer.
412 pointer
413 operator->() const noexcept
414 {
415 _GLIBCXX_DEBUG_PEDASSERT(get() != pointer());
416 return get();
417 }
418
419 /// Return the stored pointer.
420 pointer
421 get() const noexcept
422 { return _M_t._M_ptr(); }
423
424 /// Return a reference to the stored deleter.
425 deleter_type&
426 get_deleter() noexcept
427 { return _M_t._M_deleter(); }
428
429 /// Return a reference to the stored deleter.
430 const deleter_type&
431 get_deleter() const noexcept
432 { return _M_t._M_deleter(); }
433
434 /// Return @c true if the stored pointer is not null.
435 explicit operator bool() const noexcept
436 { return get() == pointer() ? false : true; }
437
438 // Modifiers.
439
440 /// Release ownership of any stored pointer.
441 pointer
442 release() noexcept
443 { return _M_t.release(); }
444
445 /** @brief Replace the stored pointer.
446 *
447 * @param __p The new pointer to store.
448 *
449 * The deleter will be invoked if a pointer is already owned.
450 */
451 void
452 reset(pointer __p = pointer()) noexcept
453 {
454 static_assert(__is_invocable<deleter_type&, pointer>::value,
455 "unique_ptr's deleter must be invocable with a pointer");
456 _M_t.reset(std::move(__p));
457 }
458
459 /// Exchange the pointer and deleter with another object.
460 void
461 swap(unique_ptr& __u) noexcept
462 {
463 static_assert(__is_swappable<_Dp>::value, "deleter must be swappable");
464 _M_t.swap(__u._M_t);
465 }
466
467 // Disable copy from lvalue.
468 unique_ptr(const unique_ptr&) = delete;
469 unique_ptr& operator=(const unique_ptr&) = delete;
470 };
471
472 /// 20.7.1.3 unique_ptr for array objects with a runtime length
473 // [unique.ptr.runtime]
474 // _GLIBCXX_RESOLVE_LIB_DEFECTS
475 // DR 740 - omit specialization for array objects with a compile time length
476 template<typename _Tp, typename _Dp>
477 class unique_ptr<_Tp[], _Dp>
478 {
479 template <typename _Up>
480 using _DeleterConstraint =
481 typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type;
482
483 __uniq_ptr_data<_Tp, _Dp> _M_t;
484
485 template<typename _Up>
486 using __remove_cv = typename remove_cv<_Up>::type;
487
488 // like is_base_of<_Tp, _Up> but false if unqualified types are the same
489 template<typename _Up>
490 using __is_derived_Tp
491 = __and_< is_base_of<_Tp, _Up>,
492 __not_<is_same<__remove_cv<_Tp>, __remove_cv<_Up>>> >;
493
494 public:
495 using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer;
496 using element_type = _Tp;
497 using deleter_type = _Dp;
498
499 // helper template for detecting a safe conversion from another
500 // unique_ptr
501 template<typename _Up, typename _Ep,
502 typename _UPtr = unique_ptr<_Up, _Ep>,
503 typename _UP_pointer = typename _UPtr::pointer,
504 typename _UP_element_type = typename _UPtr::element_type>
505 using __safe_conversion_up = __and_<
506 is_array<_Up>,
507 is_same<pointer, element_type*>,
508 is_same<_UP_pointer, _UP_element_type*>,
509 is_convertible<_UP_element_type(*)[], element_type(*)[]>
510 >;
511
512 // helper template for detecting a safe conversion from a raw pointer
513 template<typename _Up>
514 using __safe_conversion_raw = __and_<
515 __or_<__or_<is_same<_Up, pointer>,
516 is_same<_Up, nullptr_t>>,
517 __and_<is_pointer<_Up>,
518 is_same<pointer, element_type*>,
519 is_convertible<
520 typename remove_pointer<_Up>::type(*)[],
521 element_type(*)[]>
522 >
523 >
524 >;
525
526 // Constructors.
527
528 /// Default constructor, creates a unique_ptr that owns nothing.
529 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
530 constexpr unique_ptr() noexcept
531 : _M_t()
532 { }
533
534 /** Takes ownership of a pointer.
535 *
536 * @param __p A pointer to an array of a type safely convertible
537 * to an array of @c element_type
538 *
539 * The deleter will be value-initialized.
540 */
541 template<typename _Up,
542 typename _Vp = _Dp,
543 typename = _DeleterConstraint<_Vp>,
544 typename = typename enable_if<
545 __safe_conversion_raw<_Up>::value, bool>::type>
546 explicit
547 unique_ptr(_Up __p) noexcept
548 : _M_t(__p)
549 { }
550
551 /** Takes ownership of a pointer.
552 *
553 * @param __p A pointer to an array of a type safely convertible
554 * to an array of @c element_type
555 * @param __d A reference to a deleter.
556 *
557 * The deleter will be initialized with @p __d
558 */
559 template<typename _Up, typename _Del = deleter_type,
560 typename = _Require<__safe_conversion_raw<_Up>,
561 is_copy_constructible<_Del>>>
562 unique_ptr(_Up __p, const deleter_type& __d) noexcept
563 : _M_t(__p, __d) { }
564
565 /** Takes ownership of a pointer.
566 *
567 * @param __p A pointer to an array of a type safely convertible
568 * to an array of @c element_type
569 * @param __d A reference to a deleter.
570 *
571 * The deleter will be initialized with @p std::move(__d)
572 */
573 template<typename _Up, typename _Del = deleter_type,
574 typename = _Require<__safe_conversion_raw<_Up>,
575 is_move_constructible<_Del>>>
576 unique_ptr(_Up __p,
577 __enable_if_t<!is_lvalue_reference<_Del>::value,
578 _Del&&> __d) noexcept
579 : _M_t(std::move(__p), std::move(__d))
580 { }
581
582 template<typename _Up, typename _Del = deleter_type,
583 typename _DelUnref = typename remove_reference<_Del>::type,
584 typename = _Require<__safe_conversion_raw<_Up>>>
585 unique_ptr(_Up,
586 __enable_if_t<is_lvalue_reference<_Del>::value,
587 _DelUnref&&>) = delete;
588
589 /// Move constructor.
590 unique_ptr(unique_ptr&&) = default;
591
592 /// Creates a unique_ptr that owns nothing.
593 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
594 constexpr unique_ptr(nullptr_t) noexcept
595 : _M_t()
596 { }
597
598 template<typename _Up, typename _Ep, typename = _Require<
599 __safe_conversion_up<_Up, _Ep>,
600 typename conditional<is_reference<_Dp>::value,
601 is_same<_Ep, _Dp>,
602 is_convertible<_Ep, _Dp>>::type>>
603 unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept
604 : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter()))
605 { }
606
607 /// Destructor, invokes the deleter if the stored pointer is not null.
608 ~unique_ptr()
609 {
610 auto& __ptr = _M_t._M_ptr();
611 if (__ptr != nullptr)
612 get_deleter()(__ptr);
613 __ptr = pointer();
614 }
615
616 // Assignment.
617
618 /** @brief Move assignment operator.
619 *
620 * Invokes the deleter if this object owns a pointer.
621 */
622 unique_ptr&
623 operator=(unique_ptr&&) = default;
624
625 /** @brief Assignment from another type.
626 *
627 * @param __u The object to transfer ownership from, which owns a
628 * convertible pointer to an array object.
629 *
630 * Invokes the deleter if this object owns a pointer.
631 */
632 template<typename _Up, typename _Ep>
633 typename
634 enable_if<__and_<__safe_conversion_up<_Up, _Ep>,
635 is_assignable<deleter_type&, _Ep&&>
636 >::value,
637 unique_ptr&>::type
638 operator=(unique_ptr<_Up, _Ep>&& __u) noexcept
639 {
640 reset(__u.release());
641 get_deleter() = std::forward<_Ep>(__u.get_deleter());
642 return *this;
643 }
644
645 /// Reset the %unique_ptr to empty, invoking the deleter if necessary.
646 unique_ptr&
647 operator=(nullptr_t) noexcept
648 {
649 reset();
650 return *this;
651 }
652
653 // Observers.
654
655 /// Access an element of owned array.
656 typename std::add_lvalue_reference<element_type>::type
657 operator[](size_t __i) const
658 {
659 __glibcxx_assert(get() != pointer());
660 return get()[__i];
661 }
662
663 /// Return the stored pointer.
664 pointer
665 get() const noexcept
666 { return _M_t._M_ptr(); }
667
668 /// Return a reference to the stored deleter.
669 deleter_type&
670 get_deleter() noexcept
671 { return _M_t._M_deleter(); }
672
673 /// Return a reference to the stored deleter.
674 const deleter_type&
675 get_deleter() const noexcept
676 { return _M_t._M_deleter(); }
677
678 /// Return @c true if the stored pointer is not null.
679 explicit operator bool() const noexcept
680 { return get() == pointer() ? false : true; }
681
682 // Modifiers.
683
684 /// Release ownership of any stored pointer.
685 pointer
686 release() noexcept
687 { return _M_t.release(); }
688
689 /** @brief Replace the stored pointer.
690 *
691 * @param __p The new pointer to store.
692 *
693 * The deleter will be invoked if a pointer is already owned.
694 */
695 template <typename _Up,
696 typename = _Require<
697 __or_<is_same<_Up, pointer>,
698 __and_<is_same<pointer, element_type*>,
699 is_pointer<_Up>,
700 is_convertible<
701 typename remove_pointer<_Up>::type(*)[],
702 element_type(*)[]
703 >
704 >
705 >
706 >>
707 void
708 reset(_Up __p) noexcept
709 { _M_t.reset(std::move(__p)); }
710
711 void reset(nullptr_t = nullptr) noexcept
712 { reset(pointer()); }
713
714 /// Exchange the pointer and deleter with another object.
715 void
716 swap(unique_ptr& __u) noexcept
717 {
718 static_assert(__is_swappable<_Dp>::value, "deleter must be swappable");
719 _M_t.swap(__u._M_t);
720 }
721
722 // Disable copy from lvalue.
723 unique_ptr(const unique_ptr&) = delete;
724 unique_ptr& operator=(const unique_ptr&) = delete;
725 };
726
727 /// @relates unique_ptr @{
728
729 /// Swap overload for unique_ptr
730 template<typename _Tp, typename _Dp>
731 inline
732#if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11
733 // Constrained free swap overload, see p0185r1
734 typename enable_if<__is_swappable<_Dp>::value>::type
735#else
736 void
737#endif
738 swap(unique_ptr<_Tp, _Dp>& __x,
739 unique_ptr<_Tp, _Dp>& __y) noexcept
740 { __x.swap(__y); }
741
742#if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11
743 template<typename _Tp, typename _Dp>
744 typename enable_if<!__is_swappable<_Dp>::value>::type
745 swap(unique_ptr<_Tp, _Dp>&,
746 unique_ptr<_Tp, _Dp>&) = delete;
747#endif
748
749 /// Equality operator for unique_ptr objects, compares the owned pointers
750 template<typename _Tp, typename _Dp,
751 typename _Up, typename _Ep>
752 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
753 operator==(const unique_ptr<_Tp, _Dp>& __x,
754 const unique_ptr<_Up, _Ep>& __y)
755 { return __x.get() == __y.get(); }
756
757 /// unique_ptr comparison with nullptr
758 template<typename _Tp, typename _Dp>
759 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
760 operator==(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept
761 { return !__x; }
762
763#ifndef __cpp_lib_three_way_comparison
764 /// unique_ptr comparison with nullptr
765 template<typename _Tp, typename _Dp>
766 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
767 operator==(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept
768 { return !__x; }
769
770 /// Inequality operator for unique_ptr objects, compares the owned pointers
771 template<typename _Tp, typename _Dp,
772 typename _Up, typename _Ep>
773 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
774 operator!=(const unique_ptr<_Tp, _Dp>& __x,
775 const unique_ptr<_Up, _Ep>& __y)
776 { return __x.get() != __y.get(); }
777
778 /// unique_ptr comparison with nullptr
779 template<typename _Tp, typename _Dp>
780 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
781 operator!=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept
782 { return (bool)__x; }
783
784 /// unique_ptr comparison with nullptr
785 template<typename _Tp, typename _Dp>
786 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
787 operator!=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept
788 { return (bool)__x; }
789#endif // three way comparison
790
791 /// Relational operator for unique_ptr objects, compares the owned pointers
792 template<typename _Tp, typename _Dp,
793 typename _Up, typename _Ep>
794 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
795 operator<(const unique_ptr<_Tp, _Dp>& __x,
796 const unique_ptr<_Up, _Ep>& __y)
797 {
798 typedef typename
799 std::common_type<typename unique_ptr<_Tp, _Dp>::pointer,
800 typename unique_ptr<_Up, _Ep>::pointer>::type _CT;
801 return std::less<_CT>()(__x.get(), __y.get());
802 }
803
804 /// unique_ptr comparison with nullptr
805 template<typename _Tp, typename _Dp>
806 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
807 operator<(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
808 {
809 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(),
810 nullptr);
811 }
812
813 /// unique_ptr comparison with nullptr
814 template<typename _Tp, typename _Dp>
815 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
816 operator<(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
817 {
818 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr,
819 __x.get());
820 }
821
822 /// Relational operator for unique_ptr objects, compares the owned pointers
823 template<typename _Tp, typename _Dp,
824 typename _Up, typename _Ep>
825 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
826 operator<=(const unique_ptr<_Tp, _Dp>& __x,
827 const unique_ptr<_Up, _Ep>& __y)
828 { return !(__y < __x); }
829
830 /// unique_ptr comparison with nullptr
831 template<typename _Tp, typename _Dp>
832 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
833 operator<=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
834 { return !(nullptr < __x); }
835
836 /// unique_ptr comparison with nullptr
837 template<typename _Tp, typename _Dp>
838 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
839 operator<=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
840 { return !(__x < nullptr); }
841
842 /// Relational operator for unique_ptr objects, compares the owned pointers
843 template<typename _Tp, typename _Dp,
844 typename _Up, typename _Ep>
845 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
846 operator>(const unique_ptr<_Tp, _Dp>& __x,
847 const unique_ptr<_Up, _Ep>& __y)
848 { return (__y < __x); }
849
850 /// unique_ptr comparison with nullptr
851 template<typename _Tp, typename _Dp>
852 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
853 operator>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
854 {
855 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr,
856 __x.get());
857 }
858
859 /// unique_ptr comparison with nullptr
860 template<typename _Tp, typename _Dp>
861 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
862 operator>(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
863 {
864 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(),
865 nullptr);
866 }
867
868 /// Relational operator for unique_ptr objects, compares the owned pointers
869 template<typename _Tp, typename _Dp,
870 typename _Up, typename _Ep>
871 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
872 operator>=(const unique_ptr<_Tp, _Dp>& __x,
873 const unique_ptr<_Up, _Ep>& __y)
874 { return !(__x < __y); }
875
876 /// unique_ptr comparison with nullptr
877 template<typename _Tp, typename _Dp>
878 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
879 operator>=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
880 { return !(__x < nullptr); }
881
882 /// unique_ptr comparison with nullptr
883 template<typename _Tp, typename _Dp>
884 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
885 operator>=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
886 { return !(nullptr < __x); }
887
888#ifdef __cpp_lib_three_way_comparison
889 template<typename _Tp, typename _Dp, typename _Up, typename _Ep>
890 requires three_way_comparable_with<typename unique_ptr<_Tp, _Dp>::pointer,
891 typename unique_ptr<_Up, _Ep>::pointer>
892 inline
893 compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer,
894 typename unique_ptr<_Up, _Ep>::pointer>
895 operator<=>(const unique_ptr<_Tp, _Dp>& __x,
896 const unique_ptr<_Up, _Ep>& __y)
897 { return compare_three_way()(__x.get(), __y.get()); }
898
899 template<typename _Tp, typename _Dp>
900 requires three_way_comparable<typename unique_ptr<_Tp, _Dp>::pointer>
901 inline
902 compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer>
903 operator<=>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
904 {
905 using pointer = typename unique_ptr<_Tp, _Dp>::pointer;
906 return compare_three_way()(__x.get(), static_cast<pointer>(nullptr));
907 }
908#endif
909 // @} relates unique_ptr
910
911 /// @cond undocumented
912 template<typename _Up, typename _Ptr = typename _Up::pointer,
913 bool = __poison_hash<_Ptr>::__enable_hash_call>
914 struct __uniq_ptr_hash
915#if ! _GLIBCXX_INLINE_VERSION0
916 : private __poison_hash<_Ptr>
917#endif
918 {
919 size_t
920 operator()(const _Up& __u) const
921 noexcept(noexcept(std::declval<hash<_Ptr>>()(std::declval<_Ptr>())))
922 { return hash<_Ptr>()(__u.get()); }
923 };
924
925 template<typename _Up, typename _Ptr>
926 struct __uniq_ptr_hash<_Up, _Ptr, false>
927 : private __poison_hash<_Ptr>
928 { };
929 /// @endcond
930
931 /// std::hash specialization for unique_ptr.
932 template<typename _Tp, typename _Dp>
933 struct hash<unique_ptr<_Tp, _Dp>>
934 : public __hash_base<size_t, unique_ptr<_Tp, _Dp>>,
935 public __uniq_ptr_hash<unique_ptr<_Tp, _Dp>>
936 { };
937
938#if __cplusplus201703L >= 201402L
939 /// @relates unique_ptr @{
940#define __cpp_lib_make_unique201304 201304
941
942 /// @cond undocumented
943
944 template<typename _Tp>
945 struct _MakeUniq
946 { typedef unique_ptr<_Tp> __single_object; };
947
948 template<typename _Tp>
949 struct _MakeUniq<_Tp[]>
950 { typedef unique_ptr<_Tp[]> __array; };
951
952 template<typename _Tp, size_t _Bound>
953 struct _MakeUniq<_Tp[_Bound]>
954 { struct __invalid_type { }; };
955
956 /// @endcond
957
958 /// std::make_unique for single objects
959 template<typename _Tp, typename... _Args>
960 inline typename _MakeUniq<_Tp>::__single_object
961 make_unique(_Args&&... __args)
962 { return unique_ptr<_Tp>(new _Tp(std::forward<_Args>(__args)...)); }
2
Calling constructor for 'SvxFontWorkChildWindow'
963
964 /// std::make_unique for arrays of unknown bound
965 template<typename _Tp>
966 inline typename _MakeUniq<_Tp>::__array
967 make_unique(size_t __num)
968 { return unique_ptr<_Tp>(new remove_extent_t<_Tp>[__num]()); }
969
970 /// Disable std::make_unique for arrays of known bound
971 template<typename _Tp, typename... _Args>
972 inline typename _MakeUniq<_Tp>::__invalid_type
973 make_unique(_Args&&...) = delete;
974 // @} relates unique_ptr
975#endif // C++14
976
977#if __cplusplus201703L > 201703L && __cpp_concepts
978 // _GLIBCXX_RESOLVE_LIB_DEFECTS
979 // 2948. unique_ptr does not define operator<< for stream output
980 /// Stream output operator for unique_ptr
981 template<typename _CharT, typename _Traits, typename _Tp, typename _Dp>
982 inline basic_ostream<_CharT, _Traits>&
983 operator<<(basic_ostream<_CharT, _Traits>& __os,
984 const unique_ptr<_Tp, _Dp>& __p)
985 requires requires { __os << __p.get(); }
986 {
987 __os << __p.get();
988 return __os;
989 }
990#endif // C++20
991
992 // @} group pointer_abstractions
993
994#if __cplusplus201703L >= 201703L
995 namespace __detail::__variant
996 {
997 template<typename> struct _Never_valueless_alt; // see <variant>
998
999 // Provide the strong exception-safety guarantee when emplacing a
1000 // unique_ptr into a variant.
1001 template<typename _Tp, typename _Del>
1002 struct _Never_valueless_alt<std::unique_ptr<_Tp, _Del>>
1003 : std::true_type
1004 { };
1005 } // namespace __detail::__variant
1006#endif // C++17
1007
1008_GLIBCXX_END_NAMESPACE_VERSION
1009} // namespace
1010
1011#endif /* _UNIQUE_PTR_H */

/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();
17
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 )
4
Memory is allocated
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)
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
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
)
8
Taking true branch
113 m_pBody->release();
9
Calling 'VclReferenceBase::release'
13
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;
18
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

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