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 | ||||
21 | #include <vcl/toolkit/ivctrl.hxx> | |||
22 | #include "imivctl.hxx" | |||
23 | #include <vcl/accessiblefactory.hxx> | |||
24 | #include <vcl/bitmapex.hxx> | |||
25 | #include <vcl/commandevent.hxx> | |||
26 | #include <vcl/mnemonic.hxx> | |||
27 | #include <vcl/settings.hxx> | |||
28 | #include <vcl/tabctrl.hxx> | |||
29 | #include <vcl/vclevent.hxx> | |||
30 | #include <vcl/uitest/uiobject.hxx> | |||
31 | #include <verticaltabctrl.hxx> | |||
32 | ||||
33 | using namespace ::com::sun::star::accessibility; | |||
34 | ||||
35 | /***************************************************************************** | |||
36 | | | |||
37 | | class : SvxIconChoiceCtrlEntry | |||
38 | | | |||
39 | \*****************************************************************************/ | |||
40 | ||||
41 | SvxIconChoiceCtrlEntry::SvxIconChoiceCtrlEntry( const OUString& rText, | |||
42 | const Image& rImage ) | |||
43 | : aImage(rImage) | |||
44 | , aText(rText) | |||
45 | , nPos(0) | |||
46 | , pblink(nullptr) | |||
47 | , pflink(nullptr) | |||
48 | , eTextMode(SvxIconChoiceCtrlTextMode::Short) | |||
49 | , nX(0) | |||
50 | , nY(0) | |||
51 | , nFlags(SvxIconViewFlags::NONE) | |||
52 | { | |||
53 | } | |||
54 | ||||
55 | OUString SvxIconChoiceCtrlEntry::GetDisplayText() const | |||
56 | { | |||
57 | return MnemonicGenerator::EraseAllMnemonicChars( aText ); | |||
58 | } | |||
59 | ||||
60 | ||||
61 | SvxIconChoiceCtrlColumnInfo::SvxIconChoiceCtrlColumnInfo( const SvxIconChoiceCtrlColumnInfo& rInfo ) | |||
62 | { | |||
63 | nWidth = rInfo.nWidth; | |||
64 | } | |||
65 | ||||
66 | /***************************************************************************** | |||
67 | | | |||
68 | | class : SvtIconChoiceCtrl | |||
69 | | | |||
70 | \*****************************************************************************/ | |||
71 | ||||
72 | SvtIconChoiceCtrl::SvtIconChoiceCtrl( vcl::Window* pParent, WinBits nWinStyle ) : | |||
73 | ||||
74 | // WB_CLIPCHILDREN on, as ScrollBars lie on the window! | |||
75 | Control( pParent, nWinStyle | WB_CLIPCHILDREN ), | |||
76 | ||||
77 | _pImpl ( new SvxIconChoiceCtrl_Impl( this, nWinStyle ) ) | |||
78 | { | |||
79 | SetLineColor(); | |||
80 | _pImpl->InitSettings(); | |||
81 | _pImpl->SetPositionMode( SvxIconChoiceCtrlPositionMode::AutoArrange ); | |||
82 | } | |||
83 | ||||
84 | SvtIconChoiceCtrl::~SvtIconChoiceCtrl() | |||
85 | { | |||
86 | disposeOnce(); | |||
87 | } | |||
88 | ||||
89 | void SvtIconChoiceCtrl::dispose() | |||
90 | { | |||
91 | if (_pImpl) | |||
92 | { | |||
93 | _pImpl->CallEventListeners( VclEventId::ObjectDying, nullptr ); | |||
94 | _pImpl.reset(); | |||
95 | } | |||
96 | Control::dispose(); | |||
97 | } | |||
98 | ||||
99 | SvxIconChoiceCtrlEntry* SvtIconChoiceCtrl::InsertEntry( const OUString& rText, const Image& rImage ) | |||
100 | { | |||
101 | SvxIconChoiceCtrlEntry* pEntry = new SvxIconChoiceCtrlEntry( rText, rImage); | |||
102 | ||||
103 | _pImpl->InsertEntry(std::unique_ptr<SvxIconChoiceCtrlEntry>(pEntry), _pImpl->GetEntryCount()); | |||
104 | ||||
105 | return pEntry; | |||
106 | } | |||
107 | ||||
108 | void SvtIconChoiceCtrl::RemoveEntry(sal_Int32 nIndex) | |||
109 | { | |||
110 | _pImpl->RemoveEntry(nIndex); | |||
111 | } | |||
112 | ||||
113 | void SvtIconChoiceCtrl::DrawEntryImage( SvxIconChoiceCtrlEntry const * pEntry, const Point& rPos, OutputDevice& rDev ) | |||
114 | { | |||
115 | rDev.DrawImage( rPos, pEntry->GetImage() ); | |||
116 | } | |||
117 | ||||
118 | OUString SvtIconChoiceCtrl::GetEntryText( SvxIconChoiceCtrlEntry const * pEntry ) | |||
119 | { | |||
120 | return pEntry->GetText(); | |||
121 | } | |||
122 | ||||
123 | void SvtIconChoiceCtrl::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) | |||
124 | { | |||
125 | _pImpl->Paint(rRenderContext, rRect); | |||
126 | } | |||
127 | ||||
128 | void SvtIconChoiceCtrl::MouseButtonDown( const MouseEvent& rMEvt ) | |||
129 | { | |||
130 | if( !_pImpl->MouseButtonDown( rMEvt ) ) | |||
131 | Control::MouseButtonDown( rMEvt ); | |||
132 | } | |||
133 | ||||
134 | void SvtIconChoiceCtrl::MouseButtonUp( const MouseEvent& rMEvt ) | |||
135 | { | |||
136 | if( !_pImpl->MouseButtonUp( rMEvt ) ) | |||
137 | Control::MouseButtonUp( rMEvt ); | |||
138 | } | |||
139 | ||||
140 | void SvtIconChoiceCtrl::MouseMove( const MouseEvent& rMEvt ) | |||
141 | { | |||
142 | if( !_pImpl->MouseMove( rMEvt ) ) | |||
143 | Control::MouseMove( rMEvt ); | |||
144 | } | |||
145 | void SvtIconChoiceCtrl::ArrangeIcons() | |||
146 | { | |||
147 | if ( GetStyle() & WB_ALIGN_TOPWB_TOP ) | |||
148 | { | |||
149 | Size aFullSize; | |||
150 | tools::Rectangle aEntryRect; | |||
151 | ||||
152 | for ( sal_Int32 i = 0; i < GetEntryCount(); i++ ) | |||
153 | { | |||
154 | SvxIconChoiceCtrlEntry* pEntry = GetEntry ( i ); | |||
155 | aEntryRect = _pImpl->GetEntryBoundRect ( pEntry ); | |||
156 | ||||
157 | aFullSize.setWidth ( aFullSize.getWidth()+aEntryRect.GetWidth() ); | |||
158 | } | |||
159 | ||||
160 | _pImpl->Arrange ( false, aFullSize.getWidth(), 0 ); | |||
161 | } | |||
162 | else if ( GetStyle() & WB_ALIGN_LEFTWB_LEFT ) | |||
163 | { | |||
164 | Size aFullSize; | |||
165 | tools::Rectangle aEntryRect; | |||
166 | ||||
167 | for ( sal_Int32 i = 0; i < GetEntryCount(); i++ ) | |||
168 | { | |||
169 | SvxIconChoiceCtrlEntry* pEntry = GetEntry ( i ); | |||
170 | aEntryRect = _pImpl->GetEntryBoundRect ( pEntry ); | |||
171 | ||||
172 | aFullSize.setHeight ( aFullSize.getHeight()+aEntryRect.GetHeight() ); | |||
173 | } | |||
174 | ||||
175 | _pImpl->Arrange ( false, 0, aFullSize.getHeight() ); | |||
176 | } | |||
177 | else | |||
178 | { | |||
179 | _pImpl->Arrange(false, 0, 0); | |||
180 | } | |||
181 | _pImpl->Arrange( false, 0, 1000 ); | |||
182 | } | |||
183 | void SvtIconChoiceCtrl::Resize() | |||
184 | { | |||
185 | _pImpl->Resize(); | |||
186 | Control::Resize(); | |||
187 | } | |||
188 | ||||
189 | void SvtIconChoiceCtrl::GetFocus() | |||
190 | { | |||
191 | _pImpl->GetFocus(); | |||
192 | Control::GetFocus(); | |||
193 | SvxIconChoiceCtrlEntry* pSelectedEntry = GetSelectedEntry(); | |||
194 | if ( pSelectedEntry ) | |||
195 | _pImpl->CallEventListeners( VclEventId::ListboxSelect, pSelectedEntry ); | |||
196 | } | |||
197 | ||||
198 | void SvtIconChoiceCtrl::LoseFocus() | |||
199 | { | |||
200 | if (_pImpl) | |||
201 | _pImpl->LoseFocus(); | |||
202 | Control::LoseFocus(); | |||
203 | } | |||
204 | ||||
205 | void SvtIconChoiceCtrl::SetFont(const vcl::Font& rFont) | |||
206 | { | |||
207 | if (rFont != GetFont()) | |||
208 | { | |||
209 | Control::SetFont(rFont); | |||
210 | _pImpl->FontModified(); | |||
211 | } | |||
212 | } | |||
213 | ||||
214 | void SvtIconChoiceCtrl::SetPointFont(const vcl::Font& rFont) | |||
215 | { | |||
216 | if (rFont != GetPointFont(*this)) //FIXME | |||
217 | { | |||
218 | Control::SetPointFont(*this, rFont); //FIXME | |||
219 | _pImpl->FontModified(); | |||
220 | } | |||
221 | } | |||
222 | ||||
223 | WinBits SvtIconChoiceCtrl::GetStyle() const | |||
224 | { | |||
225 | return _pImpl->GetStyle(); | |||
226 | } | |||
227 | ||||
228 | void SvtIconChoiceCtrl::Command(const CommandEvent& rCEvt) | |||
229 | { | |||
230 | _pImpl->Command( rCEvt ); | |||
231 | //pass at least alt press/release to parent impl | |||
232 | if (rCEvt.GetCommand() == CommandEventId::ModKeyChange) | |||
233 | Control::Command(rCEvt); | |||
234 | } | |||
235 | ||||
236 | #ifdef DBG_UTIL | |||
237 | void SvtIconChoiceCtrl::SetEntryTextMode( SvxIconChoiceCtrlTextMode eMode, SvxIconChoiceCtrlEntry* pEntry ) | |||
238 | { | |||
239 | _pImpl->SetEntryTextMode( eMode, pEntry ); | |||
240 | } | |||
241 | #endif | |||
242 | ||||
243 | sal_Int32 SvtIconChoiceCtrl::GetEntryCount() const | |||
244 | { | |||
245 | return _pImpl ? _pImpl->GetEntryCount() : 0; | |||
246 | } | |||
247 | ||||
248 | SvxIconChoiceCtrlEntry* SvtIconChoiceCtrl::GetEntry( sal_Int32 nPos ) const | |||
249 | { | |||
250 | return _pImpl ? _pImpl->GetEntry( nPos ) : nullptr; | |||
251 | } | |||
252 | ||||
253 | SvxIconChoiceCtrlEntry* SvtIconChoiceCtrl::GetSelectedEntry() const | |||
254 | { | |||
255 | return _pImpl ? _pImpl->GetFirstSelectedEntry() : nullptr; | |||
256 | } | |||
257 | ||||
258 | void SvtIconChoiceCtrl::ClickIcon() | |||
259 | { | |||
260 | GetSelectedEntry(); | |||
261 | _aClickIconHdl.Call( this ); | |||
262 | } | |||
263 | ||||
264 | void SvtIconChoiceCtrl::KeyInput( const KeyEvent& rKEvt ) | |||
265 | { | |||
266 | bool bKeyUsed = DoKeyInput( rKEvt ); | |||
267 | if ( !bKeyUsed ) | |||
268 | { | |||
269 | Control::KeyInput( rKEvt ); | |||
270 | } | |||
271 | } | |||
272 | bool SvtIconChoiceCtrl::DoKeyInput( const KeyEvent& rKEvt ) | |||
273 | { | |||
274 | return _pImpl->KeyInput( rKEvt ); | |||
275 | } | |||
276 | sal_Int32 SvtIconChoiceCtrl::GetEntryListPos( SvxIconChoiceCtrlEntry const * pEntry ) const | |||
277 | { | |||
278 | return _pImpl->GetEntryListPos( pEntry ); | |||
279 | } | |||
280 | SvxIconChoiceCtrlEntry* SvtIconChoiceCtrl::GetCursor( ) const | |||
281 | { | |||
282 | return _pImpl->GetCurEntry( ); | |||
283 | } | |||
284 | void SvtIconChoiceCtrl::SetCursor( SvxIconChoiceCtrlEntry* pEntry ) | |||
285 | { | |||
286 | _pImpl->SetCursor( pEntry ); | |||
287 | } | |||
288 | ||||
289 | void SvtIconChoiceCtrl::DataChanged( const DataChangedEvent& rDCEvt ) | |||
290 | { | |||
291 | if ( ((rDCEvt.GetType() == DataChangedEventType::SETTINGS) || | |||
292 | (rDCEvt.GetType() == DataChangedEventType::FONTSUBSTITUTION) || | |||
293 | (rDCEvt.GetType() == DataChangedEventType::FONTS) ) && | |||
294 | (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) ) | |||
295 | { | |||
296 | _pImpl->InitSettings(); | |||
297 | Invalidate(InvalidateFlags::NoChildren); | |||
298 | } | |||
299 | else | |||
300 | Control::DataChanged( rDCEvt ); | |||
301 | } | |||
302 | ||||
303 | void SvtIconChoiceCtrl::SetBackground( const Wallpaper& rPaper ) | |||
304 | { | |||
305 | if( rPaper == GetBackground() ) | |||
306 | return; | |||
307 | ||||
308 | const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings(); | |||
309 | // if it is the default (empty) wallpaper | |||
310 | if (rPaper.IsEmpty()) | |||
311 | { | |||
312 | Control::SetBackground( rStyleSettings.GetFieldColor() ); | |||
313 | } | |||
314 | else | |||
315 | { | |||
316 | Wallpaper aBackground( rPaper ); | |||
317 | // HACK, as background might be transparent! | |||
318 | if( !aBackground.IsBitmap() ) | |||
319 | aBackground.SetStyle( WallpaperStyle::Tile ); | |||
320 | ||||
321 | WallpaperStyle eStyle = aBackground.GetStyle(); | |||
322 | Color aBack( aBackground.GetColor()); | |||
323 | if( aBack == COL_TRANSPARENT && | |||
324 | (!aBackground.IsBitmap() || | |||
325 | aBackground.GetBitmap().IsTransparent() || | |||
326 | (eStyle != WallpaperStyle::Tile && eStyle != WallpaperStyle::Scale)) ) | |||
327 | { | |||
328 | aBackground.SetColor( rStyleSettings.GetFieldColor() ); | |||
329 | } | |||
330 | if( aBackground.IsScrollable() ) | |||
331 | { | |||
332 | tools::Rectangle aRect; | |||
333 | aRect.SetSize( Size(32765, 32765) ); | |||
334 | aBackground.SetRect( aRect ); | |||
335 | } | |||
336 | else | |||
337 | { | |||
338 | tools::Rectangle aRect( _pImpl->GetOutputRect() ); | |||
339 | aBackground.SetRect( aRect ); | |||
340 | } | |||
341 | Control::SetBackground( aBackground ); | |||
342 | } | |||
343 | ||||
344 | // If text colors are attributed "hard," don't use automatism to select | |||
345 | // a readable text color. | |||
346 | vcl::Font aFont( GetFont() ); | |||
347 | aFont.SetColor( rStyleSettings.GetFieldTextColor() ); | |||
348 | SetFont( aFont ); | |||
349 | ||||
350 | Invalidate(InvalidateFlags::NoChildren); | |||
351 | } | |||
352 | ||||
353 | void SvtIconChoiceCtrl::RequestHelp( const HelpEvent& rHEvt ) | |||
354 | { | |||
355 | if ( !_pImpl->RequestHelp( rHEvt ) ) | |||
356 | Control::RequestHelp( rHEvt ); | |||
357 | } | |||
358 | ||||
359 | tools::Rectangle SvtIconChoiceCtrl::GetBoundingBox( SvxIconChoiceCtrlEntry* pEntry ) const | |||
360 | { | |||
361 | return _pImpl->GetEntryBoundRect( pEntry ); | |||
362 | } | |||
363 | ||||
364 | void SvtIconChoiceCtrl::FillLayoutData() const | |||
365 | { | |||
366 | CreateLayoutData(); | |||
367 | const_cast<SvtIconChoiceCtrl*>(this)->Invalidate(); | |||
368 | } | |||
369 | ||||
370 | tools::Rectangle SvtIconChoiceCtrl::GetEntryCharacterBounds( const sal_Int32 _nEntryPos, const sal_Int32 _nCharacterIndex ) const | |||
371 | { | |||
372 | tools::Rectangle aRect; | |||
373 | ||||
374 | Pair aEntryCharacterRange = GetLineStartEnd( _nEntryPos ); | |||
375 | if ( aEntryCharacterRange.A() + _nCharacterIndex < aEntryCharacterRange.B() ) | |||
376 | { | |||
377 | aRect = GetCharacterBounds( aEntryCharacterRange.A() + _nCharacterIndex ); | |||
378 | } | |||
379 | ||||
380 | return aRect; | |||
381 | } | |||
382 | ||||
383 | void SvtIconChoiceCtrl::SetNoSelection() | |||
384 | { | |||
385 | _pImpl->SetNoSelection(); | |||
386 | } | |||
387 | ||||
388 | void SvtIconChoiceCtrl::CallImplEventListeners(VclEventId nEvent, void* pData) | |||
389 | { | |||
390 | CallEventListeners(nEvent, pData); | |||
391 | } | |||
392 | css::uno::Reference< XAccessible > SvtIconChoiceCtrl::CreateAccessible() | |||
393 | { | |||
394 | vcl::Window* pParent = GetAccessibleParentWindow(); | |||
395 | DBG_ASSERT( pParent, "SvTreeListBox::CreateAccessible - accessible parent not found" )do { if (true && (!(pParent))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/ivctrl.cxx" ":" "395" ": "), "%s", "SvTreeListBox::CreateAccessible - accessible parent not found" ); } } while (false); | |||
396 | ||||
397 | css::uno::Reference< XAccessible > xAccessible; | |||
398 | if ( pParent ) | |||
399 | { | |||
400 | css::uno::Reference< XAccessible > xAccParent = pParent->GetAccessible(); | |||
401 | if ( xAccParent.is() ) | |||
402 | { | |||
403 | css::uno::Reference< css::awt::XWindowPeer > xHoldAlive(GetComponentInterface()); | |||
404 | xAccessible = _pImpl->GetAccessibleFactory().createAccessibleIconChoiceCtrl( *this, xAccParent ); | |||
405 | } | |||
406 | } | |||
407 | return xAccessible; | |||
408 | } | |||
409 | ||||
410 | struct VerticalTabPageData | |||
411 | { | |||
412 | OString sId; | |||
413 | SvxIconChoiceCtrlEntry* pEntry; | |||
414 | VclPtr<vcl::Window> xPage; ///< the TabPage itself | |||
415 | }; | |||
416 | ||||
417 | VerticalTabControl::VerticalTabControl(vcl::Window* pParent) | |||
418 | : VclHBox(pParent) | |||
419 | , m_xChooser(VclPtr<SvtIconChoiceCtrl>::Create(this, WB_3DLOOK | WB_ICONWB_RECTSTYLE | WB_BORDER | | |||
420 | WB_NOCOLUMNHEADERWB_CENTER | WB_HIGHLIGHTFRAMEWB_IGNORETAB | | |||
421 | WB_NODRAGSELECTIONWB_PATHELLIPSIS | WB_TABSTOP | WB_CLIPCHILDREN | | |||
422 | WB_ALIGN_LEFTWB_LEFT | WB_NOHSCROLLWB_SPIN)) | |||
423 | , m_xBox(VclPtr<VclVBox>::Create(this)) | |||
424 | { | |||
425 | SetType(WindowType::VERTICALTABCONTROL); | |||
426 | m_xChooser->SetClickHdl(LINK(this, VerticalTabControl, ChosePageHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<VerticalTabControl *>(this), &VerticalTabControl::LinkStubChosePageHdl_Impl )); | |||
427 | m_xChooser->set_width_request(110); | |||
428 | m_xChooser->set_height_request(400); | |||
429 | m_xChooser->SetSizePixel(Size(110, 400)); | |||
430 | m_xBox->set_vexpand(true); | |||
431 | m_xBox->set_hexpand(true); | |||
432 | m_xBox->set_expand(true); | |||
433 | m_xBox->Show(); | |||
434 | m_xChooser->Show(); | |||
435 | } | |||
436 | ||||
437 | VerticalTabControl::~VerticalTabControl() | |||
438 | { | |||
439 | disposeOnce(); | |||
440 | } | |||
441 | ||||
442 | void VerticalTabControl::dispose() | |||
443 | { | |||
444 | m_xChooser.disposeAndClear(); | |||
445 | m_xBox.disposeAndClear(); | |||
| ||||
446 | VclHBox::dispose(); | |||
447 | } | |||
448 | ||||
449 | IMPL_LINK_NOARG(VerticalTabControl, ChosePageHdl_Impl, SvtIconChoiceCtrl*, void)void VerticalTabControl::LinkStubChosePageHdl_Impl(void * instance , SvtIconChoiceCtrl* data) { return static_cast<VerticalTabControl *>(instance)->ChosePageHdl_Impl(data); } void VerticalTabControl ::ChosePageHdl_Impl(__attribute__ ((unused)) SvtIconChoiceCtrl *) | |||
450 | { | |||
451 | SvxIconChoiceCtrlEntry *pEntry = m_xChooser->GetSelectedEntry(); | |||
452 | if (!pEntry) | |||
453 | pEntry = m_xChooser->GetCursor(); | |||
454 | ||||
455 | VerticalTabPageData* pData = GetPageData(pEntry); | |||
456 | ||||
457 | if (pData->sId != m_sCurrentPageId) | |||
458 | SetCurPageId(pData->sId); | |||
459 | } | |||
460 | ||||
461 | void VerticalTabControl::ActivatePage() | |||
462 | { | |||
463 | m_aActivateHdl.Call( this ); | |||
464 | } | |||
465 | ||||
466 | bool VerticalTabControl::DeactivatePage() | |||
467 | { | |||
468 | return !m_aDeactivateHdl.IsSet() || m_aDeactivateHdl.Call(this); | |||
469 | } | |||
470 | ||||
471 | VerticalTabPageData* VerticalTabControl::GetPageData(const SvxIconChoiceCtrlEntry* pEntry) const | |||
472 | { | |||
473 | VerticalTabPageData* pRet = nullptr; | |||
474 | for (auto & pData : maPageList) | |||
475 | { | |||
476 | if (pData->pEntry == pEntry) | |||
477 | { | |||
478 | pRet = pData.get(); | |||
479 | break; | |||
480 | } | |||
481 | } | |||
482 | return pRet; | |||
483 | } | |||
484 | ||||
485 | VerticalTabPageData* VerticalTabControl::GetPageData(const OString& rId) const | |||
486 | { | |||
487 | VerticalTabPageData* pRet = nullptr; | |||
488 | for (auto & pData : maPageList) | |||
489 | { | |||
490 | if (pData->sId == rId) | |||
491 | { | |||
492 | pRet = pData.get(); | |||
493 | break; | |||
494 | } | |||
495 | } | |||
496 | return pRet; | |||
497 | } | |||
498 | ||||
499 | void VerticalTabControl::SetCurPageId(const OString& rId) | |||
500 | { | |||
501 | OString sOldPageId = GetCurPageId(); | |||
502 | if (sOldPageId == rId) | |||
503 | return; | |||
504 | ||||
505 | VerticalTabPageData* pOldData = GetPageData(sOldPageId); | |||
506 | if (pOldData && pOldData->xPage) | |||
507 | { | |||
508 | if (!DeactivatePage()) | |||
509 | return; | |||
510 | pOldData->xPage->Hide(); | |||
511 | } | |||
512 | ||||
513 | m_sCurrentPageId = ""; | |||
514 | ||||
515 | VerticalTabPageData* pNewData = GetPageData(rId); | |||
516 | if (pNewData && pNewData->xPage) | |||
517 | { | |||
518 | m_sCurrentPageId = rId; | |||
519 | m_xChooser->SetCursor(pNewData->pEntry); | |||
520 | ||||
521 | ActivatePage(); | |||
522 | pNewData->xPage->Show(); | |||
523 | } | |||
524 | } | |||
525 | ||||
526 | OString VerticalTabControl::GetPageId(sal_uInt16 nIndex) const | |||
527 | { | |||
528 | return maPageList[nIndex]->sId; | |||
529 | } | |||
530 | ||||
531 | void VerticalTabControl::InsertPage(const rtl::OString &rIdent, const rtl::OUString& rLabel, const Image& rImage, | |||
532 | const rtl::OUString& rTooltip, VclPtr<vcl::Window> xPage, int nPos) | |||
533 | { | |||
534 | SvxIconChoiceCtrlEntry* pEntry = m_xChooser->InsertEntry(rLabel, rImage); | |||
535 | pEntry->SetQuickHelpText(rTooltip); | |||
536 | m_xChooser->ArrangeIcons(); | |||
537 | VerticalTabPageData* pNew; | |||
538 | if (nPos == -1) | |||
539 | { | |||
540 | maPageList.emplace_back(new VerticalTabPageData); | |||
541 | pNew = maPageList.back().get(); | |||
542 | } | |||
543 | else | |||
544 | { | |||
545 | maPageList.emplace(maPageList.begin() + nPos, new VerticalTabPageData); | |||
546 | pNew = maPageList[nPos].get(); | |||
547 | } | |||
548 | pNew->sId = rIdent; | |||
549 | pNew->pEntry = pEntry; | |||
550 | pNew->xPage = xPage; | |||
551 | Size aOrigPrefSize(m_xBox->get_preferred_size()); | |||
552 | Size aPagePrefSize(xPage->get_preferred_size()); | |||
553 | m_xBox->set_width_request(std::max(aOrigPrefSize.Width(), aPagePrefSize.Width())); | |||
554 | m_xBox->set_height_request(std::max(aOrigPrefSize.Height(), aPagePrefSize.Height())); | |||
555 | pNew->xPage->Hide(); | |||
556 | } | |||
557 | ||||
558 | void VerticalTabControl::RemovePage(const rtl::OString &rPageId) | |||
559 | { | |||
560 | for (auto it = maPageList.begin(), end = maPageList.end(); it != end; ++it) | |||
561 | { | |||
562 | VerticalTabPageData* pData = it->get(); | |||
563 | if (pData->sId == rPageId) | |||
564 | { | |||
565 | sal_Int32 nEntryListPos = m_xChooser->GetEntryListPos(pData->pEntry); | |||
566 | m_xChooser->RemoveEntry(nEntryListPos); | |||
567 | m_xChooser->ArrangeIcons(); | |||
568 | maPageList.erase(it); | |||
569 | break; | |||
570 | } | |||
571 | } | |||
572 | } | |||
573 | ||||
574 | sal_uInt16 VerticalTabControl::GetPagePos(const OString& rPageId) const | |||
575 | { | |||
576 | VerticalTabPageData* pData = GetPageData(rPageId); | |||
577 | if (!pData) | |||
578 | return TAB_PAGE_NOTFOUND(sal_uInt16(0xFFFF)); | |||
579 | return m_xChooser->GetEntryListPos(pData->pEntry); | |||
580 | } | |||
581 | ||||
582 | VclPtr<vcl::Window> VerticalTabControl::GetPage(const OString& rPageId) | |||
583 | { | |||
584 | VerticalTabPageData* pData = GetPageData(rPageId); | |||
585 | if (!pData) | |||
586 | return nullptr; | |||
587 | return pData->xPage; | |||
588 | } | |||
589 | ||||
590 | OUString VerticalTabControl::GetPageText(const OString& rPageId) const | |||
591 | { | |||
592 | VerticalTabPageData* pData = GetPageData(rPageId); | |||
593 | if (!pData) | |||
594 | return OUString(); | |||
595 | return pData->pEntry->GetText(); | |||
596 | } | |||
597 | ||||
598 | void VerticalTabControl::SetPageText(const OString& rPageId, const OUString& rText) | |||
599 | { | |||
600 | VerticalTabPageData* pData = GetPageData(rPageId); | |||
601 | if (!pData) | |||
602 | return; | |||
603 | pData->pEntry->SetText(rText); | |||
604 | } | |||
605 | ||||
606 | FactoryFunction VerticalTabControl::GetUITestFactory() const | |||
607 | { | |||
608 | return VerticalTabControlUIObject::create; | |||
609 | } | |||
610 | ||||
611 | /* 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 |