#include <qqmlcodemodelmanager_p.h>

Inheritance diagram for QmlLsp::QQmlCodeModelManager:

Collaboration diagram for QmlLsp::QQmlCodeModelManager:

Signals
void	updatedSnapshot (const QByteArray &url, UpdatePolicy policy)
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
	QQmlCodeModelManager (QObject parent=nullptr, QQmlToolingSharedSettings settings=nullptr)
	~QQmlCodeModelManager ()
OpenDocumentSnapshot	snapshotByUrl (const QByteArray &url)
OpenDocument	openDocumentByUrl (const QByteArray &url)
void	addOpenToUpdate (const QByteArray &)
void	removeDirectory (const QByteArray &)
void	newOpenFile (const QByteArray &url, int version, const QString &docText)
void	closeOpenFile (const QByteArray &url)
QList< QByteArray >	rootUrls () const
void	addRootUrls (const QList< QByteArray > &urls)
QStringList	buildPathsForFileUrl (const QByteArray &url)
void	setBuildPathsForRootUrl (const QByteArray &url, const QStringList &paths)
QStringList	importPathsForUrl (const QByteArray &)
void	setImportPaths (const QStringList &paths)
void	removeRootUrls (const QList< QByteArray > &urls)
QQmlToolingSharedSettings *	settings () const
void	disableCMakeCalls ()
const QFactoryLoader &	pluginLoader () const
QByteArray	shortestRootUrlForFile (const QByteArray &fileUrl) const
RegisteredSemanticTokens &	registeredTokens (const QByteArray &)
const RegisteredSemanticTokens &	registeredTokens (const QByteArray &) const
void	setDocumentationRootPath (const QString &path)
HelpManager *	helpManagerForUrl (const QByteArray &)
void	tryEnableCMakeCalls ()
void	setVerbose (bool verbose)
QStringList	defaultImportPaths () const
QStringList	defaultBuildPaths () const
QString	defaultDocumentationRootPath () 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	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`.

Protected Types
enum	CMakeStatus { HasCMake , DoesNotHaveCMake , IsProbingCMake }
enum	ManagedBy { ManagedByClient , ManagedByServer }
using	Workspaces = std::vector<QQmlWorkspace>
using	WorkspaceIterator = Workspaces::const_iterator
using	WorkspaceMutableIterator = Workspaces::iterator

Protected Member Functions
QQmlCodeModel *	findCodeModelForFile (const QByteArray &url)
QQmlCodeModel *	fallbackCodeModel () const
WorkspaceIterator	findWorkspaceForFile (const QByteArray &url)
WorkspaceIterator	workspaceFromBuildFolder (const QString &fileName, const QStringList &buildFolders)
WorkspaceMutableIterator	findWorkspace (const QByteArray &url)
void	appendWorkspace (const QByteArray &url, ManagedBy managedBy)
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
QQmlToolingSharedSettings *	m_settings
QFactoryLoader	m_pluginLoader
Workspaces	m_workspaces
QQmllsBuildInformation	m_buildInformation
QProcessScheduler	m_processScheduler
std::map< QByteArray, QByteArray >	m_file2CodeModel
QProcess	m_cmakeProber
CMakeStatus	m_cmakeStatus = IsProbingCMake
bool	m_verbose = false
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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)
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)

Detailed Description

Definition at line 43 of file qqmlcodemodelmanager_p.h.

Member Typedef Documentation

◆ WorkspaceIterator

using QmlLsp::QQmlCodeModelManager::WorkspaceIterator = Workspaces::const_iterator

protected

Definition at line 89 of file qqmlcodemodelmanager_p.h.

◆ WorkspaceMutableIterator

using QmlLsp::QQmlCodeModelManager::WorkspaceMutableIterator = Workspaces::iterator

protected

Definition at line 98 of file qqmlcodemodelmanager_p.h.

◆ Workspaces

using QmlLsp::QQmlCodeModelManager::Workspaces = std::vector<QQmlWorkspace>

protected

Definition at line 88 of file qqmlcodemodelmanager_p.h.

Member Enumeration Documentation

◆ CMakeStatus

enum QmlLsp::QQmlCodeModelManager::CMakeStatus

protected

Enumerator
HasCMake
DoesNotHaveCMake
IsProbingCMake

Definition at line 90 of file qqmlcodemodelmanager_p.h.

◆ ManagedBy

enum QmlLsp::QQmlCodeModelManager::ManagedBy

protected

Enumerator
ManagedByClient
ManagedByServer

Definition at line 97 of file qqmlcodemodelmanager_p.h.

Constructor & Destructor Documentation

◆ QQmlCodeModelManager()

QmlLsp::QQmlCodeModelManager::QQmlCodeModelManager	(	QObject *	parent = nullptr,
		QQmlToolingSharedSettings *	settings = nullptr )

Definition at line 51 of file qqmlcodemodelmanager.cpp.

◆ ~QQmlCodeModelManager()

QmlLsp::QQmlCodeModelManager::~QQmlCodeModelManager ( )

Definition at line 58 of file qqmlcodemodelmanager.cpp.

Member Function Documentation

◆ addOpenToUpdate()

void QmlLsp::QQmlCodeModelManager::addOpenToUpdate ( const QByteArray & url )

Definition at line 322 of file qqmlcodemodelmanager.cpp.

◆ addRootUrls()

void QmlLsp::QQmlCodeModelManager::addRootUrls ( const QList< QByteArray > & urls )

Definition at line 227 of file qqmlcodemodelmanager.cpp.

◆ appendWorkspace()

void QmlLsp::QQmlCodeModelManager::appendWorkspace	(	const QByteArray &	url,
		ManagedBy	managedBy )

protected

Definition at line 120 of file qqmlcodemodelmanager.cpp.

◆ buildPathsForFileUrl()

QStringList QmlLsp::QQmlCodeModelManager::buildPathsForFileUrl ( const QByteArray & url )

Definition at line 252 of file qqmlcodemodelmanager.cpp.

◆ closeOpenFile()

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

Definition at line 200 of file qqmlcodemodelmanager.cpp.

◆ defaultBuildPaths()

QStringList QmlLsp::QQmlCodeModelManager::defaultBuildPaths ( ) const

inline

Definition at line 79 of file qqmlcodemodelmanager_p.h.

References fallbackCodeModel().

Here is the call graph for this function:

◆ defaultDocumentationRootPath()

QString QmlLsp::QQmlCodeModelManager::defaultDocumentationRootPath ( ) const

inline

Definition at line 80 of file qqmlcodemodelmanager_p.h.

References fallbackCodeModel().

Here is the call graph for this function:

◆ defaultImportPaths()

QStringList QmlLsp::QQmlCodeModelManager::defaultImportPaths ( ) const

inline

Definition at line 78 of file qqmlcodemodelmanager_p.h.

References fallbackCodeModel().

Here is the call graph for this function:

◆ disableCMakeCalls()

void QmlLsp::QQmlCodeModelManager::disableCMakeCalls ( )

Definition at line 166 of file qqmlcodemodelmanager.cpp.

◆ fallbackCodeModel()

QQmlCodeModel * QmlLsp::QQmlCodeModelManager::fallbackCodeModel ( ) const

inlineprotected

Definition at line 93 of file qqmlcodemodelmanager_p.h.

Referenced by defaultBuildPaths(), defaultDocumentationRootPath(), and defaultImportPaths().

Here is the caller graph for this function:

◆ findCodeModelForFile()

QQmlCodeModel * QmlLsp::QQmlCodeModelManager::findCodeModelForFile ( const QByteArray & url )

protected

Definition at line 108 of file qqmlcodemodelmanager.cpp.

◆ findWorkspace()

QQmlCodeModelManager::WorkspaceMutableIterator QmlLsp::QQmlCodeModelManager::findWorkspace ( const QByteArray & url )

protected

Definition at line 114 of file qqmlcodemodelmanager.cpp.

◆ findWorkspaceForFile()

QQmlCodeModelManager::WorkspaceIterator QmlLsp::QQmlCodeModelManager::findWorkspaceForFile ( const QByteArray & url )

protected

Definition at line 65 of file qqmlcodemodelmanager.cpp.

◆ helpManagerForUrl()

HelpManager * QmlLsp::QQmlCodeModelManager::helpManagerForUrl ( const QByteArray & url )

Definition at line 337 of file qqmlcodemodelmanager.cpp.

◆ importPathsForUrl()

QStringList QmlLsp::QQmlCodeModelManager::importPathsForUrl ( const QByteArray & url )

Definition at line 247 of file qqmlcodemodelmanager.cpp.

◆ newOpenFile()

void QmlLsp::QQmlCodeModelManager::newOpenFile	(	const QByteArray &	url,
		int	version,
		const QString &	docText )

Definition at line 183 of file qqmlcodemodelmanager.cpp.

◆ openDocumentByUrl()

OpenDocument QmlLsp::QQmlCodeModelManager::openDocumentByUrl ( const QByteArray & url )

Definition at line 190 of file qqmlcodemodelmanager.cpp.

◆ pluginLoader()

const QFactoryLoader & QmlLsp::QQmlCodeModelManager::pluginLoader ( ) const

inline

Definition at line 67 of file qqmlcodemodelmanager_p.h.

◆ registeredTokens() [1/2]

RegisteredSemanticTokens & QmlLsp::QQmlCodeModelManager::registeredTokens ( const QByteArray & url )

Definition at line 195 of file qqmlcodemodelmanager.cpp.

◆ registeredTokens() [2/2]

const RegisteredSemanticTokens & QmlLsp::QQmlCodeModelManager::registeredTokens ( const QByteArray & ) const

◆ removeDirectory()

void QmlLsp::QQmlCodeModelManager::removeDirectory ( const QByteArray & url )

Definition at line 178 of file qqmlcodemodelmanager.cpp.

◆ removeRootUrls()

void QmlLsp::QQmlCodeModelManager::removeRootUrls ( const QList< QByteArray > & urls )

Definition at line 239 of file qqmlcodemodelmanager.cpp.

◆ rootUrls()

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

Definition at line 217 of file qqmlcodemodelmanager.cpp.

◆ setBuildPathsForRootUrl()

void QmlLsp::QQmlCodeModelManager::setBuildPathsForRootUrl	(	const QByteArray &	url,
		const QStringList &	paths )

Definition at line 296 of file qqmlcodemodelmanager.cpp.

◆ setDocumentationRootPath()

void QmlLsp::QQmlCodeModelManager::setDocumentationRootPath ( const QString & path )

Definition at line 279 of file qqmlcodemodelmanager.cpp.

◆ setImportPaths()

void QmlLsp::QQmlCodeModelManager::setImportPaths ( const QStringList & paths )

Definition at line 327 of file qqmlcodemodelmanager.cpp.

◆ settings()

QQmlToolingSharedSettings * QmlLsp::QQmlCodeModelManager::settings ( ) const

inline

Definition at line 65 of file qqmlcodemodelmanager_p.h.

◆ setVerbose()

void QmlLsp::QQmlCodeModelManager::setVerbose ( bool verbose )

Definition at line 289 of file qqmlcodemodelmanager.cpp.

◆ shortestRootUrlForFile()

QByteArray QmlLsp::QQmlCodeModelManager::shortestRootUrlForFile ( const QByteArray & fileUrl ) const

Definition at line 257 of file qqmlcodemodelmanager.cpp.

◆ snapshotByUrl()

OpenDocumentSnapshot QmlLsp::QQmlCodeModelManager::snapshotByUrl ( const QByteArray & url )

Definition at line 173 of file qqmlcodemodelmanager.cpp.

◆ tryEnableCMakeCalls()

void QmlLsp::QQmlCodeModelManager::tryEnableCMakeCalls ( )

Enable and initialize the functionality that uses CMake, if CMake exists.

Note: Set the buildpaths before calling this method!

Definition at line 37 of file qqmlcodemodelmanager.cpp.

◆ updatedSnapshot

void QmlLsp::QQmlCodeModelManager::updatedSnapshot	(	const QByteArray &	url,
		UpdatePolicy	policy )

signal

◆ workspaceFromBuildFolder()

QQmlCodeModelManager::WorkspaceIterator QmlLsp::QQmlCodeModelManager::workspaceFromBuildFolder	(	const QString &	fileName,
		const QStringList &	buildFolders )

protected

Definition at line 154 of file qqmlcodemodelmanager.cpp.

Member Data Documentation

◆ m_buildInformation

QQmllsBuildInformation QmlLsp::QQmlCodeModelManager::m_buildInformation

protected

Definition at line 106 of file qqmlcodemodelmanager_p.h.

◆ m_cmakeProber

QProcess QmlLsp::QQmlCodeModelManager::m_cmakeProber

protected

Definition at line 111 of file qqmlcodemodelmanager_p.h.

◆ m_cmakeStatus

CMakeStatus QmlLsp::QQmlCodeModelManager::m_cmakeStatus = IsProbingCMake

protected

Definition at line 112 of file qqmlcodemodelmanager_p.h.

◆ m_file2CodeModel

std::map<QByteArray, QByteArray> QmlLsp::QQmlCodeModelManager::m_file2CodeModel

protected

Definition at line 109 of file qqmlcodemodelmanager_p.h.

◆ m_pluginLoader

QFactoryLoader QmlLsp::QQmlCodeModelManager::m_pluginLoader

protected

Definition at line 103 of file qqmlcodemodelmanager_p.h.

◆ m_processScheduler

QProcessScheduler QmlLsp::QQmlCodeModelManager::m_processScheduler

protected

Definition at line 107 of file qqmlcodemodelmanager_p.h.

◆ m_settings

QQmlToolingSharedSettings* QmlLsp::QQmlCodeModelManager::m_settings

protected

Definition at line 102 of file qqmlcodemodelmanager_p.h.

◆ m_verbose

bool QmlLsp::QQmlCodeModelManager::m_verbose = false

protected

Definition at line 113 of file qqmlcodemodelmanager_p.h.

◆ m_workspaces

Workspaces QmlLsp::QQmlCodeModelManager::m_workspaces

protected

Definition at line 105 of file qqmlcodemodelmanager_p.h.

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

qtdeclarative/src/qmlls/qqmlcodemodelmanager_p.h (0546b969db339501c9fe7795663a541982c8fcff)
qtdeclarative/src/qmlls/qqmlcodemodelmanager.cpp (0546b969db339501c9fe7795663a541982c8fcff)

Signals

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ WorkspaceIterator

◆ WorkspaceMutableIterator

◆ Workspaces

Member Enumeration Documentation

◆ CMakeStatus

◆ ManagedBy

Constructor & Destructor Documentation

◆ QQmlCodeModelManager()

◆ ~QQmlCodeModelManager()

Member Function Documentation

◆ addOpenToUpdate()

◆ addRootUrls()

◆ appendWorkspace()

◆ buildPathsForFileUrl()

◆ closeOpenFile()

◆ defaultBuildPaths()

◆ defaultDocumentationRootPath()

◆ defaultImportPaths()

◆ disableCMakeCalls()

◆ fallbackCodeModel()

◆ findCodeModelForFile()

◆ findWorkspace()

◆ findWorkspaceForFile()

◆ helpManagerForUrl()

◆ importPathsForUrl()

◆ newOpenFile()

◆ openDocumentByUrl()

◆ pluginLoader()

◆ registeredTokens() [1/2]

◆ registeredTokens() [2/2]

◆ removeDirectory()

◆ removeRootUrls()

◆ rootUrls()

◆ setBuildPathsForRootUrl()

◆ setDocumentationRootPath()

◆ setImportPaths()

◆ settings()

◆ setVerbose()

◆ shortestRootUrlForFile()

◆ snapshotByUrl()

◆ tryEnableCMakeCalls()

◆ updatedSnapshot

◆ workspaceFromBuildFolder()

Member Data Documentation

◆ m_buildInformation

◆ m_cmakeProber

◆ m_cmakeStatus

◆ m_file2CodeModel

◆ m_pluginLoader

◆ m_processScheduler

◆ m_settings

◆ m_verbose

◆ m_workspaces