Path: blob/master/drivers/accessibility/speakup/speakup.h
26282 views
/* SPDX-License-Identifier: GPL-2.0 */1#ifndef _SPEAKUP_H2#define _SPEAKUP_H34#include "spk_types.h"5#include "i18n.h"67#define SPEAKUP_VERSION "3.1.6"8#define KEY_MAP_VER 1199#define SHIFT_TBL_SIZE 6410#define MAX_DESC_LEN 721112#define TOGGLE_0 .u.n = {NULL, 0, 0, 1, 0, 0, NULL }13#define TOGGLE_1 .u.n = {NULL, 1, 0, 1, 0, 0, NULL }14#define MAXVARLEN 151516#define SYNTH_OK 0x000117#define B_ALPHA 0x000218#define ALPHA 0x000319#define B_CAP 0x000420#define A_CAP 0x000721#define B_NUM 0x000822#define NUM 0x000923#define ALPHANUM (B_ALPHA | B_NUM)24#define SOME 0x001025#define MOST 0x002026#define PUNC 0x004027#define A_PUNC 0x004128#define B_WDLM 0x008029#define WDLM 0x008130#define B_EXNUM 0x010031#define CH_RPT 0x020032#define B_CTL 0x040033#define A_CTL (B_CTL + SYNTH_OK)34#define B_SYM 0x080035#define B_CAPSYM (B_CAP | B_SYM)3637/* FIXME: u16 */38#define IS_WDLM(x) (spk_chartab[((u_char)x)] & B_WDLM)39#define IS_CHAR(x, type) (spk_chartab[((u_char)x)] & type)40#define IS_TYPE(x, type) ((spk_chartab[((u_char)x)] & type) == type)4142int speakup_thread(void *data);43void spk_reset_default_chars(void);44void spk_reset_default_chartab(void);45void synth_start(void);46void synth_insert_next_index(int sent_num);47void spk_reset_index_count(int sc);48void spk_get_index_count(int *linecount, int *sentcount);49int spk_set_key_info(const u_char *key_info, u_char *k_buffer);50char *spk_strlwr(char *s);51char *spk_s2uchar(char *start, char *dest);52int speakup_kobj_init(void);53void speakup_kobj_exit(void);54int spk_chartab_get_value(char *keyword);55void speakup_register_var(struct var_t *var);56void speakup_unregister_var(enum var_id_t var_id);57struct st_var_header *spk_get_var_header(enum var_id_t var_id);58struct st_var_header *spk_var_header_by_name(const char *name);59struct punc_var_t *spk_get_punc_var(enum var_id_t var_id);60int spk_set_num_var(int val, struct st_var_header *var, int how);61int spk_set_string_var(const char *page, struct st_var_header *var, int len);62int spk_set_mask_bits(const char *input, const int which, const int how);63extern special_func spk_special_handler;64int spk_handle_help(struct vc_data *vc, u_char type, u_char ch, u_short key);65int synth_init(char *name);66void synth_release(void);6768void spk_do_flush(void);69void speakup_start_ttys(void);70void synth_buffer_add(u16 ch);71void synth_buffer_clear(void);72int speakup_set_selection(struct tty_struct *tty);73void speakup_cancel_selection(void);74int speakup_paste_selection(struct tty_struct *tty);75void speakup_cancel_paste(void);76void speakup_register_devsynth(void);77void speakup_unregister_devsynth(void);78s32 synth_utf8_get(const char *buf, size_t count, size_t *consumed, size_t *want);79void synth_write(const char *buf, size_t count);80void synth_writeu(const char *buf, size_t count);81int synth_supports_indexing(void);8283extern struct vc_data *spk_sel_cons;84extern unsigned short spk_xs, spk_ys, spk_xe, spk_ye; /* our region points */8586extern wait_queue_head_t speakup_event;87extern struct kobject *speakup_kobj;88extern struct task_struct *speakup_task;89extern const u_char spk_key_defaults[];9091/* Protect speakup synthesizer list */92extern struct mutex spk_mutex;93extern struct st_spk_t *speakup_console[];94extern struct spk_synth *synth;95extern char spk_pitch_buff[];96extern u_char *spk_our_keys[];97extern short spk_punc_masks[];98extern char spk_str_caps_start[], spk_str_caps_stop[], spk_str_pause[];99extern bool spk_paused;100extern const struct st_bits_data spk_punc_info[];101extern u_char spk_key_buf[600];102extern char *spk_characters[];103extern char *spk_default_chars[];104extern u_short spk_chartab[];105extern int spk_no_intr, spk_say_ctrl, spk_say_word_ctl, spk_punc_level;106extern int spk_reading_punc, spk_attrib_bleep, spk_bleeps;107extern int spk_bleep_time, spk_bell_pos;108extern int spk_spell_delay, spk_key_echo;109extern int spk_cur_phonetic;110extern short spk_punc_mask;111extern short spk_pitch_shift, synth_flags;112extern bool spk_quiet_boot;113extern char *synth_name;114extern struct bleep spk_unprocessed_sound;115116/* Prototypes from fakekey.c. */117int speakup_add_virtual_keyboard(void);118void speakup_remove_virtual_keyboard(void);119void speakup_fake_down_arrow(void);120bool speakup_fake_key_pressed(void);121122#endif123124125