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
QmlLsp Namespace Reference

Classes

class  AbstractReader
class  StdinReader
class  FileReader
class  QProcessScheduler
 Runs multiple processes sequentially via a QProcess, and signals once they are done. More...
class  OpenDocumentSnapshot
class  OpenDocument
struct  RegisteredSemanticTokens
struct  ModuleSetting
class  QQmllsBuildInformation
class  QQmlCodeModel
struct  QQmlWorkspace
class  QQmlCodeModelManager
class  QQmlLanguageServer
 Sets up a QmlLanguageServer. More...
struct  LastLintUpdate
class  QmlLintSuggestions

Typedefs

using ModuleSettings = QList<ModuleSetting>
using AdvanceFunc = qxp::function_ref<void(const QQmlJS::SourceLocation &, Position &)>

Enumerations

enum  VersionCheckResult {
  ClosedDocument , VersionLowerThanDocument , VersionLowerThanSnapshot , VersionOk ,
  ClosedDocument , VersionLowerThanDocument , VersionLowerThanSnapshot , VersionOk
}
enum  VersionCheckResultForValidDocument { VersionLowerThanValidSnapshot , VersionOkForValidDocument , VersionLowerThanValidSnapshot , VersionOkForValidDocument }
enum  UpdatePolicy { NormalUpdate , ForceUpdate }
enum  VersionCheckResult {
  ClosedDocument , VersionLowerThanDocument , VersionLowerThanSnapshot , VersionOk ,
  ClosedDocument , VersionLowerThanDocument , VersionLowerThanSnapshot , VersionOk
}
enum  VersionCheckResultForValidDocument { VersionLowerThanValidSnapshot , VersionOkForValidDocument , VersionLowerThanValidSnapshot , VersionOkForValidDocument }

Functions

static QStringList collectImportPaths (const QCommandLineParser &parser, const QCommandLineOption &qmlImportPathOption, const QCommandLineOption &environmentOption, const QCommandLineOption &qmlImportNoDefault)
static int cmakeJobs (const QCommandLineParser &parser, const QCommandLineOption &cmakeJobsOption)
static bool prepareCMakeFeature (const QCommandLineParser &parser, const QCommandLineOption &noCMakeCallsOption)
int qmllsMain (int argv, char *argc[])
static QT_WARNING_POP bool isStartMarkerOf (const QProcessScheduler::QueueElement &e, const QProcessScheduler::Id &id)
static bool isEndMarkerOf (const QProcessScheduler::QueueElement &e, const QProcessScheduler::Id &id)
static int cmakeJobsFromSettings (QQmlToolingSharedSettings *settings, const QString &rootPath, int defaultValue)
VersionCheckResult checkVersion (const OpenDocument &doc, int version)
static VersionCheckResultForValidDocument checkVersionForValidDocument (const OpenDocument &doc, int version)
static void updateItemInSnapshot (const DomItem &item, const DomItem &validItem, const QByteArray &url, OpenDocument *doc, int version, UpdatePolicy policy)
static QStringList withDependentBuildDirectories (QStringList &&buildPaths)
static ModuleSetting * moduleSettingFor (const QString &sourceFolder, ModuleSettings *moduleSettings, UpdatePolicy policy)
static QStringList asStringList (const QVariant &variant)
static void handleArrayStartingAt0 (QSettings *settings, ModuleSettings *moduleSettings, UpdatePolicy policy)
static void loadWorkspacesV2 (QSettings *settings, ModuleSettings *moduleSettings, UpdatePolicy policy)
static DiagnosticSeverity severityFromMsgType (QtMsgType t)
static void codeActionHandler (const QByteArray &, const CodeActionParams &params, LSPPartialResponse< std::variant< QList< std::variant< Command, CodeAction > >, std::nullptr_t >, QList< std::variant< Command, CodeAction > > > &&response)
static void advancePositionPastLocation_helper (const QString &fileContents, const QQmlJS::SourceLocation &location, Position &position)
static Diagnostic createMissingBuildDirDiagnostic ()
static Diagnostic messageToDiagnostic_helper (AdvanceFunc advancePositionPastLocation, std::optional< int > version, const Message &message)
static bool isSnapshotNew (std::optional< int > snapshotVersion, std::optional< int > processedVersion, QmlLsp::UpdatePolicy policy)

