Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlincubator_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtQml 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 Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QQMLINCUBATOR_P_H
43 #define QQMLINCUBATOR_P_H
44
45 #include <private/qintrusivelist_p.h>
46 #include <private/qqmlvme_p.h>
47 #include <private/qrecursionwatcher_p.h>
48 #include <private/qqmlengine_p.h>
49 #include <private/qqmlcontext_p.h>
50
51 //
52 //  W A R N I N G
53 //  -------------
54 //
55 // This file is not part of the Qt API.  It exists purely as an
56 // implementation detail.  This header file may change from version to
57 // version without notice, or even be removed.
58 //
59 // We mean it.
60 //
61
62 QT_BEGIN_NAMESPACE
63
64 class QQmlCompiledData;
65 class QQmlIncubator;
66 class QQmlIncubatorPrivate : public QQmlEnginePrivate::Incubator
67 {
68 public:
69     QQmlIncubatorPrivate(QQmlIncubator *q, QQmlIncubator::IncubationMode m);
70     ~QQmlIncubatorPrivate();
71
72     inline static QQmlIncubatorPrivate *get(QQmlIncubator *incubator) { return incubator->d; }
73
74     QQmlIncubator *q;
75
76     QQmlIncubator::Status calculateStatus() const;
77     void changeStatus(QQmlIncubator::Status);
78     QQmlIncubator::Status status;
79
80     QQmlIncubator::IncubationMode mode;
81     bool isAsynchronous;
82
83     QList<QQmlError> errors;
84
85     enum Progress { Execute, Completing, Completed };
86     Progress progress;
87
88     QQmlGuard<QObject> result;
89     QQmlGuardedContextData rootContext;
90     QQmlCompiledData *compiledData;
91     QQmlVME vme;
92     QQmlVMEGuard vmeGuard;
93
94     QQmlIncubatorPrivate *waitingOnMe;
95     typedef QQmlEnginePrivate::Incubator QIPBase;
96     QIntrusiveList<QIPBase, &QIPBase::nextWaitingFor> waitingFor;
97
98     QRecursionNode recursion;
99
100     void clear();
101
102     void incubate(QQmlVME::Interrupt &i);
103 };
104
105 QT_END_NAMESPACE
106
107 #endif // QQMLINCUBATOR_P_H
108