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 QtCore 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 QSTATE_P_H
41 #define QSTATE_P_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 "qstate.h"
55 #include "private/qabstractstate_p.h"
56 
57 #include <QtCore/qlist.h>
58 #include <QtCore/qbytearray.h>
59 #include <QtCore/qpointer.h>
60 #include <QtCore/qvariant.h>
61 
62 QT_REQUIRE_CONFIG(statemachine);
63 
64 QT_BEGIN_NAMESPACE
65 
66 #ifndef QT_NO_PROPERTIES
67 
68 struct QPropertyAssignment
69 {
QPropertyAssignmentQPropertyAssignment70     QPropertyAssignment()
71         : object(nullptr), explicitlySet(true) {}
72     QPropertyAssignment(QObject *o, const QByteArray &n,
73                         const QVariant &v, bool es = true)
objectQPropertyAssignment74         : object(o), propertyName(n), value(v), explicitlySet(es)
75         {}
76 
objectDeletedQPropertyAssignment77     bool objectDeleted() const { return !object; }
writeQPropertyAssignment78     void write() const { Q_ASSERT(object != nullptr); object->setProperty(propertyName, value); }
hasTargetQPropertyAssignment79     bool hasTarget(QObject *o, const QByteArray &pn) const
80     { return object == o && propertyName == pn; }
81 
82     QPointer<QObject> object;
83     QByteArray propertyName;
84     QVariant value;
85     bool explicitlySet; // false means the property is being restored to its old value
86 };
87 Q_DECLARE_TYPEINFO(QPropertyAssignment, Q_MOVABLE_TYPE);
88 
89 #endif // QT_NO_PROPERTIES
90 
91 class QAbstractTransition;
92 class QHistoryState;
93 
94 class QState;
95 class Q_CORE_EXPORT QStatePrivate : public QAbstractStatePrivate
96 {
97     Q_DECLARE_PUBLIC(QState)
98 public:
99     QStatePrivate();
100     ~QStatePrivate();
101 
get(QState * q)102     static QStatePrivate *get(QState *q) { return q ? q->d_func() : nullptr; }
get(const QState * q)103     static const QStatePrivate *get(const QState *q) { return q? q->d_func() : nullptr; }
104 
105     QList<QAbstractState*> childStates() const;
106     QList<QHistoryState*> historyStates() const;
107     QList<QAbstractTransition*> transitions() const;
108 
109     void emitFinished();
110     void emitPropertiesAssigned();
111 
112     QAbstractState *errorState;
113     QAbstractState *initialState;
114     QState::ChildMode childMode;
115     mutable bool childStatesListNeedsRefresh;
116     mutable bool transitionsListNeedsRefresh;
117     mutable QList<QAbstractState*> childStatesList;
118     mutable QList<QAbstractTransition*> transitionsList;
119 
120 #ifndef QT_NO_PROPERTIES
121     QVector<QPropertyAssignment> propertyAssignments;
122 #endif
123 };
124 
125 QT_END_NAMESPACE
126 
127 #endif
128