Variables

QFile * logFile = nullptr
QBasicMutex * logFileLock = nullptr

Typedef Documentation

◆ AdvanceFunc

typedef qxp::function_ref< void(const QQmlJS::SourceLocation &, Position &)> QmlLsp::AdvanceFunc = qxp::function_ref<void(const QQmlJS::SourceLocation &, Position &)>

Definition at line 155 of file qqmllintsuggestions.cpp.

◆ ModuleSettings

using QmlLsp::ModuleSettings = QList<ModuleSetting>

Definition at line 102 of file qqmlcodemodel_p.h.

Enumeration Type Documentation

◆ UpdatePolicy

enum QmlLsp::UpdatePolicy
Enumerator
NormalUpdate 
ForceUpdate 

Definition at line 100 of file qqmlcodemodel_p.h.

◆ VersionCheckResult [1/2]

enum QmlLsp::VersionCheckResult
Enumerator
ClosedDocument 
VersionLowerThanDocument 
VersionLowerThanSnapshot 
VersionOk 
ClosedDocument 
VersionLowerThanDocument 
VersionLowerThanSnapshot 
VersionOk 

Definition at line 478 of file qqmlcodemodel.cpp.

◆ VersionCheckResult [2/2]

enum QmlLsp::VersionCheckResult
Enumerator
ClosedDocument 
VersionLowerThanDocument 
VersionLowerThanSnapshot 
VersionOk 
ClosedDocument 
VersionLowerThanDocument 
VersionLowerThanSnapshot 
VersionOk 

Definition at line 478 of file qqmlcodemodel.cpp.

◆ VersionCheckResultForValidDocument [1/2]

enum QmlLsp::VersionCheckResultForValidDocument
Enumerator
VersionLowerThanValidSnapshot 
VersionOkForValidDocument 
VersionLowerThanValidSnapshot 
VersionOkForValidDocument 

Definition at line 485 of file qqmlcodemodel.cpp.

◆ VersionCheckResultForValidDocument [2/2]

enum QmlLsp::VersionCheckResultForValidDocument
Enumerator
VersionLowerThanValidSnapshot 
VersionOkForValidDocument 
VersionLowerThanValidSnapshot 
VersionOkForValidDocument 

Definition at line 485 of file qqmlcodemodel.cpp.

Function Documentation

◆ advancePositionPastLocation_helper()

void QmlLsp::advancePositionPastLocation_helper ( const QString & fileContents,
const QQmlJS::SourceLocation & location,
Position & position )
static

Definition at line 116 of file qqmllintsuggestions.cpp.

◆ asStringList()

QStringList QmlLsp::asStringList ( const QVariant & variant)
static

Definition at line 815 of file qqmlcodemodel.cpp.

◆ checkVersion()

VersionCheckResult QmlLsp::checkVersion ( const OpenDocument & doc,
int version )

Definition at line 490 of file qqmlcodemodel.cpp.

References ClosedDocument, VersionLowerThanDocument, VersionLowerThanSnapshot, and VersionOk.

Referenced by updateItemInSnapshot().

Here is the caller graph for this function:

◆ checkVersionForValidDocument()

VersionCheckResultForValidDocument QmlLsp::checkVersionForValidDocument ( const OpenDocument & doc,
int version )
static

Definition at line 507 of file qqmlcodemodel.cpp.

References VersionLowerThanValidSnapshot, and VersionOkForValidDocument.

Referenced by updateItemInSnapshot().

Here is the caller graph for this function:

◆ cmakeJobs()

int QmlLsp::cmakeJobs ( const QCommandLineParser & parser,
const QCommandLineOption & cmakeJobsOption )
static

Definition at line 224 of file qmllsmain.cpp.

◆ cmakeJobsFromSettings()

int QmlLsp::cmakeJobsFromSettings ( QQmlToolingSharedSettings * settings,
const QString & rootPath,
int defaultValue )
static

Definition at line 327 of file qqmlcodemodel.cpp.

◆ codeActionHandler()

