mirror/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
Code Issues Projects Releases Wiki Activity

termios: new termios module (#17792)

Browse Source 
* termio: new termio module

move the tcgetattr and tcsetattr functions in a new termio module.
The code needed refactoring as different OS have different fields
size, position and number for the C.termios structure, which
could not be correctly expressed consitently otherwise.

It has the positive side effect to reduce the number of unsafe calls.
New testing code was also added for the readline module as it is
relying of the feature.

* apply 2023 copyright to the new files too
This commit is contained in:
Thomas Mangin 2023-03-30 06:58:52 +01:00 committed by GitHub
parent 0826102e0a
commit 580d9cedc7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 921 additions and 723 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/linux_ci.yml vendored
View File

@ -99,6 +99,10 @@ jobs:
run: | run: |
./v examples/password ./v examples/password
./v examples/password/password_ci.vsh ./v examples/password/password_ci.vsh
- name: Test readline
run: |
./v examples/readline/readline_ci.v
./v examples/readline/readline.vsh
ubuntu-tcc-boehm-gc: ubuntu-tcc-boehm-gc:

4
.github/workflows/macos_ci.yml vendored
View File

@ -113,3 +113,7 @@ jobs:
run: | run: |
./v examples/password ./v examples/password
./v examples/password/password_ci.vsh ./v examples/password/password_ci.vsh
- name: Test readline
run: |
./v examples/readline/readline_ci.v
./v examples/readline/readline.vsh

9
examples/readline/correct.expect Executable file
View File

@ -0,0 +1,9 @@
#!/usr/bin/expect
spawn ./readline_ci
send "a"
expect "got 97"
send "1"
expect "got 49"
send "q"
expect "Goodbye."
expect eof

2
examples/readline/readline.vsh Normal file
View File

@ -0,0 +1,2 @@
chdir('examples/readline')!
assert execute('./correct.expect').exit_code == 0

29
examples/readline/readline_ci.v Normal file
View File

@ -0,0 +1,29 @@
module main
import readline
fn main() {
run() or { panic('${err}') }
}
fn run() ! {
$if windows {
eprintln('skipping test on windows for now')
return
} $else {
mut r := readline.Readline{}
r.enable_raw_mode_nosig()
defer {
r.disable_raw_mode()
}
for {
entered := r.read_char()!
if entered == `q` {
break
}
println('got ${entered}')
}
println('Goodbye.')
}
}

25
vlib/os/password_nix.c.v
View File

@ -1,19 +1,6 @@
module os module os
#include <termios.h> import term.termios
pub struct C.termios {
mut:
c_iflag int
c_oflag int
c_cflag int
c_lflag int
c_cc [20]u8
}
fn C.tcgetattr(fd int, ptr &C.termios) int
fn C.tcsetattr(fd int, action int, const_ptr &C.termios) int
// input_password prompts the user for a password-like secret. It disables // input_password prompts the user for a password-like secret. It disables
// the terminal echo during user input and resets it back to normal when done. // the terminal echo during user input and resets it back to normal when done.
@ -22,19 +9,19 @@ pub fn input_password(prompt string) !string {
return error('Could not obtain password discretely.') return error('Could not obtain password discretely.')
} }
old_state := C.termios{} mut old_state := termios.Termios{}
if unsafe { C.tcgetattr(0, &old_state) } != 0 { if termios.tcgetattr(0, mut old_state) != 0 {
return last_error() return last_error()
} }
defer { defer {
unsafe { C.tcsetattr(0, C.TCSANOW, &old_state) } termios.tcsetattr(0, C.TCSANOW, mut old_state)
println('') println('')
} }
mut new_state := old_state mut new_state := old_state
new_state.c_lflag &= int(~u32(C.ECHO)) // Disable echoing of characters new_state.c_lflag &= termios.invert(C.ECHO) // Disable echoing of characters
unsafe { C.tcsetattr(0, C.TCSANOW, &new_state) } termios.tcsetattr(0, C.TCSANOW, mut new_state)
password := input_opt(prompt) or { return error('Failed to read password') } password := input_opt(prompt) or { return error('Failed to read password') }

4
vlib/readline/readline.v
View File

