QQmlJSLinter Class Reference

#include <qqmljslinter_p.h>

Collaboration diagram for QQmlJSLinter:

Classes
class	Plugin
struct	Result

Public Types
enum	LintResult {   FailedToOpen , FailedToParse , HasWarnings , HasErrors ,   LintSuccess }
enum	LintOption : quint8 { Silent = 1 , GenerateJson = 2 }
enum	FixResult { NothingToFix , FixError , FixSuccess }

Public Member Functions
	QQmlJSLinter (const QStringList &importPaths, const QStringList &extraPluginPaths={}, bool useAbsolutePath=false)
	Q_DECLARE_FLAGS (LintOptions, LintOption)
Result	lintFileInBatch (const QString &filename)
bool	prepareFileForBatchLinting (const QString &filename, const QString *fileContents, LintOptions options, const QStringList &qmlImportPaths, const QStringList &qmldirFiles, const QStringList &resourceFiles, const QList< QQmlJS::LoggerCategory > &categories)
Result	lintModule (const QString &uri, LintOptions options, const QStringList &qmlImportPaths, const QStringList &resourceFiles)
std::vector< Plugin > &	plugins ()
void	setPlugins (std::vector< Plugin > plugins)
void	setPluginsEnabled (bool enablePlugins)
bool	pluginsEnabled () const
bool	useAbsolutePath () const
void	clearCache ()

Static Public Member Functions
static std::vector< Plugin >	loadPlugins (QStringList paths)
static FixResult	applyFixes (const QQmlJSLogger *logger, QString *fixedCode, bool silent)

Protected Attributes
QQmlJSImporter	m_importer

Detailed Description

Definition at line 44 of file qqmljslinter_p.h.

Member Enumeration Documentation

FixResult

enum QQmlJSLinter::FixResult

Enumerator
NothingToFix
FixError
FixSuccess

Definition at line 56 of file qqmljslinter_p.h.

LintOption

enum QQmlJSLinter::LintOption : quint8

Enumerator
Silent
GenerateJson

Definition at line 51 of file qqmljslinter_p.h.

LintResult

enum QQmlJSLinter::LintResult

Enumerator
FailedToOpen
FailedToParse
HasWarnings
HasErrors
LintSuccess

Definition at line 50 of file qqmljslinter_p.h.

Constructor & Destructor Documentation

QQmlJSLinter()

QQmlJSLinter::QQmlJSLinter	(	const QStringList &	importPaths,
		const QStringList &	extraPluginPaths = {},
		bool	useAbsolutePath = false )

Definition at line 144 of file qqmljslinter.cpp.

References QQmlJSLinter().

Referenced by QQmlJSLinter().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

applyFixes()

QQmlJSLinter::FixResult QQmlJSLinter::applyFixes ( const QQmlJSLogger * logger, QString * fixedCode, bool silent )

static

Definition at line 1020 of file qqmljslinter.cpp.

References FixError, FixSuccess, and NothingToFix.

clearCache()

void QQmlJSLinter::clearCache ( )

inline

Definition at line 147 of file qqmljslinter_p.h.

lintFileInBatch()

QQmlJSLinter::Result QQmlJSLinter::lintFileInBatch

(

const QString &

filename

)

Definition at line 598 of file qqmljslinter.cpp.

References FailedToOpen, and GenerateJson.

lintModule()

QQmlJSLinter::Result QQmlJSLinter::lintModule	(	const QString &	uri,
		LintOptions	options,
		const QStringList &	qmlImportPaths,
		const QStringList &	resourceFiles )

Definition at line 852 of file qqmljslinter.cpp.

References GenerateJson, LintSuccess, and QQmlJSLinter::Result::status.

loadPlugins()

std::vector< QQmlJSLinter::Plugin > QQmlJSLinter::loadPlugins ( QStringList paths )

static

Definition at line 288 of file qqmljslinter.cpp.

plugins()

std::vector< Plugin > & QQmlJSLinter::plugins ( )

inline

Definition at line 137 of file qqmljslinter_p.h.

pluginsEnabled()

bool QQmlJSLinter::pluginsEnabled ( ) const

inline

Definition at line 144 of file qqmljslinter_p.h.

prepareFileForBatchLinting()

bool QQmlJSLinter::prepareFileForBatchLinting	(	const QString &	dirtyFilename,
		const QString *	fileContents,
		LintOptions	options,
		const QStringList &	qmlImportPaths,
		const QStringList &	qmldirFiles,
		const QStringList &	resourceFiles,
		const QList< QQmlJS::LoggerCategory > &	categories )

Returns false on already-populated files.

Set up the scope of a file to lazy-load via LinterVisitor. Returns true on success and false if the scope already was populated. Retrieve lint results via QQmlJSLinter::lintFileInBatch().

Definition at line 536 of file qqmljslinter.cpp.

Q_DECLARE_FLAGS()

QQmlJSLinter::Q_DECLARE_FLAGS	(	LintOptions	,
		LintOption	)

setPlugins()

void QQmlJSLinter::setPlugins ( std::vector< Plugin > plugins )

inline

Definition at line 141 of file qqmljslinter_p.h.

setPluginsEnabled()

void QQmlJSLinter::setPluginsEnabled ( bool enablePlugins )

inline

Definition at line 143 of file qqmljslinter_p.h.

useAbsolutePath()

bool QQmlJSLinter::useAbsolutePath ( ) const

inline

Definition at line 145 of file qqmljslinter_p.h.

Member Data Documentation

m_importer

QQmlJSImporter QQmlJSLinter::m_importer

protected

Definition at line 163 of file qqmljslinter_p.h.

---

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

• qtdeclarative/src/qmllint/qqmljslinter_p.h (f88681d820caf542ee6ef385bf51dc7894b97af3)
• qtdeclarative/src/qmllint/qqmljslinter.cpp (f88681d820caf542ee6ef385bf51dc7894b97af3)