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 bastypes.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/basctl/inc -I /home/maarten/src/libreoffice/core/basctl/sdi -I /home/maarten/src/libreoffice/core/basctl/source/inc -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/basctl/sdi -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -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/basctl/source/basicide/bastypes.cxx

/home/maarten/src/libreoffice/core/basctl/source/basicide/bastypes.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 <strings.hrc>
21#include <helpids.h>
22#include <iderid.hxx>
23
24#include "baside2.hxx"
25#include <baside3.hxx>
26#include <basidesh.hxx>
27#include <basobj.hxx>
28#include <iderdll.hxx>
29#include "iderdll2.hxx"
30
31#include <com/sun/star/script/XLibraryContainerPassword.hpp>
32#include <sal/log.hxx>
33#include <sfx2/dispatch.hxx>
34#include <sfx2/passwd.hxx>
35#include <sfx2/sfxsids.hrc>
36#include <svl/intitem.hxx>
37#include <svl/stritem.hxx>
38#include <svl/srchdefs.hxx>
39#include <vcl/commandevent.hxx>
40#include <vcl/event.hxx>
41#include <vcl/layout.hxx>
42#include <vcl/svapp.hxx>
43#include <vcl/weld.hxx>
44#include <tools/stream.hxx>
45#include <boost/functional/hash.hpp>
46
47namespace basctl
48{
49
50using namespace ::com::sun::star::uno;
51using namespace ::com::sun::star;
52
53BaseWindow::BaseWindow( vcl::Window* pParent, const ScriptDocument& rDocument, const OUString& aLibName, const OUString& aName )
54 :Window( pParent, WinBits( WB_3DLOOK ) )
55 ,m_aDocument( rDocument )
56 ,m_aLibName( aLibName )
57 ,m_aName( aName )
58{
59 pShellHScrollBar = nullptr;
60 pShellVScrollBar = nullptr;
61 nStatus = 0;
62}
63
64BaseWindow::~BaseWindow()
65{
66 disposeOnce();
67}
68
69void BaseWindow::dispose()
70{
71 if ( pShellVScrollBar )
72 pShellVScrollBar->SetScrollHdl( Link<ScrollBar*,void>() );
73 if ( pShellHScrollBar )
74 pShellHScrollBar->SetScrollHdl( Link<ScrollBar*,void>() );
75 pShellVScrollBar.clear();
76 pShellHScrollBar.clear();
77 vcl::Window::dispose();
78}
79
80
81void BaseWindow::Init()
82{
83 if ( pShellVScrollBar )
84 pShellVScrollBar->SetScrollHdl( LINK( this, BaseWindow, ScrollHdl )::tools::detail::makeLink( ::tools::detail::castTo<BaseWindow
*>(this), &BaseWindow::LinkStubScrollHdl)
);
85 if ( pShellHScrollBar )
86 pShellHScrollBar->SetScrollHdl( LINK( this, BaseWindow, ScrollHdl )::tools::detail::makeLink( ::tools::detail::castTo<BaseWindow
*>(this), &BaseWindow::LinkStubScrollHdl)
);
87 DoInit(); // virtual...
88}
89
90
91void BaseWindow::DoInit()
92{ }
93
94
95void BaseWindow::GrabScrollBars( ScrollBar* pHScroll, ScrollBar* pVScroll )
96{
97 pShellHScrollBar = pHScroll;
98 pShellVScrollBar = pVScroll;
99// Init(); // does not make sense, leads to flickering and errors...
100}
101
102
103IMPL_LINK( BaseWindow, ScrollHdl, ScrollBar *, pCurScrollBar, void )void BaseWindow::LinkStubScrollHdl(void * instance, ScrollBar
* data) { return static_cast<BaseWindow *>(instance)->
ScrollHdl(data); } void BaseWindow::ScrollHdl(ScrollBar * pCurScrollBar
)
104{
105 DoScroll( pCurScrollBar );
106}
107
108void BaseWindow::ExecuteCommand (SfxRequest&)
109{ }
110
111void BaseWindow::ExecuteGlobal (SfxRequest&)
112{ }
113
114
115bool BaseWindow::EventNotify( NotifyEvent& rNEvt )
116{
117 bool bDone = false;
118
119 if ( rNEvt.GetType() == MouseNotifyEvent::KEYINPUT )
120 {
121 KeyEvent aKEvt = *rNEvt.GetKeyEvent();
122 vcl::KeyCode aCode = aKEvt.GetKeyCode();
123 sal_uInt16 nCode = aCode.GetCode();
124
125 switch ( nCode )
126 {
127 case KEY_PAGEUP:
128 case KEY_PAGEDOWN:
129 {
130 if ( aCode.IsMod1() )
131 {
132 if (Shell* pShell = GetShell())
133 pShell->NextPage( nCode == KEY_PAGEUP );
134 bDone = true;
135 }
136 }
137 break;
138 }
139 }
140
141 return bDone || Window::EventNotify( rNEvt );
142}
143
144
145void BaseWindow::DoScroll( ScrollBar* )
146{
147}
148
149
150void BaseWindow::StoreData()
151{
152}
153
154bool BaseWindow::AllowUndo()
155{
156 return true;
157}
158
159
160void BaseWindow::UpdateData()
161{
162}
163
164OUString BaseWindow::GetTitle()
165{
166 return OUString();
167}
168
169OUString BaseWindow::CreateQualifiedName()
170{
171 OUString aName;
172 if ( !m_aLibName.isEmpty() )
173 {
174 LibraryLocation eLocation = m_aDocument.getLibraryLocation( m_aLibName );
175 aName = m_aDocument.getTitle(eLocation) + "." + m_aLibName + "." +
176 GetTitle();
177 }
178 return aName;
179}
180
181void BaseWindow::SetReadOnly (bool)
182{
183}
184
185bool BaseWindow::IsReadOnly ()
186{
187 return false;
188}
189
190void BaseWindow::BasicStarted()
191{
192}
193
194void BaseWindow::BasicStopped()
195{
196}
197
198bool BaseWindow::IsModified ()
199{
200 return true;
201}
202
203SfxUndoManager* BaseWindow::GetUndoManager()
204{
205 return nullptr;
206}
207
208SearchOptionFlags BaseWindow::GetSearchOptions()
209{
210 return SearchOptionFlags::NONE;
211}
212
213sal_uInt16 BaseWindow::StartSearchAndReplace (SvxSearchItem const&, bool)
214{
215 return 0;
216}
217
218void BaseWindow::OnNewDocument ()
219{ }
220
221void BaseWindow::InsertLibInfo () const
222{
223 if (ExtraData* pData = GetExtraData())
224 pData->GetLibInfo().InsertInfo(m_aDocument, m_aLibName, m_aName, GetType());
225}
226
227bool BaseWindow::Is (
228 ScriptDocument const& rDocument,
229 OUString const& rLibName, OUString const& rName,
230 ItemType eType, bool bFindSuspended
231)
232{
233 if (bFindSuspended || !IsSuspended())
234 {
235 // any non-suspended window is ok
236 if (rLibName.isEmpty() || rName.isEmpty() || eType == TYPE_UNKNOWN)
237 return true;
238 // ok if the parameters match
239 if (m_aDocument == rDocument && m_aLibName == rLibName && m_aName == rName && GetType() == eType)
240 return true;
241 }
242 return false;
243}
244
245bool BaseWindow::HasActiveEditor () const
246{
247 return false;
248}
249
250
251// DockingWindow
252
253
254// style bits for DockingWindow
255WinBits const DockingWindow::StyleBits =
256 WB_BORDER | WB_3DLOOK | WB_CLIPCHILDREN |
257 WB_MOVEABLE | WB_SIZEABLE | WB_ROLLABLE | WB_DOCKABLE;
258
259DockingWindow::DockingWindow(vcl::Window* pParent, const OUString& rUIXMLDescription, const OString& rID) :
260 ::DockingWindow(pParent, "DockingWindow", "sfx/ui/dockingwindow.ui"),
261 pLayout(nullptr),
262 nShowCount(0)
263{
264 m_xVclContentArea = VclPtr<VclVBox>::Create(this);
1
Calling 'VclPtr::Create'
3
Returned allocated memory
4
Calling implicit destructor for 'VclPtr<VclVBox>'
5
Calling '~Reference'
12
Returning from '~Reference'
13
Returning from destructor for 'VclPtr<VclVBox>'
265 m_xVclContentArea->Show();
14
Calling 'VclPtr::operator->'
266 m_xBuilder.reset(Application::CreateInterimBuilder(m_xVclContentArea, rUIXMLDescription, true));
267 m_xContainer = m_xBuilder->weld_container(rID);
268}
269
270DockingWindow::DockingWindow (Layout* pParent) :
271 ::DockingWindow(pParent, StyleBits),
272 pLayout(pParent),
273 nShowCount(0)
274{ }
275
276DockingWindow::~DockingWindow()
277{
278 disposeOnce();
279}
280
281void DockingWindow::dispose()
282{
283 m_xContainer.reset();
284 m_xBuilder.reset();
285 m_xVclContentArea.disposeAndClear();
286 pLayout.clear();
287 ::DockingWindow::dispose();
288}
289
290// Sets the position and the size of the docking window. This property is saved
291// when the window is floating. Called by Layout.
292void DockingWindow::ResizeIfDocking (Point const& rPos, Size const& rSize)
293{
294 tools::Rectangle const rRect(rPos, rSize);
295 if (rRect != aDockingRect)
296 {
297 // saving the position and the size
298 aDockingRect = rRect;
299 // resizing if actually docking
300 if (!IsFloatingMode())
301 SetPosSizePixel(rPos, rSize);
302 }
303}
304void DockingWindow::ResizeIfDocking (Size const& rSize)
305{
306 ResizeIfDocking(aDockingRect.TopLeft(), rSize);
307}
308
309// Sets the parent Layout window.
310// The physical parent is set only when the window is docking.
311void DockingWindow::SetLayoutWindow (Layout* pLayout_)
312{
313 pLayout = pLayout_;
314 if (!IsFloatingMode())
315 SetParent(pLayout);
316
317}
318
319// Increases the "show" reference count.
320// The window is shown when the reference count is positive.
321void DockingWindow::Show (bool bShow) // = true
322{
323 if (bShow)
324 {
325 if (++nShowCount == 1)
326 ::DockingWindow::Show();
327 }
328 else
329 {
330 if (--nShowCount == 0)
331 ::DockingWindow::Hide();
332 }
333}
334
335// Decreases the "show" reference count.
336// The window is hidden when the reference count reaches zero.
337void DockingWindow::Hide ()
338{
339 Show(false);
340}
341
342bool DockingWindow::Docking( const Point& rPos, tools::Rectangle& rRect )
343{
344 if (aDockingRect.IsInside(rPos))
345 {
346 rRect.SetSize(aDockingRect.GetSize());
347 return false; // dock
348 }
349 else // adjust old size
350 {
351 if (!aFloatingRect.IsEmpty())
352 rRect.SetSize(aFloatingRect.GetSize());
353 return true; // float
354 }
355}
356
357void DockingWindow::EndDocking( const tools::Rectangle& rRect, bool bFloatMode )
358{
359 if ( bFloatMode )
360 ::DockingWindow::EndDocking( rRect, bFloatMode );
361 else
362 {
363 SetFloatingMode(false);
364 DockThis();
365 }
366}
367
368void DockingWindow::ToggleFloatingMode()
369{
370 if (IsFloatingMode())
371 {
372 if (!aFloatingRect.IsEmpty())
373 SetPosSizePixel(
374 GetParent()->ScreenToOutputPixel(aFloatingRect.TopLeft()),
375 aFloatingRect.GetSize()
376 );
377 }
378 DockThis();
379}
380
381bool DockingWindow::PrepareToggleFloatingMode()
382{
383 if (IsFloatingMode())
384 {
385 // memorize position and size on the desktop...
386 aFloatingRect = tools::Rectangle(
387 GetParent()->OutputToScreenPixel(GetPosPixel()),
388 GetSizePixel()
389 );
390 }
391 return true;
392}
393
394void DockingWindow::StartDocking()
395{
396 if (IsFloatingMode())
397 {
398 aFloatingRect = tools::Rectangle(
399 GetParent()->OutputToScreenPixel(GetPosPixel()),
400 GetSizePixel()
401 );
402 }
403}
404
405void DockingWindow::DockThis ()
406{
407 // resizing when floating -> docking
408 if (!IsFloatingMode())
409 {
410 Point const aPos = aDockingRect.TopLeft();
411 Size const aSize = aDockingRect.GetSize();
412 if (aSize != GetSizePixel() || aPos != GetPosPixel())
413 SetPosSizePixel(aPos, aSize);
414 }
415
416 if (pLayout)
417 {
418 if (!IsFloatingMode() && GetParent() != pLayout)
419 SetParent(pLayout);
420 pLayout->ArrangeWindows();
421 }
422}
423
424TabBar::TabBar( vcl::Window* pParent ) :
425 ::TabBar( pParent, WinBits( WB_3DLOOK | WB_SCROLL | WB_BORDER | WB_SIZEABLE | WB_DRAG ) )
426{
427 EnableEditMode();
428
429 SetHelpId( HID_BASICIDE_TABBAR"BASCTL_HID_BASICIDE_TABBAR" );
430}
431
432void TabBar::MouseButtonDown( const MouseEvent& rMEvt )
433{
434 if ( rMEvt.IsLeft() && ( rMEvt.GetClicks() == 2 ) && !IsInEditMode() )
435 {
436 if (SfxDispatcher* pDispatcher = GetDispatcher())
437 pDispatcher->Execute( SID_BASICIDE_MODULEDLG( (30000 + 768) + 5 ) );
438 }
439 else
440 {
441 ::TabBar::MouseButtonDown( rMEvt ); // base class version
442 }
443}
444
445void TabBar::Command( const CommandEvent& rCEvt )
446{
447 if ( ( rCEvt.GetCommand() == CommandEventId::ContextMenu ) && !IsInEditMode() )
448 {
449 Point aPos( rCEvt.IsMouseEvent() ? rCEvt.GetMousePosPixel() : Point(1,1) );
450 if ( rCEvt.IsMouseEvent() ) // select right tab
451 {
452 Point aP = PixelToLogic( aPos );
453 MouseEvent aMouseEvent( aP, 1, MouseEventModifiers::SIMPLECLICK, MOUSE_LEFT(sal_uInt16(0x0001)) );
454 ::TabBar::MouseButtonDown( aMouseEvent ); // base class
455 }
456 if (SfxDispatcher* pDispatcher = GetDispatcher())
457 pDispatcher->ExecutePopup("tabbar", this, &aPos);
458 }
459}
460
461TabBarAllowRenamingReturnCode TabBar::AllowRenaming()
462{
463 bool const bValid = IsValidSbxName(GetEditText());
464
465 if ( !bValid )
466 {
467 std::unique_ptr<weld::MessageDialog> xError(Application::CreateMessageDialog(GetFrameWeld(),
468 VclMessageType::Warning, VclButtonsType::Ok, IDEResId(RID_STR_BADSBXNAMEreinterpret_cast<char const *>("RID_STR_BADSBXNAME" "\004"
u8"Invalid Name")
)));
469 xError->run();
470 }
471
472 return bValid ? TABBAR_RENAMING_YES : TABBAR_RENAMING_NO;
473}
474
475
476void TabBar::EndRenaming()
477{
478 if ( !IsEditModeCanceled() )
479 {
480 SfxUInt16Item aID( SID_BASICIDE_ARG_TABIDTypedWhichId<SfxUInt16Item>( (30000 + 768) + 30 ), GetEditPageId() );
481 SfxStringItem aNewName( SID_BASICIDE_ARG_MODULENAMETypedWhichId<SfxStringItem>( (30000 + 768) + 35 ), GetEditText() );
482 if (SfxDispatcher* pDispatcher = GetDispatcher())
483 pDispatcher->ExecuteList( SID_BASICIDE_NAMECHANGEDONTAB( (30000 + 768) + 11 ),
484 SfxCallMode::SYNCHRON, { &aID, &aNewName });
485 }
486}
487
488
489namespace
490{
491
492// helper class for sorting TabBar
493struct TabBarSortHelper
494{
495 sal_uInt16 nPageId;
496 OUString aPageText;
497
498 bool operator < (TabBarSortHelper const& rComp) const
499 {
500 return aPageText.compareToIgnoreAsciiCase(rComp.aPageText) < 0;
501 }
502};
503
504} // namespace
505
506void TabBar::Sort()
507{
508 Shell* pShell = GetShell();
509 if (!pShell)
510 return;
511
512 Shell::WindowTable& aWindowTable = pShell->GetWindowTable();
513 TabBarSortHelper aTabBarSortHelper;
514 std::vector<TabBarSortHelper> aModuleList;
515 std::vector<TabBarSortHelper> aDialogList;
516 sal_uInt16 nPageCount = GetPageCount();
517 sal_uInt16 i;
518
519 // create module and dialog lists for sorting
520 for ( i = 0; i < nPageCount; i++)
521 {
522 sal_uInt16 nId = GetPageId( i );
523 aTabBarSortHelper.nPageId = nId;
524 aTabBarSortHelper.aPageText = GetPageText( nId );
525 BaseWindow* pWin = aWindowTable[ nId ].get();
526
527 if (dynamic_cast<ModulWindow*>(pWin))
528 {
529 aModuleList.push_back( aTabBarSortHelper );
530 }
531 else if (dynamic_cast<DialogWindow*>(pWin))
532 {
533 aDialogList.push_back( aTabBarSortHelper );
534 }
535 }
536
537 // sort module and dialog lists by page text
538 std::sort( aModuleList.begin() , aModuleList.end() );
539 std::sort( aDialogList.begin() , aDialogList.end() );
540
541
542 sal_uInt16 nModules = sal::static_int_cast<sal_uInt16>( aModuleList.size() );
543 sal_uInt16 nDialogs = sal::static_int_cast<sal_uInt16>( aDialogList.size() );
544
545 // move module pages to new positions
546 for (i = 0; i < nModules; i++)
547 {
548 MovePage( aModuleList[i].nPageId , i );
549 }
550
551 // move dialog pages to new positions
552 for (i = 0; i < nDialogs; i++)
553 {
554 MovePage( aDialogList[i].nPageId , nModules + i );
555 }
556}
557
558void CutLines( OUString& rStr, sal_Int32 nStartLine, sal_Int32 nLines )
559{
560 sal_Int32 nStartPos = 0;
561 sal_Int32 nLine = 0;
562 while ( nLine < nStartLine )
563 {
564 nStartPos = searchEOL( rStr, nStartPos );
565 if( nStartPos == -1 )
566 break;
567 nStartPos++; // not the \n.
568 nLine++;
569 }
570
571 SAL_WARN_IF( nStartPos == -1, "basctl.basicide", "CutLines: Start line not found!" )do { if (true && (nStartPos == -1)) { switch (sal_detail_log_report
(::SAL_DETAIL_LOG_LEVEL_WARN, "basctl.basicide")) { case SAL_DETAIL_LOG_ACTION_IGNORE
: break; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail
::getResult( ::sal::detail::StreamStart() << "CutLines: Start line not found!"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("basctl.basicide"
), ("/home/maarten/src/libreoffice/core/basctl/source/basicide/bastypes.cxx"
":" "571" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "CutLines: Start line not found!"), 0)
; } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "CutLines: Start line not found!"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("basctl.basicide"), ("/home/maarten/src/libreoffice/core/basctl/source/basicide/bastypes.cxx"
":" "571" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "CutLines: Start line not found!") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("basctl.basicide"), ("/home/maarten/src/libreoffice/core/basctl/source/basicide/bastypes.cxx"
":" "571" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "CutLines: Start line not found!"), 0)
; } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "CutLines: Start line not found!"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("basctl.basicide"), ("/home/maarten/src/libreoffice/core/basctl/source/basicide/bastypes.cxx"
":" "571" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
;
572
573 if ( nStartPos == -1 )
574 return;
575
576 sal_Int32 nEndPos = nStartPos;
577
578 for ( sal_Int32 i = 0; i < nLines; i++ )
579 nEndPos = searchEOL( rStr, nEndPos+1 );
580
581 if ( nEndPos == -1 ) // might happen at the last line
582 nEndPos = rStr.getLength();
583 else
584 nEndPos++;
585
586 OUString aEndStr = rStr.copy( nEndPos );
587 rStr = rStr.copy( 0, nStartPos );
588 rStr += aEndStr;
589
590 // erase trailing empty lines
591 {
592 sal_Int32 n = nStartPos;
593 sal_Int32 nLen = rStr.getLength();
594 while ( ( n < nLen ) && ( rStr[ n ] == LINE_SEP0x0A ||
595 rStr[ n ] == LINE_SEP_CR0x0D ) )
596 {
597 n++;
598 }
599
600 if ( n > nStartPos )
601 {
602 aEndStr = rStr.copy( n );
603 rStr = rStr.copy( 0, nStartPos );
604 rStr += aEndStr;
605 }
606 }
607}
608
609sal_uInt32 CalcLineCount( SvStream& rStream )
610{
611 sal_uInt32 nLFs = 0;
612 sal_uInt32 nCRs = 0;
613 char c;
614
615 rStream.Seek( 0 );
616 rStream.ReadChar( c );
617 while ( !rStream.eof() )
618 {
619 if ( c == '\n' )
620 nLFs++;
621 else if ( c == '\r' )
622 nCRs++;
623 rStream.ReadChar( c );
624 }
625
626 rStream.Seek( 0 );
627 if ( nLFs > nCRs )
628 return nLFs;
629 return nCRs;
630}
631
632
633// LibInfo
634
635
636LibInfo::LibInfo ()
637{ }
638
639LibInfo::~LibInfo ()
640{ }
641
642void LibInfo::InsertInfo (
643 ScriptDocument const& rDocument,
644 OUString const& rLibName,
645 OUString const& rCurrentName,
646 ItemType eCurrentType
647)
648{
649 Key aKey(rDocument, rLibName);
650 m_aMap.erase(aKey);
651 m_aMap.emplace(aKey, Item(rCurrentName, eCurrentType));
652}
653
654void LibInfo::RemoveInfoFor (ScriptDocument const& rDocument)
655{
656 Map::iterator it = std::find_if(m_aMap.begin(), m_aMap.end(),
657 [&rDocument](Map::reference rEntry) { return rEntry.first.GetDocument() == rDocument; });
658 if (it != m_aMap.end())
659 m_aMap.erase(it);
660}
661
662LibInfo::Item const* LibInfo::GetInfo (
663 ScriptDocument const& rDocument, OUString const& rLibName
664)
665{
666 Map::iterator it = m_aMap.find(Key(rDocument, rLibName));
667 return it != m_aMap.end() ? &it->second : nullptr;
668}
669
670LibInfo::Key::Key (ScriptDocument const& rDocument, OUString const& rLibName) :
671 m_aDocument(rDocument), m_aLibName(rLibName)
672{ }
673
674bool LibInfo::Key::operator == (Key const& rKey) const
675{
676 return m_aDocument == rKey.m_aDocument && m_aLibName == rKey.m_aLibName;
677}
678
679size_t LibInfo::Key::Hash::operator () (Key const& rKey) const
680{
681 std::size_t seed = 0;
682 boost::hash_combine(seed, rKey.m_aDocument.hashCode());
683 boost::hash_combine(seed, rKey.m_aLibName.hashCode());
684 return seed;
685}
686
687LibInfo::Item::Item (
688 OUString const& rCurrentName,
689 ItemType eCurrentType
690) :
691 m_aCurrentName(rCurrentName),
692 m_eCurrentType(eCurrentType)
693{ }
694
695static bool QueryDel(const OUString& rName, const OUString &rStr, weld::Widget* pParent)
696{
697 OUString aName = "\'" + rName + "\'";
698 OUString aQuery = rStr.replaceAll("XX", aName);
699 std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(pParent,
700 VclMessageType::Question, VclButtonsType::YesNo, aQuery));
701 return (xQueryBox->run() == RET_YES);
702}
703
704bool QueryDelMacro( const OUString& rName, weld::Widget* pParent )
705{
706 return QueryDel( rName, IDEResId( RID_STR_QUERYDELMACROreinterpret_cast<char const *>("RID_STR_QUERYDELMACRO" "\004"
u8"Do you want to delete the macro XX?")
), pParent );
707}
708
709bool QueryReplaceMacro( const OUString& rName, weld::Widget* pParent )
710{
711 return QueryDel( rName, IDEResId( RID_STR_QUERYREPLACEMACROreinterpret_cast<char const *>("RID_STR_QUERYREPLACEMACRO"
"\004" u8"Do you want to overwrite the XX macro?")
), pParent );
712}
713
714bool QueryDelDialog( const OUString& rName, weld::Widget* pParent )
715{
716 return QueryDel( rName, IDEResId( RID_STR_QUERYDELDIALOGreinterpret_cast<char const *>("RID_STR_QUERYDELDIALOG"
"\004" u8"Do you want to delete the XX dialog?")
), pParent );
717}
718
719bool QueryDelLib( const OUString& rName, bool bRef, weld::Widget* pParent )
720{
721 return QueryDel( rName, IDEResId( bRef ? RID_STR_QUERYDELLIBREFreinterpret_cast<char const *>("RID_STR_QUERYDELLIBREF"
"\004" u8"Do you want to delete the reference to the XX library?"
)
: RID_STR_QUERYDELLIBreinterpret_cast<char const *>("RID_STR_QUERYDELLIB" "\004"
u8"Do you want to delete the XX library?")
), pParent );
722}
723
724bool QueryDelModule( const OUString& rName, weld::Widget* pParent )
725{
726 return QueryDel( rName, IDEResId( RID_STR_QUERYDELMODULEreinterpret_cast<char const *>("RID_STR_QUERYDELMODULE"
"\004" u8"Do you want to delete the XX module?")
), pParent );
727}
728
729bool QueryPassword(weld::Widget* pDialogParent, const Reference< script::XLibraryContainer >& xLibContainer, const OUString& rLibName, OUString& rPassword, bool bRepeat, bool bNewTitle)
730{
731 bool bOK = false;
732 sal_uInt16 nRet = 0;
733
734 do
735 {
736 // password dialog
737 SfxPasswordDialog aDlg(pDialogParent);
738 aDlg.SetMinLen(1);
739
740 // set new title
741 if ( bNewTitle )
742 {
743 OUString aTitle(IDEResId(RID_STR_ENTERPASSWORDreinterpret_cast<char const *>("RID_STR_ENTERPASSWORD" "\004"
u8"Enter password for 'XX'")
));
744 aTitle = aTitle.replaceAll("XX", rLibName);
745 aDlg.set_title(aTitle);
746 }
747
748 // execute dialog
749 nRet = aDlg.run();
750
751 // verify password
752 if ( nRet == RET_OK )
753 {
754 if ( xLibContainer.is() && xLibContainer->hasByName( rLibName ) )
755 {
756 Reference< script::XLibraryContainerPassword > xPasswd( xLibContainer, UNO_QUERY );
757 if ( xPasswd.is() && xPasswd->isLibraryPasswordProtected( rLibName ) && !xPasswd->isLibraryPasswordVerified( rLibName ) )
758 {
759 rPassword = aDlg.GetPassword();
760 bOK = xPasswd->verifyLibraryPassword( rLibName, rPassword );
761
762 if ( !bOK )
763 {
764 std::unique_ptr<weld::MessageDialog> xErrorBox(Application::CreateMessageDialog(pDialogParent,
765 VclMessageType::Warning, VclButtonsType::Ok, IDEResId(RID_STR_WRONGPASSWORDreinterpret_cast<char const *>("RID_STR_WRONGPASSWORD" "\004"
u8"Incorrect Password")
)));
766 xErrorBox->run();
767 }
768 }
769 }
770 }
771 }
772 while ( bRepeat && !bOK && nRet == RET_OK );
773
774 return bOK;
775}
776
777
778} // namespace basctl
779
780/* 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 );
2
Memory is allocated
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
15
Calling 'Reference::get'
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

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