Base class for all static analysis passes on elements. 更多...
头: | #include <ElementPass> |
CMake: |
find_package(Qt6 REQUIRED COMPONENTS QmlCompiler)
target_link_libraries(mytarget PRIVATE Qt6::QmlCompiler) |
继承: | QQmlSA::GenericPass |
状态: | 技术预览 |
virtual void | run (const QQmlSA::Element & element ) = 0 |
virtual bool | shouldRun (const QQmlSA::Element & element ) |
ElementPass is the simpler of the two analysis passes. It will consider every element in a file. The shouldRun () method can be used to filter out irrelevant elements, and the run () method is doing the initial work.
Common tasks suitable for an ElementPass are
Layout
).
As shown in the snippet below, it is recommended to do necessary type resolution in the constructor of the ElementPass and cache it in local members, and to implement some filtering via shouldRun () to keep the static analysis performant.
using namespace QQmlSA; class MyElementPass : public ElementPass { Element myType; public: MyElementPass(QQmlSA::PassManager *manager) : myType(resolveType("MyModule", "MyType")) {} bool shouldRun(const Element &element) override { return element.inherits(myType); } void run(const Element &element) override { // actual pass logic } }
ElementPasses have limited insight into how an element's properties are used. If you need that information, consider using a PropertyPass 代替。
注意: ElementPass will only ever consider instantiable types. Therefore, it is unsuitable to analyze attached types and singletons. Those need to be handled via a PropertyPass .
[pure virtual]
void
ElementPass::
run
(const
QQmlSA::Element
&
element
)
Executes if
shouldRun()
返回
true
. Performs the real computation of the pass on
element
. This method is meant to be overridden. Calling the base method is not necessary.
[虚拟]
bool
ElementPass::
shouldRun
(const
QQmlSA::Element
&
element
)
Controls whether the
run()
function should be executed on the given
element
. Subclasses can override this method to improve performance of the analysis by filtering out elements which are not relevant.
The default implementation unconditionally returns
true
.