Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
#include <qqmlcodemodel_p.h>
Public Types | |
enum class | UrlLookup { Caching , ForceLookup } |
enum class | State { Running , Stopping } |
Signals | |
void | updatedSnapshot (const QByteArray &url) |
Signals inherited from QObject | |
void | destroyed (QObject *=nullptr) |
This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
void | objectNameChanged (const QString &objectName, QPrivateSignal) |
This signal is emitted after the object's name has been changed. | |
Public Member Functions | |
QQmlCodeModel (QObject *parent=nullptr, QQmlToolingSettings *settings=nullptr) | |
~QQmlCodeModel () | |
QQmlJS::Dom::DomItem | currentEnv () |
QQmlJS::Dom::DomItem | validEnv () |
OpenDocumentSnapshot | snapshotByUrl (const QByteArray &url) |
OpenDocument | openDocumentByUrl (const QByteArray &url) |
void | openNeedUpdate () |
void | indexNeedsUpdate () |
void | addDirectoriesToIndex (const QStringList &paths, QLanguageServer *server) |
void | addOpenToUpdate (const QByteArray &) |
void | removeDirectory (const QString &path) |
QString | url2Path (const QByteArray &url, UrlLookup options=UrlLookup::Caching) |
void | newOpenFile (const QByteArray &url, int version, const QString &docText) |
void | newDocForOpenFile (const QByteArray &url, int version, const QString &docText) |
void | closeOpenFile (const QByteArray &url) |
void | setRootUrls (const QList< QByteArray > &urls) |
QList< QByteArray > | rootUrls () const |
void | addRootUrls (const QList< QByteArray > &urls) |
QStringList | buildPathsForRootUrl (const QByteArray &url) |
QStringList | buildPathsForFileUrl (const QByteArray &url) |
void | setBuildPathsForRootUrl (QByteArray url, const QStringList &paths) |
QStringList | importPaths () const |
void | setImportPaths (const QStringList &paths) |
void | removeRootUrls (const QList< QByteArray > &urls) |
QQmlToolingSettings * | settings () |
QStringList | findFilePathsFromFileNames (const QStringList &fileNames) const |
void | disableCMakeCalls () |
const QFactoryLoader & | pluginLoader () const |
Public Member Functions inherited from QObject | |
Q_INVOKABLE | QObject (QObject *parent=nullptr) |
Constructs an object with parent object parent. | |
virtual | ~QObject () |
Destroys the object, deleting all its child objects. | |
virtual bool | event (QEvent *event) |
This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
Filters events if this object has been installed as an event filter for the watched object. | |
QString | objectName () const |
Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
Sets the object's name to name. | |
void | setObjectName (QAnyStringView name) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QBindable< QString > | bindableObjectName () |
bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false . | |
bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false . | |
bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false . | |
bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false . | |
bool | blockSignals (bool b) noexcept |
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
QThread * | thread () const |
Returns the thread in which the object lives. | |
bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
void | killTimer (int id) |
Kills the timer with timer identifier, id. | |
void | killTimer (Qt::TimerId id) |
template<typename T > | |
T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
template<typename T > | |
QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
template<typename T > | |
T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const QObjectList & | children () const |
Returns a list of child objects. | |
void | setParent (QObject *parent) |
Makes the object a child of parent. | |
void | installEventFilter (QObject *filterObj) |
Installs an event filter filterObj on this object. | |
void | removeEventFilter (QObject *obj) |
Removes an event filter object obj from this object. | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
void | dumpObjectTree () const |
Dumps a tree of children to the debug output. | |
void | dumpObjectInfo () const |
Dumps information about signal connections, etc. | |
bool | setProperty (const char *name, const QVariant &value) |
Sets the value of the object's name property to value. | |
bool | setProperty (const char *name, QVariant &&value) |
QVariant | property (const char *name) const |
Returns the value of the object's name property. | |
QList< QByteArray > | dynamicPropertyNames () const |
QBindingStorage * | bindingStorage () |
const QBindingStorage * | bindingStorage () const |
QObject * | parent () const |
Returns a pointer to the parent object. | |
bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false . | |
Static Public Member Functions | |
static QStringList | fileNamesToWatch (const QQmlJS::Dom::DomItem &qmlFile) |
Static Public Member Functions inherited from QObject | |
static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
\threadsafe | |
static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
\threadsafe | |
static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
static bool | disconnect (const QMetaObject::Connection &) |
Disconnect a connection. | |
template<typename Func1 , typename Func2 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
template<typename Func1 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
Additional Inherited Members | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Protected Member Functions inherited from QObject | |
QObject * | sender () const |
Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
int | senderSignalIndex () const |
int | receivers (const char *signal) const |
Returns the number of receivers connected to the signal. | |
bool | isSignalConnected (const QMetaMethod &signal) const |
virtual void | timerEvent (QTimerEvent *event) |
This event handler can be reimplemented in a subclass to receive timer events for the object. | |
virtual void | childEvent (QChildEvent *event) |
This event handler can be reimplemented in a subclass to receive child events. | |
virtual void | customEvent (QEvent *event) |
This event handler can be reimplemented in a subclass to receive custom events. | |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
Protected Attributes inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Related Symbols inherited from QObject | |
template< class T > T | qobject_cast (const QObject *object) |
Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QObjectList | |
\macro Q_CLASSINFO(Name, Value) | |
The code model offers a view of the current state of the current files, and traks open files. All methods are threadsafe, and generally return immutable or threadsafe objects that can be worked on from any thread (unless otherwise noted). The idea is the let all other operations be as lock free as possible, concentrating all tricky synchronization here.
\list
\list
Most operations are not parallel and usually take place in the main thread (but are still thread safe). There are two main task that are executed in parallel: Indexing, and OpenDocumentUpdate. Indexing is meant to keep the global view up to date. OpenDocumentUpdate keeps the snapshots of the open documents up to date.
There is always a tension between being responsive, using all threads available, and avoid to hog too many resources. One can choose different parallelization strategies, we went with a flexiable approach. We have (private) functions that execute part of the work: indexSome() and openUpdateSome(). These do all locking needed, get some work, do it without locks, and at the end update the state of the code model. If there is more work, then they return true. Thus while (xxxSome()); works until there is no work left.
addDirectoriesToIndex(), the internal addDirectory() and addOpenToUpdate() add more work to do.
indexNeedsUpdate() and openNeedUpdate(), check if there is work to do, and if yes ensure that a worker thread (or more) that work on it exist.
Definition at line 74 of file qqmlcodemodel_p.h.
|
strong |
Enumerator | |
---|---|
Running | |
Stopping |
Definition at line 79 of file qqmlcodemodel_p.h.
|
strong |
Enumerator | |
---|---|
Caching | |
ForceLookup |
Definition at line 78 of file qqmlcodemodel_p.h.
|
explicit |
Definition at line 84 of file qqmlcodemodel.cpp.
QmlLsp::QQmlCodeModel::~QQmlCodeModel | ( | ) |
Definition at line 113 of file qqmlcodemodel.cpp.
References QSet< T >::clear(), QObject::disconnect(), QFileSystemWatcher::fileChanged(), and QThread::yieldCurrentThread().
void QmlLsp::QQmlCodeModel::addDirectoriesToIndex | ( | const QStringList & | paths, |
QLanguageServer * | server ) |
Definition at line 224 of file qqmlcodemodel.cpp.
References indexNeedsUpdate(), Q_UNUSED, and server.
Referenced by WorkspaceHandlers::clientInitialized(), and WorkspaceHandlers::registerHandlers().
void QmlLsp::QQmlCodeModel::addOpenToUpdate | ( | const QByteArray & | url | ) |
Definition at line 853 of file qqmlcodemodel.cpp.
References QSet< T >::insert(), and url.
Referenced by TextSynchronization::didDidChangeTextDocument(), and newOpenFile().
void QmlLsp::QQmlCodeModel::addRootUrls | ( | const QList< QByteArray > & | urls | ) |
Definition at line 673 of file qqmlcodemodel.cpp.
References QList< T >::append(), QListSpecialMethodsBase< T >::contains(), and url.
Referenced by WorkspaceHandlers::registerHandlers().
QStringList QmlLsp::QQmlCodeModel::buildPathsForFileUrl | ( | const QByteArray & | url | ) |
Definition at line 706 of file qqmlcodemodel.cpp.
References buildPathsForRootUrl(), d, QDir::Dirs, QFile::exists(), QmlLsp::isNotSeparator(), QQmlToolingSettings::isSet(), QDateTime::isValid(), QHash< Key, T >::keys(), QString::last(), QDir::listSeparator(), QByteArray(), qEnvironmentVariable(), QStringLiteral, QString::removeLast(), QQmlToolingSettings::search(), Qt::SkipEmptyParts, QString::split(), QVariant::toString(), url, url2Path(), and QQmlToolingSettings::value().
Referenced by newDocForOpenFile().
QStringList QmlLsp::QQmlCodeModel::buildPathsForRootUrl | ( | const QByteArray & | url | ) |
Definition at line 695 of file qqmlcodemodel.cpp.
References url, and QHash< Key, T >::value().
Referenced by buildPathsForFileUrl().
void QmlLsp::QQmlCodeModel::closeOpenFile | ( | const QByteArray & | url | ) |
Definition at line 661 of file qqmlcodemodel.cpp.
References url.
Referenced by TextSynchronization::didCloseTextDocument().
QQmlJS::Dom::DomItem QmlLsp::QQmlCodeModel::currentEnv | ( | ) |
void QmlLsp::QQmlCodeModel::disableCMakeCalls | ( | ) |
Disable the functionality that uses CMake, and remove the already watched paths if there are some.
Definition at line 106 of file qqmlcodemodel.cpp.
References QObject::disconnect(), QFileSystemWatcher::fileChanged(), QFileSystemWatcher::files(), and QFileSystemWatcher::removePaths().
|
static |
Find all C++ file names (not path, for file paths call \l findFilePathsFromFileNames on the result of this method) that this qmlFile relies on.
Definition at line 530 of file qqmlcodemodel.cpp.
References QQmlJS::Dom::DomItem::as(), file, QFileInfo::fileName(), and isComposite().
QStringList QmlLsp::QQmlCodeModel::findFilePathsFromFileNames | ( | const QStringList & | fileNames | ) | const |
Iterate the entire source directory to find all C++ files that have their names in fileNames, and return all the found file paths.
This is an overapproximation and might find unrelated files with the same name.
Definition at line 506 of file qqmlcodemodel.cpp.
References fileNames, QDir::Files, QString::fromUtf8(), info, QString::isEmpty(), it, qCDebug, QDirIterator::Subdirectories, and QUrl::toLocalFile().
|
inline |
Definition at line 104 of file qqmlcodemodel_p.h.
void QmlLsp::QQmlCodeModel::indexNeedsUpdate | ( | ) |
Definition at line 323 of file qqmlcodemodel.cpp.
References QThreadPool::globalInstance().
Referenced by addDirectoriesToIndex().
void QmlLsp::QQmlCodeModel::newDocForOpenFile | ( | const QByteArray & | url, |
int | version, | ||
const QString & | docText ) |
Definition at line 579 of file qqmlcodemodel.cpp.
References QmlLsp::OpenDocumentSnapshot::AllCode, buildPathsForFileUrl(), QmlLsp::OpenDocumentSnapshot::doc, QmlLsp::OpenDocumentSnapshot::docVersion, QmlLsp::OpenDocumentSnapshot::dump(), emit, QQmlJS::Dom::DomItem::EnvConnected, file, ForceLookup, QQmlJS::Dom::FileToLoad::fromMemory(), QString::fromUtf8(), item, QQmlJS::Dom::MutableDomItem::item(), QQmlJS::Dom::DomEnvironment::loadFile(), QQmlJS::Dom::DomItem::makeCopy(), QQmlJS::Dom::DomItem::ownerAs(), QQmlJS::Dom::DomItem::path(), qCDebug, qCWarning, qDebug, QmlLsp::OpenDocument::snapshot, snapshotByUrl(), QmlLsp::OpenDocument::textDocument, updatedSnapshot(), url, url2Path(), QmlLsp::OpenDocumentSnapshot::validDoc, and QmlLsp::OpenDocumentSnapshot::validDocVersion.
void QmlLsp::QQmlCodeModel::newOpenFile | ( | const QByteArray & | url, |
int | version, | ||
const QString & | docText ) |
Definition at line 302 of file qqmlcodemodel.cpp.
References addOpenToUpdate(), openNeedUpdate(), and url.
Referenced by TextSynchronization::didOpenTextDocument().
OpenDocument QmlLsp::QQmlCodeModel::openDocumentByUrl | ( | const QByteArray & | url | ) |
Definition at line 317 of file qqmlcodemodel.cpp.
References url.
Referenced by TextSynchronization::didDidChangeTextDocument(), QQmlDocumentFormatting::process(), QQmlHover::process(), QQmlRangeFormatting::process(), and snapshotByUrl().
void QmlLsp::QQmlCodeModel::openNeedUpdate | ( | ) |
Definition at line 369 of file qqmlcodemodel.cpp.
References QThreadPool::globalInstance(), QSet< T >::isEmpty(), and qCDebug.
Referenced by TextSynchronization::didDidChangeTextDocument(), and newOpenFile().
|
inline |
Definition at line 111 of file qqmlcodemodel_p.h.
Definition at line 256 of file qqmlcodemodel.cpp.
References it, and QQmlJS::Dom::DomItem::ownerAs().
void QmlLsp::QQmlCodeModel::removeRootUrls | ( | const QList< QByteArray > & | urls | ) |
Definition at line 682 of file qqmlcodemodel.cpp.
References QList< T >::removeOne(), and url.
Referenced by WorkspaceHandlers::registerHandlers().
QList< QByteArray > QmlLsp::QQmlCodeModel::rootUrls | ( | ) | const |
Definition at line 689 of file qqmlcodemodel.cpp.
void QmlLsp::QQmlCodeModel::setBuildPathsForRootUrl | ( | QByteArray | url, |
const QStringList & | paths ) |
Definition at line 799 of file qqmlcodemodel.cpp.
References QHash< Key, T >::insert(), QUrl::isEmpty(), QmlLsp::isNotSeparator(), QHash< Key, T >::remove(), and url.
Referenced by QmlLsp::QQmlLanguageServer::registerHandlers().
|
inline |
Definition at line 105 of file qqmlcodemodel_p.h.
void QmlLsp::QQmlCodeModel::setRootUrls | ( | const QList< QByteArray > & | urls | ) |
Definition at line 667 of file qqmlcodemodel.cpp.
Referenced by QmlLsp::QQmlLanguageServer::setupCapabilities().
QQmlToolingSettings * QmlLsp::QQmlCodeModel::settings | ( | ) |
OpenDocumentSnapshot QmlLsp::QQmlCodeModel::snapshotByUrl | ( | const QByteArray & | url | ) |
Definition at line 130 of file qqmlcodemodel.cpp.
References openDocumentByUrl(), QmlLsp::OpenDocument::snapshot, and url.
Referenced by newDocForOpenFile(), and QmlCompletionSupport::process().
|
signal |
Referenced by QmlLsp::QmlLintSuggestions::QmlLintSuggestions(), QQmlBaseModule< RequestType >::QQmlBaseModule(), and newDocForOpenFile().
QString QmlLsp::QQmlCodeModel::url2Path | ( | const QByteArray & | url, |
UrlLookup | options = UrlLookup::Caching ) |
Definition at line 278 of file qqmlcodemodel.cpp.
References Caching, QString::fromUtf8(), QHash< Key, T >::insert(), QHash< Key, T >::remove(), url, and QHash< Key, T >::value().
Referenced by buildPathsForFileUrl(), WorkspaceHandlers::clientInitialized(), TextSynchronization::didDidChangeTextDocument(), TextSynchronization::didOpenTextDocument(), newDocForOpenFile(), and WorkspaceHandlers::registerHandlers().
QQmlJS::Dom::DomItem QmlLsp::QQmlCodeModel::validEnv | ( | ) |