doc/CaptureReference.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: CaptureReference</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: CaptureReference</h1>

    
<section>

<header>
    <h2>
    CaptureReference
    </h2>
    
</header>

<article>
    <div class="container-overview">
    

<dt>
    <h4 class="name" id="CaptureReference"><span class="type-signature">(protected) </span>new CaptureReference<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1330">line 1330</a>
    </li></ul></dd>
    

</dl>


</dd>

    
    </div>

    
        <h3 class="subsection-title">Extends</h3>

        <ul>
            <li><a href="Term.html">Term</a></li>
        </ul>
    

        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<dt>
    <h4 class="name" id="_generateBody"><span class="type-signature">(protected, static) </span>_generateBody<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
<dl class="details">
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1349">line 1349</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="_generate"><span class="type-signature">(protected) </span>_generate<span class="signature">(context, termRequiresWrap)</span><span class="type-signature"> &rarr; {String}</span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>important: _generate and _generateBody should never modify the term object.</p>
<p>implementation notes:</p>
<p>termRequiresWrap tells fragile term(s) in sub-expression that if protection is required.
There are 2 situations:
0.no: If there is only one term, then the terms need not protection at all.
1.maybe: If the sub-expression is composed with more then one term,
and the terms will be evaluated in order, i.e., will be concatenated directly,
then the terms need not protection, unless it is the &quot;either&quot; expression.</p>
<p>[in traditional chinese]</p>
<p>termRequiresWrap 是要通知元素是否需要使用 group 來保護內容。</p>
<p>有兩種狀況:</p>
<p>0.no: 元素沒有兄弟元素(僅有一個子元素)，則元素本身不需要特別保護。
1.maybe: 有兄弟元素，且兄弟元素之間將直接接合(concatenated)，
元素應視需要(目前只有 either 運算式有此需要)自我保護。</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the context object of the regexGen generator.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>termRequiresWrap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last"><p>should the term requires wrap. See possible values descripted above.</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#_generate">Term#_generate</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line918">line 918</a>
    </li></ul></dd>
    

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>the generated regular expression string literal.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

        
</dd>

        
<dt>
    <h4 class="name" id="_generateBody"><span class="type-signature">(protected) </span>_generateBody<span class="signature">(context, bodyRequiresWrap)</span><span class="type-signature"> &rarr; {String}</span></h4>

    
</dt>
<dd>

    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the context object of the regexGen generator.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>bodyRequiresWrap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last"><p>should the body of term requires wrap. See possible values descripted in #_generate.</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#_generateBody">Term#_generateBody</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line949">line 949</a>
    </li></ul></dd>
    

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>the generated regular expression string literal (body part).</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

        
</dd>

        
<dt>
    <h4 class="name" id="_init"><span class="type-signature">(protected) </span>_init<span class="signature">(body, quantifiers)</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>Initialize the term object, setup default values.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>body</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the expression string.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>quantifiers</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the quantifiers applied on this term.</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#_init">Term#_init</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line881">line 881</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="_warn"><span class="type-signature">(protected) </span>_warn<span class="signature">(msg, values)</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>msg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>-</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>values</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>-</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#_warn">Term#_warn</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line958">line 958</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="any"><span class="type-signature"></span>any<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>Matches the expression generated by the preceding sub-generator 0 or more times. Equivalent to <code>/(.*)/</code> and <code>/.{0,}/</code>.</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#any">Term#any</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1039">line 1039</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="contains"><span class="type-signature"></span>contains<span class="signature">(&hellip;terms)</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>terms</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                    &lt;repeatable><br>
                
                </td>
            

            <td class="description last"><p>-</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#contains">Term#contains</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line975">line 975</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="followedBy"><span class="type-signature"></span>followedBy<span class="signature">(&hellip;terms)</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>Matches 'x' only if 'x' is followed by 'y'. This is called a lookahead. (x(?=y))</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>terms</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                    &lt;repeatable><br>
                
                </td>
            

            <td class="description last"><p>-</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#followedBy">Term#followedBy</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1005">line 1005</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="greedy"><span class="type-signature"></span>greedy<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>Makes a quantifier greedy. Note that quantifier are greedy by default.</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#greedy">Term#greedy</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1109">line 1109</a>
    </li></ul></dd>
    

