A PSI (Program Structure Interface) file represents a hierarchy of PSI elements (so-called PSI trees). A single PSI file (itself being a PSI element) may contain several PSI trees in specific programming languages. A PSI element, in its turn, can have child PSI elements.
PSI elements and operations at the level of individual PSI elements are used to explore the source code's internal structure as it is interpreted by the Consulo. For example, you can use PSI elements to perform code analysis, such as code inspections or intention actions.
PsiElement class is the common base class for PSI elements.
How do I get a PSI element?
- From an action:
e.getData(LangDataKeys.PSI_ELEMENT). Note: if an editor is currently open and the element under caret is a reference, this will return the result of resolving the reference. This may or may not be what you need.
- From a file by offset:
PsiFile.findElementAt(). Note: this returns the lowest level element ("leaf") at the specified offset, normally a lexer token. Most likely, you should use
PsiTreeUtil.getParentOfType()to find the element you really need.
- By iterating through a PSI file: using a
- By resolving a reference:
What can I do with PSI elements?
See PSI Cook Book