aboutsummaryrefslogtreecommitdiff
path: root/docs/examples/readline.lua.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/examples/readline.lua.html10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/examples/readline.lua.html b/docs/examples/readline.lua.html
index a78f5b3..ba453ad 100644
--- a/docs/examples/readline.lua.html
+++ b/docs/examples/readline.lua.html
@@ -213,10 +213,12 @@ readline.__index = readline
213</span><span class="comment">-- @tparam[opt=""] string opts.value the default value 213</span><span class="comment">-- @tparam[opt=""] string opts.value the default value
214</span><span class="comment">-- @tparam[opt=<code>#value</code>] number opts.position of the cursor in the input 214</span><span class="comment">-- @tparam[opt=<code>#value</code>] number opts.position of the cursor in the input
215</span><span class="comment">-- @tparam[opt={"\10"/"\13"}] table opts.exit_keys an array of keys that will cause the readline to exit 215</span><span class="comment">-- @tparam[opt={"\10"/"\13"}] table opts.exit_keys an array of keys that will cause the readline to exit
216</span><span class="comment">-- @tparam[opt=system.sleep] function opts.fsleep the sleep function to use (see <a href="../modules/system.html#readansi">system.readansi</a>)
216</span><span class="comment">-- @treturn readline the new readline object 217</span><span class="comment">-- @treturn readline the new readline object
217</span><span class="keyword">function</span> readline.<span class="function-name">new</span>(opts) 218</span><span class="keyword">function</span> readline.<span class="function-name">new</span>(opts)
218 <span class="keyword">local</span> value = <span class="function-name">utf8parse</span>(opts.value <span class="keyword">or</span> <span class="string">""</span>) 219 <span class="keyword">local</span> value = <span class="function-name">utf8parse</span>(opts.value <span class="keyword">or</span> <span class="string">""</span>)
219 <span class="keyword">local</span> prompt = <span class="function-name">utf8parse</span>(opts.prompt <span class="keyword">or</span> <span class="string">""</span>) 220 <span class="keyword">local</span> prompt = <span class="function-name">utf8parse</span>(opts.prompt <span class="keyword">or</span> <span class="string">""</span>)
221 <span class="keyword">local</span> fsleep = opts.fsleep <span class="keyword">or</span> sys.sleep
220 <span class="keyword">local</span> pos = <span class="global">math</span>.<span class="function-name">floor</span>(opts.position <span class="keyword">or</span> (#value + <span class="number">1</span>)) 222 <span class="keyword">local</span> pos = <span class="global">math</span>.<span class="function-name">floor</span>(opts.position <span class="keyword">or</span> (#value + <span class="number">1</span>))
221 pos = <span class="global">math</span>.<span class="function-name">max</span>(<span class="global">math</span>.<span class="function-name">min</span>(pos, (#value + <span class="number">1</span>)), <span class="number">1</span>) 223 pos = <span class="global">math</span>.<span class="function-name">max</span>(<span class="global">math</span>.<span class="function-name">min</span>(pos, (#value + <span class="number">1</span>)), <span class="number">1</span>)
222 <span class="keyword">local</span> len = <span class="global">math</span>.<span class="function-name">floor</span>(opts.max_length <span class="keyword">or</span> <span class="number">80</span>) 224 <span class="keyword">local</span> len = <span class="global">math</span>.<span class="function-name">floor</span>(opts.max_length <span class="keyword">or</span> <span class="number">80</span>)
@@ -244,6 +246,7 @@ readline.__index = readline
244</span> position = pos, <span class="comment">-- the current position in the input 246</span> position = pos, <span class="comment">-- the current position in the input
245</span> drawn_before = <span class="keyword">false</span>, <span class="comment">-- if the prompt has been drawn 247</span> drawn_before = <span class="keyword">false</span>, <span class="comment">-- if the prompt has been drawn
246</span> exit_keys = exit_keys, <span class="comment">-- the keys that will cause the readline to exit 248</span> exit_keys = exit_keys, <span class="comment">-- the keys that will cause the readline to exit
249</span> fsleep = fsleep, <span class="comment">-- the sleep function to use
247</span> } 250</span> }
248 251
249 <span class="global">setmetatable</span>(self, readline) 252 <span class="global">setmetatable</span>(self, readline)
@@ -482,7 +485,7 @@ readline.__index = readline
482 <span class="keyword">local</span> timeout_end = sys.<span class="function-name">gettime</span>() + timeout 485 <span class="keyword">local</span> timeout_end = sys.<span class="function-name">gettime</span>() + timeout
483 486
484 <span class="keyword">while</span> <span class="keyword">true</span> <span class="keyword">do</span> 487 <span class="keyword">while</span> <span class="keyword">true</span> <span class="keyword">do</span>
485 <span class="keyword">local</span> key, keytype = sys.<span class="function-name">readansi</span>(timeout_end - sys.<span class="function-name">gettime</span>()) 488 <span class="keyword">local</span> key, keytype = sys.<span class="function-name">readansi</span>(timeout_end - sys.<span class="function-name">gettime</span>(), self.fsleep)
486 <span class="keyword">if</span> <span class="keyword">not</span> key <span class="keyword">then</span> 489 <span class="keyword">if</span> <span class="keyword">not</span> key <span class="keyword">then</span>
487 <span class="comment">-- error or timeout 490 <span class="comment">-- error or timeout
488</span> <span class="keyword">return</span> <span class="keyword">nil</span>, keytype 491</span> <span class="keyword">return</span> <span class="keyword">nil</span>, keytype
@@ -527,7 +530,8 @@ sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</
527 value = <span class="string">"Hello, 你-好 World 🚀!"</span>, 530 value = <span class="string">"Hello, 你-好 World 🚀!"</span>,
528 <span class="comment">-- position = 2, 531 <span class="comment">-- position = 2,
529</span> exit_keys = {key_sequences.enter, <span class="string">"\27"</span>, <span class="string">"\t"</span>, <span class="string">"\27[Z"</span>}, <span class="comment">-- enter, escape, tab, shift-tab 532</span> exit_keys = {key_sequences.enter, <span class="string">"\27"</span>, <span class="string">"\t"</span>, <span class="string">"\27[Z"</span>}, <span class="comment">-- enter, escape, tab, shift-tab
530</span>} 533</span> fsleep = sys.sleep,
534}
531 535
532 536
533<span class="keyword">local</span> result, key = <span class="function-name">rl</span>() 537<span class="keyword">local</span> result, key = <span class="function-name">rl</span>()
@@ -545,7 +549,7 @@ sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</
545</div> <!-- id="main" --> 549</div> <!-- id="main" -->
546<div id="about"> 550<div id="about">
547<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> 551<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
548<i style="float:right;">Last updated 2024-12-18 02:50:03 </i> 552<i style="float:right;">Last updated 2025-03-02 19:43:40 </i>
549</div> <!-- id="about" --> 553</div> <!-- id="about" -->
550</div> <!-- id="container" --> 554</div> <!-- id="container" -->
551</body> 555</body>