</dl>


        <h5>Example</h5>
        
    <pre class="prettyprint"><code>anyChar().any().greedy()       // ==> /.\u002A/
anyChar().many().greedy()      // ==> /.+/
anyChar().maybe().greedy()     // ==> /.?/</code></pre>

    
</dd>

        
<dt>
    <h4 class="name" id="lazy"><span class="type-signature"></span>lazy<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>Makes a quantifier lazy.</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#lazy">Term#lazy</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1124">line 1124</a>
    </li></ul></dd>
    

</dl>


        <h5>Example</h5>
        
    <pre class="prettyprint"><code>anyChar().any().lazy()          // ==> /.*?/
anyChar().many().lazy()         // ==> /.+?/
anyChar().maybe().lazy()        // ==> /.??/
anyChar().multiple(5,9).lazy()  // ==> /.{5,9}?/</code></pre>

    
</dd>

        
<dt>
    <h4 class="name" id="many"><span class="type-signature"></span>many<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>occurs one or more times (x+)</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#many">Term#many</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1047">line 1047</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="maybe"><span class="type-signature"></span>maybe<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>occurs zero or one times (x?)</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#maybe">Term#maybe</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1055">line 1055</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="multiple"><span class="type-signature"></span>multiple<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>occurs at least min times and (optional) at most max times (?|<em>|+|{min,}|{min,max})
occurs at least min times and (optional) at most max times (?|</em>|+|{min,}|{min,max})</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#multiple">Term#multiple</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1077">line 1077</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="notContains"><span class="type-signature"></span>notContains<span class="signature">(&hellip;terms)</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>terms</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                    &lt;repeatable><br>
                
                </td>
            

            <td class="description last"><p>-</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#notContains">Term#notContains</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line989">line 989</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="notFollowedBy"><span class="type-signature"></span>notFollowedBy<span class="signature">(&hellip;terms)</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>Matches 'x' only if 'x' is not followed by 'y'. This is called a negated lookahead. (x(?!y))</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>terms</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                    &lt;repeatable><br>
                
                </td>
            

            <td class="description last"><p>-</p></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#notFollowedBy">Term#notFollowedBy</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1021">line 1021</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="regex"><span class="type-signature"></span>regex<span class="signature">(value)</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>Use the given regex, i.e., trust me, just put the value as is.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">RegExp</span>
|

<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#regex">Term#regex</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1152">line 1152</a>
    </li></ul></dd>
    

</dl>


        <h5>Example</h5>
        
    <pre class="prettyprint"><code>regex( /\w\d/ )       // ==> /\w\d/
regex( "\\w\\d" )     // ==> /\w\d/</code></pre>

    
</dd>

        
<dt>
    <h4 class="name" id="reluctant"><span class="type-signature"></span>reluctant<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>This is an alias of <code>lazy()</code>.</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#reluctant">Term#reluctant</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1132">line 1132</a>
    </li></ul></dd>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="repeat"><span class="type-signature"></span>repeat<span class="signature">()</span><span class="type-signature"></span></h4>

    
</dt>
<dd>

    
    <div class="description">
        <p>occurs at least once or exactly specified times (+|{n})</p>
    </div>
    

<dl class="details">
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Term.html#repeat">Term#repeat</a>
    </li></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="regexgen.js.html">regexgen.js</a>, <a href="regexgen.js.html#line1063">line 1063</a>
    </li></ul></dd>
    

</dl>


</dd>

        </dl>
    

</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Capture.html">Capture</a></li><li><a href="CaptureReference.html">CaptureReference</a></li><li><a href="Label.html">Label</a></li><li><a href="Modifier.html">Modifier</a></li><li><a href="RegexOverwrite.html">RegexOverwrite</a></li><li><a href="Sequence.html">Sequence</a></li><li><a href="Term.html">Term</a></li></ul><h3>Namespaces</h3><ul><li><a href="regexGen.html">regexGen</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Fri Dec 05 2014 01:51:59 GMT+0800 (台北標準時間)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>