/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <comphelper/lok.hxx>
#include <officecfg/Office/Common.hxx>
#include <tools/debug.hxx>
#include <vcl/roadmapwizardmachine.hxx>
#include <comphelper/diagnose_ex.hxx>
#include <strings.hrc>
#include <svdata.hxx>
#include <stack>
#include "wizimpldata.hxx"
namespace vcl
{
//= WizardPageImplData
OWizardPage::OWizardPage(weld::Container* pPage, weld::DialogController* pController, const OUString& rUIXMLDescription, const OUString& rID)
: BuilderPage(pPage, pController, rUIXMLDescription, rID)
{
}
OWizardPage::~OWizardPage()
{
}
void OWizardPage::initializePage()
{
}
void OWizardPage::Activate()
{
BuilderPage::Activate();
updateDialogTravelUI();
}
void OWizardPage::updateDialogTravelUI()
{
auto pWizardMachine = dynamic_cast<RoadmapWizardMachine*>(m_pDialogController);
if (pWizardMachine)
pWizardMachine->updateTravelUI();
}
bool OWizardPage::canAdvance() const
{
return true;
}
bool OWizardPage::commitPage( WizardTypes::CommitPageReason )
{
return true;
}
WizardMachine::WizardMachine(weld::Window* pParent, WizardButtonFlags nButtonFlags)
: AssistantController(pParent, u"vcl/ui/wizard.ui"_ustr, u"Wizard"_ustr)
, m_pCurTabPage(nullptr)
, m_nCurState(0)
, m_pFirstPage(nullptr)
, m_xFinish(m_xAssistant->weld_button_for_response(RET_OK))
, m_xCancel(m_xAssistant->weld_button_for_response(RET_CANCEL))
, m_xNextPage(m_xAssistant->weld_button_for_response(RET_YES))
, m_xPrevPage(m_xAssistant->weld_button_for_response(RET_NO))
, m_xHelp(m_xAssistant->weld_button_for_response(RET_HELP))
, m_pImpl(new WizardMachineImplData)
{
implConstruct(nButtonFlags);
}
void WizardMachine::implConstruct(const WizardButtonFlags nButtonFlags)
{
m_pImpl->sTitleBase = m_xAssistant->get_title();
const bool bHideHelp = comphelper::LibreOfficeKit::isActive() &&
officecfg::Office::Common::Help::HelpRootURL::get().isEmpty();
// create the buttons according to the wizard button flags
// the help button
if (nButtonFlags & WizardButtonFlags::HELP && !bHideHelp)
m_xHelp->show();
else
m_xHelp->hide();
// the previous button
if (nButtonFlags & WizardButtonFlags::PREVIOUS)
{
m_xPrevPage->set_help_id( HID_WIZARD_PREVIOUS );
m_xPrevPage->show();
m_xPrevPage->connect_clicked( LINK( this, WizardMachine, OnPrevPage ) );
}
else
m_xPrevPage->hide();
// the next button
if (nButtonFlags & WizardButtonFlags::NEXT)
{
m_xNextPage->set_help_id( HID_WIZARD_NEXT );
m_xNextPage->show();
m_xNextPage->connect_clicked( LINK( this, WizardMachine, OnNextPage ) );
}
else
m_xNextPage->hide();
// the finish button
if (nButtonFlags & WizardButtonFlags::FINISH)
{
m_xFinish->show();
m_xFinish->connect_clicked( LINK( this, WizardMachine, OnFinish ) );
}
else
m_xFinish->hide();
// the cancel button
if (nButtonFlags & WizardButtonFlags::CANCEL)
{
m_xCancel->show();
m_xCancel->connect_clicked( LINK( this, WizardMachine, OnCancel ) );
}
else
m_xCancel->hide();
}
WizardMachine::~WizardMachine()
{
if (m_pImpl)
{
while (m_pFirstPage)
RemovePage(m_pFirstPage->mxPage.get());
m_pImpl.reset();
}
}
void WizardMachine::implUpdateTitle()
{
OUString sCompleteTitle(m_pImpl->sTitleBase);
// append the page title
BuilderPage* pCurrentPage = GetPage(getCurrentState());
if ( pCurrentPage && !pCurrentPage->GetPageTitle().isEmpty() )
{
sCompleteTitle += " - " + pCurrentPage->GetPageTitle();
}
m_xAssistant->set_title(sCompleteTitle);
}
void WizardMachine::setTitleBase(const OUString& _rTitleBase)
{
m_pImpl->sTitleBase = _rTitleBase;
implUpdateTitle();
}
OUString WizardMachine::getPageIdentForState(WizardTypes::WizardState nState) const
{
return OUString::number(nState);
}
WizardTypes::WizardState WizardMachine::getStateFromPageIdent(const OUString& rIdent) const
{
return rIdent.toInt32();
}
BuilderPage* WizardMachine::GetOrCreatePage( const WizardTypes::WizardState i_nState )
{
if ( nullptr == GetPage( i_nState ) )
{
std::unique_ptr<BuilderPage> xNewPage = createPage( i_nState );
DBG_ASSERT( xNewPage, "WizardMachine::GetOrCreatePage: invalid new page (NULL)!" );
// fill up the page sequence of our base class (with dummies)
while ( m_pImpl->nFirstUnknownPage < i_nState )
{
AddPage( nullptr );
++m_pImpl->nFirstUnknownPage;
}
if ( m_pImpl->nFirstUnknownPage == i_nState )
{
// encountered this page number the first time
AddPage(std::move(xNewPage));
++m_pImpl->nFirstUnknownPage;
}
else
// already had this page - just change it
SetPage(i_nState, std::move(xNewPage));
}
return GetPage( i_nState );
}
void WizardMachine::ActivatePage()
{
WizardTypes::WizardState nCurrentLevel = m_nCurState;
GetOrCreatePage( nCurrentLevel );
enterState( nCurrentLevel );
}
bool WizardMachine::DeactivatePage()
{
WizardTypes::WizardState nCurrentState = getCurrentState();
return leaveState(nCurrentState);
}
void WizardMachine::defaultButton(WizardButtonFlags _nWizardButtonFlags)
{
// the new default button
weld::Button* pNewDefButton = nullptr;
if (_nWizardButtonFlags & WizardButtonFlags::FINISH)
pNewDefButton = m_xFinish.get();
if (_nWizardButtonFlags & WizardButtonFlags::NEXT)
pNewDefButton = m_xNextPage.get();
if (_nWizardButtonFlags & WizardButtonFlags::PREVIOUS)
pNewDefButton = m_xPrevPage.get();
if (_nWizardButtonFlags & WizardButtonFlags::HELP)
pNewDefButton = m_xHelp.get();
if (_nWizardButtonFlags & WizardButtonFlags::CANCEL)
pNewDefButton = m_xCancel.get();
defaultButton(pNewDefButton);
}
void WizardMachine::defaultButton(weld::Button* _pNewDefButton)
{
// loop through all (direct and indirect) descendants which participate in our tabbing order, and
// reset the WB_DEFBUTTON for every window which is a button and set _pNewDefButton as the new
// WB_DEFBUTTON
m_xAssistant->change_default_button(nullptr, _pNewDefButton);
}
void WizardMachine::enableButtons(WizardButtonFlags _nWizardButtonFlags, bool _bEnable)
{
if (_nWizardButtonFlags & WizardButtonFlags::FINISH)
m_xFinish->set_sensitive(_bEnable);
if (_nWizardButtonFlags & WizardButtonFlags::NEXT)
m_xNextPage->set_sensitive(_bEnable);
if (_nWizardButtonFlags & WizardButtonFlags::PREVIOUS)
m_xPrevPage->set_sensitive(_bEnable);
if (_nWizardButtonFlags & WizardButtonFlags::HELP)
m_xHelp->set_sensitive(_bEnable);
if (_nWizardButtonFlags & WizardButtonFlags::CANCEL)
m_xCancel->set_sensitive(_bEnable);
}
void WizardMachine::enterState(WizardTypes::WizardState _nState)
{
// tell the page
IWizardPageController* pController = getPageController( GetPage( _nState ) );
OSL_ENSURE( pController, "WizardMachine::enterState: no controller for the given page!" );
if ( pController )
pController->initializePage();
if ( isAutomaticNextButtonStateEnabled() )
enableButtons( WizardButtonFlags::NEXT, canAdvance() );
enableButtons( WizardButtonFlags::PREVIOUS, !m_pImpl->aStateHistory.empty() );
// set the new title - it depends on the current page (i.e. state)
implUpdateTitle();
}
bool WizardMachine::leaveState(WizardTypes::WizardState)
{
// no need to ask the page here.
// If we reach this point, we already gave the current page the chance to commit it's data,
// and it was allowed to commit it's data
return true;
}
bool WizardMachine::onFinish()
{
return Finish(RET_OK);
}
IMPL_LINK_NOARG(WizardMachine, OnFinish, weld::Button&, void)
{
if ( isTravelingSuspended() )
return;
// prevent WizardTravelSuspension from using this instance
// after will be destructed due to onFinish and async response call
{
WizardTravelSuspension aTravelGuard( *this );
if (!prepareLeaveCurrentState(WizardTypes::eFinish))
{
return;
}
}
onFinish();
}
IMPL_LINK_NOARG(WizardMachine, OnCancel, weld::Button&, void)
{
m_xAssistant->response(RET_CANCEL);
}
WizardTypes::WizardState WizardMachine::determineNextState(WizardTypes::WizardState _nCurrentState ) const
{
return _nCurrentState + 1;
}
bool WizardMachine::prepareLeaveCurrentState( WizardTypes::CommitPageReason _eReason )
{
IWizardPageController* pController = getPageController( GetPage( getCurrentState() ) );
ENSURE_OR_RETURN( pController != nullptr, "WizardMachine::prepareLeaveCurrentState: no controller for the current page!", true );
return pController->commitPage( _eReason );
}
bool WizardMachine::skipBackwardUntil(WizardTypes::WizardState _nTargetState)
{
// allowed to leave the current page?
if ( !prepareLeaveCurrentState( WizardTypes::eTravelBackward ) )
return false;
// don't travel directly on m_pImpl->aStateHistory, in case something goes wrong
std::stack< WizardTypes::WizardState > aTravelVirtually = m_pImpl->aStateHistory;
std::stack< WizardTypes::WizardState > aOldStateHistory = m_pImpl->aStateHistory;
WizardTypes::WizardState nCurrentRollbackState = getCurrentState();
while ( nCurrentRollbackState != _nTargetState )
{
DBG_ASSERT( !aTravelVirtually.empty(), "WizardMachine::skipBackwardUntil: this target state does not exist in the history!" );
nCurrentRollbackState = aTravelVirtually.top();
aTravelVirtually.pop();
}
m_pImpl->aStateHistory = std::move(aTravelVirtually);
if ( !ShowPage( _nTargetState ) )
{
m_pImpl->aStateHistory = std::move(aOldStateHistory);
return false;
}
return true;
}
bool WizardMachine::skipUntil( WizardTypes::WizardState _nTargetState )
{
WizardTypes::WizardState nCurrentState = getCurrentState();
// allowed to leave the current page?
if ( !prepareLeaveCurrentState( nCurrentState < _nTargetState ? WizardTypes::eTravelForward : WizardTypes::eTravelBackward ) )
return false;
// don't travel directly on m_pImpl->aStateHistory, in case something goes wrong
std::stack< WizardTypes::WizardState > aTravelVirtually = m_pImpl->aStateHistory;
std::stack< WizardTypes::WizardState > aOldStateHistory = m_pImpl->aStateHistory;
while ( nCurrentState != _nTargetState )
{
WizardTypes::WizardState nNextState = determineNextState( nCurrentState );
if ( WZS_INVALID_STATE == nNextState )
{
OSL_FAIL( "WizardMachine::skipUntil: the given target state does not exist!" );
return false;
}
// remember the skipped state in the history
aTravelVirtually.push( nCurrentState );
// get the next state
nCurrentState = nNextState;
}
m_pImpl->aStateHistory = std::move(aTravelVirtually);
// show the target page
if ( !ShowPage( nCurrentState ) )
{
// argh! prepareLeaveCurrentPage succeeded, determineNextState succeeded,
// but ShowPage doesn't? Somebody behaves very strange here...
OSL_FAIL( "WizardMachine::skipUntil: very unpolite..." );
m_pImpl->aStateHistory = std::move(aOldStateHistory);
return false;
}
return true;
}
void WizardMachine::skip()
{
// allowed to leave the current page?
if ( !prepareLeaveCurrentState( WizardTypes::eTravelForward ) )
return;
WizardTypes::WizardState nCurrentState = getCurrentState();
WizardTypes::WizardState nNextState = determineNextState(nCurrentState);
if (WZS_INVALID_STATE == nNextState)
return;
// remember the skipped state in the history
m_pImpl->aStateHistory.push(nCurrentState);
// get the next state
nCurrentState = nNextState;
// show the (n+1)th page
if (!ShowPage(nCurrentState))
{
// TODO: this leaves us in a state where we have no current page and an inconsistent state history.
// Perhaps we should rollback the skipping here...
OSL_FAIL("WizardMachine::skip: very unpolite...");
// if somebody does a skip and then does not allow to leave...
// (can't be a commit error, as we've already committed the current page. So if ShowPage fails here,
// somebody behaves really strange ...)
return;
}
// all fine
}
bool WizardMachine::travelNext()
{
// allowed to leave the current page?
if ( !prepareLeaveCurrentState( WizardTypes::eTravelForward ) )
return false;
// determine the next state to travel to
WizardTypes::WizardState nCurrentState = getCurrentState();
WizardTypes::WizardState nNextState = determineNextState(nCurrentState);
if (WZS_INVALID_STATE == nNextState)
return false;
// the state history is used by the enterState method
// all fine
m_pImpl->aStateHistory.push(nCurrentState);
if (!ShowPage(nNextState))
{
m_pImpl->aStateHistory.pop();
return false;
}
return true;
}
bool WizardMachine::ShowPage(WizardTypes::WizardState nState)
{
if (DeactivatePage())
{
BuilderPage* pOldTabPage = m_pCurTabPage;
m_nCurState = nState;
ActivatePage();
if (pOldTabPage)
pOldTabPage->Deactivate();
m_xAssistant->set_current_page(getPageIdentForState(nState));
m_pCurTabPage = GetPage(m_nCurState);
m_pCurTabPage->Activate();
return true;
}
return false;
}
bool WizardMachine::ShowNextPage()
{
return ShowPage(m_nCurState + 1);
}
bool WizardMachine::ShowPrevPage()
{
if (!m_nCurState)
return false;
return ShowPage(m_nCurState - 1);
}
bool WizardMachine::travelPrevious()
{
DBG_ASSERT(!m_pImpl->aStateHistory.empty(), "WizardMachine::travelPrevious: have no previous page!");
// allowed to leave the current page?
if ( !prepareLeaveCurrentState( WizardTypes::eTravelBackward ) )
return false;
// the next state to switch to
WizardTypes::WizardState nPreviousState = m_pImpl->aStateHistory.top();
// the state history is used by the enterState method
m_pImpl->aStateHistory.pop();
// show this page
if (!ShowPage(nPreviousState))
{
m_pImpl->aStateHistory.push(nPreviousState);
return false;
}
// all fine
return true;
}
void WizardMachine::removePageFromHistory( WizardTypes::WizardState nToRemove )
{
std::stack< WizardTypes::WizardState > aTemp;
while(!m_pImpl->aStateHistory.empty())
{
WizardTypes::WizardState nPreviousState = m_pImpl->aStateHistory.top();
m_pImpl->aStateHistory.pop();
if(nPreviousState != nToRemove)
aTemp.push( nPreviousState );
else
break;
}
while(!aTemp.empty())
{
m_pImpl->aStateHistory.push( aTemp.top() );
aTemp.pop();
}
}
void WizardMachine::enableAutomaticNextButtonState()
{
m_pImpl->m_bAutoNextButtonState = true;
}
bool WizardMachine::isAutomaticNextButtonStateEnabled() const
{
return m_pImpl->m_bAutoNextButtonState;
}
IMPL_LINK_NOARG(WizardMachine, OnPrevPage, weld::Button&, void)
{
if ( isTravelingSuspended() )
return;
WizardTravelSuspension aTravelGuard( *this );
travelPrevious();
}
IMPL_LINK_NOARG(WizardMachine, OnNextPage, weld::Button&, void)
{
if ( isTravelingSuspended() )
return;
WizardTravelSuspension aTravelGuard( *this );
travelNext();
}
IWizardPageController* WizardMachine::getPageController(BuilderPage* pCurrentPage) const
{
IWizardPageController* pController = dynamic_cast<IWizardPageController*>(pCurrentPage);
return pController;
}
void WizardMachine::getStateHistory( std::vector< WizardTypes::WizardState >& _out_rHistory )
{
std::stack< WizardTypes::WizardState > aHistoryCopy( m_pImpl->aStateHistory );
while ( !aHistoryCopy.empty() )
{
_out_rHistory.push_back( aHistoryCopy.top() );
aHistoryCopy.pop();
}
}
bool WizardMachine::canAdvance() const
{
return WZS_INVALID_STATE != determineNextState( getCurrentState() );
}
void WizardMachine::updateTravelUI()
{
const IWizardPageController* pController = getPageController( GetPage( getCurrentState() ) );
OSL_ENSURE( pController != nullptr, "WizardMachine::updateTravelUI: no controller for the current page!" );
bool bCanAdvance =
( !pController || pController->canAdvance() ) // the current page allows to advance
&& canAdvance(); // the dialog as a whole allows to advance
enableButtons( WizardButtonFlags::NEXT, bCanAdvance );
}
bool WizardMachine::isTravelingSuspended() const
{
return m_pImpl->m_bTravelingSuspended;
}
void WizardMachine::suspendTraveling( AccessGuard )
{
DBG_ASSERT( !m_pImpl->m_bTravelingSuspended, "WizardMachine::suspendTraveling: already suspended!" );
m_pImpl->m_bTravelingSuspended = true;
}
void WizardMachine::resumeTraveling( AccessGuard )
{
if (!m_pImpl)
return;
DBG_ASSERT( m_pImpl->m_bTravelingSuspended, "WizardMachine::resumeTraveling: nothing to resume!" );
m_pImpl->m_bTravelingSuspended = false;
}
bool WizardMachine::Finish(short nResult)
{
if ( DeactivatePage() )
{
if (m_pCurTabPage)
m_pCurTabPage->Deactivate();
m_xAssistant->response(nResult);
return true;
}
else
return false;
}
void WizardMachine::AddPage(std::unique_ptr<BuilderPage> xPage)
{
WizPageData* pNewPageData = new WizPageData;
pNewPageData->mpNext = nullptr;
pNewPageData->mxPage = std::move(xPage);
if ( !m_pFirstPage )
m_pFirstPage = pNewPageData;
else
{
WizPageData* pPageData = m_pFirstPage;
while ( pPageData->mpNext )
pPageData = pPageData->mpNext;
pPageData->mpNext = pNewPageData;
}
}
void WizardMachine::RemovePage(const BuilderPage* pPage)
{
WizPageData* pPrevPageData = nullptr;
WizPageData* pPageData = m_pFirstPage;
while ( pPageData )
{
if (pPageData->mxPage.get() == pPage)
{
if (pPrevPageData)
pPrevPageData->mpNext = pPageData->mpNext;
else
m_pFirstPage = pPageData->mpNext;
if (pPage == m_pCurTabPage)
m_pCurTabPage = nullptr;
delete pPageData;
return;
}
pPrevPageData = pPageData;
pPageData = pPageData->mpNext;
}
OSL_FAIL( "WizardMachine::RemovePage() - Page not in list" );
}
void WizardMachine::SetPage(WizardTypes::WizardState nLevel, std::unique_ptr<BuilderPage> xPage)
{
sal_uInt16 nTempLevel = 0;
WizPageData* pPageData = m_pFirstPage;
while ( pPageData )
{
if ( (nTempLevel == nLevel) || !pPageData->mpNext )
break;
nTempLevel++;
pPageData = pPageData->mpNext;
}
if ( pPageData )
{
if (pPageData->mxPage.get() == m_pCurTabPage)
m_pCurTabPage = nullptr;
pPageData->mxPage = std::move(xPage);
}
}
BuilderPage* WizardMachine::GetPage(WizardTypes::WizardState nLevel) const
{
sal_uInt16 nTempLevel = 0;
for (WizPageData* pPageData = m_pFirstPage; pPageData;
pPageData = pPageData->mpNext)
{
if ( nTempLevel == nLevel )
return pPageData->mxPage.get();
nTempLevel++;
}
return nullptr;
}
} // namespace svt
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
↑ V547 Expression 'pController != nullptr' is always false.