1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtScxml module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSCXMLSTATEMACHINEINFO_H
41#define QSCXMLSTATEMACHINEINFO_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtScxml/qscxmlglobals.h>
55#include <QtCore/qobject.h>
56
57QT_BEGIN_NAMESPACE
58
59class QScxmlStateMachine;
60class QScxmlStateMachineInfoPrivate;
61
62class Q_SCXML_EXPORT QScxmlStateMachineInfo: public QObject
63{
64 Q_OBJECT
65
66public: // types
67 typedef int StateId;
68 typedef int TransitionId;
69
70 static const StateId InvalidStateId = -1;
71 static const TransitionId InvalidTransitionId = -1;
72
73 enum StateType : int {
74 InvalidState = -1,
75 NormalState = 0,
76 ParallelState = 1,
77 FinalState = 2,
78 ShallowHistoryState = 3,
79 DeepHistoryState = 4
80 };
81
82 enum TransitionType : int {
83 InvalidTransition = -1,
84 InternalTransition = 0,
85 ExternalTransition = 1,
86 SyntheticTransition = 2
87 };
88
89public: // methods
90 QScxmlStateMachineInfo(QScxmlStateMachine *stateMachine);
91
92 QScxmlStateMachine *stateMachine() const;
93
94 QVector<StateId> allStates() const;
95 QVector<TransitionId> allTransitions() const;
96 QString stateName(int stateId) const;
97 StateId stateParent(StateId stateId) const;
98 StateType stateType(int stateId) const;
99 QVector<StateId> stateChildren(StateId stateId) const;
100 TransitionId initialTransition(StateId stateId) const;
101 TransitionType transitionType(TransitionId transitionId) const;
102 StateId transitionSource(TransitionId transitionId) const;
103 QVector<StateId> transitionTargets(TransitionId transitionId) const;
104 QVector<QString> transitionEvents(TransitionId transitionId) const;
105 QVector<StateId> configuration() const;
106
107Q_SIGNALS:
108 void statesEntered(const QVector<QScxmlStateMachineInfo::StateId> &states);
109 void statesExited(const QVector<QScxmlStateMachineInfo::StateId> &states);
110 void transitionsTriggered(const QVector<QScxmlStateMachineInfo::TransitionId> &transitions);
111
112private:
113 Q_DECLARE_PRIVATE(QScxmlStateMachineInfo)
114};
115
116QT_END_NAMESPACE
117
118#endif // QSCXMLSTATEMACHINEINFO_H
119

source code of qtscxml/src/scxml/qscxmlstatemachineinfo_p.h