1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
|
/// @submodule system
// Unix: see https://blog.nelhage.com/2009/12/a-brief-introduction-to-termios-termios3-and-stty/
// Windows: see https://learn.microsoft.com/en-us/windows/console/console-reference
#include <lua.h>
#include <lauxlib.h>
#include <lualib.h>
#include "compat.h"
#include "bitflags.h"
#ifndef _MSC_VER
# include <unistd.h>
#endif
#ifdef _WIN32
# include <windows.h>
#else
# include <termios.h>
# include <string.h>
# include <errno.h>
# include <fcntl.h>
# include <sys/ioctl.h>
# include <unistd.h>
#endif
#ifdef _WIN32
// after an error is returned, GetLastError() result can be passed to this function to get a string
// representation of the error on the stack.
// result will be nil+error on the stack, always 2 results.
static void termFormatError(lua_State *L, DWORD errorCode, const char* prefix) {
//static void FormatErrorAndReturn(lua_State *L, DWORD errorCode, const char* prefix) {
LPSTR messageBuffer = NULL;
FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
NULL, errorCode, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPSTR)&messageBuffer, 0, NULL);
lua_pushnil(L);
if (messageBuffer) {
if (prefix) {
lua_pushfstring(L, "%s: %s", prefix, messageBuffer);
} else {
lua_pushstring(L, messageBuffer);
}
LocalFree(messageBuffer);
} else {
lua_pushfstring(L, "%sError code %d", prefix ? prefix : "", errorCode);
}
}
#else
static int pusherror(lua_State *L, const char *info)
{
lua_pushnil(L);
if (info==NULL)
lua_pushstring(L, strerror(errno));
else
lua_pushfstring(L, "%s: %s", info, strerror(errno));
lua_pushinteger(L, errno);
return 3;
}
#endif
/***
Checks if a file-handle is a TTY.
@function isatty
@tparam file file the file-handle to check, one of `io.stdin`, `io.stdout`, `io.stderr`.
@treturn boolean true if the file is a tty
@usage
local system = require('system')
if system.isatty(io.stdin) then
-- enable ANSI coloring etc on Windows, does nothing in Posix.
local flags = system.getconsoleflags(io.stdout)
system.setconsoleflags(io.stdout, flags + sys.COF_VIRTUAL_TERMINAL_PROCESSING)
end
*/
static int lst_isatty(lua_State* L) {
FILE **fh = (FILE **) luaL_checkudata(L, 1, LUA_FILEHANDLE);
lua_pushboolean(L, isatty(fileno(*fh)));
return 1;
}
/*-------------------------------------------------------------------------
* Windows Get/SetConsoleMode functions
*-------------------------------------------------------------------------*/
typedef struct ls_RegConst {
const char *name;
DWORD value;
} ls_RegConst;
// Define a macro to check if a constant is defined and set it to 0 if not.
// This is needed because some flags are not defined on all platforms. So we
// still export the constants, but they will be all 0, and hence not do anything.
#ifdef _WIN32
#define CHECK_WIN_FLAG_OR_ZERO(flag) flag
#define CHECK_NIX_FLAG_OR_ZERO(flag) 0
#else
#define CHECK_WIN_FLAG_OR_ZERO(flag) 0
#define CHECK_NIX_FLAG_OR_ZERO(flag) flag
#endif
// Export Windows constants to Lua
static const struct ls_RegConst win_console_in_flags[] = {
// Console Input Flags
{"CIF_ECHO_INPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_ECHO_INPUT)},
{"CIF_INSERT_MODE", CHECK_WIN_FLAG_OR_ZERO(ENABLE_INSERT_MODE)},
{"CIF_LINE_INPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_LINE_INPUT)},
{"CIF_MOUSE_INPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_MOUSE_INPUT)},
{"CIF_PROCESSED_INPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_PROCESSED_INPUT)},
{"CIF_QUICK_EDIT_MODE", CHECK_WIN_FLAG_OR_ZERO(ENABLE_QUICK_EDIT_MODE)},
{"CIF_WINDOW_INPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_WINDOW_INPUT)},
{"CIF_VIRTUAL_TERMINAL_INPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_VIRTUAL_TERMINAL_INPUT)},
{"CIF_EXTENDED_FLAGS", CHECK_WIN_FLAG_OR_ZERO(ENABLE_EXTENDED_FLAGS)},
{"CIF_AUTO_POSITION", CHECK_WIN_FLAG_OR_ZERO(ENABLE_AUTO_POSITION)},
{NULL, 0}
};
static const struct ls_RegConst win_console_out_flags[] = {
// Console Output Flags
{"COF_PROCESSED_OUTPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_PROCESSED_OUTPUT)},
{"COF_WRAP_AT_EOL_OUTPUT", CHECK_WIN_FLAG_OR_ZERO(ENABLE_WRAP_AT_EOL_OUTPUT)},
{"COF_VIRTUAL_TERMINAL_PROCESSING", CHECK_WIN_FLAG_OR_ZERO(ENABLE_VIRTUAL_TERMINAL_PROCESSING)},
{"COF_DISABLE_NEWLINE_AUTO_RETURN", CHECK_WIN_FLAG_OR_ZERO(DISABLE_NEWLINE_AUTO_RETURN)},
{"COF_ENABLE_LVB_GRID_WORLDWIDE", CHECK_WIN_FLAG_OR_ZERO(ENABLE_LVB_GRID_WORLDWIDE)},
{NULL, 0}
};
// Export Unix constants to Lua
static const struct ls_RegConst nix_tcsetattr_actions[] = {
// The optional actions for tcsetattr
{"TCSANOW", CHECK_NIX_FLAG_OR_ZERO(TCSANOW)},
{"TCSADRAIN", CHECK_NIX_FLAG_OR_ZERO(TCSADRAIN)},
{"TCSAFLUSH", CHECK_NIX_FLAG_OR_ZERO(TCSAFLUSH)},
{NULL, 0}
};
static const struct ls_RegConst nix_console_i_flags[] = {
// Input flags (c_iflag)
{"I_IGNBRK", CHECK_NIX_FLAG_OR_ZERO(IGNBRK)},
{"I_BRKINT", CHECK_NIX_FLAG_OR_ZERO(BRKINT)},
{"I_IGNPAR", CHECK_NIX_FLAG_OR_ZERO(IGNPAR)},
{"I_PARMRK", CHECK_NIX_FLAG_OR_ZERO(PARMRK)},
{"I_INPCK", CHECK_NIX_FLAG_OR_ZERO(INPCK)},
{"I_ISTRIP", CHECK_NIX_FLAG_OR_ZERO(ISTRIP)},
{"I_INLCR", CHECK_NIX_FLAG_OR_ZERO(INLCR)},
{"I_IGNCR", CHECK_NIX_FLAG_OR_ZERO(IGNCR)},
{"I_ICRNL", CHECK_NIX_FLAG_OR_ZERO(ICRNL)},
#ifndef __APPLE__
{"I_IUCLC", CHECK_NIX_FLAG_OR_ZERO(IUCLC)}, // Might not be available on all systems
#else
{"I_IUCLC", 0},
#endif
{"I_IXON", CHECK_NIX_FLAG_OR_ZERO(IXON)},
{"I_IXANY", CHECK_NIX_FLAG_OR_ZERO(IXANY)},
{"I_IXOFF", CHECK_NIX_FLAG_OR_ZERO(IXOFF)},
{"I_IMAXBEL", CHECK_NIX_FLAG_OR_ZERO(IMAXBEL)},
{NULL, 0}
};
static const struct ls_RegConst nix_console_o_flags[] = {
// Output flags (c_oflag)
{"O_OPOST", CHECK_NIX_FLAG_OR_ZERO(OPOST)},
#ifndef __APPLE__
{"O_OLCUC", CHECK_NIX_FLAG_OR_ZERO(OLCUC)}, // Might not be available on all systems
#else
{"O_OLCUC", 0},
#endif
{"O_ONLCR", CHECK_NIX_FLAG_OR_ZERO(ONLCR)},
{"O_OCRNL", CHECK_NIX_FLAG_OR_ZERO(OCRNL)},
{"O_ONOCR", CHECK_NIX_FLAG_OR_ZERO(ONOCR)},
{"O_ONLRET", CHECK_NIX_FLAG_OR_ZERO(ONLRET)},
{"O_OFILL", CHECK_NIX_FLAG_OR_ZERO(OFILL)},
{"O_OFDEL", CHECK_NIX_FLAG_OR_ZERO(OFDEL)},
{"O_NLDLY", CHECK_NIX_FLAG_OR_ZERO(NLDLY)},
{"O_CRDLY", CHECK_NIX_FLAG_OR_ZERO(CRDLY)},
{"O_TABDLY", CHECK_NIX_FLAG_OR_ZERO(TABDLY)},
{"O_BSDLY", CHECK_NIX_FLAG_OR_ZERO(BSDLY)},
{"O_VTDLY", CHECK_NIX_FLAG_OR_ZERO(VTDLY)},
{"O_FFDLY", CHECK_NIX_FLAG_OR_ZERO(FFDLY)},
{NULL, 0}
};
static const struct ls_RegConst nix_console_l_flags[] = {
// Local flags (c_lflag)
{"L_ISIG", CHECK_NIX_FLAG_OR_ZERO(ISIG)},
{"L_ICANON", CHECK_NIX_FLAG_OR_ZERO(ICANON)},
#ifndef __APPLE__
{"L_XCASE", CHECK_NIX_FLAG_OR_ZERO(XCASE)}, // Might not be available on all systems
#else
{"L_XCASE", 0},
#endif
{"L_ECHO", CHECK_NIX_FLAG_OR_ZERO(ECHO)},
{"L_ECHOE", CHECK_NIX_FLAG_OR_ZERO(ECHOE)},
{"L_ECHOK", CHECK_NIX_FLAG_OR_ZERO(ECHOK)},
{"L_ECHONL", CHECK_NIX_FLAG_OR_ZERO(ECHONL)},
{"L_NOFLSH", CHECK_NIX_FLAG_OR_ZERO(NOFLSH)},
{"L_TOSTOP", CHECK_NIX_FLAG_OR_ZERO(TOSTOP)},
{"L_ECHOCTL", CHECK_NIX_FLAG_OR_ZERO(ECHOCTL)}, // Might not be available on all systems
{"L_ECHOPRT", CHECK_NIX_FLAG_OR_ZERO(ECHOPRT)}, // Might not be available on all systems
{"L_ECHOKE", CHECK_NIX_FLAG_OR_ZERO(ECHOKE)}, // Might not be available on all systems
{"L_FLUSHO", CHECK_NIX_FLAG_OR_ZERO(FLUSHO)},
{"L_PENDIN", CHECK_NIX_FLAG_OR_ZERO(PENDIN)},
{"L_IEXTEN", CHECK_NIX_FLAG_OR_ZERO(IEXTEN)},
{NULL, 0}
};
static DWORD win_valid_in_flags = 0;
static DWORD win_valid_out_flags = 0;
static DWORD nix_valid_i_flags = 0;
static DWORD nix_valid_o_flags = 0;
static DWORD nix_valid_l_flags = 0;
static void initialize_valid_flags()
{
win_valid_in_flags = 0;
for (int i = 0; win_console_in_flags[i].name != NULL; i++)
{
win_valid_in_flags |= win_console_in_flags[i].value;
}
win_valid_out_flags = 0;
for (int i = 0; win_console_out_flags[i].name != NULL; i++)
{
win_valid_out_flags |= win_console_out_flags[i].value;
}
nix_valid_i_flags = 0;
for (int i = 0; nix_console_i_flags[i].name != NULL; i++)
{
nix_valid_i_flags |= nix_console_i_flags[i].value;
}
nix_valid_o_flags = 0;
for (int i = 0; nix_console_o_flags[i].name != NULL; i++)
{
nix_valid_o_flags |= nix_console_o_flags[i].value;
}
nix_valid_l_flags = 0;
for (int i = 0; nix_console_l_flags[i].name != NULL; i++)
{
nix_valid_l_flags |= nix_console_l_flags[i].value;
}
}
#ifdef _WIN32
// first item on the stack should be io.stdin, io.stderr, or io.stdout, second item
// should be the flags to validate.
// If it returns NULL, then it leaves nil+err on the stack
static HANDLE get_console_handle(lua_State *L, int flags_optional)
{
if (lua_gettop(L) < 1) {
luaL_argerror(L, 1, "expected file handle");
}
HANDLE handle;
DWORD valid;
FILE *file = *(FILE **)luaL_checkudata(L, 1, LUA_FILEHANDLE);
if (file == stdin && file != NULL) {
handle = GetStdHandle(STD_INPUT_HANDLE);
valid = win_valid_in_flags;
} else if (file == stdout && file != NULL) {
handle = GetStdHandle(STD_OUTPUT_HANDLE);
valid = win_valid_out_flags;
} else if (file == stderr && file != NULL) {
handle = GetStdHandle(STD_ERROR_HANDLE);
valid = win_valid_out_flags;
} else {
luaL_argerror(L, 1, "invalid file handle"); // does not return
}
if (handle == INVALID_HANDLE_VALUE) {
termFormatError(L, GetLastError(), "failed to retrieve std handle");
lua_error(L); // does not return
}
if (handle == NULL) {
lua_pushnil(L);
lua_pushliteral(L, "failed to get console handle");
return NULL;
}
if (flags_optional && lua_gettop(L) < 2) {
return handle;
}
if (lua_gettop(L) < 2) {
luaL_argerror(L, 2, "expected flags");
}
LSBF_BITFLAG flags = lsbf_checkbitflags(L, 2);
if ((flags & ~valid) != 0) {
luaL_argerror(L, 2, "invalid flags");
}
return handle;
}
#else
// first item on the stack should be io.stdin, io.stderr, or io.stdout. Throws a
// Lua error if the file is not one of these.
static int get_console_handle(lua_State *L)
{
FILE **file = (FILE **)luaL_checkudata(L, 1, LUA_FILEHANDLE);
if (file == NULL || *file == NULL) {
return luaL_argerror(L, 1, "expected file handle"); // call doesn't return
}
// Check if the file is stdin, stdout, or stderr
if (*file == stdin || *file == stdout || *file == stderr) {
// Push the file descriptor onto the Lua stack
return fileno(*file);
}
return luaL_argerror(L, 1, "invalid file handle"); // does not return
}
#endif
/***
Sets the console flags (Windows).
The `CIF_` and `COF_` constants are available on the module table. Where `CIF` are the
input flags (for use with `io.stdin`) and `COF` are the output flags (for use with
`io.stdout`/`io.stderr`).
To see flag status and constant names check `listconsoleflags`.
Note: not all combinations of flags are allowed, as some are mutually exclusive or mutually required.
See [setconsolemode documentation](https://learn.microsoft.com/en-us/windows/console/setconsolemode)
@function setconsoleflags
@tparam file file the file-handle to set the flags on
@tparam bitflags bitflags the flags to set/unset
@treturn[1] boolean `true` on success
@treturn[2] nil
@treturn[2] string error message
@usage
local system = require('system')
system.listconsoleflags(io.stdout) -- List all the available flags and their current status
local flags = system.getconsoleflags(io.stdout)
assert(system.setconsoleflags(io.stdout,
flags + system.COF_VIRTUAL_TERMINAL_PROCESSING)
system.listconsoleflags(io.stdout) -- List again to check the differences
*/
static int lst_setconsoleflags(lua_State *L)
{
#ifdef _WIN32
HANDLE console_handle = get_console_handle(L, 0);
if (console_handle == NULL) {
return 2; // error message is already on the stack
}
LSBF_BITFLAG new_console_mode = lsbf_checkbitflags(L, 2);
DWORD prev_console_mode;
if (GetConsoleMode(console_handle, &prev_console_mode) == 0)
{
termFormatError(L, GetLastError(), "failed to get console mode");
return 2;
}
int success = SetConsoleMode(console_handle, new_console_mode) != 0;
if (!success)
{
termFormatError(L, GetLastError(), "failed to set console mode");
return 2;
}
#endif
lua_pushboolean(L, 1);
return 1;
}
/***
Gets console flags (Windows).
@function getconsoleflags
@tparam file file the file-handle to get the flags from.
@treturn[1] bitflags the current console flags.
@treturn[2] nil
@treturn[2] string error message
@usage
local system = require('system')
local flags = system.getconsoleflags(io.stdout)
print("Current stdout flags:", tostring(flags))
if flags:has(system.COF_VIRTUAL_TERMINAL_PROCESSING + system.COF_PROCESSED_OUTPUT) then
print("Both flags are set")
else
print("At least one flag is not set")
end
*/
static int lst_getconsoleflags(lua_State *L)
{
DWORD console_mode = 0;
#ifdef _WIN32
HANDLE console_handle = get_console_handle(L, 1);
if (console_handle == NULL) {
return 2; // error message is already on the stack
}
if (GetConsoleMode(console_handle, &console_mode) == 0)
{
lua_pushnil(L);
lua_pushliteral(L, "failed to get console mode");
return 2;
}
#endif
lsbf_pushbitflags(L, console_mode);
return 1;
}
/*-------------------------------------------------------------------------
* Unix tcgetattr/tcsetattr functions
*-------------------------------------------------------------------------*/
// Code modified from the LuaPosix library by Gary V. Vaughan
// see https://github.com/luaposix/luaposix
/***
Get termios state.
The terminal attributes is a table with the following fields:
- `iflag` input flags
- `oflag` output flags
- `cflag` control flags
- `lflag` local flags
- `ispeed` input speed
- `ospeed` output speed
- `cc` control characters
@function tcgetattr
@tparam file fd file handle to operate on, one of `io.stdin`, `io.stdout`, `io.stderr`
@treturn[1] termios terminal attributes, if successful. On Windows the bitflags are all 0, and the `cc` table is empty.
@treturn[2] nil
@treturn[2] string error message
@treturn[2] int errnum
@return error message if failed
@usage
local system = require('system')
local status = assert(tcgetattr(io.stdin))
if status.iflag:has(system.I_IGNBRK) then
print("Ignoring break condition")
end
*/
static int lst_tcgetattr(lua_State *L)
{
#ifndef _WIN32
int r, i;
struct termios t;
int fd = get_console_handle(L);
r = tcgetattr(fd, &t);
if (r == -1) return pusherror(L, NULL);
lua_newtable(L);
lsbf_pushbitflags(L, t.c_iflag);
lua_setfield(L, -2, "iflag");
lsbf_pushbitflags(L, t.c_oflag);
lua_setfield(L, -2, "oflag");
lsbf_pushbitflags(L, t.c_lflag);
lua_setfield(L, -2, "lflag");
lsbf_pushbitflags(L, t.c_cflag);
lua_setfield(L, -2, "cflag");
lua_pushinteger(L, cfgetispeed(&t));
lua_setfield(L, -2, "ispeed");
lua_pushinteger(L, cfgetospeed(&t));
lua_setfield(L, -2, "ospeed");
lua_newtable(L);
for (i=0; i<NCCS; i++)
{
lua_pushinteger(L, i);
lua_pushinteger(L, t.c_cc[i]);
lua_settable(L, -3);
}
lua_setfield(L, -2, "cc");
#else
lua_newtable(L);
lsbf_pushbitflags(L, 0);
lua_setfield(L, -2, "iflag");
lsbf_pushbitflags(L, 0);
lua_setfield(L, -2, "oflag");
lsbf_pushbitflags(L, 0);
lua_setfield(L, -2, "lflag");
lsbf_pushbitflags(L, 0);
lua_setfield(L, -2, "cflag");
lua_pushinteger(L, 0);
lua_setfield(L, -2, "ispeed");
lua_pushinteger(L, 0);
lua_setfield(L, -2, "ospeed");
lua_newtable(L);
lua_setfield(L, -2, "cc");
#endif
return 1;
}
/***
Set termios state.
This function will set the flags as given.
The `I_`, `O_`, and `L_` constants are available on the module table. They are the respective
flags for the `iflags`, `oflags`, and `lflags` bitmasks.
To see flag status and constant names check `listtermflags`. For their meaning check
[the manpage](https://www.man7.org/linux/man-pages/man3/termios.3.html).
_Note_: not all combinations of flags are allowed, as some are mutually exclusive or mutually required.
See [setconsolemode documentation](https://learn.microsoft.com/en-us/windows/console/setconsolemode)
_Note_: only `iflag`, `oflag`, and `lflag` are supported at the moment. The other fields are ignored.
@function tcsetattr
@tparam file fd file handle to operate on, one of `io.stdin`, `io.stdout`, `io.stderr`
@int actions one of `TCSANOW`, `TCSADRAIN`, `TCSAFLUSH`
@tparam table termios a table with bitflag fields:
@tparam[opt] bitflags termios.iflag if given will set the input flags
@tparam[opt] bitflags termios.oflag if given will set the output flags
@tparam[opt] bitflags termios.lflag if given will set the local flags
@treturn[1] bool `true`, if successful. Always returns `true` on Windows.
@return[2] nil
@treturn[2] string error message
@treturn[2] int errnum
@usage
local system = require('system')
local status = assert(tcgetattr(io.stdin))
if not status.lflag:has(system.L_ECHO) then
-- if echo is off, turn echoing newlines on
tcsetattr(io.stdin, system.TCSANOW, { lflag = status.lflag + system.L_ECHONL }))
end
*/
static int lst_tcsetattr(lua_State *L)
{
#ifndef _WIN32
struct termios t;
int r, i;
int fd = get_console_handle(L); // first is the console handle
int act = luaL_checkinteger(L, 2); // second is the action to take
luaL_checktype(L, 3, LUA_TTABLE); // third is the termios table with fields
r = tcgetattr(fd, &t);
if (r == -1) return pusherror(L, NULL);
lua_getfield(L, 3, "iflag");
if (!lua_isnil(L, -1)) {
t.c_iflag = lsbf_checkbitflags(L, -1);
}
lua_pop(L, 1);
lua_getfield(L, 3, "oflag");
if (!lua_isnil(L, -1)) {
t.c_oflag = lsbf_checkbitflags(L, -1);
}
lua_pop(L, 1);
lua_getfield(L, 3, "lflag");
if (!lua_isnil(L, -1)) {
t.c_lflag = lsbf_checkbitflags(L, -1);
}
lua_pop(L, 1);
// Skipping the others for now
// lua_getfield(L, 3, "cflag"); t.c_cflag = optint(L, -1, 0); lua_pop(L, 1);
// lua_getfield(L, 3, "ispeed"); cfsetispeed( &t, optint(L, -1, B0) ); lua_pop(L, 1);
// lua_getfield(L, 3, "ospeed"); cfsetospeed( &t, optint(L, -1, B0) ); lua_pop(L, 1);
// lua_getfield(L, 3, "cc");
// for (i=0; i<NCCS; i++)
// {
// lua_pushinteger(L, i);
// lua_gettable(L, -2);
// t.c_cc[i] = optint(L, -1, 0);
// lua_pop(L, 1);
// }
r = tcsetattr(fd, act, &t);
if (r == -1) return pusherror(L, NULL);
#endif
lua_pushboolean(L, 1);
return 1;
}
/***
Enables or disables non-blocking mode for a file (Posix).
@function setnonblock
@tparam file fd file handle to operate on, one of `io.stdin`, `io.stdout`, `io.stderr`
@tparam boolean make_non_block a truthy value will enable non-blocking mode, a falsy value will disable it.
@treturn[1] bool `true`, if successful
@treturn[2] nil
@treturn[2] string error message
@treturn[2] int errnum
@see getnonblock
@usage
local sys = require('system')
-- set io.stdin to non-blocking mode
local old_setting = sys.getnonblock(io.stdin)
sys.setnonblock(io.stdin, true)
-- do stuff
-- restore old setting
sys.setnonblock(io.stdin, old_setting)
*/
static int lst_setnonblock(lua_State *L)
{
#ifndef _WIN32
int fd = get_console_handle(L);
int flags = fcntl(fd, F_GETFL, 0);
if (flags == -1) {
return pusherror(L, "Error getting handle flags: ");
}
if (lua_toboolean(L, 2)) {
// truthy: set non-blocking
flags |= O_NONBLOCK;
} else {
// falsy: set disable non-blocking
flags &= ~O_NONBLOCK;
}
if (fcntl(fd, F_SETFL, flags) == -1) {
return pusherror(L, "Error changing O_NONBLOCK: ");
}
#endif
lua_pushboolean(L, 1);
return 1;
}
/***
Gets non-blocking mode status for a file (Posix).
@function getnonblock
@tparam file fd file handle to operate on, one of `io.stdin`, `io.stdout`, `io.stderr`
@treturn[1] bool `true` if set to non-blocking, `false` if not. Always returns `false` on Windows.
@treturn[2] nil
@treturn[2] string error message
@treturn[2] int errnum
*/
static int lst_getnonblock(lua_State *L)
{
#ifndef _WIN32
int fd = get_console_handle(L);
// Set O_NONBLOCK
int flags = fcntl(fd, F_GETFL, 0);
if (flags == -1) {
return pusherror(L, "Error getting handle flags: ");
}
if (flags & O_NONBLOCK) {
lua_pushboolean(L, 1);
} else {
lua_pushboolean(L, 0);
}
#else
lua_pushboolean(L, 0);
#endif
return 1;
}
/*-------------------------------------------------------------------------
* Reading keyboard input
*-------------------------------------------------------------------------*/
/***
Reads a key from the console non-blocking.
On Posix, `io.stdin` must be set to non-blocking mode using `setnonblock`
before calling this function. Otherwise it will block.
@function readkey
@treturn[1] integer the key code of the key that was pressed
@treturn[2] nil if no key was pressed
*/
static int lst_readkey(lua_State *L) {
#ifdef _WIN32
if (_kbhit()) {
lua_pushinteger(L, _getch());
return 1;
}
return 0;
#else
char ch;
if (read(STDIN_FILENO, &ch, 1) > 0) {
lua_pushinteger(L, ch);
return 1;
}
return 0;
#endif
}
/***
Checks if a key has been pressed without reading it.
On Posix, `io.stdin` must be set to non-blocking mode using `setnonblock`
before calling this function. Otherwise it will block.
@function keypressed
@treturn boolean true if a key has been pressed, nil if not.
*/
static int lst_keypressed(lua_State *L) {
#ifdef _WIN32
if (kbhit()) {
lua_pushboolean(L, 1);
return 1;
}
return 0;
#else
char ch;
if (read(STDIN_FILENO, &ch, 1) > 0) {
// key was read, push back to stdin
ungetc(ch, stdin);
lua_pushboolean(L, 1);
return 1;
}
return 0;
#endif
}
/*-------------------------------------------------------------------------
* Retrieve terminal size
*-------------------------------------------------------------------------*/
/***
Get the size of the terminal in columns and rows.
@function termsize
@treturn[1] int the number of columns
@treturn[1] int the number of rows
@treturn[2] nil
@treturn[2] string error message
*/
static int lst_termsize(lua_State *L) {
int columns, rows;
#ifdef _WIN32
CONSOLE_SCREEN_BUFFER_INFO csbi;
if (!GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi)) {
termFormatError(L, GetLastError(), "Failed to get terminal size.");
return 2;
}
columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
rows = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
#else
struct winsize ws;
if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
return pusherror(L, "Failed to get terminal size.");
}
columns = ws.ws_col;
rows = ws.ws_row;
#endif
lua_pushinteger(L, columns);
lua_pushinteger(L, rows);
return 2;
}
/*-------------------------------------------------------------------------
* Initializes module
*-------------------------------------------------------------------------*/
static luaL_Reg func[] = {
{ "isatty", lst_isatty },
{ "getconsoleflags", lst_getconsoleflags },
{ "setconsoleflags", lst_setconsoleflags },
{ "tcgetattr", lst_tcgetattr },
{ "tcsetattr", lst_tcsetattr },
{ "getnonblock", lst_setnonblock },
{ "setnonblock", lst_setnonblock },
{ "readkey", lst_readkey },
{ "keypressed", lst_keypressed },
{ "termsize", lst_termsize },
{ NULL, NULL }
};
void term_open(lua_State *L) {
// set up constants and export the constants in module table
initialize_valid_flags();
// Windows flags
for (int i = 0; win_console_in_flags[i].name != NULL; i++)
{
lsbf_pushbitflags(L, win_console_in_flags[i].value);
lua_setfield(L, -2, win_console_in_flags[i].name);
}
for (int i = 0; win_console_out_flags[i].name != NULL; i++)
{
lsbf_pushbitflags(L, win_console_out_flags[i].value);
lua_setfield(L, -2, win_console_out_flags[i].name);
}
// Unix flags
for (int i = 0; nix_console_i_flags[i].name != NULL; i++)
{
lsbf_pushbitflags(L, nix_console_i_flags[i].value);
lua_setfield(L, -2, nix_console_i_flags[i].name);
}
for (int i = 0; nix_console_o_flags[i].name != NULL; i++)
{
lsbf_pushbitflags(L, nix_console_o_flags[i].value);
lua_setfield(L, -2, nix_console_o_flags[i].name);
}
for (int i = 0; nix_console_l_flags[i].name != NULL; i++)
{
lsbf_pushbitflags(L, nix_console_l_flags[i].value);
lua_setfield(L, -2, nix_console_l_flags[i].name);
}
// Unix tcsetattr actions
for (int i = 0; nix_tcsetattr_actions[i].name != NULL; i++)
{
lua_pushinteger(L, nix_tcsetattr_actions[i].value);
lua_setfield(L, -2, nix_tcsetattr_actions[i].name);
}
// export functions
luaL_setfuncs(L, func, 0);
}
|