aboutsummaryrefslogtreecommitdiff
path: root/docs/examples/read.lua.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/examples/read.lua.html')
-rw-r--r--docs/examples/read.lua.html150
1 files changed, 150 insertions, 0 deletions
diff --git a/docs/examples/read.lua.html b/docs/examples/read.lua.html
new file mode 100644
index 0000000..c7697d3
--- /dev/null
+++ b/docs/examples/read.lua.html
@@ -0,0 +1,150 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5<head>
6 <title>Lua-System docs</title>
7 <link rel="stylesheet" href="../ldoc.css" type="text/css" />
8</head>
9<body>
10
11<div id="container">
12
13<div id="product">
14 <div id="product_logo"></div>
15 <div id="product_name"><big><b></b></big></div>
16 <div id="product_description"></div>
17</div> <!-- id="product" -->
18
19
20<div id="main">
21
22
23<!-- Menu -->
24
25<div id="navigation">
26<br/>
27<h1>Lua-System</h1>
28
29
30<ul>
31 <li><a href="../index.html">Index</a></li>
32</ul>
33
34
35
36<h2>Examples</h2>
37<ul class="nowrap">
38 <li><a href="../examples/compat.lua.html">compat.lua</a></li>
39 <li><a href="../examples/flag_debugging.lua.html">flag_debugging.lua</a></li>
40 <li><a href="../examples/password_input.lua.html">password_input.lua</a></li>
41 <li><strong>read.lua</strong></li>
42 <li><a href="../examples/readline.lua.html">readline.lua</a></li>
43 <li><a href="../examples/spinner.lua.html">spinner.lua</a></li>
44 <li><a href="../examples/spiral_snake.lua.html">spiral_snake.lua</a></li>
45 <li><a href="../examples/terminalsize.lua.html">terminalsize.lua</a></li>
46</ul>
47<h2>Modules</h2>
48<ul class="nowrap">
49 <li><a href="../modules/system.html">system</a></li>
50</ul>
51<h2>Classes</h2>
52<ul class="nowrap">
53 <li><a href="../classes/bitflags.html">bitflags</a></li>
54</ul>
55<h2>Topics</h2>
56<ul class="">
57 <li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
58 <li><a href="../topics/02-development.md.html">2. Development</a></li>
59 <li><a href="../topics/03-terminal.md.html">3. Terminal functionality</a></li>
60 <li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li>
61 <li><a href="../topics/LICENSE.md.html">MIT License</a></li>
62</ul>
63
64</div>
65
66<div id="content">
67
68 <h2>read.lua</h2>
69<pre>
70<span class="keyword">local</span> sys = <span class="global">require</span> <span class="string">"system"</span>
71
72<span class="global">print</span> <span class="string">[[
73
74This example shows how to do a non-blocking read from the cli.
75
76]]</span>
77
78<span class="comment">-- setup Windows console to handle ANSI processing
79</span><span class="keyword">local</span> of_in = sys.<span class="function-name">getconsoleflags</span>(<span class="global">io</span>.stdin)
80<span class="keyword">local</span> of_out = sys.<span class="function-name">getconsoleflags</span>(<span class="global">io</span>.stdout)
81sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</span>.stdout, sys.<span class="function-name">getconsoleflags</span>(<span class="global">io</span>.stdout) + sys.COF_VIRTUAL_TERMINAL_PROCESSING)
82sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</span>.stdin, sys.<span class="function-name">getconsoleflags</span>(<span class="global">io</span>.stdin) + sys.CIF_VIRTUAL_TERMINAL_INPUT)
83
84<span class="comment">-- setup Posix terminal to use non-blocking mode, and disable line-mode
85</span><span class="keyword">local</span> of_attr = sys.<span class="function-name">tcgetattr</span>(<span class="global">io</span>.stdin)
86<span class="keyword">local</span> of_block = sys.<span class="function-name">getnonblock</span>(<span class="global">io</span>.stdin)
87sys.<span class="function-name">setnonblock</span>(<span class="global">io</span>.stdin, <span class="keyword">true</span>)
88sys.<span class="function-name">tcsetattr</span>(<span class="global">io</span>.stdin, sys.TCSANOW, {
89 lflag = of_attr.lflag - sys.L_ICANON - sys.L_ECHO, <span class="comment">-- disable canonical mode and echo
90</span>})
91
92<span class="comment">-- cursor sequences
93</span><span class="keyword">local</span> get_cursor_pos = <span class="string">"\27[6n"</span>
94
95
96
97<span class="global">print</span>(<span class="string">"Press a key, or 'A' to get cursor position, 'ESC' to exit"</span>)
98<span class="keyword">while</span> <span class="keyword">true</span> <span class="keyword">do</span>
99 <span class="keyword">local</span> key, keytype
100
101 <span class="comment">-- wait for a key
102</span> <span class="keyword">while</span> <span class="keyword">not</span> key <span class="keyword">do</span>
103 key, keytype = sys.<span class="function-name">readansi</span>(<span class="global">math</span>.huge)
104 <span class="keyword">end</span>
105
106 <span class="keyword">if</span> key == <span class="string">"A"</span> <span class="keyword">then</span> <span class="global">io</span>.<span class="function-name">write</span>(get_cursor_pos); <span class="global">io</span>.<span class="function-name">flush</span>() <span class="keyword">end</span>
107
108 <span class="comment">-- check if we got a key or ANSI sequence
109</span> <span class="keyword">if</span> keytype == <span class="string">"char"</span> <span class="keyword">then</span>
110 <span class="comment">-- just a key
111</span> <span class="keyword">local</span> b = key:<span class="function-name">byte</span>()
112 <span class="keyword">if</span> b &lt; <span class="number">32</span> <span class="keyword">then</span>
113 key = <span class="string">"."</span> <span class="comment">-- replace control characters with a simple "." to not mess up the screen
114</span> <span class="keyword">end</span>
115
116 <span class="global">print</span>(<span class="string">"you pressed: "</span> .. key .. <span class="string">" ("</span> .. b .. <span class="string">")"</span>)
117 <span class="keyword">if</span> b == <span class="number">27</span> <span class="keyword">then</span>
118 <span class="global">print</span>(<span class="string">"Escape pressed, exiting"</span>)
119 <span class="keyword">break</span>
120 <span class="keyword">end</span>
121
122 <span class="keyword">elseif</span> keytype == <span class="string">"ansi"</span> <span class="keyword">then</span>
123 <span class="comment">-- we got an ANSI sequence
124</span> <span class="keyword">local</span> seq = { key:<span class="function-name">byte</span>(<span class="number">1</span>, #key) }
125 <span class="global">print</span>(<span class="string">"ANSI sequence received: "</span> .. key:<span class="function-name">sub</span>(<span class="number">2</span>,-<span class="number">1</span>), <span class="string">"(bytes: "</span> .. <span class="global">table</span>.<span class="function-name">concat</span>(seq, <span class="string">", "</span>)..<span class="string">")"</span>)
126
127 <span class="keyword">else</span>
128 <span class="global">print</span>(<span class="string">"unknown key type received: "</span> .. <span class="global">tostring</span>(keytype))
129 <span class="keyword">end</span>
130<span class="keyword">end</span>
131
132
133
134<span class="comment">-- Clean up afterwards
135</span>sys.<span class="function-name">setnonblock</span>(<span class="global">io</span>.stdin, <span class="keyword">false</span>)
136sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</span>.stdout, of_out)
137sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</span>.stdin, of_in)
138sys.<span class="function-name">tcsetattr</span>(<span class="global">io</span>.stdin, sys.TCSANOW, of_attr)
139sys.<span class="function-name">setnonblock</span>(<span class="global">io</span>.stdin, of_block)</pre>
140
141
142</div> <!-- id="content" -->
143</div> <!-- id="main" -->
144<div id="about">
145<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
146<i style="float:right;">Last updated 2024-06-20 23:11:37 </i>
147</div> <!-- id="about" -->
148</div> <!-- id="container" -->
149</body>
150</html>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-12-24 17:20:34 +0000