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 vclmedit.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/glm -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/libmount -isystem /usr/include/blkid -isystem /usr/include/cairo -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/pixman-1 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/libxml2 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -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 VCL_DLLIMPLEMENTATION -D DLLIMPLEMENTATION_UITEST -D CUI_DLL_NAME="libcuilo.so" -D DESKTOP_DETECTOR_DLL_NAME="libdesktop_detectorlo.so" -D TK_DLL_NAME="libtklo.so" -D SYSTEM_ZLIB -D GLM_FORCE_CTOR_INIT -D SK_USER_CONFIG_HEADER=</home/maarten/src/libreoffice/core/config_host/config_skia.h> -D SKIA_DLL -D ENABLE_CUPS -D HAVE_VALGRIND_HEADERS -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/core -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/effects -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/config -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/ports -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/third_party/vulkan -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/tools/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia -I /home/maarten/src/libreoffice/core/external/skia/inc/ -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/lcms2/include -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/workdir/UnpackedTarball/harfbuzz/src -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/graphite/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium/public -D COMPONENT_BUILD -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libpng -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libjpeg-turbo -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/vcl/inc -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 -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/libxml2 -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/vcl/source/edit/vclmedit.cxx

/home/maarten/src/libreoffice/core/vcl/source/edit/vclmedit.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 <memory>
21#include <i18nlangtag/languagetag.hxx>
22#include <vcl/commandevent.hxx>
23#include <vcl/builder.hxx>
24#include <vcl/decoview.hxx>
25#include <vcl/event.hxx>
26#include <vcl/specialchars.hxx>
27#include <vcl/timer.hxx>
28#include <vcl/toolkit/vclmedit.hxx>
29#include <vcl/xtextedt.hxx>
30#include <vcl/textview.hxx>
31#include <vcl/ptrstyle.hxx>
32
33#include <svl/undo.hxx>
34#include <svl/lstner.hxx>
35#include <vcl/uitest/uiobject.hxx>
36
37#include <vcl/scrbar.hxx>
38#include <vcl/settings.hxx>
39#include <vcl/weld.hxx>
40#include <osl/diagnose.h>
41#include <tools/json_writer.hxx>
42
43class ImpVclMEdit : public SfxListener
44{
45private:
46 VclPtr<VclMultiLineEdit> pVclMultiLineEdit;
47
48 VclPtr<TextWindow> mpTextWindow;
49 VclPtr<ScrollBar> mpHScrollBar;
50 VclPtr<ScrollBar> mpVScrollBar;
51 VclPtr<ScrollBarBox> mpScrollBox;
52
53 long mnTextWidth;
54 mutable Selection maSelection;
55
56protected:
57 virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
58 void ImpUpdateScrollBarVis( WinBits nWinStyle );
59 void ImpInitScrollBars();
60 void ImpSetScrollBarRanges();
61 void ImpSetHScrollBarThumbPos();
62 DECL_LINK( ScrollHdl, ScrollBar*, void )static void LinkStubScrollHdl(void *, ScrollBar*); void ScrollHdl
(ScrollBar*);
63
64public:
65 ImpVclMEdit( VclMultiLineEdit* pVclMultiLineEdit, WinBits nWinStyle );
66 virtual ~ImpVclMEdit() override;
67
68 void SetModified( bool bMod );
69
70 void SetReadOnly( bool bRdOnly );
71 bool IsReadOnly() const;
72
73 void SetMaxTextLen(sal_Int32 nLen);
74 sal_Int32 GetMaxTextLen() const;
75
76 void SetMaxTextWidth(long nMaxWidth);
77
78 void InsertText( const OUString& rStr );
79 OUString GetSelected() const;
80 OUString GetSelected( LineEnd aSeparator ) const;
81
82 void SetSelection( const Selection& rSelection );
83 const Selection& GetSelection() const;
84
85 void Cut();
86 void Copy();
87 void Paste();
88
89 void SetText( const OUString& rStr );
90 OUString GetText() const;
91 OUString GetText( LineEnd aSeparator ) const;
92 OUString GetTextLines( LineEnd aSeparator ) const;
93
94 void Resize();
95 void GetFocus();
96
97 bool HandleCommand( const CommandEvent& rCEvt );
98
99 void Enable( bool bEnable );
100
101 Size CalcMinimumSize() const;
102 Size CalcBlockSize( sal_uInt16 nColumns, sal_uInt16 nLines ) const;
103 void GetMaxVisColumnsAndLines( sal_uInt16& rnCols, sal_uInt16& rnLines ) const;
104
105 void SetAlign( WinBits nWinStyle );
106
107 void InitFromStyle( WinBits nWinStyle );
108
109 TextWindow* GetTextWindow() { return mpTextWindow; }
110 ScrollBar& GetHScrollBar() { return *mpHScrollBar; }
111 ScrollBar& GetVScrollBar() { return *mpVScrollBar; }
112};
113
114ImpVclMEdit::ImpVclMEdit( VclMultiLineEdit* pEdt, WinBits nWinStyle )
115 : pVclMultiLineEdit(pEdt)
116 , mpTextWindow(VclPtr<TextWindow>::Create(pEdt))
117 , mpHScrollBar(VclPtr<ScrollBar>::Create(pVclMultiLineEdit, WB_HSCROLL|WB_DRAG))
118 , mpVScrollBar(VclPtr<ScrollBar>::Create(pVclMultiLineEdit, WB_VSCROLL|WB_DRAG))
119 , mpScrollBox(VclPtr<ScrollBarBox>::Create(pVclMultiLineEdit, WB_SIZEABLE))
120 , mnTextWidth(0)
121{
122 mpVScrollBar->SetScrollHdl( LINK( this, ImpVclMEdit, ScrollHdl )::tools::detail::makeLink( ::tools::detail::castTo<ImpVclMEdit
*>(this), &ImpVclMEdit::LinkStubScrollHdl) );
123 mpHScrollBar->SetScrollHdl( LINK( this, ImpVclMEdit, ScrollHdl )::tools::detail::makeLink( ::tools::detail::castTo<ImpVclMEdit
*>(this), &ImpVclMEdit::LinkStubScrollHdl) );
124 mpTextWindow->Show();
125 InitFromStyle( nWinStyle );
126 StartListening( *mpTextWindow->GetTextEngine() );
127}
128
129void ImpVclMEdit::ImpUpdateScrollBarVis( WinBits nWinStyle )
130{
131 const bool bHaveVScroll = mpVScrollBar->IsVisible();
132 const bool bHaveHScroll = mpHScrollBar->IsVisible();
133 const bool bHaveScrollBox = mpScrollBox->IsVisible();
134
135 bool bNeedVScroll = ( nWinStyle & WB_VSCROLL ) == WB_VSCROLL;
136 const bool bNeedHScroll = ( nWinStyle & WB_HSCROLL ) == WB_HSCROLL;
137
138 const bool bAutoVScroll = ( nWinStyle & WB_AUTOVSCROLL ) == WB_AUTOVSCROLL;
139 if ( !bNeedVScroll && bAutoVScroll )
140 {
141 TextEngine& rEngine( *mpTextWindow->GetTextEngine() );
142 long nOverallTextHeight(0);
143 for ( sal_uInt32 i=0; i<rEngine.GetParagraphCount(); ++i )
144 nOverallTextHeight += rEngine.GetTextHeight( i );
145 if ( nOverallTextHeight > mpTextWindow->GetOutputSizePixel().Height() )
146 bNeedVScroll = true;
147 }
148
149 const bool bNeedScrollBox = bNeedVScroll && bNeedHScroll;
150
151 bool bScrollbarsChanged = false;
152 if ( bHaveVScroll != bNeedVScroll )
153 {
154 mpVScrollBar->Show(bNeedVScroll);
155 bScrollbarsChanged = true;
156 }
157
158 if ( bHaveHScroll != bNeedHScroll )
159 {
160 mpHScrollBar->Show(bNeedHScroll);
161 bScrollbarsChanged = true;
162 }
163
164 if ( bHaveScrollBox != bNeedScrollBox )
165 {
166 mpScrollBox->Show(bNeedScrollBox);
167 }
168
169 if ( bScrollbarsChanged )
170 {
171 ImpInitScrollBars();
172 Resize();
173 }
174}
175
176void ImpVclMEdit::InitFromStyle( WinBits nWinStyle )
177{
178 ImpUpdateScrollBarVis( nWinStyle );
179 SetAlign( nWinStyle );
180
181 if ( nWinStyle & WB_NOHIDESELECTION )
182 mpTextWindow->SetAutoFocusHide( false );
183 else
184 mpTextWindow->SetAutoFocusHide( true );
185
186 if ( nWinStyle & WB_READONLY )
187 mpTextWindow->GetTextView()->SetReadOnly( true );
188 else
189 mpTextWindow->GetTextView()->SetReadOnly( false );
190
191 if ( nWinStyle & WB_IGNORETAB )
192 {
193 mpTextWindow->SetIgnoreTab( true );
194 }
195 else
196 {
197 mpTextWindow->SetIgnoreTab( false );
198 // #103667# VclMultiLineEdit has the flag, but focusable window also needs this flag
199 WinBits nStyle = mpTextWindow->GetStyle();
200 nStyle |= WB_NODIALOGCONTROL;
201 mpTextWindow->SetStyle( nStyle );
202 }
203}
204
205ImpVclMEdit::~ImpVclMEdit()
206{
207 EndListening( *mpTextWindow->GetTextEngine() );
208 mpTextWindow.disposeAndClear();
209 mpHScrollBar.disposeAndClear();
210 mpVScrollBar.disposeAndClear();
211 mpScrollBox.disposeAndClear();
212 pVclMultiLineEdit.disposeAndClear();
7
←
Calling 'VclPtr::disposeAndClear'
→
213}
214
215void ImpVclMEdit::ImpSetScrollBarRanges()
216{
217 const long nTextHeight = mpTextWindow->GetTextEngine()->GetTextHeight();
218 mpVScrollBar->SetRange( Range( 0, nTextHeight-1 ) );
219
220 mpHScrollBar->SetRange( Range( 0, mnTextWidth-1 ) );
221}
222
223void ImpVclMEdit::ImpInitScrollBars()
224{
225 static const sal_Unicode sampleChar = { 'x' };
226
227 ImpSetScrollBarRanges();
228
229 Size aCharBox;
230 aCharBox.setWidth( mpTextWindow->GetTextWidth( OUString(sampleChar) ) );
231 aCharBox.setHeight( mpTextWindow->GetTextHeight() );
232 Size aOutSz = mpTextWindow->GetOutputSizePixel();
233
234 mpHScrollBar->SetVisibleSize( aOutSz.Width() );
235 mpHScrollBar->SetPageSize( aOutSz.Width() * 8 / 10 );
236 mpHScrollBar->SetLineSize( aCharBox.Width()*10 );
237 ImpSetHScrollBarThumbPos();
238
239 mpVScrollBar->SetVisibleSize( aOutSz.Height() );
240 mpVScrollBar->SetPageSize( aOutSz.Height() * 8 / 10 );
241 mpVScrollBar->SetLineSize( aCharBox.Height() );
242 mpVScrollBar->SetThumbPos( mpTextWindow->GetTextView()->GetStartDocPos().Y() );
243}
244
245void ImpVclMEdit::ImpSetHScrollBarThumbPos()
246{
247 long nX = mpTextWindow->GetTextView()->GetStartDocPos().X();
248 if ( !mpTextWindow->GetTextEngine()->IsRightToLeft() )
249 mpHScrollBar->SetThumbPos( nX );
250 else
251 mpHScrollBar->SetThumbPos( mnTextWidth - mpHScrollBar->GetVisibleSize() - nX );
252
253}
254
255IMPL_LINK( ImpVclMEdit, ScrollHdl, ScrollBar*, pCurScrollBar, void )void ImpVclMEdit::LinkStubScrollHdl(void * instance, ScrollBar
* data) { return static_cast<ImpVclMEdit *>(instance)->
ScrollHdl(data); } void ImpVclMEdit::ScrollHdl(ScrollBar* pCurScrollBar
)
256{
257 long nDiffX = 0, nDiffY = 0;
258
259 if ( pCurScrollBar == mpVScrollBar )
260 nDiffY = mpTextWindow->GetTextView()->GetStartDocPos().Y() - pCurScrollBar->GetThumbPos();
261 else if ( pCurScrollBar == mpHScrollBar )
262 nDiffX = mpTextWindow->GetTextView()->GetStartDocPos().X() - pCurScrollBar->GetThumbPos();
263
264 mpTextWindow->GetTextView()->Scroll( nDiffX, nDiffY );
265 // mpTextWindow->GetTextView()->ShowCursor( false, true );
266}
267
268void ImpVclMEdit::SetAlign( WinBits nWinStyle )
269{
270 bool bRTL = AllSettings::GetLayoutRTL();
271 mpTextWindow->GetTextEngine()->SetRightToLeft( bRTL );
272
273 if ( nWinStyle & WB_CENTER )
274 mpTextWindow->GetTextEngine()->SetTextAlign( TxtAlign::Center );
275 else if ( nWinStyle & WB_RIGHT )
276 mpTextWindow->GetTextEngine()->SetTextAlign( !bRTL ? TxtAlign::Right : TxtAlign::Left );
277 else if ( nWinStyle & WB_LEFT )
278 mpTextWindow->GetTextEngine()->SetTextAlign( !bRTL ? TxtAlign::Left : TxtAlign::Right );
279}
280
281void ImpVclMEdit::SetModified( bool bMod )
282{
283 mpTextWindow->GetTextEngine()->SetModified( bMod );
284}
285
286void ImpVclMEdit::SetReadOnly( bool bRdOnly )
287{
288 mpTextWindow->GetTextView()->SetReadOnly( bRdOnly );
289 // TODO: Adjust color?
290}
291
292bool ImpVclMEdit::IsReadOnly() const
293{
294 return mpTextWindow->GetTextView()->IsReadOnly();
295}
296
297void ImpVclMEdit::SetMaxTextLen(sal_Int32 nLen)
298{
299 mpTextWindow->GetTextEngine()->SetMaxTextLen(nLen);
300}
301
302sal_Int32 ImpVclMEdit::GetMaxTextLen() const
303{
304 return mpTextWindow->GetTextEngine()->GetMaxTextLen();
305}
306
307void ImpVclMEdit::InsertText( const OUString& rStr )
308{
309 mpTextWindow->GetTextView()->InsertText( rStr );
310}
311
312OUString ImpVclMEdit::GetSelected() const
313{
314 return mpTextWindow->GetTextView()->GetSelected();
315}
316
317OUString ImpVclMEdit::GetSelected( LineEnd aSeparator ) const
318{
319 return mpTextWindow->GetTextView()->GetSelected( aSeparator );
320}
321
322void ImpVclMEdit::SetMaxTextWidth(long nMaxWidth)
323{
324 mpTextWindow->GetTextEngine()->SetMaxTextWidth(nMaxWidth);
325}
326
327void ImpVclMEdit::Resize()
328{
329 int nIteration = 1;
330 do
331 {
332 WinBits nWinStyle( pVclMultiLineEdit->GetStyle() );
333 if ( ( nWinStyle & WB_AUTOVSCROLL ) == WB_AUTOVSCROLL )
334 ImpUpdateScrollBarVis( nWinStyle );
335
336 Size aSz = pVclMultiLineEdit->GetOutputSizePixel();
337 Size aEditSize = aSz;
338 long nSBWidth = pVclMultiLineEdit->GetSettings().GetStyleSettings().GetScrollBarSize();
339 nSBWidth = pVclMultiLineEdit->CalcZoom( nSBWidth );
340
341 if (mpHScrollBar->IsVisible())
342 aSz.AdjustHeight( -(nSBWidth+1) );
343 if (mpVScrollBar->IsVisible())
344 aSz.AdjustWidth( -(nSBWidth+1) );
345
346 if (!mpHScrollBar->IsVisible())
347 mpTextWindow->GetTextEngine()->SetMaxTextWidth( aSz.Width() );
348 else
349 mpHScrollBar->setPosSizePixel( 0, aEditSize.Height()-nSBWidth, aSz.Width(), nSBWidth );
350
351 Point aTextWindowPos;
352 if (mpVScrollBar->IsVisible())
353 {
354 if( AllSettings::GetLayoutRTL() )
355 {
356 mpVScrollBar->setPosSizePixel( 0, 0, nSBWidth, aSz.Height() );
357 aTextWindowPos.AdjustX(nSBWidth );
358 }
359 else
360 mpVScrollBar->setPosSizePixel( aEditSize.Width()-nSBWidth, 0, nSBWidth, aSz.Height() );
361 }
362
363 if (mpScrollBox->IsVisible())
364 mpScrollBox->setPosSizePixel( aSz.Width(), aSz.Height(), nSBWidth, nSBWidth );
365
366 Size aTextWindowSize( aSz );
367 if ( aTextWindowSize.Width() < 0 )
368 aTextWindowSize.setWidth( 0 );
369 if ( aTextWindowSize.Height() < 0 )
370 aTextWindowSize.setHeight( 0 );
371
372 Size aOldTextWindowSize( mpTextWindow->GetSizePixel() );
373 mpTextWindow->SetPosSizePixel( aTextWindowPos, aTextWindowSize );
374 if ( aOldTextWindowSize == aTextWindowSize )
375 break;
376
377 // Changing the text window size might effectively have changed the need for
378 // scrollbars, so do another iteration.
379 ++nIteration;
380 OSL_ENSURE( nIteration < 3, "ImpVclMEdit::Resize: isn't this expected to terminate with the second iteration?" )do { if (true && (!(nIteration < 3))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/edit/vclmedit.cxx"
":" "380" ": "), "%s", "ImpVclMEdit::Resize: isn't this expected to terminate with the second iteration?"
); } } while (false);
381
382 } while ( nIteration <= 3 ); // artificial break after four iterations
383
384 ImpInitScrollBars();
385}
386
387void ImpVclMEdit::GetFocus()
388{
389 mpTextWindow->GrabFocus();
390}
391
392void ImpVclMEdit::Cut()
393{
394 if ( !mpTextWindow->GetTextView()->IsReadOnly() )
395 mpTextWindow->GetTextView()->Cut();
396}
397
398void ImpVclMEdit::Copy()
399{
400 mpTextWindow->GetTextView()->Copy();
401}
402
403void ImpVclMEdit::Paste()
404{
405 if ( !mpTextWindow->GetTextView()->IsReadOnly() )
406 mpTextWindow->GetTextView()->Paste();
407}
408
409void ImpVclMEdit::SetText( const OUString& rStr )
410{
411 bool bWasModified = mpTextWindow->GetTextEngine()->IsModified();
412 mpTextWindow->GetTextEngine()->SetText( rStr );
413 if ( !bWasModified )
414 mpTextWindow->GetTextEngine()->SetModified( false );
415
416 mpTextWindow->GetTextView()->SetSelection( TextSelection() );
417
418 WinBits nWinStyle( pVclMultiLineEdit->GetStyle() );
419 if ( ( nWinStyle & WB_AUTOVSCROLL ) == WB_AUTOVSCROLL )
420 ImpUpdateScrollBarVis( nWinStyle );
421}
422
423OUString ImpVclMEdit::GetText() const
424{
425 return mpTextWindow->GetTextEngine()->GetText();
426}
427
428OUString ImpVclMEdit::GetText( LineEnd aSeparator ) const
429{
430 return mpTextWindow->GetTextEngine()->GetText( aSeparator );
431}
432
433OUString ImpVclMEdit::GetTextLines( LineEnd aSeparator ) const
434{
435 return mpTextWindow->GetTextEngine()->GetTextLines( aSeparator );
436}
437
438void ImpVclMEdit::Notify( SfxBroadcaster&, const SfxHint& rHint )
439{
440 const TextHint* pTextHint = dynamic_cast<const TextHint*>(&rHint);
441 if ( !pTextHint )
442 return;
443
444 switch (pTextHint->GetId())
445 {
446 case SfxHintId::TextViewScrolled:
447 if (mpHScrollBar->IsVisible())
448 ImpSetHScrollBarThumbPos();
449 if (mpVScrollBar->IsVisible())
450 mpVScrollBar->SetThumbPos( mpTextWindow->GetTextView()->GetStartDocPos().Y() );
451 break;
452
453 case SfxHintId::TextHeightChanged:
454 if ( mpTextWindow->GetTextView()->GetStartDocPos().Y() )
455 {
456 long nOutHeight = mpTextWindow->GetOutputSizePixel().Height();
457 long nTextHeight = mpTextWindow->GetTextEngine()->GetTextHeight();
458 if ( nTextHeight < nOutHeight )
459 mpTextWindow->GetTextView()->Scroll( 0, mpTextWindow->GetTextView()->GetStartDocPos().Y() );
460 }
461 ImpSetScrollBarRanges();
462 break;
463
464 case SfxHintId::TextFormatted:
465 if (mpHScrollBar->IsVisible())
466 {
467 const long nWidth = mpTextWindow->GetTextEngine()->CalcTextWidth();
468 if ( nWidth != mnTextWidth )
469 {
470 mnTextWidth = nWidth;
471 mpHScrollBar->SetRange( Range( 0, mnTextWidth-1 ) );
472 ImpSetHScrollBarThumbPos();
473 }
474 }
475 break;
476
477 case SfxHintId::TextModified:
478 ImpUpdateScrollBarVis(pVclMultiLineEdit->GetStyle());
479 pVclMultiLineEdit->Modify();
480 break;
481
482 case SfxHintId::TextViewSelectionChanged:
483 pVclMultiLineEdit->SelectionChanged();
484 break;
485
486 case SfxHintId::TextViewCaretChanged:
487 pVclMultiLineEdit->CaretChanged();
488 break;
489
490 default: break;
491 }
492}
493
494void ImpVclMEdit::SetSelection( const Selection& rSelection )
495{
496 OUString aText = mpTextWindow->GetTextEngine()->GetText();
497
498 Selection aNewSelection( rSelection );
499 if ( aNewSelection.Min() < 0 )
500 aNewSelection.Min() = 0;
501 else if ( aNewSelection.Min() > aText.getLength() )
502 aNewSelection.Min() = aText.getLength();
503 if ( aNewSelection.Max() < 0 )
504 aNewSelection.Max() = 0;
505 else if ( aNewSelection.Max() > aText.getLength() )
506 aNewSelection.Max() = aText.getLength();
507
508 long nEnd = std::max( aNewSelection.Min(), aNewSelection.Max() );
509 TextSelection aTextSel;
510 sal_uInt32 nPara = 0;
511 sal_Int32 nChar = 0;
512 long x = 0;
513 while ( x <= nEnd )
514 {
515 if ( x == aNewSelection.Min() )
516 aTextSel.GetStart() = TextPaM( nPara, nChar );
517 if ( x == aNewSelection.Max() )
518 aTextSel.GetEnd() = TextPaM( nPara, nChar );
519
520 if ( ( x < aText.getLength() ) && ( aText[ x ] == '\n' ) )
521 {
522 nPara++;
523 nChar = 0;
524 }
525 else
526 nChar++;
527 x++;
528 }
529 mpTextWindow->GetTextView()->SetSelection( aTextSel );
530}
531
532const Selection& ImpVclMEdit::GetSelection() const
533{
534 maSelection = Selection();
535 TextSelection aTextSel( mpTextWindow->GetTextView()->GetSelection() );
536 aTextSel.Justify();
537 // flatten selection => every line-break a character
538
539 ExtTextEngine* pExtTextEngine = mpTextWindow->GetTextEngine();
540 // paragraphs before
541 for ( sal_uInt32 n = 0; n < aTextSel.GetStart().GetPara(); ++n )
542 {
543 maSelection.Min() += pExtTextEngine->GetTextLen( n );
544 maSelection.Min()++;
545 }
546
547 // first paragraph with selection
548 maSelection.Max() = maSelection.Min();
549 maSelection.Min() += aTextSel.GetStart().GetIndex();
550
551 for ( sal_uInt32 n = aTextSel.GetStart().GetPara(); n < aTextSel.GetEnd().GetPara(); ++n )
552 {
553 maSelection.Max() += pExtTextEngine->GetTextLen( n );
554 maSelection.Max()++;
555 }
556
557 maSelection.Max() += aTextSel.GetEnd().GetIndex();
558
559 return maSelection;
560}
561
562Size ImpVclMEdit::CalcMinimumSize() const
563{
564 Size aSz( mpTextWindow->GetTextEngine()->CalcTextWidth(),
565 mpTextWindow->GetTextEngine()->GetTextHeight() );
566
567 if (mpHScrollBar->IsVisible())
568 aSz.AdjustHeight(mpHScrollBar->GetSizePixel().Height() );
569 if (mpVScrollBar->IsVisible())
570 aSz.AdjustWidth(mpVScrollBar->GetSizePixel().Width() );
571
572 return aSz;
573}
574
575Size ImpVclMEdit::CalcBlockSize( sal_uInt16 nColumns, sal_uInt16 nLines ) const
576{
577 static const sal_Unicode sampleChar = 'X';
578
579 Size aSz;
580 Size aCharSz;
581 aCharSz.setWidth( mpTextWindow->GetTextWidth( OUString(sampleChar) ) );
582 aCharSz.setHeight( mpTextWindow->GetTextHeight() );
583
584 if ( nLines )
585 aSz.setHeight( nLines*aCharSz.Height() );
586 else
587 aSz.setHeight( mpTextWindow->GetTextEngine()->GetTextHeight() );
588
589 if ( nColumns )
590 aSz.setWidth( nColumns*aCharSz.Width() );
591 else
592 aSz.setWidth( mpTextWindow->GetTextEngine()->CalcTextWidth() );
593
594 if (mpHScrollBar->IsVisible())
595 aSz.AdjustHeight(mpHScrollBar->GetSizePixel().Height() );
596 if (mpVScrollBar->IsVisible())
597 aSz.AdjustWidth(mpVScrollBar->GetSizePixel().Width() );
598
599 return aSz;
600}
601
602void ImpVclMEdit::GetMaxVisColumnsAndLines( sal_uInt16& rnCols, sal_uInt16& rnLines ) const
603{
604 static const sal_Unicode sampleChar = { 'x' };
605 Size aOutSz = mpTextWindow->GetOutputSizePixel();
606 Size aCharSz( mpTextWindow->GetTextWidth( OUString(sampleChar) ), mpTextWindow->GetTextHeight() );
607 rnCols = static_cast<sal_uInt16>(aOutSz.Width()/aCharSz.Width());
608 rnLines = static_cast<sal_uInt16>(aOutSz.Height()/aCharSz.Height());
609}
610
611void ImpVclMEdit::Enable( bool bEnable )
612{
613 mpTextWindow->Enable( bEnable );
614 if (mpHScrollBar->IsVisible())
615 mpHScrollBar->Enable( bEnable );
616 if (mpVScrollBar->IsVisible())
617 mpVScrollBar->Enable( bEnable );
618}
619
620bool ImpVclMEdit::HandleCommand( const CommandEvent& rCEvt )
621{
622 bool bDone = false;
623 CommandEventId nCommand = rCEvt.GetCommand();
624 if (nCommand == CommandEventId::Wheel ||
625 nCommand == CommandEventId::StartAutoScroll ||
626 nCommand == CommandEventId::AutoScroll ||
627 nCommand == CommandEventId::Gesture)
628 {
629 ScrollBar* pHScrollBar = mpHScrollBar->IsVisible() ? mpHScrollBar.get() : nullptr;
630 ScrollBar* pVScrollBar = mpVScrollBar->IsVisible() ? mpVScrollBar.get() : nullptr;
631 mpTextWindow->HandleScrollCommand(rCEvt, pHScrollBar, pVScrollBar);
632 bDone = true;
633 }
634 return bDone;
635}
636
637TextWindow::TextWindow(Edit* pParent)
638 : Window(pParent)
639 , mxParent(pParent)
640{
641 mbInMBDown = false;
642 mbFocusSelectionHide = false;
643 mbIgnoreTab = false;
644 mbActivePopup = false;
645 mbSelectOnTab = true;
646
647 SetPointer( PointerStyle::Text );
648
649 mpExtTextEngine.reset(new ExtTextEngine);
650 mpExtTextEngine->SetMaxTextLen(EDIT_NOLIMIT((sal_Int32) 0x7FFFFFFF));
651 if( pParent->GetStyle() & WB_BORDER )
652 mpExtTextEngine->SetLeftMargin( 2 );
653 mpExtTextEngine->SetLocale( GetSettings().GetLanguageTag().getLocale() );
654 mpExtTextView.reset(new TextView( mpExtTextEngine.get(), this ));
655 mpExtTextEngine->InsertView( mpExtTextView.get() );
656 mpExtTextEngine->EnableUndo( true );
657 mpExtTextView->ShowCursor();
658
659 Color aBackgroundColor = GetSettings().GetStyleSettings().GetWorkspaceColor();
660 SetBackground( aBackgroundColor );
661 pParent->SetBackground( aBackgroundColor );
662}
663
664TextWindow::~TextWindow()
665{
666 disposeOnce();
667}
668
669void TextWindow::dispose()
670{
671 mxParent.clear();
672 mpExtTextView.reset();
673 mpExtTextEngine.reset();
674 Window::dispose();
675}
676
677void TextWindow::MouseMove( const MouseEvent& rMEvt )
678{
679 mpExtTextView->MouseMove( rMEvt );
680 Window::MouseMove( rMEvt );
681}
682
683void TextWindow::MouseButtonDown( const MouseEvent& rMEvt )
684{
685 mbInMBDown = true; // so that GetFocus does not select everything
686 mpExtTextView->MouseButtonDown( rMEvt );
687 GrabFocus();
688 mbInMBDown = false;
689}
690
691void TextWindow::MouseButtonUp( const MouseEvent& rMEvt )
692{
693 mpExtTextView->MouseButtonUp( rMEvt );
694}
695
696void TextWindow::KeyInput( const KeyEvent& rKEvent )
697{
698 bool bDone = false;
699 sal_uInt16 nCode = rKEvent.GetKeyCode().GetCode();
700 if ( nCode == css::awt::Key::SELECT_ALL ||
701 ( (nCode == KEY_A) && rKEvent.GetKeyCode().IsMod1() && !rKEvent.GetKeyCode().IsMod2() )
702 )
703 {
704 mpExtTextView->SetSelection( TextSelection( TextPaM( 0, 0 ), TextPaM( TEXT_PARA_ALL((sal_uInt32) 0xFFFFFFFF), TEXT_INDEX_ALL((sal_Int32) 0x7FFFFFFF) ) ) );
705 bDone = true;
706 }
707 else if ( (nCode == KEY_S) && rKEvent.GetKeyCode().IsShift() && rKEvent.GetKeyCode().IsMod1() )
708 {
709 if ( vcl::GetGetSpecialCharsFunction() )
710 {
711 // to maintain the selection
712 mbActivePopup = true;
713 OUString aChars = vcl::GetGetSpecialCharsFunction()(GetFrameWeld(), GetFont());
714 if (!aChars.isEmpty())
715 {
716 mpExtTextView->InsertText( aChars );
717 mpExtTextView->GetTextEngine()->SetModified( true );
718 }
719 mbActivePopup = false;
720 bDone = true;
721 }
722 }
723 else if ( nCode == KEY_TAB )
724 {
725 if ( !mbIgnoreTab || rKEvent.GetKeyCode().IsMod1() )
726 bDone = mpExtTextView->KeyInput( rKEvent );
727 }
728 else
729 {
730 bDone = mpExtTextView->KeyInput( rKEvent );
731 }
732
733 if ( !bDone )
734 Window::KeyInput( rKEvent );
735}
736
737void TextWindow::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect)
738{
739 mpExtTextView->Paint(rRenderContext, rRect);
740}
741
742void TextWindow::Resize()
743{
744}
745
746void TextWindow::Command( const CommandEvent& rCEvt )
747{
748 if ( rCEvt.GetCommand() == CommandEventId::ContextMenu )
749 {
750 VclPtr<PopupMenu> pPopup = mxParent->CreatePopupMenu();
751 bool bEnableCut = true;
752 bool bEnableCopy = true;
753 bool bEnableDelete = true;
754 bool bEnablePaste = true;
755 bool bEnableSpecialChar = true;
756 bool bEnableUndo = true;
757
758 if ( !mpExtTextView->HasSelection() )
759 {
760 bEnableCut = false;
761 bEnableCopy = false;
762 bEnableDelete = false;
763 }
764 if ( mpExtTextView->IsReadOnly() )
765 {
766 bEnableCut = false;
767 bEnablePaste = false;
768 bEnableDelete = false;
769 bEnableSpecialChar = false;
770 }
771 if ( !mpExtTextView->GetTextEngine()->HasUndoManager() || !mpExtTextView->GetTextEngine()->GetUndoManager().GetUndoActionCount() )
772 {
773 bEnableUndo = false;
774 }
775 pPopup->EnableItem(pPopup->GetItemId("cut"), bEnableCut);
776 pPopup->EnableItem(pPopup->GetItemId("copy"), bEnableCopy);
777 pPopup->EnableItem(pPopup->GetItemId("delete"), bEnableDelete);
778 pPopup->EnableItem(pPopup->GetItemId("paste"), bEnablePaste);
779 pPopup->EnableItem(pPopup->GetItemId("specialchar"), bEnableSpecialChar);
780 pPopup->EnableItem(pPopup->GetItemId("undo"), bEnableUndo);
781 pPopup->ShowItem(pPopup->GetItemId("specialchar"), !vcl::GetGetSpecialCharsFunction());
782
783 mbActivePopup = true;
784 Point aPos = rCEvt.GetMousePosPixel();
785 if ( !rCEvt.IsMouseEvent() )
786 {
787 // Sometime do show Menu centered in the selection !!!
788 Size aSize = GetOutputSizePixel();
789 aPos = Point( aSize.Width()/2, aSize.Height()/2 );
790 }
791 sal_uInt16 n = pPopup->Execute( this, aPos );
792 OString sCommand = pPopup->GetItemIdent(n);
793 if (sCommand == "undo")
794 {
795 mpExtTextView->Undo();
796 mpExtTextEngine->SetModified( true );
797 mpExtTextEngine->Broadcast( TextHint( SfxHintId::TextModified ) );
798 }
799 else if (sCommand == "cut")
800 {
801 mpExtTextView->Cut();
802 mpExtTextEngine->SetModified( true );
803 mpExtTextEngine->Broadcast( TextHint( SfxHintId::TextModified ) );
804 }
805 else if (sCommand == "copy")
806 {
807 mpExtTextView->Copy();
808 }
809 else if (sCommand == "paste")
810 {
811 mpExtTextView->Paste();
812 mpExtTextEngine->SetModified( true );
813 mpExtTextEngine->Broadcast( TextHint( SfxHintId::TextModified ) );
814 }
815 else if (sCommand == "delete")
816 {
817 mpExtTextView->DeleteSelected();
818 mpExtTextEngine->SetModified( true );
819 mpExtTextEngine->Broadcast( TextHint( SfxHintId::TextModified ) );
820 }
821 else if (sCommand == "selectall")
822 {
823 mpExtTextView->SetSelection( TextSelection( TextPaM( 0, 0 ), TextPaM( TEXT_PARA_ALL((sal_uInt32) 0xFFFFFFFF), TEXT_INDEX_ALL((sal_Int32) 0x7FFFFFFF) ) ) );
824 }
825 else if (sCommand == "specialchar")
826 {
827 OUString aChars = vcl::GetGetSpecialCharsFunction()(GetFrameWeld(), GetFont());
828 if (!aChars.isEmpty())
829 {
830 mpExtTextView->InsertText( aChars );
831 mpExtTextEngine->SetModified( true );
832 mpExtTextEngine->Broadcast( TextHint( SfxHintId::TextModified ) );
833 }
834 }
835 pPopup.clear();
836 mbActivePopup = false;
837 }
838 else
839 {
840 mpExtTextView->Command( rCEvt );
841 }
842 Window::Command( rCEvt );
843}
844
845void TextWindow::GetFocus()
846{
847 Window::GetFocus();
848 if ( mbActivePopup )
849 return;
850
851 bool bGotoCursor = !mpExtTextView->IsReadOnly();
852 if ( mbFocusSelectionHide && IsReallyVisible()
853 && ( mbSelectOnTab &&
854 (!mbInMBDown || ( GetSettings().GetStyleSettings().GetSelectionOptions() & SelectionOptions::Focus ) )) )
855 {
856 // select everything, but do not scroll
857 bool bAutoScroll = mpExtTextView->IsAutoScroll();
858 mpExtTextView->SetAutoScroll( false );
859 mpExtTextView->SetSelection( TextSelection( TextPaM( 0, 0 ), TextPaM( TEXT_PARA_ALL((sal_uInt32) 0xFFFFFFFF), TEXT_INDEX_ALL((sal_Int32) 0x7FFFFFFF) ) ) );
860 mpExtTextView->SetAutoScroll( bAutoScroll );
861 bGotoCursor = false;
862 }
863 mpExtTextView->SetPaintSelection( true );
864 mpExtTextView->ShowCursor( bGotoCursor );
865}
866
867void TextWindow::LoseFocus()
868{
869 Window::LoseFocus();
870
871 if ( mbFocusSelectionHide && !mbActivePopup && mpExtTextView )
872 mpExtTextView->SetPaintSelection( false );
873}
874
875VclMultiLineEdit::VclMultiLineEdit( vcl::Window* pParent, WinBits nWinStyle )
876 : Edit( pParent, nWinStyle )
877{
878 SetType( WindowType::MULTILINEEDIT );
879 pImpVclMEdit.reset(new ImpVclMEdit( this, nWinStyle ));
880 ImplInitSettings( true );
881
882 SetCompoundControl( true );
883 SetStyle( ImplInitStyle( nWinStyle ) );
884}
885
886VclMultiLineEdit::~VclMultiLineEdit()
887{
888 disposeOnce();
889}
890
891void VclMultiLineEdit::dispose()
892{
893 pImpVclMEdit.reset();
1
Calling 'unique_ptr::reset'
→
894 Edit::dispose();
895}
896
897WinBits VclMultiLineEdit::ImplInitStyle( WinBits nStyle )
898{
899 if ( !(nStyle & WB_NOTABSTOP) )
900 nStyle |= WB_TABSTOP;
901
902 if ( !(nStyle & WB_NOGROUP) )
903 nStyle |= WB_GROUP;
904
905 if ( !(nStyle & WB_IGNORETAB ))
906 nStyle |= WB_NODIALOGCONTROL;
907
908 return nStyle;
909}
910
911void VclMultiLineEdit::ApplySettings(vcl::RenderContext& rRenderContext)
912{
913 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
914
915 // The Font has to be adjusted, as the TextEngine does not take care of
916 // TextColor/Background
917
918 Color aTextColor = rStyleSettings.GetFieldTextColor();
919 if (IsControlForeground())
920 aTextColor = GetControlForeground();
921
922 if (!IsEnabled())
923 aTextColor = rStyleSettings.GetDisableColor();
924
925 vcl::Font aFont = rStyleSettings.GetFieldFont();
926 aFont.SetTransparent(IsPaintTransparent());
927 ApplyControlFont(rRenderContext, aFont);
928
929 vcl::Font theFont = rRenderContext.GetFont();
930 theFont.SetColor(aTextColor);
931 if (IsPaintTransparent())
932 theFont.SetFillColor(COL_TRANSPARENT);
933 else
934 theFont.SetFillColor(IsControlBackground() ? GetControlBackground() : rStyleSettings.GetFieldColor());
935
936 pImpVclMEdit->GetTextWindow()->SetFont(theFont);
937 // FIXME: next call causes infinite invalidation loop, rethink how to properly fix this situation
938 // pImpVclMEdit->GetTextWindow()->GetTextEngine()->SetFont(theFont);
939 pImpVclMEdit->GetTextWindow()->SetTextColor(aTextColor);
940
941 if (IsPaintTransparent())
942 {
943 pImpVclMEdit->GetTextWindow()->SetPaintTransparent(true);
944 pImpVclMEdit->GetTextWindow()->SetBackground();
945 pImpVclMEdit->GetTextWindow()->SetControlBackground();
946 rRenderContext.SetBackground();
947 SetControlBackground();
948 }
949 else
950 {
951 if (IsControlBackground())
952 pImpVclMEdit->GetTextWindow()->SetBackground(GetControlBackground());
953 else
954 pImpVclMEdit->GetTextWindow()->SetBackground(rStyleSettings.GetFieldColor());
955 // also adjust for VclMultiLineEdit as the TextComponent might hide Scrollbars
956 rRenderContext.SetBackground(pImpVclMEdit->GetTextWindow()->GetBackground());
957 }
958}
959
960void VclMultiLineEdit::ImplInitSettings(bool bBackground)
961{
962 const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
963
964 // The Font has to be adjusted, as the TextEngine does not take care of
965 // TextColor/Background
966
967 Color aTextColor = rStyleSettings.GetFieldTextColor();
968 if (IsControlForeground())
969 aTextColor = GetControlForeground();
970 if (!IsEnabled())
971 aTextColor = rStyleSettings.GetDisableColor();
972
973 vcl::Font aFont = rStyleSettings.GetFieldFont();
974 aFont.SetTransparent(IsPaintTransparent());
975 ApplyControlFont(*this, aFont);
976
977 vcl::Font TheFont = GetFont();
978 TheFont.SetColor(aTextColor);
979 if (IsPaintTransparent())
980 TheFont.SetFillColor(COL_TRANSPARENT);
981 else
982 TheFont.SetFillColor(IsControlBackground() ? GetControlBackground() : rStyleSettings.GetFieldColor());
983 pImpVclMEdit->GetTextWindow()->SetFont(TheFont);
984 pImpVclMEdit->GetTextWindow()->GetTextEngine()->SetFont(TheFont);
985 pImpVclMEdit->GetTextWindow()->SetTextColor(aTextColor);
986
987 if (!bBackground)
988 return;
989
990 if (IsPaintTransparent())
991 {
992 pImpVclMEdit->GetTextWindow()->SetPaintTransparent(true);
993 pImpVclMEdit->GetTextWindow()->SetBackground();
994 pImpVclMEdit->GetTextWindow()->SetControlBackground();
995 SetBackground();
996 SetControlBackground();
997 }
998 else
999 {
1000 if (IsControlBackground())
1001 pImpVclMEdit->GetTextWindow()->SetBackground(GetControlBackground());
1002 else
1003 pImpVclMEdit->GetTextWindow()->SetBackground(rStyleSettings.GetFieldColor());
1004 // also adjust for VclMultiLineEdit as the TextComponent might hide Scrollbars
1005 SetBackground(pImpVclMEdit->GetTextWindow()->GetBackground());
1006 }
1007}
1008
1009void VclMultiLineEdit::Modify()
1010{
1011 aModifyHdlLink.Call( *this );
1012
1013 CallEventListeners( VclEventId::EditModify );
1014}
1015
1016void VclMultiLineEdit::SelectionChanged()
1017{
1018 CallEventListeners(VclEventId::EditSelectionChanged);
1019}
1020
1021void VclMultiLineEdit::CaretChanged()
1022{
1023 CallEventListeners(VclEventId::EditCaretChanged);
1024}
1025
1026void VclMultiLineEdit::SetModifyFlag()
1027{
1028 pImpVclMEdit->SetModified( true );
1029}
1030
1031void VclMultiLineEdit::SetReadOnly( bool bReadOnly )
1032{
1033 pImpVclMEdit->SetReadOnly( bReadOnly );
1034 Edit::SetReadOnly( bReadOnly );
1035
1036 // #94921# ReadOnly can be overwritten in InitFromStyle() when WB not set.
1037 WinBits nStyle = GetStyle();
1038 if ( bReadOnly )
1039 nStyle |= WB_READONLY;
1040 else
1041 nStyle &= ~WB_READONLY;
1042 SetStyle( nStyle );
1043}
1044
1045bool VclMultiLineEdit::IsReadOnly() const
1046{
1047 if (!pImpVclMEdit) // might be called from within the dtor, when pImpVclMEdit == NULL is a valid state
1048 return true;
1049
1050 return pImpVclMEdit->IsReadOnly();
1051}
1052
1053void VclMultiLineEdit::SetMaxTextLen(sal_Int32 nMaxLen)
1054{
1055 pImpVclMEdit->SetMaxTextLen(nMaxLen);
1056}
1057
1058void VclMultiLineEdit::SetMaxTextWidth(long nMaxWidth)
1059{
1060 pImpVclMEdit->SetMaxTextWidth(nMaxWidth );
1061}
1062
1063sal_Int32 VclMultiLineEdit::GetMaxTextLen() const
1064{
1065 return pImpVclMEdit->GetMaxTextLen();
1066}
1067
1068void VclMultiLineEdit::ReplaceSelected( const OUString& rStr )
1069{
1070 pImpVclMEdit->InsertText( rStr );
1071}
1072
1073void VclMultiLineEdit::DeleteSelected()
1074{
1075 pImpVclMEdit->InsertText( OUString() );
1076}
1077
1078OUString VclMultiLineEdit::GetSelected() const
1079{
1080 return pImpVclMEdit->GetSelected();
1081}
1082
1083OUString VclMultiLineEdit::GetSelected( LineEnd aSeparator ) const
1084{
1085 return pImpVclMEdit->GetSelected( aSeparator );
1086}
1087
1088void VclMultiLineEdit::Cut()
1089{
1090 pImpVclMEdit->Cut();
1091}
1092
1093void VclMultiLineEdit::Copy()
1094{
1095 pImpVclMEdit->Copy();
1096}
1097
1098void VclMultiLineEdit::Paste()
1099{
1100 pImpVclMEdit->Paste();
1101}
1102
1103void VclMultiLineEdit::SetText( const OUString& rStr )
1104{
1105 pImpVclMEdit->SetText( rStr );
1106}
1107
1108OUString VclMultiLineEdit::GetText() const
1109{
1110 return pImpVclMEdit ? pImpVclMEdit->GetText() : OUString();
1111}
1112
1113OUString VclMultiLineEdit::GetText( LineEnd aSeparator ) const
1114{
1115 return pImpVclMEdit ? pImpVclMEdit->GetText( aSeparator ) : OUString();
1116}
1117
1118OUString VclMultiLineEdit::GetTextLines( LineEnd aSeparator ) const
1119{
1120 return pImpVclMEdit ? pImpVclMEdit->GetTextLines( aSeparator ) : OUString();
1121}
1122
1123void VclMultiLineEdit::Resize()
1124{
1125 pImpVclMEdit->Resize();
1126}
1127
1128void VclMultiLineEdit::GetFocus()
1129{
1130 if ( !pImpVclMEdit ) // might be called from within the dtor, when pImpVclMEdit == NULL is a valid state
1131 return;
1132
1133 pImpVclMEdit->GetFocus();
1134}
1135
1136void VclMultiLineEdit::SetSelection( const Selection& rSelection )
1137{
1138 pImpVclMEdit->SetSelection( rSelection );
1139}
1140
1141const Selection& VclMultiLineEdit::GetSelection() const
1142{
1143 return pImpVclMEdit->GetSelection();
1144}
1145
1146Size VclMultiLineEdit::CalcMinimumSize() const
1147{
1148 Size aSz = pImpVclMEdit->CalcMinimumSize();
1149
1150 sal_Int32 nLeft, nTop, nRight, nBottom;
1151 static_cast<vcl::Window*>(const_cast<VclMultiLineEdit *>(this))->GetBorder( nLeft, nTop, nRight, nBottom );
1152 aSz.AdjustWidth(nLeft+nRight );
1153 aSz.AdjustHeight(nTop+nBottom );
1154
1155 return aSz;
1156}
1157
1158Size VclMultiLineEdit::CalcAdjustedSize( const Size& rPrefSize ) const
1159{
1160 Size aSz = rPrefSize;
1161 sal_Int32 nLeft, nTop, nRight, nBottom;
1162 static_cast<vcl::Window*>(const_cast<VclMultiLineEdit *>(this))->GetBorder( nLeft, nTop, nRight, nBottom );
1163
1164 // center vertically for whole lines
1165
1166 long nHeight = aSz.Height() - nTop - nBottom;
1167 long nLineHeight = pImpVclMEdit->CalcBlockSize( 1, 1 ).Height();
1168 long nLines = nHeight / nLineHeight;
1169 if ( nLines < 1 )
1170 nLines = 1;
1171
1172 aSz.setHeight( nLines * nLineHeight );
1173 aSz.AdjustHeight(nTop+nBottom );
1174
1175 return aSz;
1176}
1177
1178Size VclMultiLineEdit::CalcBlockSize( sal_uInt16 nColumns, sal_uInt16 nLines ) const
1179{
1180 Size aSz = pImpVclMEdit->CalcBlockSize( nColumns, nLines );
1181
1182 sal_Int32 nLeft, nTop, nRight, nBottom;
1183 static_cast<vcl::Window*>(const_cast<VclMultiLineEdit *>(this))->GetBorder( nLeft, nTop, nRight, nBottom );
1184 aSz.AdjustWidth(nLeft+nRight );
1185 aSz.AdjustHeight(nTop+nBottom );
1186 return aSz;
1187}
1188
1189void VclMultiLineEdit::GetMaxVisColumnsAndLines( sal_uInt16& rnCols, sal_uInt16& rnLines ) const
1190{
1191 pImpVclMEdit->GetMaxVisColumnsAndLines( rnCols, rnLines );
1192}
1193
1194void VclMultiLineEdit::StateChanged( StateChangedType nType )
1195{
1196 if( nType == StateChangedType::Enable )
1197 {
1198 pImpVclMEdit->Enable( IsEnabled() );
1199 ImplInitSettings( false );
1200 }
1201 else if( nType == StateChangedType::ReadOnly )
1202 {
1203 pImpVclMEdit->SetReadOnly( IsReadOnly() );
1204 }
1205 else if ( nType == StateChangedType::Zoom )
1206 {
1207 pImpVclMEdit->GetTextWindow()->SetZoom( GetZoom() );
1208 ImplInitSettings( false );
1209 Resize();
1210 }
1211 else if ( nType == StateChangedType::ControlFont )
1212 {
1213 ImplInitSettings( false );
1214 Resize();
1215 Invalidate();
1216 }
1217 else if ( nType == StateChangedType::ControlForeground )
1218 {
1219 ImplInitSettings( false );
1220 Invalidate();
1221 }
1222 else if ( nType == StateChangedType::ControlBackground )
1223 {
1224 ImplInitSettings( true );
1225 Invalidate();
1226 }
1227 else if ( nType == StateChangedType::Style )
1228 {
1229 pImpVclMEdit->InitFromStyle( GetStyle() );
1230 SetStyle( ImplInitStyle( GetStyle() ) );
1231 }
1232 else if ( nType == StateChangedType::InitShow )
1233 {
1234 if( IsPaintTransparent() )
1235 {
1236 pImpVclMEdit->GetTextWindow()->SetPaintTransparent( true );
1237 pImpVclMEdit->GetTextWindow()->SetBackground();
1238 pImpVclMEdit->GetTextWindow()->SetControlBackground();
1239 SetBackground();
1240 SetControlBackground();
1241 }
1242 }
1243
1244 Control::StateChanged( nType );
1245}
1246
1247void VclMultiLineEdit::DataChanged( const DataChangedEvent& rDCEvt )
1248{
1249 if ( (rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
1250 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) )
1251 {
1252 ImplInitSettings( true );
1253 Resize();
1254 Invalidate();
1255 }
1256 else
1257 Control::DataChanged( rDCEvt );
1258}
1259
1260void VclMultiLineEdit::Draw( OutputDevice* pDev, const Point& rPos, DrawFlags nFlags )
1261{
1262 ImplInitSettings(true);
1263
1264 Point aPos = pDev->LogicToPixel( rPos );
1265 Size aSize = GetSizePixel();
1266
1267 vcl::Font aFont = pImpVclMEdit->GetTextWindow()->GetDrawPixelFont(pDev);
1268 aFont.SetTransparent( true );
1269 OutDevType eOutDevType = pDev->GetOutDevType();
1270
1271 pDev->Push();
1272 pDev->SetMapMode();
1273 pDev->SetFont( aFont );
1274 pDev->SetTextFillColor();
1275
1276 // Border/Background
1277 pDev->SetLineColor();
1278 pDev->SetFillColor();
1279 bool bBorder = (GetStyle() & WB_BORDER);
1280 bool bBackground = IsControlBackground();
1281 if ( bBorder || bBackground )
1282 {
1283 tools::Rectangle aRect( aPos, aSize );
1284 if ( bBorder )
1285 {
1286 DecorationView aDecoView( pDev );
1287 aRect = aDecoView.DrawFrame( aRect, DrawFrameStyle::DoubleIn );
1288 }
1289 if ( bBackground )
1290 {
1291 pDev->SetFillColor( GetControlBackground() );
1292 pDev->DrawRect( aRect );
1293 }
1294 }
1295
1296 // contents
1297 if ( ( nFlags & DrawFlags::Mono ) || ( eOutDevType == OUTDEV_PRINTER ) )
1298 pDev->SetTextColor( COL_BLACK );
1299 else
1300 {
1301 if ( !IsEnabled() )
1302 {
1303 const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
1304 pDev->SetTextColor( rStyleSettings.GetDisableColor() );
1305 }
1306 else
1307 {
1308 pDev->SetTextColor( GetTextColor() );
1309 }
1310 }
1311
1312 OUString aText = GetText();
1313 Size aTextSz( pDev->GetTextWidth( aText ), pDev->GetTextHeight() );
1314 sal_uLong nLines = static_cast<sal_uLong>(aSize.Height() / aTextSz.Height());
1315 if ( !nLines )
1316 nLines = 1;
1317 aTextSz.setHeight( nLines*aTextSz.Height() );
1318 long nOnePixel = GetDrawPixel( pDev, 1 );
1319 long nOffX = 3*nOnePixel;
1320 long nOffY = 2*nOnePixel;
1321
1322 // Clipping?
1323 if ( ( nOffY < 0 ) || ( (nOffY+aTextSz.Height()) > aSize.Height() ) || ( (nOffX+aTextSz.Width()) > aSize.Width() ) )
1324 {
1325 tools::Rectangle aClip( aPos, aSize );
1326 if ( aTextSz.Height() > aSize.Height() )
1327 aClip.AdjustBottom(aTextSz.Height() - aSize.Height() + 1 ); // so that HP-printer does not 'optimize-away'
1328 pDev->IntersectClipRegion( aClip );
1329 }
1330
1331 ExtTextEngine aTE;
1332 aTE.SetText( GetText() );
1333 aTE.SetMaxTextWidth( aSize.Width() );
1334 aTE.SetFont( aFont );
1335 aTE.SetTextAlign( pImpVclMEdit->GetTextWindow()->GetTextEngine()->GetTextAlign() );
1336 aTE.Draw( pDev, Point( aPos.X() + nOffX, aPos.Y() + nOffY ) );
1337
1338 pDev->Pop();
1339}
1340
1341bool VclMultiLineEdit::EventNotify( NotifyEvent& rNEvt )
1342{
1343 bool bDone = false;
1344 if( rNEvt.GetType() == MouseNotifyEvent::COMMAND )
1345 {
1346 bDone = pImpVclMEdit->HandleCommand( *rNEvt.GetCommandEvent() );
1347 }
1348 return bDone || Edit::EventNotify( rNEvt );
1349}
1350
1351bool VclMultiLineEdit::PreNotify( NotifyEvent& rNEvt )
1352{
1353 bool bDone = false;
1354
1355 if( ( rNEvt.GetType() == MouseNotifyEvent::KEYINPUT ) && ( !GetTextView()->IsCursorEnabled() ) )
1356 {
1357 const KeyEvent& rKEvent = *rNEvt.GetKeyEvent();
1358 if ( !rKEvent.GetKeyCode().IsShift() && ( rKEvent.GetKeyCode().GetGroup() == KEYGROUP_CURSOR ) )
1359 {
1360 bDone = true;
1361 TextSelection aSel = pImpVclMEdit->GetTextWindow()->GetTextView()->GetSelection();
1362 if ( aSel.HasRange() )
1363 {
1364 aSel.GetStart() = aSel.GetEnd();
1365 pImpVclMEdit->GetTextWindow()->GetTextView()->SetSelection( aSel );
1366 }
1367 else
1368 {
1369 switch ( rKEvent.GetKeyCode().GetCode() )
1370 {
1371 case KEY_UP:
1372 {
1373 if ( pImpVclMEdit->GetVScrollBar().IsVisible() )
1374 pImpVclMEdit->GetVScrollBar().DoScrollAction( ScrollType::LineUp );
1375 }
1376 break;
1377 case KEY_DOWN:
1378 {
1379 if ( pImpVclMEdit->GetVScrollBar().IsVisible() )
1380 pImpVclMEdit->GetVScrollBar().DoScrollAction( ScrollType::LineDown );
1381 }
1382 break;
1383 case KEY_PAGEUP :
1384 {
1385 if ( pImpVclMEdit->GetVScrollBar().IsVisible() )
1386 pImpVclMEdit->GetVScrollBar().DoScrollAction( ScrollType::PageUp );
1387 }
1388 break;
1389 case KEY_PAGEDOWN:
1390 {
1391 if ( pImpVclMEdit->GetVScrollBar().IsVisible() )
1392 pImpVclMEdit->GetVScrollBar().DoScrollAction( ScrollType::PageDown );
1393 }
1394 break;
1395 case KEY_LEFT:
1396 {
1397 if ( pImpVclMEdit->GetHScrollBar().IsVisible() )
1398 pImpVclMEdit->GetHScrollBar().DoScrollAction( ScrollType::LineUp );
1399 }
1400 break;
1401 case KEY_RIGHT:
1402 {
1403 if ( pImpVclMEdit->GetHScrollBar().IsVisible() )
1404 pImpVclMEdit->GetHScrollBar().DoScrollAction( ScrollType::LineDown );
1405 }
1406 break;
1407 case KEY_HOME:
1408 {
1409 if ( rKEvent.GetKeyCode().IsMod1() )
1410 pImpVclMEdit->GetTextWindow()->GetTextView()->
1411 SetSelection( TextSelection( TextPaM( 0, 0 ) ) );
1412 }
1413 break;
1414 case KEY_END:
1415 {
1416 if ( rKEvent.GetKeyCode().IsMod1() )
1417 pImpVclMEdit->GetTextWindow()->GetTextView()->
1418 SetSelection( TextSelection( TextPaM( TEXT_PARA_ALL((sal_uInt32) 0xFFFFFFFF), TEXT_INDEX_ALL((sal_Int32) 0x7FFFFFFF) ) ) );
1419 }
1420 break;
1421 default:
1422 {
1423 bDone = false;
1424 }
1425 }
1426 }
1427 }
1428 }
1429
1430 return bDone || Edit::PreNotify( rNEvt );
1431}
1432
1433// Internals for derived classes, e.g. TextComponent
1434
1435ExtTextEngine* VclMultiLineEdit::GetTextEngine() const
1436{
1437 return pImpVclMEdit->GetTextWindow()->GetTextEngine();
1438}
1439
1440TextView* VclMultiLineEdit::GetTextView() const
1441{
1442 return pImpVclMEdit->GetTextWindow()->GetTextView();
1443}
1444
1445ScrollBar& VclMultiLineEdit::GetVScrollBar() const
1446{
1447 return pImpVclMEdit->GetVScrollBar();
1448}
1449
1450void VclMultiLineEdit::EnableFocusSelectionHide( bool bHide )
1451{
1452 pImpVclMEdit->GetTextWindow()->SetAutoFocusHide( bHide );
1453}
1454
1455void VclMultiLineEdit::DisableSelectionOnFocus()
1456{
1457 pImpVclMEdit->GetTextWindow()->DisableSelectionOnFocus();
1458}
1459
1460void VclMultiLineEdit::EnableCursor( bool bEnable )
1461{
1462 GetTextView()->EnableCursor( bEnable );
1463}
1464
1465bool VclMultiLineEdit::CanUp() const
1466{
1467 TextView* pTextView = GetTextView();
1468 const TextSelection& rTextSelection = pTextView->GetSelection();
1469 TextPaM aPaM(rTextSelection.GetEnd());
1470 return aPaM != pTextView->CursorUp(aPaM);
1471}
1472
1473bool VclMultiLineEdit::CanDown() const
1474{
1475 TextView* pTextView = GetTextView();
1476 const TextSelection& rTextSelection = pTextView->GetSelection();
1477 TextPaM aPaM(rTextSelection.GetEnd());
1478 return aPaM != pTextView->CursorDown(aPaM);
1479}
1480
1481TextWindow* VclMultiLineEdit::GetTextWindow()
1482{
1483 return pImpVclMEdit->GetTextWindow();
1484}
1485
1486FactoryFunction VclMultiLineEdit::GetUITestFactory() const
1487{
1488 return MultiLineEditUIObject::create;
1489}
1490
1491bool VclMultiLineEdit::set_property(const OString &rKey, const OUString &rValue)
1492{
1493 if (rKey == "cursor-visible")
1494 EnableCursor(toBool(rValue));
1495 else if (rKey == "accepts-tab")
1496 pImpVclMEdit->GetTextWindow()->SetIgnoreTab(!toBool(rValue));
1497 else
1498 return Edit::set_property(rKey, rValue);
1499 return true;
1500}
1501
1502void VclMultiLineEdit::DumpAsPropertyTree(tools::JsonWriter& rJsonWriter)
1503{
1504 Edit::DumpAsPropertyTree(rJsonWriter);
1505
1506 rJsonWriter.put("cursor", pImpVclMEdit->GetTextWindow()->GetTextView()->IsCursorEnabled());
1507}
1508
1509/* 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;
6
←
Calling '~ImpVclMEdit'
→
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)
3
←
Assuming '__old_p' is non-null
→
4
←
Taking true branch
→
182 _M_deleter()(__old_p);
5
←
Calling 'default_delete::operator()'
→
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));
2
←
Calling '__uniq_ptr_impl::reset'
→
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)...)); }
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();
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);
8
←
Calling copy constructor for 'Reference<VclMultiLineEdit>'
→
11
←
Returning from copy constructor for 'Reference<VclMultiLineEdit>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
12
←
Calling 'Reference::clear'
→
19
←
Returning; memory was released
→
205 if (aTmp.get()) {
20
←
Calling 'Reference::get'
→
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
9
←
Assuming field 'm_pBody' is non-null
→
10
←
Taking true branch
→
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
12.1
Field 'm_pBody' is non-null
12.1
Field 'm_pBody' is non-null
12.1
Field 'm_pBody' is non-null
12.1
Field 'm_pBody' is non-null
12.1
Field 'm_pBody' is non-null
)
13
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
14
←
Calling 'VclReferenceBase::release'
→
18
←
Returning; memory was released
→
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
21
←
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)
15
←
Assuming the condition is true
→
16
←
Taking true branch
→
40 delete this;
17
←
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