blob: a7f4962427f36b98d54e98518e8259ff11f044c8 [file] [log] [blame]
William Hubbsc6e3fd22010-10-07 13:20:02 -05001#ifndef _SPEAKUP_H
2#define _SPEAKUP_H
William Hubbsc6e3fd22010-10-07 13:20:02 -05003
4#include "spk_types.h"
5#include "i18n.h"
6
7#define SPEAKUP_VERSION "3.1.6"
8#define KEY_MAP_VER 119
9#define SHIFT_TBL_SIZE 64
10#define MAX_DESC_LEN 72
11
12/* proc permissions */
13#define USER_R (S_IFREG|S_IRUGO)
14#define USER_W (S_IFREG|S_IWUGO)
William Hubbsc6e3fd22010-10-07 13:20:02 -050015
16#define TOGGLE_0 .u.n = {NULL, 0, 0, 1, 0, 0, NULL }
17#define TOGGLE_1 .u.n = {NULL, 1, 0, 1, 0, 0, NULL }
18#define MAXVARLEN 15
19
20#define SYNTH_OK 0x0001
21#define B_ALPHA 0x0002
22#define ALPHA 0x0003
23#define B_CAP 0x0004
24#define A_CAP 0x0007
25#define B_NUM 0x0008
26#define NUM 0x0009
27#define ALPHANUM (B_ALPHA|B_NUM)
28#define SOME 0x0010
29#define MOST 0x0020
30#define PUNC 0x0040
31#define A_PUNC 0x0041
32#define B_WDLM 0x0080
33#define WDLM 0x0081
34#define B_EXNUM 0x0100
35#define CH_RPT 0x0200
36#define B_CTL 0x0400
37#define A_CTL (B_CTL+SYNTH_OK)
38#define B_SYM 0x0800
39#define B_CAPSYM (B_CAP|B_SYM)
40
41#define IS_WDLM(x) (spk_chartab[((u_char)x)]&B_WDLM)
42#define IS_CHAR(x, type) (spk_chartab[((u_char)x)]&type)
43#define IS_TYPE(x, type) ((spk_chartab[((u_char)x)]&type) == type)
44
William Hubbsc6e3fd22010-10-07 13:20:02 -050045extern int speakup_thread(void *data);
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010046extern void spk_reset_default_chars(void);
47extern void spk_reset_default_chartab(void);
William Hubbsc6e3fd22010-10-07 13:20:02 -050048extern void synth_start(void);
William Hubbs16d35512010-10-15 22:13:34 -050049void synth_insert_next_index(int sent_num);
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010050void spk_reset_index_count(int sc);
51void spk_get_index_count(int *linecount, int *sentcount);
52extern int spk_set_key_info(const u_char *key_info, u_char *k_buffer);
53extern char *spk_strlwr(char *s);
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010054extern char *spk_s2uchar(char *start, char *dest);
William Hubbsc6e3fd22010-10-07 13:20:02 -050055extern int speakup_kobj_init(void);
56extern void speakup_kobj_exit(void);
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010057extern int spk_chartab_get_value(char *keyword);
William Hubbsc6e3fd22010-10-07 13:20:02 -050058extern void speakup_register_var(struct var_t *var);
59extern void speakup_unregister_var(enum var_id_t var_id);
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010060extern struct st_var_header *spk_get_var_header(enum var_id_t var_id);
61extern struct st_var_header *spk_var_header_by_name(const char *name);
62extern struct punc_var_t *spk_get_punc_var(enum var_id_t var_id);
63extern int spk_set_num_var(int val, struct st_var_header *var, int how);
Shirish Gajera63b8ebe2015-03-28 13:21:39 -070064extern int spk_set_string_var(const char *page, struct st_var_header *var,
65 int len);
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010066extern int spk_set_mask_bits(const char *input, const int which, const int how);
67extern special_func spk_special_handler;
Shirish Gajera63b8ebe2015-03-28 13:21:39 -070068extern int spk_handle_help(struct vc_data *vc, u_char type, u_char ch,
69 u_short key);
William Hubbsc6e3fd22010-10-07 13:20:02 -050070extern int synth_init(char *name);
71extern void synth_release(void);
72
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010073extern void spk_do_flush(void);
William Hubbsc6e3fd22010-10-07 13:20:02 -050074extern void speakup_start_ttys(void);
75extern void synth_buffer_add(char ch);
76extern void synth_buffer_clear(void);
77extern void speakup_clear_selection(void);
78extern int speakup_set_selection(struct tty_struct *tty);
79extern int speakup_paste_selection(struct tty_struct *tty);
Ben Hutchingsd7500132014-05-19 00:56:22 +010080extern void speakup_cancel_paste(void);
William Hubbsc6e3fd22010-10-07 13:20:02 -050081extern void speakup_register_devsynth(void);
82extern void speakup_unregister_devsynth(void);
83extern void synth_write(const char *buf, size_t count);
84extern int synth_supports_indexing(void);
85
86extern struct vc_data *spk_sel_cons;
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010087extern unsigned short spk_xs, spk_ys, spk_xe, spk_ye; /* our region points */
William Hubbsc6e3fd22010-10-07 13:20:02 -050088
89extern wait_queue_head_t speakup_event;
90extern struct kobject *speakup_kobj;
91extern struct task_struct *speakup_task;
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010092extern const u_char spk_key_defaults[];
William Hubbsc6e3fd22010-10-07 13:20:02 -050093
94/* Protect speakup synthesizer list */
95extern struct mutex spk_mutex;
96extern struct st_spk_t *speakup_console[];
97extern struct spk_synth *synth;
Samuel Thibaultca2beaf2013-01-02 02:37:40 +010098extern char spk_pitch_buff[];
99extern u_char *spk_our_keys[];
100extern short spk_punc_masks[];
101extern char spk_str_caps_start[], spk_str_caps_stop[];
102extern const struct st_bits_data spk_punc_info[];
103extern u_char spk_key_buf[600];
104extern char *spk_characters[];
105extern char *spk_default_chars[];
William Hubbsc6e3fd22010-10-07 13:20:02 -0500106extern u_short spk_chartab[];
Samuel Thibaultca2beaf2013-01-02 02:37:40 +0100107extern int spk_no_intr, spk_say_ctrl, spk_say_word_ctl, spk_punc_level;
108extern int spk_reading_punc, spk_attrib_bleep, spk_bleeps;
109extern int spk_bleep_time, spk_bell_pos;
110extern int spk_spell_delay, spk_key_echo;
111extern short spk_punc_mask;
112extern short spk_pitch_shift, synth_flags;
113extern bool spk_quiet_boot;
William Hubbsc6e3fd22010-10-07 13:20:02 -0500114extern char *synth_name;
Samuel Thibaultca2beaf2013-01-02 02:37:40 +0100115extern struct bleep spk_unprocessed_sound;
William Hubbsc6e3fd22010-10-07 13:20:02 -0500116
117/* Prototypes from fakekey.c. */
118int speakup_add_virtual_keyboard(void);
119void speakup_remove_virtual_keyboard(void);
120void speakup_fake_down_arrow(void);
121bool speakup_fake_key_pressed(void);
122
123#endif