hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

uast.md: add "Using UAST in Plugins"

Browse Source
This commit is contained in:
Yann Cébron 2021-03-24 18:06:47 +01:00
parent 33db542b17
commit 5d7490eb3b
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
topics/basics/architectural_overview/uast.md
View File

@ -12,6 +12,8 @@ work the same way for all these languages.
Using UAST allows providing features that will work across all [supported JVM languages](#which-languages-are-supported) using a single implementation.
Presentation [Writing IntelliJ Plugins for Kotlin](https://www.youtube.com/watch?v=j2tvi4GbOr4) offers a thorough overview of using UAST in real-world scenarios.
### When should I use UAST?
For plugins that should work for all JVM languages in the same way.
@ -173,7 +175,7 @@ Still, consider exposing the raw `PsiElement` instead.
### UAST/PSI Tree Structure Mismatch
UAST is an abstraction level on top of PSI of different languages and tries to build a unified tree.
UAST is an abstraction level on top of PSI of different languages and tries to build a unified tree (see [Inspecting UAST Tree](#inspecting-uast-tree)).
It leads to the fact that the tree structure could seriously diverge between UAST and original language,
so no ancestor-descendant relation preserving is guaranteed.
@ -184,4 +186,22 @@ For instance, results of
generateSequence(uElement.sourcePsi) { it.parent }
```
could be different, not only in the number of elements, but also in their order.
could be different, not only in the number of elements, but also in their order.
## Using UAST in Plugins
To register extensions applicable to UAST, specify `language="UAST"` in `plugin.xml`.
### Inspecting UAST Tree
To inspect UAST Tree, invoke [internal action](enabling_internal.md) **Tools \| Internal Actions \| UAST \| Dump UAST Tree (By Each PsiElement)**.
### Inspections
Use [`AbstractBaseUastLocalInspectionTool`](upsource:///java/java-analysis-api/src/com/intellij/codeInspection/AbstractBaseUastLocalInspectionTool.java) as base class.
If inspection targets only a subset of default types (`UFile`, `UClass`, `UField`, and `UMethod`), specify `UElement`s as hints in overloaded constructor to improve performance.
### Line Marker
Use `UastUtils.getUParentForIdentifier()` or `UAnnotationUtils.getIdentifierAnnotationOwner()` for annotations to obtain suitable "identifier" element (see [Line Marker Provider](line_marker_provider.md) for details).