Staging: add speakup to the staging directory
[linux-2.6-block.git] / drivers / staging / speakup / speakup.h
CommitLineData
c6e3fd22
WH
1#ifndef _SPEAKUP_H
2#define _SPEAKUP_H
3#include <linux/version.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/* proc permissions */
14#define USER_R (S_IFREG|S_IRUGO)
15#define USER_W (S_IFREG|S_IWUGO)
16#define USER_RW (S_IFREG|S_IRUGO|S_IWUGO)
17#define ROOT_W (S_IFREG|S_IRUGO|S_IWUSR)
18
19#define TOGGLE_0 .u.n = {NULL, 0, 0, 1, 0, 0, NULL }
20#define TOGGLE_1 .u.n = {NULL, 1, 0, 1, 0, 0, NULL }
21#define MAXVARLEN 15
22
23#define SYNTH_OK 0x0001
24#define B_ALPHA 0x0002
25#define ALPHA 0x0003
26#define B_CAP 0x0004
27#define A_CAP 0x0007
28#define B_NUM 0x0008
29#define NUM 0x0009
30#define ALPHANUM (B_ALPHA|B_NUM)
31#define SOME 0x0010
32#define MOST 0x0020
33#define PUNC 0x0040
34#define A_PUNC 0x0041
35#define B_WDLM 0x0080
36#define WDLM 0x0081
37#define B_EXNUM 0x0100
38#define CH_RPT 0x0200
39#define B_CTL 0x0400
40#define A_CTL (B_CTL+SYNTH_OK)
41#define B_SYM 0x0800
42#define B_CAPSYM (B_CAP|B_SYM)
43
44#define IS_WDLM(x) (spk_chartab[((u_char)x)]&B_WDLM)
45#define IS_CHAR(x, type) (spk_chartab[((u_char)x)]&type)
46#define IS_TYPE(x, type) ((spk_chartab[((u_char)x)]&type) == type)
47
48#define SET_DEFAULT -4
49#define E_RANGE -3
50#define E_TOOLONG -2
51#define E_UNDEF -1
52
53extern int speakup_thread(void *data);
54extern void reset_default_chars(void);
55extern void reset_default_chartab(void);
56extern void synth_start(void);
57extern int set_key_info(const u_char *key_info, u_char *k_buffer);
58extern char *strlwr(char *s);
59extern char *speakup_s2i(char *start, int *dest);
60extern char *s2uchar(char *start, char *dest);
61extern char *xlate(char *s);
62extern int speakup_kobj_init(void);
63extern void speakup_kobj_exit(void);
64extern int chartab_get_value(char *keyword);
65extern void speakup_register_var(struct var_t *var);
66extern void speakup_unregister_var(enum var_id_t var_id);
67extern struct st_var_header *get_var_header(enum var_id_t var_id);
68extern struct st_var_header *var_header_by_name(const char *name);
69extern struct punc_var_t *get_punc_var(enum var_id_t var_id);
70extern int set_num_var(int val, struct st_var_header *var, int how);
71extern int set_string_var(const char *page, struct st_var_header *var, int len);
72extern int set_mask_bits(const char *input, const int which, const int how);
73extern special_func special_handler;
74extern int handle_help(struct vc_data *vc, u_char type, u_char ch, u_short key);
75extern int synth_init(char *name);
76extern void synth_release(void);
77
78extern void do_flush(void);
79extern void speakup_start_ttys(void);
80extern void synth_buffer_add(char ch);
81extern void synth_buffer_clear(void);
82extern void speakup_clear_selection(void);
83extern int speakup_set_selection(struct tty_struct *tty);
84extern int speakup_paste_selection(struct tty_struct *tty);
85extern void speakup_register_devsynth(void);
86extern void speakup_unregister_devsynth(void);
87extern void synth_write(const char *buf, size_t count);
88extern int synth_supports_indexing(void);
89
90extern struct vc_data *spk_sel_cons;
91extern unsigned short xs, ys, xe, ye; /* our region points */
92
93extern wait_queue_head_t speakup_event;
94extern struct kobject *speakup_kobj;
95extern struct task_struct *speakup_task;
96extern const u_char key_defaults[];
97
98/* Protect speakup synthesizer list */
99extern struct mutex spk_mutex;
100extern struct st_spk_t *speakup_console[];
101extern struct spk_synth *synth;
102extern char pitch_buff[];
103extern u_char *our_keys[];
104extern short punc_masks[];
105extern char str_caps_start[], str_caps_stop[];
106extern const struct st_bits_data punc_info[];
107extern u_char key_buf[600];
108extern char *characters[];
109extern char *default_chars[];
110extern u_short spk_chartab[];
111extern int no_intr, say_ctrl, say_word_ctl, punc_level;
112extern int reading_punc, attrib_bleep, bleeps;
113extern int bleep_time, bell_pos;
114extern int spell_delay, key_echo;
115extern short punc_mask;
116extern short pitch_shift, synth_flags;
117extern int quiet_boot;
118extern char *synth_name;
119extern struct bleep unprocessed_sound;
120
121/* Prototypes from fakekey.c. */
122int speakup_add_virtual_keyboard(void);
123void speakup_remove_virtual_keyboard(void);
124void speakup_fake_down_arrow(void);
125bool speakup_fake_key_pressed(void);
126
127#endif