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 annotationwindow.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -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 SD_DLLIMPLEMENTATION -D SDUI_DLL_NAME="libsduilo.so" -D SYSTEM_LIBXML -D ENABLE_SDREMOTE -D ENABLE_SDREMOTE_BLUETOOTH -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/external/bluez_bluetooth/inc -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/sd/inc -I /home/maarten/src/libreoffice/core/sd/source/ui/inc -I /home/maarten/src/libreoffice/core/sd/source/ui/slidesorter/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sd/sdi -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/oox/generated -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /usr/include/glib-2.0 -I /usr/lib64/glib-2.0/include -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/sd/source/ui/annotations/annotationwindow.cxx

/home/maarten/src/libreoffice/core/sd/source/ui/annotations/annotationwindow.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 <editeng/eeitem.hxx>
21#include <editeng/udlnitem.hxx>
22#include <editeng/langitem.hxx>
23#include <editeng/editview.hxx>
24#include <editeng/editstat.hxx>
25#include <editeng/outliner.hxx>
26#include <editeng/editeng.hxx>
27#include <editeng/outlobj.hxx>
28#include <editeng/postitem.hxx>
29#include <editeng/wghtitem.hxx>
30#include <editeng/crossedoutitem.hxx>
31#include <svx/svxids.hrc>
32#include <unotools/useroptions.hxx>
33
34#include <sfx2/viewfrm.hxx>
35#include <sfx2/bindings.hxx>
36#include <sfx2/dispatch.hxx>
37
38#include <vcl/commandevent.hxx>
39#include <vcl/vclenum.hxx>
40#include <vcl/scrbar.hxx>
41#include <vcl/svapp.hxx>
42#include <vcl/gradient.hxx>
43#include <vcl/settings.hxx>
44#include <vcl/ptrstyle.hxx>
45
46#include <strings.hrc>
47#include "annotationwindow.hxx"
48#include "annotationmanagerimpl.hxx"
49
50#include <com/sun/star/office/XAnnotation.hpp>
51#include <DrawDocShell.hxx>
52#include <ViewShell.hxx>
53#include <drawdoc.hxx>
54#include <textapi.hxx>
55#include <sdresid.hxx>
56
57#include <memory>
58
59using namespace ::sd;
60using namespace ::com::sun::star;
61using namespace ::com::sun::star::uno;
62using namespace ::com::sun::star::office;
63using namespace ::com::sun::star::text;
64
65#define METABUTTON_WIDTH16 16
66#define METABUTTON_HEIGHT18 18
67#define METABUTTON_AREA_WIDTH30 30
68#define POSTIT_META_HEIGHTsal_Int32(30) sal_Int32(30)
69
70namespace sd {
71
72static Color ColorFromAlphaColor(sal_uInt8 aTransparency, Color const &aFront, Color const &aBack )
73{
74 return Color(static_cast<sal_uInt8>(aFront.GetRed() * aTransparency/double(255) + aBack.GetRed() * (1-aTransparency/double(255))),
75 static_cast<sal_uInt8>(aFront.GetGreen() * aTransparency/double(255) + aBack.GetGreen() * (1-aTransparency/double(255))),
76 static_cast<sal_uInt8>(aFront.GetBlue() * aTransparency/double(255) + aBack.GetBlue() * (1-aTransparency/double(255))));
77}
78
79/************ AnnotationTextWindow **********************************/
80
81AnnotationTextWindow::AnnotationTextWindow( AnnotationWindow* pParent, WinBits nBits )
82: Control(pParent, nBits)
83, mpOutlinerView(nullptr)
84, mpAnnotationWindow( pParent )
85{
86}
87
88AnnotationTextWindow::~AnnotationTextWindow()
89{
90 disposeOnce();
91}
92
93void AnnotationTextWindow::dispose()
94{
95 mpAnnotationWindow.clear();
96 Control::dispose();
97}
98
99void AnnotationTextWindow::Paint( vcl::RenderContext& /*rRenderContext*/, const ::tools::Rectangle& rRect)
100{
101 const bool bHighContrast = Application::GetSettings().GetStyleSettings().GetHighContrastMode();
102 if ( !bHighContrast )
103 {
104 DrawGradient(::tools::Rectangle(Point(0,0),PixelToLogic(GetSizePixel())),
105 Gradient(GradientStyle::Linear,mpAnnotationWindow->maColorLight,mpAnnotationWindow->maColor));
106 }
107
108 if( mpOutlinerView )
109 {
110 Color aBackgroundColor( mpAnnotationWindow->maColor );
111 if( bHighContrast )
112 {
113 aBackgroundColor = GetSettings().GetStyleSettings().GetWindowColor();
114 }
115
116 mpOutlinerView->SetBackgroundColor( aBackgroundColor );
117
118 mpOutlinerView->Paint( rRect );
119 }
120}
121
122void AnnotationTextWindow::KeyInput( const KeyEvent& rKeyEvt )
123{
124 const vcl::KeyCode& rKeyCode = rKeyEvt.GetKeyCode();
125 sal_uInt16 nKey = rKeyCode.GetCode();
126
127 if ((rKeyCode.IsMod1() && rKeyCode.IsMod2()) && ((nKey == KEY_PAGEUP) || (nKey == KEY_PAGEDOWN)))
128 {
129 SfxDispatcher* pDispatcher = mpAnnotationWindow->DocShell()->GetViewShell()->GetViewFrame()->GetDispatcher();
130 if( pDispatcher )
131 pDispatcher->Execute( nKey == KEY_PAGEDOWN ? SID_NEXT_POSTIT( 10000 + 1095 ) : SID_PREVIOUS_POSTIT( 10000 + 1096 ) );
132 }
133 else if (nKey == KEY_INSERT)
134 {
135 if (!rKeyCode.IsMod1() && !rKeyCode.IsMod2())
136 mpAnnotationWindow->ToggleInsMode();
137 }
138 else
139 {
140 long aOldHeight = mpAnnotationWindow->GetPostItTextHeight();
141 bool bDone = false;
142
143 /// HACK: need to switch off processing of Undo/Redo in Outliner
144 if ( !( (nKey == KEY_Z || nKey == KEY_Y) && rKeyCode.IsMod1()) )
145 {
146 bool bIsProtected = mpAnnotationWindow->IsProtected();
147 if (!bIsProtected || !EditEngine::DoesKeyChangeText(rKeyEvt) )
148
149 bDone = mpOutlinerView->PostKeyEvent( rKeyEvt );
150 }
151 if (bDone)
152 {
153 mpAnnotationWindow->ResizeIfNecessary(aOldHeight,mpAnnotationWindow->GetPostItTextHeight());
154 }
155 else
156 {
157 Control::KeyInput(rKeyEvt);
158 }
159 }
160}
161
162void AnnotationTextWindow::MouseMove( const MouseEvent& rMEvt )
163{
164 if ( mpOutlinerView )
165 {
166 mpOutlinerView->MouseMove( rMEvt );
167 SetPointer( mpOutlinerView->GetPointer( rMEvt.GetPosPixel() ) );
168 }
169}
170
171void AnnotationTextWindow::MouseButtonDown( const MouseEvent& rMEvt )
172{
173 GrabFocus();
174 if ( mpOutlinerView )
175 mpOutlinerView->MouseButtonDown( rMEvt );
176}
177
178void AnnotationTextWindow::MouseButtonUp( const MouseEvent& rMEvt )
179{
180 if ( mpOutlinerView )
181 mpOutlinerView->MouseButtonUp( rMEvt );
182}
183
184void AnnotationTextWindow::Command( const CommandEvent& rCEvt )
185{
186 if ( rCEvt.GetCommand() == CommandEventId::ContextMenu )
187 {
188 mpAnnotationWindow->Command(rCEvt);
189 }
190 else
191 {
192 if ( mpOutlinerView )
193 mpOutlinerView->Command( rCEvt );
194 else
195 Window::Command(rCEvt);
196 }
197}
198
199OUString AnnotationTextWindow::GetSurroundingText() const
200{
201 if( mpOutlinerView )
202 {
203 EditEngine *aEditEngine = mpOutlinerView->GetEditView().GetEditEngine();
204 if( mpOutlinerView->HasSelection() )
205 return mpOutlinerView->GetSelected();
206 else
207 {
208 ESelection aSelection = mpOutlinerView->GetEditView().GetSelection();
209 return aEditEngine->GetText(aSelection.nStartPara);
210 }
211 }
212 return OUString();
213}
214
215Selection AnnotationTextWindow::GetSurroundingTextSelection() const
216{
217 if( mpOutlinerView )
218 {
219 if( mpOutlinerView->HasSelection() )
220 return Selection( 0, mpOutlinerView->GetSelected().getLength() );
221 else
222 {
223 ESelection aSelection = mpOutlinerView->GetEditView().GetSelection();
224 return Selection( aSelection.nStartPos, aSelection.nEndPos );
225 }
226 }
227 else
228 return Selection( 0, 0 );
229}
230
231/************** AnnotationWindow***********************************++*/
232
233AnnotationWindow::AnnotationWindow( AnnotationManagerImpl& rManager, DrawDocShell* pDocShell, vcl::Window* pParent )
234: FloatingWindow(pParent, WB_BORDER)
235, mrManager( rManager )
236, mpDocShell( pDocShell )
237, mpDoc( pDocShell->GetDoc() )
238, mpVScrollbar(nullptr)
239, mbReadonly(pDocShell->IsReadOnly())
240, mbProtected(false)
241, mbMouseOverButton(false)
242, mpTextWindow(nullptr)
243, mpMeta(nullptr)
244{
245 EnableAlwaysOnTop();
246}
247
248AnnotationWindow::~AnnotationWindow()
249{
250 disposeOnce();
251}
252
253void AnnotationWindow::dispose()
254{
255 mpMeta.disposeAndClear();
256 mpOutlinerView.reset();
257 mpOutliner.reset();
258 mpOutliner = nullptr;
259 mpVScrollbar.disposeAndClear();
260 mpTextWindow.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
261 FloatingWindow::dispose();
262}
263
264void AnnotationWindow::InitControls()
265{
266 // actual window which holds the user text
267 mpTextWindow = VclPtr<AnnotationTextWindow>::Create(this, WB_NODIALOGCONTROL);
268 mpTextWindow->SetPointer(PointerStyle::Text);
269
270 // window control for author and date
271 mpMeta = VclPtr<FixedText>::Create(this);
272 mpMeta->EnableRTL(AllSettings::GetLayoutRTL());
273
274 // we should leave this setting alone, but for this we need a better layout algo
275 // with variable meta size height
276 AllSettings aSettings = mpMeta->GetSettings();
277 StyleSettings aStyleSettings = aSettings.GetStyleSettings();
278 vcl::Font aFont = aStyleSettings.GetLabelFont();
279 aFont.SetFontHeight(8);
280 aStyleSettings.SetLabelFont(aFont);
281 aSettings.SetStyleSettings(aStyleSettings);
282 mpMeta->SetSettings(aSettings);
283
284 mpOutliner.reset( new ::Outliner(GetAnnotationPool(),OutlinerMode::TextObject) );
285 SdDrawDocument::SetCalcFieldValueHdl( mpOutliner.get() );
286 mpOutliner->SetUpdateMode( true );
287 Rescale();
288
289 OutputDevice* pDev = Doc()->GetRefDevice();
290 if( pDev )
291 {
292 mpOutliner->SetRefDevice( pDev );
293 }
294
295 mpTextWindow->EnableRTL( false );
296 mpOutlinerView.reset( new OutlinerView ( mpOutliner.get(), mpTextWindow ) );
297 mpOutliner->InsertView(mpOutlinerView.get() );
298 mpTextWindow->SetOutlinerView(mpOutlinerView.get());
299 mpOutlinerView->SetOutputArea( PixelToLogic( ::tools::Rectangle(0,0,1,1) ) );
300
301 //create Scrollbars
302 mpVScrollbar = VclPtr<ScrollBar>::Create(this, WB_3DLOOK |WB_VSCROLL|WB_DRAG);
303 mpVScrollbar->EnableNativeWidget(false);
304 mpVScrollbar->EnableRTL( false );
305 mpVScrollbar->SetScrollHdl(LINK(this, AnnotationWindow, ScrollHdl)::tools::detail::makeLink( ::tools::detail::castTo<AnnotationWindow
*>(this), &AnnotationWindow::LinkStubScrollHdl));
306 mpVScrollbar->EnableDrag();
307
308 EEControlBits nCntrl = mpOutliner->GetControlWord();
309 nCntrl |= EEControlBits::PASTESPECIAL | EEControlBits::AUTOCORRECT | EEControlBits::USECHARATTRIBS | EEControlBits::NOCOLORS;
310 mpOutliner->SetControlWord(nCntrl);
311
312 Engine()->SetModifyHdl( Link<LinkParamNone*,void>() );
313 Engine()->EnableUndo( false );
314
315 Engine()->ClearModifyFlag();
316 Engine()->GetUndoManager().Clear();
317 Engine()->EnableUndo( true );
318
319 Invalidate();
320
321 SetLanguage(SvxLanguageItem( Doc()->GetLanguage( EE_CHAR_LANGUAGE ), SID_ATTR_LANGUAGE(((((10000 + 1499) + 1) + 499) + 1) + 7) ));
322
323 mpMeta->Show();
324 mpVScrollbar->Show();
325 mpTextWindow->Show();
326}
327
328void AnnotationWindow::StartEdit()
329{
330 getView()->SetSelection(ESelection(EE_PARA_MAX_COUNT((sal_Int32) 0x7FFFFFFF),EE_TEXTPOS_MAX_COUNT((sal_Int32) 0x7FFFFFFF),EE_PARA_MAX_COUNT((sal_Int32) 0x7FFFFFFF),EE_TEXTPOS_MAX_COUNT((sal_Int32) 0x7FFFFFFF)));
331 getView()->ShowCursor();
332}
333
334void AnnotationWindow::Rescale()
335{
336 MapMode aMode(MapUnit::Map100thMM);
337 aMode.SetOrigin( Point() );
338 mpOutliner->SetRefMapMode( aMode );
339 SetMapMode( aMode );
340 mpTextWindow->SetMapMode( aMode );
341 if ( mpMeta )
342 {
343 vcl::Font aFont( mpMeta->GetSettings().GetStyleSettings().GetLabelFont() );
344 sal_Int32 nHeight = long(aFont.GetFontHeight() * aMode.GetScaleY());
345 aFont.SetFontHeight( nHeight );
346 mpMeta->SetControlFont( aFont );
347 }
348}
349
350void AnnotationWindow::DoResize()
351{
352 unsigned long aWidth = GetSizePixel().Width();
353 long aHeight = GetSizePixel().Height() - POSTIT_META_HEIGHTsal_Int32(30);
354
355 mpOutliner->SetPaperSize( PixelToLogic( Size(aWidth,aHeight) ) ) ;
356 long aTextHeight = LogicToPixel( mpOutliner->CalcTextSize()).Height();
357
358 if( aTextHeight > aHeight )
359 { // we need vertical scrollbars and have to reduce the width
360 aWidth -= GetScrollbarWidth();
361 mpVScrollbar->Show();
362 }
363 else
364 {
365 mpVScrollbar->Hide();
366 }
367
368 mpTextWindow->setPosSizePixel(0,0,aWidth, aHeight);
369
370 if( mbReadonly )
371 mpMeta->setPosSizePixel(0,aHeight,GetSizePixel().Width(),POSTIT_META_HEIGHTsal_Int32(30));
372 else
373 mpMeta->setPosSizePixel(0,aHeight,GetSizePixel().Width()-METABUTTON_AREA_WIDTH30,POSTIT_META_HEIGHTsal_Int32(30));
374
375 mpOutliner->SetPaperSize( PixelToLogic( Size(aWidth,aHeight) ) ) ;
376 mpOutlinerView->SetOutputArea( PixelToLogic( ::tools::Rectangle(0,0,aWidth,aHeight) ) );
377 if (!mpVScrollbar->IsVisible())
378 { // if we do not have a scrollbar anymore, we want to see the complete text
379 mpOutlinerView->SetVisArea( PixelToLogic( ::tools::Rectangle(0,0,aWidth,aHeight) ) );
380 }
381 mpVScrollbar->setPosSizePixel( 0 + aWidth, 0, GetScrollbarWidth(), aHeight );
382 mpVScrollbar->SetVisibleSize( PixelToLogic(Size(0,aHeight)).Height() );
383 mpVScrollbar->SetPageSize( PixelToLogic(Size(0,aHeight)).Height() * 8 / 10 );
384 mpVScrollbar->SetLineSize( mpOutliner->GetTextHeight() / 10 );
385 SetScrollbar();
386 mpVScrollbar->SetRange( Range(0, mpOutliner->GetTextHeight()));
387
388 Point aPos( mpMeta->GetPosPixel());
389 Point aBase( aPos.X() + aPos.X() + GetSizePixel().Width(), aPos.Y() );
390 Point aLeft = PixelToLogic( Point( aBase.X() - (METABUTTON_WIDTH16+5), aBase.Y()+17 ) );
391 Point aRight = PixelToLogic( Point( aBase.X() - (METABUTTON_WIDTH16-1), aBase.Y()+17 ) );
392 Point aBottom = PixelToLogic( Point( aBase.X() - (METABUTTON_WIDTH16+2), aBase.Y()+20 ) );
393
394 maPopupTriangle.clear();
395 maPopupTriangle.append(basegfx::B2DPoint(aLeft.X(),aLeft.Y()));
396 maPopupTriangle.append(basegfx::B2DPoint(aRight.X(),aRight.Y()));
397 maPopupTriangle.append(basegfx::B2DPoint(aBottom.X(),aBottom.Y()));
398 maPopupTriangle.setClosed(true);
399 maRectMetaButton = PixelToLogic( ::tools::Rectangle( Point(
400 aPos.X()+GetSizePixel().Width()-(METABUTTON_WIDTH16+10),
401 aPos.Y()+5 ),
402 Size( METABUTTON_WIDTH16, METABUTTON_HEIGHT18 ) ) );
403
404}
405
406void AnnotationWindow::SetScrollbar()
407{
408 mpVScrollbar->SetThumbPos(mpOutlinerView->GetVisArea().Top());
409}
410
411void AnnotationWindow::ResizeIfNecessary(long aOldHeight, long aNewHeight)
412{
413 if (aOldHeight != aNewHeight)
414 {
415 DoResize();
416 Invalidate();
417 }
418 else
419 {
420 SetScrollbar();
421 }
422}
423
424void AnnotationWindow::SetLanguage(const SvxLanguageItem &aNewItem)
425{
426 Engine()->SetModifyHdl( Link<LinkParamNone*,void>() );
427 ESelection aOld = getView()->GetSelection();
428
429 ESelection aNewSelection( 0, 0, Engine()->GetParagraphCount()-1, EE_TEXTPOS_ALL((sal_Int32) 0x7FFFFFFF) );
430 getView()->SetSelection( aNewSelection );
431 SfxItemSet aEditAttr(getView()->GetAttribs());
432 aEditAttr.Put(aNewItem);
433 getView()->SetAttribs( aEditAttr );
434
435 getView()->SetSelection(aOld);
436
437 Invalidate();
438}
439
440void AnnotationWindow::ToggleInsMode()
441{
442 if( mpOutlinerView )
443 {
444 SfxBindings &rBnd = mpDocShell->GetViewShell()->GetViewFrame()->GetBindings();
445 rBnd.Invalidate(SID_ATTR_INSERTTypedWhichId<SfxBoolItem>( 10000 + 221 ));
446 rBnd.Update(SID_ATTR_INSERTTypedWhichId<SfxBoolItem>( 10000 + 221 ));
447 }
448}
449
450long AnnotationWindow::GetPostItTextHeight()
451{
452 return mpOutliner ? LogicToPixel(mpOutliner->CalcTextSize()).Height() : 0;
453}
454
455IMPL_LINK(AnnotationWindow, ScrollHdl, ScrollBar*, pScroll, void)void AnnotationWindow::LinkStubScrollHdl(void * instance, ScrollBar
* data) { return static_cast<AnnotationWindow *>(instance
)->ScrollHdl(data); } void AnnotationWindow::ScrollHdl(ScrollBar
* pScroll)
456{
457 long nDiff = getView()->GetEditView().GetVisArea().Top() - pScroll->GetThumbPos();
458 getView()->Scroll( 0, nDiff );
459}
460
461TextApiObject* getTextApiObject( const Reference< XAnnotation >& xAnnotation )
462{
463 if( xAnnotation.is() )
464 {
465 Reference< XText > xText( xAnnotation->getTextRange() );
466 return TextApiObject::getImplementation( xText );
467 }
468 return nullptr;
469}
470
471void AnnotationWindow::setAnnotation( const Reference< XAnnotation >& xAnnotation )
472{
473 if( (xAnnotation == mxAnnotation) || !xAnnotation.is() )
474 return;
475
476 mxAnnotation = xAnnotation;
477
478 SetColor();
479
480 SvtUserOptions aUserOptions;
481 mbProtected = aUserOptions.GetFullName() != xAnnotation->getAuthor();
482
483 Engine()->Clear();
484 TextApiObject* pTextApi = getTextApiObject( mxAnnotation );
485
486 if( pTextApi )
487 {
488 std::unique_ptr< OutlinerParaObject > pOPO( pTextApi->CreateText() );
489 Engine()->SetText(*pOPO);
490 }
491
492 Engine()->ClearModifyFlag();
493 Engine()->GetUndoManager().Clear();
494
495 Invalidate();
496
497 OUString sMeta( xAnnotation->getAuthor() );
498 OUString sDateTime( getAnnotationDateTimeString(xAnnotation) );
499
500 if( !sDateTime.isEmpty() )
501 {
502 if( !sMeta.isEmpty() )
503 sMeta += "\n";
504
505 sMeta += sDateTime;
506 }
507 mpMeta->SetText(sMeta);
508}
509
510void AnnotationWindow::SetColor()
511{
512 sal_uInt16 nAuthorIdx = mpDoc->GetAnnotationAuthorIndex( mxAnnotation->getAuthor() );
513
514 const bool bHighContrast = Application::GetSettings().GetStyleSettings().GetHighContrastMode();
515 if( bHighContrast )
516 {
517 StyleSettings aStyleSettings = GetSettings().GetStyleSettings();
518
519 maColor = aStyleSettings.GetWindowColor();
520 maColorDark = maColor;
521 maColorLight = aStyleSettings.GetWindowTextColor();
522 }
523 else
524 {
525 maColor = AnnotationManagerImpl::GetColor( nAuthorIdx );
526 maColorDark = AnnotationManagerImpl::GetColorDark( nAuthorIdx );
527 maColorLight = AnnotationManagerImpl::GetColorLight( nAuthorIdx );
528 }
529
530 mpOutlinerView->SetBackgroundColor(maColor);
531 Engine()->SetBackgroundColor(maColor);
532
533 {
534 SvtAccessibilityOptions aOptions;
535 Engine()->ForceAutoColor( bHighContrast || aOptions.GetIsAutomaticFontColor() );
536 }
537
538 mpMeta->SetControlBackground(maColor);
539 AllSettings aSettings = mpMeta->GetSettings();
540 StyleSettings aStyleSettings = aSettings.GetStyleSettings();
541 aStyleSettings.SetLabelTextColor( bHighContrast ? maColorLight : maColorDark);
542 aSettings.SetStyleSettings(aStyleSettings);
543 mpMeta->SetSettings(aSettings);
544
545 AllSettings aSettings2 = mpVScrollbar->GetSettings();
546 StyleSettings aStyleSettings2 = aSettings2.GetStyleSettings();
547 aStyleSettings2.SetButtonTextColor(Color(0,0,0));
548 aStyleSettings2.SetCheckedColor(maColorLight); //hintergund
549 aStyleSettings2.SetShadowColor(maColorDark);
550 aStyleSettings2.SetFaceColor(maColor);
551 aSettings2.SetStyleSettings(aStyleSettings2);
552 mpVScrollbar->SetSettings(aSettings2);
553}
554
555void AnnotationWindow::Deactivate()
556{
557 //tdf#99388 and tdf#99712, don't deactivate if we lose focus because of our
558 //own popup
559 if (mrManager.getPopupMenuActive())
560 return;
561
562 if (!mpOutliner) //in dispose
563 return;
564
565 Reference< XAnnotation > xAnnotation( mxAnnotation );
566
567 // write changed text back to annotation
568 if ( Engine()->IsModified() )
569 {
570 TextApiObject* pTextApi = getTextApiObject( xAnnotation );
571
572 if( pTextApi )
573 {
574 std::unique_ptr<OutlinerParaObject> pOPO = Engine()->CreateParaObject();
575 if( pOPO )
576 {
577 if( mpDoc->IsUndoEnabled() )
578 mpDoc->BegUndo( SdResId( STR_ANNOTATION_UNDO_EDITreinterpret_cast<char const *>("STR_ANNOTATION_UNDO_EDIT"
"\004" u8"Edit Comment") ) );
579
580 pTextApi->SetText( *pOPO );
581 pOPO.reset();
582
583 // set current time to changed annotation
584 xAnnotation->setDateTime( getCurrentDateTime() );
585
586 if( mpDoc->IsUndoEnabled() )
587 mpDoc->EndUndo();
588
589 mpDocShell->SetModified();
590 }
591
592 }
593 }
594 Engine()->ClearModifyFlag();
595
596 Engine()->GetUndoManager().Clear();
597}
598
599void AnnotationWindow::Paint(vcl::RenderContext& rRenderContext, const ::tools::Rectangle& rRect)
600{
601 FloatingWindow::Paint(rRenderContext, rRect);
602
603 if(!mpMeta->IsVisible() || mbReadonly)
604 return;
605
606 const bool bHighContrast = Application::GetSettings().GetStyleSettings().GetHighContrastMode();
607 //draw left over space
608 if ( bHighContrast )
609 SetFillColor(COL_BLACK);
610 else
611 SetFillColor(maColor);
612 SetLineColor();
613 DrawRect(PixelToLogic(::tools::Rectangle(Point(mpMeta->GetPosPixel().X()+mpMeta->GetSizePixel().Width(),mpMeta->GetPosPixel().Y()),Size(METABUTTON_AREA_WIDTH30,mpMeta->GetSizePixel().Height()))));
614
615 if ( bHighContrast )
616 {
617 //draw rect around button
618 SetFillColor(COL_BLACK);
619 SetLineColor(COL_WHITE);
620 }
621 else
622 {
623 //draw button
624 Gradient aGradient;
625 if (mbMouseOverButton)
626 aGradient = Gradient(GradientStyle::Linear,ColorFromAlphaColor(80,maColorDark,maColor),ColorFromAlphaColor(15,maColorDark,maColor));
627 else
628 aGradient = Gradient(GradientStyle::Linear,ColorFromAlphaColor(15,maColorDark,maColor),ColorFromAlphaColor(80,maColorDark,maColor));
629 DrawGradient(maRectMetaButton,aGradient);
630 //draw rect around button
631 SetFillColor();
632 SetLineColor(ColorFromAlphaColor(90,maColorDark,maColor));
633 }
634 DrawRect(maRectMetaButton);
635
636 //draw arrow
637 if( bHighContrast )
638 SetFillColor(COL_WHITE);
639 else
640 SetFillColor(COL_BLACK);
641 SetLineColor();
642 DrawPolygon( ::tools::Polygon(maPopupTriangle));
643}
644
645void AnnotationWindow::MouseMove( const MouseEvent& rMEvt )
646{
647 if( mbReadonly )
648 return;
649
650 if (maRectMetaButton.IsInside(PixelToLogic(rMEvt.GetPosPixel())))
651 {
652 if (!mbMouseOverButton)
653 {
654 Invalidate(maRectMetaButton);
655 mbMouseOverButton = true;
656 }
657 }
658 else
659 {
660 if (mbMouseOverButton)
661 {
662 Invalidate(maRectMetaButton);
663 mbMouseOverButton = false;
664 }
665 }
666}
667
668void AnnotationWindow::MouseButtonDown( const MouseEvent& rMEvt )
669{
670 if (!mbReadonly && maRectMetaButton.IsInside(PixelToLogic(rMEvt.GetPosPixel())) && rMEvt.IsLeft())
671 {
672 // context menu
673 ::tools::Rectangle aRect(LogicToPixel(maRectMetaButton.BottomLeft()),LogicToPixel(maRectMetaButton.BottomLeft()));
674 mrManager.ExecuteAnnotationContextMenu( mxAnnotation, static_cast<vcl::Window*>(this), aRect, true );
675 }
676}
677
678void AnnotationWindow::Command( const CommandEvent& rCEvt )
679{
680 if ( rCEvt.GetCommand() == CommandEventId::ContextMenu )
681 {
682 if( mpMeta->IsVisible() &&(mpMeta->GetPosPixel().Y() < rCEvt.GetMousePosPixel().Y()) )
683 return;
684 mrManager.ExecuteAnnotationContextMenu( mxAnnotation, this, ::tools::Rectangle(rCEvt.GetMousePosPixel(),Size(1,1)) );
685 }
686 else
687 {
688 FloatingWindow::Command(rCEvt);
689 }
690}
691
692void AnnotationWindow::GetFocus()
693{
694 if( mpTextWindow )
695 mpTextWindow->GrabFocus();
696 else
697 FloatingWindow::GetFocus();
698}
699
700void AnnotationWindow::ExecuteSlot( sal_uInt16 nSID )
701{
702 if( nSID == SID_COPY(5000 + 711) )
703 {
704 getView()->Copy();
705 }
706 else if( nSID == SID_PASTE(5000 + 712) )
707 {
708 getView()->PasteSpecial();
709 DoResize();
710 }
711 else
712 {
713 SfxItemSet aEditAttr(getView()->GetAttribs());
714 SfxItemSet aNewAttr(mpOutliner->GetEmptyItemSet());
715
716 switch( nSID )
717 {
718 case SID_ATTR_CHAR_WEIGHT( 10000 + 9 ):
719 {
720 FontWeight eFW = aEditAttr.Get( EE_CHAR_WEIGHT ).GetWeight();
721 aNewAttr.Put( SvxWeightItem( eFW == WEIGHT_NORMAL ? WEIGHT_BOLD : WEIGHT_NORMAL, EE_CHAR_WEIGHT ) );
722 }
723 break;
724 case SID_ATTR_CHAR_POSTURE( 10000 + 8 ):
725 {
726 FontItalic eFI = aEditAttr.Get( EE_CHAR_ITALIC ).GetPosture();
727 aNewAttr.Put( SvxPostureItem( eFI == ITALIC_NORMAL ? ITALIC_NONE : ITALIC_NORMAL, EE_CHAR_ITALIC ) );
728 }
729 break;
730 case SID_ATTR_CHAR_UNDERLINE( 10000 + 14 ):
731 {
732 FontLineStyle eFU = aEditAttr. Get( EE_CHAR_UNDERLINE ).GetLineStyle();
733 aNewAttr.Put( SvxUnderlineItem( eFU == LINESTYLE_SINGLE ? LINESTYLE_NONE : LINESTYLE_SINGLE, EE_CHAR_UNDERLINE ) );
734 }
735 break;
736 case SID_ATTR_CHAR_STRIKEOUT( 10000 + 13 ):
737 {
738 FontStrikeout eFSO = aEditAttr.Get( EE_CHAR_STRIKEOUT ).GetStrikeout();
739 aNewAttr.Put( SvxCrossedOutItem( eFSO == STRIKEOUT_SINGLE ? STRIKEOUT_NONE : STRIKEOUT_SINGLE, EE_CHAR_STRIKEOUT ) );
740 }
741 break;
742 }
743 getView()->SetAttribs( aNewAttr );
744 }
745}
746
747}
748
749/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
2
←
Calling copy constructor for 'Reference<sd::AnnotationTextWindow>'
→
5
←
Returning from copy constructor for 'Reference<sd::AnnotationTextWindow>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
6
←
Calling 'Reference::clear'
→
13
←
Returning; memory was released
→
205 if (aTmp.get()) {
14
←
Calling 'Reference::get'
→
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
3
←
Assuming field 'm_pBody' is non-null
→
4
←
Taking true branch
→
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
)
7
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
8
←
Calling 'VclReferenceBase::release'
→
12
←
Returning; memory was released
→
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
15
←
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__));
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__));
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

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