xref: /linux/drivers/accessibility/speakup/spk_priv_keyinfo.h (revision 02680c23d7b3febe45ea3d4f9818c2b2dc89020a)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /* spk_priv.h
3  * review functions for the speakup screen review package.
4  * originally written by: Kirk Reiser and Andy Berdan.
5  *
6  * extensively modified by David Borowski.
7  *
8  * Copyright (C) 1998  Kirk Reiser.
9  * Copyright (C) 2003  David Borowski.
10  */
11 
12 #ifndef _SPEAKUP_KEYINFO_H
13 #define _SPEAKUP_KEYINFO_H
14 
15 #define FIRST_SYNTH_VAR RATE
16 /* 0 is reserved for no remap */
17 #define SPEAKUP_GOTO		0x01
18 #define SPEECH_KILL		0x02
19 #define SPEAKUP_QUIET		0x03
20 #define SPEAKUP_CUT		0x04
21 #define SPEAKUP_PASTE		0x05
22 #define SAY_FIRST_CHAR		0x06
23 #define SAY_LAST_CHAR		0x07
24 #define SAY_CHAR		0x08
25 #define SAY_PREV_CHAR		0x09
26 #define SAY_NEXT_CHAR		0x0a
27 #define SAY_WORD		0x0b
28 #define SAY_PREV_WORD		0x0c
29 #define SAY_NEXT_WORD		0x0d
30 #define SAY_LINE		0x0e
31 #define SAY_PREV_LINE		0x0f
32 #define SAY_NEXT_LINE		0x10
33 #define TOP_EDGE		0x11
34 #define BOTTOM_EDGE		0x12
35 #define LEFT_EDGE		0x13
36 #define RIGHT_EDGE		0x14
37 #define SPELL_PHONETIC		0x15
38 #define SPELL_WORD		0x16
39 #define SAY_SCREEN		0x17
40 #define SAY_POSITION		0x18
41 #define SAY_ATTRIBUTES		0x19
42 #define SPEAKUP_OFF		0x1a
43 #define SPEAKUP_PARKED		0x1b
44 #define SAY_LINE_INDENT	0x1c
45 #define SAY_FROM_TOP		0x1d
46 #define SAY_TO_BOTTOM		0x1e
47 #define SAY_FROM_LEFT		0x1f
48 #define SAY_TO_RIGHT		0x20
49 #define SAY_CHAR_NUM		0x21
50 #define EDIT_SOME		0x22
51 #define EDIT_MOST		0x23
52 #define SAY_PHONETIC_CHAR	0x24
53 #define EDIT_DELIM		0x25
54 #define EDIT_REPEAT		0x26
55 #define EDIT_EXNUM		0x27
56 #define SET_WIN		0x28
57 #define CLEAR_WIN		0x29
58 #define ENABLE_WIN		0x2a
59 #define SAY_WIN		0x2b
60 #define SPK_LOCK		0x2c
61 #define SPEAKUP_HELP		0x2d
62 #define TOGGLE_CURSORING	0x2e
63 #define READ_ALL_DOC		0x2f
64 
65 /* one greater than the last func handler */
66 #define SPKUP_MAX_FUNC		0x30
67 
68 #define SPK_KEY		0x80
69 #define FIRST_EDIT_BITS	0x22
70 #define FIRST_SET_VAR SPELL_DELAY
71 
72 /* increase if adding more than 0x3f functions */
73 #define VAR_START		0x40
74 
75 /* keys for setting variables, must be ordered same as the enum for var_ids */
76 /* with dec being even and inc being 1 greater */
77 #define SPELL_DELAY_DEC (VAR_START + 0)
78 #define SPELL_DELAY_INC (SPELL_DELAY_DEC + 1)
79 #define PUNC_LEVEL_DEC (SPELL_DELAY_DEC + 2)
80 #define PUNC_LEVEL_INC (PUNC_LEVEL_DEC + 1)
81 #define READING_PUNC_DEC (PUNC_LEVEL_DEC + 2)
82 #define READING_PUNC_INC (READING_PUNC_DEC + 1)
83 #define ATTRIB_BLEEP_DEC (READING_PUNC_DEC + 2)
84 #define ATTRIB_BLEEP_INC (ATTRIB_BLEEP_DEC + 1)
85 #define BLEEPS_DEC (ATTRIB_BLEEP_DEC + 2)
86 #define BLEEPS_INC (BLEEPS_DEC + 1)
87 #define RATE_DEC (BLEEPS_DEC + 2)
88 #define RATE_INC (RATE_DEC + 1)
89 #define PITCH_DEC (RATE_DEC + 2)
90 #define PITCH_INC (PITCH_DEC + 1)
91 #define VOL_DEC (PITCH_DEC + 2)
92 #define VOL_INC (VOL_DEC + 1)
93 #define TONE_DEC (VOL_DEC + 2)
94 #define TONE_INC (TONE_DEC + 1)
95 #define PUNCT_DEC (TONE_DEC + 2)
96 #define PUNCT_INC (PUNCT_DEC + 1)
97 #define VOICE_DEC (PUNCT_DEC + 2)
98 #define VOICE_INC (VOICE_DEC + 1)
99 
100 #endif
101