Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / drivers / staging / speakup / speakup.h
1 #ifndef _SPEAKUP_H
2 #define _SPEAKUP_H
3
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)
15
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
45 extern int speakup_thread(void *data);
46 extern void spk_reset_default_chars(void);
47 extern void spk_reset_default_chartab(void);
48 extern void synth_start(void);
49 void synth_insert_next_index(int sent_num);
50 void spk_reset_index_count(int sc);
51 void spk_get_index_count(int *linecount, int *sentcount);
52 extern int spk_set_key_info(const u_char *key_info, u_char *k_buffer);
53 extern char *spk_strlwr(char *s);
54 extern char *spk_s2uchar(char *start, char *dest);
55 extern int speakup_kobj_init(void);
56 extern void speakup_kobj_exit(void);
57 extern int spk_chartab_get_value(char *keyword);
58 extern void speakup_register_var(struct var_t *var);
59 extern void speakup_unregister_var(enum var_id_t var_id);
60 extern struct st_var_header *spk_get_var_header(enum var_id_t var_id);
61 extern struct st_var_header *spk_var_header_by_name(const char *name);
62 extern struct punc_var_t *spk_get_punc_var(enum var_id_t var_id);
63 extern int spk_set_num_var(int val, struct st_var_header *var, int how);
64 extern int spk_set_string_var(const char *page, struct st_var_header *var,
65                                 int len);
66 extern int spk_set_mask_bits(const char *input, const int which, const int how);
67 extern special_func spk_special_handler;
68 extern int spk_handle_help(struct vc_data *vc, u_char type, u_char ch,
69                                 u_short key);
70 extern int synth_init(char *name);
71 extern void synth_release(void);
72
73 extern void spk_do_flush(void);
74 extern void speakup_start_ttys(void);
75 extern void synth_buffer_add(char ch);
76 extern void synth_buffer_clear(void);
77 extern void speakup_clear_selection(void);
78 extern int speakup_set_selection(struct tty_struct *tty);
79 extern int speakup_paste_selection(struct tty_struct *tty);
80 extern void speakup_cancel_paste(void);
81 extern void speakup_register_devsynth(void);
82 extern void speakup_unregister_devsynth(void);
83 extern void synth_write(const char *buf, size_t count);
84 extern int synth_supports_indexing(void);
85
86 extern struct vc_data *spk_sel_cons;
87 extern unsigned short spk_xs, spk_ys, spk_xe, spk_ye; /* our region points */
88
89 extern wait_queue_head_t speakup_event;
90 extern struct kobject *speakup_kobj;
91 extern struct task_struct *speakup_task;
92 extern const u_char spk_key_defaults[];
93
94 /* Protect speakup synthesizer list */
95 extern struct mutex spk_mutex;
96 extern struct st_spk_t *speakup_console[];
97 extern struct spk_synth *synth;
98 extern char spk_pitch_buff[];
99 extern u_char *spk_our_keys[];
100 extern short spk_punc_masks[];
101 extern char spk_str_caps_start[], spk_str_caps_stop[];
102 extern const struct st_bits_data spk_punc_info[];
103 extern u_char spk_key_buf[600];
104 extern char *spk_characters[];
105 extern char *spk_default_chars[];
106 extern u_short spk_chartab[];
107 extern int spk_no_intr, spk_say_ctrl, spk_say_word_ctl, spk_punc_level;
108 extern int spk_reading_punc, spk_attrib_bleep, spk_bleeps;
109 extern int spk_bleep_time, spk_bell_pos;
110 extern int spk_spell_delay, spk_key_echo;
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