drivers/staging/speakup/keyhelp.c

   1 /* speakup_keyhelp.c
   2  * help module for speakup
   3  *
   4  *written by David Borowski.
   5  *
   6  *  Copyright (C) 2003  David Borowski.
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 #include <linux/keyboard.h>
  24 #include "spk_priv.h"
  25 #include "speakup.h"
  26
  27 #define MAXFUNCS 130
  28 #define MAXKEYS 256
  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 };
  32
  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,
  37         -1, -1 };
  38
  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
  57 };
  58
  59 static u_char *state_tbl;
  60 static int cur_item, nstates;
  61
  62 static void build_key_data(void)
  63 {
  64         u_char *kp, counters[MAXFUNCS], ch, ch1;
  65         u_short *p_key = key_data, key;
  66         int i, offset = 1;
  67
  68         nstates = (int)(state_tbl[-1]);
  69         memset(counters, 0, sizeof(counters));
  70         memset(key_offsets, 0, sizeof(key_offsets));
  71         kp = state_tbl + nstates + 1;
  72         while (*kp++) {
  73                 /* count occurrences of each function */
  74                 for (i = 0; i < nstates; i++, kp++) {
  75                         if (!*kp)
  76                                 continue;
  77                         if ((state_tbl[i]&16) != 0 && *kp == SPK_KEY)
  78                                 continue;
  79                         counters[*kp]++;
  80                 }
  81         }
  82         for (i = 0; i < MAXFUNCS; i++) {
  83                 if (counters[i] == 0)
  84                         continue;
  85                 key_offsets[i] = offset;
  86                 offset += (counters[i]+1);
  87                 if (offset >= MAXKEYS)
  88                         break;
  89         }
  90 /* leave counters set so high keycodes come first.
  91  * this is done so num pad and other extended keys maps are spoken before
  92  * the alpha with speakup type mapping.
  93  */
  94         kp = state_tbl + nstates + 1;
  95         while ((ch = *kp++)) {
  96                 for (i = 0; i < nstates; i++) {
  97                         ch1 = *kp++;
  98                         if (!ch1)
  99                                 continue;
 100                         if ((state_tbl[i]&16) != 0 && ch1 == SPK_KEY)
 101                                 continue;
 102                         key = (state_tbl[i] << 8) + ch;
 103                         counters[ch1]--;
 104                         offset = key_offsets[ch1];
 105                         if (!offset)
 106                                 continue;
 107                         p_key = key_data + offset + counters[ch1];
 108                         *p_key = key;
 109                 }
 110         }
 111 }
 112
 113 static void say_key(int key)
 114 {
 115         int i, state = key >> 8;
 116
 117         key &= 0xff;
 118         for (i = 0; i < 6; i++) {
 119                 if (state & masks[i])
 120                         synth_printf(" %s", spk_msg_get(MSG_STATES_START + i));
 121         }
 122         if ((key > 0) && (key <= num_key_names))
 123                 synth_printf(" %s\n",
 124                                 spk_msg_get(MSG_KEYNAMES_START + (key - 1)));
 125 }
 126
 127 static int help_init(void)
 128 {
 129         char start = SPACE;
 130         int i;
 131         int num_funcs = MSG_FUNCNAMES_END - MSG_FUNCNAMES_START + 1;
 132
 133         state_tbl = spk_our_keys[0]+SHIFT_TBL_SIZE+2;
 134         for (i = 0; i < num_funcs; i++) {
 135                 char *cur_funcname = spk_msg_get(MSG_FUNCNAMES_START + i);
 136
 137                 if (start == *cur_funcname)
 138                         continue;
 139                 start = *cur_funcname;
 140                 letter_offsets[(start&31)-1] = i;
 141         }
 142         return 0;
 143 }
 144
 145 int spk_handle_help(struct vc_data *vc, u_char type, u_char ch, u_short key)
 146 {
 147         int i, n;
 148         char *name;
 149         u_char func, *kp;
 150         u_short *p_keys, val;
 151
 152         if (letter_offsets[0] == -1)
 153                 help_init();
 154         if (type == KT_LATIN) {
 155                 if (ch == SPACE) {
 156                         spk_special_handler = NULL;
 157                         synth_printf("%s\n", spk_msg_get(MSG_LEAVING_HELP));
 158                         return 1;
 159                 }
 160                 ch |= 32; /* lower case */
 161                 if (ch < 'a' || ch > 'z')
 162                         return -1;
 163                 if (letter_offsets[ch-'a'] == -1) {
 164                         synth_printf(spk_msg_get(MSG_NO_COMMAND), ch);
 165                         synth_printf("\n");
 166                         return 1;
 167                 }
 168                 cur_item = letter_offsets[ch-'a'];
 169         } else if (type == KT_CUR) {
 170                 if (ch == 0
 171                     && (MSG_FUNCNAMES_START + cur_item + 1) <=
 172                     MSG_FUNCNAMES_END)
 173                         cur_item++;
 174                 else if (ch == 3 && cur_item > 0)
 175                         cur_item--;
 176                 else
 177                         return -1;
 178         } else if (type == KT_SPKUP
 179                         && ch == SPEAKUP_HELP
 180                         && !spk_special_handler) {
 181                 spk_special_handler = spk_handle_help;
 182                 synth_printf("%s\n", spk_msg_get(MSG_HELP_INFO));
 183                 build_key_data(); /* rebuild each time in case new mapping */
 184                 return 1;
 185         } else {
 186                 name = NULL;
 187                 if ((type != KT_SPKUP) && (key > 0) && (key <= num_key_names)) {
 188                         synth_printf("%s\n",
 189                                 spk_msg_get(MSG_KEYNAMES_START + key-1));
 190                         return 1;
 191                 }
 192                 for (i = 0; funcvals[i] != 0 && !name; i++) {
 193                         if (ch == funcvals[i])
 194                                 name = spk_msg_get(MSG_FUNCNAMES_START + i);
 195                 }
 196                 if (!name)
 197                         return -1;
 198                 kp = spk_our_keys[key]+1;
 199                 for (i = 0; i < nstates; i++) {
 200                         if (ch == kp[i])
 201                                 break;
 202                 }
 203                 key += (state_tbl[i] << 8);
 204                 say_key(key);
 205                 synth_printf(spk_msg_get(MSG_KEYDESC), name);
 206                 synth_printf("\n");
 207                 return 1;
 208         }
 209         name = spk_msg_get(MSG_FUNCNAMES_START + cur_item);
 210         func = funcvals[cur_item];
 211         synth_printf("%s", name);
 212         if (key_offsets[func] == 0) {
 213                 synth_printf(" %s\n", spk_msg_get(MSG_IS_UNASSIGNED));
 214                 return 1;
 215         }
 216         p_keys = key_data + key_offsets[func];
 217         for (n = 0; p_keys[n]; n++) {
 218                 val = p_keys[n];
 219                 if (n > 0)
 220                         synth_printf("%s ", spk_msg_get(MSG_DISJUNCTION));
 221                 say_key(val);
 222         }
 223         return 1;
 224 }