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>.
Loading...
Searching...
No Matches
QmlLsp::QQmlCodeModel Class Reference

#include <qqmlcodemodel_p.h>

+ Inheritance diagram for QmlLsp::QQmlCodeModel:
+ Collaboration diagram for QmlLsp::QQmlCodeModel:

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< QByteArrayrootUrls () 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)
 
QQmlToolingSettingssettings ()
 
QStringList findFilePathsFromFileNames (const QStringList &fileNames) const
 
void disableCMakeCalls ()
 
const QFactoryLoaderpluginLoader () 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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
QObjectsender () 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< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

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

  • currentEnv() offers a view that contains the latest version of all the loaded files
  • validEnv() is just like current env but stores only the valid (meaning correctly parsed, not necessarily without errors) version of a file, it is normally a better choice to load the dependencies/symbol information from \endlist

\list

  • snapshotByUrl() returns an OpenDocumentSnapshot of an open document. From it you can get the document, its latest valid version, scope, all connected to a specific version of the document and immutable. The signal updatedSnapshot() is called every time a snapshot changes (also for every partial change: document change, validDocument change, scope change).
  • openDocumentByUrl() is a lower level and more intrusive access to OpenDocument objects. These contains the current snapshot, and shared pointer to a Utils::TextDocument. This is always the current version of the document, and has line by line support. Working on it is more delicate and intrusive, because you have to explicitly acquire its mutex() before any read or write/modification to it. It has a version nuber which is supposed to always change and increase. It is mainly used for highlighting/indenting, and is immediately updated when the user edits a document. Its use should be avoided if possible, preferring the snapshots. \endlist

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.

Member Enumeration Documentation

◆ State

enum class QmlLsp::QQmlCodeModel::State
strong
Enumerator
Running 
Stopping 

Definition at line 79 of file qqmlcodemodel_p.h.

◆ UrlLookup

Enumerator
Caching 
ForceLookup 

Definition at line 78 of file qqmlcodemodel_p.h.

Constructor & Destructor Documentation

◆ QQmlCodeModel()

QmlLsp::QQmlCodeModel::QQmlCodeModel ( QObject * parent = nullptr,
QQmlToolingSettings * settings = nullptr )
explicit

Definition at line 84 of file qqmlcodemodel.cpp.

◆ ~QQmlCodeModel()

QmlLsp::QQmlCodeModel::~QQmlCodeModel ( )

Definition at line 113 of file qqmlcodemodel.cpp.

References QSet< T >::clear(), QObject::disconnect(), QFileSystemWatcher::fileChanged(), and QThread::yieldCurrentThread().

+ Here is the call graph for this function:

Member Function Documentation

◆ addDirectoriesToIndex()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addOpenToUpdate()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addRootUrls()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildPathsForFileUrl()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildPathsForRootUrl()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ closeOpenFile()

void QmlLsp::QQmlCodeModel::closeOpenFile ( const QByteArray & url)

Definition at line 661 of file qqmlcodemodel.cpp.

References url.

Referenced by TextSynchronization::didCloseTextDocument().

+ Here is the caller graph for this function:

◆ currentEnv()

QQmlJS::Dom::DomItem QmlLsp::QQmlCodeModel::currentEnv ( )

◆ disableCMakeCalls()

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().

+ Here is the call graph for this function:

◆ fileNamesToWatch()

QStringList QmlLsp::QQmlCodeModel::fileNamesToWatch ( const QQmlJS::Dom::DomItem & qmlFile)
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().

+ Here is the call graph for this function:

◆ findFilePathsFromFileNames()

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().

+ Here is the call graph for this function:

◆ importPaths()

QStringList QmlLsp::QQmlCodeModel::importPaths ( ) const
inline

Definition at line 104 of file qqmlcodemodel_p.h.

◆ indexNeedsUpdate()

void QmlLsp::QQmlCodeModel::indexNeedsUpdate ( )

Definition at line 323 of file qqmlcodemodel.cpp.

References QThreadPool::globalInstance().

Referenced by addDirectoriesToIndex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ newDocForOpenFile()

◆ newOpenFile()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ openDocumentByUrl()

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().

+ Here is the caller graph for this function:

◆ openNeedUpdate()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ pluginLoader()

const QFactoryLoader & QmlLsp::QQmlCodeModel::pluginLoader ( ) const
inline

Definition at line 111 of file qqmlcodemodel_p.h.

◆ removeDirectory()

void QmlLsp::QQmlCodeModel::removeDirectory ( const QString & path)

Definition at line 256 of file qqmlcodemodel.cpp.

References it, and QQmlJS::Dom::DomItem::ownerAs().

+ Here is the call graph for this function:

◆ removeRootUrls()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ rootUrls()

QList< QByteArray > QmlLsp::QQmlCodeModel::rootUrls ( ) const

Definition at line 689 of file qqmlcodemodel.cpp.

◆ setBuildPathsForRootUrl()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setImportPaths()

void QmlLsp::QQmlCodeModel::setImportPaths ( const QStringList & paths)
inline

Definition at line 105 of file qqmlcodemodel_p.h.

◆ setRootUrls()

void QmlLsp::QQmlCodeModel::setRootUrls ( const QList< QByteArray > & urls)

Definition at line 667 of file qqmlcodemodel.cpp.

Referenced by QmlLsp::QQmlLanguageServer::setupCapabilities().

+ Here is the caller graph for this function:

◆ settings()

QQmlToolingSettings * QmlLsp::QQmlCodeModel::settings ( )

◆ snapshotByUrl()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ updatedSnapshot

void QmlLsp::QQmlCodeModel::updatedSnapshot ( const QByteArray & url)
signal

Referenced by QmlLsp::QmlLintSuggestions::QmlLintSuggestions(), QQmlBaseModule< RequestType >::QQmlBaseModule(), and newDocForOpenFile().

+ Here is the caller graph for this function:

◆ url2Path()

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().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ validEnv()

QQmlJS::Dom::DomItem QmlLsp::QQmlCodeModel::validEnv ( )

The documentation for this class was generated from the following files: