xref: /OK3568_Linux_fs/kernel/drivers/accessibility/speakup/speakup.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef _SPEAKUP_H
3*4882a593Smuzhiyun #define _SPEAKUP_H
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include "spk_types.h"
6*4882a593Smuzhiyun #include "i18n.h"
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #define SPEAKUP_VERSION "3.1.6"
9*4882a593Smuzhiyun #define KEY_MAP_VER 119
10*4882a593Smuzhiyun #define SHIFT_TBL_SIZE 64
11*4882a593Smuzhiyun #define MAX_DESC_LEN 72
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #define TOGGLE_0 .u.n = {NULL, 0, 0, 1, 0, 0, NULL }
14*4882a593Smuzhiyun #define TOGGLE_1 .u.n = {NULL, 1, 0, 1, 0, 0, NULL }
15*4882a593Smuzhiyun #define MAXVARLEN 15
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #define SYNTH_OK 0x0001
18*4882a593Smuzhiyun #define B_ALPHA 0x0002
19*4882a593Smuzhiyun #define ALPHA 0x0003
20*4882a593Smuzhiyun #define B_CAP 0x0004
21*4882a593Smuzhiyun #define A_CAP 0x0007
22*4882a593Smuzhiyun #define B_NUM 0x0008
23*4882a593Smuzhiyun #define NUM 0x0009
24*4882a593Smuzhiyun #define ALPHANUM (B_ALPHA | B_NUM)
25*4882a593Smuzhiyun #define SOME 0x0010
26*4882a593Smuzhiyun #define MOST 0x0020
27*4882a593Smuzhiyun #define PUNC 0x0040
28*4882a593Smuzhiyun #define A_PUNC 0x0041
29*4882a593Smuzhiyun #define B_WDLM 0x0080
30*4882a593Smuzhiyun #define WDLM 0x0081
31*4882a593Smuzhiyun #define B_EXNUM 0x0100
32*4882a593Smuzhiyun #define CH_RPT 0x0200
33*4882a593Smuzhiyun #define B_CTL 0x0400
34*4882a593Smuzhiyun #define A_CTL (B_CTL + SYNTH_OK)
35*4882a593Smuzhiyun #define B_SYM 0x0800
36*4882a593Smuzhiyun #define B_CAPSYM (B_CAP | B_SYM)
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun /* FIXME: u16 */
39*4882a593Smuzhiyun #define IS_WDLM(x) (spk_chartab[((u_char)x)] & B_WDLM)
40*4882a593Smuzhiyun #define IS_CHAR(x, type) (spk_chartab[((u_char)x)] & type)
41*4882a593Smuzhiyun #define IS_TYPE(x, type) ((spk_chartab[((u_char)x)] & type) == type)
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun int speakup_thread(void *data);
44*4882a593Smuzhiyun void spk_reset_default_chars(void);
45*4882a593Smuzhiyun void spk_reset_default_chartab(void);
46*4882a593Smuzhiyun void synth_start(void);
47*4882a593Smuzhiyun void synth_insert_next_index(int sent_num);
48*4882a593Smuzhiyun void spk_reset_index_count(int sc);
49*4882a593Smuzhiyun void spk_get_index_count(int *linecount, int *sentcount);
50*4882a593Smuzhiyun int spk_set_key_info(const u_char *key_info, u_char *k_buffer);
51*4882a593Smuzhiyun char *spk_strlwr(char *s);
52*4882a593Smuzhiyun char *spk_s2uchar(char *start, char *dest);
53*4882a593Smuzhiyun int speakup_kobj_init(void);
54*4882a593Smuzhiyun void speakup_kobj_exit(void);
55*4882a593Smuzhiyun int spk_chartab_get_value(char *keyword);
56*4882a593Smuzhiyun void speakup_register_var(struct var_t *var);
57*4882a593Smuzhiyun void speakup_unregister_var(enum var_id_t var_id);
58*4882a593Smuzhiyun struct st_var_header *spk_get_var_header(enum var_id_t var_id);
59*4882a593Smuzhiyun struct st_var_header *spk_var_header_by_name(const char *name);
60*4882a593Smuzhiyun struct punc_var_t *spk_get_punc_var(enum var_id_t var_id);
61*4882a593Smuzhiyun int spk_set_num_var(int val, struct st_var_header *var, int how);
62*4882a593Smuzhiyun int spk_set_string_var(const char *page, struct st_var_header *var, int len);
63*4882a593Smuzhiyun int spk_set_mask_bits(const char *input, const int which, const int how);
64*4882a593Smuzhiyun extern special_func spk_special_handler;
65*4882a593Smuzhiyun int spk_handle_help(struct vc_data *vc, u_char type, u_char ch, u_short key);
66*4882a593Smuzhiyun int synth_init(char *name);
67*4882a593Smuzhiyun void synth_release(void);
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun void spk_do_flush(void);
70*4882a593Smuzhiyun void speakup_start_ttys(void);
71*4882a593Smuzhiyun void synth_buffer_add(u16 ch);
72*4882a593Smuzhiyun void synth_buffer_clear(void);
73*4882a593Smuzhiyun int speakup_set_selection(struct tty_struct *tty);
74*4882a593Smuzhiyun void speakup_cancel_selection(void);
75*4882a593Smuzhiyun int speakup_paste_selection(struct tty_struct *tty);
76*4882a593Smuzhiyun void speakup_cancel_paste(void);
77*4882a593Smuzhiyun void speakup_register_devsynth(void);
78*4882a593Smuzhiyun void speakup_unregister_devsynth(void);
79*4882a593Smuzhiyun void synth_write(const char *buf, size_t count);
80*4882a593Smuzhiyun int synth_supports_indexing(void);
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun extern struct vc_data *spk_sel_cons;
83*4882a593Smuzhiyun extern unsigned short spk_xs, spk_ys, spk_xe, spk_ye; /* our region points */
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun extern wait_queue_head_t speakup_event;
86*4882a593Smuzhiyun extern struct kobject *speakup_kobj;
87*4882a593Smuzhiyun extern struct task_struct *speakup_task;
88*4882a593Smuzhiyun extern const u_char spk_key_defaults[];
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun /* Protect speakup synthesizer list */
91*4882a593Smuzhiyun extern struct mutex spk_mutex;
92*4882a593Smuzhiyun extern struct st_spk_t *speakup_console[];
93*4882a593Smuzhiyun extern struct spk_synth *synth;
94*4882a593Smuzhiyun extern char spk_pitch_buff[];
95*4882a593Smuzhiyun extern u_char *spk_our_keys[];
96*4882a593Smuzhiyun extern short spk_punc_masks[];
97*4882a593Smuzhiyun extern char spk_str_caps_start[], spk_str_caps_stop[], spk_str_pause[];
98*4882a593Smuzhiyun extern bool spk_paused;
99*4882a593Smuzhiyun extern const struct st_bits_data spk_punc_info[];
100*4882a593Smuzhiyun extern u_char spk_key_buf[600];
101*4882a593Smuzhiyun extern char *spk_characters[];
102*4882a593Smuzhiyun extern char *spk_default_chars[];
103*4882a593Smuzhiyun extern u_short spk_chartab[];
104*4882a593Smuzhiyun extern int spk_no_intr, spk_say_ctrl, spk_say_word_ctl, spk_punc_level;
105*4882a593Smuzhiyun extern int spk_reading_punc, spk_attrib_bleep, spk_bleeps;
106*4882a593Smuzhiyun extern int spk_bleep_time, spk_bell_pos;
107*4882a593Smuzhiyun extern int spk_spell_delay, spk_key_echo;
108*4882a593Smuzhiyun extern short spk_punc_mask;
109*4882a593Smuzhiyun extern short spk_pitch_shift, synth_flags;
110*4882a593Smuzhiyun extern bool spk_quiet_boot;
111*4882a593Smuzhiyun extern char *synth_name;
112*4882a593Smuzhiyun extern struct bleep spk_unprocessed_sound;
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun /* Prototypes from fakekey.c. */
115*4882a593Smuzhiyun int speakup_add_virtual_keyboard(void);
116*4882a593Smuzhiyun void speakup_remove_virtual_keyboard(void);
117*4882a593Smuzhiyun void speakup_fake_down_arrow(void);
118*4882a593Smuzhiyun bool speakup_fake_key_pressed(void);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun #endif
121