summaryrefslogtreecommitdiffstats
path: root/src/scxml/qscxmlqstates.h
blob: 7014861d99dbc35c081fe15cdb338ed8f4a4f600 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtScxml 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$
**
****************************************************************************/

#ifndef SCXMLQSTATES_H
#define SCXMLQSTATES_H

#include <QtScxml/qscxmlstatemachine.h>
#include <QtScxml/qscxmlinvokableservice.h>

#include <QAbstractTransition>
#include <QFinalState>
#include <QHistoryState>
#include <QState>

QT_BEGIN_NAMESPACE

template<class T>
class QScxmlInvokeScxmlFactory: public QScxmlInvokableScxmlServiceFactory
{
public:
    QScxmlInvokeScxmlFactory(QScxmlExecutableContent::StringId invokeLocation,
                             QScxmlExecutableContent::EvaluatorId srcexpr,
                             QScxmlExecutableContent::StringId id,
                             QScxmlExecutableContent::StringId idPrefix,
                             QScxmlExecutableContent::StringId idlocation,
                             const QVector<QScxmlExecutableContent::StringId> &namelist,
                             bool doAutoforward,
                             const QVector<Param> &params,
                             QScxmlExecutableContent::ContainerId finalize)
        : QScxmlInvokableScxmlServiceFactory(invokeLocation,
                                             srcexpr,
                                             id,
                                             idPrefix,
                                             idlocation,
                                             namelist,
                                             doAutoforward,
                                             params,
                                             finalize)
    {}

    QScxmlInvokableService *invoke(QScxmlStateMachine *parent) Q_DECL_OVERRIDE
    {
        bool ok = true;
        auto srcexpr = calculateSrcexpr(parent, &ok);
        if (!ok)
            return Q_NULLPTR;

        if (!srcexpr.isEmpty())
            return loadAndInvokeDynamically(parent, srcexpr);

        return finishInvoke(new T, parent);
    }
};

class QScxmlStatePrivate;
class Q_SCXML_EXPORT QScxmlState: public QState
{
    Q_OBJECT

public:
    QScxmlState(QState *parent = Q_NULLPTR);
    QScxmlState(QScxmlStateMachine *parent);
    ~QScxmlState();

    void setAsInitialStateFor(QScxmlState *state);
    void setAsInitialStateFor(QScxmlStateMachine *stateMachine);

    QScxmlStateMachine *stateMachine() const;
    QString stateLocation() const;

    void setInitInstructions(QScxmlExecutableContent::ContainerId instructions);
    void setOnEntryInstructions(QScxmlExecutableContent::ContainerId instructions);
    void setOnExitInstructions(QScxmlExecutableContent::ContainerId instructions);
    void setInvokableServiceFactories(const QVector<QScxmlInvokableServiceFactory *>& factories);

Q_SIGNALS:
    void didEnter(); // TODO: REMOVE!
    void willExit(); // TODO: REMOVE!

protected:
    void onEntry(QEvent * event) Q_DECL_OVERRIDE;
    void onExit(QEvent * event) Q_DECL_OVERRIDE;

private:
    Q_DECLARE_PRIVATE(QScxmlState)
};

class QScxmlFinalStatePrivate;
class Q_SCXML_EXPORT QScxmlFinalState: public QFinalState
{
    Q_OBJECT

public:
    QScxmlFinalState(QState *parent = Q_NULLPTR);
    QScxmlFinalState(QScxmlStateMachine *parent);
    ~QScxmlFinalState();

    void setAsInitialStateFor(QScxmlState *state);
    void setAsInitialStateFor(QScxmlStateMachine *stateMachine);

    QScxmlStateMachine *stateMachine() const;

    QScxmlExecutableContent::ContainerId doneData() const;
    void setDoneData(QScxmlExecutableContent::ContainerId doneData);

    void setOnEntryInstructions(QScxmlExecutableContent::ContainerId instructions);
    void setOnExitInstructions(QScxmlExecutableContent::ContainerId instructions);

protected:
    void onEntry(QEvent * event) Q_DECL_OVERRIDE;
    void onExit(QEvent * event) Q_DECL_OVERRIDE;

private:
    Q_DECLARE_PRIVATE(QScxmlFinalState)
};

class Q_SCXML_EXPORT QScxmlHistoryState: public QHistoryState
{
    Q_OBJECT

public:
    QScxmlHistoryState(QState *parent = Q_NULLPTR);
    ~QScxmlHistoryState();

    void setAsInitialStateFor(QScxmlState *state);
    void setAsInitialStateFor(QScxmlStateMachine *stateMachine);

    QScxmlStateMachine *stateMachine() const;
};

class QScxmlBaseTransitionPrivate;
class Q_SCXML_EXPORT QScxmlBaseTransition: public QAbstractTransition
{
    Q_OBJECT
    class Data;

public:
    QScxmlBaseTransition(QState * sourceState = Q_NULLPTR,
                         const QStringList &eventSelector = QStringList());
    ~QScxmlBaseTransition();

    QScxmlStateMachine *stateMachine() const;
    QString transitionLocation() const;

    bool eventTest(QEvent *event) Q_DECL_OVERRIDE;

protected:
    void onTransition(QEvent *event) Q_DECL_OVERRIDE;

    QScxmlBaseTransition(QScxmlBaseTransitionPrivate &dd, QState *parent,
                         const QStringList &eventSelector = QStringList());

private:
    Q_DECLARE_PRIVATE(QScxmlBaseTransition)
};

class QScxmlTransitionPrivate;
class Q_SCXML_EXPORT QScxmlTransition: public QScxmlBaseTransition
{
    Q_OBJECT

public:
    QScxmlTransition(QState * sourceState = Q_NULLPTR,
                     const QStringList &eventSelector = QStringList());
    QScxmlTransition(const QStringList &eventSelector);
    ~QScxmlTransition();

    void addTransitionTo(QScxmlState *state);
    void addTransitionTo(QScxmlStateMachine *stateMachine);

    bool eventTest(QEvent *event) Q_DECL_OVERRIDE;
    QScxmlStateMachine *stateMachine() const;

    void setInstructionsOnTransition(QScxmlExecutableContent::ContainerId instructions);
    void setConditionalExpression(QScxmlExecutableContent::EvaluatorId evaluator);

protected:
    void onTransition(QEvent *event) Q_DECL_OVERRIDE;

private:
    Q_DECLARE_PRIVATE(QScxmlTransition)
};

QT_END_NAMESPACE

#endif // SCXMLQSTATES_H