remove deprecated APIs

Author: nitely

CHANGELOG.md

@@ -4,6 +4,8 @@ v0.8.0
 * Drop Nim 0.17 support
 * Add Nim 0.19 support
 * Update dependencies
+* Remove deprecated `match` and `find`
+  returning `Option[RegexMatch]`
 
 v0.7.4
 ==================

docs/index.html

@@ -1278,14 +1278,10 @@ <h1 class="title">Module regex</h1>
     title="groupsCount(m: RegexMatch): int"><wbr />groups<wbr />Count<span class="attachedType" style="visibility:hidden">RegexMatch</span></a></li>
   <li><a class="reference" href="#match%2Cstring%2CRegex%2CRegexMatch%2Cint"
     title="match(s: string; pattern: Regex; m: var RegexMatch; start = 0): bool"><wbr />match<span class="attachedType" style="visibility:hidden">Regex</span></a></li>
-  <li><a class="reference" href="#match%2Cstring%2CRegex%2Cint"
-    title="match(s: string; pattern: Regex; start = 0): Option[RegexMatch]"><wbr />match<span class="attachedType" style="visibility:hidden">RegexMatch</span></a></li>
   <li><a class="reference" href="#contains%2Cstring%2CRegex"
     title="contains(s: string; pattern: Regex): bool"><wbr />contains<span class="attachedType" style="visibility:hidden">Regex</span></a></li>
   <li><a class="reference" href="#find%2Cstring%2CRegex%2CRegexMatch%2Cint"
     title="find(s: string; pattern: Regex; m: var RegexMatch; start = 0): bool"><wbr />find<span class="attachedType" style="visibility:hidden">Regex</span></a></li>
-  <li><a class="reference" href="#find%2Cstring%2CRegex%2Cint"
-    title="find(s: string; pattern: Regex; start = 0): Option[RegexMatch]"><wbr />find<span class="attachedType" style="visibility:hidden">RegexMatch</span></a></li>
   <li><a class="reference" href="#findAll%2Cstring%2CRegex%2Cint"
     title="findAll(s: string; pattern: Regex; start = 0): seq[RegexMatch]"><wbr />find<wbr />All<span class="attachedType" style="visibility:hidden">RegexMatch</span></a></li>
   <li><a class="reference" href="#findAndCaptureAll%2Cstring%2CRegex"
@@ -1467,11 +1463,11 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
 <dd>
 return the number of capturing groups<pre class="listing"><span class="Keyword">block</span><span class="Punctuation">:</span>
   <span class="Keyword">var</span> <span class="Identifier">m</span><span class="Punctuation">:</span> <span class="Identifier">RegexMatch</span>
-  <span class="Identifier">doAssert</span> <span class="StringLit">&quot;ab&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="Identifier">m</span><span class="Punctuation">,</span> <span class="RawData">re&quot;(a)(b)&quot;</span><span class="Punctuation">)</span>
+  <span class="Identifier">doAssert</span> <span class="StringLit">&quot;ab&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(a)(b)&quot;</span><span class="Punctuation">,</span> <span class="Identifier">m</span><span class="Punctuation">)</span>
   <span class="Identifier">doAssert</span> <span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">groupsCount</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
 <span class="Keyword">block</span><span class="Punctuation">:</span>
   <span class="Keyword">var</span> <span class="Identifier">m</span><span class="Punctuation">:</span> <span class="Identifier">RegexMatch</span>
-  <span class="Identifier">doAssert</span> <span class="StringLit">&quot;ab&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="Identifier">m</span><span class="Punctuation">,</span> <span class="RawData">re&quot;((ab))&quot;</span><span class="Punctuation">)</span>
+  <span class="Identifier">doAssert</span> <span class="StringLit">&quot;ab&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;((ab))&quot;</span><span class="Punctuation">,</span> <span class="Identifier">m</span><span class="Punctuation">)</span>
   <span class="Identifier">doAssert</span> <span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">groupsCount</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
 
 </dd>
@@ -1483,13 +1479,6 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
 <span class="Identifier">doAssert</span> <span class="StringLit">&quot;abcd&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;abcd&quot;</span><span class="Punctuation">,</span> <span class="Identifier">m</span><span class="Punctuation">)</span>
 <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Keyword">not</span> <span class="StringLit">&quot;abcd&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;abc&quot;</span><span class="Punctuation">,</span> <span class="Identifier">m</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
 
-</dd>
-<a id="match%2Cstring%2CRegex%2Cint"></a>
-<dt><pre><span class="Keyword">proc</span> <span class="Identifier">match</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="regex.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="regex.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">]</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">deprecated</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> <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>
-<dd>
-Deprecated, use <tt class="docutils literal"><span class="pre">match(string, Regex, var RegexMatch)</span></tt> instead
-
 </dd>
 <a id="contains%2Cstring%2CRegex"></a>
 <dt><pre><span class="Keyword">proc</span> <span class="Identifier">contains</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="regex.html#Regex"><span class="Identifier">Regex</span></a><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>
@@ -1509,22 +1498,11 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
 <span class="Identifier">doAssert</span> <span class="StringLit">&quot;2222&quot;</span><span class="Operator">.</span><span class="Identifier">find</span><span class="Punctuation">(</span><span class="RawData">re&quot;(22)*&quot;</span><span class="Punctuation">,</span> <span class="Identifier">m</span><span class="Punctuation">)</span> <span class="Keyword">and</span>
   <span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">group</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span> <span class="Operator">..</span> <span class="DecNumber">3</span><span class="Punctuation">]</span></pre>
 
