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
|
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef QMLDOMFILELOCATIONS_P_H
#define QMLDOMFILELOCATIONS_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include "qqmldom_global.h"
#include "qqmldomitem_p.h"
#include <memory>
QT_BEGIN_NAMESPACE
namespace QQmlJS {
namespace Dom {
namespace FileLocations {
struct Info
{
constexpr static DomType kindValue = DomType::FileLocationsInfo;
// mainly used for debugging, for example dumping qmlFile
bool iterateDirectSubpaths(const DomItem &self, DirectVisitor) const;
SourceLocation fullRegion;
QMap<FileLocationRegion, SourceLocation> regions;
};
using Tree = std::shared_ptr<Node>;
Tree createTree(const Path &basePath);
Tree ensure(const Tree &base, const Path &basePath);
Tree find(const Tree &self, const Path &p);
bool visitTree(const Tree &base, function_ref<bool(const Path &, const Tree &)> visitor,
const Path &basePath = Path());
// TODO move to some testing utils
QString canonicalPathForTesting(const Tree &base);
// returns the path looked up and the found tree when looking for the info attached to item
Tree treeOf(const DomItem &);
// beware of shrinking and reassigning regions (QTBUG-131288)
void addRegion(const Tree &fLoc, FileLocationRegion region, SourceLocation loc);
QQmlJS::SourceLocation region(const Tree &fLoc, FileLocationRegion region);
class QMLDOM_EXPORT Node : public OwningItem, public std::enable_shared_from_this<Node>
{
public:
constexpr static DomType kindValue = DomType::FileLocationsNode;
using Ptr = std::shared_ptr<Node>;
DomType kind() const override { return kindValue; }
Path canonicalPath(const DomItem &self) const override { return self.m_ownerPath; }
// mainly used for debugging, for example dumping qmlFile
bool iterateDirectSubpaths(const DomItem &self, DirectVisitor visitor) const override;
Node::Ptr makeCopy(const DomItem &self) const
{
return std::static_pointer_cast<Node>(doCopy(self));
}
static Ptr instantiate(const Ptr &parent = nullptr, const Path &p = Path());
Path path() const { return m_path; }
Ptr parent() const { return m_parent.lock(); }
QMap<Path, Ptr> subItems() const { return m_subItems; }
FileLocations::Info &info() { return m_info; }
void setPath(const Path &p) { m_path = p; }
Ptr insertOrReturnChildAt(const Path &path);
private:
// Because of the current implementation (weak_ptr to the parent, extensive use of shared_ptr-s)
// it's safer to prohibit construction on the stack or non-shared heap.
// Otherwise there is a high chance of misuse leading to double free
Node(const Ptr &parent = nullptr, const Path &p = Path()) : m_path(p), m_parent(parent) { }
Node(const Node &o) = default;
std::shared_ptr<OwningItem> doCopy(const DomItem &) const override;
private:
Path m_path;
std::weak_ptr<Node> m_parent;
QMap<Path, Ptr> m_subItems;
FileLocations::Info m_info;
};
} // namespace FileLocations
} // end namespace Dom
} // end namespace QQmlJS
QT_END_NAMESPACE
#endif // QMLDOMFILELOCATIONS_P_H
|
