aboutsummaryrefslogtreecommitdiff
path: root/docs/examples/spinner.lua.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/examples/spinner.lua.html')
-rw-r--r--docs/examples/spinner.lua.html144
1 files changed, 144 insertions, 0 deletions
diff --git a/docs/examples/spinner.lua.html b/docs/examples/spinner.lua.html
new file mode 100644
index 0000000..181cbe5
--- /dev/null
+++ b/docs/examples/spinner.lua.html
@@ -0,0 +1,144 @@
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><a href="../examples/read.lua.html">read.lua</a></li>
42 <li><a href="../examples/readline.lua.html">readline.lua</a></li>
43 <li><strong>spinner.lua</strong></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>spinner.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
74An example to display a spinner, whilst a long running task executes.
75
76]]</span>
77
78
79<span class="comment">-- start make backup, to auto-restore on exit
80</span>sys.<span class="function-name">autotermrestore</span>()
81<span class="comment">-- configure console
82</span>sys.<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_ECHO_INPUT - sys.CIF_LINE_INPUT)
83<span class="keyword">local</span> of = sys.<span class="function-name">tcgetattr</span>(<span class="global">io</span>.stdin)
84sys.<span class="function-name">tcsetattr</span>(<span class="global">io</span>.stdin, sys.TCSANOW, { lflag = of.lflag - sys.L_ICANON - sys.L_ECHO })
85sys.<span class="function-name">setnonblock</span>(<span class="global">io</span>.stdin, <span class="keyword">true</span>)
86
87
88
89<span class="keyword">local</span> <span class="keyword">function</span> <span class="function-name">hideCursor</span>()
90 <span class="global">io</span>.<span class="function-name">write</span>(<span class="string">"\27[?25l"</span>)
91 <span class="global">io</span>.<span class="function-name">flush</span>()
92<span class="keyword">end</span>
93
94<span class="keyword">local</span> <span class="keyword">function</span> <span class="function-name">showCursor</span>()
95 <span class="global">io</span>.<span class="function-name">write</span>(<span class="string">"\27[?25h"</span>)
96 <span class="global">io</span>.<span class="function-name">flush</span>()
97<span class="keyword">end</span>
98
99<span class="keyword">local</span> <span class="keyword">function</span> <span class="function-name">left</span>(n)
100 <span class="global">io</span>.<span class="function-name">write</span>(<span class="string">"\27["</span>,n <span class="keyword">or</span> <span class="number">1</span>,<span class="string">"D"</span>)
101 <span class="global">io</span>.<span class="function-name">flush</span>()
102<span class="keyword">end</span>
103
104
105
106<span class="keyword">local</span> spinner <span class="keyword">do</span>
107 <span class="keyword">local</span> spin = <span class="string">[[|/-\]]</span>
108 <span class="keyword">local</span> i = <span class="number">1</span>
109 spinner = <span class="keyword">function</span>()
110 <span class="function-name">hideCursor</span>()
111 <span class="global">io</span>.<span class="function-name">write</span>(spin:<span class="function-name">sub</span>(i, i))
112 <span class="function-name">left</span>()
113 i = i + <span class="number">1</span>
114 <span class="keyword">if</span> i &gt; #spin <span class="keyword">then</span> i = <span class="number">1</span> <span class="keyword">end</span>
115
116 <span class="keyword">if</span> sys.<span class="function-name">readkey</span>(<span class="number">0</span>) ~= <span class="keyword">nil</span> <span class="keyword">then</span>
117 <span class="keyword">while</span> sys.<span class="function-name">readkey</span>(<span class="number">0</span>) ~= <span class="keyword">nil</span> <span class="keyword">do</span> <span class="keyword">end</span> <span class="comment">-- consume keys pressed
118</span> <span class="global">io</span>.<span class="function-name">write</span>(<span class="string">" "</span>);
119 <span class="function-name">left</span>()
120 <span class="function-name">showCursor</span>()
121 <span class="keyword">return</span> <span class="keyword">true</span>
122 <span class="keyword">else</span>
123 <span class="keyword">return</span> <span class="keyword">false</span>
124 <span class="keyword">end</span>
125 <span class="keyword">end</span>
126<span class="keyword">end</span>
127
128<span class="global">io</span>.stdout:<span class="function-name">write</span>(<span class="string">"press any key to stop the spinner... "</span>)
129<span class="keyword">while</span> <span class="keyword">not</span> <span class="function-name">spinner</span>() <span class="keyword">do</span>
130 sys.<span class="function-name">sleep</span>(<span class="number">0.1</span>)
131<span class="keyword">end</span>
132
133<span class="global">print</span>(<span class="string">"Done!"</span>)</pre>
134
135
136</div> <!-- id="content" -->
137</div> <!-- id="main" -->
138<div id="about">
139<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
140<i style="float:right;">Last updated 2024-06-20 23:11:37 </i>
141</div> <!-- id="about" -->
142</div> <!-- id="container" -->
143</body>
144</html>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-12-24 17:21:37 +0000