mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-08-01 21:19:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0686a3c470084216efbe9fdc83841eefeeb4e01f
Nim/compiler/idetools.html
github-actions[bot] 0686a3c470 Deploy to GitHub pages
2026-07-22 18:32:37 +00:00

132 lines
14 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>idetools</title>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
<div class="document" id="documentId">
<input type="checkbox" id="nav-toggle" hidden>
<label for="nav-toggle" id="nav-burger">&#9776;</label>
<label for="nav-toggle" id="nav-overlay"></label>
<div class="container">
<h1 class="title">idetools</h1>
<div class="row">
<div class="three columns">
<div class="theme-select-wrapper">
<label for="theme-select">Theme:&nbsp;</label>
<select id="theme-select" onchange="setTheme(this.value)">
<option value="auto">🌗 Match OS</option>
<option value="dark">🌑 Dark</option>
<option value="light">🌕 Light</option>
</select>
</div>
<div id="global-links">
<ul class="simple">
<li><a id="indexLink" href="theindex.html">Index</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput" oninput="search()"/>
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">runIdeQuery
<li><a class="reference" href="#runIdeQuery%2CConfigRef" title="runIdeQuery(conf: ConfigRef)">runIdeQuery(conf: ConfigRef)</a></li>
</ul>
</ul>
</details>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<a href="https://github.com/nim-lang/Nim/tree/devel/compiler/idetools.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/compiler/idetools.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc"><p>NIF-based goto-definition / find-all-usages for <tt class="docutils literal"><span class="pre"><span class="Identifier">nim</span> <span class="Identifier">track</span></span></tt>.</p>
<p>This is the mainline-Nim port of nimony's <tt class="docutils literal"><span class="pre"><span class="Identifier">idetools</span><span class="Operator">.</span><span class="Identifier">nim</span></span></tt>. It answers a <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">def</span><span class="Punctuation">:</span><span class="Identifier">FILE</span><span class="Punctuation">,</span><span class="Identifier">LINE</span><span class="Punctuation">,</span><span class="Identifier">COL</span></span></tt> / <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">usages</span><span class="Punctuation">:</span><span class="Identifier">FILE</span><span class="Punctuation">,</span><span class="Identifier">LINE</span><span class="Punctuation">,</span><span class="Identifier">COL</span></span></tt> query by <em>scanning the `.s.bif` files</em> (binary NIF, see <tt class="docutils literal"><span class="pre"><span class="Identifier">dist</span><span class="Operator">/</span><span class="Identifier">nimony</span><span class="Operator">/</span><span class="Identifier">src</span><span class="Operator">/</span><span class="Identifier">lib</span><span class="Operator">/</span><span class="Identifier">bif</span><span class="Operator">.</span><span class="Identifier">nim</span></span></tt>) that the preceding <tt class="docutils literal"><span class="pre"><span class="Identifier">nim</span> <span class="Identifier">ic</span></span></tt> frontend (<tt class="docutils literal"><span class="pre"><span class="Identifier">nim</span> <span class="Identifier">track</span></span></tt>) emitted into the nimcache directory — NOT by re-running sem. NIF distinguishes a definition (<tt class="docutils literal"><span class="pre"><span class="Identifier">SymbolDef</span></span></tt> token) from a use (<tt class="docutils literal"><span class="pre"><span class="Identifier">Symbol</span></span></tt> token) syntactically, so goto-def / find-uses become plain token scans over type-checked NIF, which is more reliable than the classic PSym engine because generics and macros are type-checked in the NIF too.</p>
<p>Two passes (mirroring nimony's <tt class="docutils literal"><span class="pre"><span class="Identifier">usages</span></span></tt>):</p>
<ol class="simple"><li>Load the queried module's <tt class="docutils literal"><span class="pre"><span class="Operator">.</span><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">bif</span></span></tt> and find the <tt class="docutils literal"><span class="pre"><span class="Identifier">Symbol</span></span></tt>/<tt class="docutils literal"><span class="pre"><span class="Identifier">SymbolDef</span></span></tt> token whose line info + identifier length contains <tt class="docutils literal"><span class="pre"><span class="Identifier">conf</span><span class="Operator">.</span><span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">trackPos</span></span></tt>. That yields the mangled symbol NAME and whether it is global (&gt;= 2 dots).</li>
<li><tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">usages</span></span></tt>: emit every <tt class="docutils literal"><span class="pre"><span class="Identifier">Symbol</span></span></tt> (use) token; <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">def</span></span></tt>: every <tt class="docutils literal"><span class="pre"><span class="Identifier">SymbolDef</span></span></tt>. A global symbol is scanned across every module <tt class="docutils literal"><span class="pre"><span class="Operator">.</span><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">bif</span></span></tt>; a local one only within the queried module.</li>
</ol>
<p>IMPORTANT porting note: <tt class="docutils literal"><span class="pre"><span class="Identifier">bif</span><span class="Operator">.</span><span class="Identifier">load</span></span></tt> mints FRESH per-file pools, so a <tt class="docutils literal"><span class="pre"><span class="Identifier">SymId</span></span></tt> from module A's buffer is meaningless in module B's. The cross-module match is therefore by the mangled NAME string, never by <tt class="docutils literal"><span class="pre"><span class="Identifier">SymId</span></span></tt> (nimony can compare ids because it parses every text NIF into one shared global pool; we cannot).</p>
</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="options.html">options</a>, <a class="reference external" href="msgs.html">msgs</a>, <a class="reference external" href="pathutils.html">pathutils</a>, <a class="reference external" href="lineinfos.html">lineinfos</a>, <a class="reference external" href="ast2nif.html">ast2nif</a>, <a class="reference external" href="deps.html">deps</a>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="runIdeQuery-procs-all">
<div id="runIdeQuery,ConfigRef">
<dt><pre><span class="Keyword">proc</span> <a href="#runIdeQuery%2CConfigRef"><span class="Identifier">runIdeQuery</span></a><span class="Other">(</span><span class="Identifier">conf</span><span class="Other">:</span> <a href="options.html#ConfigRef"><span class="Identifier">ConfigRef</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">,</span>
<span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadDirEffect</span><span class="Other">,</span>
<span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Entry point: called from <tt class="docutils literal"><span class="pre"><span class="Identifier">main</span><span class="Operator">.</span><span class="Identifier">nim</span></span></tt> after <tt class="docutils literal"><span class="pre"><span class="Identifier">commandCheck</span></span></tt> when a <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">def</span></span></tt>/<tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">usages</span></span></tt> query is active. Assumes the check just emitted the project's <tt class="docutils literal"><span class="pre"><span class="Operator">.</span><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">bif</span></span></tt> files into <tt class="docutils literal"><span class="pre"><span class="Identifier">getNimcacheDir</span><span class="Punctuation">(</span><span class="Identifier">conf</span><span class="Punctuation">)</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/compiler/idetools.nim#L220" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/compiler/idetools.nim#L220" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
</dl>
</div>
</div>
</div>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2026-07-22 18:32:36 UTC</small>
</div>
</div>
</div>
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink