X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;ds=sidebyside;f=include%2Fjoystick.h;h=26f339fe4f392227accca399d7f35ee8d424a881;hb=7f52a770d9c6a43dde67689032bb3a4848eb6b30;hp=327d2ed10800fe387935f16773e573c7b4bd8410;hpb=5453c45d8fdd983a836ffc54e3cdb994ac20b244;p=cc65

diff --git a/include/joystick.h b/include/joystick.h
index 327d2ed10..26f339fe4 100644
--- a/include/joystick.h
+++ b/include/joystick.h
@@ -1,11 +1,35 @@
-/*
- * joystick.h
- *
- * Ullrich von Bassewitz, 24.09.1998
- *
- * Read the joystick on systems that support it.
- *
- */
+/*****************************************************************************/
+/*                                                                           */
+/*                                joystick.h                                 */
+/*                                                                           */
+/*               Read the joystick on systems that support it                */
+/*                                                                           */
+/*                                                                           */
+/*                                                                           */
+/* (C) 1998-2011, Ullrich von Bassewitz                                      */
+/*                Roemerstrasse 52                                           */
+/*                D-70794 Filderstadt                                        */
+/* EMail:         uz@cc65.org                                                */
+/*                                                                           */
+/*                                                                           */
+/* This software is provided 'as-is', without any expressed or implied       */
+/* warranty.  In no event will the authors be held liable for any damages    */
+/* arising from the use of this software.                                    */
+/*                                                                           */
+/* Permission is granted to anyone to use this software for any purpose,     */
+/* including commercial applications, and to alter it and redistribute it    */
+/* freely, subject to the following restrictions:                            */
+/*                                                                           */
+/* 1. The origin of this software must not be misrepresented; you must not   */
+/*    claim that you wrote the original software. If you use this software   */
+/*    in a product, an acknowledgment in the product documentation would be  */
+/*    appreciated but is not required.                                       */
+/* 2. Altered source versions must be plainly marked as such, and must not   */
+/*    be misrepresented as being the original software.                      */
+/* 3. This notice may not be removed or altered from any source              */
+/*    distribution.                                                          */
+/*                                                                           */
+/*****************************************************************************/
 
 
 
@@ -14,37 +38,66 @@
 
 
 
-/* Define __JOYSTICK__ for systems that support a joystick */
-#ifdef __ATARI__
-#  define __JOYSTICK__
-#endif
-#ifdef __C64__
-#  define __JOYSTICK__
-#endif
-#ifdef __C128__
-#  define __JOYSTICK__
-#endif
-#ifdef __PLUS4__
-#  define __JOYSTICK__
-#endif
+/*****************************************************************************/
+/*                                  Definitions                              */
+/*****************************************************************************/
+
+
+
+/* Error codes */
+#define JOY_ERR_OK              0       /* No error */
+#define JOY_ERR_NO_DRIVER       1       /* No driver available */
+#define JOY_ERR_CANNOT_LOAD     2       /* Error loading driver */
+#define JOY_ERR_INV_DRIVER      3       /* Invalid driver */
+#define JOY_ERR_NO_DEVICE       4       /* Device (hardware) not found */
+
+/* Argument for the joy_read function */
+#define JOY_1                   0
+#define JOY_2                   1
+
+/* Macros that evaluate the return code of joy_read */
+#define JOY_UP(v)               ((v) & JOY_UP_MASK)
+#define JOY_DOWN(v)             ((v) & JOY_DOWN_MASK)
+#define JOY_LEFT(v)             ((v) & JOY_LEFT_MASK)
+#define JOY_RIGHT(v)            ((v) & JOY_RIGHT_MASK)
+#define JOY_BTN_1(v)            ((v) & JOY_BTN_1_MASK)      /* Universally available */
+#define JOY_BTN_2(v)            ((v) & JOY_BTN_2_MASK)      /* Second button if available */
+#define JOY_BTN_3(v)            ((v) & JOY_BTN_3_MASK)      /* Third button if available  */
+#define JOY_BTN_4(v)            ((v) & JOY_BTN_4_MASK)      /* Fourth button if available */
+
+/* The name of the standard joystick driver for a platform */
+extern const char joy_stddrv[];
+
+/* The address of the static standard joystick driver for a platform */
+extern const void joy_static_stddrv[];
+
+
+
+/*****************************************************************************/
+/*                                 Functions                                 */
+/*****************************************************************************/
+
+
+
+unsigned char __fastcall__ joy_load_driver (const char* driver);
+/* Load and install a joystick driver. Return an error code. */
 
-/* Argument for the function */
-#define JOY_1		0
-#define JOY_2		1
+unsigned char joy_unload (void);
+/* Uninstall, then unload the currently loaded driver. */
 
-/* Result codes of the function. The actual code is a bitwise or
- * of one or more of the following values.
- */
-#define JOY_UP       	0x01
-#define JOY_DOWN	0x02
-#define JOY_LEFT	0x04
-#define JOY_RIGHT	0x08
-#define JOY_FIRE	0x10
+unsigned char __fastcall__ joy_install (void* driver);
+/* Install an already loaded driver. Return an error code. */
 
+unsigned char joy_uninstall (void);
+/* Uninstall the currently loaded driver and return an error code.
+** Note: This call does not free allocated memory.
+*/
 
+unsigned char joy_count (void);
+/* Return the number of joysticks supported by the driver */
 
-unsigned __fastcall__ readjoy (unsigned char joy);
-/* Read the joystick. The argument is one of JOY_1/JOY2 */
+unsigned char __fastcall__ joy_read (unsigned char joystick);
+/* Read a particular joystick */