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