home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / e / amigae / src / tools / cookrawkey / cookrawkey.doc next >
Text File  |  1994-10-04  |  2KB  |  37 lines
  1. cookRawkey.m - Module of functions designed to process a raw input event,
  2. translating it into its corresponding Vanilla keycode as defined by the
  3. current keymap.  Uses the console.device.
  4.  
  5.     warmupRawkeyCooker()
  6.  
  7. Initializes the module to enable processing of raw input events.  Should be
  8. called once prior to invoking any of the other functions in the module.
  9. May raise any of the following exceptions:  "MEM", ER_CREATEPORT,
  10. ER_CREATEIO, ER_OPENDEVICE, ER_ASKKEYMAP.
  11.  
  12.     ascii_keycode:=cookRawkey(message.code, message.qualifier, message.iaddress)
  13.  
  14. ascii_keycode gets the Vanilla ASCII value if one exists, else 0.  message is
  15. here a PTR TO intuimessage, which contains the address of an IDCMP_RAWKEY
  16. message.  Vanilla ASCII codes may be manufactured by passing in a valid raw
  17. code and a valid raw qualifier, and a valid PTR TO LONG which points to
  18. deadkey prefixes (or zeroized memory if deadkeys aren't desired, i.e.,
  19. [0]:LONG) for the iaddress.
  20.  
  21.     shutdownRawkeyCooker()
  22.  
  23. Cleans up the module.  Should be called once when the module's functions are
  24. no longer needed.  Raises no exceptions.  Performs complete sanity checks,
  25. and may therefore be safely called multiple times.
  26.  
  27.  
  28. NOTES:
  29.  
  30. It is entirely possible that this module will successfully translate any
  31. kind of raw input event properly, although this has not been tested. :-)
  32.  
  33. You may repeatedly warmup and shutdown the rawkey cooker module, but you must
  34. be careful to call shutdownRawkeyCooker() before calling warmupRawkeyCooker()
  35. a subsequent time.  Otherwise, the allocated resources will be irreclaimable
  36. and your system will degrade.
  37.