1 /*****************************************************************************/
9 /* (C) 2003-2004 Ullrich von Bassewitz */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
17 /* This software is provided 'as-is', without any expressed or implied */
18 /* warranty. In no event will the authors be held liable for any damages */
19 /* arising from the use of this software. */
21 /* Permission is granted to anyone to use this software for any purpose, */
22 /* including commercial applications, and to alter it and redistribute it */
23 /* freely, subject to the following restrictions: */
25 /* 1. The origin of this software must not be misrepresented; you must not */
26 /* claim that you wrote the original software. If you use this software */
27 /* in a product, an acknowledgment in the product documentation would be */
28 /* appreciated but is not required. */
29 /* 2. Altered source versions must be plainly marked as such, and must not */
30 /* be misrepresented as being the original software. */
31 /* 3. This notice may not be removed or altered from any source */
34 /*****************************************************************************/
43 /*****************************************************************************/
45 /*****************************************************************************/
50 #define MOUSE_ERR_OK 0 /* No error */
51 #define MOUSE_ERR_NO_DRIVER 1 /* No driver available */
52 #define MOUSE_ERR_CANNOT_LOAD 2 /* Error loading driver */
53 #define MOUSE_ERR_INV_DRIVER 3 /* Invalid driver */
54 #define MOUSE_ERR_NO_DEVICE 4 /* Mouse hardware not found */
55 #define MOUSE_ERR_INV_IOCTL 5 /* Invalid ioctl code */
57 /* Mouse button masks */
58 #define MOUSE_BTN_LEFT 0x10
59 #define MOUSE_BTN_RIGHT 0x01
61 /* Structure containing the mouse coordinates */
67 /* Structure containing information about the mouse */
69 struct mouse_pos pos; /* Mouse position */
70 unsigned char buttons; /* Mouse button mask */
73 /* Structure containing mouse callback functions. These functions are declared
74 * in C notation here, but they cannot be C functions (at least not easily),
75 * since they may be called from within an interrupt.
77 struct mouse_callbacks {
80 /* Hide the mouse cursor. */
83 /* Show the mouse cursor */
86 /* Move the mouse cursor to the new X coordinate. This function is called,
87 * even when the cursor is currently invisible.
91 /* Move the mouse cursor to the new Y coordinate. This function is called,
92 * even when the cursor is currently invisible.
96 /* The default mouse callbacks */
97 extern const struct mouse_callbacks mouse_def_callbacks;
101 /*****************************************************************************/
103 /*****************************************************************************/
107 unsigned char __fastcall__ mouse_load_driver (const struct mouse_callbacks* c,
109 /* Load and install a mouse driver, return an error code. */
111 unsigned char __fastcall__ mouse_unload (void);
112 /* Uninstall, then unload the currently loaded driver. */
114 unsigned char __fastcall__ mouse_install (const struct mouse_callbacks* c,
116 /* Install an already loaded driver. Returns an error code. */
118 unsigned char __fastcall__ mouse_uninstall (void);
119 /* Uninstall the currently loaded driver. Returns an error code. */
121 const char* __fastcall__ mouse_geterrormsg (unsigned char code);
122 /* Get an error message describing the error in code. */
124 void __fastcall__ mouse_hide (void);
125 /* Hide the mouse. The function manages a counter and may be called more than
126 * once. For each call to mouse_hide there must be a call to mouse_show to make
127 * the mouse visible again.
130 void __fastcall__ mouse_show (void);
131 /* Show the mouse. See mouse_hide for more information. */
133 void __fastcall__ mouse_box (int minx, int miny, int maxx, int maxy);
134 /* Set the bounding box for the mouse pointer movement. The mouse X and Y
135 * coordinates will never go outside the given box.
136 * NOTE: The function does *not* check if the mouse is currently inside the
137 * given margins. The proper way to use this function therefore is:
140 * - Set the bounding box
141 * - Place the mouse at the desired position
142 * - Show the mouse again.
144 * NOTE2: When setting the box to something that is larger than the actual
145 * screen, the positioning of the mouse cursor can fail. If such margins
146 * are really what you want, you have to use your own cursor routines.
149 void __fastcall__ mouse_move (int x, int y);
150 /* Set the mouse cursor to the given position. If a mouse cursor is defined
151 * and currently visible, the mouse cursor is also moved.
152 * NOTE: This function does not check if the given position is valid and
153 * inside the bounding box.
156 unsigned char __fastcall__ mouse_buttons (void);
157 /* Return a bit mask encoding the states of the mouse buttons. Use the
158 * MOUSE_BTN_XXX flags to decode a specific button.
161 void __fastcall__ mouse_pos (struct mouse_pos* pos);
162 /* Return the current mouse position */
164 void __fastcall__ mouse_info (struct mouse_info* info);
165 /* Return the state of the mouse buttons and the position of the mouse */
167 unsigned char __fastcall__ mouse_ioctl (unsigned char code, void* data);
168 /* Call the driver specific ioctl function. NON PORTABLE! Returns an error