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

[md] Indexing intro: lang style + formatting

Browse Source
This commit is contained in:
Anna Bulenkova 2015-04-15 11:45:36 +02:00
parent f13152a05d
commit 022a871d7a
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_SUMMARY.md
View File

@ -34,6 +34,7 @@
* [PSI Cookbook](psi_cookbook.html)
* [Virtual File System](virtual_file_system.html)
* [Indexing and PSI Stubs](indexing_and_psi_stubs.html)
* [Run Configurations](run_configurations.html)
* [Testing Plugins](testing_plugins.html)
* [Advanced Topics](advanced_topics.html)

14
indexing_and_psi_stubs.md
View File

@ -5,9 +5,19 @@ title: Indexing and PSI Stubs
## Introduction
The indexing framework provides a quick way to locate certain elements (for example, files containing a certain word or methods with a particular name) in large code bases. Plugin developers can use the existing indexes built by the IDE itself, as well as build and use their own indexes.
The indexing framework provides a quick way to locate certain elements, e.g. files containing a certain word or methods with a particular name, in large code bases.
Plugin developers can use the existing indexes built by the IDE itself, as well as build and use their own indexes.
It supports two main types of indexes: *file-based indexes* and *stub indexes*. File-based indexes are built directly over the content of files, and 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 certain condition, and 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.
It supports two main types of indexes:
* *File-based indexes*
* *Stub 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 certain 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.
## File-based Indexes