widestrs.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/widestrs</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/widestrs</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <details open>
  51. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  52. <ul class="simple simple-toc-section">
  53. <li><a class="reference" href="#Utf16Char" title="Utf16Char = distinct int16">Utf16Char</a></li>
  54. <li><a class="reference" href="#WideCString" title="WideCString = ptr UncheckedArray[Utf16Char]">WideCString</a></li>
  55. <li><a class="reference" href="#WideCStringObj" title="WideCStringObj = object">WideCStringObj</a></li>
  56. </ul>
  57. </details>
  58. </li>
  59. <li>
  60. <details open>
  61. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  62. <ul class="simple simple-toc-section">
  63. <ul class="simple nested-toc-section">$
  64. <li><a class="reference" href="#%24%2CWideCString" title="`$`(s: WideCString): string">`$`(s: WideCString): string</a></li>
  65. <li><a class="reference" href="#%24%2CWideCStringObj" title="`$`(s: WideCStringObj): string">`$`(s: WideCStringObj): string</a></li>
  66. <li><a class="reference" href="#%24%2CWideCStringObj%2Cint%2Cint" title="`$`(s: WideCStringObj; estimate: int; replacement: int = 0x0000FFFD): string">`$`(s: WideCStringObj; estimate: int; replacement: int = 0x0000FFFD): string</a></li>
  67. <li><a class="reference" href="#%24%2CWideCString%2Cint%2Cint" title="`$`(w: WideCString; estimate: int; replacement: int = 0x0000FFFD): string">`$`(w: WideCString; estimate: int; replacement: int = 0x0000FFFD): string</a></li>
  68. </ul>
  69. <ul class="simple nested-toc-section">len
  70. <li><a class="reference" href="#len%2CWideCString" title="len(w: WideCString): int">len(w: WideCString): int</a></li>
  71. <li><a class="reference" href="#len%2CWideCStringObj" title="len(w: WideCStringObj): int">len(w: WideCStringObj): int</a></li>
  72. </ul>
  73. <ul class="simple nested-toc-section">newWideCString
  74. <li><a class="reference" href="#newWideCString%2Ccstring" title="newWideCString(s: cstring): WideCStringObj">newWideCString(s: cstring): WideCStringObj</a></li>
  75. <li><a class="reference" href="#newWideCString%2Cstring" title="newWideCString(s: string): WideCStringObj">newWideCString(s: string): WideCStringObj</a></li>
  76. <li><a class="reference" href="#newWideCString%2Cint" title="newWideCString(size: int): WideCStringObj">newWideCString(size: int): WideCStringObj</a></li>
  77. <li><a class="reference" href="#newWideCString%2Ccstring%2Cint" title="newWideCString(source: cstring; L: int): WideCStringObj">newWideCString(source: cstring; L: int): WideCStringObj</a></li>
  78. </ul>
  79. </ul>
  80. </details>
  81. </li>
  82. <li>
  83. <details open>
  84. <summary><a class="reference reference-toplevel" href="#16" id="66">Converters</a></summary>
  85. <ul class="simple simple-toc-section">
  86. <ul class="simple nested-toc-section">toWideCString
  87. <li><a class="reference" href="#toWideCString.c%2CWideCStringObj" title="toWideCString(x: WideCStringObj): WideCString">toWideCString(x: WideCStringObj): WideCString</a></li>
  88. </ul>
  89. </ul>
  90. </details>
  91. </li>
  92. <li>
  93. <details open>
  94. <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
  95. <ul class="simple simple-toc-section">
  96. <ul class="simple nested-toc-section">[]
  97. <li><a class="reference" href="#%5B%5D.t%2CWideCStringObj%2Cint" title="`[]`(a: WideCStringObj; idx: int): Utf16Char">`[]`(a: WideCStringObj; idx: int): Utf16Char</a></li>
  98. </ul>
  99. <ul class="simple nested-toc-section">[]=
  100. <li><a class="reference" href="#%5B%5D%3D.t%2CWideCStringObj%2Cint%2CUtf16Char" title="`[]=`(a: WideCStringObj; idx: int; val: Utf16Char)">`[]=`(a: WideCStringObj; idx: int; val: Utf16Char)</a></li>
  101. </ul>
  102. </ul>
  103. </details>
  104. </li>
  105. </ul>
  106. </div>
  107. <div class="nine columns" id="content">
  108. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  109. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  110. <div id="tocRoot"></div>
  111. <p class="module-desc">Nim support for C/C++'s <span id="wide-strings_1">wide strings</span>.</p>
  112. <div class="section" id="7">
  113. <h1><a class="toc-backref" href="#7">Types</a></h1>
  114. <dl class="item">
  115. <div id="Utf16Char">
  116. <dt><pre><a href="widestrs.html#Utf16Char"><span class="Identifier">Utf16Char</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="system.html#int16"><span class="Identifier">int16</span></a></pre></dt>
  117. <dd>
  118. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L16" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  119. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L16" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  120. </dd>
  121. </div>
  122. <div id="WideCString">
  123. <dt><pre><a href="widestrs.html#WideCString"><span class="Identifier">WideCString</span></a> <span class="Other">=</span> <span class="Keyword">ptr</span> <a href="system.html#UncheckedArray"><span class="Identifier">UncheckedArray</span></a><span class="Other">[</span><a href="widestrs.html#Utf16Char"><span class="Identifier">Utf16Char</span></a><span class="Other">]</span></pre></dt>
  124. <dd>
  125. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L22" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  126. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L22" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  127. </dd>
  128. </div>
  129. <div id="WideCStringObj">
  130. <dt><pre><a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
  131. <dd>
  132. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L24" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  133. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L24" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  134. </dd>
  135. </div>
  136. </dl>
  137. </div>
  138. <div class="section" id="12">
  139. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  140. <dl class="item">
  141. <div id="$-procs-all">
  142. <div id="$,WideCString">
  143. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CWideCString"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="widestrs.html#WideCString"><span class="Identifier">WideCString</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<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>
  144. <dd>
  145. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L230" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  146. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L230" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  147. </dd>
  148. </div>
  149. <div id="$,WideCStringObj">
  150. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CWideCStringObj"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<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>
  151. <dd>
  152. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L237" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  153. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L237" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  154. </dd>
  155. </div>
  156. <div id="$,WideCStringObj,int,int">
  157. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CWideCStringObj%2Cint%2Cint"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a><span class="Other">;</span> <span class="Identifier">estimate</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">replacement</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">0x0000FFFD</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
  158. <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>
  159. <dd>
  160. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L234" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  161. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L234" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  162. </dd>
  163. </div>
  164. <div id="$,WideCString,int,int">
  165. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CWideCString%2Cint%2Cint"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">w</span><span class="Other">:</span> <a href="widestrs.html#WideCString"><span class="Identifier">WideCString</span></a><span class="Other">;</span> <span class="Identifier">estimate</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">replacement</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">0x0000FFFD</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
  166. <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>
  167. <dd>
  168. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L188" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  169. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L188" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  170. </dd>
  171. </div>
  172. </div>
  173. <div id="len-procs-all">
  174. <div id="len,WideCString">
  175. <dt><pre><span class="Keyword">proc</span> <a href="#len%2CWideCString"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">w</span><span class="Other">:</span> <a href="widestrs.html#WideCString"><span class="Identifier">WideCString</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<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>
  176. <dd>
  177. returns the length of a widestring. This traverses the whole string to find the binary zero end marker!
  178. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L77" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  179. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L77" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  180. </dd>
  181. </div>
  182. <div id="len,WideCStringObj">
  183. <dt><pre><span class="Keyword">proc</span> <a href="#len%2CWideCStringObj"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">w</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</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>
  184. <dd>
  185. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L240" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  186. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L240" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  187. </dd>
  188. </div>
  189. </div>
  190. <div id="newWideCString-procs-all">
  191. <div id="newWideCString,cstring">
  192. <dt><pre><span class="Keyword">proc</span> <a href="#newWideCString%2Ccstring"><span class="Identifier">newWideCString</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a> {.<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>
  193. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  194. <dd>
  195. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L180" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  196. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L180" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  197. </dd>
  198. </div>
  199. <div id="newWideCString,string">
  200. <dt><pre><span class="Keyword">proc</span> <a href="#newWideCString%2Cstring"><span class="Identifier">newWideCString</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a> {.<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>
  201. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  202. <dd>
  203. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L185" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  204. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L185" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  205. </dd>
  206. </div>
  207. <div id="newWideCString,int">
  208. <dt><pre><span class="Keyword">proc</span> <a href="#newWideCString%2Cint"><span class="Identifier">newWideCString</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a> {.<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>
  209. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  210. <dd>
  211. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L154" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  212. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L154" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  213. </dd>
  214. </div>
  215. <div id="newWideCString,cstring,int">
  216. <dt><pre><span class="Keyword">proc</span> <a href="#newWideCString%2Ccstring%2Cint"><span class="Identifier">newWideCString</span></a><span class="Other">(</span><span class="Identifier">source</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">L</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a> {.<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>
  217. <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>
  218. <dd>
  219. Warning:: <tt class="docutils literal"><span class="pre"><span class="Identifier">source</span></span></tt> needs to be preallocated with the length <tt class="docutils literal"><span class="pre"><span class="Identifier">L</span></span></tt>
  220. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L158" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  221. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L158" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  222. </dd>
  223. </div>
  224. </div>
  225. </dl>
  226. </div>
  227. <div class="section" id="16">
  228. <h1><a class="toc-backref" href="#16">Converters</a></h1>
  229. <dl class="item">
  230. <div id="toWideCString-converters-all">
  231. <div id="toWideCString.c,WideCStringObj">
  232. <dt><pre><span class="Keyword">converter</span> <a href="#toWideCString.c%2CWideCStringObj"><span class="Identifier">toWideCString</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a><span class="Other">)</span><span class="Other">:</span> <a href="widestrs.html#WideCString"><span class="Identifier">WideCString</span></a> {.<span class="Identifier">inline</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>
  233. <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>
  234. <dd>
  235. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L62" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  236. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L62" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  237. </dd>
  238. </div>
  239. </div>
  240. </dl>
  241. </div>
  242. <div class="section" id="18">
  243. <h1><a class="toc-backref" href="#18">Templates</a></h1>
  244. <dl class="item">
  245. <div id="[]-templates-all">
  246. <div id="[].t,WideCStringObj,int">
  247. <dt><pre><span class="Keyword">template</span> <a href="#%5B%5D.t%2CWideCStringObj%2Cint"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a><span class="Other">;</span> <span class="Identifier">idx</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="widestrs.html#Utf16Char"><span class="Identifier">Utf16Char</span></a></pre></dt>
  248. <dd>
  249. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L57" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  250. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L57" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  251. </dd>
  252. </div>
  253. </div>
  254. <div id="[]=-templates-all">
  255. <div id="[]=.t,WideCStringObj,int,Utf16Char">
  256. <dt><pre><span class="Keyword">template</span> <a href="#%5B%5D%3D.t%2CWideCStringObj%2Cint%2CUtf16Char"><span class="Identifier">`[]=`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="widestrs.html#WideCStringObj"><span class="Identifier">WideCStringObj</span></a><span class="Other">;</span> <span class="Identifier">idx</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="widestrs.html#Utf16Char"><span class="Identifier">Utf16Char</span></a><span class="Other">)</span></pre></dt>
  257. <dd>
  258. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/widestrs.nim#L58" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  259. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/widestrs.nim#L58" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  260. </dd>
  261. </div>
  262. </div>
  263. </dl>
  264. </div>
  265. </div>
  266. </div>
  267. <div class="twelve-columns footer">
  268. <span class="nim-sprite"></span>
  269. <br>
  270. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-12 16:39:50 UTC</small>
  271. </div>
  272. </div>
  273. </div>
  274. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  275. </body>
  276. </html>