1 |
/* Copyright (c) 1987 Regents of the University of California */ |
2 |
|
3 |
/* SCCSid "$SunId$ LBL" */ |
4 |
|
5 |
/* |
6 |
* driver.h - header file for interactive device drivers. |
7 |
* |
8 |
* 2/2/87 |
9 |
*/ |
10 |
|
11 |
struct driver { /* driver functions */ |
12 |
int (*close)(); /* close device */ |
13 |
int (*clear)(); /* clear device */ |
14 |
int (*paintr)(); /* paint rectangle */ |
15 |
int (*getcur)(); /* get cursor position */ |
16 |
int (*comout)(); /* command line output */ |
17 |
int (*comin)(); /* command line input */ |
18 |
int (*flush)(); /* flush output */ |
19 |
double pixaspect; /* pixel aspect ratio */ |
20 |
int xsiz, ysiz; /* device size */ |
21 |
int inpready; /* input ready on device */ |
22 |
}; |
23 |
/* stream interface */ |
24 |
extern struct driver *comm_init(), *slave_init(); |
25 |
/* magic numbers for verification */ |
26 |
#define COM_SENDM 0x6f37 |
27 |
#define COM_RECVM 0x51da |
28 |
/* stream commands */ |
29 |
#define COM_CLEAR 0 |
30 |
#define COM_PAINTR 1 |
31 |
#define COM_GETCUR 2 |
32 |
#define COM_COMOUT 3 |
33 |
#define COM_COMIN 4 |
34 |
#define COM_FLUSH 5 |
35 |
#define NREQUESTS 6 /* number of valid requests */ |
36 |
|
37 |
extern struct device { /* interactive device */ |
38 |
char *name; /* device name */ |
39 |
char *descrip; /* description */ |
40 |
struct driver *(*init)(); /* initialize device */ |
41 |
} devtable[]; /* supported devices */ |
42 |
|
43 |
extern char dev_default[]; /* default device name */ |
44 |
|
45 |
#define MB1 ('\n') /* mouse button 1 */ |
46 |
#define MB2 ('\r') /* mouse button 2 */ |
47 |
#define MB3 (' ') /* mouse button 3 */ |
48 |
#define ABORT ('C'-'@') /* abort key */ |
49 |
|
50 |
/* |
51 |
* struct driver * |
52 |
* dname_init(name, id) |
53 |
* char *name, *id; |
54 |
* { |
55 |
* Initialize device and return pointer to driver |
56 |
* functions. Returns NULL if an error occurred. |
57 |
* The name string identifies the driver, |
58 |
* and the id string identifies the client. |
59 |
* A device can be open by at most one client. |
60 |
* Be verbose in error reports; call eputs(). |
61 |
* If device has its own error output, set erract. |
62 |
* } |
63 |
* (*dev->close)() |
64 |
* { |
65 |
* Close the device. Reset error vectors. |
66 |
* } |
67 |
* (*dev->clear)(xres, yres) |
68 |
* int xres, yres; |
69 |
* { |
70 |
* Clear the device for xres by yres output. This call will |
71 |
* be made prior to any output. |
72 |
* } |
73 |
* (*dev->paintr)(col, xmin, ymin, xmax, ymax) |
74 |
* COLOR col; |
75 |
* int xmin, ymin, xmax, ymax; |
76 |
* { |
77 |
* Paint a half-open rectangle from (xmin,ymin) to (xmax,ymax) |
78 |
* with the color col. |
79 |
* } |
80 |
* (*dev->getcur)(xp, yp) |
81 |
* int *xp, *yp; |
82 |
* { |
83 |
* Get the cursor position entered by the user via mouse, |
84 |
* joystick, etc. Return the key hit by the user (usually |
85 |
* MB1 or MB2). Return ABORT to cancel. |
86 |
* Can be NULL for devices without this capability. |
87 |
* } |
88 |
* (*dev->comout)(out) |
89 |
* char *out; |
90 |
* { |
91 |
* Print the string out on the device command line. If the |
92 |
* string ends with '\n', the message is considered complete, |
93 |
* and the next call can erase it. |
94 |
* } |
95 |
* (*dev->comin)(in, prompt) |
96 |
* char *in, *prompt; |
97 |
* { |
98 |
* Print a prompt then read an edited input command line |
99 |
* assuming the in buffer is big enough. Unless prompt is NULL, |
100 |
* the driver may substitute its own rview command. This is |
101 |
* the most reliable way to repaint areas of the screen. |
102 |
* If the user enters an unrecognized control character, |
103 |
* terminate input and return the string with only that character. |
104 |
* The input string should not contain a newline. The routines in |
105 |
* editline.c may be useful. Comin must work in consort with comout. |
106 |
* } |
107 |
* (*dev->flush)() |
108 |
* { |
109 |
* Flush output to the display. This is guaranteed to be called |
110 |
* frequently enough to keep the display up to date. |
111 |
* This is an ideal time to check for device input. |
112 |
* This function can be NULL for devices that don't need it. |
113 |
* } |
114 |
* xsiz, ysiz |
115 |
* The maximum allowable x and y dimensions. If any |
116 |
* size is allowable, these should be set to MAXRES. |
117 |
* inpready |
118 |
* This variable should be made positive asynchronously |
119 |
* when characters are ready on the input. (Often easiest |
120 |
* to check for input during calls to paintr.) |
121 |
*/ |