mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Nim/compilesettings.html
github-actions[bot] ef3d9e7b38 Deploy to GitHub pages
2025-12-28 15:55:52 +00:00

239 lines
19 KiB
HTML
Raw Permalink 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>std/compilesettings</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">
<div class="container">
<h1 class="title">std/compilesettings</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-boot">
<li><a href="manual.html">Manual</a></li>
<li><a href="lib.html">Standard library</a></li>
<li> <a id="indexLink" href="theindex.html">Index</a></li>
<li><a href="compiler/theindex.html">Compiler docs</a></li>
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput"
oninput="search()" />
</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="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#MultipleValueSetting" title="MultipleValueSetting {.pure.} = enum
nimblePaths, ## the nimble path(s)
searchPaths, ## the search path for modules
lazyPaths, ## experimental: even more paths
commandArgs, ## the arguments passed to the Nim compiler
cincludes, ## the #include paths passed to the C/C++ compiler
clibs ## libraries passed to the C/C++ compiler">MultipleValueSetting</a></li>
<li><a class="reference" href="#SingleValueSetting" title="SingleValueSetting {.pure.} = enum
arguments, ## experimental: the arguments passed after '-r'
outFile, ## experimental: the output file
outDir, ## the output directory
nimcacheDir, ## the location of the 'nimcache' directory
projectName, ## the project's name that is being compiled
projectPath, ## experimental: some path to the project that is being compiled
projectFull, ## the full path to the project that is being compiled
command, ## experimental: the command (e.g. 'c', 'cpp', 'doc') passed to
## the Nim compiler
commandLine, ## experimental: the command line passed to Nim
linkOptions, ## additional options passed to the linker
compileOptions, ## additional options passed to the C/C++ compiler
ccompilerPath, ## the path to the C/C++ compiler
backend, ## the backend (eg: c|cpp|objc|js); both `nim doc --backend:js`
## and `nim js` would imply backend=js
libPath, ## the absolute path to the stdlib library, i.e. nim's `--lib`, since 1.5.1
gc {.deprecated.}, ## gc selected
mm ## memory management selected">SingleValueSetting</a></li>
</ul>
</details>
</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">querySetting
<li><a class="reference" href="#querySetting%2CSingleValueSetting" title="querySetting(setting: SingleValueSetting): string">querySetting(setting: SingleValueSetting): string</a></li>
</ul>
<ul class="simple nested-toc-section">querySettingSeq
<li><a class="reference" href="#querySettingSeq%2CMultipleValueSetting" title="querySettingSeq(setting: MultipleValueSetting): seq[string]">querySettingSeq(setting: MultipleValueSetting): seq[string]</a></li>
</ul>
</ul>
</details>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/compilesettings.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/compilesettings.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc">This module allows querying the compiler about diverse configuration settings. See also <tt class="docutils literal"><span class="pre"><span class="Identifier">compileOption</span></span></tt>.</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="assertions.html">assertions</a>
</dl>
</div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="MultipleValueSetting">
<dt><pre><a href="compilesettings.html#MultipleValueSetting"><span class="Identifier">MultipleValueSetting</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">nimblePaths</span><span class="Other">,</span> <span class="Comment">## the nimble path(s)</span>
<span class="Identifier">searchPaths</span><span class="Other">,</span> <span class="Comment">## the search path for modules</span>
<span class="Identifier">lazyPaths</span><span class="Other">,</span> <span class="Comment">## experimental: even more paths</span>
<span class="Identifier">commandArgs</span><span class="Other">,</span> <span class="Comment">## the arguments passed to the Nim compiler</span>
<span class="Identifier">cincludes</span><span class="Other">,</span> <span class="Comment">## the #include paths passed to the C/C++ compiler</span>
<span class="Identifier">clibs</span> <span class="Comment">## libraries passed to the C/C++ compiler</span></pre></dt>
<dd>
settings resulting in a seq of string values
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/compilesettings.nim#L41" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/compilesettings.nim#L41" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="SingleValueSetting">
<dt><pre><a href="compilesettings.html#SingleValueSetting"><span class="Identifier">SingleValueSetting</span></a> {.<span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">arguments</span><span class="Other">,</span> <span class="Comment">## experimental: the arguments passed after '-r'</span>
<span class="Identifier">outFile</span><span class="Other">,</span> <span class="Comment">## experimental: the output file</span>
<span class="Identifier">outDir</span><span class="Other">,</span> <span class="Comment">## the output directory</span>
<span class="Identifier">nimcacheDir</span><span class="Other">,</span> <span class="Comment">## the location of the 'nimcache' directory</span>
<span class="Identifier">projectName</span><span class="Other">,</span> <span class="Comment">## the project's name that is being compiled</span>
<span class="Identifier">projectPath</span><span class="Other">,</span> <span class="Comment">## experimental: some path to the project that is being compiled</span>
<span class="Identifier">projectFull</span><span class="Other">,</span> <span class="Comment">## the full path to the project that is being compiled</span>
<span class="Identifier">command</span><span class="Other">,</span> <span class="Comment">## experimental: the command (e.g. 'c', 'cpp', 'doc') passed to</span>
<span class="Comment">## the Nim compiler</span>
<span class="Identifier">commandLine</span><span class="Other">,</span> <span class="Comment">## experimental: the command line passed to Nim</span>
<span class="Identifier">linkOptions</span><span class="Other">,</span> <span class="Comment">## additional options passed to the linker</span>
<span class="Identifier">compileOptions</span><span class="Other">,</span> <span class="Comment">## additional options passed to the C/C++ compiler</span>
<span class="Identifier">ccompilerPath</span><span class="Other">,</span> <span class="Comment">## the path to the C/C++ compiler</span>
<span class="Identifier">backend</span><span class="Other">,</span> <span class="Comment">## the backend (eg: c|cpp|objc|js); both `nim doc --backend:js`</span>
<span class="Comment">## and `nim js` would imply backend=js</span>
<span class="Identifier">libPath</span><span class="Other">,</span> <span class="Comment">## the absolute path to the stdlib library, i.e. nim's `--lib`, since 1.5.1</span>
<span class="Identifier">gc</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span></span>.}<span class="Other">,</span> <span class="Comment">## gc selected</span>
<span class="Identifier">mm</span> <span class="Comment">## memory management selected</span></pre></dt>
<dd>
settings resulting in a single string value
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/compilesettings.nim#L20" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/compilesettings.nim#L20" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="querySetting-procs-all">
<div id="querySetting,SingleValueSetting">
<dt><pre><span class="Keyword">proc</span> <a href="#querySetting%2CSingleValueSetting"><span class="Identifier">querySetting</span></a><span class="Other">(</span><span class="Identifier">setting</span><span class="Other">:</span> <a href="compilesettings.html#SingleValueSetting"><span class="Identifier">SingleValueSetting</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">compileTime</span><span class="Other">,</span>
<span class="Identifier">noSideEffect</span><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="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</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>
<p>Can be used to get a string compile-time option.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="system.html#compileOption,string">compileOption</a> for <tt class="docutils literal"><span class="pre"><span class="Identifier">on</span><span class="Operator">|</span><span class="Identifier">off</span></span></tt> options</li>
<li><a class="reference external" href="system.html#compileOption,string,string">compileOption</a> for enum options</li>
</ul>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">const</span> <span class="Identifier">nimcache</span> <span class="Operator">=</span> <span class="Identifier">querySetting</span><span class="Punctuation">(</span><span class="Identifier">SingleValueSetting</span><span class="Operator">.</span><span class="Identifier">nimcacheDir</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/compilesettings.nim#L50" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/compilesettings.nim#L50" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="querySettingSeq-procs-all">
<div id="querySettingSeq,MultipleValueSetting">
<dt><pre><span class="Keyword">proc</span> <a href="#querySettingSeq%2CMultipleValueSetting"><span class="Identifier">querySettingSeq</span></a><span class="Other">(</span><span class="Identifier">setting</span><span class="Other">:</span> <a href="compilesettings.html#MultipleValueSetting"><span class="Identifier">MultipleValueSetting</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">compileTime</span><span class="Other">,</span>
<span class="Identifier">noSideEffect</span><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="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</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>
<p>Can be used to get a multi-string compile-time option.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="system.html#compileOption,string">compileOption</a> for <tt class="docutils literal"><span class="pre"><span class="Identifier">on</span><span class="Operator">|</span><span class="Identifier">off</span></span></tt> options</li>
<li><a class="reference external" href="system.html#compileOption,string,string">compileOption</a> for enum options</li>
</ul>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">const</span> <span class="Identifier">nimblePaths</span> <span class="Operator">=</span> <span class="Identifier">querySettingSeq</span><span class="Punctuation">(</span><span class="Identifier">MultipleValueSetting</span><span class="Operator">.</span><span class="Identifier">nimblePaths</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/compilesettings.nim#L62" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/compilesettings.nim#L62" 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: 2025-12-28 15:55:13 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