libterminput_set_flags.3


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

.TH LIBTERMINPUT_SET_FLAGS 3 LIBTERMINPUT
.SH NAME
libterminput_set_flags \- Add input parsing flags
.br
libterminput_clear_flags \- Remove input parsing flags

.SH SYNOPSIS
.nf
#include <libterminput.h>

int libterminput_set_flags(struct libterminput_state *ctx *\fIctx\fP, enum libterminput_flags \fIflags\fP);
int libterminput_clear_flags(struct libterminput_state *ctx *\fIctx\fP, enum libterminput_flags \fIflags\fP);
.fi
.PP
Link with
.IR \-lterminput .

.SH DESCRIPTION
The
.BR libterminput_set_flags ()
function sets the flags specified in the
.I flags
parameter on
.IR ctx ,
whereas the
.BR libterminput_clear_flags ()
function clears the flags.
.PP
Flags are used to change the behaviour parsing
rules in order to support escape sequences that
are incompatible with the default parsing rules.
The available flags are
.TP
.B LIBTERMINPUT_DECSET_1005
The sequence
.B CSI M
shall be parsed be parse as a DECSET 1005 sequence
which is incompatible with legacy mouse tracking.
This flag shall only be set if DECSET 1005 has sent
to the terminal and the user is sure it is supported
by the terminal.
.TP
.B LIBTERMINPUT_MACRO_ON_CSI_M
The sequence
.B CSI Pm M
shall be parsed as a key press of the macro key.
This is incompatible with all mouse tracking modes
except
.IR "DECSET 1006" .
Applications that do not use mouse tracking, or
know that their terminal supports
.I DECSET 1006
and therefore uses it, can safely use this flag.
.TP
.B LIBTERMINPUT_PAUSE_ON_CSI_P
The sequence
.B CSI Pm M
shall be parsed as a key press of the pause key
instead of the F1 key.
.TP
.B LIBTERMINPUT_INS_ON_CSI_AT
The sequence
.B CSI Pm @
shall be parsed as a key press of the insert key
instead of a number of possible special keys
combined with the control and shift modifiers.
.TP
.B LIBTERMINPUT_SEPARATE_BACKTAB
Backtab shall be treated as a separate key, and
not be reported as tab with the shift modifier.
This flag is just a usability issue. Keyboards
put backtab on shift+tab, which is why the tab
keycap has both a backward arrow (backtab) and
a forward arrow (tab); but most users are unfamiliar
with backtab, and just see it as shift+tab.
.TP
.B LIBTERMINPUT_ESC_ON_BLOCK
If an ESC is received without anything after it,
it shall be parsed as an ESC keypress. This is not
always desirable behaviour as the user may manually
press ESC to simulate a keypress that terminal does
not support (yes, this is a real world issue).
.PP
.I ctx
must have been zero-initialised, e.g. with
.BR memset (3)
function.

.SH RETURN VALUE
The
.BR libterminput_set_flags ()
and
.BR libterminput_clear_flags ()
functions return 0 upon successful completion;
otherwise the
.BR libterminput_set_flags ()
and
.BR libterminput_clear_flags ()
functions return
.B -1
and set
.I errno
it indicate the error.

.SH ERRORS
Current versions of the
.BR libterminput_set_flags ()
and
.BR libterminput_clear_flags ()
functions cannot fail.

.SH EXAMPLES
None.

.SH APPLICATION USAGE
None.

.SH RATIONALE
None.

.SH FUTURE DIRECTIONS
None.

.SH NOTES
None.

.SH BUGS
None.

.SH SEE ALSO
.BR libterminput_read (3)