Working

[cc65] / include / mouse.h

diff --git a/include/mouse.h b/include/mouse.h
index cd51683550cb24a15d0c313dda9c53880b0b42e3..1f36675c46c62014d70f88d5f868eb93ed20d988 100644 (file)
--- a/include/mouse.h
+++ b/include/mouse.h
@@ -6,7 +6,7 @@
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 1999-2000 Ullrich von Bassewitz                                       */
+/* (C) 1999-2001 Ullrich von Bassewitz                                       */
 /*               Wacholderweg 14                                             */
 /*               D-70597 Stuttgart                                           */
 /* EMail:        uz@musoftware.de                                            */
@@ -39,12 +39,41 @@
 
 
 /* Define __MOUSE__ for systems that support a mouse */
-#ifdef __C64__
+#if defined(__ATARI__) || defined(__C64__) || defined(__C128__) || defined(__CBM510__) || defined(__GEOS__)
 #  define __MOUSE__
-#endif
-#ifdef __C128__
-#  define __MOUSE__
-#endif
+#else
+#  error The target system does not support a mouse!
+# endif
+
+
+
+/*****************************************************************************/
+/*                               Definitions                                */
+/*****************************************************************************/
+
+
+
+/* The different mouse types */
+#define MOUSE_TRAKBALL                 0
+#define MOUSE_ST               1
+#define MOUSE_AMIGA            2
+#define MOUSE_CBM1351                  3      /* 1351 mouse */
+
+/* Mouse button masks */
+#define MOUSE_BTN_LEFT      0x10
+#define MOUSE_BTN_RIGHT      0x01
+
+/* Structure containing the mouse coordinates */
+struct mouse_pos {
+    int x;
+    int y;
+};
+
+/* Structure containing information about the mouse */
+struct mouse_info {
+    struct mouse_pos    pos;           /* Mouse position */
+    unsigned char       buttons;       /* Mouse button mask */
+};
 
 
 
@@ -54,35 +83,42 @@
 
 
 
-void __fastcall__ mouse_init (unsigned char port, unsigned char sprite, unsigned char type);
-/* Setup the mouse interrupt handler. If the sprite value is != zero, the
- * mouse routines will manage the sprite with this number. That means, it
- * is moved if the mouse is moved (provided that the mouse cursor is visible),
- * and switched on and off in the show and hide functions.
- * The port parameter gives the joystick port used for the mouse and is only
- * needed to read the mouse button state.
+unsigned char __fastcall__ mouse_init (unsigned char type);
+/* Setup the mouse interrupt handler. The mouse routines will use a predefined
+ * system resource for the mouse port and mouse cursor:
+ *     C64:      Port #0, Sprite #0
+ *     C128:     Port #0, Sprite #0
+ *     GEOS:     System defined port, Sprite #0
+ *     Atari:    Port #0, PM #0
+ * However, the mouse routines will not initialize this cursor or set a
+ * specific shape - this is platform dependent and up to the user program.
+ * The mouse cursor is moved if the mouse is moved (provided that the mouse
+ * cursor is visible), and switched on and off in the show and hide functions.
  * The type parameter is needed on some systems to determine the type of
- * the mouse connected to the given port.
+ * the mouse connected to the given port, on others it is ignored.
  * After calling this function, the mouse is invisble, the cursor is placed
  * at 0/0 (upper left corner), and the bounding box is reset to cover the
  * whole screen. Call mouse_show once to make the mouse cursor visible.
+ * The function will return zero if a mouse was not found and a non zero
+ * value if the mouse was found and initialized (or if there is no way to
+ * detect a mouse reliably).
  */
 
-void mouse_done (void);
+void __fastcall__ mouse_done (void);
 /* Disable the mouse, remove the interrupt handler. This function MUST be
  * called before terminating the program, otherwise odd things may happen.
  * If in doubt, install an exit handler (using atexit) that calls this
  * function.
  */
 
-void mouse_hide (void);
+void __fastcall__ mouse_hide (void);
 /* Hide the mouse. This function doesn't do anything visible if no sprite is
  * used. The function manages a counter and may be called more than once.
  * For each call to mouse_hide there must be a call to mouse_show to make
  * the mouse visible again.
  */
 
-void mouse_show (void);
+void __fastcall__ mouse_show (void);
 /* Show the mouse. This function doesn't do anything visible if no sprite is
  * used. See mouse_hide for more information.
  */
@@ -110,10 +146,17 @@ void __fastcall__ mouse_move (int x, int y);
  * inside the bounding box.
  */
 
-void mouse_info (void);
-/* Hmmm...
+unsigned char __fastcall__ mouse_buttons (void);
+/* Return a bit mask encoding the states of the mouse buttons. Use the
+ * MOUSE_BTN_XXX flags to decode a specific button.
  */
 
+void __fastcall__ mouse_pos (struct mouse_pos* pos);
+/* Return the current mouse position */
+
+void __fastcall__ mouse_info (struct mouse_info* info);
+/* Return the state of the mouse buttons and the position of the mouse */
+
 
 
 /* End of mouse.h */