[deliverable/linux.git] / drivers / staging / speakup / keyhelp.c

/* speakup_keyhelp.c
 * help module for speakup
 *
 *written by David Borowski.
 *
 *  Copyright (C) 2003  David Borowski.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 */

#include <linux/keyboard.h>
#include "spk_priv.h"
#include "speakup.h"

#define MAXFUNCS 130
#define MAXKEYS 256
static const int num_key_names = MSG_KEYNAMES_END - MSG_KEYNAMES_START + 1;
static u_short key_offsets[MAXFUNCS], key_data[MAXKEYS];
static u_short masks[] = { 32, 16, 8, 4, 2, 1 };

static short letter_offsets[26] = {
	-1, -1, -1, -1, -1, -1, -1, -1,
	-1, -1, -1, -1, -1, -1, -1, -1,
	-1, -1, -1, -1, -1, -1, -1, -1,
	-1, -1 };

static u_char funcvals[] = {
	ATTRIB_BLEEP_DEC, ATTRIB_BLEEP_INC, BLEEPS_DEC, BLEEPS_INC,
	SAY_FIRST_CHAR, SAY_LAST_CHAR, SAY_CHAR, SAY_CHAR_NUM,
	SAY_NEXT_CHAR, SAY_PHONETIC_CHAR, SAY_PREV_CHAR, SPEAKUP_PARKED,
	SPEAKUP_CUT, EDIT_DELIM, EDIT_EXNUM, EDIT_MOST,
	EDIT_REPEAT, EDIT_SOME, SPEAKUP_GOTO, BOTTOM_EDGE,
	LEFT_EDGE, RIGHT_EDGE, TOP_EDGE, SPEAKUP_HELP,
	SAY_LINE, SAY_NEXT_LINE, SAY_PREV_LINE, SAY_LINE_INDENT,
	SPEAKUP_PASTE, PITCH_DEC, PITCH_INC, PUNCT_DEC,
	PUNCT_INC, PUNC_LEVEL_DEC, PUNC_LEVEL_INC, SPEAKUP_QUIET,
	RATE_DEC, RATE_INC, READING_PUNC_DEC, READING_PUNC_INC,
	SAY_ATTRIBUTES, SAY_FROM_LEFT, SAY_FROM_TOP, SAY_POSITION,
	SAY_SCREEN, SAY_TO_BOTTOM, SAY_TO_RIGHT, SPK_KEY,
	SPK_LOCK, SPEAKUP_OFF, SPEECH_KILL, SPELL_DELAY_DEC,
	SPELL_DELAY_INC, SPELL_WORD, SPELL_PHONETIC, TONE_DEC,
	TONE_INC, VOICE_DEC, VOICE_INC, VOL_DEC,
	VOL_INC, CLEAR_WIN, SAY_WIN, SET_WIN,
	ENABLE_WIN, SAY_WORD, SAY_NEXT_WORD, SAY_PREV_WORD, 0
};

static u_char *state_tbl;
static int cur_item, nstates;

static void build_key_data(void)
{
	u_char *kp, counters[MAXFUNCS], ch, ch1;
	u_short *p_key = key_data, key;
	int i, offset = 1;

	nstates = (int)(state_tbl[-1]);
	memset(counters, 0, sizeof(counters));
	memset(key_offsets, 0, sizeof(key_offsets));
	kp = state_tbl + nstates + 1;
	while (*kp++) {
		/* count occurrences of each function */
		for (i = 0; i < nstates; i++, kp++) {
			if (!*kp)
				continue;
			if ((state_tbl[i] & 16) != 0 && *kp == SPK_KEY)
				continue;
			counters[*kp]++;
		}
	}
	for (i = 0; i < MAXFUNCS; i++) {
		if (counters[i] == 0)
			continue;
		key_offsets[i] = offset;
		offset += (counters[i] + 1);
		if (offset >= MAXKEYS)
			break;
	}
/* leave counters set so high keycodes come first.
 * this is done so num pad and other extended keys maps are spoken before
 * the alpha with speakup type mapping.
 */
	kp = state_tbl + nstates + 1;
	while ((ch = *kp++)) {
		for (i = 0; i < nstates; i++) {
			ch1 = *kp++;
			if (!ch1)
				continue;
			if ((state_tbl[i] & 16) != 0 && ch1 == SPK_KEY)
				continue;
			key = (state_tbl[i] << 8) + ch;
			counters[ch1]--;
			offset = key_offsets[ch1];
			if (!offset)
				continue;
			p_key = key_data + offset + counters[ch1];
			*p_key = key;
		}
	}
}

static void say_key(int key)
{
	int i, state = key >> 8;

	key &= 0xff;
	for (i = 0; i < 6; i++) {
		if (state & masks[i])
			synth_printf(" %s", spk_msg_get(MSG_STATES_START + i));
	}
	if ((key > 0) && (key <= num_key_names))
		synth_printf(" %s\n",
				spk_msg_get(MSG_KEYNAMES_START + (key - 1)));
}

static int help_init(void)
{
	char start = SPACE;
	int i;
	int num_funcs = MSG_FUNCNAMES_END - MSG_FUNCNAMES_START + 1;

	state_tbl = spk_our_keys[0] + SHIFT_TBL_SIZE + 2;
	for (i = 0; i < num_funcs; i++) {
		char *cur_funcname = spk_msg_get(MSG_FUNCNAMES_START + i);

		if (start == *cur_funcname)
			continue;
		start = *cur_funcname;
		letter_offsets[(start & 31) - 1] = i;
	}
	return 0;
}

int spk_handle_help(struct vc_data *vc, u_char type, u_char ch, u_short key)
{
	int i, n;
	char *name;
	u_char func, *kp;
	u_short *p_keys, val;

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