mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-29 17:57:53 +08:00
186 lines
12 KiB
HTML
186 lines
12 KiB
HTML
|
|
|
|
|
|
<!doctype html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>11. Find Usages Provider / IntelliJ Platform SDK DevGuide</title>
|
|
<link rel="stylesheet" href="/intellij/sdk/docs/app/css/styles.min.css">
|
|
|
|
<!-- non-retina iPad pre iOS 7 -->
|
|
<link rel="apple-touch-icon" href="/intellij/sdk/docs/apple-touch-icon-72x72.png" sizes="72x72">
|
|
|
|
<!-- retina iPhone pre iOS 7 -->
|
|
<link rel="apple-touch-icon" href="/intellij/sdk/docs/apple-touch-icon-114x114.png" sizes="114x114">
|
|
|
|
<!-- retina iPad pre iOS 7 -->
|
|
<link rel="apple-touch-icon" href="/intellij/sdk/docs/apple-touch-icon-144x144.png" sizes="144x144">
|
|
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/intellij/sdk/docs/apple-touch-icon-precomposed.png">
|
|
|
|
<!-- normal favicon -->
|
|
<link rel="shortcut icon" type="image/x-icon" href="/intellij/sdk/docs/favicon.ico">
|
|
<link rel="icon" type="image/png" href="/intellij/sdk/docs/favicon.png">
|
|
<link rel="stylesheet" href="/intellij/sdk/docs/styles/styles.css"></head>
|
|
<body data-id="tutorials/custom_language_support/find_usages_provider">
|
|
<div class="wrapper">
|
|
<section class="panel _nav">
|
|
<header class="panel__header">
|
|
<div class="container">
|
|
<form class="search-box">
|
|
<label for="search-box__input" class="search-box__label">
|
|
<input type="text" class="search-box__input" id="search-box__input" placeholder="Search IntelliJ Platform SDK DevGuide">
|
|
</label>
|
|
<div class="search-box__clear" title="Clear"></div>
|
|
</form>
|
|
</div>
|
|
</header>
|
|
<nav class="panel__content">
|
|
<div class="container _nav">
|
|
<menu class="nav-tree"></menu>
|
|
</div>
|
|
<div class="container _footer panel__footer">
|
|
<p><a href="https://youtrack.jetbrains.com/issues/IJSDK">Send feedback</a></p>
|
|
<p>© 2000–2016 <a href="//www.jetbrains.com">JetBrains</a> s.r.o.<br>
|
|
All rights reserved.</p>
|
|
</div>
|
|
</nav>
|
|
</section>
|
|
|
|
<main class="panel _main" role="main">
|
|
<header class="panel__header">
|
|
<div class="container">
|
|
<h3>IntelliJ Platform SDK DevGuide</h3>
|
|
|
|
<div class="shortcuts-switcher"><label for="switch-shortcuts">Keymap:</label><select id="switch-shortcuts" class="select _shortcuts" height="1">
|
|
<option data-group="primary" value="default" selected>Default</option>
|
|
<option data-group="primary" value="default_for_gnome">GNOME</option>
|
|
<option data-group="primary" value="default_for_kde">KDE</option>
|
|
<option data-group="primary" value="default_for_xwin">XWindow</option>
|
|
<option data-group="primary" value="emacs">Emacs</option>
|
|
<option data-group="primary" value="jbuilder">JBuilder</option>
|
|
<option data-group="primary" value="visual_studio">Visual Studio</option>
|
|
<option data-group="primary" value="netbeans_6.5">NetBeans 6.5</option>
|
|
<option data-group="primary" value="eclipse">Eclipse</option>
|
|
<option data-group="secondary" value="mac_os_x_10.5_">OS X 10.5+</option>
|
|
<option data-group="secondary" value="mac_os_x">OS X</option>
|
|
<option data-group="secondary" value="eclipse_mac_os_x">OS X Eclipse</option></select>
|
|
</div>
|
|
|
|
<div class="panel-trigger"></div>
|
|
</div>
|
|
</header>
|
|
<section class="panel__content">
|
|
<div class="container">
|
|
<article class="article" data-shortcut-switcher="false">
|
|
|
|
<h1>11. Find Usages Provider</h1>
|
|
<p>A find usage provider uses a word scanner to build an index of words present in every file.
|
|
A scanner breaks the text into words, defines the context for each word and passes it to the find usage provider.</p>
|
|
|
|
<a name="define-a-find-usages-provider" class="elem-anchor"></a>
|
|
<h3>11.1. Define a find usages provider<a href="#define-a-find-usages-provider" class="anchor-link"><span></span></a></h3>
|
|
|
|
<pre><code class="code-block__wrapper code-block _highlighted lang_java"><span class="kn">package</span> <span class="n">com</span><span class="o">.</span><span class="na">simpleplugin</span><span class="o">;</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">com.intellij.lang.cacheBuilder.DefaultWordsScanner</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">com.intellij.lang.cacheBuilder.WordsScanner</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">com.intellij.lang.findUsages.FindUsagesProvider</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">com.intellij.psi.PsiElement</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">com.intellij.psi.PsiNamedElement</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">com.intellij.psi.tree.TokenSet</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">com.simpleplugin.psi.SimpleProperty</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">com.simpleplugin.psi.SimpleTypes</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">org.jetbrains.annotations.NotNull</span><span class="o">;</span>
|
|
<span class="kn">import</span> <span class="nn">org.jetbrains.annotations.Nullable</span><span class="o">;</span>
|
|
|
|
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">SimpleFindUsagesProvider</span> <span class="kd">implements</span> <span class="n">FindUsagesProvider</span> <span class="o">{</span>
|
|
<span class="nd">@Nullable</span>
|
|
<span class="nd">@Override</span>
|
|
<span class="kd">public</span> <span class="n">WordsScanner</span> <span class="nf">getWordsScanner</span><span class="o">()</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="k">new</span> <span class="nf">DefaultWordsScanner</span><span class="o">(</span><span class="k">new</span> <span class="n">SimpleLexerAdapter</span><span class="o">(),</span>
|
|
<span class="n">TokenSet</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">SimpleTypes</span><span class="o">.</span><span class="na">KEY</span><span class="o">),</span> <span class="n">TokenSet</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">SimpleTypes</span><span class="o">.</span><span class="na">COMMENT</span><span class="o">),</span> <span class="n">TokenSet</span><span class="o">.</span><span class="na">EMPTY</span><span class="o">);</span>
|
|
<span class="o">}</span>
|
|
|
|
<span class="nd">@Override</span>
|
|
<span class="kd">public</span> <span class="kt">boolean</span> <span class="nf">canFindUsagesFor</span><span class="o">(</span><span class="nd">@NotNull</span> <span class="n">PsiElement</span> <span class="n">psiElement</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="n">psiElement</span> <span class="k">instanceof</span> <span class="n">PsiNamedElement</span><span class="o">;</span>
|
|
<span class="o">}</span>
|
|
|
|
<span class="nd">@Nullable</span>
|
|
<span class="nd">@Override</span>
|
|
<span class="kd">public</span> <span class="n">String</span> <span class="nf">getHelpId</span><span class="o">(</span><span class="nd">@NotNull</span> <span class="n">PsiElement</span> <span class="n">psiElement</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="kc">null</span><span class="o">;</span>
|
|
<span class="o">}</span>
|
|
|
|
<span class="nd">@NotNull</span>
|
|
<span class="nd">@Override</span>
|
|
<span class="kd">public</span> <span class="n">String</span> <span class="nf">getType</span><span class="o">(</span><span class="nd">@NotNull</span> <span class="n">PsiElement</span> <span class="n">element</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">if</span> <span class="o">(</span><span class="n">element</span> <span class="k">instanceof</span> <span class="n">SimpleProperty</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="s">"simple property"</span><span class="o">;</span>
|
|
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="s">""</span><span class="o">;</span>
|
|
<span class="o">}</span>
|
|
<span class="o">}</span>
|
|
|
|
<span class="nd">@NotNull</span>
|
|
<span class="nd">@Override</span>
|
|
<span class="kd">public</span> <span class="n">String</span> <span class="nf">getDescriptiveName</span><span class="o">(</span><span class="nd">@NotNull</span> <span class="n">PsiElement</span> <span class="n">element</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">if</span> <span class="o">(</span><span class="n">element</span> <span class="k">instanceof</span> <span class="n">SimpleProperty</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="o">((</span><span class="n">SimpleProperty</span><span class="o">)</span> <span class="n">element</span><span class="o">).</span><span class="na">getKey</span><span class="o">();</span>
|
|
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="s">""</span><span class="o">;</span>
|
|
<span class="o">}</span>
|
|
<span class="o">}</span>
|
|
|
|
<span class="nd">@NotNull</span>
|
|
<span class="nd">@Override</span>
|
|
<span class="kd">public</span> <span class="n">String</span> <span class="nf">getNodeText</span><span class="o">(</span><span class="nd">@NotNull</span> <span class="n">PsiElement</span> <span class="n">element</span><span class="o">,</span> <span class="kt">boolean</span> <span class="n">useFullName</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">if</span> <span class="o">(</span><span class="n">element</span> <span class="k">instanceof</span> <span class="n">SimpleProperty</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="o">((</span><span class="n">SimpleProperty</span><span class="o">)</span> <span class="n">element</span><span class="o">).</span><span class="na">getKey</span><span class="o">()</span> <span class="o">+</span> <span class="s">":"</span> <span class="o">+</span> <span class="o">((</span><span class="n">SimpleProperty</span><span class="o">)</span> <span class="n">element</span><span class="o">).</span><span class="na">getValue</span><span class="o">();</span>
|
|
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="s">""</span><span class="o">;</span>
|
|
<span class="o">}</span>
|
|
<span class="o">}</span>
|
|
<span class="o">}</span>
|
|
|
|
</code></pre>
|
|
|
|
<a name="register-the-find-usages-provider" class="elem-anchor"></a>
|
|
<h3>11.2. Register the find usages provider<a href="#register-the-find-usages-provider" class="anchor-link"><span></span></a></h3>
|
|
|
|
<pre><code class="code-block__wrapper code-block _highlighted lang_xml"><span class="nt"><lang.findUsagesProvider</span> <span class="na">language=</span><span class="s">"Simple"</span> <span class="na">implementationClass=</span><span class="s">"com.simpleplugin.SimpleFindUsagesProvider"</span><span class="nt">/></span>
|
|
</code></pre>
|
|
|
|
<a name="run-the-project" class="elem-anchor"></a>
|
|
<h3>11.3. Run the project<a href="#run-the-project" class="anchor-link"><span></span></a></h3>
|
|
|
|
<p>Now we can call <em>Find Usages</em> for any property with a reference.</p>
|
|
|
|
<p><img src="img/find_usages.png" alt="Find Usages" /></p>
|
|
|
|
<p><a href="reference_contributor.html"><span>Previous</span></a>
|
|
<a href="/intellij/sdk/docs/tutorials/custom_language_support_tutorial.html"><span>Top</span></a>
|
|
<a href="folding_builder.html"><span>Next</span></a></p>
|
|
|
|
|
|
<div class="last-modified">
|
|
Last modified: 28 December 2015
|
|
</div>
|
|
</article>
|
|
|
|
<section class="disqus">
|
|
<div id="disqus_thread"></div>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</main>
|
|
</div>
|
|
|
|
|
|
<script data-main="/intellij/sdk/docs/app/js/main.build" data-baseurl="/intellij/sdk/docs/" src="/intellij/sdk/docs/app/js/vendor/requirejs/require.js"></script>
|
|
|
|
</body>
|
|
</html>
|
|
|