void QmlLsp::codeActionHandler ( const QByteArray & ,
const CodeActionParams & params,
LSPPartialResponse< std::variant< QList< std::variant< Command, CodeAction > >, std::nullptr_t >, QList< std::variant< Command, CodeAction > > > && response )
static

Definition at line 47 of file qqmllintsuggestions.cpp.

◆ collectImportPaths()

QStringList QmlLsp::collectImportPaths ( const QCommandLineParser & parser,
const QCommandLineOption & qmlImportPathOption,
const QCommandLineOption & environmentOption,
const QCommandLineOption & qmlImportNoDefault )
static

Definition at line 183 of file qmllsmain.cpp.

◆ createMissingBuildDirDiagnostic()

Diagnostic QmlLsp::createMissingBuildDirDiagnostic ( )
static

Definition at line 136 of file qqmllintsuggestions.cpp.

◆ handleArrayStartingAt0()

void QmlLsp::handleArrayStartingAt0 ( QSettings * settings,
ModuleSettings * moduleSettings,
UpdatePolicy policy )
static

Definition at line 821 of file qqmlcodemodel.cpp.

◆ isEndMarkerOf()

bool QmlLsp::isEndMarkerOf ( const QProcessScheduler::QueueElement & e,
const QProcessScheduler::Id & id )
static

Definition at line 71 of file qprocessscheduler.cpp.

◆ isSnapshotNew()

bool QmlLsp::isSnapshotNew ( std::optional< int > snapshotVersion,
std::optional< int > processedVersion,
QmlLsp::UpdatePolicy policy )
static

Definition at line 221 of file qqmllintsuggestions.cpp.

◆ isStartMarkerOf()

QT_WARNING_POP bool QmlLsp::isStartMarkerOf ( const QProcessScheduler::QueueElement & e,
const QProcessScheduler::Id & id )
static

Definition at line 62 of file qprocessscheduler.cpp.

◆ loadWorkspacesV2()

void QmlLsp::loadWorkspacesV2 ( QSettings * settings,
ModuleSettings * moduleSettings,
UpdatePolicy policy )
static

Definition at line 834 of file qqmlcodemodel.cpp.

◆ messageToDiagnostic_helper()

Diagnostic QmlLsp::messageToDiagnostic_helper ( AdvanceFunc advancePositionPastLocation,
std::optional< int > version,
const Message & message )
static

Definition at line 156 of file qqmllintsuggestions.cpp.

◆ moduleSettingFor()

ModuleSetting * QmlLsp::moduleSettingFor ( const QString & sourceFolder,
ModuleSettings * moduleSettings,
UpdatePolicy policy )
static

Definition at line 801 of file qqmlcodemodel.cpp.

References ForceUpdate.

◆ prepareCMakeFeature()

bool QmlLsp::prepareCMakeFeature ( const QCommandLineParser & parser,
const QCommandLineOption & noCMakeCallsOption )
static

Definition at line 263 of file qmllsmain.cpp.

◆ qmllsMain()

int QmlLsp::qmllsMain ( int argv,
char * argc[] )

Definition at line 301 of file qmllsmain.cpp.

References logFile, and logFileLock.

◆ severityFromMsgType()

DiagnosticSeverity QmlLsp::severityFromMsgType ( QtMsgType t)
static

Definition at line 31 of file qqmllintsuggestions.cpp.

◆ updateItemInSnapshot()

void QmlLsp::updateItemInSnapshot ( const DomItem & item,
const DomItem & validItem,
const QByteArray & url,
OpenDocument * doc,
int version,
UpdatePolicy policy )
static

Definition at line 516 of file qqmlcodemodel.cpp.

References checkVersion(), checkVersionForValidDocument(), ForceUpdate, VersionOk, and VersionOkForValidDocument.

Here is the call graph for this function:

◆ withDependentBuildDirectories()

QStringList QmlLsp::withDependentBuildDirectories ( QStringList && buildPaths)
static

Definition at line 676 of file qqmlcodemodel.cpp.

Variable Documentation

◆ logFile

QFile * QmlLsp::logFile = nullptr

Definition at line 52 of file qmllsmain.cpp.

Referenced by qmllsMain().

◆ logFileLock

QBasicMutex * QmlLsp::logFileLock = nullptr

Definition at line 53 of file qmllsmain.cpp.

Referenced by qmllsMain().