2 help module for speakup
4 written by David Borowski.
6 Copyright (C) 2003 David Borowski.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/keyboard.h>
29 static const int num_key_names = MSG_KEYNAMES_END - MSG_KEYNAMES_START + 1;
30 static u_short key_offsets[MAXFUNCS], key_data[MAXKEYS];
31 static u_short masks[] = { 32, 16, 8, 4, 2, 1 };
33 static short letter_offsets[26] =
34 { -1, -1, -1, -1, -1, -1, -1, -1,
35 -1, -1, -1, -1, -1, -1, -1, -1,
36 -1, -1, -1, -1, -1, -1, -1, -1,
39 static u_char funcvals[] = {
40 ATTRIB_BLEEP_DEC, ATTRIB_BLEEP_INC, BLEEPS_DEC, BLEEPS_INC,
41 SAY_FIRST_CHAR, SAY_LAST_CHAR, SAY_CHAR, SAY_CHAR_NUM,
42 SAY_NEXT_CHAR, SAY_PHONETIC_CHAR, SAY_PREV_CHAR, SPEAKUP_PARKED,
43 SPEAKUP_CUT, EDIT_DELIM, EDIT_EXNUM, EDIT_MOST,
44 EDIT_REPEAT, EDIT_SOME, SPEAKUP_GOTO, BOTTOM_EDGE,
45 LEFT_EDGE, RIGHT_EDGE, TOP_EDGE, SPEAKUP_HELP,
46 SAY_LINE, SAY_NEXT_LINE, SAY_PREV_LINE, SAY_LINE_INDENT,
47 SPEAKUP_PASTE, PITCH_DEC, PITCH_INC, PUNCT_DEC,
48 PUNCT_INC, PUNC_LEVEL_DEC, PUNC_LEVEL_INC, SPEAKUP_QUIET,
49 RATE_DEC, RATE_INC, READING_PUNC_DEC, READING_PUNC_INC,
50 SAY_ATTRIBUTES, SAY_FROM_LEFT, SAY_FROM_TOP, SAY_POSITION,
51 SAY_SCREEN, SAY_TO_BOTTOM, SAY_TO_RIGHT, SPK_KEY,
52 SPK_LOCK, SPEAKUP_OFF, SPEECH_KILL, SPELL_DELAY_DEC,
53 SPELL_DELAY_INC, SPELL_WORD, SPELL_PHONETIC, TONE_DEC,
54 TONE_INC, VOICE_DEC, VOICE_INC, VOL_DEC,
55 VOL_INC, CLEAR_WIN, SAY_WIN, SET_WIN,
56 ENABLE_WIN, SAY_WORD, SAY_NEXT_WORD, SAY_PREV_WORD, 0
59 static u_char *state_tbl;
60 static int cur_item, nstates;
62 static void build_key_data(void)
64 u_char *kp, counters[MAXFUNCS], ch, ch1;
65 u_short *p_key = key_data, key;
67 nstates = (int)(state_tbl[-1]);
68 memset(counters, 0, sizeof(counters));
69 memset(key_offsets, 0, sizeof(key_offsets));
70 kp = state_tbl + nstates + 1;
72 /* count occurrances of each function */
73 for (i = 0; i < nstates; i++, kp++) {
76 if ((state_tbl[i]&16) != 0 && *kp == SPK_KEY)
81 for (i = 0; i < MAXFUNCS; i++) {
84 key_offsets[i] = offset;
85 offset += (counters[i]+1);
86 if (offset >= MAXKEYS)
89 /* leave counters set so high keycodes come first.
90 this is done so num pad and other extended keys maps are spoken before
91 the alpha with speakup type mapping. */
92 kp = state_tbl + nstates + 1;
93 while ((ch = *kp++)) {
94 for (i = 0; i < nstates; i++) {
98 if ((state_tbl[i]&16) != 0 && ch1 == SPK_KEY)
100 key = (state_tbl[i] << 8) + ch;
102 offset = key_offsets[ch1];
105 p_key = key_data + offset + counters[ch1];
111 static void say_key(int key)
113 int i, state = key >> 8;
115 for (i = 0; i < 6; i++) {
116 if (state & masks[i])
117 synth_printf(" %s", msg_get(MSG_STATES_START + i));
119 if ((key > 0) && (key <= num_key_names))
120 synth_printf(" %s\n", msg_get(MSG_KEYNAMES_START + (key - 1)));
123 static int help_init(void)
127 int num_funcs = MSG_FUNCNAMES_END - MSG_FUNCNAMES_START + 1;
128 state_tbl = our_keys[0]+SHIFT_TBL_SIZE+2;
129 for (i = 0; i < num_funcs; i++) {
130 char *cur_funcname = msg_get(MSG_FUNCNAMES_START + i);
131 if (start == *cur_funcname)
133 start = *cur_funcname;
134 letter_offsets[(start&31)-1] = i;
139 int handle_help(struct vc_data *vc, u_char type, u_char ch, u_short key)
144 u_short *p_keys, val;
145 if (letter_offsets[0] == -1)
147 if (type == KT_LATIN) {
149 special_handler = NULL;
150 synth_printf("%s\n", msg_get(MSG_LEAVING_HELP));
153 ch |= 32; /* lower case */
154 if (ch < 'a' || ch > 'z')
156 if (letter_offsets[ch-'a'] == -1) {
157 synth_printf(msg_get(MSG_NO_COMMAND), ch);
161 cur_item = letter_offsets[ch-'a'];
162 } else if (type == KT_CUR) {
163 if (ch == 0 && (cur_item + 1) <= MSG_FUNCNAMES_END)
165 else if (ch == 3 && cur_item > 0)
169 } else if (type == KT_SPKUP && ch == SPEAKUP_HELP && !special_handler) {
170 special_handler = handle_help;
171 synth_printf("%s\n", msg_get(MSG_HELP_INFO));
172 build_key_data(); /* rebuild each time in case new mapping */
176 if ((type != KT_SPKUP) && (key > 0) && (key <= num_key_names)) {
177 synth_printf("%s\n", msg_get(MSG_KEYNAMES_START + key-1));
180 for (i = 0; funcvals[i] != 0 && !name; i++) {
181 if (ch == funcvals[i])
182 name = msg_get(MSG_FUNCNAMES_START + i);
186 kp = our_keys[key]+1;
187 for (i = 0; i < nstates; i++) {
191 key += (state_tbl[i] << 8);
193 synth_printf(msg_get(MSG_KEYDESC), name);
197 name = msg_get(MSG_FUNCNAMES_START + cur_item);
198 func = funcvals[cur_item];
199 synth_printf("%s", name);
200 if (key_offsets[func] == 0) {
201 synth_printf(" %s\n", msg_get(MSG_IS_UNASSIGNED));
204 p_keys = key_data + key_offsets[func];
205 for (n = 0; p_keys[n]; n++) {
208 synth_printf("%s ", msg_get(MSG_DISJUNCTION));