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
|
/*@ S-nail - a mail user agent derived from Berkeley Mail.
*@ Terminal attributes and state.
*
* Copyright (c) 2019 - 2020 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
* SPDX-License-Identifier: ISC
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef mx_TERMIOS_H
#define mx_TERMIOS_H
#include <mx/nail.h>
#define mx_HEADER
#include <su/code-in.h>
struct mx_termios_dimension;
enum mx_termios_cmd{
/* Throw away the entire stack, and restore normal terminal state.
* The outermost level will be regularly shutdown, as via POP.
* The state_change handlers of all stack entries will be called.
* Further bits may not be set (this is 0) */
mx_TERMIOS_CMD_RESET,
/* Only when HANDS_OFF is active, only by itself! */
/* mx_TERMIOS_CMD_SET_PGRP = 1u,*/
/* Create a (POPable) environment, as necessary change to the given mode.
* An environment carries the terminal mode as well as a possibly installed
* on_state_change hook; if such environment is reentered, the state change
* hook gets called to resume after the mode has been reestablished.
* Likewise, if it is left, it gets called to suspend first.
* XXX Any state change requires this, only RAW and RAW_TIMEOUT may be
* XXX switched back and forth on the same level (otherwise state_change
* XXX needs cmd argument, plus plus plus) */
mx_TERMIOS_CMD_PUSH = 1u<<1,
/* Pop stack and restore the terminal setting active before.
* If a hook is installed, it will be called first.
* If a mode is given, debug version will assert the stack top matches.
* Further bits are ignored */
mx_TERMIOS_CMD_POP = 1u<<2,
mx__TERMIOS_CMD_CTL_MASK = mx_TERMIOS_CMD_PUSH | mx_TERMIOS_CMD_POP,
mx_TERMIOS_CMD_NORMAL = 1u<<3, /* Normal canonical mode */
mx_TERMIOS_CMD_PASSWORD = 2u<<3, /* Password input mode */
mx_TERMIOS_CMD_RAW = 3u<<3, /* Raw mode, use by-(the given-)byte(s) input */
mx_TERMIOS_CMD_RAW_TIMEOUT = 4u<<3, /* Raw mode, use (the given) timeout */
mx_TERMIOS_CMD_HANDS_OFF = 5u<<3, /* We do not own the terminal */
mx__TERMIOS_CMD_ACT_MASK = 7u<<3
};
enum mx_termios_setup{
mx_TERMIOS_SETUP_STARTUP,
mx_TERMIOS_SETUP_TERMSIZE
};
enum mx_termios_state_change{
mx_TERMIOS_STATE_SUSPEND = 1u<<0, /* Need to suspend terminal state */
mx_TERMIOS_STATE_RESUME = 1u<<1, /* Need to resume terminal state */
mx_TERMIOS_STATE_SIGNAL = 1u<<2, /* Call was caused by a signal */
mx_TERMIOS_STATE_JOB_SIGNAL = 1u<<3, /* It was a job signal indeed */
/* The environment is being popped.
* If it is still active, _STATE_SUSPEND will be set in addition.
* For HANDS_OFF handlers this will be called in a RESET even in already
* suspended state, so no _STATE_SUSPEND is set, then! */
mx_TERMIOS_STATE_POP = 1u<<4
};
/* tiossc is termios_state_change bitmix, cookie is user argument.
* signal is only meaningful when _STATE_SIGNAL is set.
* Return value indicates whether level shall be CMD_POPped: it is only
* honoured if TERMIOS_STATE_SUSPEND and TERMIOS_STATE_SIGNAL are both set.
* TODO This "to-pop" return will vanish in v15, we only need it due to longjmp
* TODO and of course it sucks since how many levels does the jump cross?
* TODO We do not know except when installing setjmps on each and every level,
* TODO but we do not; it is ok for this MUA today, but a real generic solution
* TODO in v15 will simply not care for signal jumps at all, they suck more */
typedef boole (*mx_termios_on_state_change)(up cookie, u32 tiossc, s32 signal);
struct mx_termios_dimension{
u32 tiosd_height;
/* .tiosd_height might be deduced via terminal speed, in which case this
* still is set to the real terminal height */
u32 tiosd_real_height;
u32 tiosd_width;
/* .tiosd_width might be reduces deduced by one if we have no termcap
* support or if the terminal cannot write in the last column (without
* wrapping), in which case this still is set to the real terminal width */
u32 tiosd_real_width;
};
/* */
EXPORT_DATA struct mx_termios_dimension mx_termios_dimen;
/* For long iterative output, like `list', tabulator-completion, etc.,
* determine the screen width that should be used */
#define mx_TERMIOS_WIDTH_OF_LISTS() \
(mx_termios_dimen.tiosd_width - (mx_termios_dimen.tiosd_width >> 3))
/* Installs signal handlers etc. Early! */
EXPORT void mx_termios_controller_setup(enum mx_termios_setup what);
/* Install a state change hook for the current environment,
* which will receive cookie as its user argument.
* May not be used in and for the top level */
EXPORT void mx_termios_on_state_change_set(mx_termios_on_state_change hdl,
up cookie);
/* tiosc is a bitmix of mx_termios_cmd values.
* For _RAW and _RAW_TIMEOUT a1 describes VMIN and VTIME, respectively,
* for SET_PGRP it is the PID */
EXPORT boole mx_termios_cmd(u32 tiosc, uz a1);
#define mx_termios_cmdx(CMD) mx_termios_cmd(CMD, 0)
#include <su/code-ou.h>
#endif /* mx_TERMIOS_H */
/* s-it-mode */
|
