1*2067fd92SSamuel Thibault // SPDX-License-Identifier: GPL-2.0+
2*2067fd92SSamuel Thibault /* speakup_keyhelp.c
3*2067fd92SSamuel Thibault * help module for speakup
4*2067fd92SSamuel Thibault *
5*2067fd92SSamuel Thibault *written by David Borowski.
6*2067fd92SSamuel Thibault *
7*2067fd92SSamuel Thibault * Copyright (C) 2003 David Borowski.
8*2067fd92SSamuel Thibault */
9*2067fd92SSamuel Thibault
10*2067fd92SSamuel Thibault #include <linux/keyboard.h>
11*2067fd92SSamuel Thibault #include "spk_priv.h"
12*2067fd92SSamuel Thibault #include "speakup.h"
13*2067fd92SSamuel Thibault
14*2067fd92SSamuel Thibault #define MAXFUNCS 130
15*2067fd92SSamuel Thibault #define MAXKEYS 256
16*2067fd92SSamuel Thibault static const int num_key_names = MSG_KEYNAMES_END - MSG_KEYNAMES_START + 1;
17*2067fd92SSamuel Thibault static u_short key_offsets[MAXFUNCS], key_data[MAXKEYS];
18*2067fd92SSamuel Thibault static u_short masks[] = { 32, 16, 8, 4, 2, 1 };
19*2067fd92SSamuel Thibault
20*2067fd92SSamuel Thibault static short letter_offsets[26] = {
21*2067fd92SSamuel Thibault -1, -1, -1, -1, -1, -1, -1, -1,
22*2067fd92SSamuel Thibault -1, -1, -1, -1, -1, -1, -1, -1,
23*2067fd92SSamuel Thibault -1, -1, -1, -1, -1, -1, -1, -1,
24*2067fd92SSamuel Thibault -1, -1 };
25*2067fd92SSamuel Thibault
26*2067fd92SSamuel Thibault static u_char funcvals[] = {
27*2067fd92SSamuel Thibault ATTRIB_BLEEP_DEC, ATTRIB_BLEEP_INC, BLEEPS_DEC, BLEEPS_INC,
28*2067fd92SSamuel Thibault SAY_FIRST_CHAR, SAY_LAST_CHAR, SAY_CHAR, SAY_CHAR_NUM,
29*2067fd92SSamuel Thibault SAY_NEXT_CHAR, SAY_PHONETIC_CHAR, SAY_PREV_CHAR, SPEAKUP_PARKED,
30*2067fd92SSamuel Thibault SPEAKUP_CUT, EDIT_DELIM, EDIT_EXNUM, EDIT_MOST,
31*2067fd92SSamuel Thibault EDIT_REPEAT, EDIT_SOME, SPEAKUP_GOTO, BOTTOM_EDGE,
32*2067fd92SSamuel Thibault LEFT_EDGE, RIGHT_EDGE, TOP_EDGE, SPEAKUP_HELP,
33*2067fd92SSamuel Thibault SAY_LINE, SAY_NEXT_LINE, SAY_PREV_LINE, SAY_LINE_INDENT,
34*2067fd92SSamuel Thibault SPEAKUP_PASTE, PITCH_DEC, PITCH_INC, PUNCT_DEC,
35*2067fd92SSamuel Thibault PUNCT_INC, PUNC_LEVEL_DEC, PUNC_LEVEL_INC, SPEAKUP_QUIET,
36*2067fd92SSamuel Thibault RATE_DEC, RATE_INC, READING_PUNC_DEC, READING_PUNC_INC,
37*2067fd92SSamuel Thibault SAY_ATTRIBUTES, SAY_FROM_LEFT, SAY_FROM_TOP, SAY_POSITION,
38*2067fd92SSamuel Thibault SAY_SCREEN, SAY_TO_BOTTOM, SAY_TO_RIGHT, SPK_KEY,
39*2067fd92SSamuel Thibault SPK_LOCK, SPEAKUP_OFF, SPEECH_KILL, SPELL_DELAY_DEC,
40*2067fd92SSamuel Thibault SPELL_DELAY_INC, SPELL_WORD, SPELL_PHONETIC, TONE_DEC,
41*2067fd92SSamuel Thibault TONE_INC, VOICE_DEC, VOICE_INC, VOL_DEC,
42*2067fd92SSamuel Thibault VOL_INC, CLEAR_WIN, SAY_WIN, SET_WIN,
43*2067fd92SSamuel Thibault ENABLE_WIN, SAY_WORD, SAY_NEXT_WORD, SAY_PREV_WORD, 0
44*2067fd92SSamuel Thibault };
45*2067fd92SSamuel Thibault
46*2067fd92SSamuel Thibault static u_char *state_tbl;
47*2067fd92SSamuel Thibault static int cur_item, nstates;
48*2067fd92SSamuel Thibault
build_key_data(void)49*2067fd92SSamuel Thibault static void build_key_data(void)
50*2067fd92SSamuel Thibault {
51*2067fd92SSamuel Thibault u_char *kp, counters[MAXFUNCS], ch, ch1;
52*2067fd92SSamuel Thibault u_short *p_key, key;
53*2067fd92SSamuel Thibault int i, offset = 1;
54*2067fd92SSamuel Thibault
55*2067fd92SSamuel Thibault nstates = (int)(state_tbl[-1]);
56*2067fd92SSamuel Thibault memset(counters, 0, sizeof(counters));
57*2067fd92SSamuel Thibault memset(key_offsets, 0, sizeof(key_offsets));
58*2067fd92SSamuel Thibault kp = state_tbl + nstates + 1;
59*2067fd92SSamuel Thibault while (*kp++) {
60*2067fd92SSamuel Thibault /* count occurrences of each function */
61*2067fd92SSamuel Thibault for (i = 0; i < nstates; i++, kp++) {
62*2067fd92SSamuel Thibault if (!*kp)
63*2067fd92SSamuel Thibault continue;
64*2067fd92SSamuel Thibault if ((state_tbl[i] & 16) != 0 && *kp == SPK_KEY)
65*2067fd92SSamuel Thibault continue;
66*2067fd92SSamuel Thibault counters[*kp]++;
67*2067fd92SSamuel Thibault }
68*2067fd92SSamuel Thibault }
69*2067fd92SSamuel Thibault for (i = 0; i < MAXFUNCS; i++) {
70*2067fd92SSamuel Thibault if (counters[i] == 0)
71*2067fd92SSamuel Thibault continue;
72*2067fd92SSamuel Thibault key_offsets[i] = offset;
73*2067fd92SSamuel Thibault offset += (counters[i] + 1);
74*2067fd92SSamuel Thibault if (offset >= MAXKEYS)
75*2067fd92SSamuel Thibault break;
76*2067fd92SSamuel Thibault }
77*2067fd92SSamuel Thibault /* leave counters set so high keycodes come first.
78*2067fd92SSamuel Thibault * this is done so num pad and other extended keys maps are spoken before
79*2067fd92SSamuel Thibault * the alpha with speakup type mapping.
80*2067fd92SSamuel Thibault */
81*2067fd92SSamuel Thibault kp = state_tbl + nstates + 1;
82*2067fd92SSamuel Thibault while ((ch = *kp++)) {
83*2067fd92SSamuel Thibault for (i = 0; i < nstates; i++) {
84*2067fd92SSamuel Thibault ch1 = *kp++;
85*2067fd92SSamuel Thibault if (!ch1)
86*2067fd92SSamuel Thibault continue;
87*2067fd92SSamuel Thibault if ((state_tbl[i] & 16) != 0 && ch1 == SPK_KEY)
88*2067fd92SSamuel Thibault continue;
89*2067fd92SSamuel Thibault key = (state_tbl[i] << 8) + ch;
90*2067fd92SSamuel Thibault counters[ch1]--;
91*2067fd92SSamuel Thibault offset = key_offsets[ch1];
92*2067fd92SSamuel Thibault if (!offset)
93*2067fd92SSamuel Thibault continue;
94*2067fd92SSamuel Thibault p_key = key_data + offset + counters[ch1];
95*2067fd92SSamuel Thibault *p_key = key;
96*2067fd92SSamuel Thibault }
97*2067fd92SSamuel Thibault }
98*2067fd92SSamuel Thibault }
99*2067fd92SSamuel Thibault
say_key(int key)100*2067fd92SSamuel Thibault static void say_key(int key)
101*2067fd92SSamuel Thibault {
102*2067fd92SSamuel Thibault int i, state = key >> 8;
103*2067fd92SSamuel Thibault
104*2067fd92SSamuel Thibault key &= 0xff;
105*2067fd92SSamuel Thibault for (i = 0; i < 6; i++) {
106*2067fd92SSamuel Thibault if (state & masks[i])
107*2067fd92SSamuel Thibault synth_printf(" %s", spk_msg_get(MSG_STATES_START + i));
108*2067fd92SSamuel Thibault }
109*2067fd92SSamuel Thibault if ((key > 0) && (key <= num_key_names))
110*2067fd92SSamuel Thibault synth_printf(" %s\n",
111*2067fd92SSamuel Thibault spk_msg_get(MSG_KEYNAMES_START + (key - 1)));
112*2067fd92SSamuel Thibault }
113*2067fd92SSamuel Thibault
help_init(void)114*2067fd92SSamuel Thibault static int help_init(void)
115*2067fd92SSamuel Thibault {
116*2067fd92SSamuel Thibault char start = SPACE;
117*2067fd92SSamuel Thibault int i;
118*2067fd92SSamuel Thibault int num_funcs = MSG_FUNCNAMES_END - MSG_FUNCNAMES_START + 1;
119*2067fd92SSamuel Thibault
120*2067fd92SSamuel Thibault state_tbl = spk_our_keys[0] + SHIFT_TBL_SIZE + 2;
121*2067fd92SSamuel Thibault for (i = 0; i < num_funcs; i++) {
122*2067fd92SSamuel Thibault char *cur_funcname = spk_msg_get(MSG_FUNCNAMES_START + i);
123*2067fd92SSamuel Thibault
124*2067fd92SSamuel Thibault if (start == *cur_funcname)
125*2067fd92SSamuel Thibault continue;
126*2067fd92SSamuel Thibault start = *cur_funcname;
127*2067fd92SSamuel Thibault letter_offsets[(start & 31) - 1] = i;
128*2067fd92SSamuel Thibault }
129*2067fd92SSamuel Thibault return 0;
130*2067fd92SSamuel Thibault }
131*2067fd92SSamuel Thibault
spk_handle_help(struct vc_data * vc,u_char type,u_char ch,u_short key)132*2067fd92SSamuel Thibault int spk_handle_help(struct vc_data *vc, u_char type, u_char ch, u_short key)
133*2067fd92SSamuel Thibault {
134*2067fd92SSamuel Thibault int i, n;
135*2067fd92SSamuel Thibault char *name;
136*2067fd92SSamuel Thibault u_char func, *kp;
137*2067fd92SSamuel Thibault u_short *p_keys, val;
138*2067fd92SSamuel Thibault
139*2067fd92SSamuel Thibault if (letter_offsets[0] == -1)
140*2067fd92SSamuel Thibault help_init();
141*2067fd92SSamuel Thibault if (type == KT_LATIN) {
142*2067fd92SSamuel Thibault if (ch == SPACE) {
143*2067fd92SSamuel Thibault spk_special_handler = NULL;
144*2067fd92SSamuel Thibault synth_printf("%s\n", spk_msg_get(MSG_LEAVING_HELP));
145*2067fd92SSamuel Thibault return 1;
146*2067fd92SSamuel Thibault }
147*2067fd92SSamuel Thibault ch |= 32; /* lower case */
148*2067fd92SSamuel Thibault if (ch < 'a' || ch > 'z')
149*2067fd92SSamuel Thibault return -1;
150*2067fd92SSamuel Thibault if (letter_offsets[ch - 'a'] == -1) {
151*2067fd92SSamuel Thibault synth_printf(spk_msg_get(MSG_NO_COMMAND), ch);
152*2067fd92SSamuel Thibault synth_printf("\n");
153*2067fd92SSamuel Thibault return 1;
154*2067fd92SSamuel Thibault }
155*2067fd92SSamuel Thibault cur_item = letter_offsets[ch - 'a'];
156*2067fd92SSamuel Thibault } else if (type == KT_CUR) {
157*2067fd92SSamuel Thibault if (ch == 0 &&
158*2067fd92SSamuel Thibault (MSG_FUNCNAMES_START + cur_item + 1) <= MSG_FUNCNAMES_END)
159*2067fd92SSamuel Thibault cur_item++;
160*2067fd92SSamuel Thibault else if (ch == 3 && cur_item > 0)
161*2067fd92SSamuel Thibault cur_item--;
162*2067fd92SSamuel Thibault else
163*2067fd92SSamuel Thibault return -1;
164*2067fd92SSamuel Thibault } else if (type == KT_SPKUP && ch == SPEAKUP_HELP &&
165*2067fd92SSamuel Thibault !spk_special_handler) {
166*2067fd92SSamuel Thibault spk_special_handler = spk_handle_help;
167*2067fd92SSamuel Thibault synth_printf("%s\n", spk_msg_get(MSG_HELP_INFO));
168*2067fd92SSamuel Thibault build_key_data(); /* rebuild each time in case new mapping */
169*2067fd92SSamuel Thibault return 1;
170*2067fd92SSamuel Thibault } else {
171*2067fd92SSamuel Thibault name = NULL;
172*2067fd92SSamuel Thibault if ((type != KT_SPKUP) && (key > 0) && (key <= num_key_names)) {
173*2067fd92SSamuel Thibault synth_printf("%s\n",
174*2067fd92SSamuel Thibault spk_msg_get(MSG_KEYNAMES_START + key - 1));
175*2067fd92SSamuel Thibault return 1;
176*2067fd92SSamuel Thibault }
177*2067fd92SSamuel Thibault for (i = 0; funcvals[i] != 0 && !name; i++) {
178*2067fd92SSamuel Thibault if (ch == funcvals[i])
179*2067fd92SSamuel Thibault name = spk_msg_get(MSG_FUNCNAMES_START + i);
180*2067fd92SSamuel Thibault }
181*2067fd92SSamuel Thibault if (!name)
182*2067fd92SSamuel Thibault return -1;
183*2067fd92SSamuel Thibault kp = spk_our_keys[key] + 1;
184*2067fd92SSamuel Thibault for (i = 0; i < nstates; i++) {
185*2067fd92SSamuel Thibault if (ch == kp[i])
186*2067fd92SSamuel Thibault break;
187*2067fd92SSamuel Thibault }
188*2067fd92SSamuel Thibault key += (state_tbl[i] << 8);
189*2067fd92SSamuel Thibault say_key(key);
190*2067fd92SSamuel Thibault synth_printf(spk_msg_get(MSG_KEYDESC), name);
191*2067fd92SSamuel Thibault synth_printf("\n");
192*2067fd92SSamuel Thibault return 1;
193*2067fd92SSamuel Thibault }
194*2067fd92SSamuel Thibault name = spk_msg_get(MSG_FUNCNAMES_START + cur_item);
195*2067fd92SSamuel Thibault func = funcvals[cur_item];
196*2067fd92SSamuel Thibault synth_printf("%s", name);
197*2067fd92SSamuel Thibault if (key_offsets[func] == 0) {
198*2067fd92SSamuel Thibault synth_printf(" %s\n", spk_msg_get(MSG_IS_UNASSIGNED));
199*2067fd92SSamuel Thibault return 1;
200*2067fd92SSamuel Thibault }
201*2067fd92SSamuel Thibault p_keys = key_data + key_offsets[func];
202*2067fd92SSamuel Thibault for (n = 0; p_keys[n]; n++) {
203*2067fd92SSamuel Thibault val = p_keys[n];
204*2067fd92SSamuel Thibault if (n > 0)
205*2067fd92SSamuel Thibault synth_printf("%s ", spk_msg_get(MSG_DISJUNCTION));
206*2067fd92SSamuel Thibault say_key(val);
207*2067fd92SSamuel Thibault }
208*2067fd92SSamuel Thibault return 1;
209*2067fd92SSamuel Thibault }
210