QmlLsp::QQmlLanguageServer Class Reference

Sets up a QmlLanguageServer. More...

#include <qqmllanguageserver_p.h>

Inheritance diagram for QmlLsp::QQmlLanguageServer:

Collaboration diagram for QmlLsp::QQmlLanguageServer:

Public Slots
void	exit ()
void	errorExit ()
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Public Member Functions
	QQmlLanguageServer (std::function< void(const QByteArray &)> sendData, QQmlToolingSettings *settings=nullptr)
QString	name () const final
void	registerHandlers (QLanguageServer *server, QLanguageServerProtocol *protocol) final
void	setupCapabilities (const QLspSpecification::InitializeParams &clientInfo, QLspSpecification::InitializeResult &serverInfo) final
int	returnValue () const
QQmlCodeModel *	codeModel ()
QLanguageServer *	server ()
TextSynchronization *	textSynchronization ()
QmlLintSuggestions *	lint ()
WorkspaceHandlers *	worspace ()
Public Member Functions inherited from QLanguageServerModule
	QLanguageServerModule (QObject *parent=nullptr)
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.

Additional Inherited Members
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.
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)
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)

Detailed Description

Sets up a QmlLanguageServer.

This class sets up a QML language server.

Use the following function to send replies:

std::function<void(const QByteArray &)> sendData

And, feed the data that the function receives to the {server()->receive()} method.

Call this method only from a single thread, and do not block. To achieve this, avoid direct calls, and connect the method as a slot, while reading from another thread.

The various tasks of the language server are divided between QLanguageServerModule instances. Each instance is responsible for handling a certain subset of client requests. For example, one instance handles completion requests, another one updates the code in the code model when the client sends a new file version, and so on. The QLanguageServerModule instances are constructed and registered with QLanguageServer in the constructor of this class.

Generally, do all operations in the object thread and always call handlers from it. However, the operations can delegate the response to another thread, as the response handler is thread safe. All the methods of the server() object are also thread safe.

The code model starts other threads to update its state. See its documentation for more information.

Definition at line 38 of file qqmllanguageserver_p.h.

Constructor & Destructor Documentation

QQmlLanguageServer()

QmlLsp::QQmlLanguageServer::QQmlLanguageServer	(	std::function< void(const QByteArray &)>	sendData,
		QQmlToolingSettings *	settings = nullptr )

Definition at line 56 of file qqmllanguageserver.cpp.

References QLanguageServer::addServerModule(), QLanguageServer::finishSetup(), and qCWarning.

Here is the call graph for this function:

Member Function Documentation

codeModel()

QQmlCodeModel * QmlLsp::QQmlLanguageServer::codeModel

(

)

Definition at line 156 of file qqmllanguageserver.cpp.

errorExit

void QmlLsp::QQmlLanguageServer::errorExit ( )

slot

Definition at line 139 of file qqmllanguageserver.cpp.

References qCWarning.

Referenced by registerHandlers().

Here is the caller graph for this function:

exit

void QmlLsp::QQmlLanguageServer::exit ( )

slot

Definition at line 145 of file qqmllanguageserver.cpp.

Referenced by registerHandlers().

Here is the caller graph for this function:

lint()

QmlLintSuggestions * QmlLsp::QQmlLanguageServer::lint

(

)

Definition at line 171 of file qqmllanguageserver.cpp.

name()

QString QmlLsp::QQmlLanguageServer::name ( ) const

finalvirtual

Implements QLanguageServerModule.

Definition at line 134 of file qqmllanguageserver.cpp.

registerHandlers()

void QmlLsp::QQmlLanguageServer::registerHandlers ( QLanguageServer * server, QLanguageServerProtocol * protocol )

finalvirtual

Implements QLanguageServerModule.

Definition at line 88 of file qqmllanguageserver.cpp.

References QLspSpecification::Notifications::AddBuildDirsMethod, QObject::connect(), errorExit(), QLanguageServer::exit(), exit(), QLanguageServer::lifecycleError(), Q_UNUSED, QByteArray(), qCDebug, QLanguageServer::runStatusChanged(), server(), and QmlLsp::QQmlCodeModel::setBuildPathsForRootUrl().

Here is the call graph for this function:

returnValue()

int QmlLsp::QQmlLanguageServer::returnValue

(

)

const

Definition at line 151 of file qqmllanguageserver.cpp.

server()

QLanguageServer * QmlLsp::QQmlLanguageServer::server

(

)

Definition at line 161 of file qqmllanguageserver.cpp.

Referenced by registerHandlers().

Here is the caller graph for this function:

setupCapabilities()

void QmlLsp::QQmlLanguageServer::setupCapabilities ( const QLspSpecification::InitializeParams & clientInfo, QLspSpecification::InitializeResult & serverInfo )

finalvirtual

Implements QLanguageServerModule.

Definition at line 113 of file qqmllanguageserver.cpp.

References QJsonObject::insert(), and QmlLsp::QQmlCodeModel::setRootUrls().

Here is the call graph for this function:

textSynchronization()

TextSynchronization * QmlLsp::QQmlLanguageServer::textSynchronization

(

)

Definition at line 166 of file qqmllanguageserver.cpp.

worspace()

WorkspaceHandlers * QmlLsp::QQmlLanguageServer::worspace

(

)

Definition at line 176 of file qqmllanguageserver.cpp.

---

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

• qtdeclarative/src/qmlls/qqmllanguageserver_p.h (63ecc3a1f0ede925517bf30470c277c99541804e)
• qtdeclarative/src/qmlls/qqmllanguageserver.cpp (63ecc3a1f0ede925517bf30470c277c99541804e)