File: | home/maarten/src/libreoffice/core/include/rtl/ref.hxx |
Warning: | line 192, column 9 Use of memory after it is freed |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
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 <com/sun/star/accessibility/AccessibleRole.hpp> | |||
21 | #include <com/sun/star/accessibility/AccessibleStateType.hpp> | |||
22 | #include <com/sun/star/accessibility/AccessibleEventId.hpp> | |||
23 | #include <com/sun/star/accessibility/AccessibleRelationType.hpp> | |||
24 | #include <com/sun/star/lang/IndexOutOfBoundsException.hpp> | |||
25 | #include <cppuhelper/supportsservice.hxx> | |||
26 | #include <i18nlangtag/languagetag.hxx> | |||
27 | #include <toolkit/awt/vclxaccessiblecomponent.hxx> | |||
28 | #include <toolkit/awt/vclxwindow.hxx> | |||
29 | #include <toolkit/helper/convert.hxx> | |||
30 | #include <toolkit/awt/vclxfont.hxx> | |||
31 | #include <vcl/toolkit/dialog.hxx> | |||
32 | #include <vcl/vclevent.hxx> | |||
33 | #include <vcl/window.hxx> | |||
34 | #include <vcl/toolkit/edit.hxx> | |||
35 | #include <vcl/settings.hxx> | |||
36 | #include <tools/debug.hxx> | |||
37 | #include <unotools/accessiblestatesethelper.hxx> | |||
38 | #include <unotools/accessiblerelationsethelper.hxx> | |||
39 | #include <vcl/svapp.hxx> | |||
40 | #include <vcl/menu.hxx> | |||
41 | ||||
42 | using namespace ::com::sun::star; | |||
43 | using namespace ::comphelper; | |||
44 | ||||
45 | VCLXAccessibleComponent::VCLXAccessibleComponent( VCLXWindow* pVCLXWindow ) | |||
46 | { | |||
47 | m_xVCLXWindow = pVCLXWindow; | |||
48 | ||||
49 | DBG_ASSERT( pVCLXWindow->GetWindow(), "VCLXAccessibleComponent - no window!" )do { if (true && (!(pVCLXWindow->GetWindow()))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxaccessiblecomponent.cxx" ":" "49" ": "), "%s", "VCLXAccessibleComponent - no window!" ); } } while (false); | |||
| ||||
50 | m_xEventSource = pVCLXWindow->GetWindow(); | |||
51 | if ( m_xEventSource ) | |||
52 | { | |||
53 | m_xEventSource->AddEventListener( LINK( this, VCLXAccessibleComponent, WindowEventListener )::tools::detail::makeLink( ::tools::detail::castTo<VCLXAccessibleComponent *>(this), &VCLXAccessibleComponent::LinkStubWindowEventListener ) ); | |||
54 | m_xEventSource->AddChildEventListener( LINK( this, VCLXAccessibleComponent, WindowChildEventListener )::tools::detail::makeLink( ::tools::detail::castTo<VCLXAccessibleComponent *>(this), &VCLXAccessibleComponent::LinkStubWindowChildEventListener ) ); | |||
55 | } | |||
56 | ||||
57 | // announce the XAccessible of our creator to the base class | |||
58 | lateInit( pVCLXWindow ); | |||
59 | } | |||
60 | ||||
61 | VCLXWindow* VCLXAccessibleComponent::GetVCLXWindow() const | |||
62 | { | |||
63 | return m_xVCLXWindow.get(); | |||
64 | } | |||
65 | ||||
66 | void VCLXAccessibleComponent::DisconnectEvents() | |||
67 | { | |||
68 | if ( m_xEventSource ) | |||
69 | { | |||
70 | m_xEventSource->RemoveEventListener( LINK( this, VCLXAccessibleComponent, WindowEventListener )::tools::detail::makeLink( ::tools::detail::castTo<VCLXAccessibleComponent *>(this), &VCLXAccessibleComponent::LinkStubWindowEventListener ) ); | |||
71 | m_xEventSource->RemoveChildEventListener( LINK( this, VCLXAccessibleComponent, WindowChildEventListener )::tools::detail::makeLink( ::tools::detail::castTo<VCLXAccessibleComponent *>(this), &VCLXAccessibleComponent::LinkStubWindowChildEventListener ) ); | |||
72 | m_xEventSource.clear(); | |||
73 | } | |||
74 | } | |||
75 | ||||
76 | VCLXAccessibleComponent::~VCLXAccessibleComponent() | |||
77 | { | |||
78 | ensureDisposed(); | |||
79 | DisconnectEvents(); | |||
80 | } | |||
81 | ||||
82 | IMPLEMENT_FORWARD_XINTERFACE3( VCLXAccessibleComponent, OAccessibleExtendedComponentHelper, OAccessibleImplementationAccess, VCLXAccessibleComponent_BASE )void VCLXAccessibleComponent::acquire() throw() { OAccessibleExtendedComponentHelper ::acquire(); } void VCLXAccessibleComponent::release() throw( ) { OAccessibleExtendedComponentHelper::release(); } css::uno ::Any VCLXAccessibleComponent::queryInterface( const css::uno ::Type& _rType ) { css::uno::Any aReturn = OAccessibleExtendedComponentHelper ::queryInterface( _rType ); if ( !aReturn.hasValue() ) { aReturn = OAccessibleImplementationAccess::queryInterface( _rType ); if ( !aReturn.hasValue() ) aReturn = VCLXAccessibleComponent_BASE ::queryInterface( _rType ); } return aReturn; } | |||
83 | IMPLEMENT_FORWARD_XTYPEPROVIDER3( VCLXAccessibleComponent, OAccessibleExtendedComponentHelper, OAccessibleImplementationAccess, VCLXAccessibleComponent_BASE )css::uno::Sequence< css::uno::Type > VCLXAccessibleComponent ::getTypes( ) { return ::comphelper::concatSequences( OAccessibleExtendedComponentHelper ::getTypes(), OAccessibleImplementationAccess::getTypes(), VCLXAccessibleComponent_BASE ::getTypes() ); } css::uno::Sequence< sal_Int8 > VCLXAccessibleComponent ::getImplementationId( ) { return css::uno::Sequence<sal_Int8 >(); } | |||
84 | ||||
85 | OUString VCLXAccessibleComponent::getImplementationName() | |||
86 | { | |||
87 | return "com.sun.star.comp.toolkit.AccessibleWindow"; | |||
88 | } | |||
89 | ||||
90 | sal_Bool VCLXAccessibleComponent::supportsService( const OUString& rServiceName ) | |||
91 | { | |||
92 | return cppu::supportsService(this, rServiceName); | |||
93 | } | |||
94 | ||||
95 | uno::Sequence< OUString > VCLXAccessibleComponent::getSupportedServiceNames() | |||
96 | { | |||
97 | uno::Sequence< OUString > aNames { "com.sun.star.awt.AccessibleWindow" }; | |||
98 | return aNames; | |||
99 | } | |||
100 | ||||
101 | IMPL_LINK( VCLXAccessibleComponent, WindowEventListener, VclWindowEvent&, rEvent, void )void VCLXAccessibleComponent::LinkStubWindowEventListener(void * instance, VclWindowEvent& data) { return static_cast< VCLXAccessibleComponent *>(instance)->WindowEventListener (data); } void VCLXAccessibleComponent::WindowEventListener(VclWindowEvent & rEvent) | |||
102 | { | |||
103 | /* Ignore VclEventId::WindowEndPopupMode, because the UNO accessibility wrapper | |||
104 | * might have been destroyed by the previous VCLEventListener (if no AT tool | |||
105 | * is running), e.g. sub-toolbars in impress. | |||
106 | */ | |||
107 | if ( m_xVCLXWindow.is() /* #122218# */ && (rEvent.GetId() != VclEventId::WindowEndPopupMode) ) | |||
108 | { | |||
109 | DBG_ASSERT( rEvent.GetWindow(), "Window???" )do { if (true && (!(rEvent.GetWindow()))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxaccessiblecomponent.cxx" ":" "109" ": "), "%s", "Window???"); } } while (false); | |||
110 | if( !rEvent.GetWindow()->IsAccessibilityEventsSuppressed() || ( rEvent.GetId() == VclEventId::ObjectDying ) ) | |||
111 | { | |||
112 | ProcessWindowEvent( rEvent ); | |||
113 | } | |||
114 | } | |||
115 | } | |||
116 | ||||
117 | IMPL_LINK( VCLXAccessibleComponent, WindowChildEventListener, VclWindowEvent&, rEvent, void )void VCLXAccessibleComponent::LinkStubWindowChildEventListener (void * instance, VclWindowEvent& data) { return static_cast <VCLXAccessibleComponent *>(instance)->WindowChildEventListener (data); } void VCLXAccessibleComponent::WindowChildEventListener (VclWindowEvent& rEvent) | |||
118 | { | |||
119 | if ( m_xVCLXWindow.is() /* #i68079# */ ) | |||
120 | { | |||
121 | DBG_ASSERT( rEvent.GetWindow(), "Window???" )do { if (true && (!(rEvent.GetWindow()))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxaccessiblecomponent.cxx" ":" "121" ": "), "%s", "Window???"); } } while (false); | |||
122 | if( !rEvent.GetWindow()->IsAccessibilityEventsSuppressed() ) | |||
123 | { | |||
124 | // #103087# to prevent an early release of the component | |||
125 | uno::Reference< accessibility::XAccessibleContext > xHoldAlive = this; | |||
126 | ||||
127 | ProcessWindowChildEvent( rEvent ); | |||
128 | } | |||
129 | } | |||
130 | } | |||
131 | ||||
132 | uno::Reference< accessibility::XAccessible > VCLXAccessibleComponent::GetChildAccessible( const VclWindowEvent& rVclWindowEvent ) | |||
133 | { | |||
134 | // checks if the data in the window event is our direct child | |||
135 | // and returns its accessible | |||
136 | ||||
137 | // MT: Change this later, normally a show/hide event shouldn't have the vcl::Window* in pData. | |||
138 | vcl::Window* pChildWindow = static_cast<vcl::Window *>(rVclWindowEvent.GetData()); | |||
139 | if( pChildWindow && GetWindow() == pChildWindow->GetAccessibleParentWindow() ) | |||
140 | return pChildWindow->GetAccessible( rVclWindowEvent.GetId() == VclEventId::WindowShow ); | |||
141 | else | |||
142 | return uno::Reference< accessibility::XAccessible > (); | |||
143 | } | |||
144 | ||||
145 | void VCLXAccessibleComponent::ProcessWindowChildEvent( const VclWindowEvent& rVclWindowEvent ) | |||
146 | { | |||
147 | uno::Any aOldValue, aNewValue; | |||
148 | uno::Reference< accessibility::XAccessible > xAcc; | |||
149 | ||||
150 | switch ( rVclWindowEvent.GetId() ) | |||
151 | { | |||
152 | case VclEventId::WindowShow: // send create on show for direct accessible children | |||
153 | { | |||
154 | xAcc = GetChildAccessible( rVclWindowEvent ); | |||
155 | if( xAcc.is() ) | |||
156 | { | |||
157 | aNewValue <<= xAcc; | |||
158 | NotifyAccessibleEvent( accessibility::AccessibleEventId::CHILD, aOldValue, aNewValue ); | |||
159 | } | |||
160 | } | |||
161 | break; | |||
162 | case VclEventId::WindowHide: // send destroy on hide for direct accessible children | |||
163 | { | |||
164 | xAcc = GetChildAccessible( rVclWindowEvent ); | |||
165 | if( xAcc.is() ) | |||
166 | { | |||
167 | aOldValue <<= xAcc; | |||
168 | NotifyAccessibleEvent( accessibility::AccessibleEventId::CHILD, aOldValue, aNewValue ); | |||
169 | } | |||
170 | } | |||
171 | break; | |||
172 | default: break; | |||
173 | } | |||
174 | } | |||
175 | ||||
176 | void VCLXAccessibleComponent::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent ) | |||
177 | { | |||
178 | uno::Any aOldValue, aNewValue; | |||
179 | ||||
180 | vcl::Window* pAccWindow = rVclWindowEvent.GetWindow(); | |||
181 | assert(pAccWindow && "VCLXAccessibleComponent::ProcessWindowEvent - Window?")(static_cast <bool> (pAccWindow && "VCLXAccessibleComponent::ProcessWindowEvent - Window?" ) ? void (0) : __assert_fail ("pAccWindow && \"VCLXAccessibleComponent::ProcessWindowEvent - Window?\"" , "/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxaccessiblecomponent.cxx" , 181, __extension__ __PRETTY_FUNCTION__)); | |||
182 | ||||
183 | switch ( rVclWindowEvent.GetId() ) | |||
184 | { | |||
185 | case VclEventId::ObjectDying: | |||
186 | { | |||
187 | DisconnectEvents(); | |||
188 | m_xVCLXWindow.clear(); | |||
189 | } | |||
190 | break; | |||
191 | case VclEventId::WindowChildDestroyed: | |||
192 | { | |||
193 | vcl::Window* pWindow = static_cast<vcl::Window*>(rVclWindowEvent.GetData()); | |||
194 | DBG_ASSERT( pWindow, "VclEventId::WindowChildDestroyed - Window=?" )do { if (true && (!(pWindow))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/vclxaccessiblecomponent.cxx" ":" "194" ": "), "%s", "VclEventId::WindowChildDestroyed - Window=?" ); } } while (false); | |||
195 | if ( pWindow->GetAccessible( false ).is() ) | |||
196 | { | |||
197 | aOldValue <<= pWindow->GetAccessible( false ); | |||
198 | NotifyAccessibleEvent( accessibility::AccessibleEventId::CHILD, aOldValue, aNewValue ); | |||
199 | } | |||
200 | } | |||
201 | break; | |||
202 | case VclEventId::WindowActivate: | |||
203 | { | |||
204 | sal_Int16 aAccessibleRole = getAccessibleRole(); | |||
205 | // avoid notification if a child frame is already active | |||
206 | // only one frame may be active at a given time | |||
207 | if ( !pAccWindow->HasActiveChildFrame() && | |||
208 | ( aAccessibleRole == accessibility::AccessibleRole::FRAME || | |||
209 | aAccessibleRole == accessibility::AccessibleRole::ALERT || | |||
210 | aAccessibleRole == accessibility::AccessibleRole::DIALOG ) ) // #i18891# | |||
211 | { | |||
212 | aNewValue <<= accessibility::AccessibleStateType::ACTIVE; | |||
213 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
214 | } | |||
215 | } | |||
216 | break; | |||
217 | case VclEventId::WindowDeactivate: | |||
218 | { | |||
219 | sal_Int16 aAccessibleRole = getAccessibleRole(); | |||
220 | if ( aAccessibleRole == accessibility::AccessibleRole::FRAME || | |||
221 | aAccessibleRole == accessibility::AccessibleRole::ALERT || | |||
222 | aAccessibleRole == accessibility::AccessibleRole::DIALOG ) // #i18891# | |||
223 | { | |||
224 | aOldValue <<= accessibility::AccessibleStateType::ACTIVE; | |||
225 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
226 | } | |||
227 | } | |||
228 | break; | |||
229 | case VclEventId::WindowGetFocus: | |||
230 | case VclEventId::ControlGetFocus: | |||
231 | { | |||
232 | if( (pAccWindow->IsCompoundControl() && rVclWindowEvent.GetId() == VclEventId::ControlGetFocus) || | |||
233 | (!pAccWindow->IsCompoundControl() && rVclWindowEvent.GetId() == VclEventId::WindowGetFocus) ) | |||
234 | { | |||
235 | // if multiple listeners were registered it is possible that the | |||
236 | // focus was changed during event processing (eg SfxTopWindow ) | |||
237 | // #106082# allow ChildPathFocus only for CompoundControls, for windows the focus must be in the window itself | |||
238 | if( (pAccWindow->IsCompoundControl() && pAccWindow->HasChildPathFocus()) || | |||
239 | (!pAccWindow->IsCompoundControl() && pAccWindow->HasFocus()) ) | |||
240 | { | |||
241 | aNewValue <<= accessibility::AccessibleStateType::FOCUSED; | |||
242 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
243 | } | |||
244 | } | |||
245 | } | |||
246 | break; | |||
247 | case VclEventId::WindowLoseFocus: | |||
248 | case VclEventId::ControlLoseFocus: | |||
249 | { | |||
250 | if( (pAccWindow->IsCompoundControl() && rVclWindowEvent.GetId() == VclEventId::ControlLoseFocus) || | |||
251 | (!pAccWindow->IsCompoundControl() && rVclWindowEvent.GetId() == VclEventId::WindowLoseFocus) ) | |||
252 | { | |||
253 | aOldValue <<= accessibility::AccessibleStateType::FOCUSED; | |||
254 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
255 | } | |||
256 | } | |||
257 | break; | |||
258 | case VclEventId::WindowFrameTitleChanged: | |||
259 | { | |||
260 | OUString aOldName( *static_cast<OUString*>(rVclWindowEvent.GetData()) ); | |||
261 | OUString aNewName( getAccessibleName() ); | |||
262 | aOldValue <<= aOldName; | |||
263 | aNewValue <<= aNewName; | |||
264 | NotifyAccessibleEvent( accessibility::AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue ); | |||
265 | } | |||
266 | break; | |||
267 | case VclEventId::WindowEnabled: | |||
268 | { | |||
269 | aNewValue <<= accessibility::AccessibleStateType::ENABLED; | |||
270 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
271 | aNewValue <<= accessibility::AccessibleStateType::SENSITIVE; | |||
272 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
273 | } | |||
274 | break; | |||
275 | case VclEventId::WindowDisabled: | |||
276 | { | |||
277 | aOldValue <<= accessibility::AccessibleStateType::SENSITIVE; | |||
278 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
279 | ||||
280 | aOldValue <<= accessibility::AccessibleStateType::ENABLED; | |||
281 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
282 | } | |||
283 | break; | |||
284 | case VclEventId::WindowMove: | |||
285 | case VclEventId::WindowResize: | |||
286 | { | |||
287 | NotifyAccessibleEvent( accessibility::AccessibleEventId::BOUNDRECT_CHANGED, aOldValue, aNewValue ); | |||
288 | } | |||
289 | break; | |||
290 | case VclEventId::WindowMenubarAdded: | |||
291 | { | |||
292 | MenuBar* pMenuBar = static_cast<MenuBar*>(rVclWindowEvent.GetData()); | |||
293 | if ( pMenuBar ) | |||
294 | { | |||
295 | uno::Reference< accessibility::XAccessible > xChild( pMenuBar->GetAccessible() ); | |||
296 | if ( xChild.is() ) | |||
297 | { | |||
298 | aNewValue <<= xChild; | |||
299 | NotifyAccessibleEvent( accessibility::AccessibleEventId::CHILD, aOldValue, aNewValue ); | |||
300 | } | |||
301 | } | |||
302 | } | |||
303 | break; | |||
304 | case VclEventId::WindowMenubarRemoved: | |||
305 | { | |||
306 | MenuBar* pMenuBar = static_cast<MenuBar*>(rVclWindowEvent.GetData()); | |||
307 | if ( pMenuBar ) | |||
308 | { | |||
309 | uno::Reference< accessibility::XAccessible > xChild( pMenuBar->GetAccessible() ); | |||
310 | if ( xChild.is() ) | |||
311 | { | |||
312 | aOldValue <<= xChild; | |||
313 | NotifyAccessibleEvent( accessibility::AccessibleEventId::CHILD, aOldValue, aNewValue ); | |||
314 | } | |||
315 | } | |||
316 | } | |||
317 | break; | |||
318 | case VclEventId::WindowMinimize: | |||
319 | { | |||
320 | aNewValue <<= accessibility::AccessibleStateType::ICONIFIED; | |||
321 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
322 | } | |||
323 | break; | |||
324 | case VclEventId::WindowNormalize: | |||
325 | { | |||
326 | aOldValue <<= accessibility::AccessibleStateType::ICONIFIED; | |||
327 | NotifyAccessibleEvent( accessibility::AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue ); | |||
328 | } | |||
329 | break; | |||
330 | default: | |||
331 | { | |||
332 | } | |||
333 | break; | |||
334 | } | |||
335 | } | |||
336 | ||||
337 | void VCLXAccessibleComponent::disposing() | |||
338 | { | |||
339 | DisconnectEvents(); | |||
340 | ||||
341 | OAccessibleExtendedComponentHelper::disposing(); | |||
342 | ||||
343 | m_xVCLXWindow.clear(); | |||
344 | } | |||
345 | ||||
346 | VclPtr<vcl::Window> VCLXAccessibleComponent::GetWindow() const | |||
347 | { | |||
348 | return GetVCLXWindow() ? GetVCLXWindow()->GetWindow() | |||
349 | : VclPtr<vcl::Window>(); | |||
350 | } | |||
351 | ||||
352 | void VCLXAccessibleComponent::FillAccessibleRelationSet( utl::AccessibleRelationSetHelper& rRelationSet ) | |||
353 | { | |||
354 | VclPtr<vcl::Window> pWindow = GetWindow(); | |||
355 | if ( !pWindow ) | |||
356 | return; | |||
357 | ||||
358 | vcl::Window *pLabeledBy = pWindow->GetAccessibleRelationLabeledBy(); | |||
359 | if ( pLabeledBy && pLabeledBy != pWindow ) | |||
360 | { | |||
361 | uno::Sequence< uno::Reference< uno::XInterface > > aSequence { pLabeledBy->GetAccessible() }; | |||
362 | rRelationSet.AddRelation( accessibility::AccessibleRelation( accessibility::AccessibleRelationType::LABELED_BY, aSequence ) ); | |||
363 | } | |||
364 | ||||
365 | vcl::Window* pLabelFor = pWindow->GetAccessibleRelationLabelFor(); | |||
366 | if ( pLabelFor && pLabelFor != pWindow ) | |||
367 | { | |||
368 | uno::Sequence< uno::Reference< uno::XInterface > > aSequence { pLabelFor->GetAccessible() }; | |||
369 | rRelationSet.AddRelation( accessibility::AccessibleRelation( accessibility::AccessibleRelationType::LABEL_FOR, aSequence ) ); | |||
370 | } | |||
371 | ||||
372 | vcl::Window* pMemberOf = pWindow->GetAccessibleRelationMemberOf(); | |||
373 | if ( pMemberOf && pMemberOf != pWindow ) | |||
374 | { | |||
375 | uno::Sequence< uno::Reference< uno::XInterface > > aSequence { pMemberOf->GetAccessible() }; | |||
376 | rRelationSet.AddRelation( accessibility::AccessibleRelation( accessibility::AccessibleRelationType::MEMBER_OF, aSequence ) ); | |||
377 | } | |||
378 | } | |||
379 | ||||
380 | void VCLXAccessibleComponent::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet ) | |||
381 | { | |||
382 | VclPtr<vcl::Window> pWindow = GetWindow(); | |||
383 | if ( pWindow ) | |||
384 | { | |||
385 | if ( pWindow->IsVisible() ) | |||
386 | { | |||
387 | rStateSet.AddState( accessibility::AccessibleStateType::VISIBLE ); | |||
388 | rStateSet.AddState( accessibility::AccessibleStateType::SHOWING ); | |||
389 | } | |||
390 | else | |||
391 | { | |||
392 | rStateSet.AddState( accessibility::AccessibleStateType::INVALID ); | |||
393 | } | |||
394 | ||||
395 | if ( pWindow->IsEnabled() ) | |||
396 | { | |||
397 | rStateSet.AddState( accessibility::AccessibleStateType::ENABLED ); | |||
398 | rStateSet.AddState( accessibility::AccessibleStateType::SENSITIVE ); | |||
399 | } | |||
400 | ||||
401 | if ( pWindow->HasChildPathFocus() && | |||
402 | ( getAccessibleRole() == accessibility::AccessibleRole::FRAME || | |||
403 | getAccessibleRole() == accessibility::AccessibleRole::ALERT || | |||
404 | getAccessibleRole() == accessibility::AccessibleRole::DIALOG ) ) // #i18891# | |||
405 | rStateSet.AddState( accessibility::AccessibleStateType::ACTIVE ); | |||
406 | ||||
407 | if ( pWindow->HasFocus() || ( pWindow->IsCompoundControl() && pWindow->HasChildPathFocus() ) ) | |||
408 | rStateSet.AddState( accessibility::AccessibleStateType::FOCUSED ); | |||
409 | ||||
410 | if ( pWindow->IsWait() ) | |||
411 | rStateSet.AddState( accessibility::AccessibleStateType::BUSY ); | |||
412 | ||||
413 | if ( pWindow->GetStyle() & WB_SIZEABLE ) | |||
414 | rStateSet.AddState( accessibility::AccessibleStateType::RESIZABLE ); | |||
415 | // 6. frame doesn't have MOVABLE state | |||
416 | // 10. for password text, where is the sensitive state? | |||
417 | if( ( getAccessibleRole() == accessibility::AccessibleRole::FRAME ||getAccessibleRole() == accessibility::AccessibleRole::DIALOG )&& pWindow->GetStyle() & WB_MOVEABLE ) | |||
418 | rStateSet.AddState( accessibility::AccessibleStateType::MOVEABLE ); | |||
419 | if( pWindow->IsDialog() ) | |||
420 | { | |||
421 | Dialog *pDlg = static_cast< Dialog* >( pWindow.get() ); | |||
422 | if( pDlg->IsInExecute() ) | |||
423 | rStateSet.AddState( accessibility::AccessibleStateType::MODAL ); | |||
424 | } | |||
425 | //If a combobox or list's edit child isn't read-only,EDITABLE state | |||
426 | //should be set. | |||
427 | if( pWindow && pWindow->GetType() == WindowType::COMBOBOX ) | |||
428 | { | |||
429 | if( !( pWindow->GetStyle() & WB_READONLY) || | |||
430 | !static_cast<Edit*>(pWindow.get())->IsReadOnly() ) | |||
431 | rStateSet.AddState( accessibility::AccessibleStateType::EDITABLE ); | |||
432 | } | |||
433 | ||||
434 | VclPtr<vcl::Window> pChild = pWindow->GetWindow( GetWindowType::FirstChild ); | |||
435 | ||||
436 | while( pWindow && pChild ) | |||
437 | { | |||
438 | VclPtr<vcl::Window> pWinTemp = pChild->GetWindow( GetWindowType::FirstChild ); | |||
439 | if( pWinTemp && pWinTemp->GetType() == WindowType::EDIT ) | |||
440 | { | |||
441 | if( !( pWinTemp->GetStyle() & WB_READONLY) || | |||
442 | !static_cast<Edit*>(pWinTemp.get())->IsReadOnly() ) | |||
443 | rStateSet.AddState( accessibility::AccessibleStateType::EDITABLE ); | |||
444 | break; | |||
445 | } | |||
446 | if( pChild->GetType() == WindowType::EDIT ) | |||
447 | { | |||
448 | if( !( pChild->GetStyle() & WB_READONLY) || | |||
449 | !static_cast<Edit*>(pChild.get())->IsReadOnly()) | |||
450 | rStateSet.AddState( accessibility::AccessibleStateType::EDITABLE ); | |||
451 | break; | |||
452 | } | |||
453 | pChild = pChild->GetWindow( GetWindowType::Next ); | |||
454 | } | |||
455 | } | |||
456 | else | |||
457 | { | |||
458 | rStateSet.AddState( accessibility::AccessibleStateType::DEFUNC ); | |||
459 | } | |||
460 | ||||
461 | /* | |||
462 | ||||
463 | MUST BE SET FROM DERIVED CLASSES: | |||
464 | ||||
465 | CHECKED | |||
466 | COLLAPSED | |||
467 | EXPANDED | |||
468 | EXPANDABLE | |||
469 | EDITABLE | |||
470 | FOCUSABLE | |||
471 | HORIZONTAL | |||
472 | VERTICAL | |||
473 | ICONIFIED | |||
474 | MULTILINE | |||
475 | MULTI_SELECTABLE | |||
476 | PRESSED | |||
477 | SELECTABLE | |||
478 | SELECTED | |||
479 | SINGLE_LINE | |||
480 | TRANSIENT | |||
481 | ||||
482 | */ | |||
483 | } | |||
484 | ||||
485 | ||||
486 | // accessibility::XAccessibleContext | |||
487 | sal_Int32 VCLXAccessibleComponent::getAccessibleChildCount() | |||
488 | { | |||
489 | OExternalLockGuard aGuard( this ); | |||
490 | ||||
491 | sal_Int32 nChildren = 0; | |||
492 | if ( GetWindow() ) | |||
493 | nChildren = GetWindow()->GetAccessibleChildWindowCount(); | |||
494 | ||||
495 | return nChildren; | |||
496 | } | |||
497 | ||||
498 | uno::Reference< accessibility::XAccessible > VCLXAccessibleComponent::getAccessibleChild( sal_Int32 i ) | |||
499 | { | |||
500 | OExternalLockGuard aGuard( this ); | |||
501 | ||||
502 | if ( i >= getAccessibleChildCount() ) | |||
503 | throw lang::IndexOutOfBoundsException(); | |||
504 | ||||
505 | uno::Reference< accessibility::XAccessible > xAcc; | |||
506 | if ( GetWindow() ) | |||
507 | { | |||
508 | vcl::Window* pChild = GetWindow()->GetAccessibleChildWindow( static_cast<sal_uInt16>(i) ); | |||
509 | if ( pChild ) | |||
510 | xAcc = pChild->GetAccessible(); | |||
511 | } | |||
512 | ||||
513 | return xAcc; | |||
514 | } | |||
515 | ||||
516 | uno::Reference< accessibility::XAccessible > VCLXAccessibleComponent::getVclParent() const | |||
517 | { | |||
518 | uno::Reference< accessibility::XAccessible > xAcc; | |||
519 | if ( GetWindow() ) | |||
520 | { | |||
521 | vcl::Window* pParent = GetWindow()->GetAccessibleParentWindow(); | |||
522 | if ( pParent ) | |||
523 | xAcc = pParent->GetAccessible(); | |||
524 | } | |||
525 | return xAcc; | |||
526 | } | |||
527 | ||||
528 | uno::Reference< accessibility::XAccessible > VCLXAccessibleComponent::getAccessibleParent( ) | |||
529 | { | |||
530 | OExternalLockGuard aGuard( this ); | |||
531 | ||||
532 | // we do _not_ have a foreign-controlled parent -> default to our VCL parent | |||
533 | uno::Reference< accessibility::XAccessible > xAcc = getVclParent(); | |||
534 | ||||
535 | return xAcc; | |||
536 | } | |||
537 | ||||
538 | sal_Int32 VCLXAccessibleComponent::getAccessibleIndexInParent( ) | |||
539 | { | |||
540 | OExternalLockGuard aGuard( this ); | |||
541 | ||||
542 | sal_Int32 nIndex = -1; | |||
543 | ||||
544 | if ( GetWindow() ) | |||
545 | { | |||
546 | vcl::Window* pParent = GetWindow()->GetAccessibleParentWindow(); | |||
547 | if ( pParent ) | |||
548 | { | |||
549 | // Iterate over all the parent's children and search for this object. | |||
550 | // this should be compatible with the code in SVX | |||
551 | uno::Reference< accessibility::XAccessible > xParentAcc( pParent->GetAccessible() ); | |||
552 | if ( xParentAcc.is() ) | |||
553 | { | |||
554 | uno::Reference< accessibility::XAccessibleContext > xParentContext ( xParentAcc->getAccessibleContext() ); | |||
555 | if ( xParentContext.is() ) | |||
556 | { | |||
557 | sal_Int32 nChildCount = xParentContext->getAccessibleChildCount(); | |||
558 | for ( sal_Int32 i=0; i<nChildCount; i++ ) | |||
559 | { | |||
560 | uno::Reference< accessibility::XAccessible > xChild( xParentContext->getAccessibleChild(i) ); | |||
561 | if ( xChild.is() ) | |||
562 | { | |||
563 | uno::Reference< accessibility::XAccessibleContext > xChildContext = xChild->getAccessibleContext(); | |||
564 | if ( xChildContext == static_cast<accessibility::XAccessibleContext*>(this) ) | |||
565 | { | |||
566 | nIndex = i; | |||
567 | break; | |||
568 | } | |||
569 | } | |||
570 | } | |||
571 | } | |||
572 | } | |||
573 | } | |||
574 | } | |||
575 | return nIndex; | |||
576 | } | |||
577 | ||||
578 | sal_Int16 VCLXAccessibleComponent::getAccessibleRole( ) | |||
579 | { | |||
580 | OExternalLockGuard aGuard( this ); | |||
581 | ||||
582 | sal_Int16 nRole = 0; | |||
583 | ||||
584 | if ( GetWindow() ) | |||
585 | nRole = GetWindow()->GetAccessibleRole(); | |||
586 | ||||
587 | return nRole; | |||
588 | } | |||
589 | ||||
590 | OUString VCLXAccessibleComponent::getAccessibleDescription( ) | |||
591 | { | |||
592 | OExternalLockGuard aGuard( this ); | |||
593 | ||||
594 | OUString aDescription; | |||
595 | ||||
596 | if ( GetWindow() ) | |||
597 | aDescription = GetWindow()->GetAccessibleDescription(); | |||
598 | ||||
599 | return aDescription; | |||
600 | } | |||
601 | ||||
602 | OUString VCLXAccessibleComponent::getAccessibleName( ) | |||
603 | { | |||
604 | OExternalLockGuard aGuard( this ); | |||
605 | ||||
606 | OUString aName; | |||
607 | if ( GetWindow() ) | |||
608 | { | |||
609 | aName = GetWindow()->GetAccessibleName(); | |||
610 | #if OSL_DEBUG_LEVEL1 > 0 | |||
611 | aName += " (Type = " + OUString::number(static_cast<sal_Int32>(GetWindow()->GetType())) + ")"; | |||
612 | #endif | |||
613 | } | |||
614 | return aName; | |||
615 | } | |||
616 | ||||
617 | OUString VCLXAccessibleComponent::getAccessibleId( ) | |||
618 | { | |||
619 | OExternalLockGuard aGuard( this ); | |||
620 | ||||
621 | OUString aId; | |||
622 | if ( GetWindow() ) | |||
623 | { | |||
624 | const OUString &aWindowId = GetWindow()->get_id(); | |||
625 | aId = aWindowId; | |||
626 | } | |||
627 | return aId; | |||
628 | } | |||
629 | ||||
630 | uno::Reference< accessibility::XAccessibleRelationSet > VCLXAccessibleComponent::getAccessibleRelationSet( ) | |||
631 | { | |||
632 | OExternalLockGuard aGuard( this ); | |||
633 | ||||
634 | utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper; | |||
635 | uno::Reference< accessibility::XAccessibleRelationSet > xSet = pRelationSetHelper; | |||
636 | FillAccessibleRelationSet( *pRelationSetHelper ); | |||
637 | return xSet; | |||
638 | } | |||
639 | ||||
640 | uno::Reference< accessibility::XAccessibleStateSet > VCLXAccessibleComponent::getAccessibleStateSet( ) | |||
641 | { | |||
642 | OExternalLockGuard aGuard( this ); | |||
643 | ||||
644 | utl::AccessibleStateSetHelper* pStateSetHelper = new utl::AccessibleStateSetHelper; | |||
645 | uno::Reference< accessibility::XAccessibleStateSet > xSet = pStateSetHelper; | |||
646 | FillAccessibleStateSet( *pStateSetHelper ); | |||
647 | return xSet; | |||
648 | } | |||
649 | ||||
650 | lang::Locale VCLXAccessibleComponent::getLocale() | |||
651 | { | |||
652 | OExternalLockGuard aGuard( this ); | |||
653 | ||||
654 | return Application::GetSettings().GetLanguageTag().getLocale(); | |||
655 | } | |||
656 | ||||
657 | uno::Reference< accessibility::XAccessible > VCLXAccessibleComponent::getAccessibleAtPoint( const awt::Point& rPoint ) | |||
658 | { | |||
659 | OExternalLockGuard aGuard( this ); | |||
660 | ||||
661 | uno::Reference< accessibility::XAccessible > xChild; | |||
662 | for ( sal_uInt32 i = 0, nCount = getAccessibleChildCount(); i < nCount; ++i ) | |||
663 | { | |||
664 | uno::Reference< accessibility::XAccessible > xAcc = getAccessibleChild( i ); | |||
665 | if ( xAcc.is() ) | |||
666 | { | |||
667 | uno::Reference< accessibility::XAccessibleComponent > xComp( xAcc->getAccessibleContext(), uno::UNO_QUERY ); | |||
668 | if ( xComp.is() ) | |||
669 | { | |||
670 | tools::Rectangle aRect = VCLRectangle( xComp->getBounds() ); | |||
671 | Point aPos = VCLPoint( rPoint ); | |||
672 | if ( aRect.IsInside( aPos ) ) | |||
673 | { | |||
674 | xChild = xAcc; | |||
675 | break; | |||
676 | } | |||
677 | } | |||
678 | } | |||
679 | } | |||
680 | ||||
681 | return xChild; | |||
682 | } | |||
683 | ||||
684 | // accessibility::XAccessibleComponent | |||
685 | awt::Rectangle VCLXAccessibleComponent::implGetBounds() | |||
686 | { | |||
687 | awt::Rectangle aBounds ( 0, 0, 0, 0 ); | |||
688 | ||||
689 | VclPtr<vcl::Window> pWindow = GetWindow(); | |||
690 | if ( pWindow ) | |||
691 | { | |||
692 | tools::Rectangle aRect = pWindow->GetWindowExtentsRelative( nullptr ); | |||
693 | aBounds = AWTRectangle( aRect ); | |||
694 | vcl::Window* pParent = pWindow->GetAccessibleParentWindow(); | |||
695 | if ( pParent ) | |||
696 | { | |||
697 | tools::Rectangle aParentRect = pParent->GetWindowExtentsRelative( nullptr ); | |||
698 | awt::Point aParentScreenLoc = AWTPoint( aParentRect.TopLeft() ); | |||
699 | aBounds.X -= aParentScreenLoc.X; | |||
700 | aBounds.Y -= aParentScreenLoc.Y; | |||
701 | } | |||
702 | } | |||
703 | ||||
704 | return aBounds; | |||
705 | } | |||
706 | ||||
707 | awt::Point VCLXAccessibleComponent::getLocationOnScreen( ) | |||
708 | { | |||
709 | OExternalLockGuard aGuard( this ); | |||
710 | ||||
711 | awt::Point aPos; | |||
712 | if ( GetWindow() ) | |||
713 | { | |||
714 | tools::Rectangle aRect = GetWindow()->GetWindowExtentsRelative( nullptr ); | |||
715 | aPos.X = aRect.Left(); | |||
716 | aPos.Y = aRect.Top(); | |||
717 | } | |||
718 | ||||
719 | return aPos; | |||
720 | } | |||
721 | ||||
722 | void VCLXAccessibleComponent::grabFocus( ) | |||
723 | { | |||
724 | OExternalLockGuard aGuard( this ); | |||
725 | ||||
726 | uno::Reference< accessibility::XAccessibleStateSet > xStates = getAccessibleStateSet(); | |||
727 | if ( m_xVCLXWindow.is() && xStates.is() && xStates->contains( accessibility::AccessibleStateType::FOCUSABLE ) ) | |||
728 | m_xVCLXWindow->setFocus(); | |||
729 | } | |||
730 | ||||
731 | sal_Int32 SAL_CALL VCLXAccessibleComponent::getForeground( ) | |||
732 | { | |||
733 | OExternalLockGuard aGuard( this ); | |||
734 | ||||
735 | Color nColor; | |||
736 | VclPtr<vcl::Window> pWindow = GetWindow(); | |||
737 | if ( pWindow ) | |||
738 | { | |||
739 | if ( pWindow->IsControlForeground() ) | |||
740 | nColor = pWindow->GetControlForeground(); | |||
741 | else | |||
742 | { | |||
743 | vcl::Font aFont; | |||
744 | if ( pWindow->IsControlFont() ) | |||
745 | aFont = pWindow->GetControlFont(); | |||
746 | else | |||
747 | aFont = pWindow->GetFont(); | |||
748 | nColor = aFont.GetColor(); | |||
749 | // COL_AUTO is not very meaningful for AT | |||
750 | if ( nColor == COL_AUTO) | |||
751 | nColor = pWindow->GetTextColor(); | |||
752 | } | |||
753 | } | |||
754 | ||||
755 | return sal_Int32(nColor); | |||
756 | } | |||
757 | ||||
758 | sal_Int32 SAL_CALL VCLXAccessibleComponent::getBackground( ) | |||
759 | { | |||
760 | OExternalLockGuard aGuard( this ); | |||
761 | ||||
762 | Color nColor; | |||
763 | VclPtr<vcl::Window> pWindow = GetWindow(); | |||
764 | if ( pWindow ) | |||
765 | { | |||
766 | if ( pWindow->IsControlBackground() ) | |||
767 | nColor = pWindow->GetControlBackground(); | |||
768 | else | |||
769 | nColor = pWindow->GetBackground().GetColor(); | |||
770 | } | |||
771 | ||||
772 | return sal_Int32(nColor); | |||
773 | } | |||
774 | ||||
775 | // XAccessibleExtendedComponent | |||
776 | ||||
777 | uno::Reference< awt::XFont > SAL_CALL VCLXAccessibleComponent::getFont( ) | |||
778 | { | |||
779 | OExternalLockGuard aGuard( this ); | |||
780 | ||||
781 | uno::Reference< awt::XFont > xFont; | |||
782 | VclPtr<vcl::Window> pWindow = GetWindow(); | |||
783 | if ( pWindow ) | |||
784 | { | |||
785 | uno::Reference< awt::XDevice > xDev( pWindow->GetComponentInterface(), uno::UNO_QUERY ); | |||
786 | if ( xDev.is() ) | |||
787 | { | |||
788 | vcl::Font aFont; | |||
789 | if ( pWindow->IsControlFont() ) | |||
790 | aFont = pWindow->GetControlFont(); | |||
791 | else | |||
792 | aFont = pWindow->GetFont(); | |||
793 | VCLXFont* pVCLXFont = new VCLXFont; | |||
794 | pVCLXFont->Init( *xDev, aFont ); | |||
795 | xFont = pVCLXFont; | |||
796 | } | |||
797 | } | |||
798 | ||||
799 | return xFont; | |||
800 | } | |||
801 | ||||
802 | OUString SAL_CALL VCLXAccessibleComponent::getTitledBorderText( ) | |||
803 | { | |||
804 | OExternalLockGuard aGuard( this ); | |||
805 | ||||
806 | OUString sRet; | |||
807 | if ( GetWindow() ) | |||
808 | sRet = GetWindow()->GetText(); | |||
809 | ||||
810 | return sRet; | |||
811 | } | |||
812 | ||||
813 | OUString SAL_CALL VCLXAccessibleComponent::getToolTipText( ) | |||
814 | { | |||
815 | OExternalLockGuard aGuard( this ); | |||
816 | ||||
817 | OUString sRet; | |||
818 | if ( GetWindow() ) | |||
819 | sRet = GetWindow()->GetQuickHelpText(); | |||
820 | ||||
821 | return sRet; | |||
822 | } | |||
823 | ||||
824 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
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_TOOLKIT_AWT_VCLXWINDOW_HXX |
21 | #define INCLUDED_TOOLKIT_AWT_VCLXWINDOW_HXX |
22 | |
23 | #include <toolkit/dllapi.h> |
24 | #include <toolkit/awt/vclxdevice.hxx> |
25 | #include <vcl/window.hxx> |
26 | |
27 | #include <com/sun/star/awt/XWindow2.hpp> |
28 | #include <com/sun/star/awt/XVclWindowPeer.hpp> |
29 | #include <com/sun/star/awt/XLayoutConstrains.hpp> |
30 | #include <com/sun/star/awt/XView.hpp> |
31 | #include <com/sun/star/beans/XPropertySetInfo.hpp> |
32 | #include <com/sun/star/accessibility/XAccessible.hpp> |
33 | #include <com/sun/star/awt/XDockableWindow.hpp> |
34 | #include <com/sun/star/awt/XStyleSettingsSupplier.hpp> |
35 | |
36 | #include <comphelper/servicehelper.hxx> |
37 | #include <cppuhelper/implbase.hxx> |
38 | |
39 | #include <tools/gen.hxx> |
40 | #include <tools/link.hxx> |
41 | |
42 | #include <memory> |
43 | #include <vector> |
44 | #include <functional> |
45 | |
46 | namespace comphelper { class OInterfaceContainerHelper2; } |
47 | namespace com::sun::star::accessibility { class XAccessibleContext; } |
48 | |
49 | class VclWindowEvent; |
50 | |
51 | namespace toolkit |
52 | { |
53 | class IAccessibleFactory; |
54 | } |
55 | |
56 | |
57 | class UnoPropertyArrayHelper; |
58 | class VCLXWindowImpl; |
59 | typedef cppu::ImplInheritanceHelper< VCLXDevice, |
60 | css::awt::XWindow2, |
61 | css::awt::XVclWindowPeer, |
62 | css::awt::XLayoutConstrains, |
63 | css::awt::XView, |
64 | css::awt::XDockableWindow, |
65 | css::accessibility::XAccessible, |
66 | css::lang::XEventListener, |
67 | css::beans::XPropertySetInfo, |
68 | css::awt::XStyleSettingsSupplier |
69 | > VCLXWindow_Base; |
70 | |
71 | class TOOLKIT_DLLPUBLIC__attribute__ ((visibility("default"))) VCLXWindow : public VCLXWindow_Base |
72 | { |
73 | private: |
74 | std::unique_ptr<VCLXWindowImpl> mpImpl; |
75 | |
76 | UnoPropertyArrayHelper *GetPropHelper(); |
77 | |
78 | protected: |
79 | Size ImplCalcWindowSize( const Size& rOutSz ) const; |
80 | DECL_LINK(WindowEventListener, VclWindowEvent&, void )static void LinkStubWindowEventListener(void *, VclWindowEvent &); void WindowEventListener(VclWindowEvent&); |
81 | |
82 | virtual void ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent ); |
83 | virtual css::uno::Reference< css::accessibility::XAccessibleContext > |
84 | CreateAccessibleContext(); |
85 | |
86 | void SetSynthesizingVCLEvent( bool b ); |
87 | bool IsSynthesizingVCLEvent() const; |
88 | |
89 | void SetSystemParent_Impl( const css::uno::Any& rHandle ); |
90 | |
91 | ::toolkit::IAccessibleFactory& getAccessibleFactory(); |
92 | |
93 | // helper ... |
94 | static void PushPropertyIds( std::vector< sal_uInt16 > &aIds, int nFirstId, ...); |
95 | // for use in controls/ |
96 | static void ImplGetPropertyIds( std::vector< sal_uInt16 > &aIds, |
97 | bool bWithDefaults = false ); |
98 | virtual void GetPropertyIds( std::vector< sal_uInt16 > &aIds ); |
99 | |
100 | ::comphelper::OInterfaceContainerHelper2& GetContainerListeners(); |
101 | ::comphelper::OInterfaceContainerHelper2& GetTopWindowListeners(); |
102 | |
103 | public: |
104 | typedef ::std::function<void ()> Callback; |
105 | |
106 | protected: |
107 | /** executes the given callback asynchronously |
108 | |
109 | At the moment the callback is called, the Solar Mutex is not locked. In particular, this implies that |
110 | you cannot rely on |this| not being disposed. However, you *can* rely on |this| being still alive (i.e. |
111 | having a ref count > 0). |
112 | |
113 | As a consequence, this can be used for doing listener notifications, using event multiplexers. Those multiplexers |
114 | care for the disposed state themself, and are alive as long as |this| is alive. |
115 | */ |
116 | void ImplExecuteAsyncWithoutSolarLock( |
117 | const Callback& i_callback |
118 | ); |
119 | |
120 | public: |
121 | VCLXWindow( bool bWithDefaultProps = false ); |
122 | virtual ~VCLXWindow() override; |
123 | |
124 | virtual void SetWindow( const VclPtr< vcl::Window > &pWindow ); |
125 | template< class derived_type > VclPtr< derived_type > GetAs() const { |
126 | return VclPtr< derived_type >( static_cast< derived_type * >( GetOutputDevice().get() ) ); } |
127 | template< class derived_type > VclPtr< derived_type > GetAsDynamic() const { |
128 | return VclPtr< derived_type >( dynamic_cast< derived_type * >( GetOutputDevice().get() ) ); } |
129 | VclPtr<vcl::Window> GetWindow() const { return GetAs<vcl::Window>(); } |
130 | |
131 | void suspendVclEventListening( ); |
132 | void resumeVclEventListening( ); |
133 | |
134 | void notifyWindowRemoved( vcl::Window const & _rWindow ); |
135 | |
136 | // css::lang::XUnoTunnel |
137 | UNO3_GETIMPLEMENTATION_DECL(VCLXWindow)static const css::uno::Sequence< sal_Int8 > & getUnoTunnelId () throw(); virtual sal_Int64 getSomething( const css::uno::Sequence < sal_Int8 >& aIdentifier ) override; |
138 | |
139 | // css::lang::XEventListener |
140 | virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override; |
141 | |
142 | // css::lang::XComponent |
143 | void SAL_CALL dispose( ) override; |
144 | void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override; |
145 | void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override; |
146 | |
147 | // css::awt::XWindow |
148 | void SAL_CALL setPosSize( sal_Int32 X, sal_Int32 Y, sal_Int32 Width, sal_Int32 Height, sal_Int16 Flags ) override; |
149 | css::awt::Rectangle SAL_CALL getPosSize( ) override; |
150 | void SAL_CALL setVisible( sal_Bool Visible ) override; |
151 | void SAL_CALL setEnable( sal_Bool Enable ) override; |
152 | void SAL_CALL setFocus( ) override; |
153 | void SAL_CALL addWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override; |
154 | void SAL_CALL removeWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override; |
155 | void SAL_CALL addFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override; |
156 | void SAL_CALL removeFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override; |
157 | void SAL_CALL addKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override; |
158 | void SAL_CALL removeKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override; |
159 | void SAL_CALL addMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override; |
160 | void SAL_CALL removeMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override; |
161 | void SAL_CALL addMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override; |
162 | void SAL_CALL removeMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override; |
163 | void SAL_CALL addPaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override; |
164 | void SAL_CALL removePaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override; |
165 | |
166 | // css::awt::XWindowPeer |
167 | css::uno::Reference< css::awt::XToolkit > SAL_CALL getToolkit( ) override; |
168 | void SAL_CALL setPointer( const css::uno::Reference< css::awt::XPointer >& Pointer ) override; |
169 | void SAL_CALL setBackground( sal_Int32 Color ) override; |
170 | void SAL_CALL invalidate( sal_Int16 Flags ) override; |
171 | void SAL_CALL invalidateRect( const css::awt::Rectangle& Rect, sal_Int16 Flags ) override; |
172 | |
173 | // css::awt::XVclWindowPeer |
174 | sal_Bool SAL_CALL isChild( const css::uno::Reference< css::awt::XWindowPeer >& Peer ) override; |
175 | void SAL_CALL setDesignMode( sal_Bool bOn ) override; |
176 | sal_Bool SAL_CALL isDesignMode( ) override; |
177 | void SAL_CALL enableClipSiblings( sal_Bool bClip ) override; |
178 | void SAL_CALL setForeground( sal_Int32 Color ) override; |
179 | void SAL_CALL setControlFont( const css::awt::FontDescriptor& aFont ) override; |
180 | void SAL_CALL getStyles( sal_Int16 nType, css::awt::FontDescriptor& Font, sal_Int32& ForegroundColor, sal_Int32& BackgroundColor ) override; |
181 | void SAL_CALL setProperty( const OUString& PropertyName, const css::uno::Any& Value ) override; |
182 | css::uno::Any SAL_CALL getProperty( const OUString& PropertyName ) override; |
183 | |
184 | // css::awt::XLayoutConstrains |
185 | css::awt::Size SAL_CALL getMinimumSize( ) override; |
186 | css::awt::Size SAL_CALL getPreferredSize( ) override; |
187 | css::awt::Size SAL_CALL calcAdjustedSize( const css::awt::Size& aNewSize ) override; |
188 | |
189 | // css::awt::XView |
190 | sal_Bool SAL_CALL setGraphics( const css::uno::Reference< css::awt::XGraphics >& aDevice ) override; |
191 | css::uno::Reference< css::awt::XGraphics > SAL_CALL getGraphics( ) override; |
192 | css::awt::Size SAL_CALL getSize( ) override; |
193 | void SAL_CALL draw( sal_Int32 nX, sal_Int32 nY ) override; |
194 | void SAL_CALL setZoom( float fZoomX, float fZoomY ) override; |
195 | |
196 | // css::accessibility::XAccessible |
197 | css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext( ) override; |
198 | |
199 | // css::awt::XDockableWindow |
200 | void SAL_CALL addDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override; |
201 | void SAL_CALL removeDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override; |
202 | void SAL_CALL enableDocking( sal_Bool bEnable ) override; |
203 | sal_Bool SAL_CALL isFloating( ) override; |
204 | void SAL_CALL setFloatingMode( sal_Bool bFloating ) override; |
205 | void SAL_CALL lock( ) override; |
206 | void SAL_CALL unlock( ) override; |
207 | sal_Bool SAL_CALL isLocked( ) override; |
208 | void SAL_CALL startPopupMode( const css::awt::Rectangle& WindowRect ) override; |
209 | sal_Bool SAL_CALL isInPopupMode( ) override; |
210 | |
211 | // css::awt::XWindow2 |
212 | void SAL_CALL setOutputSize( const css::awt::Size& aSize ) override; |
213 | css::awt::Size SAL_CALL getOutputSize( ) override; |
214 | sal_Bool SAL_CALL isVisible( ) override; |
215 | sal_Bool SAL_CALL isActive( ) override; |
216 | sal_Bool SAL_CALL isEnabled( ) override; |
217 | sal_Bool SAL_CALL hasFocus( ) override; |
218 | |
219 | // css::beans::XPropertySetInfo |
220 | css::uno::Sequence< css::beans::Property > SAL_CALL getProperties( ) override; |
221 | css::beans::Property SAL_CALL getPropertyByName( const OUString& aName ) override; |
222 | sal_Bool SAL_CALL hasPropertyByName( const OUString& Name ) override; |
223 | |
224 | // XStyleSettingsSupplier |
225 | virtual css::uno::Reference< css::awt::XStyleSettings > SAL_CALL getStyleSettings() override; |
226 | }; |
227 | |
228 | #endif // INCLUDED_TOOLKIT_AWT_VCLXWINDOW_HXX |
229 | |
230 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
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 | |
36 | class VclReferenceBase; |
37 | |
38 | namespace vcl::detail { |
39 | |
40 | template<typename> |
41 | constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; } |
42 | |
43 | template<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 | */ |
56 | template <class reference_type> |
57 | class 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 | |
66 | public: |
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); |
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 | |
218 | template<typename T1, typename T2> |
219 | inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
220 | return p1.get() == p2.get(); |
221 | } |
222 | |
223 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2) |
224 | { |
225 | return p1.get() == p2; |
226 | } |
227 | |
228 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) { |
229 | return p1.get() == p2; |
230 | } |
231 | |
232 | template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2) |
233 | { |
234 | return p1 == p2.get(); |
235 | } |
236 | |
237 | template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) { |
238 | return p1 == p2.get(); |
239 | } |
240 | |
241 | template<typename T1, typename T2> |
242 | inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
243 | return !(p1 == p2); |
244 | } |
245 | |
246 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2) |
247 | { |
248 | return !(p1 == p2); |
249 | } |
250 | |
251 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) { |
252 | return !(p1 == p2); |
253 | } |
254 | |
255 | template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2) |
256 | { |
257 | return !(p1 == p2); |
258 | } |
259 | |
260 | template<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 | */ |
274 | template <class reference_type> |
275 | class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type> |
276 | { |
277 | public: |
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 | |
290 | template <class reference_type> |
291 | class ScopedVclPtr : public VclPtr<reference_type> |
292 | { |
293 | public: |
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 | |
378 | private: |
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 | |
387 | protected: |
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 |
406 | template <class reference_type> |
407 | class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type> |
408 | { |
409 | public: |
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 | |
421 | private: |
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: */ |
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 | |||||||||||
34 | namespace rtl | ||||||||||
35 | { | ||||||||||
36 | |||||||||||
37 | /** Template reference class for reference type. | ||||||||||
38 | */ | ||||||||||
39 | template <class reference_type> | ||||||||||
40 | class Reference | ||||||||||
41 | { | ||||||||||
42 | /** The <b>reference_type</b> body pointer. | ||||||||||
43 | */ | ||||||||||
44 | reference_type * m_pBody; | ||||||||||
45 | |||||||||||
46 | |||||||||||
47 | public: | ||||||||||
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
| ||||||||||
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) | ||||||||||
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; | ||||||||||
| |||||||||||
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 | ||||||||||
277 | namespace 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 | */ | ||||||||||
286 | template<typename T> | ||||||||||
287 | struct 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: */ |
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 | |
25 | class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase |
26 | { |
27 | mutable oslInterlockedCount mnRefCnt; |
28 | |
29 | template<typename T> friend class VclPtr; |
30 | |
31 | public: |
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) |
40 | delete this; |
41 | } |
42 | #ifdef DBG_UTIL |
43 | #ifndef _WIN32 |
44 | sal_Int32 getRefCount() const { return mnRefCnt; } |
45 | #endif |
46 | #endif |
47 | |
48 | |
49 | private: |
50 | VclReferenceBase(const VclReferenceBase&) = delete; |
51 | VclReferenceBase& operator=(const VclReferenceBase&) = delete; |
52 | |
53 | bool mbDisposed : 1; |
54 | |
55 | protected: |
56 | VclReferenceBase(); |
57 | protected: |
58 | virtual ~VclReferenceBase(); |
59 | |
60 | protected: |
61 | virtual void dispose(); |
62 | |
63 | public: |
64 | void disposeOnce(); |
65 | bool isDisposed() const { return mbDisposed; } |
66 | |
67 | }; |
68 | #endif |