forked from qt-creator/qt-creator
1e587831d1
app.qmltypes is being added as a new convention to Qt 5.15. These files are to be found next to application binaries, and contain the QML types those application register themselves, in contrast to QML types registered from plugins loaded via the regular import mechanism. lib.qmltypes works the same way, in principle, for libraries. This change only adds it to the possible names for qmltypes files, though. Change-Id: I1d7c5835c8c3e988d214c5cdb949ca677b48dfc5 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
279 lines
11 KiB
C++
279 lines
11 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** 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 https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "qmljs_global.h"
|
|
#include "qmljsbundle.h"
|
|
#include "qmljsdocument.h"
|
|
#include "qmljsdialect.h"
|
|
|
|
#include <cplusplus/CppDocument.h>
|
|
#include <utils/environment.h>
|
|
#include <utils/qrcparser.h>
|
|
|
|
#include <QFuture>
|
|
#include <QHash>
|
|
#include <QObject>
|
|
#include <QPointer>
|
|
#include <QStringList>
|
|
|
|
QT_FORWARD_DECLARE_CLASS(QTimer)
|
|
|
|
namespace ProjectExplorer { class Project; }
|
|
|
|
namespace QmlJS {
|
|
|
|
class Snapshot;
|
|
class PluginDumper;
|
|
|
|
class QMLJS_EXPORT ModelManagerInterface : public QObject
|
|
{
|
|
Q_OBJECT
|
|
Q_DISABLE_COPY(ModelManagerInterface)
|
|
|
|
public:
|
|
ModelManagerInterface(ModelManagerInterface &&) = delete;
|
|
ModelManagerInterface &operator=(ModelManagerInterface &&) = delete;
|
|
|
|
enum QrcResourceSelector {
|
|
ActiveQrcResources,
|
|
AllQrcResources
|
|
};
|
|
|
|
struct ProjectInfo
|
|
{
|
|
QPointer<ProjectExplorer::Project> project;
|
|
QStringList sourceFiles;
|
|
PathsAndLanguages importPaths;
|
|
QStringList activeResourceFiles;
|
|
QStringList allResourceFiles;
|
|
QHash<QString, QString> resourceFileContents;
|
|
QStringList applicationDirectories;
|
|
|
|
// whether trying to run qmldump makes sense
|
|
bool tryQmlDump = false;
|
|
bool qmlDumpHasRelocatableFlag = true;
|
|
QString qmlDumpPath;
|
|
::Utils::Environment qmlDumpEnvironment;
|
|
|
|
QString qtQmlPath;
|
|
QString qtVersionString;
|
|
QmlJS::QmlLanguageBundles activeBundle;
|
|
QmlJS::QmlLanguageBundles extendedBundle;
|
|
};
|
|
|
|
class WorkingCopy
|
|
{
|
|
public:
|
|
using Table = QHash<QString, QPair<QString, int>>;
|
|
|
|
void insert(const QString &fileName, const QString &source, int revision = 0)
|
|
{ m_elements.insert(fileName, {source, revision}); }
|
|
|
|
bool contains(const QString &fileName) const
|
|
{ return m_elements.contains(fileName); }
|
|
|
|
QString source(const QString &fileName) const
|
|
{ return m_elements.value(fileName).first; }
|
|
|
|
QPair<QString, int> get(const QString &fileName) const
|
|
{ return m_elements.value(fileName); }
|
|
|
|
Table all() const
|
|
{ return m_elements; }
|
|
|
|
private:
|
|
Table m_elements;
|
|
};
|
|
|
|
struct CppData
|
|
{
|
|
QList<LanguageUtils::FakeMetaObject::ConstPtr> exportedTypes;
|
|
QHash<QString, QString> contextProperties;
|
|
};
|
|
|
|
using CppDataHash = QHash<QString, CppData>;
|
|
|
|
public:
|
|
ModelManagerInterface(QObject *parent = nullptr);
|
|
~ModelManagerInterface() override;
|
|
|
|
static Dialect guessLanguageOfFile(const QString &fileName);
|
|
static QStringList globPatternsForLanguages(const QList<Dialect> &languages);
|
|
static ModelManagerInterface *instance();
|
|
static void writeWarning(const QString &msg);
|
|
static WorkingCopy workingCopy();
|
|
|
|
QmlJS::Snapshot snapshot() const;
|
|
QmlJS::Snapshot newestSnapshot() const;
|
|
|
|
void activateScan();
|
|
void updateSourceFiles(const QStringList &files,
|
|
bool emitDocumentOnDiskChanged);
|
|
void fileChangedOnDisk(const QString &path);
|
|
void removeFiles(const QStringList &files);
|
|
QStringList qrcPathsForFile(const QString &file, const QLocale *locale = nullptr,
|
|
ProjectExplorer::Project *project = nullptr,
|
|
QrcResourceSelector resources = AllQrcResources);
|
|
QStringList filesAtQrcPath(const QString &path, const QLocale *locale = nullptr,
|
|
ProjectExplorer::Project *project = nullptr,
|
|
QrcResourceSelector resources = AllQrcResources);
|
|
QMap<QString, QStringList> filesInQrcPath(const QString &path,
|
|
const QLocale *locale = nullptr,
|
|
ProjectExplorer::Project *project = nullptr,
|
|
bool addDirs = false,
|
|
QrcResourceSelector resources = AllQrcResources);
|
|
|
|
QList<ProjectInfo> projectInfos() const;
|
|
bool containsProject(ProjectExplorer::Project *project) const;
|
|
ProjectInfo projectInfo(ProjectExplorer::Project *project) const;
|
|
void updateProjectInfo(const ProjectInfo &pinfo, ProjectExplorer::Project *p);
|
|
|
|
void updateDocument(const QmlJS::Document::Ptr& doc);
|
|
void updateLibraryInfo(const QString &path, const QmlJS::LibraryInfo &info);
|
|
void emitDocumentChangedOnDisk(QmlJS::Document::Ptr doc);
|
|
void updateQrcFile(const QString &path);
|
|
ProjectInfo projectInfoForPath(const QString &path) const;
|
|
QList<ProjectInfo> allProjectInfosForPath(const QString &path) const;
|
|
bool isIdle() const ;
|
|
|
|
QStringList importPathsNames() const;
|
|
QmlJS::QmlLanguageBundles activeBundles() const;
|
|
QmlJS::QmlLanguageBundles extendedBundles() const;
|
|
|
|
void loadPluginTypes(const QString &libraryPath, const QString &importPath,
|
|
const QString &importUri, const QString &importVersion);
|
|
|
|
CppDataHash cppData() const;
|
|
LibraryInfo builtins(const Document::Ptr &doc) const;
|
|
ViewerContext completeVContext(const ViewerContext &vCtx,
|
|
const Document::Ptr &doc = Document::Ptr(nullptr)) const;
|
|
ViewerContext defaultVContext(Dialect language = Dialect::Qml,
|
|
const Document::Ptr &doc = Document::Ptr(nullptr),
|
|
bool autoComplete = true) const;
|
|
void setDefaultVContext(const ViewerContext &vContext);
|
|
virtual ProjectInfo defaultProjectInfo() const;
|
|
virtual ProjectInfo defaultProjectInfoForProject(ProjectExplorer::Project *project) const;
|
|
|
|
|
|
// Blocks until all parsing threads are done. Used for testing.
|
|
void joinAllThreads();
|
|
|
|
QmlJS::Document::Ptr ensuredGetDocumentForPath(const QString &filePath);
|
|
static void importScan(QFutureInterface<void> &future, const WorkingCopy& workingCopyInternal,
|
|
const PathsAndLanguages& paths, ModelManagerInterface *modelManager,
|
|
bool emitDocChangedOnDisk, bool libOnly = true,
|
|
bool forceRescan = false);
|
|
|
|
virtual void resetCodeModel();
|
|
void removeProjectInfo(ProjectExplorer::Project *project);
|
|
void maybeQueueCppQmlTypeUpdate(const CPlusPlus::Document::Ptr &doc);
|
|
|
|
signals:
|
|
void documentUpdated(QmlJS::Document::Ptr doc);
|
|
void documentChangedOnDisk(QmlJS::Document::Ptr doc);
|
|
void aboutToRemoveFiles(const QStringList &files);
|
|
void libraryInfoUpdated(const QString &path, const QmlJS::LibraryInfo &info);
|
|
void projectInfoUpdated(const ProjectInfo &pinfo);
|
|
void projectPathChanged(const QString &projectPath);
|
|
|
|
protected:
|
|
Q_INVOKABLE void queueCppQmlTypeUpdate(const CPlusPlus::Document::Ptr &doc, bool scan);
|
|
Q_INVOKABLE void asyncReset();
|
|
virtual void startCppQmlTypeUpdate();
|
|
QMutex *mutex() const;
|
|
virtual QHash<QString,Dialect> languageForSuffix() const;
|
|
virtual void writeMessageInternal(const QString &msg) const;
|
|
virtual WorkingCopy workingCopyInternal() const;
|
|
virtual void addTaskInternal(const QFuture<void> &result, const QString &msg,
|
|
const char *taskId) const;
|
|
|
|
QFuture<void> refreshSourceFiles(const QStringList &sourceFiles,
|
|
bool emitDocumentOnDiskChanged);
|
|
|
|
static void parseLoop(QSet<QString> &scannedPaths, QSet<QString> &newLibraries,
|
|
const WorkingCopy &workingCopyInternal, QStringList files,
|
|
ModelManagerInterface *modelManager,
|
|
QmlJS::Dialect mainLanguage, bool emitDocChangedOnDisk,
|
|
const std::function<bool(qreal)> &reportProgress);
|
|
static void parse(QFutureInterface<void> &future,
|
|
const WorkingCopy &workingCopyInternal,
|
|
QStringList files,
|
|
ModelManagerInterface *modelManager,
|
|
QmlJS::Dialect mainLanguage,
|
|
bool emitDocChangedOnDisk);
|
|
static void updateCppQmlTypes(
|
|
QFutureInterface<void> &futureInterface, ModelManagerInterface *qmlModelManager,
|
|
const CPlusPlus::Snapshot &snapshot,
|
|
const QHash<QString, QPair<CPlusPlus::Document::Ptr, bool>> &documents);
|
|
|
|
void maybeScan(const PathsAndLanguages &importPaths);
|
|
void updateImportPaths();
|
|
void loadQmlTypeDescriptionsInternal(const QString &path);
|
|
void setDefaultProject(const ProjectInfo &pInfo, ProjectExplorer::Project *p);
|
|
|
|
private:
|
|
void cleanupFutures();
|
|
void iterateQrcFiles(ProjectExplorer::Project *project,
|
|
QrcResourceSelector resources,
|
|
const std::function<void(Utils::QrcParser::ConstPtr)> &callback);
|
|
|
|
mutable QMutex m_mutex;
|
|
QmlJS::Snapshot m_validSnapshot;
|
|
QmlJS::Snapshot m_newestSnapshot;
|
|
PathsAndLanguages m_allImportPaths;
|
|
QStringList m_defaultImportPaths;
|
|
QmlJS::QmlLanguageBundles m_activeBundles;
|
|
QmlJS::QmlLanguageBundles m_extendedBundles;
|
|
QHash<Dialect, QmlJS::ViewerContext> m_defaultVContexts;
|
|
bool m_shouldScanImports = false;
|
|
QSet<QString> m_scannedPaths;
|
|
|
|
QTimer *m_updateCppQmlTypesTimer = nullptr;
|
|
QTimer *m_asyncResetTimer = nullptr;
|
|
QHash<QString, QPair<CPlusPlus::Document::Ptr, bool>> m_queuedCppDocuments;
|
|
QFuture<void> m_cppQmlTypesUpdater;
|
|
Utils::QrcCache m_qrcCache;
|
|
QHash<QString, QString> m_qrcContents;
|
|
|
|
CppDataHash m_cppDataHash;
|
|
QHash<QString, QList<CPlusPlus::Document::Ptr>> m_cppDeclarationFiles;
|
|
mutable QMutex m_cppDataMutex;
|
|
|
|
// project integration
|
|
QMap<ProjectExplorer::Project *, ProjectInfo> m_projects;
|
|
ProjectInfo m_defaultProjectInfo;
|
|
ProjectExplorer::Project *m_defaultProject = nullptr;
|
|
QMultiHash<QString, ProjectExplorer::Project *> m_fileToProject;
|
|
|
|
PluginDumper *m_pluginDumper = nullptr;
|
|
|
|
QList<QFuture<void>> m_futures;
|
|
bool m_indexerDisabled = false;
|
|
};
|
|
|
|
} // namespace QmlJS
|