@ -7,6 +7,8 @@
// //
module readline module readline
import term.termios
// Winsize stores the screen information on Linux. // Winsize stores the screen information on Linux.
struct Winsize { struct Winsize {
ws_row u16 ws_row u16
@ -20,7 +22,7 @@ struct Winsize {
pub struct Readline { pub struct Readline {
mut: mut:
is_raw bool is_raw bool
orig_termios Termios // Linux orig_termios termios.Termios // Linux
current []rune // Line being edited current []rune // Line being edited
cursor int // Cursor position cursor int // Cursor position
overwrite bool overwrite bool

599
vlib/readline/readline_darwin.c.v
View File

@ -1,599 +0,0 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module readline
import term
import os
#include <termios.h>
#include <sys/ioctl.h>
// https://github.com/apple/darwin-xnu/blob/main/bsd/sys/termios.h
const cclen = 20
// Termios stores the terminal options
pub struct C.termios {
mut:
c_iflag int
c_oflag int
c_cflag int
c_lflag int
c_cc [cclen]u8
c_ispeed int
c_ospeed int
}
struct Termios {
mut:
c_iflag int
c_oflag int
c_cflag int
c_lflag int
c_cc [cclen]u8
c_ispeed int
c_ospeed int
padding [200]char // Note: the padding here is larger than necessary, but that is better than overwriting the fields after Termios!
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.raise(sig int)
fn C.getppid() int
// Action defines what actions to be executed.
enum Action {
eof
nothing
insert_character
commit_line
delete_left
delete_right
move_cursor_left
move_cursor_right
move_cursor_begining
move_cursor_end
move_cursor_word_left
move_cursor_word_right
history_previous
history_next
overwrite
clear_screen
suspend
}
// enable_raw_mode enables the raw mode of the terminal.
// In raw mode all key presses are directly sent to the program and no interpretation is done.
// Please note that `enable_raw_mode` catches the `SIGUSER` (CTRL + C) signal.
// For a method that does please see `enable_raw_mode_nosig`.
pub fn (mut r Readline) enable_raw_mode() {
if unsafe { C.tcgetattr(0, &C.termios(&r.orig_termios)) } != 0 {
r.is_tty = false
r.is_raw = false
return
}
mut raw := C.termios{}
unsafe { vmemcpy(&raw, &r.orig_termios, int(sizeof(raw))) }
// println('> r.orig_termios: $r.orig_termios')
// println('> raw: $raw')
raw.c_iflag &= ~(C.BRKINT | C.ICRNL | C.INPCK | C.ISTRIP | C.IXON)
raw.c_cflag |= C.CS8
raw.c_lflag &= ~(C.ECHO | C.ICANON | C.IEXTEN | C.ISIG)
raw.c_cc[C.VMIN] = u8(1)
raw.c_cc[C.VTIME] = u8(0)
unsafe { C.tcsetattr(0, C.TCSADRAIN, &raw) }
// println('> after raw: $raw')
r.is_raw = true
r.is_tty = true
}
// enable_raw_mode_nosig enables the raw mode of the terminal.
// In raw mode all key presses are directly sent to the program and no interpretation is done.
// Please note that `enable_raw_mode_nosig` does not catch the `SIGUSER` (CTRL + C) signal
// as opposed to `enable_raw_mode`.
pub fn (mut r Readline) enable_raw_mode_nosig() {
if unsafe { C.tcgetattr(0, &C.termios(&r.orig_termios)) } != 0 {
r.is_tty = false
r.is_raw = false
return
}
mut raw := C.termios{}
unsafe { vmemcpy(&raw, &r.orig_termios, int(sizeof(raw))) }
raw.c_iflag &= ~(C.BRKINT | C.ICRNL | C.INPCK | C.ISTRIP | C.IXON)
raw.c_cflag |= C.CS8
raw.c_lflag &= ~(C.ECHO | C.ICANON | C.IEXTEN)
raw.c_cc[C.VMIN] = u8(1)
raw.c_cc[C.VTIME] = u8(0)
unsafe { C.tcsetattr(0, C.TCSADRAIN, &raw) }
r.is_raw = true
r.is_tty = true
}
// disable_raw_mode disables the raw mode of the terminal.
// For a description of raw mode please see the `enable_raw_mode` method.
pub fn (mut r Readline) disable_raw_mode() {
if r.is_raw {
unsafe { C.tcsetattr(0, C.TCSADRAIN, &C.termios(&r.orig_termios)) }
r.is_raw = false
}
}
// read_char reads a single character.
pub fn (r Readline) read_char() !int {
return int(term.utf8_getchar() or { return err })
}
// read_line_utf8 blocks execution in a loop and awaits user input
// characters from a terminal until `EOF` or `Enter` key is encountered
// in the input stream.
// read_line_utf8 returns the complete input line as an UTF-8 encoded `[]rune` or
// an error if the line is empty.
// The `prompt` `string` is output as a prefix text for the input capturing.
// read_line_utf8 is the main method of the `readline` module and `Readline` struct.
pub fn (mut r Readline) read_line_utf8(prompt string) ![]rune {
r.current = []rune{}
r.cursor = 0
r.prompt = prompt
r.search_index = 0
r.prompt_offset = get_prompt_offset(prompt)
if r.previous_lines.len <= 1 {
r.previous_lines << []rune{}
r.previous_lines << []rune{}
} else {
r.previous_lines[0] = []rune{}
}
if !r.is_raw {
r.enable_raw_mode()
}
print(r.prompt)
for {
unsafe { C.fflush(C.stdout) }
c := r.read_char() or { return err }
a := r.analyse(c)
if r.execute(a, c) {
break
}
}
r.previous_lines[0] = []rune{}
r.search_index = 0
r.disable_raw_mode()
if r.current.len == 0 {
return error('empty line')
}
return r.current
}
// read_line does the same as `read_line_utf8` but returns user input as a `string`.
// (As opposed to `[]rune` returned by `read_line_utf8`).
pub fn (mut r Readline) read_line(prompt string) !string {
s := r.read_line_utf8(prompt)!
return s.string()
}
// read_line_utf8 blocks execution in a loop and awaits user input
// characters from a terminal until `EOF` or `Enter` key is encountered
// in the input stream.
// read_line_utf8 returns the complete input line as an UTF-8 encoded `[]rune` or
// an error if the line is empty.
// The `prompt` `string` is output as a prefix text for the input capturing.
// read_line_utf8 is the main method of the `readline` module and `Readline` struct.
// NOTE that this version of `read_line_utf8` is a standalone function without
// persistent functionalities (e.g. history).
pub fn read_line_utf8(prompt string) ![]rune {
mut r := Readline{}
s := r.read_line_utf8(prompt)!
return s
}
// read_line does the same as `read_line_utf8` but returns user input as a `string`.
// (As opposed to `[]rune` as returned by `read_line_utf8`).
// NOTE that this version of `read_line` is a standalone function without
// persistent functionalities (e.g. history).
pub fn read_line(prompt string) !string {
mut r := Readline{}
s := r.read_line(prompt)!
return s
}
// analyse returns an `Action` based on the type of input byte given in `c`.
fn (r Readline) analyse(c int) Action {
if c > 255 {
return Action.insert_character
}
match u8(c) {
`\0`, 0x3, 0x4, 255 {
return .eof
} // NUL, End of Text, End of Transmission
`\n`, `\r` {
return .commit_line
}
`\f` {
return .clear_screen
} // CTRL + L
`\b`, 127 {
return .delete_left
} // BS, DEL
27 {
return r.analyse_control()
} // ESC
1 {
return .move_cursor_begining
} // ^A
5 {
return .move_cursor_end
} // ^E
26 {
return .suspend
} // CTRL + Z, SUB
else {
if c >= ` ` {
return Action.insert_character
}
return Action.nothing
}
}
}
// analyse_control returns an `Action` based on the type of input read by `read_char`.
fn (r Readline) analyse_control() Action {
c := r.read_char() or { panic('Control sequence incomplete') }
match u8(c) {
`[` {
sequence := r.read_char() or { panic('Control sequence incomplete') }
match u8(sequence) {
`C` { return .move_cursor_right }
`D` { return .move_cursor_left }
`B` { return .history_next }
`A` { return .history_previous }
`H` { return .move_cursor_begining }
`F` { return .move_cursor_end }
`1` { return r.analyse_extended_control() }
`2`, `3` { return r.analyse_extended_control_no_eat(u8(sequence)) }
else {}
}
}
else {}
}
/*
//TODO
match c {
case `[`:
sequence := r.read_char()?
match sequence {
case `C`: return .move_cursor_right
case `D`: return .move_cursor_left
case `B`: return .history_next
case `A`: return .history_previous
case `1`: return r.analyse_extended_control()
case `2`: return r.analyse_extended_control_no_eat(sequence)
case `3`: return r.analyse_extended_control_no_eat(sequence)
case `9`:
foo()
bar()
else:
}
else:
}
*/
return .nothing
}
// analyse_extended_control returns an `Action` based on the type of input read by `read_char`.
// analyse_extended_control specialises in cursor control.
fn (r Readline) analyse_extended_control() Action {
r.read_char() or { panic('Control sequence incomplete') } // Removes ;
c := r.read_char() or { panic('Control sequence incomplete') }
match u8(c) {
`5` {
direction := r.read_char() or { panic('Control sequence incomplete') }
match u8(direction) {
`C` { return .move_cursor_word_right }
`D` { return .move_cursor_word_left }
else {}
}
}
else {}
}
return .nothing
}
// analyse_extended_control_no_eat returns an `Action` based on the type of input byte given in `c`.
// analyse_extended_control_no_eat specialises in detection of delete and insert keys.
fn (r Readline) analyse_extended_control_no_eat(last_c u8) Action {
c := r.read_char() or { panic('Control sequence incomplete') }
match u8(c) {
`~` {
match last_c {
`3` { return .delete_right } // Suppr key
`2` { return .overwrite }
else {}
}
}
else {}
}
return .nothing
}
// execute executes the corresponding methods on `Readline` based on `a Action` and `c int` arguments.
fn (mut r Readline) execute(a Action, c int) bool {
match a {
.eof { return r.eof() }
.insert_character { r.insert_character(c) }
.commit_line { return r.commit_line() }
.delete_left { r.delete_character() }
.delete_right { r.suppr_character() }
.move_cursor_left { r.move_cursor_left() }
.move_cursor_right { r.move_cursor_right() }
.move_cursor_begining { r.move_cursor_begining() }
.move_cursor_end { r.move_cursor_end() }
.move_cursor_word_left { r.move_cursor_word_left() }
.move_cursor_word_right { r.move_cursor_word_right() }
.history_previous { r.history_previous() }
.history_next { r.history_next() }
.overwrite { r.switch_overwrite() }
.clear_screen { r.clear_screen() }
.suspend { r.suspend() }
else {}
}
return false
}
// get_screen_columns returns the number of columns (`width`) in the terminal.
fn get_screen_columns() int {
ws := Winsize{}
cols := if unsafe { C.ioctl(1, C.TIOCGWINSZ, &ws) } == -1 { 80 } else { int(ws.ws_col) }
return cols
}
// shift_cursor warps the cursor to `xpos` with `yoffset`.
fn shift_cursor(xpos int, yoffset int) {
if yoffset != 0 {
if yoffset > 0 {
term.cursor_down(yoffset)
} else {
term.cursor_up(-yoffset)
}
}
// Absolute X position
print('\x1b[${xpos + 1}G')
}
// calculate_screen_position returns a position `[x, y]int` based on various terminal attributes.
fn calculate_screen_position(x_in int, y_in int, screen_columns int, char_count int, inp []int) []int {
mut out := inp.clone()
mut x := x_in
mut y := y_in
out[0] = x
out[1] = y
for chars_remaining := char_count; chars_remaining > 0; {
chars_this_row := if (x + chars_remaining) < screen_columns {
chars_remaining
} else {
screen_columns - x
}
out[0] = x + chars_this_row
out[1] = y
chars_remaining -= chars_this_row
x = 0
y++
}
if out[0] == screen_columns {
out[0] = 0
out[1]++
}
return out
}
// get_prompt_offset computes the length of the `prompt` `string` argument.
fn get_prompt_offset(prompt string) int {
mut len := 0
for i := 0; i < prompt.len; i++ {
if prompt[i] == `\e` {
for ; i < prompt.len && prompt[i] != `m`; i++ {
}
} else {
len = len + 1
}
}
return prompt.len - len
}
// refresh_line redraws the current line, including the prompt.
fn (mut r Readline) refresh_line() {
mut end_of_input := [0, 0]
end_of_input = calculate_screen_position(r.prompt.len, 0, get_screen_columns(), r.current.len,
end_of_input)
end_of_input[1] += r.current.filter(it == `\n`).len
mut cursor_pos := [0, 0]
cursor_pos = calculate_screen_position(r.prompt.len, 0, get_screen_columns(), r.cursor,
cursor_pos)
shift_cursor(0, -r.cursor_row_offset)
term.erase_toend()
print(r.prompt)
print(r.current.string())
if end_of_input[0] == 0 && end_of_input[1] > 0 {
print('\n')
}
shift_cursor(cursor_pos[0] - r.prompt_offset, -(end_of_input[1] - cursor_pos[1]))
r.cursor_row_offset = cursor_pos[1]
}
// eof ends the line *without* a newline.
fn (mut r Readline) eof() bool {
r.previous_lines.insert(1, r.current)
r.cursor = r.current.len
if r.is_tty {
r.refresh_line()
}
return true
}
// insert_character inserts the character `c` at current cursor position.
fn (mut r Readline) insert_character(c int) {
if !r.overwrite || r.cursor == r.current.len {
r.current.insert(r.cursor, c)
} else {
r.current[r.cursor] = rune(c)
}
r.cursor++
// Refresh the line to add the new character
if r.is_tty {
r.refresh_line()
}
}
// Removes the character behind cursor.
fn (mut r Readline) delete_character() {
if r.cursor <= 0 {
return
}
r.cursor--
r.current.delete(r.cursor)
r.refresh_line()
}
// suppr_character removes (suppresses) the character in front of the cursor.
fn (mut r Readline) suppr_character() {
if r.cursor >= r.current.len {
return
}
r.current.delete(r.cursor)
r.refresh_line()
}
// commit_line adds a line break and then stops the main loop.
fn (mut r Readline) commit_line() bool {
r.previous_lines.insert(1, r.current)
r.current << `\n`
r.cursor = r.current.len
if r.is_tty {
r.refresh_line()
println('')
}
return true
}
// move_cursor_left moves the cursor relative one cell to the left.
fn (mut r Readline) move_cursor_left() {
if r.cursor > 0 {
r.cursor--
r.refresh_line()
}
}
// move_cursor_right moves the cursor relative one cell to the right.
fn (mut r Readline) move_cursor_right() {
if r.cursor < r.current.len {
r.cursor++
r.refresh_line()
}
}
// move_cursor_begining moves the cursor to the beginning of the current line.
fn (mut r Readline) move_cursor_begining() {
r.cursor = 0
r.refresh_line()
}
// move_cursor_end moves the cursor to the end of the current line.
fn (mut r Readline) move_cursor_end() {
r.cursor = r.current.len
r.refresh_line()
}
// is_break_character returns true if the character is considered as a word-breaking character.
fn (r Readline) is_break_character(c string) bool {
break_characters := ' \t\v\f\a\b\r\n`~!@#$%^&*()-=+[{]}\\|;:\'",<.>/?'
return break_characters.contains(c)
}
// move_cursor_word_left moves the cursor relative one word length worth to the left.
fn (mut r Readline) move_cursor_word_left() {
if r.cursor > 0 {
for ; r.cursor > 0 && r.is_break_character(r.current[r.cursor - 1].str()); r.cursor-- {
}
for ; r.cursor > 0 && !r.is_break_character(r.current[r.cursor - 1].str()); r.cursor-- {
}
r.refresh_line()
}
}
// move_cursor_word_right moves the cursor relative one word length worth to the right.
fn (mut r Readline) move_cursor_word_right() {
if r.cursor < r.current.len {
for ; r.cursor < r.current.len && r.is_break_character(r.current[r.cursor].str()); r.cursor++ {
}
for ; r.cursor < r.current.len && !r.is_break_character(r.current[r.cursor].str()); r.cursor++ {
}
r.refresh_line()
}
}
// switch_overwrite toggles Readline `overwrite` mode on/off.
fn (mut r Readline) switch_overwrite() {
r.overwrite = !r.overwrite
}
// clear_screen clears the current terminal window contents and positions the cursor at top left.
fn (mut r Readline) clear_screen() {
term.set_cursor_position(x: 1, y: 1)
term.erase_clear()
r.refresh_line()
}
// history_previous sets current line to the content of the previous line in the history buffer.
fn (mut r Readline) history_previous() {
if r.search_index + 2 >= r.previous_lines.len {
return
}
if r.search_index == 0 {
r.previous_lines[0] = r.current
}
r.search_index++
prev_line := r.previous_lines[r.search_index]
if r.skip_empty && prev_line == [] {
r.history_previous()
} else {
r.current = prev_line
r.cursor = r.current.len
r.refresh_line()
}
}
// history_next sets current line to the content of the next line in the history buffer.
fn (mut r Readline) history_next() {
if r.search_index <= 0 {
return
}
r.search_index--
r.current = r.previous_lines[r.search_index]
r.cursor = r.current.len
r.refresh_line()
}
// suspend sends the `SIGSTOP` signal to the terminal.
fn (mut r Readline) suspend() {
is_standalone := os.getenv('VCHILD') != 'true'
r.disable_raw_mode()
if !is_standalone {
// We have to SIGSTOP the parent v process
unsafe {
ppid := C.getppid()
C.kill(ppid, C.SIGSTOP)
}
}
unsafe { C.raise(C.SIGSTOP) }
r.enable_raw_mode()
r.refresh_line()
if r.is_tty {
r.refresh_line()
}
}

59
vlib/readline/readline_linux.c.v → vlib/readline/readline_nix.c.v
View File

@ -7,39 +7,10 @@
// //
module readline module readline
import term.termios
import term import term
import os import os
#include <termios.h>
#include <sys/ioctl.h>
const cclen = 10
// Termios stores the terminal options on Linux.
pub struct C.termios {
mut:
c_iflag int
c_oflag int
c_cflag int
c_lflag int
c_line u8
c_cc [cclen]int
}
struct Termios {
mut:
c_iflag u32
c_oflag u32
c_cflag u32
c_lflag u32
c_line u8
c_cc [cclen]int
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.raise(sig int) fn C.raise(sig int)
fn C.getppid() int fn C.getppid() int
@ -70,21 +41,20 @@ enum Action {
// Please note that `enable_raw_mode` catches the `SIGUSER` (CTRL + C) signal. // Please note that `enable_raw_mode` catches the `SIGUSER` (CTRL + C) signal.
// For a method that does please see `enable_raw_mode_nosig`. // For a method that does please see `enable_raw_mode_nosig`.
pub fn (mut r Readline) enable_raw_mode() { pub fn (mut r Readline) enable_raw_mode() {
if unsafe { C.tcgetattr(0, &C.termios(&r.orig_termios)) } != 0 { if termios.tcgetattr(0, mut r.orig_termios) != 0 {
r.is_tty = false r.is_tty = false
r.is_raw = false r.is_raw = false
return return
} }
mut raw := C.termios{} mut raw := r.orig_termios
unsafe { vmemcpy(&raw, &r.orig_termios, int(sizeof(raw))) }
// println('> r.orig_termios: $r.orig_termios') // println('> r.orig_termios: $r.orig_termios')
// println('> raw: $raw') // println('> raw: $raw')
raw.c_iflag &= ~(C.BRKINT | C.ICRNL | C.INPCK | C.ISTRIP | C.IXON) raw.c_iflag &= termios.invert(C.BRKINT | C.ICRNL | C.INPCK | C.ISTRIP | C.IXON)
raw.c_cflag |= C.CS8 raw.c_cflag |= termios.flag(C.CS8)
raw.c_lflag &= ~(C.ECHO | C.ICANON | C.IEXTEN | C.ISIG) raw.c_lflag &= termios.invert(C.ECHO | C.ICANON | C.IEXTEN | C.ISIG)
raw.c_cc[C.VMIN] = u8(1) raw.c_cc[C.VMIN] = u8(1)
raw.c_cc[C.VTIME] = u8(0) raw.c_cc[C.VTIME] = u8(0)
unsafe { C.tcsetattr(0, C.TCSADRAIN, &raw) } termios.tcsetattr(0, C.TCSADRAIN, mut raw)
// println('> after raw: $raw') // println('> after raw: $raw')
r.is_raw = true r.is_raw = true
r.is_tty = true r.is_tty = true
@ -95,19 +65,18 @@ pub fn (mut r Readline) enable_raw_mode() {
// Please note that `enable_raw_mode_nosig` does not catch the `SIGUSER` (CTRL + C) signal // Please note that `enable_raw_mode_nosig` does not catch the `SIGUSER` (CTRL + C) signal
// as opposed to `enable_raw_mode`. // as opposed to `enable_raw_mode`.
pub fn (mut r Readline) enable_raw_mode_nosig() { pub fn (mut r Readline) enable_raw_mode_nosig() {
if unsafe { C.tcgetattr(0, &C.termios(&r.orig_termios)) } != 0 { if termios.tcgetattr(0, mut r.orig_termios) != 0 {
r.is_tty = false r.is_tty = false
r.is_raw = false r.is_raw = false
return return
} }
mut raw := C.termios{} mut raw := r.orig_termios
unsafe { vmemcpy(&raw, &r.orig_termios, int(sizeof(raw))) } raw.c_iflag &= termios.invert(C.BRKINT | C.ICRNL | C.INPCK | C.ISTRIP | C.IXON)
raw.c_iflag &= ~(C.BRKINT | C.ICRNL | C.INPCK | C.ISTRIP | C.IXON) raw.c_cflag |= termios.flag(C.CS8)
raw.c_cflag |= C.CS8 raw.c_lflag &= termios.invert(C.ECHO | C.ICANON | C.IEXTEN)
raw.c_lflag &= ~(C.ECHO | C.ICANON | C.IEXTEN)
raw.c_cc[C.VMIN] = u8(1) raw.c_cc[C.VMIN] = u8(1)
raw.c_cc[C.VTIME] = u8(0) raw.c_cc[C.VTIME] = u8(0)
unsafe { C.tcsetattr(0, C.TCSADRAIN, &raw) } termios.tcsetattr(0, C.TCSADRAIN, mut raw)
r.is_raw = true r.is_raw = true
r.is_tty = true r.is_tty = true
} }
@ -116,7 +85,7 @@ pub fn (mut r Readline) enable_raw_mode_nosig() {
// For a description of raw mode please see the `enable_raw_mode` method. // For a description of raw mode please see the `enable_raw_mode` method.
pub fn (mut r Readline) disable_raw_mode() { pub fn (mut r Readline) disable_raw_mode() {
if r.is_raw { if r.is_raw {
unsafe { C.tcsetattr(0, C.TCSADRAIN, &C.termios(&r.orig_termios)) } termios.tcsetattr(0, C.TCSADRAIN, mut r.orig_termios)
r.is_raw = false r.is_raw = false
} }
} }

21
vlib/term/term_nix.c.v
View File

@ -1,9 +1,9 @@
module term module term
import os import os
import term.termios
#include <sys/ioctl.h> #include <sys/ioctl.h>
#include <termios.h> // TIOCGWINSZ
pub struct C.winsize { pub struct C.winsize {
pub: pub:
@ -13,10 +13,6 @@ pub:
ws_ypixel u16 ws_ypixel u16
} }
fn C.tcgetattr(fd int, ptr &C.termios) int
fn C.tcsetattr(fd int, action int, const_ptr &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int fn C.ioctl(fd int, request u64, arg voidptr) int
// get_terminal_size returns a number of colums and rows of terminal window. // get_terminal_size returns a number of colums and rows of terminal window.
@ -35,21 +31,22 @@ pub fn get_cursor_position() !Coord {
return Coord{0, 0} return Coord{0, 0}
} }
old_state := C.termios{} mut old_state := termios.Termios{}
if unsafe { C.tcgetattr(0, &old_state) } != 0 { if termios.tcgetattr(0, mut old_state) != 0 {
return os.last_error() return os.last_error()
} }
defer { defer {
// restore the old terminal state: // restore the old terminal state:
unsafe { C.tcsetattr(0, C.TCSANOW, &old_state) } termios.tcsetattr(0, C.TCSANOW, mut old_state)
} }
mut state := C.termios{} mut state := termios.Termios{}
if unsafe { C.tcgetattr(0, &state) } != 0 { if termios.tcgetattr(0, mut state) != 0 {
return os.last_error() return os.last_error()
} }
state.c_lflag &= int(~(u32(C.ICANON) | u32(C.ECHO)))
unsafe { C.tcsetattr(0, C.TCSANOW, &state) } state.c_lflag &= termios.invert(u32(C.ICANON) | u32(C.ECHO))
termios.tcsetattr(0, C.TCSANOW, mut state)
print('\e[6n') print('\e[6n')
flush_stdout() flush_stdout()

88
vlib/term/termios/termios_android.c.v Normal file
View File

@ -0,0 +1,88 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://github.com/lattera/glibc/blob/master/sysdeps/unix/sysv/linux/bits/termios.h
const cclen = 32
type TcFlag = int
type Speed = int
type Cc = u8
// Termios stores the terminal options on Linux.
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_line Cc
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_line Cc
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

86
vlib/term/termios/termios_darwin.c.v Normal file
View File

@ -0,0 +1,86 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://github.com/apple/darwin-xnu/blob/main/bsd/sys/termios.h
const cclen = 20
type TcFlag = usize
type Speed = usize
type Cc = u8
// Termios stores the terminal options
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return usize(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~usize(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

58
vlib/term/termios/termios_default.c.v Normal file
View File

@ -0,0 +1,58 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// TODO Mac version needs to be implemented
// Will serve as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
// not used but needed for function declarations
type TcFlag = int
type Speed = int
type Cc = u8
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
// It is only implemented for Unix like OSes
pub fn flag(value int) TcFlag {
$compile_error('feature not available')
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
// It is only implemented for Unix like OSes
pub fn invert(value TcFlag) TcFlag {
$compile_error('feature not available')
}
// termios definitions
// Linux https://github.com/lattera/glibc/blob/master/sysdeps/unix/sysv/linux/bits/termios.h
// OpenBSD https://github.com/openbsd/src/blob/master/sys/sys/termios.h
// FreeBSD https://web.mit.edu/freebsd/head/sys/sys/_termios.h
// Solaris https://github.com/omniti-labs/illumos-omnios/blob/master/usr/src/uts/common/sys/termios.h
// DragonFly https://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/sys/_termios.h
// QNX https://github.com/vocho/openqnx/blob/master/trunk/lib/c/public/termios.h
pub struct Termios {
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
// It is only implemented for Unix like OSes
pub fn tcgetattr(fd int, mut termios_p Termios) int {
$compile_error('feature not available')
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
// It is only implemented for Unix like OSes
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
$compile_error('feature not available')
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
$compile_error('feature not available')
}

86
vlib/term/termios/termios_dragonfly.c.v Normal file
View File

@ -0,0 +1,86 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/HEAD:/sys/sys/_termios.h
const cclen = 20
type TcFlag = int
type Speed = int
type Cc = u8
// Termios stores the terminal options
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

86
vlib/term/termios/termios_freebsd.c.v Normal file
View File

@ -0,0 +1,86 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://web.mit.edu/freebsd/head/sys/sys/_termios.h
const cclen = 20
type TcFlag = int
type Speed = int
type Cc = u8
// Termios stores the terminal options
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

88
vlib/term/termios/termios_linux.c.v Normal file
View File

@ -0,0 +1,88 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://github.com/lattera/glibc/blob/master/sysdeps/unix/sysv/linux/bits/termios.h
const cclen = 32
type TcFlag = int
type Speed = int
type Cc = u8
// Termios stores the terminal options on Linux.
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_line Cc
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_line Cc
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

86
vlib/term/termios/termios_openbsd.c.v Normal file
View File

@ -0,0 +1,86 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://github.com/openbsd/src/blob/master/sys/sys/termios.h
const cclen = 20
type TcFlag = int
type Speed = int
type Cc = u8
// Termios stores the terminal options
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
c_ispeed Speed
c_ospeed Speed
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

88
vlib/term/termios/termios_qnx.c.v Normal file
View File

@ -0,0 +1,88 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://github.com/vocho/openqnx/blob/master/trunk/lib/c/public/termios.h
const cclen = 20
type TcFlag = int
type Speed = int
type Cc = u8
// Termios stores the terminal options
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
reserved [3]u32
c_ispeed Speed
c_ospeed Speed
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
reserved [3]u32
c_ispeed Speed
c_ospeed Speed
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

82
vlib/term/termios/termios_solaris.c.v Normal file
View File

@ -0,0 +1,82 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// Serves as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
#include <termios.h>
#include <sys/ioctl.h>
// https://web.mit.edu/freebsd/head/sys/sys/_termios.h
const cclen = 20
type TcFlag = int
type Speed = int
type Cc = u8
// Termios stores the terminal options
struct C.termios {
mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
}
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
[inline]
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
[inline]
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
pub mut:
c_iflag TcFlag
c_oflag TcFlag
c_cflag TcFlag
c_lflag TcFlag
c_cc [cclen]Cc
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcgetattr(fd int, mut termios_p Termios) int {
unsafe {
return C.tcgetattr(fd, &C.termios(termios_p))
}
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
[inline]
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
unsafe {
return C.tcsetattr(fd, optional_actions, &C.termios(termios_p))
}
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
unsafe {
return C.ioctl(fd, request, arg)
}
}

20
vlib/term/termios/termios_test.c.v Normal file
View File

@ -0,0 +1,20 @@
module termios
fn test_termios() {
mut original_term := Termios{}
tcgetattr(0, mut original_term)
println(original_term)
mut silent_term := original_term
silent_term.c_lflag &= invert(C.ECHO)
tcsetattr(0, C.TCSANOW, mut silent_term)
mut check_term := Termios{}
tcgetattr(0, mut check_term)
assert check_term.c_lflag == silent_term.c_lflag
tcsetattr(0, C.TCSANOW, mut orginal_term)
tcgetattr(0, mut check_term)
assert check_term.c_lflag == orginal_term.c_lflag
}

49
vlib/term/termios/termios_windows.c.v Normal file
View File

@ -0,0 +1,49 @@
// Copyright (c) 2019-2023 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
//
// TODO Windows version needs to be implemented.
// Will serve as more advanced input method
// based on the work of https://github.com/AmokHuginnsson/replxx
//
module termios
type TcFlag = int
type Speed = int
type Cc = u8
// flag provides a termios flag of the correct size
// for the underlying C.termios structure
// It is only implemented for Unix like OSes
pub fn flag(value int) TcFlag {
return int(value)
}
// invert is a platform dependant way to bitwise NOT (~) TcFlag
// as its length varies across platforms
// It is only implemented for Unix like OSes
pub fn invert(value TcFlag) TcFlag {
return ~int(value)
}
pub struct Termios {
}
// tcgetattr is an unsafe wrapper around C.termios and keeps its semantic
// It is only implemented for Unix like OSes
pub fn tcgetattr(fd int, mut termios_p Termios) int {
return -1
}
// tcsetattr is an unsafe wrapper around C.termios and keeps its semantic
// It is only implemented for Unix like OSes
pub fn tcsetattr(fd int, optional_actions int, mut termios_p Termios) int {
return -1
}
// ioctl is an unsafe wrapper around C.ioctl and keeps its semantic
// It is only implemented for Unix like OSes
[inline]
pub fn ioctl(fd int, request u64, arg voidptr) int {
return -1
}

10
vlib/term/ui/declarations_default.c.v
View File

@ -1,10 +0,0 @@
module ui
pub struct C.termios {
mut:
c_iflag int
c_oflag int
c_cflag int
c_lflag int
c_cc [20]u8
}

11
vlib/term/ui/declarations_linux.c.v
View File

@ -1,11 +0,0 @@
module ui
pub struct C.termios {
mut:
c_iflag int
c_oflag int
c_cflag int
c_lflag int
// c_line byte
c_cc [10]int
}

40
vlib/term/ui/termios_nix.c.v
View File

@ -5,9 +5,8 @@ module ui
import os import os
import time import time
import term.termios
#include <termios.h>
#include <sys/ioctl.h>
#include <signal.h> #include <signal.h>
pub struct C.winsize { pub struct C.winsize {
@ -15,25 +14,19 @@ pub struct C.winsize {
ws_col u16 ws_col u16
} }
fn C.tcgetattr(fd int, termios_p &C.termios) int
fn C.tcsetattr(fd int, optional_actions int, const_termios_p &C.termios) int
fn C.ioctl(fd int, request u64, arg voidptr) int
const termios_at_startup = get_termios() const termios_at_startup = get_termios()
[inline] [inline]
fn get_termios() C.termios { fn get_termios() termios.Termios {
mut t := C.termios{} mut t := termios.Termios{}
C.tcgetattr(C.STDIN_FILENO, &t) termios.tcgetattr(C.STDIN_FILENO, mut t)
return t return t
} }
[inline] [inline]
fn get_terminal_size() (u16, u16) { fn get_terminal_size() (u16, u16) {
winsz := C.winsize{} winsz := C.winsize{}
C.ioctl(0, C.TIOCGWINSZ, &winsz) termios.ioctl(0, termios.flag(C.TIOCGWINSZ), voidptr(&winsz))
return winsz.ws_row, winsz.ws_col return winsz.ws_row, winsz.ws_col
} }
@ -60,16 +53,16 @@ fn (mut ctx Context) termios_setup() ! {
return error('not running under a TTY') return error('not running under a TTY')
} }
mut termios := get_termios() mut tios := get_termios()
if ctx.cfg.capture_events { if ctx.cfg.capture_events {
// Set raw input mode by unsetting ICANON and ECHO, // Set raw input mode by unsetting ICANON and ECHO,
// as well as disable e.g. ctrl+c and ctrl.z // as well as disable e.g. ctrl+c and ctrl.z
termios.c_iflag &= ~(C.IGNBRK | C.BRKINT | C.PARMRK | C.IXON) tios.c_iflag &= termios.invert(C.IGNBRK | C.BRKINT | C.PARMRK | C.IXON)
termios.c_lflag &= ~(C.ICANON | C.ISIG | C.ECHO | C.IEXTEN | C.TOSTOP) tios.c_lflag &= termios.invert(C.ICANON | C.ISIG | C.ECHO | C.IEXTEN | C.TOSTOP)
} else { } else {
// Set raw input mode by unsetting ICANON and ECHO // Set raw input mode by unsetting ICANON and ECHO
termios.c_lflag &= ~(C.ICANON | C.ECHO) tios.c_lflag &= termios.invert(C.ICANON | C.ECHO)
} }
if ctx.cfg.hide_cursor { if ctx.cfg.hide_cursor {
@ -85,9 +78,9 @@ fn (mut ctx Context) termios_setup() ! {
if !ctx.cfg.skip_init_checks { if !ctx.cfg.skip_init_checks {
// prevent blocking during the feature detections, but allow enough time for the terminal // prevent blocking during the feature detections, but allow enough time for the terminal
// to send back the relevant input data // to send back the relevant input data
termios.c_cc[C.VTIME] = 1 tios.c_cc[C.VTIME] = 1
termios.c_cc[C.VMIN] = 0 tios.c_cc[C.VMIN] = 0
C.tcsetattr(C.STDIN_FILENO, C.TCSAFLUSH, &termios) termios.tcsetattr(C.STDIN_FILENO, C.TCSAFLUSH, mut tios)
// feature-test the SU spec // feature-test the SU spec
sx, sy := get_cursor_position() sx, sy := get_cursor_position()
print('${bsu}${esu}') print('${bsu}${esu}')
@ -105,9 +98,9 @@ fn (mut ctx Context) termios_setup() ! {
ctx.enable_rgb = supports_truecolor() ctx.enable_rgb = supports_truecolor()
} }
// Prevent stdin from blocking by making its read time 0 // Prevent stdin from blocking by making its read time 0
termios.c_cc[C.VTIME] = 0 tios.c_cc[C.VTIME] = 0
termios.c_cc[C.VMIN] = 0 tios.c_cc[C.VMIN] = 0
C.tcsetattr(C.STDIN_FILENO, C.TCSAFLUSH, &termios) termios.tcsetattr(C.STDIN_FILENO, C.TCSAFLUSH, mut tios)
// enable mouse input // enable mouse input
print('\x1b[?1003h\x1b[?1006h') print('\x1b[?1003h\x1b[?1006h')
flush_stdout() flush_stdout()
@ -205,7 +198,8 @@ fn supports_truecolor() bool {
fn termios_reset() { fn termios_reset() {
// C.TCSANOW ?? // C.TCSANOW ??
C.tcsetattr(C.STDIN_FILENO, C.TCSAFLUSH, &ui.termios_at_startup) mut startup := ui.termios_at_startup
termios.tcsetattr(C.STDIN_FILENO, C.TCSAFLUSH, mut startup)
print('\x1b[?1003l\x1b[?1006l\x1b[?25h') print('\x1b[?1003l\x1b[?1006l\x1b[?25h')
flush_stdout() flush_stdout()
c := ctx_ptr c := ctx_ptr

6
vlib/v/builder/builder.v
View File

@ -304,7 +304,11 @@ pub fn (b &Builder) import_graph() &depgraph.DepGraph {
deps << 'builtin' deps << 'builtin'
if b.pref.backend == .c { if b.pref.backend == .c {
// TODO JavaScript backend doesn't handle os for now // TODO JavaScript backend doesn't handle os for now
if b.pref.is_vsh && p.mod.name !in ['os', 'dl', 'strings.textscanner'] { // os import libraries so we exclude anything which could cause a loop
// git grep import vlib/os | cut -f2 -d: | cut -f2 -d" " | sort -u
// dl, os, os.cmdline, os.filelock, os.notify, strings, strings.textscanner, term.termios, time
if b.pref.is_vsh
&& p.mod.name !in ['os', 'dl', 'strings.textscanner', 'term.termios'] {
deps << 'os' deps << 'os'
} }
} }