Skip to content

Commit 8857a7c

Browse files
committed
findAll and docs
1 parent f759b97 commit 8857a7c

37 files changed

+6633
-64
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Nim +1.0.4
1717
## Usage
1818

1919
```nim
20-
import nregex
20+
import pkg/nregex
2121
2222
var m: RegexMatch
2323
doAssert match("abc", re"abc", m)

docs/index.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta http-equiv="Refresh" content="0; url=nregex.html" />
5+
</head>
6+
<body>
7+
<p>Please follow <a href="nregex.html">this link</a>.</p>
8+
</body>
9+
</html>

docs/nimdoc.out.css

Lines changed: 891 additions & 0 deletions
Large diffs are not rendered by default.

docs/nregex.html

Lines changed: 503 additions & 0 deletions
Large diffs are not rendered by default.

docs/nregex/common.html

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
1+
<?xml version="1.0" encoding="utf-8" ?>
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
<!-- This file is generated by Nim. -->
5+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
9+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
10+
11+
<!-- Favicon -->
12+
<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=="/>
13+
<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=">
14+
15+
<!-- Google fonts -->
16+
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
17+
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
18+
19+
<!-- CSS -->
20+
<title>nregex/common</title>
21+
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
22+
23+
<script type="text/javascript" src="dochack.js"></script>
24+
25+
<script type="text/javascript">
26+
function main() {
27+
var pragmaDots = document.getElementsByClassName("pragmadots");
28+
for (var i = 0; i < pragmaDots.length; i++) {
29+
pragmaDots[i].onclick = function(event) {
30+
// Hide tease
31+
event.target.parentNode.style.display = "none";
32+
// Show actual
33+
event.target.parentNode.nextElementSibling.style.display = "inline";
34+
}
35+
}
36+
37+
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
38+
function switchTheme(e) {
39+
if (e.target.checked) {
40+
document.documentElement.setAttribute('data-theme', 'dark');
41+
localStorage.setItem('theme', 'dark');
42+
} else {
43+
document.documentElement.setAttribute('data-theme', 'light');
44+
localStorage.setItem('theme', 'light');
45+
}
46+
}
47+
48+
toggleSwitch.addEventListener('change', switchTheme, false);
49+
50+
51+
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
52+
document.documentElement.setAttribute('data-theme', "dark");
53+
toggleSwitch.checked = true;
54+
} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
55+
document.documentElement.setAttribute('data-theme', "light");
56+
toggleSwitch.checked = false;
57+
} else {
58+
const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
59+
if (currentTheme) {
60+
document.documentElement.setAttribute('data-theme', currentTheme);
61+
62+
if (currentTheme === 'dark') {
63+
toggleSwitch.checked = true;
64+
}
65+
}
66+
}
67+
}
68+
</script>
69+
70+
</head>
71+
<body onload="main()">
72+
<div class="document" id="documentId">
73+
<div class="container">
74+
<h1 class="title">nregex/common</h1>
75+
<div class="row">
76+
<div class="three columns">
77+
<div class="theme-switch-wrapper">
78+
<label class="theme-switch" for="checkbox">
79+
<input type="checkbox" id="checkbox" />
80+
<div class="slider round"></div>
81+
</label>
82+
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
83+
</div>
84+
<div id="global-links">
85+
<ul class="simple">
86+
</ul>
87+
</div>
88+
<div id="searchInputDiv">
89+
Search: <input type="text" id="searchInput"
90+
onkeyup="search()" />
91+
</div>
92+
<div>
93+
Group by:
94+
<select onchange="groupBy(this.value)">
95+
<option value="section">Section</option>
96+
<option value="type">Type</option>
97+
</select>
98+
</div>
99+
<ul class="simple simple-toc" id="toc-list">
100+
<li>
101+
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
102+
<ul class="simple simple-toc-section">
103+
<li><a class="reference" href="#RegexError"
104+
title="RegexError = object of ValueError"><wbr />Regex<wbr />Error<span class="attachedType"></span></a></li>
105+
106+
</ul>
107+
</li>
108+
<li>
109+
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
110+
<ul class="simple simple-toc-section">
111+
<li><a class="reference" href="#invalidRune"
112+
title="invalidRune = -1&apos;i32"><wbr />invalid<wbr />Rune<span class="attachedType"></span></a></li>
113+
<li><a class="reference" href="#lineBreakRune"
114+
title="lineBreakRune = 10&apos;i32"><wbr />line<wbr />Break<wbr />Rune<span class="attachedType"></span></a></li>
115+
116+
</ul>
117+
</li>
118+
<li>
119+
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
120+
<ul class="simple simple-toc-section">
121+
<li><a class="reference" href="#toRune%2Cstring"
122+
title="toRune(s: string): Rune"><wbr />to<wbr />Rune<span class="attachedType"></span></a></li>
123+
<li><a class="reference" href="#%3C%3D%2CRune%2CRune"
124+
title="`&lt;=`(x, y: Rune): bool"><wbr />`&lt;=`<span class="attachedType"></span></a></li>
125+
<li><a class="reference" href="#cmp%2CRune%2CRune"
126+
title="cmp(x, y: Rune): int"><wbr />cmp<span class="attachedType"></span></a></li>
127+
<li><a class="reference" href="#%25%25%2Cstring%2CopenArray%5Bstring%5D"
128+
title="`%%`(formatstr: string; a: openArray[string]): string"><wbr />`%%`<span class="attachedType"></span></a></li>
129+
<li><a class="reference" href="#%25%25%2Cstring%2Cstring"
130+
title="`%%`(formatstr: string; a: string): string"><wbr />`%%`<span class="attachedType"></span></a></li>
131+
132+
</ul>
133+
</li>
134+
135+
</ul>
136+
137+
</div>
138+
<div class="nine columns" id="content">
139+
<div id="tocRoot"></div>
140+
141+
<p class="module-desc"></p>
142+
<div class="section" id="7">
143+
<h1><a class="toc-backref" href="#7">Types</a></h1>
144+
<dl class="item">
145+
<a id="RegexError"></a>
146+
<dt><pre><a href="common.html#RegexError"><span class="Identifier">RegexError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">ValueError</span></pre></dt>
147+
<dd>
148+
149+
150+
151+
</dd>
152+
153+
</dl></div>
154+
<div class="section" id="10">
155+
<h1><a class="toc-backref" href="#10">Consts</a></h1>
156+
<dl class="item">
157+
<a id="invalidRune"></a>
158+
<dt><pre><a href="common.html#invalidRune"><span class="Identifier">invalidRune</span></a> <span class="Other">=</span> <span class="DecNumber">-1'i32</span></pre></dt>
159+
<dd>
160+
161+
162+
163+
</dd>
164+
<a id="lineBreakRune"></a>
165+
<dt><pre><a href="common.html#lineBreakRune"><span class="Identifier">lineBreakRune</span></a> <span class="Other">=</span> <span class="DecNumber">10'i32</span></pre></dt>
166+
<dd>
167+
168+
169+
170+
</dd>
171+
172+
</dl></div>
173+
<div class="section" id="12">
174+
<h1><a class="toc-backref" href="#12">Procs</a></h1>
175+
<dl class="item">
176+
<a id="toRune,string"></a>
177+
<dt><pre><span class="Keyword">proc</span> <a href="#toRune%2Cstring"><span class="Identifier">toRune</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Rune</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><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><span class="Other">.}</span></span></pre></dt>
178+
<dd>
179+
180+
181+
182+
</dd>
183+
<a id="<=,Rune,Rune"></a>
184+
<dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2CRune%2CRune"><span class="Identifier">`&lt;=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">Rune</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><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><span class="Other">.}</span></span></pre></dt>
185+
<dd>
186+
187+
188+
189+
</dd>
190+
<a id="cmp,Rune,Rune"></a>
191+
<dt><pre><span class="Keyword">proc</span> <a href="#cmp%2CRune%2CRune"><span class="Identifier">cmp</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">Rune</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><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><span class="Other">.}</span></span></pre></dt>
192+
<dd>
193+
194+
195+
196+
</dd>
197+
<a id="%%,string,openArray[string]"></a>
198+
<dt><pre><span class="Keyword">proc</span> <a href="#%25%25%2Cstring%2CopenArray%5Bstring%5D"><span class="Identifier">`%%`</span></a><span class="Other">(</span><span class="Identifier">formatstr</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
199+
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
200+
<dd>
201+
202+
same as <tt class="docutils literal"><span class="pre">&quot;$#&quot; % [&quot;foo&quot;]</span></tt> but returns empty string on error
203+
204+
</dd>
205+
<a id="%%,string,string"></a>
206+
<dt><pre><span class="Keyword">proc</span> <a href="#%25%25%2Cstring%2Cstring"><span class="Identifier">`%%`</span></a><span class="Other">(</span><span class="Identifier">formatstr</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><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><span class="Other">.}</span></span></pre></dt>
207+
<dd>
208+
209+
210+
211+
</dd>
212+
213+
</dl></div>
214+
215+
</div>
216+
</div>
217+
218+
<div class="row">
219+
<div class="twelve-columns footer">
220+
<span class="nim-sprite"></span>
221+
<br/>
222+
<small style="color: var(--hint);">Made with Nim. Generated: 2020-03-18 12:52:35 UTC</small>
223+
</div>
224+
</div>
225+
</div>
226+
</div>
227+
228+
</body>
229+
</html>

0 commit comments

Comments
 (0)