|
| | QQmlCodeModel (const QByteArray &rootUrl={}, QObject *parent=nullptr, QQmlToolingSharedSettings *settings=nullptr) |
| | ~QQmlCodeModel () |
| void | prepareForShutdown () |
| QQmlJS::Dom::DomItem | currentEnv () const |
| QQmlJS::Dom::DomItem | validEnv () const |
| OpenDocumentSnapshot | snapshotByUrl (const QByteArray &url) |
| OpenDocument | openDocumentByUrl (const QByteArray &url) |
| bool | isEmpty () const |
| void | addOpenToUpdate (const QByteArray &, UpdatePolicy policy) |
| void | removeDirectory (const QByteArray &) |
| void | newOpenFile (const QByteArray &url, int version, const QString &docText) |
| void | closeOpenFile (const QByteArray &url) |
| QByteArray | rootUrl () const |
| QStringList | buildPaths () |
| QStringList | buildPathsForFileUrl (const QByteArray &url) |
| void | setBuildPaths (const QStringList &paths) |
| QStringList | buildPathsForOpenedFiles () |
| QStringList | importPathsForUrl (const QByteArray &) |
| QStringList | importPaths () const |
| void | setImportPaths (const QStringList &paths) |
| QStringList | resourceFiles () const |
| void | setResourceFiles (const QStringList &resourceFiles) |
| QQmlToolingSharedSettings * | settings () const |
| QStringList | findFilePathsFromFileNames (const QStringList &fileNames, const QSet< QString > &alreadyWatchedFiles) |
| void | disableCMakeCalls () |
| void | tryEnableCMakeCalls (QProcessScheduler *scheduler) |
| RegisteredSemanticTokens & | registeredTokens () |
| const RegisteredSemanticTokens & | registeredTokens () const |
| QString | documentationRootPath () const |
| void | setDocumentationRootPath (const QString &path) |
| QSet< QString > | ignoreForWatching () const |
| HelpManager * | helpManager () |
| void | setVerbose (bool verbose) |
| bool | verbose () const |
| void | setCMakeJobs (int jobs) |
| int | cmakeJobs () const |
| 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 | isQmlObjectType () const |
| | Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
|
| 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 QStringList | fileNamesToWatch (const QQmlJS::Dom::DomItem &qmlFile) |
| 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) |
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 is one task that is executed in parallel: OpenDocumentUpdate. 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: 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.
The internal addOpenToUpdate() add more work to do.
openNeedUpdate() checks if there is work to do, and if yes ensure that a worker thread (or more) that work on it exist.
Definition at line 105 of file qqmlcodemodel_p.h.
1.16.1