1 <!DOCTYPE html>
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
   3 <head>
   4   <meta charset="utf-8" />
   5   <meta name="generator" content="pandoc" />
   6   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
   7   <title>IDE support in the JDK</title>
   8   <style type="text/css">
   9       code{white-space: pre-wrap;}
  10       span.smallcaps{font-variant: small-caps;}
  11       span.underline{text-decoration: underline;}
  12       div.column{display: inline-block; vertical-align: top; width: 50%;}
  13   </style>
  14   <link rel="stylesheet" href="../make/data/docs-resources/resources/jdk-default.css" />
  15   <!--[if lt IE 9]>
  16     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  17   <![endif]-->
  18 </head>
  19 <body>
  20 <header id="title-block-header">
  21 <h1 class="title">IDE support in the JDK</h1>
  22 </header>
  23 <nav id="TOC">
  24 <ul>
  25 <li><a href="#introduction">Introduction</a><ul>
  26 <li><a href="#ide-support-for-native-code">IDE support for native code</a></li>
  27 <li><a href="#ide-support-for-java-code">IDE support for Java code</a></li>
  28 </ul></li>
  29 </ul>
  30 </nav>
  31 <h2 id="introduction">Introduction</h2>
  32 <p>When you are familiar with building and testing the JDK, you may want to configure an IDE to work with the source code. The instructions differ a bit depending on whether you are interested in working with the native (C/C++) or the Java code.</p>
  33 <h3 id="ide-support-for-native-code">IDE support for native code</h3>
  34 <p>There are a few ways to generate IDE configuration for the native sources, depending on which IDE to use.</p>
  35 <h4 id="visual-studio-code">Visual Studio Code</h4>
  36 <p>The make system can generate a <a href="https://code.visualstudio.com">Visual Studio Code</a> workspace that has C/C++ source indexing configured correctly, as well as launcher targets for tests and the Java launcher. After configuring, a workspace for the configuration can be generated using:</p>
  37 <pre class="shell"><code>make vscode-project</code></pre>
  38 <p>This creates a file called <code>jdk.code-workspace</code> in the build output folder. The full location will be printed after the workspace has been generated. To use it, choose <code>File -&gt; Open Workspace...</code> in Visual Studio Code.</p>
  39 <h5 id="alternative-indexers">Alternative indexers</h5>
  40 <p>The main <code>vscode-project</code> target configures the default C++ support in Visual Studio Code. There are also other source indexers that can be installed, that may provide additional features. It's currently possible to generate configuration for two such indexers, <a href="https://clang.llvm.org/extra/clangd/">clangd</a> and <a href="https://github.com/Andersbakken/rtags">rtags</a>. These can be configured by appending the name of the indexer to the make target, such as:</p>
  41 <pre class="shell"><code>make vscode-project-clangd</code></pre>
  42 <p>Additional instructions for configuring the given indexer will be displayed after the workspace has been generated.</p>
  43 <h4 id="visual-studio">Visual Studio</h4>
  44 <p>This section is a work in progress.</p>
  45 <pre class="shell"><code>make ide-project</code></pre>
  46 <h4 id="compilation-database">Compilation Database</h4>
  47 <p>The make system can generate generic native code indexing support in the form of a <a href="https://clang.llvm.org/docs/JSONCompilationDatabase.html">Compilation Database</a> that can be used by many different IDEs and source code indexers.</p>
  48 <pre class="shell"><code>make compile-commands</code></pre>
  49 <p>It's also possible to generate the Compilation Database for the HotSpot source code only, which is a bit faster as it includes less information.</p>
  50 <pre class="shell"><code>make compile-commands-hotspot</code></pre>
  51 <h3 id="ide-support-for-java-code">IDE support for Java code</h3>
  52 <p>This section is a work in progress.</p>
  53 </body>
  54 </html>