/**************************************************************************** ** ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** 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 Digia. For licensing terms and ** conditions see http://www.qt.io/licensing. 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. ** ** In addition, as a special exception, Digia gives you certain additional ** rights. These rights are described in the Digia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ****************************************************************************/ #include "qmljsbind.h" #include "qmljsconstants.h" #include "qmljsfindexportedcpptypes.h" #include "qmljsinterpreter.h" #include "qmljsmodelmanagerinterface.h" #include "qmljsplugindumper.h" #include "qmljstypedescriptionreader.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace QmlJS { QMLJS_EXPORT Q_LOGGING_CATEGORY(qmljsLog, "qtc.qmljs.common") /*! \class QmlJS::ModelManagerInterface \brief The ModelManagerInterface class acts as an interface to the global state of the QmlJS code model. \sa QmlJS::Document QmlJS::Snapshot QmlJSTools::Internal::ModelManager The ModelManagerInterface is an interface for global state and actions in the QmlJS code model. It is implemented by \l{QmlJSTools::Internal::ModelManager} and the instance can be accessed through ModelManagerInterface::instance(). One of its primary concerns is to keep the Snapshots it maintains up to date by parsing documents and finding QML modules. It has a Snapshot that contains only valid Documents, accessible through ModelManagerInterface::snapshot() and a Snapshot with potentially more recent, but invalid documents that is exposed through ModelManagerInterface::newestSnapshot(). */ static ModelManagerInterface *g_instance = 0; static QStringList environmentImportPaths() { QStringList paths; QByteArray envImportPath = qgetenv("QML_IMPORT_PATH"); foreach (const QString &path, QString::fromLatin1(envImportPath) .split(Utils::HostOsInfo::pathListSeparator(), QString::SkipEmptyParts)) { QString canonicalPath = QDir(path).canonicalPath(); if (!canonicalPath.isEmpty() && !paths.contains(canonicalPath)) paths.append(canonicalPath); } return paths; } ModelManagerInterface::ModelManagerInterface(QObject *parent) : QObject(parent), m_shouldScanImports(false), m_defaultProject(0), m_pluginDumper(new PluginDumper(this)) { m_synchronizer.setCancelOnWait(true); m_updateCppQmlTypesTimer = new QTimer(this); m_updateCppQmlTypesTimer->setInterval(1000); m_updateCppQmlTypesTimer->setSingleShot(true); connect(m_updateCppQmlTypesTimer, SIGNAL(timeout()), SLOT(startCppQmlTypeUpdate())); m_asyncResetTimer = new QTimer(this); m_asyncResetTimer->setInterval(15000); m_asyncResetTimer->setSingleShot(true); connect(m_asyncResetTimer, SIGNAL(timeout()), SLOT(resetCodeModel())); qRegisterMetaType("QmlJS::Document::Ptr"); qRegisterMetaType("QmlJS::LibraryInfo"); m_defaultProjectInfo.qtImportsPath = QFileInfo( QLibraryInfo::location(QLibraryInfo::ImportsPath)).canonicalFilePath(); #if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)) m_defaultProjectInfo.qtQmlPath = QFileInfo( QLibraryInfo::location(QLibraryInfo::Qml2ImportsPath)).canonicalFilePath(); #endif m_defaultImportPaths << environmentImportPaths(); updateImportPaths(); Q_ASSERT(! g_instance); g_instance = this; } ModelManagerInterface::~ModelManagerInterface() { m_cppQmlTypesUpdater.cancel(); m_cppQmlTypesUpdater.waitForFinished(); Q_ASSERT(g_instance == this); g_instance = 0; } static QHash defaultLanguageMapping() { QHash res; res[QLatin1String("js")] = Language::JavaScript; res[QLatin1String("qml")] = Language::Qml; res[QLatin1String("qmltypes")] = Language::QmlTypeInfo; res[QLatin1String("qmlproject")] = Language::QmlProject; res[QLatin1String("json")] = Language::Json; res[QLatin1String("qbs")] = Language::QmlQbs; return res; } Language::Enum ModelManagerInterface::guessLanguageOfFile(const QString &fileName) { QHash lMapping; if (instance()) lMapping = instance()->languageForSuffix(); else lMapping = defaultLanguageMapping(); const QFileInfo info(fileName); const QString fileSuffix = info.suffix(); return lMapping.value(fileSuffix, Language::NoLanguage); } QStringList ModelManagerInterface::globPatternsForLanguages(const QList languages) { QHash lMapping; if (instance()) lMapping = instance()->languageForSuffix(); else lMapping = defaultLanguageMapping(); QStringList patterns; QHashIterator i(lMapping); while (i.hasNext()) { i.next(); if (languages.contains(i.value())) patterns << QLatin1String("*.") + i.key(); } return patterns; } ModelManagerInterface *ModelManagerInterface::instance() { return g_instance; } void ModelManagerInterface::writeWarning(const QString &msg) { if (ModelManagerInterface *i = instance()) i->writeMessageInternal(msg); else qCWarning(qmljsLog) << msg; } ModelManagerInterface::WorkingCopy ModelManagerInterface::workingCopy() { if (ModelManagerInterface *i = instance()) return i->workingCopyInternal(); return WorkingCopy(); } void ModelManagerInterface::activateScan() { if (!m_shouldScanImports) { m_shouldScanImports = true; updateImportPaths(); } } QHash ModelManagerInterface::languageForSuffix() const { return defaultLanguageMapping(); } void ModelManagerInterface::writeMessageInternal(const QString &msg) const { qCDebug(qmljsLog) << msg; } ModelManagerInterface::WorkingCopy ModelManagerInterface::workingCopyInternal() const { ModelManagerInterface::WorkingCopy res; return res; } void ModelManagerInterface::addTaskInternal(QFuture result, const QString &msg, const char *taskId) const { Q_UNUSED(result); qCDebug(qmljsLog) << "started " << taskId << " " << msg; } void ModelManagerInterface::loadQmlTypeDescriptionsInternal(const QString &resourcePath) { const QDir typeFileDir(resourcePath + QLatin1String("/qml-type-descriptions")); const QStringList qmlTypesExtensions = QStringList() << QLatin1String("*.qmltypes"); QFileInfoList qmlTypesFiles = typeFileDir.entryInfoList( qmlTypesExtensions, QDir::Files, QDir::Name); QStringList errors; QStringList warnings; // filter out the actual Qt builtins for (int i = 0; i < qmlTypesFiles.size(); ++i) { if (qmlTypesFiles.at(i).baseName() == QLatin1String("builtins")) { QFileInfoList list; list.append(qmlTypesFiles.at(i)); CppQmlTypesLoader::defaultQtObjects = CppQmlTypesLoader::loadQmlTypes(list, &errors, &warnings); qmlTypesFiles.removeAt(i); break; } } // load the fallbacks for libraries CppQmlTypesLoader::defaultLibraryObjects.unite( CppQmlTypesLoader::loadQmlTypes(qmlTypesFiles, &errors, &warnings)); foreach (const QString &error, errors) writeMessageInternal(error); foreach (const QString &warning, warnings) writeMessageInternal(warning); } void ModelManagerInterface::setDefaultProject(const ModelManagerInterface::ProjectInfo &pInfo, ProjectExplorer::Project *p) { QMutexLocker l(mutex()); m_defaultProject = p; m_defaultProjectInfo = pInfo; } Snapshot ModelManagerInterface::snapshot() const { QMutexLocker locker(&m_mutex); return m_validSnapshot; } Snapshot ModelManagerInterface::newestSnapshot() const { QMutexLocker locker(&m_mutex); return m_newestSnapshot; } void ModelManagerInterface::updateSourceFiles(const QStringList &files, bool emitDocumentOnDiskChanged) { refreshSourceFiles(files, emitDocumentOnDiskChanged); } QFuture ModelManagerInterface::refreshSourceFiles(const QStringList &sourceFiles, bool emitDocumentOnDiskChanged) { if (sourceFiles.isEmpty()) return QFuture(); QFuture result = QtConcurrent::run(&ModelManagerInterface::parse, workingCopyInternal(), sourceFiles, this, Language::Qml, emitDocumentOnDiskChanged); if (m_synchronizer.futures().size() > 10) { QList > futures = m_synchronizer.futures(); m_synchronizer.clearFutures(); foreach (const QFuture &future, futures) { if (! (future.isFinished() || future.isCanceled())) m_synchronizer.addFuture(future); } } m_synchronizer.addFuture(result); if (sourceFiles.count() > 1) addTaskInternal(result, tr("Parsing QML Files"), Constants::TASK_INDEX); if (sourceFiles.count() > 1 && !m_shouldScanImports) { bool scan = false; { QMutexLocker l(&m_mutex); if (!m_shouldScanImports) { m_shouldScanImports = true; scan = true; } } if (scan) updateImportPaths(); } return result; } void ModelManagerInterface::fileChangedOnDisk(const QString &path) { QtConcurrent::run(&ModelManagerInterface::parse, workingCopyInternal(), QStringList() << path, this, Language::AnyLanguage, true); } void ModelManagerInterface::removeFiles(const QStringList &files) { emit aboutToRemoveFiles(files); QMutexLocker locker(&m_mutex); foreach (const QString &file, files) { m_validSnapshot.remove(file); m_newestSnapshot.remove(file); } } namespace { bool pInfoLessThanActive(const ModelManagerInterface::ProjectInfo &p1, const ModelManagerInterface::ProjectInfo &p2) { QStringList s1 = p1.activeResourceFiles; QStringList s2 = p2.activeResourceFiles; if (s1.size() < s2.size()) return true; if (s1.size() > s2.size()) return false; for (int i = 0; i < s1.size(); ++i) { if (s1.at(i) < s2.at(i)) return true; else if (s1.at(i) > s2.at(i)) return false; } return false; } bool pInfoLessThanAll(const ModelManagerInterface::ProjectInfo &p1, const ModelManagerInterface::ProjectInfo &p2) { QStringList s1 = p1.allResourceFiles; QStringList s2 = p2.allResourceFiles; if (s1.size() < s2.size()) return true; if (s1.size() > s2.size()) return false; for (int i = 0; i < s1.size(); ++i) { if (s1.at(i) < s2.at(i)) return true; else if (s1.at(i) > s2.at(i)) return false; } return false; } bool pInfoLessThanImports(const ModelManagerInterface::ProjectInfo &p1, const ModelManagerInterface::ProjectInfo &p2) { if (p1.qtQmlPath < p2.qtQmlPath) return true; if (p1.qtQmlPath > p2.qtQmlPath) return false; if (p1.qtImportsPath < p2.qtImportsPath) return true; if (p1.qtImportsPath > p2.qtImportsPath) return false; QStringList s1 = p1.importPaths; QStringList s2 = p2.importPaths; if (s1.size() < s2.size()) return true; if (s1.size() > s2.size()) return false; for (int i = 0; i < s1.size(); ++i) { if (s1.at(i) < s2.at(i)) return true; else if (s1.at(i) > s2.at(i)) return false; } return false; } } QStringList ModelManagerInterface::filesAtQrcPath(const QString &path, const QLocale *locale, ProjectExplorer::Project *project, QrcResourceSelector resources) { QString normPath = QrcParser::normalizedQrcFilePath(path); QList pInfos; if (project) pInfos.append(projectInfo(project)); else pInfos = projectInfos(); QStringList res; QSet pathsChecked; foreach (const ModelManagerInterface::ProjectInfo &pInfo, pInfos) { QStringList qrcFilePaths; if (resources == ActiveQrcResources) qrcFilePaths = pInfo.activeResourceFiles; else qrcFilePaths = pInfo.allResourceFiles; foreach (const QString &qrcFilePath, qrcFilePaths) { if (pathsChecked.contains(qrcFilePath)) continue; pathsChecked.insert(qrcFilePath); QrcParser::ConstPtr qrcFile = m_qrcCache.parsedPath(qrcFilePath); if (qrcFile.isNull()) continue; qrcFile->collectFilesAtPath(normPath, &res, locale); } } res.sort(); // make the result predictable return res; } QMap ModelManagerInterface::filesInQrcPath(const QString &path, const QLocale *locale, ProjectExplorer::Project *project, bool addDirs, QrcResourceSelector resources) { QString normPath = QrcParser::normalizedQrcDirectoryPath(path); QList pInfos; if (project) { pInfos.append(projectInfo(project)); } else { pInfos = projectInfos(); if (resources == ActiveQrcResources) // make the result predictable qSort(pInfos.begin(), pInfos.end(), &pInfoLessThanActive); else qSort(pInfos.begin(), pInfos.end(), &pInfoLessThanAll); } QMap res; QSet pathsChecked; foreach (const ModelManagerInterface::ProjectInfo &pInfo, pInfos) { QStringList qrcFilePaths; if (resources == ActiveQrcResources) qrcFilePaths = pInfo.activeResourceFiles; else qrcFilePaths = pInfo.allResourceFiles; foreach (const QString &qrcFilePath, qrcFilePaths) { if (pathsChecked.contains(qrcFilePath)) continue; pathsChecked.insert(qrcFilePath); QrcParser::ConstPtr qrcFile = m_qrcCache.parsedPath(qrcFilePath); if (qrcFile.isNull()) continue; qrcFile->collectFilesInPath(normPath, &res, addDirs, locale); } } return res; } QList ModelManagerInterface::projectInfos() const { QMutexLocker locker(&m_mutex); return m_projects.values(); } ModelManagerInterface::ProjectInfo ModelManagerInterface::projectInfo( ProjectExplorer::Project *project, const ModelManagerInterface::ProjectInfo &defaultValue) const { QMutexLocker locker(&m_mutex); return m_projects.value(project, defaultValue); } void ModelManagerInterface::updateProjectInfo(const ProjectInfo &pinfo, ProjectExplorer::Project *p) { if (! pinfo.isValid() || !p) return; Snapshot snapshot; ProjectInfo oldInfo; { QMutexLocker locker(&m_mutex); oldInfo = m_projects.value(p); m_projects.insert(p, pinfo); if (p == m_defaultProject) m_defaultProjectInfo = pinfo; snapshot = m_validSnapshot; } if (oldInfo.qmlDumpPath != pinfo.qmlDumpPath || oldInfo.qmlDumpEnvironment != pinfo.qmlDumpEnvironment) { m_pluginDumper->scheduleRedumpPlugins(); m_pluginDumper->scheduleMaybeRedumpBuiltins(pinfo); } updateImportPaths(); // remove files that are no longer in the project and have been deleted QStringList deletedFiles; foreach (const QString &oldFile, oldInfo.sourceFiles) { if (snapshot.document(oldFile) && !pinfo.sourceFiles.contains(oldFile) && !QFile::exists(oldFile)) { deletedFiles += oldFile; } } removeFiles(deletedFiles); foreach (const QString &oldFile, deletedFiles) m_fileToProject.remove(oldFile, p); // parse any files not yet in the snapshot QStringList newFiles; foreach (const QString &file, pinfo.sourceFiles) { if (!snapshot.document(file)) newFiles += file; } updateSourceFiles(newFiles, false); foreach (const QString &newFile, deletedFiles) m_fileToProject.insert(newFile, p); // update qrc cache foreach (const QString &newQrc, pinfo.allResourceFiles) m_qrcCache.addPath(newQrc); foreach (const QString &oldQrc, oldInfo.allResourceFiles) m_qrcCache.removePath(oldQrc); int majorVersion, minorVersion, patchVersion; // dump builtin types if the shipped definitions are probably outdated and the // Qt version ships qmlplugindump if (::sscanf(pinfo.qtVersionString.toLatin1().constData(), "%d.%d.%d", &majorVersion, &minorVersion, &patchVersion) != 3) majorVersion = minorVersion = patchVersion = -1; if (majorVersion > 4 || (majorVersion == 4 && (minorVersion > 8 || (majorVersion == 8 && patchVersion >= 5)))) { m_pluginDumper->loadBuiltinTypes(pinfo); } emit projectInfoUpdated(pinfo); } void ModelManagerInterface::removeProjectInfo(ProjectExplorer::Project *project) { ProjectInfo info; info.sourceFiles.clear(); // update with an empty project info to clear data updateProjectInfo(info, project); { QMutexLocker locker(&m_mutex); m_projects.remove(project); } } ModelManagerInterface::ProjectInfo ModelManagerInterface::projectInfoForPath(QString path) const { QList projects; { QMutexLocker locker(&m_mutex); projects = m_fileToProject.values(path); } QList infos; foreach (ProjectExplorer::Project *project, projects) { ProjectInfo info = projectInfo(project); if (info.isValid()) infos.append(info); } std::sort(infos.begin(), infos.end(), &pInfoLessThanImports); ProjectInfo res; foreach (const ProjectInfo &pInfo, infos) { if (res.qtImportsPath.isEmpty()) res.qtImportsPath = pInfo.qtImportsPath; if (res.qtQmlPath.isEmpty()) res.qtQmlPath = pInfo.qtQmlPath; foreach (const QString &path, pInfo.importPaths) if (!res.importPaths.contains(path)) res.importPaths.append(path); } return res; } void ModelManagerInterface::emitDocumentChangedOnDisk(Document::Ptr doc) { emit documentChangedOnDisk(doc); } void ModelManagerInterface::updateQrcFile(const QString &path) { m_qrcCache.updatePath(path); } void ModelManagerInterface::updateDocument(Document::Ptr doc) { { QMutexLocker locker(&m_mutex); m_validSnapshot.insert(doc); m_newestSnapshot.insert(doc, true); } emit documentUpdated(doc); } void ModelManagerInterface::updateLibraryInfo(const QString &path, const LibraryInfo &info) { if (!info.pluginTypeInfoError().isEmpty()) qCDebug(qmljsLog) << "Dumping errors for " << path << ":" << info.pluginTypeInfoError(); { QMutexLocker locker(&m_mutex); m_validSnapshot.insertLibraryInfo(path, info); m_newestSnapshot.insertLibraryInfo(path, info); } // only emit if we got new useful information if (info.isValid()) emit libraryInfoUpdated(path, info); } static QStringList filesInDirectoryForLanguages(const QString &path, QList languages) { const QStringList pattern = ModelManagerInterface::globPatternsForLanguages(languages); QStringList files; const QDir dir(path); foreach (const QFileInfo &fi, dir.entryInfoList(pattern, QDir::Files)) files += fi.absoluteFilePath(); return files; } static void findNewImplicitImports(const Document::Ptr &doc, const Snapshot &snapshot, QStringList *importedFiles, QSet *scannedPaths) { // scan files that could be implicitly imported // it's important we also do this for JS files, otherwise the isEmpty check will fail if (snapshot.documentsInDirectory(doc->path()).isEmpty()) { if (! scannedPaths->contains(doc->path())) { *importedFiles += filesInDirectoryForLanguages(doc->path(), Document::companionLanguages(doc->language())); scannedPaths->insert(doc->path()); } } } static void findNewFileImports(const Document::Ptr &doc, const Snapshot &snapshot, QStringList *importedFiles, QSet *scannedPaths) { // scan files and directories that are explicitly imported foreach (const ImportInfo &import, doc->bind()->imports()) { const QString &importName = import.path(); if (import.type() == ImportType::File) { if (! snapshot.document(importName)) *importedFiles += importName; } else if (import.type() == ImportType::Directory) { if (snapshot.documentsInDirectory(importName).isEmpty()) { if (! scannedPaths->contains(importName)) { *importedFiles += filesInDirectoryForLanguages(importName, Document::companionLanguages(doc->language())); scannedPaths->insert(importName); } } } else if (import.type() == ImportType::QrcFile) { QStringList importPaths = ModelManagerInterface::instance()->filesAtQrcPath(importName); foreach (const QString &importPath, importPaths) { if (! snapshot.document(importPath)) *importedFiles += importPath; } } else if (import.type() == ImportType::QrcDirectory) { QMapIterator dirContents(ModelManagerInterface::instance()->filesInQrcPath(importName)); while (dirContents.hasNext()) { dirContents.next(); if (Document::isQmlLikeOrJsLanguage(ModelManagerInterface::guessLanguageOfFile(dirContents.key()))) { foreach (const QString &filePath, dirContents.value()) { if (! snapshot.document(filePath)) *importedFiles += filePath; } } } } } } static bool findNewQmlLibraryInPath(const QString &path, const Snapshot &snapshot, ModelManagerInterface *modelManager, QStringList *importedFiles, QSet *scannedPaths, QSet *newLibraries, bool ignoreMissing) { // if we know there is a library, done const LibraryInfo &existingInfo = snapshot.libraryInfo(path); if (existingInfo.isValid()) return true; if (newLibraries->contains(path)) return true; // if we looked at the path before, done if (existingInfo.wasScanned()) return false; const QDir dir(path); QFile qmldirFile(dir.filePath(QLatin1String("qmldir"))); if (!qmldirFile.exists()) { if (!ignoreMissing) { LibraryInfo libraryInfo(LibraryInfo::NotFound); modelManager->updateLibraryInfo(path, libraryInfo); } return false; } if (Utils::HostOsInfo::isWindowsHost()) { // QTCREATORBUG-3402 - be case sensitive even here? } // found a new library! qmldirFile.open(QFile::ReadOnly); QString qmldirData = QString::fromUtf8(qmldirFile.readAll()); QmlDirParser qmldirParser; qmldirParser.parse(qmldirData); const QString libraryPath = QFileInfo(qmldirFile).absolutePath(); newLibraries->insert(libraryPath); modelManager->updateLibraryInfo(libraryPath, LibraryInfo(qmldirParser)); modelManager->loadPluginTypes(QFileInfo(libraryPath).canonicalFilePath(), libraryPath, QString(), QString()); // scan the qml files in the library foreach (const QmlDirParser::Component &component, qmldirParser.components()) { if (! component.fileName.isEmpty()) { const QFileInfo componentFileInfo(dir.filePath(component.fileName)); const QString path = QDir::cleanPath(componentFileInfo.absolutePath()); if (! scannedPaths->contains(path)) { *importedFiles += filesInDirectoryForLanguages(path, Document::companionLanguages(Language::AnyLanguage)); scannedPaths->insert(path); } } } return true; } static void findNewQmlLibrary( const QString &path, const LanguageUtils::ComponentVersion &version, const Snapshot &snapshot, ModelManagerInterface *modelManager, QStringList *importedFiles, QSet *scannedPaths, QSet *newLibraries) { QString libraryPath = QString::fromLatin1("%1.%2.%3").arg( path, QString::number(version.majorVersion()), QString::number(version.minorVersion())); findNewQmlLibraryInPath( libraryPath, snapshot, modelManager, importedFiles, scannedPaths, newLibraries, false); libraryPath = QString::fromLatin1("%1.%2").arg( path, QString::number(version.majorVersion())); findNewQmlLibraryInPath( libraryPath, snapshot, modelManager, importedFiles, scannedPaths, newLibraries, false); findNewQmlLibraryInPath( path, snapshot, modelManager, importedFiles, scannedPaths, newLibraries, false); } static void findNewLibraryImports(const Document::Ptr &doc, const Snapshot &snapshot, ModelManagerInterface *modelManager, QStringList *importedFiles, QSet *scannedPaths, QSet *newLibraries) { // scan current dir findNewQmlLibraryInPath(doc->path(), snapshot, modelManager, importedFiles, scannedPaths, newLibraries, false); // scan dir and lib imports const QStringList importPaths = modelManager->importPaths(); foreach (const ImportInfo &import, doc->bind()->imports()) { if (import.type() == ImportType::Directory) { const QString targetPath = import.path(); findNewQmlLibraryInPath(targetPath, snapshot, modelManager, importedFiles, scannedPaths, newLibraries, false); } if (import.type() == ImportType::Library) { if (!import.version().isValid()) continue; foreach (const QString &importPath, importPaths) { const QString targetPath = QDir(importPath).filePath(import.path()); findNewQmlLibrary(targetPath, import.version(), snapshot, modelManager, importedFiles, scannedPaths, newLibraries); } } } } void ModelManagerInterface::parseLoop(QSet &scannedPaths, QSet &newLibraries, WorkingCopy workingCopy, QStringList files, ModelManagerInterface *modelManager, Language::Enum mainLanguage, bool emitDocChangedOnDisk, std::function reportProgress) { for (int i = 0; i < files.size(); ++i) { if (!reportProgress(qreal(i) / files.size())) return; const QString fileName = files.at(i); Language::Enum language = guessLanguageOfFile(fileName); if (language == Language::NoLanguage) { if (fileName.endsWith(QLatin1String(".qrc"))) modelManager->updateQrcFile(fileName); continue; } if (language == Language::Qml && (mainLanguage == Language::QmlQtQuick1 || mainLanguage == Language::QmlQtQuick2)) language = mainLanguage; QString contents; int documentRevision = 0; if (workingCopy.contains(fileName)) { QPair entry = workingCopy.get(fileName); contents = entry.first; documentRevision = entry.second; } else { QFile inFile(fileName); if (inFile.open(QIODevice::ReadOnly)) { QTextStream ins(&inFile); contents = ins.readAll(); inFile.close(); } } Document::MutablePtr doc = Document::create(fileName, language); doc->setEditorRevision(documentRevision); doc->setSource(contents); doc->parse(); // update snapshot. requires synchronization, but significantly reduces amount of file // system queries for library imports because queries are cached in libraryInfo const Snapshot snapshot = modelManager->snapshot(); // get list of referenced files not yet in snapshot or in directories already scanned QStringList importedFiles; findNewImplicitImports(doc, snapshot, &importedFiles, &scannedPaths); findNewFileImports(doc, snapshot, &importedFiles, &scannedPaths); findNewLibraryImports(doc, snapshot, modelManager, &importedFiles, &scannedPaths, &newLibraries); // add new files to parse list foreach (const QString &file, importedFiles) { if (! files.contains(file)) files.append(file); } modelManager->updateDocument(doc); if (emitDocChangedOnDisk) modelManager->emitDocumentChangedOnDisk(doc); } } class FutureReporter { public: FutureReporter(QFutureInterface &future, int multiplier = 100, int base = 0) :future(future), multiplier(multiplier), base(base) { } bool operator()(qreal val) { if (future.isCanceled()) return false; future.setProgressValue(int(base + multiplier * val)); return true; } private: QFutureInterface &future; int multiplier; int base; }; void ModelManagerInterface::parse(QFutureInterface &future, WorkingCopy workingCopy, QStringList files, ModelManagerInterface *modelManager, Language::Enum mainLanguage, bool emitDocChangedOnDisk) { FutureReporter reporter(future); future.setProgressRange(0, 100); // paths we have scanned for files and added to the files list QSet scannedPaths; // libraries we've found while scanning imports QSet newLibraries; parseLoop(scannedPaths, newLibraries, workingCopy, files, modelManager, mainLanguage, emitDocChangedOnDisk, reporter); future.setProgressValue(100); } struct ScanItem { QString path; int depth; ScanItem(QString path = QString(), int depth = 0) : path(path), depth(depth) { } }; void ModelManagerInterface::importScan(QFutureInterface &future, ModelManagerInterface::WorkingCopy workingCopy, QStringList paths, ModelManagerInterface *modelManager, Language::Enum language, bool emitDocChangedOnDisk) { // paths we have scanned for files and added to the files list QSet scannedPaths = modelManager->m_scannedPaths; // libraries we've found while scanning imports QSet newLibraries; QVector pathsToScan; pathsToScan.reserve(paths.size()); { QMutexLocker l(&modelManager->m_mutex); foreach (const QString &path, paths) { QString cPath = QDir::cleanPath(path); if (modelManager->m_scannedPaths.contains(cPath)) continue; pathsToScan.append(ScanItem(cPath)); modelManager->m_scannedPaths.insert(cPath); } } const int maxScanDepth = 5; int progressRange = pathsToScan.size() * (1 << (2 + maxScanDepth)); int totalWork(progressRange), workDone(0); future.setProgressRange(0, progressRange); // update max length while iterating? const bool libOnly = true; // FIXME remove when tested more const Snapshot snapshot = modelManager->snapshot(); while (!pathsToScan.isEmpty() && !future.isCanceled()) { ScanItem toScan = pathsToScan.last(); pathsToScan.pop_back(); int pathBudget = (1 << (maxScanDepth + 2 - toScan.depth)); if (!scannedPaths.contains(toScan.path)) { QStringList importedFiles; if (!findNewQmlLibraryInPath(toScan.path, snapshot, modelManager, &importedFiles, &scannedPaths, &newLibraries, true) && !libOnly && snapshot.documentsInDirectory(toScan.path).isEmpty()) importedFiles += filesInDirectoryForLanguages(toScan.path, Document::companionLanguages(language)); workDone += 1; future.setProgressValue(progressRange * workDone / totalWork); if (!importedFiles.isEmpty()) { FutureReporter reporter(future, progressRange * pathBudget / (4 * totalWork), progressRange * workDone / totalWork); parseLoop(scannedPaths, newLibraries, workingCopy, importedFiles, modelManager, language, emitDocChangedOnDisk, reporter); // run in parallel?? importedFiles.clear(); } workDone += pathBudget / 4 - 1; future.setProgressValue(progressRange * workDone / totalWork); } else { workDone += pathBudget / 4; } // always descend tree, as we might have just scanned with a smaller depth if (toScan.depth < maxScanDepth) { QDir dir(toScan.path); QStringList subDirs(dir.entryList(QDir::Dirs | QDir::NoDotAndDotDot)); workDone += 1; totalWork += pathBudget / 2 * subDirs.size() - pathBudget * 3 / 4 + 1; foreach (const QString path, subDirs) pathsToScan.append(ScanItem(dir.absoluteFilePath(path), toScan.depth + 1)); } else { workDone += pathBudget * 3 / 4; } future.setProgressValue(progressRange * workDone / totalWork); } future.setProgressValue(progressRange); if (future.isCanceled()) { // assume no work has been done QMutexLocker l(&modelManager->m_mutex); foreach (const QString &path, paths) modelManager->m_scannedPaths.remove(path); } } QStringList ModelManagerInterface::importPaths() const { QMutexLocker l(&m_mutex); return m_allImportPaths; } QmlLanguageBundles ModelManagerInterface::activeBundles() const { QMutexLocker l(&m_mutex); return m_activeBundles; } QmlLanguageBundles ModelManagerInterface::extendedBundles() const { QMutexLocker l(&m_mutex); return m_extendedBundles; } void ModelManagerInterface::maybeScan(const QStringList &importPaths, Language::Enum defaultLanguage) { QStringList pathToScan; { QMutexLocker l(&m_mutex); foreach (QString importPath, importPaths) if (!m_scannedPaths.contains(importPath)) { pathToScan.append(importPath); } } if (pathToScan.count() > 1) { QFuture result = QtConcurrent::run(&ModelManagerInterface::importScan, workingCopyInternal(), pathToScan, this, defaultLanguage, true); if (m_synchronizer.futures().size() > 10) { QList > futures = m_synchronizer.futures(); m_synchronizer.clearFutures(); foreach (const QFuture &future, futures) { if (! (future.isFinished() || future.isCanceled())) m_synchronizer.addFuture(future); } } m_synchronizer.addFuture(result); addTaskInternal(result, tr("Scanning QML Imports"), Constants::TASK_IMPORT_SCAN); } } void ModelManagerInterface::updateImportPaths() { QStringList allImportPaths; QmlLanguageBundles activeBundles; QmlLanguageBundles extendedBundles; QMapIterator pInfoIter(m_projects); QHashIterator vCtxsIter = m_defaultVContexts; while (pInfoIter.hasNext()) { pInfoIter.next(); foreach (const QString &path, pInfoIter.value().importPaths) { const QString canonicalPath = QFileInfo(path).canonicalFilePath(); if (!canonicalPath.isEmpty()) allImportPaths += canonicalPath; } } while (vCtxsIter.hasNext()) { vCtxsIter.next(); allImportPaths << vCtxsIter.value().paths; } pInfoIter.toFront(); while (pInfoIter.hasNext()) { pInfoIter.next(); activeBundles.mergeLanguageBundles(pInfoIter.value().activeBundle); foreach (Language::Enum l, pInfoIter.value().activeBundle.languages()) { foreach (const QString &path, pInfoIter.value().activeBundle.bundleForLanguage(l) .searchPaths().stringList()) { const QString canonicalPath = QFileInfo(path).canonicalFilePath(); if (!canonicalPath.isEmpty()) allImportPaths += canonicalPath; } } } pInfoIter.toFront(); while (pInfoIter.hasNext()) { pInfoIter.next(); QString pathAtt = pInfoIter.value().qtQmlPath; if (!pathAtt.isEmpty() && (allImportPaths.isEmpty() || allImportPaths.last() != pathAtt)) allImportPaths.append(pathAtt); } { QString pathAtt = defaultProjectInfo().qtQmlPath; if (!pathAtt.isEmpty() && (allImportPaths.isEmpty() || allImportPaths.last() != pathAtt)) allImportPaths.append(pathAtt); } pInfoIter.toFront(); while (pInfoIter.hasNext()) { pInfoIter.next(); QString pathAtt = pInfoIter.value().qtImportsPath; if (!pathAtt.isEmpty() && (allImportPaths.isEmpty() || allImportPaths.last() != pathAtt)) allImportPaths.append(pathAtt); } { QString pathAtt = defaultProjectInfo().qtImportsPath; if (!pathAtt.isEmpty() && (allImportPaths.isEmpty() || allImportPaths.last() != pathAtt)) allImportPaths.append(pathAtt); } allImportPaths += m_defaultImportPaths; allImportPaths.removeDuplicates(); { QMutexLocker l(&m_mutex); m_allImportPaths = allImportPaths; m_activeBundles = activeBundles; m_extendedBundles = extendedBundles; } // check if any file in the snapshot imports something new in the new paths Snapshot snapshot = m_validSnapshot; QStringList importedFiles; QSet scannedPaths; QSet newLibraries; foreach (const Document::Ptr &doc, snapshot) findNewLibraryImports(doc, snapshot, this, &importedFiles, &scannedPaths, &newLibraries); updateSourceFiles(importedFiles, true); if (!m_shouldScanImports) return; maybeScan(allImportPaths, Language::Qml); } void ModelManagerInterface::loadPluginTypes(const QString &libraryPath, const QString &importPath, const QString &importUri, const QString &importVersion) { m_pluginDumper->loadPluginTypes(libraryPath, importPath, importUri, importVersion); } // is called *inside a c++ parsing thread*, to allow hanging on to source and ast void ModelManagerInterface::maybeQueueCppQmlTypeUpdate(const CPlusPlus::Document::Ptr &doc) { // avoid scanning documents without source code available doc->keepSourceAndAST(); if (doc->utf8Source().isEmpty()) { doc->releaseSourceAndAST(); return; } // keep source and AST alive if we want to scan for register calls const bool scan = FindExportedCppTypes::maybeExportsTypes(doc); if (!scan) doc->releaseSourceAndAST(); // delegate actual queuing to the gui thread QMetaObject::invokeMethod(this, "queueCppQmlTypeUpdate", Q_ARG(CPlusPlus::Document::Ptr, doc), Q_ARG(bool, scan)); } void ModelManagerInterface::queueCppQmlTypeUpdate(const CPlusPlus::Document::Ptr &doc, bool scan) { QPair prev = m_queuedCppDocuments.value(doc->fileName()); if (prev.first && prev.second) prev.first->releaseSourceAndAST(); m_queuedCppDocuments.insert(doc->fileName(), qMakePair(doc, scan)); m_updateCppQmlTypesTimer->start(); } void ModelManagerInterface::startCppQmlTypeUpdate() { // if a future is still running, delay if (m_cppQmlTypesUpdater.isRunning()) { m_updateCppQmlTypesTimer->start(); return; } CPlusPlus::CppModelManagerBase *cppModelManager = CPlusPlus::CppModelManagerBase::instance(); if (!cppModelManager) return; m_cppQmlTypesUpdater = QtConcurrent::run( &ModelManagerInterface::updateCppQmlTypes, this, cppModelManager->snapshot(), m_queuedCppDocuments); m_queuedCppDocuments.clear(); } QMutex *ModelManagerInterface::mutex() const { return &m_mutex; } void ModelManagerInterface::asyncReset() { m_asyncResetTimer->start(); } void ModelManagerInterface::updateCppQmlTypes(QFutureInterface &interface, ModelManagerInterface *qmlModelManager, CPlusPlus::Snapshot snapshot, QHash > documents) { CppDataHash newData = qmlModelManager->cppData(); FindExportedCppTypes finder(snapshot); bool hasNewInfo = false; typedef QPair DocScanPair; foreach (const DocScanPair &pair, documents) { if (interface.isCanceled()) return; CPlusPlus::Document::Ptr doc = pair.first; const bool scan = pair.second; const QString fileName = doc->fileName(); if (!scan) { hasNewInfo = hasNewInfo || newData.remove(fileName) > 0; continue; } finder(doc); QList exported = finder.exportedTypes(); QHash contextProperties = finder.contextProperties(); if (exported.isEmpty() && contextProperties.isEmpty()) { hasNewInfo = hasNewInfo || newData.remove(fileName) > 0; } else { CppData &data = newData[fileName]; if (!hasNewInfo && (data.exportedTypes.size() != exported.size() || data.contextProperties != contextProperties)) hasNewInfo = true; if (!hasNewInfo) { QHash newFingerprints; foreach (LanguageUtils::FakeMetaObject::ConstPtr newType, exported) newFingerprints[newType->className()]=newType->fingerprint(); foreach (LanguageUtils::FakeMetaObject::ConstPtr oldType, data.exportedTypes) { if (newFingerprints.value(oldType->className()) != oldType->fingerprint()) { hasNewInfo = true; break; } } } data.exportedTypes = exported; data.contextProperties = contextProperties; } doc->releaseSourceAndAST(); } QMutexLocker locker(&qmlModelManager->m_cppDataMutex); qmlModelManager->m_cppDataHash = newData; if (hasNewInfo) // one could get away with re-linking the cpp types... QMetaObject::invokeMethod(qmlModelManager, "asyncReset"); } ModelManagerInterface::CppDataHash ModelManagerInterface::cppData() const { QMutexLocker locker(&m_cppDataMutex); return m_cppDataHash; } LibraryInfo ModelManagerInterface::builtins(const Document::Ptr &doc) const { ProjectInfo info = projectInfoForPath(doc->path()); if (!info.isValid()) return LibraryInfo(); return m_validSnapshot.libraryInfo(info.qtImportsPath); } ViewerContext ModelManagerInterface::completeVContext(const ViewerContext &vCtx, const Document::Ptr &doc) const { ViewerContext res = vCtx; if (!doc.isNull() && ((vCtx.language == Language::AnyLanguage && doc->language() != Language::NoLanguage) || (vCtx.language == Language::Qml && (doc->language() == Language::QmlQtQuick1 || doc->language() == Language::QmlQtQuick2)))) res.language = doc->language(); ProjectInfo info; if (!doc.isNull()) info = projectInfoForPath(doc->path()); ViewerContext defaultVCtx = defaultVContext(res.language, Document::Ptr(0), false); ProjectInfo defaultInfo = defaultProjectInfo(); if (info.qtImportsPath.isEmpty()) info.qtImportsPath = defaultInfo.qtImportsPath; if (info.qtQmlPath.isEmpty()) info.qtQmlPath = defaultInfo.qtQmlPath; switch (res.flags) { case ViewerContext::Complete: break; case ViewerContext::AddAllPathsAndDefaultSelectors: res.selectors.append(defaultVCtx.selectors); // fallthrough case ViewerContext::AddAllPaths: { foreach (const QString &path, defaultVCtx.paths) res.maybeAddPath(path); switch (res.language) { case Language::AnyLanguage: case Language::Qml: res.maybeAddPath(info.qtQmlPath); // fallthrough case Language::QmlQtQuick1: res.maybeAddPath(info.qtImportsPath); // fallthrough case Language::QmlQtQuick2: { if (res.language == Language::QmlQtQuick2) res.maybeAddPath(info.qtQmlPath); QList allProjects; { QMutexLocker locker(&m_mutex); allProjects = m_projects.values(); } std::sort(allProjects.begin(), allProjects.end(), &pInfoLessThanImports); foreach (const ProjectInfo &pInfo, allProjects) { foreach (const QString &path, pInfo.importPaths) res.maybeAddPath(path); } foreach (const QString &path, environmentImportPaths()) res.maybeAddPath(path); break; } case Language::NoLanguage: case Language::JavaScript: case Language::QmlTypeInfo: case Language::Json: case Language::QmlQbs: case Language::QmlProject: break; } break; } case ViewerContext::AddDefaultPathsAndSelectors: res.selectors.append(defaultVCtx.selectors); // fallthrough case ViewerContext::AddDefaultPaths: foreach (const QString &path, defaultVCtx.paths) res.maybeAddPath(path); if (res.language == Language::AnyLanguage || res.language == Language::Qml || res.language == Language::QmlQtQuick2) res.maybeAddPath(info.qtImportsPath); if (res.language == Language::AnyLanguage || res.language == Language::Qml || res.language == Language::QmlQtQuick1) res.maybeAddPath(info.qtQmlPath); if (res.language == Language::AnyLanguage || res.language == Language::Qml || res.language == Language::QmlQtQuick1 || res.language == Language::QmlQtQuick2) { foreach (const QString &path, environmentImportPaths()) res.maybeAddPath(path); } break; } res.flags = ViewerContext::Complete; return res; } ViewerContext ModelManagerInterface::defaultVContext(Language::Enum language, const Document::Ptr &doc, bool autoComplete) const { if (!doc.isNull()) { if (language == Language::AnyLanguage && doc->language() != Language::NoLanguage) language = doc->language(); else if (language == Language::Qml && (doc->language() == Language::QmlQtQuick1 || doc->language() == Language::QmlQtQuick2)) language = doc->language(); } ViewerContext defaultCtx; { QMutexLocker locker(&m_mutex); defaultCtx = m_defaultVContexts.value(language); } defaultCtx.language = language; if (autoComplete) return completeVContext(defaultCtx, doc); else return defaultCtx; } ModelManagerInterface::ProjectInfo ModelManagerInterface::defaultProjectInfo() const { QMutexLocker l(mutex()); return m_defaultProjectInfo; } void ModelManagerInterface::setDefaultVContext(const ViewerContext &vContext) { QMutexLocker locker(&m_mutex); m_defaultVContexts[vContext.language] = vContext; } void ModelManagerInterface::joinAllThreads() { foreach (QFuture future, m_synchronizer.futures()) future.waitForFinished(); } Document::Ptr ModelManagerInterface::ensuredGetDocumentForPath(const QString &filePath) { QmlJS::Document::Ptr document = newestSnapshot().document(filePath); if (!document) { document = QmlJS::Document::create(filePath, QmlJS::Language::Qml); QMutexLocker lock(&m_mutex); m_newestSnapshot.insert(document); } return document; } void ModelManagerInterface::resetCodeModel() { QStringList documents; { QMutexLocker locker(&m_mutex); // find all documents currently in the code model foreach (Document::Ptr doc, m_validSnapshot) documents.append(doc->fileName()); // reset the snapshot m_validSnapshot = Snapshot(); m_newestSnapshot = Snapshot(); } // start a reparse thread updateSourceFiles(documents, false); } } // namespace QmlJS