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