docs: updated for literals

Author: cybercoder-naj

docs/-parkour/io.github.cybercodernaj.parkour.lexer/-literals/-literals.html

@@ -61,12 +61,12 @@
                 <div class="sidebar--inner" id="sideMenu"></div>
             </div>
             <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageIds="Parkour::io.github.cybercodernaj.parkour.lexer/Literals/Literals/#/PointingToDeclaration//769193423">
+<div class="main-content" data-page-type="member" id="content" pageIds="Parkour::io.github.cybercodernaj.parkour.lexer/Literals/Literals/#kotlin.text.Regex?#kotlin.text.Regex?#kotlin.collections.Set[kotlin.String]#kotlin.collections.List[kotlin.Pair[kotlin.text.Regex,kotlin.Function1[kotlin.String,kotlin.Char]]]/PointingToDeclaration//769193423">
   <div class="breadcrumbs"><a href="../../../index.html">Parkour</a><span class="delimiter">/</span><a href="../index.html">io.github.cybercodernaj.parkour.lexer</a><span class="delimiter">/</span><a href="index.html">Literals</a><span class="delimiter">/</span><span class="current">Literals</span></div>
   <div class="cover ">
     <h1 class="cover"><span><span>Literals</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/Literals.kt#L8">source</a>)</span></span></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">integerLiteral<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">?</span><span class="token operator"> = </span>Regex(&quot;&quot;&quot;[-+]?[0-9_]+&quot;&quot;&quot;)<span class="token punctuation">, </span></span><span class="parameter ">floatingLiteral<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">?</span><span class="token operator"> = </span>Regex(&quot;&quot;&quot;[-+]?[0-9_]*\.[0-9_]+(?:[eE][-+]?[0-9_]+)?&quot;&quot;&quot;)<span class="token punctuation">, </span></span><span class="parameter ">singleLineString<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token operator"> = </span>setOf(&quot;\&quot;&quot;, &quot;\'&quot;)<span class="token punctuation">, </span></span><span class="parameter ">escapeSequences<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token punctuation">, </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html">Char</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator"> = </span>emptyList()</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/Literals.kt#L24">source</a>)</span></span></div><p class="paragraph">creates a configuration of literals for the lexer.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>integer</span><wbr></wbr><span><span>Literal</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a regex that detects an integer literal.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>floating</span><wbr></wbr><span><span>Literal</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a regex that detects a floating point number literal.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>single</span><wbr></wbr><span>Line</span><wbr></wbr><span><span>String</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a set of strings that denote the start and end enclosing strings. The lexer will throw a <a href="../../io.github.cybercodernaj.parkour.exceptions/-lexical-exception/index.html">LexicalException</a> when a string literal is not terminated in the same line.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>escape</span><wbr></wbr><span><span>Sequences</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a list of regex that matches an escape sequence. On match, it will return a Char based on the string matched.</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

docs/-parkour/io.github.cybercodernaj.parkour.lexer/-literals/index.html

@@ -65,24 +65,24 @@
   <div class="breadcrumbs"><a href="../../../index.html">Parkour</a><span class="delimiter">/</span><a href="../index.html">io.github.cybercodernaj.parkour.lexer</a><span class="delimiter">/</span><span class="current">Literals</span></div>
   <div class="cover ">
     <h1 class="cover"><span><span>Literals</span></span></h1>
-    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">Literals</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/Literals.kt#L8">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">Nishant Aanjaney Jalan</p></span><span class="kdoc-tag"><h4 class="">Since</h4><p class="paragraph">0.1.0</p></span></div></div>
+    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">Literals</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">integerLiteral<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">?</span><span class="token operator"> = </span>Regex(&quot;&quot;&quot;[-+]?[0-9_]+&quot;&quot;&quot;)<span class="token punctuation">, </span></span><span class="parameter ">floatingLiteral<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">?</span><span class="token operator"> = </span>Regex(&quot;&quot;&quot;[-+]?[0-9_]*\.[0-9_]+(?:[eE][-+]?[0-9_]+)?&quot;&quot;&quot;)<span class="token punctuation">, </span></span><span class="parameter ">singleLineString<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token operator"> = </span>setOf(&quot;\&quot;&quot;, &quot;\'&quot;)<span class="token punctuation">, </span></span><span class="parameter ">escapeSequences<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token punctuation">, </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html">Char</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator"> = </span>emptyList()</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/Literals.kt#L24">source</a>)</span></span></div><p class="paragraph">A configuration class to lex literals. There are only three types of literals the lexer manages.</p><ol><li><p class="paragraph">Integer literals are normally lexed with a pure stream of numbers with underscores.</p></li><li><p class="paragraph">Floating literals are normally lexed with a forced decimal point with optional exponentiation.</p></li><li><p class="paragraph">String literals are normally lexed exact strings till it finds the original match.</p></li></ol><p class="paragraph">Additionally, escape sequences are required to input special characters inside string literals.</p><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">Nishant Aanjaney Jalan</p></span><span class="kdoc-tag"><h4 class="">Since</h4><p class="paragraph">0.1.0</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>integer</span><wbr></wbr><span><span>Literal</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a regex that detects an integer literal.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>floating</span><wbr></wbr><span><span>Literal</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a regex that detects a floating point number literal.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>single</span><wbr></wbr><span>Line</span><wbr></wbr><span><span>String</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a set of strings that denote the start and end enclosing strings. The lexer will throw a <a href="../../io.github.cybercodernaj.parkour.exceptions/-lexical-exception/index.html">LexicalException</a> when a string literal is not terminated in the same line.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>escape</span><wbr></wbr><span><span>Sequences</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a list of regex that matches an escape sequence. On match, it will return a Char based on the string matched.</p></div></div></div></div></div></div></div>
   </div>
   <div class="tabbedcontent">
     <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
     <div class="tabs-section-body">
       <div data-togglable="CONSTRUCTOR">
         <h2 class="">Constructors</h2>
-        <div class="table"><a data-name="-217947869%2FConstructors%2F769193423" anchor-label="Literals" id="-217947869%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
+        <div class="table"><a data-name="1927156273%2FConstructors%2F769193423" anchor-label="Literals" id="1927156273%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
           <div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
             <div class="main-subrow keyValue ">
               <div class=""><span class="inline-flex">
                   <div><a href="-literals.html"><span><span>Literals</span></span></a></div>
-<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-217947869%2FConstructors%2F769193423"></span>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1927156273%2FConstructors%2F769193423"></span>
                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                   </span></span></div>
               <div>
                 <div class="title">
-                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
+                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">integerLiteral<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">?</span><span class="token operator"> = </span>Regex(&quot;&quot;&quot;[-+]?[0-9_]+&quot;&quot;&quot;)<span class="token punctuation">, </span></span><span class="parameter ">floatingLiteral<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">?</span><span class="token operator"> = </span>Regex(&quot;&quot;&quot;[-+]?[0-9_]*\.[0-9_]+(?:[eE][-+]?[0-9_]+)?&quot;&quot;&quot;)<span class="token punctuation">, </span></span><span class="parameter ">singleLineString<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="token operator"> = </span>setOf(&quot;\&quot;&quot;, &quot;\'&quot;)<span class="token punctuation">, </span></span><span class="parameter ">escapeSequences<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token punctuation">, </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html">Char</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator"> = </span>emptyList()</span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">creates a configuration of literals for the lexer.</p></div></div></div>
                 </div>
               </div>
             </div>