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 menubarwindow.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/glm -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/libmount -isystem /usr/include/blkid -isystem /usr/include/cairo -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/pixman-1 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/libxml2 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D VCL_DLLIMPLEMENTATION -D DLLIMPLEMENTATION_UITEST -D CUI_DLL_NAME="libcuilo.so" -D DESKTOP_DETECTOR_DLL_NAME="libdesktop_detectorlo.so" -D TK_DLL_NAME="libtklo.so" -D SYSTEM_ZLIB -D GLM_FORCE_CTOR_INIT -D SK_USER_CONFIG_HEADER=</home/maarten/src/libreoffice/core/config_host/config_skia.h> -D SKIA_DLL -D ENABLE_CUPS -D HAVE_VALGRIND_HEADERS -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/core -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/effects -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/config -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/ports -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/third_party/vulkan -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/tools/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia -I /home/maarten/src/libreoffice/core/external/skia/inc/ -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/lcms2/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/harfbuzz/src -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/graphite/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium/public -D COMPONENT_BUILD -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libpng -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libjpeg-turbo -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/vcl/inc -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/libxml2 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx

/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.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 "menubarwindow.hxx"
21#include "menuitemlist.hxx"
22#include "menufloatingwindow.hxx"
23
24#include <vcl/dockingarea.hxx>
25#include <vcl/settings.hxx>
26#include <vcl/taskpanelist.hxx>
27#include <sal/log.hxx>
28
29#include <salframe.hxx>
30#include <salmenu.hxx>
31#include <svdata.hxx>
32#include <strings.hrc>
33#include <bitmaps.hlst>
34#include <window.h>
35#include "bufferdevice.hxx"
36
37// document closing button
38#define IID_DOCUMENTCLOSE1 1
39
40DecoToolBox::DecoToolBox( vcl::Window* pParent ) :
41 ToolBox( pParent, 0 ),
42 lastSize(-1)
43{
44 calcMinSize();
45}
46
47void DecoToolBox::DataChanged( const DataChangedEvent& rDCEvt )
48{
49 Window::DataChanged( rDCEvt );
50
51 if ( rDCEvt.GetFlags() & AllSettingsFlags::STYLE )
52 {
53 calcMinSize();
54 SetBackground();
55 SetImages( 0, true);
56 }
57}
58
59void DecoToolBox::calcMinSize()
60{
61 ScopedVclPtrInstance<ToolBox> aTbx( GetParent() );
62 if( GetItemCount() == 0 )
63 {
64 aTbx->InsertItem(IID_DOCUMENTCLOSE1, Image(StockImage::Yes, SV_RESID_BITMAP_CLOSEDOC"vcl/res/closedoc.png"));
65 }
66 else
67 {
68 ImplToolItems::size_type nItems = GetItemCount();
69 for( ImplToolItems::size_type i = 0; i < nItems; i++ )
70 {
71 sal_uInt16 nId = GetItemId( i );
72 aTbx->InsertItem( nId, GetItemImage( nId ) );
73 }
74 }
75 aTbx->SetOutStyle( TOOLBOX_STYLE_FLAT );
76 maMinSize = aTbx->CalcWindowSizePixel();
77
78 aTbx.disposeAndClear();
79}
80
81void DecoToolBox::SetImages( long nMaxHeight, bool bForce )
82{
83 long border = getMinSize().Height() - maImage.GetSizePixel().Height();
84
85 if( !nMaxHeight && lastSize != -1 )
86 nMaxHeight = lastSize + border; // don't change anything if called with 0
87
88 if( nMaxHeight < getMinSize().Height() )
89 nMaxHeight = getMinSize().Height();
90
91 if( (lastSize == nMaxHeight - border) && !bForce )
92 return;
93
94 lastSize = nMaxHeight - border;
95
96 Color aEraseColor( 255, 255, 255, 255 );
97 BitmapEx aBmpExDst( maImage.GetBitmapEx() );
98 BitmapEx aBmpExSrc( aBmpExDst );
99
100 aEraseColor.SetTransparency( 255 );
101 aBmpExDst.Erase( aEraseColor );
102 aBmpExDst.Scale( Size( lastSize, lastSize ) );
103
104 tools::Rectangle aSrcRect( Point(0,0), maImage.GetSizePixel() );
105 tools::Rectangle aDestRect( Point((lastSize - maImage.GetSizePixel().Width())/2,
106 (lastSize - maImage.GetSizePixel().Height())/2 ),
107 maImage.GetSizePixel() );
108
109 aBmpExDst.CopyPixel( aDestRect, aSrcRect, &aBmpExSrc );
110 SetItemImage( IID_DOCUMENTCLOSE1, Image( aBmpExDst ) );
111
112}
113
114MenuBarWindow::MenuBarWindow( vcl::Window* pParent ) :
115 Window( pParent, 0 ),
116 m_aCloseBtn(VclPtr<DecoToolBox>::Create(this)),
117 m_aFloatBtn(VclPtr<PushButton>::Create(this, WB_NOPOINTERFOCUS | WB_SMALLSTYLE | WB_RECTSTYLE)),
118 m_aHideBtn(VclPtr<PushButton>::Create(this, WB_NOPOINTERFOCUS | WB_SMALLSTYLE | WB_RECTSTYLE))
119{
120 SetType(WindowType::MENUBARWINDOW);
121 m_pMenu = nullptr;
122 m_pActivePopup = nullptr;
123 m_nHighlightedItem = ITEMPOS_INVALID;
124 m_nRolloveredItem = ITEMPOS_INVALID;
125 mbAutoPopup = true;
126 m_bIgnoreFirstMove = true;
127 SetMBWHideAccel(true);
128 SetMBWMenuKey(false);
129
130 m_aCloseBtn->maImage = Image(StockImage::Yes, SV_RESID_BITMAP_CLOSEDOC"vcl/res/closedoc.png");
131
132 m_aCloseBtn->SetOutStyle(TOOLBOX_STYLE_FLAT);
133 m_aCloseBtn->SetBackground();
134 m_aCloseBtn->SetPaintTransparent(true);
135 m_aCloseBtn->SetParentClipMode(ParentClipMode::NoClip);
136
137 m_aCloseBtn->InsertItem(IID_DOCUMENTCLOSE1, m_aCloseBtn->maImage);
138 m_aCloseBtn->SetSelectHdl(LINK(this, MenuBarWindow, CloseHdl)::tools::detail::makeLink( ::tools::detail::castTo<MenuBarWindow
*>(this), &MenuBarWindow::LinkStubCloseHdl));
139 m_aCloseBtn->AddEventListener(LINK(this, MenuBarWindow, ToolboxEventHdl)::tools::detail::makeLink( ::tools::detail::castTo<MenuBarWindow
*>(this), &MenuBarWindow::LinkStubToolboxEventHdl));
140 m_aCloseBtn->SetQuickHelpText(IID_DOCUMENTCLOSE1, VclResId(SV_HELPTEXT_CLOSEDOCUMENTreinterpret_cast<char const *>("SV_HELPTEXT_CLOSEDOCUMENT"
"\004" u8"Close Document")));
141
142 m_aFloatBtn->SetSymbol( SymbolType::FLOAT );
143 m_aFloatBtn->SetQuickHelpText(VclResId(SV_HELPTEXT_RESTOREreinterpret_cast<char const *>("SV_HELPTEXT_RESTORE" "\004"
u8"Restore")));
144
145 m_aHideBtn->SetSymbol( SymbolType::HIDE );
146 m_aHideBtn->SetQuickHelpText(VclResId(SV_HELPTEXT_MINIMIZEreinterpret_cast<char const *>("SV_HELPTEXT_MINIMIZE" "\004"
u8"Minimize")));
147
148 ImplInitStyleSettings();
149
150 AddEventListener(LINK(this, MenuBarWindow, ShowHideListener)::tools::detail::makeLink( ::tools::detail::castTo<MenuBarWindow
*>(this), &MenuBarWindow::LinkStubShowHideListener));
151}
152
153MenuBarWindow::~MenuBarWindow()
154{
155 disposeOnce();
156}
157
158void MenuBarWindow::dispose()
159{
160 m_aCloseBtn->RemoveEventListener(LINK(this, MenuBarWindow, ToolboxEventHdl)::tools::detail::makeLink( ::tools::detail::castTo<MenuBarWindow
*>(this), &MenuBarWindow::LinkStubToolboxEventHdl));
161 RemoveEventListener(LINK(this, MenuBarWindow, ShowHideListener)::tools::detail::makeLink( ::tools::detail::castTo<MenuBarWindow
*>(this), &MenuBarWindow::LinkStubShowHideListener));
162
163 mpParentPopup.disposeAndClear();
164 m_aHideBtn.disposeAndClear();
165 m_aFloatBtn.disposeAndClear();
166 m_aCloseBtn.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
167 m_pMenu.clear();
168 m_pActivePopup.clear();
169 m_xSaveFocusId.clear();
170
171 Window::dispose();
172}
173
174void MenuBarWindow::SetMenu( MenuBar* pMen )
175{
176 m_pMenu = pMen;
177 KillActivePopup();
178 m_nHighlightedItem = ITEMPOS_INVALID;
179 if (pMen)
180 {
181 m_aCloseBtn->ShowItem(IID_DOCUMENTCLOSE1, pMen->HasCloseButton());
182 m_aCloseBtn->Show(pMen->HasCloseButton() || !m_aAddButtons.empty());
183 m_aFloatBtn->Show(pMen->HasFloatButton());
184 m_aHideBtn->Show(pMen->HasHideButton());
185 }
186 Invalidate();
187
188 // show and connect native menubar
189 if( m_pMenu && m_pMenu->ImplGetSalMenu() )
190 {
191 if( m_pMenu->ImplGetSalMenu()->VisibleMenuBar() )
192 ImplGetFrame()->SetMenu( m_pMenu->ImplGetSalMenu() );
193
194 m_pMenu->ImplGetSalMenu()->SetFrame( ImplGetFrame() );
195 }
196}
197
198void MenuBarWindow::SetHeight(long nHeight)
199{
200 setPosSizePixel(0, 0, 0, nHeight, PosSizeFlags::Height);
201}
202
203void MenuBarWindow::ShowButtons( bool bClose, bool bFloat, bool bHide )
204{
205 m_aCloseBtn->ShowItem(IID_DOCUMENTCLOSE1, bClose);
206 m_aCloseBtn->Show(bClose || !m_aAddButtons.empty());
207 if (m_pMenu->mpSalMenu)
208 m_pMenu->mpSalMenu->ShowCloseButton(bClose);
209 m_aFloatBtn->Show( bFloat );
210 m_aHideBtn->Show( bHide );
211 Resize();
212}
213
214Size const & MenuBarWindow::MinCloseButtonSize()
215{
216 return m_aCloseBtn->getMinSize();
217}
218
219IMPL_LINK_NOARG(MenuBarWindow, CloseHdl, ToolBox *, void)void MenuBarWindow::LinkStubCloseHdl(void * instance, ToolBox
* data) { return static_cast<MenuBarWindow *>(instance
)->CloseHdl(data); } void MenuBarWindow::CloseHdl(__attribute__
((unused)) ToolBox *)
220{
221 if( ! m_pMenu )
222 return;
223
224 if( m_aCloseBtn->GetCurItemId() == IID_DOCUMENTCLOSE1 )
225 {
226 // #i106052# call close hdl asynchronously to ease handler implementation
227 // this avoids still being in the handler while the DecoToolBox already
228 // gets destroyed
229 Application::PostUserEvent(static_cast<MenuBar*>(m_pMenu.get())->GetCloseButtonClickHdl());
230 }
231 else
232 {
233 std::map<sal_uInt16,AddButtonEntry>::iterator it = m_aAddButtons.find(m_aCloseBtn->GetCurItemId());
234 if( it != m_aAddButtons.end() )
235 {
236 MenuBar::MenuBarButtonCallbackArg aArg;
237 aArg.nId = it->first;
238 aArg.bHighlight = (m_aCloseBtn->GetHighlightItemId() == it->first);
239 it->second.m_aSelectLink.Call( aArg );
240 }
241 }
242}
243
244IMPL_LINK( MenuBarWindow, ToolboxEventHdl, VclWindowEvent&, rEvent, void )void MenuBarWindow::LinkStubToolboxEventHdl(void * instance, VclWindowEvent
& data) { return static_cast<MenuBarWindow *>(instance
)->ToolboxEventHdl(data); } void MenuBarWindow::ToolboxEventHdl
(VclWindowEvent& rEvent)
245{
246 if( ! m_pMenu )
247 return;
248
249 MenuBar::MenuBarButtonCallbackArg aArg;
250 aArg.nId = 0xffff;
251 aArg.bHighlight = (rEvent.GetId() == VclEventId::ToolboxHighlight);
252 if( rEvent.GetId() == VclEventId::ToolboxHighlight )
253 aArg.nId = m_aCloseBtn->GetHighlightItemId();
254 else if( rEvent.GetId() == VclEventId::ToolboxHighlightOff )
255 {
256 auto nPos = static_cast<ToolBox::ImplToolItems::size_type>(reinterpret_cast<sal_IntPtr>(rEvent.GetData()));
257 aArg.nId = m_aCloseBtn->GetItemId(nPos);
258 }
259 std::map< sal_uInt16, AddButtonEntry >::iterator it = m_aAddButtons.find( aArg.nId );
260 if( it != m_aAddButtons.end() )
261 {
262 it->second.m_aHighlightLink.Call( aArg );
263 }
264}
265
266IMPL_LINK( MenuBarWindow, ShowHideListener, VclWindowEvent&, rEvent, void )void MenuBarWindow::LinkStubShowHideListener(void * instance,
VclWindowEvent& data) { return static_cast<MenuBarWindow
*>(instance)->ShowHideListener(data); } void MenuBarWindow
::ShowHideListener(VclWindowEvent& rEvent)
267{
268 if( ! m_pMenu )
269 return;
270
271 if( rEvent.GetId() == VclEventId::WindowShow )
272 m_pMenu->ImplCallEventListeners( VclEventId::MenuShow, ITEMPOS_INVALID );
273 else if( rEvent.GetId() == VclEventId::WindowHide )
274 m_pMenu->ImplCallEventListeners( VclEventId::MenuHide, ITEMPOS_INVALID );
275}
276
277void MenuBarWindow::ImplCreatePopup( bool bPreSelectFirst )
278{
279 MenuItemData* pItemData = m_pMenu ? m_pMenu->GetItemList()->GetDataFromPos( m_nHighlightedItem ) : nullptr;
280 if ( !pItemData )
281 return;
282
283 m_bIgnoreFirstMove = true;
284 if ( m_pActivePopup && ( m_pActivePopup != pItemData->pSubMenu ) )
285 {
286 KillActivePopup();
287 }
288 if ( !(pItemData->bEnabled && pItemData->pSubMenu && ( m_nHighlightedItem != ITEMPOS_INVALID ) &&
289 ( pItemData->pSubMenu != m_pActivePopup )) )
290 return;
291
292 m_pActivePopup = static_cast<PopupMenu*>(pItemData->pSubMenu.get());
293 long nX = 0;
294 MenuItemData* pData = nullptr;
295 for ( sal_uLong n = 0; n < m_nHighlightedItem; n++ )
296 {
297 pData = m_pMenu->GetItemList()->GetDataFromPos( n );
298 nX += pData->aSz.Width();
299 }
300 pData = m_pMenu->pItemList->GetDataFromPos( m_nHighlightedItem );
301 Point aItemTopLeft( nX, 0 );
302 Point aItemBottomRight( aItemTopLeft );
303 aItemBottomRight.AdjustX(pData->aSz.Width() );
304
305 if (pData->bHiddenOnGUI)
306 {
307 mpParentPopup.disposeAndClear();
308 mpParentPopup = VclPtr<PopupMenu>::Create();
309 m_pActivePopup = mpParentPopup.get();
310
311 for (sal_uInt16 i = m_nHighlightedItem; i < m_pMenu->GetItemCount(); ++i)
312 {
313 sal_uInt16 nId = m_pMenu->GetItemId(i);
314
315 MenuItemData* pParentItemData = m_pMenu->GetItemList()->GetData(nId);
316 assert(pParentItemData)(static_cast <bool> (pParentItemData) ? void (0) : __assert_fail
("pParentItemData", "/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
, 316, __extension__ __PRETTY_FUNCTION__));
317 mpParentPopup->InsertItem(nId, pParentItemData->aText, pParentItemData->nBits, pParentItemData->sIdent);
318 mpParentPopup->SetHelpId(nId, pParentItemData->aHelpId);
319 mpParentPopup->SetHelpText(nId, pParentItemData->aHelpText);
320 mpParentPopup->SetAccelKey(nId, pParentItemData->aAccelKey);
321 mpParentPopup->SetItemCommand(nId, pParentItemData->aCommandStr);
322 mpParentPopup->SetHelpCommand(nId, pParentItemData->aHelpCommandStr);
323
324 PopupMenu* pPopup = m_pMenu->GetPopupMenu(nId);
325 mpParentPopup->SetPopupMenu(nId, pPopup);
326 }
327 }
328 // the menu bar could have height 0 in fullscreen mode:
329 // so do not use always WindowHeight, as ItemHeight < WindowHeight.
330 if ( GetSizePixel().Height() )
331 {
332 // #107747# give menuitems the height of the menubar
333 aItemBottomRight.AdjustY(GetOutputSizePixel().Height()-1 );
334 }
335
336 // ImplExecute is not modal...
337 // #99071# do not grab the focus, otherwise it will be restored to the menubar
338 // when the frame is reactivated later
339 //GrabFocus();
340 m_pActivePopup->ImplExecute( this, tools::Rectangle( aItemTopLeft, aItemBottomRight ), FloatWinPopupFlags::Down | FloatWinPopupFlags::NoHorzPlacement, m_pMenu, bPreSelectFirst );
341 // does not have a window, if aborted before or if there are no entries
342 if ( m_pActivePopup->ImplGetFloatingWindow() )
343 m_pActivePopup->ImplGetFloatingWindow()->AddPopupModeWindow( this );
344 else
345 m_pActivePopup = nullptr;
346}
347
348void MenuBarWindow::KillActivePopup()
349{
350 if ( !m_pActivePopup )
351 return;
352
353 if( m_pActivePopup->pWindow )
354 if( static_cast<FloatingWindow *>(m_pActivePopup->pWindow.get())->IsInCleanUp() )
355 return; // kill it later
356
357 if ( m_pActivePopup->bInCallback )
358 m_pActivePopup->bCanceled = true;
359
360 m_pActivePopup->bInCallback = true;
361 m_pActivePopup->Deactivate();
362 m_pActivePopup->bInCallback = false;
363 // check for pActivePopup, if stopped by deactivate...
364 if ( m_pActivePopup->ImplGetWindow() )
365 {
366 if (mpParentPopup)
367 {
368 for (sal_uInt16 i = 0; i < mpParentPopup->GetItemCount(); ++i)
369 {
370 sal_uInt16 nId = mpParentPopup->GetItemId(i);
371 MenuItemData* pParentItemData = mpParentPopup->GetItemList()->GetData(nId);
372 assert(pParentItemData)(static_cast <bool> (pParentItemData) ? void (0) : __assert_fail
("pParentItemData", "/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
, 372, __extension__ __PRETTY_FUNCTION__));
373 pParentItemData->pSubMenu = nullptr;
374 }
375 }
376 m_pActivePopup->ImplGetFloatingWindow()->StopExecute();
377 m_pActivePopup->ImplGetFloatingWindow()->doShutdown();
378 m_pActivePopup->pWindow->SetParentToDefaultWindow();
379 m_pActivePopup->pWindow.disposeAndClear();
380 }
381 m_pActivePopup = nullptr;
382}
383
384void MenuBarWindow::PopupClosed( Menu const * pPopup )
385{
386 if ( pPopup == m_pActivePopup )
387 {
388 KillActivePopup();
389 ChangeHighlightItem( ITEMPOS_INVALID, false, ImplGetFrameWindow()->ImplGetFrameData()->mbHasFocus, false );
390 }
391}
392
393void MenuBarWindow::MouseButtonDown( const MouseEvent& rMEvt )
394{
395 mbAutoPopup = true;
396 SetMBWMenuKey(false);
397 sal_uInt16 nEntry = ImplFindEntry( rMEvt.GetPosPixel() );
398 if ( ( nEntry != ITEMPOS_INVALID ) && !m_pActivePopup )
399 {
400 ChangeHighlightItem( nEntry, false );
401 }
402 else
403 {
404 KillActivePopup();
405 ChangeHighlightItem( ITEMPOS_INVALID, false );
406 }
407}
408
409void MenuBarWindow::MouseButtonUp( const MouseEvent& )
410{
411}
412
413void MenuBarWindow::MouseMove( const MouseEvent& rMEvt )
414{
415 if ( rMEvt.IsSynthetic() || rMEvt.IsEnterWindow() )
416 return;
417
418 if ( rMEvt.IsLeaveWindow() )
419 {
420 if ( m_nRolloveredItem != ITEMPOS_INVALID && m_nRolloveredItem != m_nHighlightedItem )
421 {
422 // there is a spurious MouseMove generated after a menu is launched from the keyboard, hence this...
423 if (m_nHighlightedItem != ITEMPOS_INVALID)
424 {
425 bool hide = GetMBWHideAccel();
426 SetMBWHideAccel(true);
427 Invalidate(); //HighlightItem( nRolloveredItem, false );
428 SetMBWHideAccel(hide);
429 }
430 else
431 Invalidate(); //HighlightItem( nRolloveredItem, false );
432 }
433
434 m_nRolloveredItem = ITEMPOS_INVALID;
435 return;
436 }
437
438 sal_uInt16 nEntry = ImplFindEntry( rMEvt.GetPosPixel() );
439 if ( m_nHighlightedItem == ITEMPOS_INVALID )
440 {
441 if ( m_nRolloveredItem != nEntry )
442 {
443 if ( m_nRolloveredItem != ITEMPOS_INVALID )
444 Invalidate(); //HighlightItem( nRolloveredItem, false );
445
446 m_nRolloveredItem = nEntry;
447 Invalidate(); //HighlightItem( nRolloveredItem, true );
448 }
449 return;
450 }
451 m_nRolloveredItem = nEntry;
452
453 if( m_bIgnoreFirstMove )
454 {
455 m_bIgnoreFirstMove = false;
456 return;
457 }
458
459 if ( ( nEntry != ITEMPOS_INVALID )
460 && ( nEntry != m_nHighlightedItem ) )
461 ChangeHighlightItem( nEntry, false );
462}
463
464void MenuBarWindow::ChangeHighlightItem( sal_uInt16 n, bool bSelectEntry, bool bAllowRestoreFocus, bool bDefaultToDocument)
465{
466 if( ! m_pMenu )
467 return;
468
469 // always hide accelerators when updating the menu bar...
470 SetMBWHideAccel(true);
471
472 // #57934# close active popup if applicable, as TH's background storage works.
473 MenuItemData* pNextData = m_pMenu->pItemList->GetDataFromPos( n );
474 if ( m_pActivePopup && m_pActivePopup->ImplGetWindow() && ( !pNextData || ( m_pActivePopup != pNextData->pSubMenu ) ) )
475 KillActivePopup(); // pActivePopup when applicable without pWin, if Rescheduled in Activate()
476
477 // activate menubar only ones per cycle...
478 bool bJustActivated = false;
479 if ( ( m_nHighlightedItem == ITEMPOS_INVALID ) && ( n != ITEMPOS_INVALID ) )
480 {
481 ImplGetSVData()->mpWinData->mbNoDeactivate = true;
482 // #105406# avoid saving the focus when we already have the focus
483 bool bNoSaveFocus = (this == ImplGetSVData()->mpWinData->mpFocusWin.get());
484
485 if( m_xSaveFocusId != nullptr )
486 {
487 if (!ImplGetSVData()->mpWinData->mbNoSaveFocus)
488 {
489 m_xSaveFocusId = nullptr;
490 if( !bNoSaveFocus )
491 m_xSaveFocusId = Window::SaveFocus(); // only save focus when initially activated
492 }
493 else {
494 ; // do nothing: we 're activated again from taskpanelist, focus was already saved
495 }
496 }
497 else
498 {
499 if( !bNoSaveFocus )
500 m_xSaveFocusId = Window::SaveFocus(); // only save focus when initially activated
501 }
502 m_pMenu->bInCallback = true; // set here if Activate overridden
503 m_pMenu->Activate();
504 m_pMenu->bInCallback = false;
505 bJustActivated = true;
506 }
507 else if ( ( m_nHighlightedItem != ITEMPOS_INVALID ) && ( n == ITEMPOS_INVALID ) )
508 {
509 m_pMenu->bInCallback = true;
510 m_pMenu->Deactivate();
511 m_pMenu->bInCallback = false;
512 ImplGetSVData()->mpWinData->mbNoDeactivate = false;
513 if (!ImplGetSVData()->mpWinData->mbNoSaveFocus)
514 {
515 VclPtr<vcl::Window> xTempFocusId;
516 if (m_xSaveFocusId && !m_xSaveFocusId->isDisposed())
517 xTempFocusId = m_xSaveFocusId;
518 m_xSaveFocusId = nullptr;
519
520 if (bAllowRestoreFocus)
521 {
522 // tdf#115227 the popup is already killed, so temporarily set us as the
523 // focus window, so we could avoid sending superfluous activate events
524 // to top window listeners.
525 if (xTempFocusId || bDefaultToDocument)
526 ImplGetSVData()->mpWinData->mpFocusWin = this;
527
528 // #105406# restore focus to document if we could not save focus before
529 if (!xTempFocusId && bDefaultToDocument)
530 GrabFocusToDocument();
531 else
532 Window::EndSaveFocus(xTempFocusId);
533 }
534 }
535 }
536
537 if ( m_nHighlightedItem != ITEMPOS_INVALID )
538 {
539 if ( m_nHighlightedItem != m_nRolloveredItem )
540 Invalidate(); //HighlightItem( nHighlightedItem, false );
541
542 m_pMenu->ImplCallEventListeners( VclEventId::MenuDehighlight, m_nHighlightedItem );
543 }
544
545 m_nHighlightedItem = n;
546 SAL_WARN_IF( ( m_nHighlightedItem != ITEMPOS_INVALID ) && !m_pMenu->ImplIsVisible( m_nHighlightedItem ), "vcl", "ChangeHighlightItem: Not visible!" )do { if (true && (( m_nHighlightedItem != ITEMPOS_INVALID
) && !m_pMenu->ImplIsVisible( m_nHighlightedItem )
)) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "vcl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case SAL_DETAIL_LOG_ACTION_LOG
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "ChangeHighlightItem: Not visible!") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "546" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "ChangeHighlightItem: Not visible!"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "ChangeHighlightItem: Not visible!"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "546" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "ChangeHighlightItem: Not visible!") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "546" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "ChangeHighlightItem: Not visible!"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "ChangeHighlightItem: Not visible!"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "546" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
547 if ( m_nHighlightedItem != ITEMPOS_INVALID )
548 Invalidate(); //HighlightItem( nHighlightedItem, true );
549 else if ( m_nRolloveredItem != ITEMPOS_INVALID )
550 Invalidate(); //HighlightItem( nRolloveredItem, true );
551 m_pMenu->ImplCallHighlight(m_nHighlightedItem);
552
553 if( mbAutoPopup )
554 ImplCreatePopup( bSelectEntry );
555
556 // #58935# #73659# Focus, if no popup underneath...
557 if ( bJustActivated && !m_pActivePopup )
558 GrabFocus();
559}
560
561static int ImplGetTopDockingAreaHeight( vcl::Window const *pWindow )
562{
563 // find docking area that is top aligned and return its height
564 // note: dockingareas are direct children of the SystemWindow
565 if( pWindow->ImplGetFrameWindow() )
566 {
567 vcl::Window *pWin = pWindow->ImplGetFrameWindow()->GetWindow( GetWindowType::FirstChild ); //mpWindowImpl->mpFirstChild;
568 while( pWin )
569 {
570 if( pWin->IsSystemWindow() )
571 {
572 vcl::Window *pChildWin = pWin->GetWindow( GetWindowType::FirstChild ); //mpWindowImpl->mpFirstChild;
573 while( pChildWin )
574 {
575 DockingAreaWindow *pDockingArea = nullptr;
576 if ( pChildWin->GetType() == WindowType::DOCKINGAREA )
577 pDockingArea = static_cast< DockingAreaWindow* >( pChildWin );
578
579 if( pDockingArea && pDockingArea->GetAlign() == WindowAlign::Top &&
580 pDockingArea->IsVisible() && pDockingArea->GetOutputSizePixel().Height() != 0 )
581 {
582 return pDockingArea->GetOutputSizePixel().Height();
583 }
584
585 pChildWin = pChildWin->GetWindow( GetWindowType::Next ); //mpWindowImpl->mpNext;
586 }
587
588 }
589
590 pWin = pWin->GetWindow( GetWindowType::Next ); //mpWindowImpl->mpNext;
591 }
592 }
593 return 0;
594}
595
596static void ImplAddNWFSeparator(vcl::RenderContext& rRenderContext, const Size& rSize, const MenubarValue& rMenubarValue)
597{
598 // add a separator if
599 // - we have an adjacent docking area
600 // - and if toolbars would draw them as well (mbDockingAreaSeparateTB must not be set, see dockingarea.cxx)
601 if (rMenubarValue.maTopDockingAreaHeight
602 && !ImplGetSVData()->maNWFData.mbDockingAreaSeparateTB
603 && !ImplGetSVData()->maNWFData.mbDockingAreaAvoidTBFrames)
604 {
605 // note: the menubar only provides the upper (dark) half of it, the rest (bright part) is drawn by the docking area
606
607 rRenderContext.SetLineColor(rRenderContext.GetSettings().GetStyleSettings().GetSeparatorColor());
608 tools::Rectangle aRect(Point(), rSize);
609 rRenderContext.DrawLine(aRect.BottomLeft(), aRect.BottomRight());
610 }
611}
612
613void MenuBarWindow::HighlightItem(vcl::RenderContext& rRenderContext, sal_uInt16 nPos)
614{
615 if (!m_pMenu)
616 return;
617
618 long nX = 0;
619 size_t nCount = m_pMenu->pItemList->size();
620
621 Size aOutputSize = GetOutputSizePixel();
622 aOutputSize.AdjustWidth( -(m_aCloseBtn->GetSizePixel().Width()) );
623
624 for (size_t n = 0; n < nCount; n++)
625 {
626 MenuItemData* pData = m_pMenu->pItemList->GetDataFromPos( n );
627 if (n == nPos)
628 {
629 if (pData->eType != MenuItemType::SEPARATOR)
630 {
631 // #107747# give menuitems the height of the menubar
632 tools::Rectangle aRect(Point(nX, 1), Size(pData->aSz.Width(), aOutputSize.Height() - 2));
633 rRenderContext.Push(PushFlags::CLIPREGION);
634 rRenderContext.IntersectClipRegion(aRect);
635 bool bRollover, bHighlight;
636 if (!ImplGetSVData()->maNWFData.mbRolloverMenubar)
637 {
638 bHighlight = true;
639 bRollover = nPos != m_nHighlightedItem;
640 }
641 else
642 {
643 bRollover = nPos == m_nRolloveredItem;
644 bHighlight = nPos == m_nHighlightedItem;
645 }
646 if (rRenderContext.IsNativeControlSupported(ControlType::Menubar, ControlPart::MenuItem) &&
647 rRenderContext.IsNativeControlSupported(ControlType::Menubar, ControlPart::Entire))
648 {
649 // draw background (transparency)
650 MenubarValue aControlValue;
651 aControlValue.maTopDockingAreaHeight = ImplGetTopDockingAreaHeight( this );
652
653 if (!Application::GetSettings().GetStyleSettings().GetPersonaHeader().IsEmpty() )
654 Erase(rRenderContext);
655 else
656 {
657 tools::Rectangle aBgRegion(Point(), aOutputSize);
658 rRenderContext.DrawNativeControl(ControlType::Menubar, ControlPart::Entire, aBgRegion,
659 ControlState::ENABLED, aControlValue, OUString());
660 }
661
662 ImplAddNWFSeparator(rRenderContext, aOutputSize, aControlValue);
663
664 // draw selected item
665 ControlState nState = ControlState::ENABLED;
666 if (bRollover)
667 nState |= ControlState::ROLLOVER;
668 else
669 nState |= ControlState::SELECTED;
670 rRenderContext.DrawNativeControl(ControlType::Menubar, ControlPart::MenuItem,
671 aRect, nState, aControlValue, OUString() );
672 }
673 else
674 {
675 if (bRollover)
676 rRenderContext.SetFillColor(rRenderContext.GetSettings().GetStyleSettings().GetMenuBarRolloverColor());
677 else
678 rRenderContext.SetFillColor(rRenderContext.GetSettings().GetStyleSettings().GetMenuHighlightColor());
679 rRenderContext.SetLineColor();
680 rRenderContext.DrawRect(aRect);
681 }
682 rRenderContext.Pop();
683
684 m_pMenu->ImplPaint(rRenderContext, aOutputSize, 0, 0, pData, bHighlight, false, bRollover);
685 }
686 return;
687 }
688
689 nX += pData->aSz.Width();
690 }
691}
692
693tools::Rectangle MenuBarWindow::ImplGetItemRect( sal_uInt16 nPos )
694{
695 tools::Rectangle aRect;
696 if( m_pMenu )
697 {
698 long nX = 0;
699 size_t nCount = m_pMenu->pItemList->size();
700 for ( size_t n = 0; n < nCount; n++ )
701 {
702 MenuItemData* pData = m_pMenu->pItemList->GetDataFromPos( n );
703 if ( n == nPos )
704 {
705 if ( pData->eType != MenuItemType::SEPARATOR )
706 // #107747# give menuitems the height of the menubar
707 aRect = tools::Rectangle( Point( nX, 1 ), Size( pData->aSz.Width(), GetOutputSizePixel().Height()-2 ) );
708 break;
709 }
710
711 nX += pData->aSz.Width();
712 }
713 }
714 return aRect;
715}
716
717void MenuBarWindow::KeyInput( const KeyEvent& rKEvent )
718{
719 if ( !HandleKeyEvent( rKEvent ) )
720 Window::KeyInput( rKEvent );
721}
722
723bool MenuBarWindow::HandleKeyEvent( const KeyEvent& rKEvent, bool bFromMenu )
724{
725 if (!m_pMenu)
726 return false;
727
728 if (m_pMenu->bInCallback)
729 return true; // swallow
730
731 bool bDone = false;
732 sal_uInt16 nCode = rKEvent.GetKeyCode().GetCode();
733
734 if( GetParent() )
735 {
736 if( GetParent()->GetWindow( GetWindowType::Client )->IsSystemWindow() )
737 {
738 SystemWindow *pSysWin = static_cast<SystemWindow*>(GetParent()->GetWindow( GetWindowType::Client ));
739 if( pSysWin->GetTaskPaneList() )
740 if( pSysWin->GetTaskPaneList()->HandleKeyEvent( rKEvent ) )
741 return true;
742 }
743 }
744
745 // no key events if native menus
746 if (m_pMenu->ImplGetSalMenu() && m_pMenu->ImplGetSalMenu()->VisibleMenuBar())
747 {
748 return false;
749 }
750
751 if ( nCode == KEY_MENU && !rKEvent.GetKeyCode().IsShift() ) // only F10, not Shift-F10
752 {
753 mbAutoPopup = false;
754 if ( m_nHighlightedItem == ITEMPOS_INVALID )
755 {
756 ChangeHighlightItem( 0, false );
757 GrabFocus();
758 }
759 else
760 {
761 ChangeHighlightItem( ITEMPOS_INVALID, false );
762 m_xSaveFocusId = nullptr;
763 }
764 bDone = true;
765 }
766 else if ( bFromMenu )
767 {
768 if ( ( nCode == KEY_LEFT ) || ( nCode == KEY_RIGHT ) ||
769 ( nCode == KEY_HOME ) || ( nCode == KEY_END ) )
770 {
771 sal_uInt16 n = m_nHighlightedItem;
772 if ( n == ITEMPOS_INVALID )
773 {
774 if ( nCode == KEY_LEFT)
775 n = 0;
776 else
777 n = m_pMenu->GetItemCount()-1;
778 }
779
780 sal_uInt16 nLoop = n;
781
782 if( nCode == KEY_HOME )
783 { n = sal_uInt16(-1); nLoop = n+1; }
784 if( nCode == KEY_END )
785 { n = m_pMenu->GetItemCount(); nLoop = n-1; }
786
787 do
788 {
789 if ( nCode == KEY_LEFT || nCode == KEY_END )
790 {
791 if ( n )
792 n--;
793 else
794 n = m_pMenu->GetItemCount()-1;
795 }
796 if ( nCode == KEY_RIGHT || nCode == KEY_HOME )
797 {
798 n++;
799 if ( n >= m_pMenu->GetItemCount() )
800 n = 0;
801 }
802
803 MenuItemData* pData = m_pMenu->GetItemList()->GetDataFromPos( n );
804 if (pData->eType != MenuItemType::SEPARATOR &&
805 m_pMenu->ImplIsVisible(n) &&
806 !m_pMenu->ImplCurrentlyHiddenOnGUI(n))
807 {
808 ChangeHighlightItem( n, true );
809 break;
810 }
811 } while ( n != nLoop );
812 bDone = true;
813 }
814 else if ( nCode == KEY_RETURN )
815 {
816 if( m_pActivePopup ) KillActivePopup();
817 else
818 if ( !mbAutoPopup )
819 {
820 ImplCreatePopup( true );
821 mbAutoPopup = true;
822 }
823 bDone = true;
824 }
825 else if ( ( nCode == KEY_UP ) || ( nCode == KEY_DOWN ) )
826 {
827 if ( !mbAutoPopup )
828 {
829 ImplCreatePopup( true );
830 mbAutoPopup = true;
831 }
832 bDone = true;
833 }
834 else if ( nCode == KEY_ESCAPE || ( nCode == KEY_F6 && rKEvent.GetKeyCode().IsMod1() ) )
835 {
836 if( m_pActivePopup )
837 {
838 // hide the menu and remove the focus...
839 mbAutoPopup = false;
840 KillActivePopup();
841 }
842
843 ChangeHighlightItem( ITEMPOS_INVALID, false );
844
845 if( nCode == KEY_F6 && rKEvent.GetKeyCode().IsMod1() )
846 {
847 // put focus into document
848 GrabFocusToDocument();
849 }
850
851 bDone = true;
852 }
853 }
854
855 bool autoacc = ImplGetSVData()->maNWFData.mbAutoAccel;
856
857 if ( !bDone && ( bFromMenu || rKEvent.GetKeyCode().IsMod2() ) )
858 {
859 sal_Unicode nCharCode = rKEvent.GetCharCode();
860 if ( nCharCode )
861 {
862 size_t nEntry, nDuplicates;
863 MenuItemData* pData = m_pMenu->GetItemList()->SearchItem( nCharCode, rKEvent.GetKeyCode(), nEntry, nDuplicates, m_nHighlightedItem );
864 if ( pData && (nEntry != ITEMPOS_INVALID) )
865 {
866 mbAutoPopup = true;
867 ChangeHighlightItem( nEntry, true );
868 bDone = true;
869 }
870 }
871 }
872
873 const bool bShowAccels = nCode != KEY_ESCAPE;
874 if (GetMBWMenuKey() != bShowAccels)
875 {
876 SetMBWMenuKey(bShowAccels);
877 SetMBWHideAccel(!bShowAccels);
878 if (autoacc)
879 Invalidate(InvalidateFlags::Update);
880 }
881
882 return bDone;
883}
884
885void MenuBarWindow::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&)
886{
887 if (!m_pMenu)
888 return;
889
890 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
891
892 Size aOutputSize = GetOutputSizePixel();
893
894 // no VCL paint if native menus
895 if (m_pMenu->ImplGetSalMenu() && m_pMenu->ImplGetSalMenu()->VisibleMenuBar())
896 {
897 ImplGetFrame()->DrawMenuBar();
898 return;
899 }
900
901 // Make sure that all actual rendering happens in one go to avoid flicker.
902 vcl::BufferDevice pBuffer(this, rRenderContext);
903
904 if (rRenderContext.IsNativeControlSupported(ControlType::Menubar, ControlPart::Entire))
905 {
906 MenubarValue aMenubarValue;
907 aMenubarValue.maTopDockingAreaHeight = ImplGetTopDockingAreaHeight(this);
908
909 if (!rStyleSettings.GetPersonaHeader().IsEmpty())
910 Erase(*pBuffer);
911 else
912 {
913 tools::Rectangle aCtrlRegion( Point(), aOutputSize );
914
915 pBuffer->DrawNativeControl(ControlType::Menubar, ControlPart::Entire, aCtrlRegion,
916 ControlState::ENABLED, aMenubarValue, OUString());
917 }
918
919 ImplAddNWFSeparator(*pBuffer, aOutputSize, aMenubarValue);
920 }
921
922 // shrink the area of the buttons
923 aOutputSize.AdjustWidth( -(m_aCloseBtn->GetSizePixel().Width()) );
924
925 pBuffer->SetFillColor(rStyleSettings.GetMenuColor());
926 m_pMenu->ImplPaint(*pBuffer, aOutputSize, 0);
927
928 if (m_nHighlightedItem != ITEMPOS_INVALID && m_pMenu && !m_pMenu->GetItemList()->GetDataFromPos(m_nHighlightedItem)->bHiddenOnGUI)
929 HighlightItem(*pBuffer, m_nHighlightedItem);
930 else if (m_nRolloveredItem != ITEMPOS_INVALID)
931 HighlightItem(*pBuffer, m_nRolloveredItem);
932
933 // in high contrast mode draw a separating line on the lower edge
934 if (!rRenderContext.IsNativeControlSupported( ControlType::Menubar, ControlPart::Entire) &&
935 rStyleSettings.GetHighContrastMode())
936 {
937 pBuffer->Push(PushFlags::LINECOLOR | PushFlags::MAPMODE);
938 pBuffer->SetLineColor(COL_WHITE);
939 pBuffer->SetMapMode(MapMode(MapUnit::MapPixel));
940 Size aSize = GetSizePixel();
941 pBuffer->DrawLine(Point(0, aSize.Height() - 1),
942 Point(aSize.Width() - 1, aSize.Height() - 1));
943 pBuffer->Pop();
944 }
945}
946
947void MenuBarWindow::Resize()
948{
949 Size aOutSz = GetOutputSizePixel();
950 long n = aOutSz.Height()-4;
951 long nX = aOutSz.Width()-3;
952 long nY = 2;
953
954 if ( m_aCloseBtn->IsVisible() )
955 {
956 m_aCloseBtn->Hide();
957 m_aCloseBtn->SetImages(n);
958 Size aTbxSize( m_aCloseBtn->CalcWindowSizePixel() );
959 nX -= aTbxSize.Width();
960 long nTbxY = (aOutSz.Height() - aTbxSize.Height())/2;
961 m_aCloseBtn->setPosSizePixel(nX, nTbxY, aTbxSize.Width(), aTbxSize.Height());
962 nX -= 3;
963 m_aCloseBtn->Show();
964 }
965 if ( m_aFloatBtn->IsVisible() )
966 {
967 nX -= n;
968 m_aFloatBtn->setPosSizePixel( nX, nY, n, n );
969 }
970 if ( m_aHideBtn->IsVisible() )
971 {
972 nX -= n;
973 m_aHideBtn->setPosSizePixel( nX, nY, n, n );
974 }
975
976 m_aFloatBtn->SetSymbol( SymbolType::FLOAT );
977 m_aHideBtn->SetSymbol( SymbolType::HIDE );
978
979 Invalidate();
980}
981
982sal_uInt16 MenuBarWindow::ImplFindEntry( const Point& rMousePos ) const
983{
984 if( m_pMenu )
985 {
986 long nX = 0;
987 size_t nCount = m_pMenu->pItemList->size();
988 for ( size_t n = 0; n < nCount; n++ )
989 {
990 MenuItemData* pData = m_pMenu->pItemList->GetDataFromPos( n );
991 if ( m_pMenu->ImplIsVisible( n ) )
992 {
993 nX += pData->aSz.Width();
994 if ( nX > rMousePos.X() )
995 return static_cast<sal_uInt16>(n);
996 }
997 }
998 }
999 return ITEMPOS_INVALID;
1000}
1001
1002void MenuBarWindow::RequestHelp( const HelpEvent& rHEvt )
1003{
1004 sal_uInt16 nId = m_nHighlightedItem;
1005 if ( rHEvt.GetMode() & HelpEventMode::CONTEXT )
1006 ChangeHighlightItem( ITEMPOS_INVALID, true );
1007
1008 tools::Rectangle aHighlightRect( ImplGetItemRect( m_nHighlightedItem ) );
1009 if( !ImplHandleHelpEvent( this, m_pMenu, nId, rHEvt, aHighlightRect ) )
1010 Window::RequestHelp( rHEvt );
1011}
1012
1013void MenuBarWindow::StateChanged( StateChangedType nType )
1014{
1015 Window::StateChanged( nType );
1016
1017 if (nType == StateChangedType::ControlForeground ||
1018 nType == StateChangedType::ControlBackground)
1019 {
1020 ApplySettings(*this);
1021 Invalidate();
1022 }
1023 else if (nType == StateChangedType::Enable)
1024 {
1025 Invalidate();
1026 }
1027 else if(m_pMenu)
1028 {
1029 m_pMenu->ImplKillLayoutData();
1030 }
1031}
1032
1033void MenuBarWindow::LayoutChanged()
1034{
1035 if (!m_pMenu)
1036 return;
1037
1038 ApplySettings(*this);
1039
1040 // if the font was changed.
1041 long nHeight = m_pMenu->ImplCalcSize(this).Height();
1042
1043 // depending on the native implementation or the displayable flag
1044 // the menubar windows is suppressed (ie, height=0)
1045 if (!static_cast<MenuBar*>(m_pMenu.get())->IsDisplayable() ||
1046 (m_pMenu->ImplGetSalMenu() && m_pMenu->ImplGetSalMenu()->VisibleMenuBar()))
1047 {
1048 nHeight = 0;
1049 }
1050 setPosSizePixel(0, 0, 0, nHeight, PosSizeFlags::Height);
1051 GetParent()->Resize();
1052 Invalidate();
1053 Resize();
1054
1055 m_pMenu->ImplKillLayoutData();
1056}
1057
1058void MenuBarWindow::ApplySettings(vcl::RenderContext& rRenderContext)
1059{
1060 Window::ApplySettings(rRenderContext);
1061 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
1062
1063 SetPointFont(rRenderContext, rStyleSettings.GetMenuFont());
1064
1065 const BitmapEx& rPersonaBitmap = Application::GetSettings().GetStyleSettings().GetPersonaHeader();
1066 SalMenu *pNativeMenu = m_pMenu ? m_pMenu->ImplGetSalMenu() : nullptr;
1067 if (pNativeMenu)
1068 pNativeMenu->ApplyPersona();
1069 if (!rPersonaBitmap.IsEmpty())
1070 {
1071 Wallpaper aWallpaper(rPersonaBitmap);
1072 aWallpaper.SetStyle(WallpaperStyle::TopRight);
1073 aWallpaper.SetColor(Application::GetSettings().GetStyleSettings().GetWorkspaceColor());
1074
1075 rRenderContext.SetBackground(aWallpaper);
1076 SetPaintTransparent(false);
1077 SetParentClipMode();
1078 }
1079 else if (rRenderContext.IsNativeControlSupported(ControlType::Menubar, ControlPart::Entire))
1080 {
1081 rRenderContext.SetBackground(); // background will be drawn by NWF
1082 }
1083 else
1084 {
1085 Wallpaper aWallpaper;
1086 aWallpaper.SetStyle(WallpaperStyle::ApplicationGradient);
1087 rRenderContext.SetBackground(aWallpaper);
1088 SetPaintTransparent(false);
1089 SetParentClipMode();
1090 }
1091
1092 rRenderContext.SetTextColor(rStyleSettings.GetMenuBarTextColor());
1093 rRenderContext.SetTextFillColor();
1094 rRenderContext.SetLineColor();
1095}
1096
1097void MenuBarWindow::ImplInitStyleSettings()
1098{
1099 if (!(IsNativeControlSupported(ControlType::Menubar, ControlPart::MenuItem) &&
1100 IsNativeControlSupported(ControlType::Menubar, ControlPart::Entire)))
1101 return;
1102
1103 AllSettings aSettings(GetSettings());
1104 ImplGetFrame()->UpdateSettings(aSettings); // to update persona
1105 StyleSettings aStyle(aSettings.GetStyleSettings());
1106 Color aHighlightTextColor = ImplGetSVData()->maNWFData.maMenuBarHighlightTextColor;
1107 if (aHighlightTextColor != COL_TRANSPARENT)
1108 {
1109 aStyle.SetMenuHighlightTextColor(aHighlightTextColor);
1110 }
1111 aSettings.SetStyleSettings(aStyle);
1112 OutputDevice::SetSettings(aSettings);
1113}
1114
1115void MenuBarWindow::DataChanged( const DataChangedEvent& rDCEvt )
1116{
1117 Window::DataChanged( rDCEvt );
1118
1119 if ( (rDCEvt.GetType() == DataChangedEventType::FONTS) ||
1120 (rDCEvt.GetType() == DataChangedEventType::FONTSUBSTITUTION) ||
1121 ((rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
1122 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE)) )
1123 {
1124 ApplySettings(*this);
1125 ImplInitStyleSettings();
1126 LayoutChanged();
1127 }
1128}
1129
1130void MenuBarWindow::LoseFocus()
1131{
1132 if ( !HasChildPathFocus( true ) )
1133 ChangeHighlightItem( ITEMPOS_INVALID, false, false );
1134}
1135
1136void MenuBarWindow::GetFocus()
1137{
1138 SalMenu *pNativeMenu = m_pMenu ? m_pMenu->ImplGetSalMenu() : nullptr;
1139 if (pNativeMenu && pNativeMenu->TakeFocus())
1140 return;
1141
1142 if ( m_nHighlightedItem == ITEMPOS_INVALID )
1143 {
1144 mbAutoPopup = false; // do not open menu when activated by focus handling like taskpane cycling
1145 ChangeHighlightItem( 0, false );
1146 }
1147}
1148
1149css::uno::Reference<css::accessibility::XAccessible> MenuBarWindow::CreateAccessible()
1150{
1151 css::uno::Reference<css::accessibility::XAccessible> xAcc;
1152
1153 if (m_pMenu)
1154 xAcc = m_pMenu->GetAccessible();
1155
1156 return xAcc;
1157}
1158
1159sal_uInt16 MenuBarWindow::AddMenuBarButton( const Image& i_rImage, const Link<MenuBar::MenuBarButtonCallbackArg&,bool>& i_rLink, const OUString& i_rToolTip )
1160{
1161 // find first free button id
1162 sal_uInt16 nId = IID_DOCUMENTCLOSE1;
1163 std::map< sal_uInt16, AddButtonEntry >::const_iterator it;
1164 do
1165 {
1166 nId++;
1167 it = m_aAddButtons.find( nId );
1168 } while( it != m_aAddButtons.end() && nId < 128 );
1169 SAL_WARN_IF( nId >= 128, "vcl", "too many addbuttons in menubar" )do { if (true && (nId >= 128)) { switch (sal_detail_log_report
(::SAL_DETAIL_LOG_LEVEL_WARN, "vcl")) { case SAL_DETAIL_LOG_ACTION_IGNORE
: break; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail
::getResult( ::sal::detail::StreamStart() << "too many addbuttons in menubar"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"
), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "1169" ": "), ::sal::detail::unwrapStream( ::sal::detail
::StreamStart() << "too many addbuttons in menubar"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "too many addbuttons in menubar"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "1169" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "too many addbuttons in menubar") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "1169" ": "), ::sal::detail::unwrapStream( ::sal::detail
::StreamStart() << "too many addbuttons in menubar"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "too many addbuttons in menubar"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/window/menubarwindow.cxx"
":" "1169" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
1170 AddButtonEntry& rNewEntry = m_aAddButtons[nId];
1171 rNewEntry.m_aSelectLink = i_rLink;
1172 m_aCloseBtn->InsertItem(nId, i_rImage, ToolBoxItemBits::NONE, 0);
1173 m_aCloseBtn->calcMinSize();
1174 ShowButtons(m_aCloseBtn->IsItemVisible(IID_DOCUMENTCLOSE1), m_aFloatBtn->IsVisible(), m_aHideBtn->IsVisible());
1175 LayoutChanged();
1176
1177 if( m_pMenu->mpSalMenu )
1178 m_pMenu->mpSalMenu->AddMenuBarButton( SalMenuButtonItem( nId, i_rImage, i_rToolTip ) );
1179
1180 return nId;
1181}
1182
1183void MenuBarWindow::SetMenuBarButtonHighlightHdl( sal_uInt16 nId, const Link<MenuBar::MenuBarButtonCallbackArg&,bool>& rLink )
1184{
1185 std::map< sal_uInt16, AddButtonEntry >::iterator it = m_aAddButtons.find( nId );
1186 if( it != m_aAddButtons.end() )
1187 it->second.m_aHighlightLink = rLink;
1188}
1189
1190tools::Rectangle MenuBarWindow::GetMenuBarButtonRectPixel( sal_uInt16 nId )
1191{
1192 tools::Rectangle aRect;
1193 if( m_aAddButtons.find( nId ) != m_aAddButtons.end() )
1194 {
1195 if( m_pMenu->mpSalMenu )
1196 {
1197 aRect = m_pMenu->mpSalMenu->GetMenuBarButtonRectPixel( nId, ImplGetWindowImpl()->mpFrame );
1198 if( aRect == tools::Rectangle( Point( -1, -1 ), Size( 1, 1 ) ) )
1199 {
1200 // system menu button is somewhere but location cannot be determined
1201 return tools::Rectangle();
1202 }
1203 }
1204
1205 if( aRect.IsEmpty() )
1206 {
1207 aRect = m_aCloseBtn->GetItemRect(nId);
1208 Point aOffset = m_aCloseBtn->OutputToScreenPixel(Point());
1209 aRect.Move( aOffset.X(), aOffset.Y() );
1210 }
1211 }
1212 return aRect;
1213}
1214
1215void MenuBarWindow::RemoveMenuBarButton( sal_uInt16 nId )
1216{
1217 ToolBox::ImplToolItems::size_type nPos = m_aCloseBtn->GetItemPos(nId);
1218 m_aCloseBtn->RemoveItem(nPos);
1219 m_aAddButtons.erase( nId );
1220 m_aCloseBtn->calcMinSize();
1221 LayoutChanged();
1222
1223 if( m_pMenu->mpSalMenu )
1224 m_pMenu->mpSalMenu->RemoveMenuBarButton( nId );
1225}
1226
1227bool MenuBarWindow::HandleMenuButtonEvent( sal_uInt16 i_nButtonId )
1228{
1229 std::map< sal_uInt16, AddButtonEntry >::iterator it = m_aAddButtons.find( i_nButtonId );
1230 if( it != m_aAddButtons.end() )
1231 {
1232 MenuBar::MenuBarButtonCallbackArg aArg;
1233 aArg.nId = it->first;
1234 aArg.bHighlight = true;
1235 return it->second.m_aSelectLink.Call( aArg );
1236 }
1237 return false;
1238}
1239
1240bool MenuBarWindow::CanGetFocus() const
1241{
1242 /* #i83908# do not use the menubar if it is native or invisible
1243 this relies on MenuBar::ImplCreate setting the height of the menubar
1244 to 0 in this case
1245 */
1246 SalMenu *pNativeMenu = m_pMenu ? m_pMenu->ImplGetSalMenu() : nullptr;
1247 if (pNativeMenu && pNativeMenu->VisibleMenuBar())
1248 return pNativeMenu->CanGetFocus();
1249 return GetSizePixel().Height() > 0;
1250}
1251
1252/* 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<DecoToolBox>'
→
5
←
Returning from copy constructor for 'Reference<DecoToolBox>'
→
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