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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  mouse.h                                  */
   4 /*                                                                           */
   5 /*                                 Mouse API                                 */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1999-2000 Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@musoftware.de                                            */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef _MOUSE_H
  37 #define _MOUSE_H
  38
  39
  40
  41 /* Define __MOUSE__ for systems that support a mouse */
  42 #if defined(__ATARI__) || defined(__C64__) || defined(__C128__)
  43 #  define __MOUSE__
  44 #endif
  45
  46
  47
  48 /*****************************************************************************/
  49 /*                                Definitions                                */
  50 /*****************************************************************************/
  51
  52
  53
  54 /* The different mouse types */
  55 #define MOUSE_TRAKBALL          0
  56 #define MOUSE_ST                1
  57 #define MOUSE_AMIGA             2
  58 #define MOUSE_C64               3      /* 1351 mouse */
  59
  60 /* Mouse button masks */
  61 #define MOUSE_BTN_LEFT       0x10
  62
  63
  64
  65 /*****************************************************************************/
  66 /*                                 Functions                                 */
  67 /*****************************************************************************/
  68
  69
  70
  71 unsigned char __fastcall__ mouse_init (unsigned char port,
  72                                        unsigned char sprite,
  73                                        unsigned char type);
  74 /* Setup the mouse interrupt handler. If the sprite value is != zero, the
  75  * mouse routines will manage the sprite with this number. That means, it
  76  * is moved if the mouse is moved (provided that the mouse cursor is visible),
  77  * and switched on and off in the show and hide functions.
  78  * The port parameter gives the joystick port used for the mouse and is only
  79  * needed to read the mouse button state.
  80  * The type parameter is needed on some systems to determine the type of
  81  * the mouse connected to the given port.
  82  * After calling this function, the mouse is invisble, the cursor is placed
  83  * at 0/0 (upper left corner), and the bounding box is reset to cover the
  84  * whole screen. Call mouse_show once to make the mouse cursor visible.
  85  * The function will return zero if a mouse was not found and a non zero
  86  * value if the mouse was found and initialized (or if there is no way to
  87  * detect a mouse reliably).
  88  */
  89
  90 void mouse_done (void);
  91 /* Disable the mouse, remove the interrupt handler. This function MUST be
  92  * called before terminating the program, otherwise odd things may happen.
  93  * If in doubt, install an exit handler (using atexit) that calls this
  94  * function.
  95  */
  96
  97 void mouse_hide (void);
  98 /* Hide the mouse. This function doesn't do anything visible if no sprite is
  99  * used. The function manages a counter and may be called more than once.
 100  * For each call to mouse_hide there must be a call to mouse_show to make
 101  * the mouse visible again.
 102  */
 103
 104 void mouse_show (void);
 105 /* Show the mouse. This function doesn't do anything visible if no sprite is
 106  * used. See mouse_hide for more information.
 107  */
 108
 109 void __fastcall__ mouse_box (int minx, int miny, int maxx, int maxy);
 110 /* Set the bounding box for the mouse pointer movement. The mouse X and Y
 111  * coordinates will never go outside the given box.
 112  * NOTE: The function does *not* check if the mouse is currently inside the
 113  * given margins. The proper way to use this function therefore is:
 114  *
 115  *      - Hide the mouse
 116  *      - Set the bounding box
 117  *      - Place the mouse at the desired position
 118  *      - Show the mouse again.
 119  *
 120  * NOTE2: When setting the box to something that is larger than the actual
 121  * screen, the positioning of the mouse cursor will fail. If such margins
 122  * are really what you want, you have to use your own cursor routines.
 123  */
 124
 125 void __fastcall__ mouse_move (int x, int y);
 126 /* Set the mouse cursor to the given position. If a mouse cursor is defined
 127  * and currently visible, the mouse cursor is also moved.
 128  * NOTE: This function does not check if the given position is valid and
 129  * inside the bounding box.
 130  */
 131
 132 unsigned char mouse_buttons (void);
 133 /* Return a bit mask encoding the states of the mouse buttons. Use the
 134  * MOUSE_BTN_XXX flags to decode a specific button.
 135  */
 136
 137 void mouse_info (void);
 138 /* Hmmm...
 139  */
 140
 141
 142 /* End of mouse.h */
 143 #endif
 144