Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QLanguageServer Class Reference

Implements a server for the language server protocol. More...

#include <qlanguageserver_p.h>

Inheritance diagram for QLanguageServer:
Collaboration diagram for QLanguageServer:

Public Types

enum class  RunStatus {
  NotSetup , SettingUp , DidSetup , Initializing ,
  DidInitialize , WaitPending , Stopping , WaitingForExit ,
  Stopped
}

Public Slots

void receiveData (const QByteArray &d, bool isEndOfMessage)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void runStatusChanged (RunStatus)
void clientInitialized (QLanguageServer *server)
void shutdown ()
void exit ()
void lifecycleError ()
void readNextMessage ()
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

 QLanguageServer (const QJsonRpcTransport::DataHandler &h, QObject *parent=nullptr)
QLanguageServerProtocol * protocol ()
void finishSetup ()
void registerHandlers (QLanguageServerProtocol *protocol)
void setupCapabilities (const QLspSpecification::InitializeParams &clientInfo, QLspSpecification::InitializeResult &serverInfo)
void addServerModule (QLanguageServerModule *serverModule)
QLanguageServerModulemoduleByName (const QString &n) const
QLspNotifySignals * notifySignals ()
RunStatus runStatus () const
bool isInitialized () const
bool isRequestCanceled (const QJsonRpc::IdType &id) const
const QLspSpecification::InitializeParams & clientInfo () const
const QLspSpecification::InitializeResult & serverInfo () 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 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).
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.

Properties

RunStatus runStatus
bool isInitialized
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

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
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

Detailed Description

Implements a server for the language server protocol.

QLanguageServer is a class that uses the QLanguageServerProtocol to provide a server implementation. It handles the lifecycle management, and can be extended via QLanguageServerModule subclasses.

The language server keeps a strictly monotonically increasing runState that can be queried from any thread (and is thus mutex gated), the normal run state is DidInitialize.

The language server also keeps track of the task canceled by the client (or implicitly when shutting down, and isRequestCanceled can be called from any thread.

Definition at line 41 of file qlanguageserver_p.h.

Member Enumeration Documentation

◆ RunStatus

enum class QLanguageServer::RunStatus
strong
Enumerator
NotSetup 
SettingUp 
DidSetup 
Initializing 
DidInitialize 
WaitPending 
Stopping 
WaitingForExit 
Stopped 

Definition at line 48 of file qlanguageserver_p.h.

Constructor & Destructor Documentation

◆ QLanguageServer()

QLanguageServer::QLanguageServer ( const QJsonRpcTransport::DataHandler & h,
QObject * parent = nullptr )

Definition at line 39 of file qlanguageserver.cpp.

Member Function Documentation

◆ addServerModule()

void QLanguageServer::addServerModule ( QLanguageServerModule * serverModule)

Definition at line 93 of file qlanguageserver.cpp.

References NotSetup.

◆ clientInfo()

const QLspSpecification::InitializeParams & QLanguageServer::clientInfo ( ) const

Definition at line 213 of file qlanguageserver.cpp.

References DidInitialize, and runStatus().

Here is the call graph for this function:

◆ clientInitialized

void QLanguageServer::clientInitialized ( QLanguageServer * server)
signal

◆ exit

void QLanguageServer::exit ( )
signal

◆ finishSetup()

void QLanguageServer::finishSetup ( )

Definition at line 60 of file qlanguageserver.cpp.

References DidSetup, NotSetup, and SettingUp.

◆ isInitialized()

bool QLanguageServer::isInitialized ( ) const

Definition at line 373 of file qlanguageserver.cpp.

References DidInitialize, DidSetup, Initializing, NotSetup, runStatus(), SettingUp, Stopped, Stopping, WaitingForExit, and WaitPending.

Here is the call graph for this function:

◆ isRequestCanceled()

bool QLanguageServer::isRequestCanceled ( const QJsonRpc::IdType & id) const

Definition at line 365 of file qlanguageserver.cpp.

◆ lifecycleError

void QLanguageServer::lifecycleError ( )
signal

◆ moduleByName()

QLanguageServerModule * QLanguageServer::moduleByName ( const QString & n) const

Definition at line 118 of file qlanguageserver.cpp.

◆ notifySignals()

QLspNotifySignals * QLanguageServer::notifySignals ( )

Definition at line 125 of file qlanguageserver.cpp.

◆ protocol()

QLanguageServerProtocol * QLanguageServer::protocol ( )

Definition at line 47 of file qlanguageserver.cpp.

◆ readNextMessage

void QLanguageServer::readNextMessage ( )
signal

◆ receiveData

void QLanguageServer::receiveData ( const QByteArray & d,
bool isEndOfMessage )
slot

Definition at line 230 of file qlanguageserver.cpp.

◆ registerHandlers()

void QLanguageServer::registerHandlers ( QLanguageServerProtocol * protocol)

Definition at line 241 of file qlanguageserver.cpp.

References DidInitialize, DidSetup, and Initializing.

◆ runStatus()

QLanguageServer::RunStatus QLanguageServer::runStatus ( ) const

Definition at line 53 of file qlanguageserver.cpp.

Referenced by clientInfo(), isInitialized(), and serverInfo().

Here is the caller graph for this function:

◆ runStatusChanged

void QLanguageServer::runStatusChanged ( RunStatus )
signal

◆ serverInfo()

const QLspSpecification::InitializeResult & QLanguageServer::serverInfo ( ) const

Definition at line 222 of file qlanguageserver.cpp.

References DidInitialize, and runStatus().

Here is the call graph for this function:

◆ setupCapabilities()

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

Definition at line 205 of file qlanguageserver.cpp.

◆ shutdown

void QLanguageServer::shutdown ( )
signal

Property Documentation

◆ isInitialized

bool QLanguageServer::isInitialized
read

Definition at line 45 of file qlanguageserver_p.h.

◆ runStatus

RunStatus QLanguageServer::runStatus
read

Definition at line 44 of file qlanguageserver_p.h.


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