IntelliJ Platform SDK DevGuide

Edit page

Indexing and PSI Stubs

Indices

The indexing framework provides a quick way to locate specific elements, e.g., files containing a certain word or methods with a particular name, in large codebases. Plugin developers can use the existing indexes built by the IDE itself and build and use their own indexes.

It supports two main types of indexes:

File-based indexes are built directly over the content of files. Stub indexes are built over serialized stub trees. A stub tree for a source file is a subset of its PSI tree, which contains only externally visible declarations and is serialized in a compact binary format.

Querying a file-based index gets you the set of files matching a specific condition. Querying a stub index gets you the set of matching PSI elements. Therefore, custom language plugin developers should typically use stub indexes in their plugin implementations.

Dumb Mode

Indexing is a potentially lengthy process. It’s performed in the background, and during this time, IDE’s features are restricted to the ones that don’t require index: basic text editing, version control, etc. This restriction is managed by DumbService. Violations are reported via IndexNotReadyException, please see its javadoc on how to adapt callers.

DumbService provides API to query whether the IDE is currently in “dumb” mode (where index access is not allowed) or “smart” mode (with all index built and ready to use). It also provides ways of delaying code execution until indices are ready. Please see its JavaDoc for more details.

Gists

Sometimes, the following conditions hold:

  • the aggregation functionality of file-based indices is not needed. One just needs to calculate some data based on a particular file’s contents and cache it on disk.
  • eagerly calculating the data for the entire project during indexing isn’t needed (e.g., it slows down the indexing, and/or this data probably will ever be required for a minor subset of all project files).
  • the data can be recalculated lazily on request without significant performance penalties.

A file-based index can be used in such cases, but file gists provide a way to perform data calculation lazily, caching on disk, and a more lightweight API. Please see VirtualFileGist and PsiFileGist documentation.

Example:

  • ImageInfoIndex calculating image dimensions/bit depth needed to be displayed in specific parts of UI.
Last modified: 4 November 2020