diff options
Diffstat (limited to 'src/corelib/statemachine/qstate.cpp')
| -rw-r--r-- | src/corelib/statemachine/qstate.cpp | 603 |
1 files changed, 0 insertions, 603 deletions
diff --git a/src/corelib/statemachine/qstate.cpp b/src/corelib/statemachine/qstate.cpp deleted file mode 100644 index dd92bfe7ba..0000000000 --- a/src/corelib/statemachine/qstate.cpp +++ /dev/null @@ -1,603 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtCore module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include "qstate_p.h" -#include "qhistorystate.h" -#include "qhistorystate_p.h" -#include "qabstracttransition.h" -#include "qabstracttransition_p.h" -#include "qsignaltransition.h" -#include "qstatemachine.h" -#include "qstatemachine_p.h" - -QT_BEGIN_NAMESPACE - -/*! - \class QState - \inmodule QtCore - - \brief The QState class provides a general-purpose state for QStateMachine. - - \since 4.6 - \ingroup statemachine - - QState objects can have child states, and can have transitions to other - states. QState is part of \l{The State Machine Framework}. - - The addTransition() function adds a transition. The removeTransition() - function removes a transition. The transitions() function returns the - state's outgoing transitions. - - The assignProperty() function is used for defining property assignments that - should be performed when a state is entered. - - Top-level states must be passed a QStateMachine object as their parent - state, or added to a state machine using QStateMachine::addState(). - - \section1 States with Child States - - The childMode property determines how child states are treated. For - non-parallel state groups, the setInitialState() function must be called to - set the initial state. The child states are mutually exclusive states, and - the state machine needs to know which child state to enter when the parent - state is the target of a transition. - - The state emits the QState::finished() signal when a final child state - (QFinalState) is entered. - - The setErrorState() sets the state's error state. The error state is the - state that the state machine will transition to if an error is detected when - attempting to enter the state (e.g. because no initial state has been set). - -*/ - -/*! - \property QState::initialState - - \brief the initial state of this state (one of its child states) -*/ - -/*! - \property QState::errorState - - \brief the error state of this state -*/ - -/*! - \property QState::childMode - - \brief the child mode of this state - - The default value of this property is QState::ExclusiveStates. -*/ - -/*! - \enum QState::ChildMode - - This enum specifies how a state's child states are treated. - - \value ExclusiveStates The child states are mutually exclusive and an - initial state must be set by calling QState::setInitialState(). - - \value ParallelStates The child states are parallel. When the parent state - is entered, all its child states are entered in parallel. -*/ - -/*! - \enum QState::RestorePolicy - - This enum specifies the restore policy type. The restore policy - takes effect when the machine enters a state which sets one or more - properties. If the restore policy is set to RestoreProperties, - the state machine will save the original value of the property before the - new value is set. - - Later, when the machine either enters a state which does not set - a value for the given property, the property will automatically be restored - to its initial value. - - Only one initial value will be saved for any given property. If a value for a property has - already been saved by the state machine, it will not be overwritten until the property has been - successfully restored. - - \value DontRestoreProperties The state machine should not save the initial values of properties - and restore them later. - \value RestoreProperties The state machine should save the initial values of properties - and restore them later. - - \sa QStateMachine::globalRestorePolicy, QState::assignProperty() -*/ - -QStatePrivate::QStatePrivate() - : QAbstractStatePrivate(StandardState), - errorState(nullptr), initialState(nullptr), childMode(QState::ExclusiveStates), - childStatesListNeedsRefresh(true), transitionsListNeedsRefresh(true) -{ -} - -QStatePrivate::~QStatePrivate() -{ -} - -void QStatePrivate::emitFinished() -{ - Q_Q(QState); - emit q->finished(QState::QPrivateSignal()); -} - -void QStatePrivate::emitPropertiesAssigned() -{ - Q_Q(QState); - emit q->propertiesAssigned(QState::QPrivateSignal()); -} - -/*! - Constructs a new state with the given \a parent state. -*/ -QState::QState(QState *parent) - : QAbstractState(*new QStatePrivate, parent) -{ -} - -/*! - Constructs a new state with the given \a childMode and the given \a parent - state. -*/ -QState::QState(ChildMode childMode, QState *parent) - : QAbstractState(*new QStatePrivate, parent) -{ - Q_D(QState); - d->childMode = childMode; -} - -/*! - \internal -*/ -QState::QState(QStatePrivate &dd, QState *parent) - : QAbstractState(dd, parent) -{ -} - -/*! - Destroys this state. -*/ -QState::~QState() -{ -} - -QList<QAbstractState*> QStatePrivate::childStates() const -{ - if (childStatesListNeedsRefresh) { - childStatesList.clear(); - QList<QObject*>::const_iterator it; - for (it = children.constBegin(); it != children.constEnd(); ++it) { - QAbstractState *s = qobject_cast<QAbstractState*>(*it); - if (!s || qobject_cast<QHistoryState*>(s)) - continue; - childStatesList.append(s); - } - childStatesListNeedsRefresh = false; - } - return childStatesList; -} - -QList<QHistoryState*> QStatePrivate::historyStates() const -{ - QList<QHistoryState*> result; - QList<QObject*>::const_iterator it; - for (it = children.constBegin(); it != children.constEnd(); ++it) { - QHistoryState *h = qobject_cast<QHistoryState*>(*it); - if (h) - result.append(h); - } - return result; -} - -QList<QAbstractTransition*> QStatePrivate::transitions() const -{ - if (transitionsListNeedsRefresh) { - transitionsList.clear(); - QList<QObject*>::const_iterator it; - for (it = children.constBegin(); it != children.constEnd(); ++it) { - QAbstractTransition *t = qobject_cast<QAbstractTransition*>(*it); - if (t) - transitionsList.append(t); - } - transitionsListNeedsRefresh = false; - } - return transitionsList; -} - -#ifndef QT_NO_PROPERTIES - -/*! - Instructs this state to set the property with the given \a name of the given - \a object to the given \a value when the state is entered. - - \sa propertiesAssigned() -*/ -void QState::assignProperty(QObject *object, const char *name, - const QVariant &value) -{ - Q_D(QState); - if (!object) { - qWarning("QState::assignProperty: cannot assign property '%s' of null object", name); - return; - } - for (int i = 0; i < d->propertyAssignments.size(); ++i) { - QPropertyAssignment &assn = d->propertyAssignments[i]; - if (assn.hasTarget(object, name)) { - assn.value = value; - return; - } - } - d->propertyAssignments.append(QPropertyAssignment(object, name, value)); -} - -#endif // QT_NO_PROPERTIES - -/*! - Returns this state's error state. - - \sa QStateMachine::error() -*/ -QAbstractState *QState::errorState() const -{ - Q_D(const QState); - return d->errorState; -} - -/*! - Sets this state's error state to be the given \a state. If the error state - is not set, or if it is set to \nullptr, the state will inherit its parent's error - state recursively. If no error state is set for the state itself or any of - its ancestors, an error will cause the machine to stop executing and an error - will be printed to the console. -*/ -void QState::setErrorState(QAbstractState *state) -{ - Q_D(QState); - if (state != nullptr && qobject_cast<QStateMachine*>(state)) { - qWarning("QStateMachine::setErrorState: root state cannot be error state"); - return; - } - if (state != nullptr && (!state->machine() || ((state->machine() != machine()) && !qobject_cast<QStateMachine*>(this)))) { - qWarning("QState::setErrorState: error state cannot belong " - "to a different state machine"); - return; - } - - if (d->errorState != state) { - d->errorState = state; - emit errorStateChanged(QState::QPrivateSignal()); - } -} - -/*! - Adds the given \a transition. The transition has this state as the source. - This state takes ownership of the transition. -*/ -void QState::addTransition(QAbstractTransition *transition) -{ - Q_D(QState); - if (!transition) { - qWarning("QState::addTransition: cannot add null transition"); - return ; - } - - transition->setParent(this); - const QList<QPointer<QAbstractState>> &targets = QAbstractTransitionPrivate::get(transition)->targetStates; - for (int i = 0; i < targets.size(); ++i) { - QAbstractState *t = targets.at(i).data(); - if (!t) { - qWarning("QState::addTransition: cannot add transition to null state"); - return ; - } - if ((QAbstractStatePrivate::get(t)->machine() != d->machine()) - && QAbstractStatePrivate::get(t)->machine() && d->machine()) { - qWarning("QState::addTransition: cannot add transition " - "to a state in a different state machine"); - return ; - } - } - if (QStateMachine *mach = machine()) - QStateMachinePrivate::get(mach)->maybeRegisterTransition(transition); -} - -/*! - \fn template <typename PointerToMemberFunction> QState::addTransition(const QObject *sender, PointerToMemberFunction signal, QAbstractState *target); - \since 5.5 - \overload - - Adds a transition associated with the given \a signal of the given \a sender - object, and returns the new QSignalTransition object. The transition has - this state as the source, and the given \a target as the target state. -*/ - -/*! - Adds a transition associated with the given \a signal of the given \a sender - object, and returns the new QSignalTransition object. The transition has - this state as the source, and the given \a target as the target state. -*/ -QSignalTransition *QState::addTransition(const QObject *sender, const char *signal, - QAbstractState *target) -{ - if (!sender) { - qWarning("QState::addTransition: sender cannot be null"); - return nullptr; - } - if (!signal) { - qWarning("QState::addTransition: signal cannot be null"); - return nullptr; - } - if (!target) { - qWarning("QState::addTransition: cannot add transition to null state"); - return nullptr; - } - int offset = (*signal == '0'+QSIGNAL_CODE) ? 1 : 0; - const QMetaObject *meta = sender->metaObject(); - if (meta->indexOfSignal(signal+offset) == -1) { - if (meta->indexOfSignal(QMetaObject::normalizedSignature(signal+offset)) == -1) { - qWarning("QState::addTransition: no such signal %s::%s", - meta->className(), signal+offset); - return nullptr; - } - } - QSignalTransition *trans = new QSignalTransition(sender, signal); - trans->setTargetState(target); - addTransition(trans); - return trans; -} - -namespace { - -// ### Make public? -class UnconditionalTransition : public QAbstractTransition -{ -public: - UnconditionalTransition(QAbstractState *target) - : QAbstractTransition() - { setTargetState(target); } -protected: - void onTransition(QEvent *) override {} - bool eventTest(QEvent *) override { return true; } -}; - -} // namespace - -/*! - Adds an unconditional transition from this state to the given \a target - state, and returns then new transition object. -*/ -QAbstractTransition *QState::addTransition(QAbstractState *target) -{ - if (!target) { - qWarning("QState::addTransition: cannot add transition to null state"); - return nullptr; - } - UnconditionalTransition *trans = new UnconditionalTransition(target); - addTransition(trans); - return trans; -} - -/*! - Removes the given \a transition from this state. The state releases - ownership of the transition. - - \sa addTransition() -*/ -void QState::removeTransition(QAbstractTransition *transition) -{ - Q_D(QState); - if (!transition) { - qWarning("QState::removeTransition: cannot remove null transition"); - return; - } - if (transition->sourceState() != this) { - qWarning("QState::removeTransition: transition %p's source state (%p)" - " is different from this state (%p)", - transition, transition->sourceState(), this); - return; - } - QStateMachinePrivate *mach = QStateMachinePrivate::get(d->machine()); - if (mach) - mach->unregisterTransition(transition); - transition->setParent(nullptr); -} - -/*! - \since 4.7 - - Returns this state's outgoing transitions (i.e. transitions where - this state is the \l{QAbstractTransition::sourceState()}{source - state}), or an empty list if this state has no outgoing transitions. - - \sa addTransition() -*/ -QList<QAbstractTransition*> QState::transitions() const -{ - Q_D(const QState); - return d->transitions(); -} - -/*! - \reimp -*/ -void QState::onEntry(QEvent *event) -{ - Q_UNUSED(event); -} - -/*! - \reimp -*/ -void QState::onExit(QEvent *event) -{ - Q_UNUSED(event); -} - -/*! - Returns this state's initial state, or \nullptr if the state has no - initial state. -*/ -QAbstractState *QState::initialState() const -{ - Q_D(const QState); - return d->initialState; -} - -/*! - Sets this state's initial state to be the given \a state. - \a state has to be a child of this state. -*/ -void QState::setInitialState(QAbstractState *state) -{ - Q_D(QState); - if (d->childMode == QState::ParallelStates) { - qWarning("QState::setInitialState: ignoring attempt to set initial state " - "of parallel state group %p", this); - return; - } - if (state && (state->parentState() != this)) { - qWarning("QState::setInitialState: state %p is not a child of this state (%p)", - state, this); - return; - } - if (d->initialState != state) { - d->initialState = state; - emit initialStateChanged(QState::QPrivateSignal()); - } -} - -/*! - Returns the child mode of this state. -*/ -QState::ChildMode QState::childMode() const -{ - Q_D(const QState); - return d->childMode; -} - -/*! - Sets the child \a mode of this state. -*/ -void QState::setChildMode(ChildMode mode) -{ - Q_D(QState); - - if (mode == QState::ParallelStates && d->initialState) { - qWarning("QState::setChildMode: setting the child-mode of state %p to " - "parallel removes the initial state", this); - d->initialState = nullptr; - emit initialStateChanged(QState::QPrivateSignal()); - } - - if (d->childMode != mode) { - d->childMode = mode; - emit childModeChanged(QState::QPrivateSignal()); - } -} - -/*! - \reimp -*/ -bool QState::event(QEvent *e) -{ - Q_D(QState); - if ((e->type() == QEvent::ChildAdded) || (e->type() == QEvent::ChildRemoved)) { - d->childStatesListNeedsRefresh = true; - d->transitionsListNeedsRefresh = true; - if ((e->type() == QEvent::ChildRemoved) && (static_cast<QChildEvent *>(e)->child() == d->initialState)) - d->initialState = nullptr; - } - return QAbstractState::event(e); -} - -/*! - \fn QState::finished() - - This signal is emitted when a final child state of this state is entered. - - \sa QFinalState -*/ - -/*! - \fn QState::propertiesAssigned() - - This signal is emitted when all properties have been assigned their final value. If the state - assigns a value to one or more properties for which an animation exists (either set on the - transition or as a default animation on the state machine), then the signal will not be emitted - until all such animations have finished playing. - - If there are no relevant animations, or no property assignments defined for the state, then - the signal will be emitted immediately before the state is entered. - - \sa QState::assignProperty(), QAbstractTransition::addAnimation() -*/ - -/*! - \fn QState::childModeChanged() - \since 5.4 - - This signal is emitted when the childMode property is changed. - - \sa QState::childMode -*/ - -/*! - \fn QState::initialStateChanged() - \since 5.4 - - This signal is emitted when the initialState property is changed. - - \sa QState::initialState -*/ - -/*! - \fn QState::errorStateChanged() - \since 5.4 - - This signal is emitted when the errorState property is changed. - - \sa QState::errorState -*/ - -QT_END_NAMESPACE - -#include "moc_qstate.cpp" |