Changed the mouse API: mouse_box is gone, there are now mouse_getbox and

[cc65] / include / mouse.h

diff --git a/include/mouse.h b/include/mouse.h
index a27cdf85762211798a752e16cadca3f193dd7bae..3d62261851546377e787f6b12343b42719fdf5b6 100644 (file)
--- a/include/mouse.h
+++ b/include/mouse.h
@@ -6,10 +6,10 @@
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 2003      Ullrich von Bassewitz                                       */
-/*               Römerstraße 52                                              */
-/*               D-70794 Filderstadt                                         */
-/* EMail:        uz@cc65.org                                                 */
+/* (C) 2003-2009, Ullrich von Bassewitz                                      */
+/*                Roemerstrasse 52                                           */
+/*                D-70794 Filderstadt                                        */
+/* EMail:         uz@cc65.org                                                */
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
@@ -60,8 +60,8 @@
 
 /* Structure containing the mouse coordinates */
 struct mouse_pos {
-    int x;
-    int y;
+    int                x;
+    int                y;
 };
 
 /* Structure containing information about the mouse */
@@ -70,6 +70,14 @@ struct mouse_info {
     unsigned char       buttons;       /* Mouse button mask */
 };
 
+/* Structure used for getbox/setbox */
+struct mouse_box {
+    int                minx;
+    int                miny;
+    int                maxx;
+    int                maxy;
+};
+
 /* Structure containing mouse callback functions. These functions are declared
  * in C notation here, but they cannot be C functions (at least not easily),
  * since they may be called from within an interrupt.
@@ -82,12 +90,23 @@ struct mouse_callbacks {
     void (*show) (void);
     /* Show the mouse cursor */
 
-    void (*move) (void);
-    /* Move the mouse cursor. This function is called, even when the cursor
-     * is currently invisible.
+    void __fastcall__ (*movex) (int x);
+    /* Move the mouse cursor to the new X coordinate. This function is called,
+     * even when the cursor is currently invisible.
+     */
+
+    void __fastcall__ (*movey) (int y);
+    /* Move the mouse cursor to the new Y coordinate. This function is called,
+     * even when the cursor is currently invisible.
      */
 };
 
+/* The default mouse callbacks */
+extern const struct mouse_callbacks mouse_def_callbacks;
+
+/* The name of the standard mouse driver for a platform */
+extern const char mouse_stddrv[];
+
 
 
 /*****************************************************************************/
@@ -96,21 +115,23 @@ struct mouse_callbacks {
 
 
 
-unsigned char __fastcall__ mouse_set_callbacks (const struct mouse_callbacks* c);
-/* Sets the callbacks to be used by the driver. */
-
-unsigned char __fastcall__ mouse_load_driver (const char* driver);
+unsigned char __fastcall__ mouse_load_driver (const struct mouse_callbacks* c,
+                                              const char* driver);
 /* Load and install a mouse driver, return an error code. */
 
 unsigned char __fastcall__ mouse_unload (void);
 /* Uninstall, then unload the currently loaded driver. */
 
-unsigned char __fastcall__ mouse_install (void* driver);
+unsigned char __fastcall__ mouse_install (const struct mouse_callbacks* c,
+                                          void* driver);
 /* Install an already loaded driver. Returns an error code. */
 
 unsigned char __fastcall__ mouse_uninstall (void);
 /* Uninstall the currently loaded driver. Returns an error code. */
 
+const char* __fastcall__ mouse_geterrormsg (unsigned char code);
+/* Get an error message describing the error in code. */
+
 void __fastcall__ mouse_hide (void);
 /* Hide the mouse. 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
@@ -120,7 +141,7 @@ void __fastcall__ mouse_hide (void);
 void __fastcall__ mouse_show (void);
 /* Show the mouse. See mouse_hide for more information. */
 
-void __fastcall__ mouse_box (int minx, int miny, int maxx, int maxy);
+void __fastcall__ mouse_setbox (const struct mouse_box* box);
 /* Set the bounding box for the mouse pointer movement. The mouse X and Y
  * coordinates will never go outside the given box.
  * NOTE: The function does *not* check if the mouse is currently inside the
@@ -132,10 +153,13 @@ void __fastcall__ mouse_box (int minx, int miny, int maxx, int maxy);
  *     - Show the mouse again.
  *
  * NOTE2: When setting the box to something that is larger than the actual
- * screen, the positioning of the mouse cursor will fail. If such margins
+ * screen, the positioning of the mouse cursor can fail. If such margins
  * are really what you want, you have to use your own cursor routines.
  */
 
+void __fastcall__ mouse_getbox (struct mouse_box* box);
+/* Get the current bounding box for the mouse pointer movement. */
+
 void __fastcall__ mouse_move (int x, int y);
 /* Set the mouse cursor to the given position. If a mouse cursor is defined
  * and currently visible, the mouse cursor is also moved.
@@ -155,8 +179,8 @@ void __fastcall__ mouse_info (struct mouse_info* info);
 /* Return the state of the mouse buttons and the position of the mouse */
 
 unsigned char __fastcall__ mouse_ioctl (unsigned char code, void* data);
-/* Call the driver specific ioctl function. NON PORTABLE! Returns an error 
- * code. 
+/* Call the driver specific ioctl function. NON PORTABLE! Returns an error
+ * code.
  */