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/roadmap.hxx> | |||
22 | #include <tools/debug.hxx> | |||
23 | #include <osl/diagnose.h> | |||
24 | ||||
25 | #include <strings.hrc> | |||
26 | #include <svdata.hxx> | |||
27 | #include <wizdlg.hxx> | |||
28 | ||||
29 | #include <vector> | |||
30 | #include <map> | |||
31 | #include <set> | |||
32 | ||||
33 | #include "wizimpldata.hxx" | |||
34 | #include <uiobject-internal.hxx> | |||
35 | ||||
36 | namespace vcl | |||
37 | { | |||
38 | using namespace RoadmapWizardTypes; | |||
39 | ||||
40 | namespace | |||
41 | { | |||
42 | typedef ::std::set< WizardTypes::WizardState > StateSet; | |||
43 | ||||
44 | typedef ::std::map< | |||
45 | PathId, | |||
46 | WizardPath | |||
47 | > Paths; | |||
48 | ||||
49 | typedef ::std::map< | |||
50 | WizardTypes::WizardState, | |||
51 | ::std::pair< | |||
52 | OUString, | |||
53 | RoadmapPageFactory | |||
54 | > | |||
55 | > StateDescriptions; | |||
56 | } | |||
57 | ||||
58 | struct RoadmapWizardImpl | |||
59 | { | |||
60 | ScopedVclPtr<ORoadmap> pRoadmap; | |||
61 | Paths aPaths; | |||
62 | PathId nActivePath; | |||
63 | StateDescriptions aStateDescriptors; | |||
64 | StateSet aDisabledStates; | |||
65 | bool bActivePathIsDefinite; | |||
66 | ||||
67 | RoadmapWizardImpl() | |||
68 | :pRoadmap( nullptr ) | |||
69 | ,nActivePath( -1 ) | |||
70 | ,bActivePathIsDefinite( false ) | |||
71 | { | |||
72 | } | |||
73 | ||||
74 | /// returns the index of the current state in given path, or -1 | |||
75 | static sal_Int32 getStateIndexInPath( WizardTypes::WizardState _nState, const WizardPath& _rPath ); | |||
76 | /// returns the index of the current state in the path with the given id, or -1 | |||
77 | sal_Int32 getStateIndexInPath( WizardTypes::WizardState _nState, PathId _nPathId ); | |||
78 | /// returns the index of the first state in which the two given paths differ | |||
79 | static sal_Int32 getFirstDifferentIndex( const WizardPath& _rLHS, const WizardPath& _rRHS ); | |||
80 | }; | |||
81 | ||||
82 | ||||
83 | sal_Int32 RoadmapWizardImpl::getStateIndexInPath( WizardTypes::WizardState _nState, const WizardPath& _rPath ) | |||
84 | { | |||
85 | sal_Int32 nStateIndexInPath = 0; | |||
86 | bool bFound = false; | |||
87 | for (auto const& path : _rPath) | |||
88 | { | |||
89 | if (path == _nState) | |||
90 | { | |||
91 | bFound = true; | |||
92 | break; | |||
93 | } | |||
94 | ++nStateIndexInPath; | |||
95 | } | |||
96 | if (!bFound) | |||
97 | nStateIndexInPath = -1; | |||
98 | return nStateIndexInPath; | |||
99 | } | |||
100 | ||||
101 | ||||
102 | sal_Int32 RoadmapWizardImpl::getStateIndexInPath( WizardTypes::WizardState _nState, PathId _nPathId ) | |||
103 | { | |||
104 | sal_Int32 nStateIndexInPath = -1; | |||
105 | Paths::const_iterator aPathPos = aPaths.find( _nPathId ); | |||
106 | if ( aPathPos != aPaths.end( ) ) | |||
107 | nStateIndexInPath = getStateIndexInPath( _nState, aPathPos->second ); | |||
108 | return nStateIndexInPath; | |||
109 | } | |||
110 | ||||
111 | ||||
112 | sal_Int32 RoadmapWizardImpl::getFirstDifferentIndex( const WizardPath& _rLHS, const WizardPath& _rRHS ) | |||
113 | { | |||
114 | sal_Int32 nMinLength = ::std::min( _rLHS.size(), _rRHS.size() ); | |||
115 | for ( sal_Int32 nCheck = 0; nCheck < nMinLength; ++nCheck ) | |||
116 | { | |||
117 | if ( _rLHS[ nCheck ] != _rRHS[ nCheck ] ) | |||
118 | return nCheck; | |||
119 | } | |||
120 | return nMinLength; | |||
121 | } | |||
122 | ||||
123 | //= RoadmapWizard | |||
124 | RoadmapWizard::RoadmapWizard(vcl::Window* pParent, WinBits nStyle, InitFlag eFlag) | |||
125 | : Dialog(pParent, nStyle, eFlag) | |||
126 | , m_pFinish(nullptr) | |||
127 | , m_pCancel(nullptr) | |||
128 | , m_pNextPage(nullptr) | |||
129 | , m_pPrevPage(nullptr) | |||
130 | , m_pHelp(nullptr) | |||
131 | , m_xWizardImpl(new WizardMachineImplData) | |||
132 | , m_xRoadmapImpl(new RoadmapWizardImpl) | |||
133 | { | |||
134 | mpFirstPage = nullptr; | |||
135 | mpFirstBtn = nullptr; | |||
136 | mpCurTabPage = nullptr; | |||
137 | mpPrevBtn = nullptr; | |||
138 | mpNextBtn = nullptr; | |||
139 | mpViewWindow = nullptr; | |||
140 | mnCurLevel = 0; | |||
141 | mbEmptyViewMargin = false; | |||
142 | mnLeftAlignCount = 0; | |||
143 | ||||
144 | maWizardLayoutIdle.SetPriority(TaskPriority::RESIZE); | |||
145 | maWizardLayoutIdle.SetInvokeHandler( LINK( this, RoadmapWizard, ImplHandleWizardLayoutTimerHdl )::tools::detail::makeLink( ::tools::detail::castTo<RoadmapWizard *>(this), &RoadmapWizard::LinkStubImplHandleWizardLayoutTimerHdl ) ); | |||
146 | ||||
147 | implConstruct(WizardButtonFlags::NEXT | WizardButtonFlags::PREVIOUS | WizardButtonFlags::FINISH | WizardButtonFlags::CANCEL | WizardButtonFlags::HELP); | |||
148 | ||||
149 | SetLeftAlignedButtonCount( 1 ); | |||
150 | mbEmptyViewMargin = true; | |||
151 | ||||
152 | m_xRoadmapImpl->pRoadmap.disposeAndReset( VclPtr<ORoadmap>::Create( this, WB_TABSTOP ) ); | |||
153 | m_xRoadmapImpl->pRoadmap->SetText( VclResId( STR_WIZDLG_ROADMAP_TITLEreinterpret_cast<char const *>("STR_WIZDLG_ROADMAP_TITLE" "\004" u8"Steps") ) ); | |||
154 | m_xRoadmapImpl->pRoadmap->SetPosPixel( Point( 0, 0 ) ); | |||
155 | m_xRoadmapImpl->pRoadmap->SetItemSelectHdl( LINK( this, RoadmapWizard, OnRoadmapItemSelected )::tools::detail::makeLink( ::tools::detail::castTo<RoadmapWizard *>(this), &RoadmapWizard::LinkStubOnRoadmapItemSelected ) ); | |||
156 | ||||
157 | Size aRoadmapSize = LogicToPixel(Size(85, 0), MapMode(MapUnit::MapAppFont)); | |||
158 | aRoadmapSize.setHeight( GetSizePixel().Height() ); | |||
159 | m_xRoadmapImpl->pRoadmap->SetSizePixel( aRoadmapSize ); | |||
160 | ||||
161 | mpViewWindow = m_xRoadmapImpl->pRoadmap; | |||
162 | m_xRoadmapImpl->pRoadmap->Show(); | |||
163 | } | |||
164 | ||||
165 | RoadmapWizardMachine::RoadmapWizardMachine(weld::Window* pParent) | |||
166 | : WizardMachine(pParent, WizardButtonFlags::NEXT | WizardButtonFlags::PREVIOUS | WizardButtonFlags::FINISH | WizardButtonFlags::CANCEL | WizardButtonFlags::HELP) | |||
167 | , m_pImpl( new RoadmapWizardImpl ) | |||
168 | { | |||
169 | m_xAssistant->connect_jump_page(LINK(this, RoadmapWizardMachine, OnRoadmapItemSelected)::tools::detail::makeLink( ::tools::detail::castTo<RoadmapWizardMachine *>(this), &RoadmapWizardMachine::LinkStubOnRoadmapItemSelected )); | |||
170 | } | |||
171 | ||||
172 | void RoadmapWizard::ShowRoadmap(bool bShow) | |||
173 | { | |||
174 | m_xRoadmapImpl->pRoadmap->Show(bShow); | |||
175 | CalcAndSetSize(); | |||
176 | } | |||
177 | ||||
178 | RoadmapWizard::~RoadmapWizard() | |||
179 | { | |||
180 | disposeOnce(); | |||
181 | } | |||
182 | ||||
183 | RoadmapWizardMachine::~RoadmapWizardMachine() | |||
184 | { | |||
185 | } | |||
186 | ||||
187 | void RoadmapWizard::dispose() | |||
188 | { | |||
189 | m_xRoadmapImpl.reset(); | |||
190 | ||||
191 | m_pFinish.disposeAndClear(); | |||
192 | m_pCancel.disposeAndClear(); | |||
193 | m_pNextPage.disposeAndClear(); | |||
194 | m_pPrevPage.disposeAndClear(); | |||
195 | m_pHelp.disposeAndClear(); | |||
| ||||
196 | ||||
197 | if (m_xWizardImpl) | |||
198 | { | |||
199 | for (WizardTypes::WizardState i = 0; i < m_xWizardImpl->nFirstUnknownPage; ++i) | |||
200 | { | |||
201 | TabPage *pPage = GetPage(i); | |||
202 | if (pPage) | |||
203 | pPage->disposeOnce(); | |||
204 | } | |||
205 | m_xWizardImpl.reset(); | |||
206 | } | |||
207 | ||||
208 | maWizardLayoutIdle.Stop(); | |||
209 | ||||
210 | // Remove all buttons | |||
211 | while ( mpFirstBtn ) | |||
212 | RemoveButton( mpFirstBtn->mpButton ); | |||
213 | ||||
214 | // Remove all pages | |||
215 | while ( mpFirstPage ) | |||
216 | RemovePage( mpFirstPage->mpPage ); | |||
217 | ||||
218 | mpCurTabPage.clear(); | |||
219 | mpPrevBtn.clear(); | |||
220 | mpNextBtn.clear(); | |||
221 | mpViewWindow.clear(); | |||
222 | Dialog::dispose(); | |||
223 | } | |||
224 | ||||
225 | void RoadmapWizard::SetRoadmapHelpId( const OString& _rId ) | |||
226 | { | |||
227 | m_xRoadmapImpl->pRoadmap->SetHelpId( _rId ); | |||
228 | } | |||
229 | ||||
230 | void RoadmapWizardMachine::SetRoadmapHelpId(const OString& rId) | |||
231 | { | |||
232 | m_xAssistant->set_page_side_help_id(rId); | |||
233 | } | |||
234 | ||||
235 | void RoadmapWizardMachine::declarePath( PathId _nPathId, const WizardPath& _lWizardStates) | |||
236 | { | |||
237 | m_pImpl->aPaths.emplace( _nPathId, _lWizardStates ); | |||
238 | ||||
239 | if ( m_pImpl->aPaths.size() == 1 ) | |||
240 | // the very first path -> activate it | |||
241 | activatePath( _nPathId ); | |||
242 | else | |||
243 | implUpdateRoadmap( ); | |||
244 | } | |||
245 | ||||
246 | void RoadmapWizardMachine::activatePath( PathId _nPathId, bool _bDecideForIt ) | |||
247 | { | |||
248 | if ( ( _nPathId == m_pImpl->nActivePath ) && ( _bDecideForIt == m_pImpl->bActivePathIsDefinite ) ) | |||
249 | // nothing to do | |||
250 | return; | |||
251 | ||||
252 | // does the given path exist? | |||
253 | Paths::const_iterator aNewPathPos = m_pImpl->aPaths.find( _nPathId ); | |||
254 | DBG_ASSERT( aNewPathPos != m_pImpl->aPaths.end(), "RoadmapWizard::activate: there is no such path!" )do { if (true && (!(aNewPathPos != m_pImpl->aPaths .end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "254" ": "), "%s", "RoadmapWizard::activate: there is no such path!" ); } } while (false); | |||
255 | if ( aNewPathPos == m_pImpl->aPaths.end() ) | |||
256 | return; | |||
257 | ||||
258 | // determine the index of the current state in the current path | |||
259 | sal_Int32 nCurrentStatePathIndex = -1; | |||
260 | if ( m_pImpl->nActivePath != -1 ) | |||
261 | nCurrentStatePathIndex = m_pImpl->getStateIndexInPath( getCurrentState(), m_pImpl->nActivePath ); | |||
262 | ||||
263 | DBG_ASSERT( static_cast<sal_Int32>(aNewPathPos->second.size()) > nCurrentStatePathIndex,do { if (true && (!(static_cast<sal_Int32>(aNewPathPos ->second.size()) > nCurrentStatePathIndex))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "264" ": "), "%s", "RoadmapWizard::activate: you cannot activate a path which has less states than we've already advanced!" ); } } while (false) | |||
264 | "RoadmapWizard::activate: you cannot activate a path which has less states than we've already advanced!" )do { if (true && (!(static_cast<sal_Int32>(aNewPathPos ->second.size()) > nCurrentStatePathIndex))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "264" ": "), "%s", "RoadmapWizard::activate: you cannot activate a path which has less states than we've already advanced!" ); } } while (false); | |||
265 | // If this asserts, this for instance means that we are already in state number, say, 5 | |||
266 | // of our current path, and the caller tries to activate a path which has less than 5 | |||
267 | // states | |||
268 | if ( static_cast<sal_Int32>(aNewPathPos->second.size()) <= nCurrentStatePathIndex ) | |||
269 | return; | |||
270 | ||||
271 | // assert that the current and the new path are equal, up to nCurrentStatePathIndex | |||
272 | Paths::const_iterator aActivePathPos = m_pImpl->aPaths.find( m_pImpl->nActivePath ); | |||
273 | if ( aActivePathPos != m_pImpl->aPaths.end() ) | |||
274 | { | |||
275 | if ( RoadmapWizardImpl::getFirstDifferentIndex( aActivePathPos->second, aNewPathPos->second ) <= nCurrentStatePathIndex ) | |||
276 | { | |||
277 | OSL_FAIL( "RoadmapWizard::activate: you cannot activate a path which conflicts with the current one *before* the current state!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "277" ": "), "%s", "RoadmapWizard::activate: you cannot activate a path which conflicts with the current one *before* the current state!" ); } } while (false); | |||
278 | return; | |||
279 | } | |||
280 | } | |||
281 | ||||
282 | m_pImpl->nActivePath = _nPathId; | |||
283 | m_pImpl->bActivePathIsDefinite = _bDecideForIt; | |||
284 | ||||
285 | implUpdateRoadmap( ); | |||
286 | } | |||
287 | ||||
288 | void RoadmapWizard::implUpdateRoadmap( ) | |||
289 | { | |||
290 | DBG_ASSERT( m_xRoadmapImpl->aPaths.find( m_xRoadmapImpl->nActivePath ) != m_xRoadmapImpl->aPaths.end(),do { if (true && (!(m_xRoadmapImpl->aPaths.find( m_xRoadmapImpl ->nActivePath ) != m_xRoadmapImpl->aPaths.end()))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "291" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: there is no such path!" ); } } while (false) | |||
291 | "RoadmapWizard::implUpdateRoadmap: there is no such path!" )do { if (true && (!(m_xRoadmapImpl->aPaths.find( m_xRoadmapImpl ->nActivePath ) != m_xRoadmapImpl->aPaths.end()))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "291" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: there is no such path!" ); } } while (false); | |||
292 | const WizardPath& rActivePath( m_xRoadmapImpl->aPaths[ m_xRoadmapImpl->nActivePath ] ); | |||
293 | ||||
294 | sal_Int32 nCurrentStatePathIndex = RoadmapWizardImpl::getStateIndexInPath( getCurrentState(), rActivePath ); | |||
295 | if (nCurrentStatePathIndex < 0) | |||
296 | return; | |||
297 | ||||
298 | // determine up to which index (in the new path) we have to display the items | |||
299 | RoadmapTypes::ItemIndex nUpperStepBoundary = static_cast<RoadmapTypes::ItemIndex>(rActivePath.size()); | |||
300 | bool bIncompletePath = false; | |||
301 | if ( !m_xRoadmapImpl->bActivePathIsDefinite ) | |||
302 | { | |||
303 | for (auto const& path : m_xRoadmapImpl->aPaths) | |||
304 | { | |||
305 | if ( path.first == m_xRoadmapImpl->nActivePath ) | |||
306 | // it's the path we are just activating -> no need to check anything | |||
307 | continue; | |||
308 | // the index from which on both paths differ | |||
309 | sal_Int32 nDivergenceIndex = RoadmapWizardImpl::getFirstDifferentIndex( rActivePath, path.second ); | |||
310 | if ( nDivergenceIndex <= nCurrentStatePathIndex ) | |||
311 | // they differ in an index which we have already left behind us | |||
312 | // -> this is no conflict anymore | |||
313 | continue; | |||
314 | ||||
315 | // the path conflicts with our new path -> don't activate the | |||
316 | // *complete* new path, but only up to the step which is unambiguous | |||
317 | nUpperStepBoundary = nDivergenceIndex; | |||
318 | bIncompletePath = true; | |||
319 | } | |||
320 | } | |||
321 | ||||
322 | // can we advance from the current page? | |||
323 | bool bCurrentPageCanAdvance = true; | |||
324 | TabPage* pCurrentPage = GetPage( getCurrentState() ); | |||
325 | if ( pCurrentPage ) | |||
326 | { | |||
327 | const IWizardPageController* pController = getPageController( GetPage( getCurrentState() ) ); | |||
328 | OSL_ENSURE( pController != nullptr, "RoadmapWizard::implUpdateRoadmap: no controller for the current page!" )do { if (true && (!(pController != nullptr))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "328" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: no controller for the current page!" ); } } while (false); | |||
329 | bCurrentPageCanAdvance = !pController || pController->canAdvance(); | |||
330 | } | |||
331 | ||||
332 | // now, we have to remove all items after nCurrentStatePathIndex, and insert the items from the active | |||
333 | // path, up to (excluding) nUpperStepBoundary | |||
334 | RoadmapTypes::ItemIndex nLoopUntil = ::std::max( nUpperStepBoundary, m_xRoadmapImpl->pRoadmap->GetItemCount() ); | |||
335 | for ( RoadmapTypes::ItemIndex nItemIndex = nCurrentStatePathIndex; nItemIndex < nLoopUntil; ++nItemIndex ) | |||
336 | { | |||
337 | bool bExistentItem = ( nItemIndex < m_xRoadmapImpl->pRoadmap->GetItemCount() ); | |||
338 | bool bNeedItem = ( nItemIndex < nUpperStepBoundary ); | |||
339 | ||||
340 | bool bInsertItem = false; | |||
341 | if ( bExistentItem ) | |||
342 | { | |||
343 | if ( !bNeedItem ) | |||
344 | { | |||
345 | while ( nItemIndex < m_xRoadmapImpl->pRoadmap->GetItemCount() ) | |||
346 | m_xRoadmapImpl->pRoadmap->DeleteRoadmapItem( nItemIndex ); | |||
347 | break; | |||
348 | } | |||
349 | else | |||
350 | { | |||
351 | // there is an item with this index in the roadmap - does it match what is requested by | |||
352 | // the respective state in the active path? | |||
353 | RoadmapTypes::ItemId nPresentItemId = m_xRoadmapImpl->pRoadmap->GetItemID( nItemIndex ); | |||
354 | WizardTypes::WizardState nRequiredState = rActivePath[ nItemIndex ]; | |||
355 | if ( nPresentItemId != nRequiredState ) | |||
356 | { | |||
357 | m_xRoadmapImpl->pRoadmap->DeleteRoadmapItem( nItemIndex ); | |||
358 | bInsertItem = true; | |||
359 | } | |||
360 | } | |||
361 | } | |||
362 | else | |||
363 | { | |||
364 | DBG_ASSERT( bNeedItem, "RoadmapWizard::implUpdateRoadmap: ehm - none needed, none present - why did the loop not terminate?" )do { if (true && (!(bNeedItem))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "364" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: ehm - none needed, none present - why did the loop not terminate?" ); } } while (false); | |||
365 | bInsertItem = bNeedItem; | |||
366 | } | |||
367 | ||||
368 | WizardTypes::WizardState nState( rActivePath[ nItemIndex ] ); | |||
369 | if ( bInsertItem ) | |||
370 | { | |||
371 | m_xRoadmapImpl->pRoadmap->InsertRoadmapItem( | |||
372 | nItemIndex, | |||
373 | getStateDisplayName( nState ), | |||
374 | nState, | |||
375 | true | |||
376 | ); | |||
377 | } | |||
378 | ||||
379 | // if the item is *after* the current state, but the current page does not | |||
380 | // allow advancing, the disable the state. This relieves derived classes | |||
381 | // from disabling all future states just because the current state does not | |||
382 | // (yet) allow advancing. | |||
383 | const bool bUnconditionedDisable = !bCurrentPageCanAdvance && ( nItemIndex > nCurrentStatePathIndex ); | |||
384 | const bool bEnable = !bUnconditionedDisable && ( m_xRoadmapImpl->aDisabledStates.find( nState ) == m_xRoadmapImpl->aDisabledStates.end() ); | |||
385 | ||||
386 | m_xRoadmapImpl->pRoadmap->EnableRoadmapItem( m_xRoadmapImpl->pRoadmap->GetItemID( nItemIndex ), bEnable ); | |||
387 | } | |||
388 | ||||
389 | m_xRoadmapImpl->pRoadmap->SetRoadmapComplete( !bIncompletePath ); | |||
390 | } | |||
391 | ||||
392 | void RoadmapWizardMachine::implUpdateRoadmap( ) | |||
393 | { | |||
394 | ||||
395 | DBG_ASSERT( m_pImpl->aPaths.find( m_pImpl->nActivePath ) != m_pImpl->aPaths.end(),do { if (true && (!(m_pImpl->aPaths.find( m_pImpl-> nActivePath ) != m_pImpl->aPaths.end()))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "396" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: there is no such path!" ); } } while (false) | |||
396 | "RoadmapWizard::implUpdateRoadmap: there is no such path!" )do { if (true && (!(m_pImpl->aPaths.find( m_pImpl-> nActivePath ) != m_pImpl->aPaths.end()))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "396" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: there is no such path!" ); } } while (false); | |||
397 | const WizardPath& rActivePath( m_pImpl->aPaths[ m_pImpl->nActivePath ] ); | |||
398 | ||||
399 | sal_Int32 nCurrentStatePathIndex = RoadmapWizardImpl::getStateIndexInPath( getCurrentState(), rActivePath ); | |||
400 | if (nCurrentStatePathIndex < 0) | |||
401 | return; | |||
402 | ||||
403 | // determine up to which index (in the new path) we have to display the items | |||
404 | RoadmapTypes::ItemIndex nUpperStepBoundary = static_cast<RoadmapTypes::ItemIndex>(rActivePath.size()); | |||
405 | if ( !m_pImpl->bActivePathIsDefinite ) | |||
406 | { | |||
407 | for (auto const& path : m_pImpl->aPaths) | |||
408 | { | |||
409 | if ( path.first == m_pImpl->nActivePath ) | |||
410 | // it's the path we are just activating -> no need to check anything | |||
411 | continue; | |||
412 | // the index from which on both paths differ | |||
413 | sal_Int32 nDivergenceIndex = RoadmapWizardImpl::getFirstDifferentIndex( rActivePath, path.second ); | |||
414 | if ( nDivergenceIndex <= nCurrentStatePathIndex ) | |||
415 | // they differ in an index which we have already left behind us | |||
416 | // -> this is no conflict anymore | |||
417 | continue; | |||
418 | ||||
419 | // the path conflicts with our new path -> don't activate the | |||
420 | // *complete* new path, but only up to the step which is unambiguous | |||
421 | nUpperStepBoundary = nDivergenceIndex; | |||
422 | } | |||
423 | } | |||
424 | ||||
425 | // can we advance from the current page? | |||
426 | bool bCurrentPageCanAdvance = true; | |||
427 | BuilderPage* pCurrentPage = GetPage( getCurrentState() ); | |||
428 | if ( pCurrentPage ) | |||
429 | { | |||
430 | const IWizardPageController* pController = getPageController( GetPage( getCurrentState() ) ); | |||
431 | OSL_ENSURE( pController != nullptr, "RoadmapWizard::implUpdateRoadmap: no controller for the current page!" )do { if (true && (!(pController != nullptr))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "431" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: no controller for the current page!" ); } } while (false); | |||
432 | bCurrentPageCanAdvance = !pController || pController->canAdvance(); | |||
433 | } | |||
434 | ||||
435 | // now, we have to remove all items after nCurrentStatePathIndex, and insert the items from the active | |||
436 | // path, up to (excluding) nUpperStepBoundary | |||
437 | RoadmapTypes::ItemIndex nRoadmapItems = m_xAssistant->get_n_pages(); | |||
438 | RoadmapTypes::ItemIndex nLoopUntil = ::std::max( nUpperStepBoundary, nRoadmapItems ); | |||
439 | for ( RoadmapTypes::ItemIndex nItemIndex = nCurrentStatePathIndex; nItemIndex < nLoopUntil; ++nItemIndex ) | |||
440 | { | |||
441 | bool bExistentItem = ( nItemIndex < nRoadmapItems ); | |||
442 | bool bNeedItem = ( nItemIndex < nUpperStepBoundary ); | |||
443 | ||||
444 | bool bInsertItem = false; | |||
445 | if ( bExistentItem ) | |||
446 | { | |||
447 | if ( !bNeedItem ) | |||
448 | { | |||
449 | int nPages = nRoadmapItems; | |||
450 | for (int i = nPages - 1; i >= nItemIndex; --i) | |||
451 | { | |||
452 | m_xAssistant->set_page_title(m_xAssistant->get_page_ident(i), ""); | |||
453 | --nRoadmapItems; | |||
454 | } | |||
455 | break; | |||
456 | } | |||
457 | else | |||
458 | { | |||
459 | // there is an item with this index in the roadmap - does it match what is requested by | |||
460 | // the respective state in the active path? | |||
461 | RoadmapTypes::ItemId nPresentItemId = m_xAssistant->get_page_ident(nItemIndex).toInt32(); | |||
462 | WizardTypes::WizardState nRequiredState = rActivePath[ nItemIndex ]; | |||
463 | if ( nPresentItemId != nRequiredState ) | |||
464 | { | |||
465 | m_xAssistant->set_page_title(OString::number(nPresentItemId), ""); | |||
466 | bInsertItem = true; | |||
467 | } | |||
468 | } | |||
469 | } | |||
470 | else | |||
471 | { | |||
472 | DBG_ASSERT( bNeedItem, "RoadmapWizard::implUpdateRoadmap: ehm - none needed, none present - why did the loop not terminate?" )do { if (true && (!(bNeedItem))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "472" ": "), "%s", "RoadmapWizard::implUpdateRoadmap: ehm - none needed, none present - why did the loop not terminate?" ); } } while (false); | |||
473 | bInsertItem = bNeedItem; | |||
474 | } | |||
475 | ||||
476 | WizardTypes::WizardState nState( rActivePath[ nItemIndex ] ); | |||
477 | ||||
478 | if ( bInsertItem ) | |||
479 | { | |||
480 | GetOrCreatePage(nState); | |||
481 | } | |||
482 | ||||
483 | OString sIdent(OString::number(nState)); | |||
484 | m_xAssistant->set_page_index(sIdent, nItemIndex); | |||
485 | m_xAssistant->set_page_title(sIdent, getStateDisplayName(nState)); | |||
486 | ||||
487 | // if the item is *after* the current state, but the current page does not | |||
488 | // allow advancing, the disable the state. This relieves derived classes | |||
489 | // from disabling all future states just because the current state does not | |||
490 | // (yet) allow advancing. | |||
491 | const bool bUnconditionedDisable = !bCurrentPageCanAdvance && ( nItemIndex > nCurrentStatePathIndex ); | |||
492 | const bool bEnable = !bUnconditionedDisable && ( m_pImpl->aDisabledStates.find( nState ) == m_pImpl->aDisabledStates.end() ); | |||
493 | m_xAssistant->set_page_sensitive(sIdent, bEnable); | |||
494 | } | |||
495 | } | |||
496 | ||||
497 | WizardTypes::WizardState RoadmapWizard::determineNextState( WizardTypes::WizardState _nCurrentState ) const | |||
498 | { | |||
499 | sal_Int32 nCurrentStatePathIndex = -1; | |||
500 | ||||
501 | Paths::const_iterator aActivePathPos = m_xRoadmapImpl->aPaths.find( m_xRoadmapImpl->nActivePath ); | |||
502 | if ( aActivePathPos != m_xRoadmapImpl->aPaths.end() ) | |||
503 | nCurrentStatePathIndex = RoadmapWizardImpl::getStateIndexInPath( _nCurrentState, aActivePathPos->second ); | |||
504 | ||||
505 | DBG_ASSERT( nCurrentStatePathIndex != -1, "RoadmapWizard::determineNextState: ehm - how can we travel if there is no (valid) active path?" )do { if (true && (!(nCurrentStatePathIndex != -1))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools" ), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "505" ": "), "%s", "RoadmapWizard::determineNextState: ehm - how can we travel if there is no (valid) active path?" ); } } while (false); | |||
506 | if ( nCurrentStatePathIndex == -1 ) | |||
507 | return WZS_INVALID_STATE(::vcl::WizardTypes::WizardState(-1)); | |||
508 | ||||
509 | sal_Int32 nNextStateIndex = nCurrentStatePathIndex + 1; | |||
510 | ||||
511 | while ( ( nNextStateIndex < static_cast<sal_Int32>(aActivePathPos->second.size()) ) | |||
512 | && ( m_xRoadmapImpl->aDisabledStates.find( aActivePathPos->second[ nNextStateIndex ] ) != m_xRoadmapImpl->aDisabledStates.end() ) | |||
513 | ) | |||
514 | { | |||
515 | ++nNextStateIndex; | |||
516 | } | |||
517 | ||||
518 | if ( nNextStateIndex >= static_cast<sal_Int32>(aActivePathPos->second.size()) ) | |||
519 | // there is no next state in the current path (at least none which is enabled) | |||
520 | return WZS_INVALID_STATE(::vcl::WizardTypes::WizardState(-1)); | |||
521 | ||||
522 | return aActivePathPos->second[ nNextStateIndex ]; | |||
523 | } | |||
524 | ||||
525 | WizardTypes::WizardState RoadmapWizardMachine::determineNextState( WizardTypes::WizardState _nCurrentState ) const | |||
526 | { | |||
527 | sal_Int32 nCurrentStatePathIndex = -1; | |||
528 | ||||
529 | Paths::const_iterator aActivePathPos = m_pImpl->aPaths.find( m_pImpl->nActivePath ); | |||
530 | if ( aActivePathPos != m_pImpl->aPaths.end() ) | |||
531 | nCurrentStatePathIndex = RoadmapWizardImpl::getStateIndexInPath( _nCurrentState, aActivePathPos->second ); | |||
532 | ||||
533 | DBG_ASSERT( nCurrentStatePathIndex != -1, "RoadmapWizard::determineNextState: ehm - how can we travel if there is no (valid) active path?" )do { if (true && (!(nCurrentStatePathIndex != -1))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools" ), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "533" ": "), "%s", "RoadmapWizard::determineNextState: ehm - how can we travel if there is no (valid) active path?" ); } } while (false); | |||
534 | if ( nCurrentStatePathIndex == -1 ) | |||
535 | return WZS_INVALID_STATE(::vcl::WizardTypes::WizardState(-1)); | |||
536 | ||||
537 | sal_Int32 nNextStateIndex = nCurrentStatePathIndex + 1; | |||
538 | ||||
539 | while ( ( nNextStateIndex < static_cast<sal_Int32>(aActivePathPos->second.size()) ) | |||
540 | && ( m_pImpl->aDisabledStates.find( aActivePathPos->second[ nNextStateIndex ] ) != m_pImpl->aDisabledStates.end() ) | |||
541 | ) | |||
542 | { | |||
543 | ++nNextStateIndex; | |||
544 | } | |||
545 | ||||
546 | if ( nNextStateIndex >= static_cast<sal_Int32>(aActivePathPos->second.size()) ) | |||
547 | // there is no next state in the current path (at least none which is enabled) | |||
548 | return WZS_INVALID_STATE(::vcl::WizardTypes::WizardState(-1)); | |||
549 | ||||
550 | return aActivePathPos->second[ nNextStateIndex ]; | |||
551 | } | |||
552 | ||||
553 | bool RoadmapWizard::canAdvance() const | |||
554 | { | |||
555 | if ( !m_xRoadmapImpl->bActivePathIsDefinite ) | |||
556 | { | |||
557 | // check how many paths are still allowed | |||
558 | const WizardPath& rActivePath( m_xRoadmapImpl->aPaths[ m_xRoadmapImpl->nActivePath ] ); | |||
559 | sal_Int32 nCurrentStatePathIndex = RoadmapWizardImpl::getStateIndexInPath( getCurrentState(), rActivePath ); | |||
560 | ||||
561 | size_t nPossiblePaths(0); | |||
562 | for (auto const& path : m_xRoadmapImpl->aPaths) | |||
563 | { | |||
564 | // the index from which on both paths differ | |||
565 | sal_Int32 nDivergenceIndex = RoadmapWizardImpl::getFirstDifferentIndex( rActivePath, path.second ); | |||
566 | ||||
567 | if ( nDivergenceIndex > nCurrentStatePathIndex ) | |||
568 | // this path is still a possible path | |||
569 | nPossiblePaths += 1; | |||
570 | } | |||
571 | ||||
572 | // if we have more than one path which is still possible, then we assume | |||
573 | // to always have a next state. Though there might be scenarios where this | |||
574 | // is not true, but this is too sophisticated (means not really needed) right now. | |||
575 | if ( nPossiblePaths > 1 ) | |||
576 | return true; | |||
577 | } | |||
578 | ||||
579 | const WizardPath& rPath = m_xRoadmapImpl->aPaths[ m_xRoadmapImpl->nActivePath ]; | |||
580 | return *rPath.rbegin() != getCurrentState(); | |||
581 | } | |||
582 | ||||
583 | bool RoadmapWizardMachine::canAdvance() const | |||
584 | { | |||
585 | if ( !m_pImpl->bActivePathIsDefinite ) | |||
586 | { | |||
587 | // check how many paths are still allowed | |||
588 | const WizardPath& rActivePath( m_pImpl->aPaths[ m_pImpl->nActivePath ] ); | |||
589 | ||||
590 | // if current path has only the base item, it is not possible to proceed without activating another path | |||
591 | if(rActivePath.size()<=1) | |||
592 | return false; | |||
593 | ||||
594 | sal_Int32 nCurrentStatePathIndex = RoadmapWizardImpl::getStateIndexInPath( getCurrentState(), rActivePath ); | |||
595 | ||||
596 | size_t nPossiblePaths(0); | |||
597 | for (auto const& path : m_pImpl->aPaths) | |||
598 | { | |||
599 | // the index from which on both paths differ | |||
600 | sal_Int32 nDivergenceIndex = RoadmapWizardImpl::getFirstDifferentIndex( rActivePath, path.second ); | |||
601 | ||||
602 | if ( nDivergenceIndex > nCurrentStatePathIndex ) | |||
603 | // this path is still a possible path | |||
604 | nPossiblePaths += 1; | |||
605 | } | |||
606 | ||||
607 | // if we have more than one path which is still possible, then we assume | |||
608 | // to always have a next state. Though there might be scenarios where this | |||
609 | // is not true, but this is too sophisticated (means not really needed) right now. | |||
610 | if ( nPossiblePaths > 1 ) | |||
611 | return true; | |||
612 | } | |||
613 | ||||
614 | const WizardPath& rPath = m_pImpl->aPaths[ m_pImpl->nActivePath ]; | |||
615 | return *rPath.rbegin() != getCurrentState(); | |||
616 | } | |||
617 | ||||
618 | void RoadmapWizardMachine::updateTravelUI() | |||
619 | { | |||
620 | WizardMachine::updateTravelUI(); | |||
621 | ||||
622 | // disable the "Previous" button if all states in our history are disabled | |||
623 | std::vector< WizardTypes::WizardState > aHistory; | |||
624 | getStateHistory( aHistory ); | |||
625 | bool bHaveEnabledState = false; | |||
626 | for (auto const& state : aHistory) | |||
627 | { | |||
628 | if ( isStateEnabled(state) ) | |||
629 | { | |||
630 | bHaveEnabledState = true; | |||
631 | break; | |||
632 | } | |||
633 | } | |||
634 | ||||
635 | enableButtons( WizardButtonFlags::PREVIOUS, bHaveEnabledState ); | |||
636 | ||||
637 | implUpdateRoadmap(); | |||
638 | } | |||
639 | ||||
640 | IMPL_LINK_NOARG(RoadmapWizard, OnRoadmapItemSelected, LinkParamNone*, void)void RoadmapWizard::LinkStubOnRoadmapItemSelected(void * instance , LinkParamNone* data) { return static_cast<RoadmapWizard * >(instance)->OnRoadmapItemSelected(data); } void RoadmapWizard ::OnRoadmapItemSelected(__attribute__ ((unused)) LinkParamNone *) | |||
641 | { | |||
642 | RoadmapTypes::ItemId nCurItemId = m_xRoadmapImpl->pRoadmap->GetCurrentRoadmapItemID(); | |||
643 | if ( nCurItemId == getCurrentState() ) | |||
644 | // nothing to do | |||
645 | return; | |||
646 | ||||
647 | if ( isTravelingSuspended() ) | |||
648 | return; | |||
649 | ||||
650 | RoadmapWizardTravelSuspension aTravelGuard( *this ); | |||
651 | ||||
652 | sal_Int32 nCurrentIndex = m_xRoadmapImpl->getStateIndexInPath( getCurrentState(), m_xRoadmapImpl->nActivePath ); | |||
653 | sal_Int32 nNewIndex = m_xRoadmapImpl->getStateIndexInPath( nCurItemId, m_xRoadmapImpl->nActivePath ); | |||
654 | ||||
655 | DBG_ASSERT( ( nCurrentIndex != -1 ) && ( nNewIndex != -1 ),do { if (true && (!(( nCurrentIndex != -1 ) && ( nNewIndex != -1 )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "656" ": "), "%s", "RoadmapWizard::OnRoadmapItemSelected: something's wrong here!" ); } } while (false) | |||
656 | "RoadmapWizard::OnRoadmapItemSelected: something's wrong here!" )do { if (true && (!(( nCurrentIndex != -1 ) && ( nNewIndex != -1 )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "656" ": "), "%s", "RoadmapWizard::OnRoadmapItemSelected: something's wrong here!" ); } } while (false); | |||
657 | if ( ( nCurrentIndex == -1 ) || ( nNewIndex == -1 ) ) | |||
658 | { | |||
659 | return; | |||
660 | } | |||
661 | ||||
662 | bool bResult = true; | |||
663 | if ( nNewIndex > nCurrentIndex ) | |||
664 | { | |||
665 | bResult = skipUntil( static_cast<WizardTypes::WizardState>(nCurItemId) ); | |||
666 | WizardTypes::WizardState nTemp = static_cast<WizardTypes::WizardState>(nCurItemId); | |||
667 | while( nTemp ) | |||
668 | { | |||
669 | if( m_xRoadmapImpl->aDisabledStates.find( --nTemp ) != m_xRoadmapImpl->aDisabledStates.end() ) | |||
670 | removePageFromHistory( nTemp ); | |||
671 | } | |||
672 | } | |||
673 | else | |||
674 | bResult = skipBackwardUntil( static_cast<WizardTypes::WizardState>(nCurItemId) ); | |||
675 | ||||
676 | if ( !bResult ) | |||
677 | m_xRoadmapImpl->pRoadmap->SelectRoadmapItemByID( getCurrentState() ); | |||
678 | } | |||
679 | ||||
680 | IMPL_LINK(RoadmapWizardMachine, OnRoadmapItemSelected, const OString&, rCurItemId, bool)bool RoadmapWizardMachine::LinkStubOnRoadmapItemSelected(void * instance, const OString& data) { return static_cast< RoadmapWizardMachine *>(instance)->OnRoadmapItemSelected (data); } bool RoadmapWizardMachine::OnRoadmapItemSelected(const OString& rCurItemId) | |||
681 | { | |||
682 | int nCurItemId = rCurItemId.toInt32(); | |||
683 | ||||
684 | if ( nCurItemId == getCurrentState() ) | |||
685 | // nothing to do | |||
686 | return false; | |||
687 | ||||
688 | if ( isTravelingSuspended() ) | |||
689 | return false; | |||
690 | ||||
691 | WizardTravelSuspension aTravelGuard( *this ); | |||
692 | ||||
693 | sal_Int32 nCurrentIndex = m_pImpl->getStateIndexInPath( getCurrentState(), m_pImpl->nActivePath ); | |||
694 | sal_Int32 nNewIndex = m_pImpl->getStateIndexInPath( nCurItemId, m_pImpl->nActivePath ); | |||
695 | ||||
696 | DBG_ASSERT( ( nCurrentIndex != -1 ) && ( nNewIndex != -1 ),do { if (true && (!(( nCurrentIndex != -1 ) && ( nNewIndex != -1 )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "697" ": "), "%s", "RoadmapWizard::OnRoadmapItemSelected: something's wrong here!" ); } } while (false) | |||
697 | "RoadmapWizard::OnRoadmapItemSelected: something's wrong here!" )do { if (true && (!(( nCurrentIndex != -1 ) && ( nNewIndex != -1 )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "697" ": "), "%s", "RoadmapWizard::OnRoadmapItemSelected: something's wrong here!" ); } } while (false); | |||
698 | if ( ( nCurrentIndex == -1 ) || ( nNewIndex == -1 ) ) | |||
699 | { | |||
700 | return false; | |||
701 | } | |||
702 | ||||
703 | bool bResult = true; | |||
704 | if ( nNewIndex > nCurrentIndex ) | |||
705 | { | |||
706 | bResult = skipUntil( static_cast<WizardTypes::WizardState>(nCurItemId) ); | |||
707 | WizardTypes::WizardState nTemp = static_cast<WizardTypes::WizardState>(nCurItemId); | |||
708 | while( nTemp ) | |||
709 | { | |||
710 | if( m_pImpl->aDisabledStates.find( --nTemp ) != m_pImpl->aDisabledStates.end() ) | |||
711 | removePageFromHistory( nTemp ); | |||
712 | } | |||
713 | } | |||
714 | else | |||
715 | bResult = skipBackwardUntil( static_cast<WizardTypes::WizardState>(nCurItemId) ); | |||
716 | ||||
717 | return bResult; | |||
718 | } | |||
719 | ||||
720 | void RoadmapWizard::enterState(WizardTypes::WizardState nState) | |||
721 | { | |||
722 | // tell the page | |||
723 | IWizardPageController* pController = getPageController( GetPage( nState ) ); | |||
724 | if (pController) | |||
725 | { | |||
726 | pController->initializePage(); | |||
727 | ||||
728 | if ( isAutomaticNextButtonStateEnabled() ) | |||
729 | enableButtons( WizardButtonFlags::NEXT, canAdvance() ); | |||
730 | ||||
731 | enableButtons( WizardButtonFlags::PREVIOUS, !m_xWizardImpl->aStateHistory.empty() ); | |||
732 | ||||
733 | // set the new title - it depends on the current page (i.e. state) | |||
734 | implUpdateTitle(); | |||
735 | } | |||
736 | ||||
737 | // synchronize the roadmap | |||
738 | implUpdateRoadmap( ); | |||
739 | m_xRoadmapImpl->pRoadmap->SelectRoadmapItemByID( getCurrentState() ); | |||
740 | } | |||
741 | ||||
742 | void RoadmapWizardMachine::enterState( WizardTypes::WizardState _nState ) | |||
743 | { | |||
744 | WizardMachine::enterState( _nState ); | |||
745 | ||||
746 | // synchronize the roadmap | |||
747 | implUpdateRoadmap(); | |||
748 | } | |||
749 | ||||
750 | OUString RoadmapWizard::getStateDisplayName( WizardTypes::WizardState _nState ) const | |||
751 | { | |||
752 | OUString sDisplayName; | |||
753 | ||||
754 | StateDescriptions::const_iterator pos = m_xRoadmapImpl->aStateDescriptors.find( _nState ); | |||
755 | OSL_ENSURE( pos != m_xRoadmapImpl->aStateDescriptors.end(),do { if (true && (!(pos != m_xRoadmapImpl->aStateDescriptors .end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "756" ": "), "%s", "RoadmapWizard::getStateDisplayName: no default implementation available for this state!" ); } } while (false) | |||
756 | "RoadmapWizard::getStateDisplayName: no default implementation available for this state!" )do { if (true && (!(pos != m_xRoadmapImpl->aStateDescriptors .end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "756" ": "), "%s", "RoadmapWizard::getStateDisplayName: no default implementation available for this state!" ); } } while (false); | |||
757 | if ( pos != m_xRoadmapImpl->aStateDescriptors.end() ) | |||
758 | sDisplayName = pos->second.first; | |||
759 | ||||
760 | return sDisplayName; | |||
761 | } | |||
762 | ||||
763 | OUString RoadmapWizardMachine::getStateDisplayName( WizardTypes::WizardState _nState ) const | |||
764 | { | |||
765 | OUString sDisplayName; | |||
766 | ||||
767 | StateDescriptions::const_iterator pos = m_pImpl->aStateDescriptors.find( _nState ); | |||
768 | OSL_ENSURE( pos != m_pImpl->aStateDescriptors.end(),do { if (true && (!(pos != m_pImpl->aStateDescriptors .end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "769" ": "), "%s", "RoadmapWizard::getStateDisplayName: no default implementation available for this state!" ); } } while (false) | |||
769 | "RoadmapWizard::getStateDisplayName: no default implementation available for this state!" )do { if (true && (!(pos != m_pImpl->aStateDescriptors .end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "769" ": "), "%s", "RoadmapWizard::getStateDisplayName: no default implementation available for this state!" ); } } while (false); | |||
770 | if ( pos != m_pImpl->aStateDescriptors.end() ) | |||
771 | sDisplayName = pos->second.first; | |||
772 | ||||
773 | return sDisplayName; | |||
774 | } | |||
775 | ||||
776 | VclPtr<TabPage> RoadmapWizard::createPage( WizardTypes::WizardState _nState ) | |||
777 | { | |||
778 | VclPtr<TabPage> pPage; | |||
779 | ||||
780 | StateDescriptions::const_iterator pos = m_xRoadmapImpl->aStateDescriptors.find( _nState ); | |||
781 | OSL_ENSURE( pos != m_xRoadmapImpl->aStateDescriptors.end(),do { if (true && (!(pos != m_xRoadmapImpl->aStateDescriptors .end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "782" ": "), "%s", "RoadmapWizard::createPage: no default implementation available for this state!" ); } } while (false) | |||
782 | "RoadmapWizard::createPage: no default implementation available for this state!" )do { if (true && (!(pos != m_xRoadmapImpl->aStateDescriptors .end()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/control/roadmapwizard.cxx" ":" "782" ": "), "%s", "RoadmapWizard::createPage: no default implementation available for this state!" ); } } while (false); | |||
783 | if ( pos != m_xRoadmapImpl->aStateDescriptors.end() ) | |||
784 | { | |||
785 | RoadmapPageFactory pFactory = pos->second.second; | |||
786 | pPage = (*pFactory)( *this ); | |||
787 | } | |||
788 | ||||
789 | return pPage; | |||
790 | } | |||
791 | ||||
792 | void RoadmapWizardMachine::enableState( WizardTypes::WizardState _nState, bool _bEnable ) | |||
793 | { | |||
794 | // remember this (in case the state appears in the roadmap later on) | |||
795 | if ( _bEnable ) | |||
796 | m_pImpl->aDisabledStates.erase( _nState ); | |||
797 | else | |||
798 | { | |||
799 | m_pImpl->aDisabledStates.insert( _nState ); | |||
800 | removePageFromHistory( _nState ); | |||
801 | } | |||
802 | ||||
803 | // if the state is currently in the roadmap, reflect it's new status | |||
804 | m_xAssistant->set_page_sensitive(OString::number(_nState), _bEnable); | |||
805 | } | |||
806 | ||||
807 | bool RoadmapWizardMachine::knowsState( WizardTypes::WizardState i_nState ) const | |||
808 | { | |||
809 | for (auto const& path : m_pImpl->aPaths) | |||
810 | { | |||
811 | for (auto const& state : path.second) | |||
812 | { | |||
813 | if ( state == i_nState ) | |||
814 | return true; | |||
815 | } | |||
816 | } | |||
817 | return false; | |||
818 | } | |||
819 | ||||
820 | bool RoadmapWizardMachine::isStateEnabled( WizardTypes::WizardState _nState ) const | |||
821 | { | |||
822 | return m_pImpl->aDisabledStates.find( _nState ) == m_pImpl->aDisabledStates.end(); | |||
823 | } | |||
824 | ||||
825 | void RoadmapWizard::InsertRoadmapItem(int nItemIndex, const OUString& rText, int nItemId, bool bEnable) | |||
826 | { | |||
827 | m_xRoadmapImpl->pRoadmap->InsertRoadmapItem(nItemIndex, rText, nItemId, bEnable); | |||
828 | } | |||
829 | ||||
830 | void RoadmapWizard::SelectRoadmapItemByID(int nItemId) | |||
831 | { | |||
832 | m_xRoadmapImpl->pRoadmap->SelectRoadmapItemByID(nItemId); | |||
833 | } | |||
834 | ||||
835 | void RoadmapWizard::DeleteRoadmapItems() | |||
836 | { | |||
837 | while (m_xRoadmapImpl->pRoadmap->GetItemCount()) | |||
838 | m_xRoadmapImpl->pRoadmap->DeleteRoadmapItem(0); | |||
839 | } | |||
840 | ||||
841 | void RoadmapWizard::SetItemSelectHdl( const Link<LinkParamNone*,void>& _rHdl ) | |||
842 | { | |||
843 | m_xRoadmapImpl->pRoadmap->SetItemSelectHdl(_rHdl); | |||
844 | } | |||
845 | ||||
846 | int RoadmapWizard::GetCurrentRoadmapItemID() const | |||
847 | { | |||
848 | return m_xRoadmapImpl->pRoadmap->GetCurrentRoadmapItemID(); | |||
849 | } | |||
850 | ||||
851 | FactoryFunction RoadmapWizard::GetUITestFactory() const | |||
852 | { | |||
853 | return RoadmapWizardUIObject::create; | |||
854 | } | |||
855 | ||||
856 | } // namespace vcl | |||
857 | ||||
858 | /* 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 |