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 */
};

extern int  stderr_v();                 /* error vectors */
extern int  (*wrnvec)(), (*errvec)(), (*cmdvec)();

extern struct driver  *comm_init();     /* stream interface */
                                        /* 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 */

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