diff options
author | Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> | 2015-10-21 15:51:54 +0200 |
---|---|---|
committer | Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> | 2015-10-23 10:47:25 +0000 |
commit | e15ca59111fe05f5ecc0f7fb48c34b5b22115a12 (patch) | |
tree | 1f66c3191f4745dea9bf126b8c22a4d8c5a90c58 /src/qdoc/qmlvisitor.h | |
parent | 4e2d1893a89ce3dcfaacea091acae1f673c14a9e (diff) |
move qdoc back to qttools
we can do that now, as the bootstrap lib is now a properly exported
module, and qmldevtools is now bootstrapped as well.
this removes the abomination of a copy of the qml parser in qtbase.
unfortunately qtbase/2422251ee5025a067b14b989153764ab36e43f10 is
reverted, as qtdeclarative is still missing the respective change.
this introduces no regression in discoverability or usability, as a full
doc build already needed qttools - for qhelpgenerator.
Change-Id: Ic9c4c9732ddf5998637b9e42e27939ba50b31479
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'src/qdoc/qmlvisitor.h')
-rw-r--r-- | src/qdoc/qmlvisitor.h | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/src/qdoc/qmlvisitor.h b/src/qdoc/qmlvisitor.h new file mode 100644 index 000000000..8a23eef75 --- /dev/null +++ b/src/qdoc/qmlvisitor.h @@ -0,0 +1,121 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QMLVISITOR_H +#define QMLVISITOR_H + +#include "node.h" + +#include <qstring.h> +#include <private/qqmljsastvisitor_p.h> +#include <private/qqmljsengine_p.h> + +QT_BEGIN_NAMESPACE + +struct QmlPropArgs +{ + QString type_; + QString module_; + QString component_; + QString name_; + + void clear() { + type_.clear(); + module_.clear(); + component_.clear(); + name_.clear(); + } +}; + +class QmlDocVisitor : public QQmlJS::AST::Visitor +{ + Q_DECLARE_TR_FUNCTIONS(QDoc::QmlDocVisitor) + +public: + QmlDocVisitor(const QString &filePath, + const QString &code, + QQmlJS::Engine *engine, + const QSet<QString> &commands, + const QSet<QString> &topics); + virtual ~QmlDocVisitor(); + + bool visit(QQmlJS::AST::UiImport *import) Q_DECL_OVERRIDE; + void endVisit(QQmlJS::AST::UiImport *definition) Q_DECL_OVERRIDE; + + bool visit(QQmlJS::AST::UiObjectDefinition *definition) Q_DECL_OVERRIDE; + void endVisit(QQmlJS::AST::UiObjectDefinition *definition) Q_DECL_OVERRIDE; + + bool visit(QQmlJS::AST::UiPublicMember *member) Q_DECL_OVERRIDE; + void endVisit(QQmlJS::AST::UiPublicMember *definition) Q_DECL_OVERRIDE; + + virtual bool visit(QQmlJS::AST::UiObjectBinding *) Q_DECL_OVERRIDE; + virtual void endVisit(QQmlJS::AST::UiObjectBinding *) Q_DECL_OVERRIDE; + virtual void endVisit(QQmlJS::AST::UiArrayBinding *) Q_DECL_OVERRIDE; + virtual bool visit(QQmlJS::AST::UiArrayBinding *) Q_DECL_OVERRIDE; + + bool visit(QQmlJS::AST::IdentifierPropertyName *idproperty) Q_DECL_OVERRIDE; + + bool visit(QQmlJS::AST::FunctionDeclaration *) Q_DECL_OVERRIDE; + void endVisit(QQmlJS::AST::FunctionDeclaration *) Q_DECL_OVERRIDE; + + bool visit(QQmlJS::AST::UiScriptBinding *) Q_DECL_OVERRIDE; + void endVisit(QQmlJS::AST::UiScriptBinding *) Q_DECL_OVERRIDE; + + bool visit(QQmlJS::AST::UiQualifiedId *) Q_DECL_OVERRIDE; + void endVisit(QQmlJS::AST::UiQualifiedId *) Q_DECL_OVERRIDE; + +private: + QString getFullyQualifiedId(QQmlJS::AST::UiQualifiedId *id); + QQmlJS::AST::SourceLocation precedingComment(quint32 offset) const; + bool applyDocumentation(QQmlJS::AST::SourceLocation location, Node *node); + void applyMetacommands(QQmlJS::AST::SourceLocation location, Node* node, Doc& doc); + bool splitQmlPropertyArg(const Doc& doc, + const QString& arg, + QmlPropArgs& qpa); + + QQmlJS::Engine *engine; + quint32 lastEndOffset; + quint32 nestingLevel; + QString filePath_; + QString name; + QString document; + ImportList importList; + QSet<QString> commands_; + QSet<QString> topics_; + QSet<quint32> usedComments; + Aggregate *current; +}; + +QT_END_NAMESPACE + +#endif |