git.sur5r.net Git - cc65/blob - include/mouse.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  mouse.h                                  */
   4 /*                                                                           */
   5 /*                                 Mouse API                                 */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2003-2009, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                D-70794 Filderstadt                                        */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /*                                                                           */
  16 /*                                                                           */
  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.                                    */
  20 /*                                                                           */
  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:                            */
  24 /*                                                                           */
  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              */
  32 /*    distribution.                                                          */
  33 /*                                                                           */
  34 /*****************************************************************************/
  35
  36
  37
  38 #ifndef _MOUSE_H
  39 #define _MOUSE_H
  40
  41
  42
  43 /*****************************************************************************/
  44 /*                                Definitions                                */
  45 /*****************************************************************************/
  46
  47
  48
  49 /* Error codes */
  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 */
  56
  57 /* Mouse button masks */
  58 #define MOUSE_BTN_LEFT       0x10
  59 #define MOUSE_BTN_RIGHT      0x01
  60
  61 /* Structure containing the mouse coordinates */
  62 struct mouse_pos {
  63     int x;
  64     int y;
  65 };
  66
  67 /* Structure containing information about the mouse */
  68 struct mouse_info {
  69     struct mouse_pos    pos;           /* Mouse position */
  70     unsigned char       buttons;       /* Mouse button mask */
  71 };
  72
  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.
  76  */
  77 struct mouse_callbacks {
  78
  79     void (*hide) (void);
  80     /* Hide the mouse cursor. */
  81
  82     void (*show) (void);
  83     /* Show the mouse cursor */
  84
  85     void __fastcall__ (*movex) (int x);
  86     /* Move the mouse cursor to the new X coordinate. This function is called,
  87      * even when the cursor is currently invisible.
  88      */
  89
  90     void __fastcall__ (*movey) (int y);
  91     /* Move the mouse cursor to the new Y coordinate. This function is called,
  92      * even when the cursor is currently invisible.
  93      */
  94 };
  95
  96 /* The default mouse callbacks */
  97 extern const struct mouse_callbacks mouse_def_callbacks;
  98
  99 /* The name of the standard mouse driver for a platform */
 100 extern const char mouse_stddrv[];
 101
 102
 103
 104 /*****************************************************************************/
 105 /*                                 Functions                                 */
 106 /*****************************************************************************/
 107
 108
 109
 110 unsigned char __fastcall__ mouse_load_driver (const struct mouse_callbacks* c,
 111                                               const char* driver);
 112 /* Load and install a mouse driver, return an error code. */
 113
 114 unsigned char __fastcall__ mouse_unload (void);
 115 /* Uninstall, then unload the currently loaded driver. */
 116
 117 unsigned char __fastcall__ mouse_install (const struct mouse_callbacks* c,
 118                                           void* driver);
 119 /* Install an already loaded driver. Returns an error code. */
 120
 121 unsigned char __fastcall__ mouse_uninstall (void);
 122 /* Uninstall the currently loaded driver. Returns an error code. */
 123
 124 const char* __fastcall__ mouse_geterrormsg (unsigned char code);
 125 /* Get an error message describing the error in code. */
 126
 127 void __fastcall__ mouse_hide (void);
 128 /* Hide the mouse. The function manages a counter and may be called more than
 129  * once. For each call to mouse_hide there must be a call to mouse_show to make
 130  * the mouse visible again.
 131  */
 132
 133 void __fastcall__ mouse_show (void);
 134 /* Show the mouse. See mouse_hide for more information. */
 135
 136 void __fastcall__ mouse_box (int minx, int miny, int maxx, int maxy);
 137 /* Set the bounding box for the mouse pointer movement. The mouse X and Y
 138  * coordinates will never go outside the given box.
 139  * NOTE: The function does *not* check if the mouse is currently inside the
 140  * given margins. The proper way to use this function therefore is:
 141  *
 142  *      - Hide the mouse
 143  *      - Set the bounding box
 144  *      - Place the mouse at the desired position
 145  *      - Show the mouse again.
 146  *
 147  * NOTE2: When setting the box to something that is larger than the actual
 148  * screen, the positioning of the mouse cursor can fail. If such margins
 149  * are really what you want, you have to use your own cursor routines.
 150  */
 151
 152 void __fastcall__ mouse_move (int x, int y);
 153 /* Set the mouse cursor to the given position. If a mouse cursor is defined
 154  * and currently visible, the mouse cursor is also moved.
 155  * NOTE: This function does not check if the given position is valid and
 156  * inside the bounding box.
 157  */
 158
 159 unsigned char __fastcall__ mouse_buttons (void);
 160 /* Return a bit mask encoding the states of the mouse buttons. Use the
 161  * MOUSE_BTN_XXX flags to decode a specific button.
 162  */
 163
 164 void __fastcall__ mouse_pos (struct mouse_pos* pos);
 165 /* Return the current mouse position */
 166
 167 void __fastcall__ mouse_info (struct mouse_info* info);
 168 /* Return the state of the mouse buttons and the position of the mouse */
 169
 170 unsigned char __fastcall__ mouse_ioctl (unsigned char code, void* data);
 171 /* Call the driver specific ioctl function. NON PORTABLE! Returns an error
 172  * code.
 173  */
 174
 175
 176
 177 /* End of mouse.h */
 178 #endif
 179
 180
 181