qqmljslintercodegen_p.h

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
// Qt-Security score:significant
 
#ifndef QQMLJSLINTERCODEGEN_P_H
#define QQMLJSLINTERCODEGEN_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 <QString>
#include <QFile>
#include <QList>
 
#include <variant>
 
#include <private/qduplicatetracker_p.h>
#include <private/qqmlirbuilder_p.h>
#include <private/qqmljscompilepass_p.h>
#include <private/qqmljscompiler_p.h>
#include <private/qqmljscontextproperties_p.h>
#include <private/qqmljsdiagnosticmessage_p.h>
#include <private/qqmljslintertypepropagator_p.h>
#include <private/qqmljslogger_p.h>
#include <private/qqmljsscope_p.h>
#include <private/qqmljstypepropagator_p.h>
#include <private/qqmljstyperesolver_p.h>
#include <private/qqmljsusercontextproperties_p.h>
 
QT_BEGIN_NAMESPACE
 
namespace QQmlSA {
class PassManager;
};
 
struct IdMemberShadow
{
    QString name; // of id and of the member
    QQmlJSScope::ConstPtr idScope;
    QQmlJSScope::ConstPtr memberOwnerScope;
};
bool operator==(const IdMemberShadow &lhs, const IdMemberShadow &rhs);
bool operator!=(const IdMemberShadow &lhs, const IdMemberShadow &rhs);
size_t qHash(const IdMemberShadow &idShadowsMember, size_t seed = 0);
 
class QQmlJSLinterCodegen : public QQmlJSAotCompiler
{
public:
    QQmlJSLinterCodegen(QQmlJSImporter *importer, const QString &fileName,
                        const QStringList &qmldirFiles, QQmlJSLogger *logger,
                        const ContextPropertyInfo &contextPropertyInfo);
 
    void setDocument(const QmlIR::JSCodeGen *codegen, const QmlIR::Document *document) override;
    std::variant<QQmlJSAotFunction, QList<QQmlJS::DiagnosticMessage>>
    compileBinding(const QV4::Compiler::Context *context, const QmlIR::Binding &irBinding,
                   QQmlJS::AST::Node *astNode) override;
    std::variant<QQmlJSAotFunction, QList<QQmlJS::DiagnosticMessage>>
    compileFunction(const QV4::Compiler::Context *context, const QString &name,
                    QQmlJS::AST::Node *astNode) override;
 
    void setTypeResolver(QQmlJSTypeResolver typeResolver)
    {
        m_typeResolver = std::move(typeResolver);
    }
 
    void setScopesById(const QQmlJSScopesById scopesByid)
    {
        m_scopesById = scopesByid;
    }
 
    void setRenamedComponents(const QQmlJS::LinterRenamedComponents *renamedComponents)
    {
        m_renamedComponents = renamedComponents;
    }
 
    void setKnownUnresolvedTypes(QDuplicateTracker<QQmlJSScope::ConstPtr> *tracker)
    {
        m_knownUnresolvedTypes = tracker;
    }
 
    QQmlJSTypeResolver *typeResolver() { return &m_typeResolver; }
 
    void setPassManager(QQmlSA::PassManager *passManager);
 
    QQmlSA::PassManager *passManager() { return m_passManager; }
 
private:
    QQmlSA::PassManager *m_passManager = nullptr;
 
    void analyzeFunction(const QV4::Compiler::Context *context,
                         QQmlJSCompilePass::Function *function);
    ContextPropertyInfo m_contextPropertyInfo;
    QQmlJSScopesById m_scopesById;
    QSet<IdMemberShadow> m_idMemberShadows;
    QDuplicateTracker<QQmlJSScope::ConstPtr> *m_knownUnresolvedTypes = nullptr;
    const QQmlJS::LinterRenamedComponents *m_renamedComponents = nullptr;
};
 
QT_END_NAMESPACE
 
#endif