src/rt/driver.h

/* Copyright (c) 1987 Regents of the University of California */

/* SCCSid "$SunId$ LBL" */

/*
 *  driver.h - header file for interactive device drivers.
 *
 *     2/2/87
 */

struct driver {                         /* driver functions */
        int  (*close)();                        /* close device */
        int  (*clear)();                        /* clear device */
        int  (*paintr)();                       /* paint rectangle */
        int  (*getcur)();                       /* get cursor position */
        int  (*comout)();                       /* command line output */
        int  (*comin)();                        /* command line input */
        int  (*flush)();                        /* flush output */
        double  pixaspect;                      /* pixel aspect ratio */
        int  xsiz, ysiz;                        /* device size */
        int  inpready;                          /* input ready on device */
};
                                        /* stream interface */
extern struct driver  *comm_init(), *slave_init();
                                        /* magic numbers for verification */
#define COM_SENDM               0x6f37
#define COM_RECVM               0x51da
                                        /* stream commands */
#define COM_CLEAR               0
#define COM_PAINTR              1
#define COM_GETCUR              2
#define COM_COMOUT              3
#define COM_COMIN               4
#define COM_FLUSH               5
#define NREQUESTS               6       /* number of valid requests */

extern struct device {                  /* interactive device */
        char  *name;                            /* device name */
        char  *descrip;                         /* description */
        struct driver  *(*init)();              /* initialize device */
}  devtable[];                          /* supported devices */

extern char  dev_default[];             /* default device name */

#define  MB1            ('\n')          /* mouse button 1 */
#define  MB2            ('\r')          /* mouse button 2 */
#define  MB3            (' ')           /* mouse button 3 */
#define  ABORT          ('C'-'@')       /* abort key */

/*
 *  struct driver *
 *  dname_init(name, id)
 *  char  *name, *id;
 *  {
 *      Initialize device and return pointer to driver
 *      functions.  Returns NULL if an error occurred.
 *      The name string identifies the driver,
 *      and the id string identifies the client.
 *      A device can be open by at most one client.
 *      Be verbose in error reports; call eputs().
 *      If device has its own error output, set erract.
 *  }
 *  (*dev->close)()
 *  {
 *      Close the device.  Reset error vectors.
 *  }
 *  (*dev->clear)(xres, yres)
 *  int  xres, yres;
 *  {
 *      Clear the device for xres by yres output.  This call will
 *      be made prior to any output.
 *  }
 *  (*dev->paintr)(col, xmin, ymin, xmax, ymax)
 *  COLOR  col;
 *  int  xmin, ymin, xmax, ymax;
 *  {
 *      Paint a half-open rectangle from (xmin,ymin) to (xmax,ymax)
 *      with the color col.
 *  }
 *  (*dev->getcur)(xp, yp)
 *  int  *xp, *yp;
 *  {
 *      Get the cursor position entered by the user via mouse,
 *      joystick, etc.  Return the key hit by the user (usually
 *      MB1 or MB2).  Return ABORT to cancel.
 *      Can be NULL for devices without this capability.
 *  }
 *  (*dev->comout)(out)
 *  char  *out;
 *  {
 *      Print the string out on the device command line.  If the
 *      string ends with '\n', the message is considered complete,
 *      and the next call can erase it.
 *  }
 *  (*dev->comin)(in, prompt)
 *  char  *in, *prompt;
 *  {
 *      Print a prompt then read an edited input command line
 *      assuming the in buffer is big enough.  Unless prompt is NULL,
 *      the driver may substitute its own rview command.  This is
 *      the most reliable way to repaint areas of the screen.
 *      If the user enters an unrecognized control character,
 *      terminate input and return the string with only that character.
 *      The input string should not contain a newline.  The routines in
 *      editline.c may be useful.  Comin must work in consort with comout.
 *  }
 *  (*dev->flush)()
 *  {
 *      Flush output to the display.  This is guaranteed to be called
 *      frequently enough to keep the display up to date.
 *      This is an ideal time to check for device input.
 *      This function can be NULL for devices that don't need it.
 *  }
 *  xsiz, ysiz
 *      The maximum allowable x and y dimensions.  If any
 *      size is allowable, these should be set to MAXRES.
 *  inpready
 *      This variable should be made positive asynchronously
 *      when characters are ready on the input.  (Often easiest
 *      to check for input during calls to paintr.)
 */
Revision:	2.3
Committed:	Tue Nov 11 20:03:00 1997 UTC (26 years, 5 months ago) by gregl
Content type:	text/plain
Branch:	MAIN
Changes since 2.2:	+2 -7 lines
Log Message:	created erract structure containing error messages and actions
#	User	Rev	Content
1	greg	1.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	greg	1.6	int (flush)(); / flush output */
19	greg	1.4	double pixaspect; /* pixel aspect ratio */
20	greg	1.1	int xsiz, ysiz; /* device size */
21			int inpready; /* input ready on device */
22			};
23	greg	2.2	/* stream interface */
24			extern struct driver comm_init(), slave_init();
25	greg	1.3	/* magic numbers for verification */
26			#define COM_SENDM 0x6f37
27			#define COM_RECVM 0x51da
28	greg	1.1	/* 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	greg	1.6	#define COM_FLUSH 5
35			#define NREQUESTS 6 /* number of valid requests */
36	greg	1.1
37	greg	1.4	extern struct device { /* interactive device */
38	greg	1.1	char name; / device name */
39			char descrip; / description */
40			struct driver (init)(); /* initialize device */
41	greg	1.4	} devtable[]; /* supported devices */
42	greg	1.1
43	greg	1.8	extern char dev_default[]; /* default device name */
44
45	greg	1.1	#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	greg	1.3	* dname_init(name, id)
53			* char name, id;
54	greg	1.1	* {
55			* Initialize device and return pointer to driver
56			* functions. Returns NULL if an error occurred.
57	greg	1.3	* The name string identifies the driver,
58			* and the id string identifies the client.
59	greg	1.1	* A device can be open by at most one client.
60	gregl	2.3	* Be verbose in error reports; call eputs().
61			* If device has its own error output, set erract.
62	greg	1.1	* }
63			* (*dev->close)()
64			* {
65	greg	1.2	* Close the device. Reset error vectors.
66	greg	1.1	* }
67			* (*dev->clear)(xres, yres)
68			* int xres, yres;
69			* {
70	greg	1.2	* Clear the device for xres by yres output. This call will
71	greg	1.1	* 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	greg	1.6	* with the color col.
79	greg	1.1	* }
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	greg	1.5	* (*dev->comin)(in, prompt)
96			* char in, prompt;
97	greg	1.1	* {
98	greg	1.5	* 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	greg	1.7	* If the user enters an unrecognized control character,
103	greg	1.5	* 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	greg	1.6	* }
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	greg	1.1	* }
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	greg	1.2	* 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	greg	1.1	*/