1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qbs.
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 QBS_BUILDGRAPHNODE_H
41 #define QBS_BUILDGRAPHNODE_H
42 
43 #include "nodeset.h"
44 #include <language/forward_decls.h>
45 #include <tools/persistence.h>
46 #include <tools/weakpointer.h>
47 
48 namespace qbs {
49 namespace Internal {
50 
51 class BuildGraphVisitor;
52 
53 class BuildGraphNode
54 {
55     friend NodeSet;
56 public:
57     virtual ~BuildGraphNode();
58 
59     NodeSet parents;
60     NodeSet children;
61     WeakPointer<ResolvedProduct> product;
62 
63     enum BuildState
64     {
65         Untouched = 0,
66         Buildable,
67         Building,
68         Built
69     };
70 
71     BuildState buildState;                  // Do not serialize. Will be refreshed for every build.
72 
73     enum Type
74     {
75         ArtifactNodeType,
76         RuleNodeType
77     };
78 
79     virtual Type type() const = 0;
80     virtual void accept(BuildGraphVisitor *visitor) = 0;
81     virtual QString toString() const = 0;
82     virtual void onChildDisconnected(BuildGraphNode *child);
83 
isBuilt()84     bool isBuilt() const { return buildState == Built; }
85 
86     virtual void load(PersistentPool &pool);
87     virtual void store(PersistentPool &pool);
88 
89 protected:
90     explicit BuildGraphNode();
91     void acceptChildren(BuildGraphVisitor *visitor);
92 
93     // Do not store parents to avoid recursion.
94     // Parents must be updated after loading all nodes.
serializationOp(PersistentPool & pool)95     template<PersistentPool::OpType opType> void serializationOp(PersistentPool &pool)
96     {
97         pool.serializationOp<opType>(children);
98     }
99 };
100 
101 } // namespace Internal
102 } // namespace qbs
103 
104 #endif // QBS_BUILDGRAPHNODE_H
105