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
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <QFileInfo>
#include <QStringList>
#include <QtGlobal>
#include "declarativeparser/qdeclarativejsast_p.h"
#include "declarativeparser/qdeclarativejsastfwd_p.h"
#include "declarativeparser/qdeclarativejsengine_p.h"
#include "node.h"
#include "qmlvisitor.h"
QT_BEGIN_NAMESPACE
QmlDocVisitor::QmlDocVisitor(const QString &filePath, const QString &code,
QDeclarativeJS::Engine *engine, Tree *tree, QSet<QString> &commands)
{
this->filePath = filePath;
this->name = QFileInfo(filePath).baseName();
document = code;
this->engine = engine;
this->tree = tree;
this->commands = commands;
current = tree->root();
}
QmlDocVisitor::~QmlDocVisitor()
{
}
QDeclarativeJS::AST::SourceLocation QmlDocVisitor::precedingComment(quint32 offset) const
{
QListIterator<QDeclarativeJS::AST::SourceLocation> it(engine->comments());
it.toBack();
while (it.hasPrevious()) {
QDeclarativeJS::AST::SourceLocation loc = it.previous();
if (loc.begin() <= lastEndOffset)
// Return if we reach the end of the preceding structure.
break;
else if (usedComments.contains(loc.begin()))
// Return if we encounter a previously used comment.
break;
else if (loc.begin() > lastEndOffset && loc.end() < offset) {
// Only examine multiline comments in order to avoid snippet markers.
if (document.mid(loc.offset - 1, 1) == "*") {
QString comment = document.mid(loc.offset, loc.length);
if (comment.startsWith("!") || comment.startsWith("*"))
return loc;
}
}
}
return QDeclarativeJS::AST::SourceLocation();
}
void QmlDocVisitor::applyDocumentation(QDeclarativeJS::AST::SourceLocation location,
Node *node)
{
QDeclarativeJS::AST::SourceLocation loc = precedingComment(location.begin());
if (loc.isValid()) {
QString source = document.mid(loc.offset, loc.length);
Location start(filePath);
start.setLineNo(loc.startLine);
start.setColumnNo(loc.startColumn);
Location finish(filePath);
finish.setLineNo(loc.startLine);
finish.setColumnNo(loc.startColumn);
Doc doc(start, finish, source.mid(1), commands);
node->setDoc(doc);
usedComments.insert(loc.offset);
}
}
/*!
Visits element definitions, recording them in a tree structure.
*/
bool QmlDocVisitor::visit(QDeclarativeJS::AST::UiObjectDefinition *definition)
{
QString type = definition->qualifiedTypeNameId->name->asString();
if (current->type() == Node::Namespace) {
QmlClassNode *component = new QmlClassNode(current, name, 0);
component->setTitle(QLatin1String("QML ") + name + QLatin1String(" Component"));
QmlClassNode::addInheritedBy(type, component);
component->setLink(Node::InheritsLink, type, type);
applyDocumentation(definition->firstSourceLocation(), component);
current = component;
}
return true;
}
void QmlDocVisitor::endVisit(QDeclarativeJS::AST::UiObjectDefinition *definition)
{
lastEndOffset = definition->lastSourceLocation().end();
}
bool QmlDocVisitor::visit(QDeclarativeJS::AST::UiImportList *imports)
{
// Note that the imports list can be traversed by iteration to obtain
// all the imports in the document at once, having found just one:
// *it = imports; it; it = it->next
QString module = document.mid(imports->import->fileNameToken.offset,
imports->import->fileNameToken.length);
QString version = document.mid(imports->import->versionToken.offset,
imports->import->versionToken.length);
importList.append(QPair<QString, QString>(module, version));
return true;
}
void QmlDocVisitor::endVisit(QDeclarativeJS::AST::UiImportList *definition)
{
lastEndOffset = definition->lastSourceLocation().end();
}
/*!
Visits public member declarations, such as signals and properties.
These only include custom signals and properties.
*/
bool QmlDocVisitor::visit(QDeclarativeJS::AST::UiPublicMember *member)
{
switch (member->type) {
case QDeclarativeJS::AST::UiPublicMember::Signal:
{
if (current->type() == Node::Fake) {
QmlClassNode *qmlClass = static_cast<QmlClassNode *>(current);
if (qmlClass) {
QString name = member->name->asString();
FunctionNode *qmlSignal = new FunctionNode(Node::QmlSignal, current, name, false);
QList<Parameter> parameters;
for (QDeclarativeJS::AST::UiParameterList *it = member->parameters; it; it = it->next) {
if (it->type && it->name)
parameters.append(Parameter(it->type->asString(), "", it->name->asString()));
}
qmlSignal->setParameters(parameters);
applyDocumentation(member->firstSourceLocation(), qmlSignal);
}
}
break;
}
case QDeclarativeJS::AST::UiPublicMember::Property:
{
QString type = member->memberType->asString();
QString name = member->name->asString();
if (current->type() == Node::Fake) {
QmlClassNode *qmlClass = static_cast<QmlClassNode *>(current);
if (qmlClass) {
QString name = member->name->asString();
QmlPropGroupNode *qmlPropGroup = new QmlPropGroupNode(qmlClass, name, false);
if (member->isDefaultMember)
qmlPropGroup->setDefault();
QmlPropertyNode *qmlPropNode = new QmlPropertyNode(qmlPropGroup, name, type, false);
qmlPropNode->setWritable(!member->isReadonlyMember);
applyDocumentation(member->firstSourceLocation(), qmlPropGroup);
}
}
break;
}
default:
return false;
}
return true;
}
void QmlDocVisitor::endVisit(QDeclarativeJS::AST::UiPublicMember *definition)
{
lastEndOffset = definition->lastSourceLocation().end();
}
bool QmlDocVisitor::visit(QDeclarativeJS::AST::IdentifierPropertyName *idproperty)
{
return true;
}
QT_END_NAMESPACE
|
