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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
/****************************************************************************
**
** Copyright (C) 2021 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:COMM$
**
** 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.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/
#include "qscxmldatamodel_p.h"
#include "qscxmlnulldatamodel.h"
#if QT_CONFIG(scxml_ecmascriptdatamodel)
#include "qscxmlecmascriptdatamodel.h"
#endif
#include "qscxmlstatemachine_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QScxmlDataModel::ForeachLoopBody
\brief The ForeachLoopBody class represents a function to be executed on
each iteration of an SCXML foreach loop.
\since 5.8
\inmodule QtScxml
*/
/*!
Creates a new foreach loop body.
*/
QScxmlDataModel::ForeachLoopBody::ForeachLoopBody()
{}
/*!
Destroys a foreach loop body.
*/
QScxmlDataModel::ForeachLoopBody::~ForeachLoopBody()
{}
/*!
\fn QScxmlDataModel::ForeachLoopBody::run(bool *ok)
This function is executed on each iteration. If the execution fails, \a ok is
set to \c false, otherwise it is set to \c true.
*/
/*!
* \class QScxmlDataModel
* \brief The QScxmlDataModel class is the data model base class for a Qt SCXML
* state machine.
* \since 5.7
* \inmodule QtScxml
*
* SCXML data models are described in
* \l {SCXML Specification - 5 Data Model and Data Manipulation}. For more
* information about supported data models, see \l {SCXML Compliance}.
*
* One data model can only belong to one state machine.
*
* \sa QScxmlStateMachine QScxmlCppDataModel QScxmlEcmaScriptDataModel QScxmlNullDataModel
*/
/*!
\property QScxmlDataModel::stateMachine
\brief The state machine this data model belongs to.
A data model can only belong to a single state machine and a state machine
can only have one data model. This relation needs to be set up before the
state machine is started. Setting this property on a data model will
automatically set the corresponding \c dataModel property on the
\a stateMachine.
*/
/*!
* Creates a new data model, with the parent object \a parent.
*/
QScxmlDataModel::QScxmlDataModel(QObject *parent)
: QObject(*(new QScxmlDataModelPrivate), parent)
{
}
/*!
Creates a new data model from the private object \a dd, with the parent
object \a parent.
*/
QScxmlDataModel::QScxmlDataModel(QScxmlDataModelPrivate &dd, QObject *parent) :
QObject(dd, parent)
{
}
/*!
* Sets the state machine this model belongs to to \a stateMachine. There is a
* 1:1 relation between state machines and models. After setting the state
* machine once you cannot change it anymore. Any further attempts to set the
* state machine using this method will be ignored.
*/
void QScxmlDataModel::setStateMachine(QScxmlStateMachine *stateMachine)
{
Q_D(QScxmlDataModel);
if (d->m_stateMachine == nullptr && stateMachine != nullptr) {
d->m_stateMachine = stateMachine;
if (stateMachine)
stateMachine->setDataModel(this);
emit stateMachineChanged(stateMachine);
}
}
/*!
* Returns the state machine associated with the data model.
*/
QScxmlStateMachine *QScxmlDataModel::stateMachine() const
{
Q_D(const QScxmlDataModel);
return d->m_stateMachine;
}
QScxmlDataModel *QScxmlDataModelPrivate::instantiateDataModel(DocumentModel::Scxml::DataModelType type)
{
QScxmlDataModel *dataModel = nullptr;
switch (type) {
case DocumentModel::Scxml::NullDataModel:
dataModel = new QScxmlNullDataModel;
break;
case DocumentModel::Scxml::JSDataModel:
#if QT_CONFIG(scxml_ecmascriptdatamodel)
dataModel = new QScxmlEcmaScriptDataModel;
#endif
break;
case DocumentModel::Scxml::CppDataModel:
break;
default:
Q_UNREACHABLE();
}
return dataModel;
}
/*!
* \fn QScxmlDataModel::setup(const QVariantMap &initialDataValues)
*
* Initializes the data model with the initial values specified by
* \a initialDataValues.
*
* Returns \c false if parse errors occur or if any of the initialization steps
* fail. Returns \c true otherwise.
*/
/*!
* \fn QScxmlDataModel::setScxmlEvent(const QScxmlEvent &event)
*
* Sets the \a event to use in the subsequent executable content execution.
*/
/*!
* \fn QScxmlDataModel::scxmlProperty(const QString &name) const
*
* Returns the value of the property \a name.
*/
/*!
* \fn QScxmlDataModel::hasScxmlProperty(const QString &name) const
*
* Returns \c true if a property with the given \a name exists, \c false
* otherwise.
*/
/*!
* \fn QScxmlDataModel::setScxmlProperty(const QString &name,
* const QVariant &value,
* const QString &context)
*
* Sets a the value \a value for the property \a name.
*
* The \a context is a string that is used in error messages to indicate the
* location in the SCXML file where the error occurred.
*
* Returns \c true if successful or \c false if an error occurred.
*/
/*!
* \fn QScxmlDataModel::evaluateToString(
* QScxmlExecutableContent::EvaluatorId id, bool *ok)
* Evaluates the executable content pointed to by \a id and sets \a ok to
* \c false if there was an error or to \c true if there was not.
* Returns the result of the evaluation as a QString.
*/
/*!
* \fn QScxmlDataModel::evaluateToBool(QScxmlExecutableContent::EvaluatorId id,
* bool *ok)
* Evaluates the executable content pointed to by \a id and sets \a ok to
* \c false if there was an error or to \c true if there was not.
* Returns the result of the evaluation as a boolean value.
*/
/*!
* \fn QScxmlDataModel::evaluateToVariant(
* QScxmlExecutableContent::EvaluatorId id, bool *ok)
* Evaluates the executable content pointed to by \a id and sets \a ok to
* \c false if there was an error or to \c true if there was not.
* Returns the result of the evaluation as a QVariant.
*/
/*!
* \fn QScxmlDataModel::evaluateToVoid(QScxmlExecutableContent::EvaluatorId id,
* bool *ok)
* Evaluates the executable content pointed to by \a id and sets \a ok to
* \c false if there was an error or to \c true if there was not.
* The execution is expected to return no result.
*/
/*!
* \fn QScxmlDataModel::evaluateAssignment(
* QScxmlExecutableContent::EvaluatorId id, bool *ok)
* Evaluates the assignment pointed to by \a id and sets \a ok to
* \c false if there was an error or to \c true if there was not.
*/
/*!
* \fn QScxmlDataModel::evaluateInitialization(
* QScxmlExecutableContent::EvaluatorId id, bool *ok)
* Evaluates the initialization pointed to by \a id and sets \a ok to
* \c false if there was an error or to \c true if there was not.
*/
/*!
* \fn QScxmlDataModel::evaluateForeach(
* QScxmlExecutableContent::EvaluatorId id, bool *ok,
* ForeachLoopBody *body)
* Evaluates the foreach loop pointed to by \a id and sets \a ok to
* \c false if there was an error or to \c true if there was not. The
* \a body is executed on each iteration.
*/
QT_END_NAMESPACE
|
