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