-</dd>
-<a id="find%2Cstring%2CRegex%2Cint"></a>
-<dt><pre><span class="Keyword">proc</span> <span class="Identifier">find</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="regex.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="regex.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">]</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">deprecated</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> <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>
-<dd>
-Deprecated, use <tt class="docutils literal"><span class="pre">find(string, Regex, var RegexMatch)</span></tt> instead
-
 </dd>
 <a id="findAll%2Cstring%2CRegex%2Cint"></a>
 <dt><pre><span class="Keyword">proc</span> <span class="Identifier">findAll</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="regex.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="regex.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">]</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>
 <dd>
-search through the string and return each match. Empty matches (start &gt; end) are included<pre class="listing"><span class="Keyword">let</span>
-  <span class="Identifier">expected</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">4</span> <span class="Operator">..</span> <span class="DecNumber">5</span><span class="Punctuation">]</span>
-  <span class="Identifier">ms</span> <span class="Operator">=</span> <span class="Identifier">findAll</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcabc&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;bc&quot;</span><span class="Punctuation">)</span>
-<span class="Keyword">for</span> <span class="Identifier">i</span><span class="Punctuation">,</span> <span class="Identifier">m</span> <span class="Keyword">in</span> <span class="Identifier">ms</span><span class="Punctuation">:</span>
-  <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">boundaries</span> <span class="Operator">==</span> <span class="Identifier">expected</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
+search through the string and return each match. Empty matches (start &gt; end) are included
 
 </dd>
 <a id="findAndCaptureAll%2Cstring%2CRegex"></a>
@@ -1616,7 +1594,7 @@ <h1><a class="toc-backref" href="#15">Iterators</a></h1>
   <span class="Identifier">expected</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span>
   <span class="Identifier">text</span> <span class="Operator">=</span> <span class="StringLit">&quot;abc&quot;</span>
 <span class="Keyword">var</span> <span class="Identifier">m</span><span class="Punctuation">:</span> <span class="Identifier">RegexMatch</span>
-<span class="Identifier">doAssert</span> <span class="Identifier">text</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="Identifier">m</span><span class="Punctuation">,</span> <span class="RawData">re&quot;(\w)+&quot;</span><span class="Punctuation">)</span>
+<span class="Identifier">doAssert</span> <span class="Identifier">text</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w)+&quot;</span><span class="Punctuation">,</span> <span class="Identifier">m</span><span class="Punctuation">)</span>
 <span class="Keyword">var</span> <span class="Identifier">i</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
 <span class="Keyword">for</span> <span class="Identifier">bounds</span> <span class="Keyword">in</span> <span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">group</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
   <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">expected</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Identifier">text</span><span class="Punctuation">[</span><span class="Identifier">bounds</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
@@ -1629,8 +1607,8 @@ <h1><a class="toc-backref" href="#15">Iterators</a></h1>
 return slices for a given named group<pre class="listing"><span class="Keyword">let</span>
   <span class="Identifier">expected</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span>
   <span class="Identifier">text</span> <span class="Operator">=</span> <span class="StringLit">&quot;abc&quot;</span>
-<span class="Keyword">var</span> <span class="Identifier">m</span> <span class="Operator">=</span> <span class="Identifier">RegexMatch</span>
-<span class="Identifier">doAssert</span> <span class="Identifier">text</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="Identifier">m</span><span class="Punctuation">,</span> <span class="RawData">re&quot;(?P&lt;foo&gt;\w)+&quot;</span><span class="Punctuation">)</span>
+<span class="Keyword">var</span> <span class="Identifier">m</span><span class="Punctuation">:</span> <span class="Identifier">RegexMatch</span>
+<span class="Identifier">doAssert</span> <span class="Identifier">text</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(?P&lt;foo&gt;\w)+&quot;</span><span class="Punctuation">,</span> <span class="Identifier">m</span><span class="Punctuation">)</span>
 <span class="Keyword">var</span> <span class="Identifier">i</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
 <span class="Keyword">for</span> <span class="Identifier">bounds</span> <span class="Keyword">in</span> <span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">group</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
   <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">expected</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Identifier">text</span><span class="Punctuation">[</span><span class="Identifier">bounds</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
@@ -1646,8 +1624,8 @@ <h1><a class="toc-backref" href="#15">Iterators</a></h1>
   <span class="Identifier">expected</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">4</span> <span class="Operator">..</span> <span class="DecNumber">5</span><span class="Punctuation">]</span>
   <span class="Identifier">text</span> <span class="Operator">=</span> <span class="StringLit">&quot;abcabc&quot;</span>
 <span class="Keyword">for</span> <span class="Identifier">m</span> <span class="Keyword">in</span> <span class="Identifier">findAll</span><span class="Punctuation">(</span><span class="Identifier">text</span><span class="Punctuation">,</span> <span class="RawData">re&quot;bc&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
-  <span class="Identifier">doAssert</span> <span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">boundaries</span> <span class="Operator">==</span> <span class="Identifier">expected</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span>
   <span class="Identifier">doAssert</span> <span class="Identifier">text</span><span class="Punctuation">[</span><span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">boundaries</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;bc&quot;</span>
+  <span class="Identifier">doAssert</span> <span class="Identifier">m</span><span class="Operator">.</span><span class="Identifier">boundaries</span> <span class="Operator">==</span> <span class="Identifier">expected</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span>
   <span class="Identifier">inc</span> <span class="Identifier">i</span></pre>
 
 </dd>
@@ -1682,7 +1660,7 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small>Made with Nim. Generated: 2018-10-08 02:54:01 UTC</small>
+        <small>Made with Nim. Generated: 2018-10-08 03:42:57 UTC</small>
       </div>
     </div>
   </div>