\inmodule QtQmlCompiler More...

#include <qqmlsa.h>

Collaboration diagram for QQmlSA::PassManager:

Public Member Functions
void	registerElementPass (std::unique_ptr< ElementPass > pass)
	Registers a static analysis pass to be run on all elements.
bool	registerPropertyPass (std::shared_ptr< PropertyPass > pass, QAnyStringView moduleName, QAnyStringView typeName, QAnyStringView propertyName=QAnyStringView(), bool allowInheritance=true)
	Registers a static analysis pass for properties.
void	analyze (const Element &root)
	Runs the element passes over root and all its children.
bool	hasImportedModule (QAnyStringView name) const
	Returns `true` if the module named module has been imported by the QML to be analyzed, `false` otherwise.
bool	isCategoryEnabled (LoggerWarningId category) const
	Returns `true` if warnings of category are enabled, `false` otherwise.
std::unordered_map< quint32, Binding >	bindingsByLocation () const
	Returns bindings by their source location.

Detailed Description

\inmodule QtQmlCompiler

Can analyze an element and its children with static analysis passes.

Definition at line 313 of file qqmlsa.h.

Member Function Documentation

◆ analyze()

void QQmlSA::PassManager::analyze ( const Element & root )

Runs the element passes over root and all its children.

Definition at line 1600 of file qqmlsa.cpp.

◆ bindingsByLocation()

std::unordered_map< quint32, Binding > QQmlSA::PassManager::bindingsByLocation ( ) const

Returns bindings by their source location.

Definition at line 2004 of file qqmlsa.cpp.

◆ hasImportedModule()

bool QQmlSA::PassManager::hasImportedModule ( QAnyStringView module ) const

Returns true if the module named module has been imported by the QML to be analyzed, false otherwise.

This can be used to skip registering a pass which is specific to a specific module.

if (passManager->hasImportedModule("QtPositioning"))
    passManager->registerElementPass(
       std::make_unique<PositioningPass>(passManager)
    );

See also: registerPropertyPass(), registerElementPass()

Definition at line 1703 of file qqmlsa.cpp.

◆ isCategoryEnabled()

bool QQmlSA::PassManager::isCategoryEnabled ( LoggerWarningId category ) const

Returns true if warnings of category are enabled, false otherwise.

Definition at line 1711 of file qqmlsa.cpp.

◆ registerElementPass()

void QQmlSA::PassManager::registerElementPass ( std::unique_ptr< ElementPass > pass )

Registers a static analysis pass to be run on all elements.

Definition at line 1434 of file qqmlsa.cpp.

◆ registerPropertyPass()

bool QQmlSA::PassManager::registerPropertyPass	(	std::shared_ptr< PropertyPass >	pass,
		QAnyStringView	moduleName,
		QAnyStringView	typeName,
		QAnyStringView	propertyName = QAnyStringView(),
		bool	allowInheritance = true )

Registers a static analysis pass for properties.

The pass will be run on every property matching the moduleName, typeName and propertyName.

Omitting the propertyName will register this pass for all properties matching the typeName and moduleName.

Setting allowInheritance to true means that the filtering on the type also accepts types deriving from typeName.

pass is passed as a {std::shared_ptr} to allow reusing the same pass on multiple elements:

auto titleValiadorPass = std::make_shared<TitleValidatorPass>(manager);
manager->registerPropertyPass(titleValidatorPass,
                              "QtQuick", "Window", "title");
manager->registerPropertyPass(titleValidatorPass,
                              "QtQuick.Controls", "Dialog", "title");

Note: Running analysis passes on too many items can be expensive. This is why it is generally good to filter down the set of properties of a pass using the moduleName, typeName and propertyName.

Returns true if the pass was successfully added, false otherwise. Adding a pass fails when the \l{QQmlSA::Element}{Element} specified by moduleName and typeName does not exist.

See also: PropertyPass

Definition at line 1503 of file qqmlsa.cpp.

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

qtdeclarative/src/qmlcompiler/qqmlsa.h (2e4c66160f0cfbc76b0154d8b989f8931b1963bf)
qtdeclarative/src/qmlcompiler/qqmlsa.cpp (ecf78f31908edfd343e9447cfe4ac0b53cbabd18)

Public Member Functions