home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / e / amigae / src / tools / amigalib / readme next >
Encoding:
Text File  |  1995-04-08  |  3.5 KB  |  116 lines
  1. Short: amiga.lib as E modules
  2. Type: dev/e
  3. Author: m88jrh@ecs.ox.ac.uk (Jason R. Hulance)
  4. Uploader: m88jrh@ecs.ox.ac.uk (Jason R. Hulance)
  5.  
  6.  
  7. AmigaLib
  8. ========
  9.  
  10. Amiga E modules of many of the amiga.lib functions.
  11. These translations are Copyright (C) 1995, Jason R. Hulance.
  12. The original amiga.lib is Copyright (C) 1985-1992, Commodore-Amiga Inc.
  13.  
  14. You are free to use these modules in your programs, whether they are freeware
  15. or commercial.  However, if you want to distribute any of this archive you
  16. must include it all, unmodified, together with this file.
  17.  
  18.  
  19. Contents
  20. --------
  21.  
  22.   argarray.m:
  23.     PROC argArrayInit(str=0)
  24.     PROC argArrayDone()
  25.     PROC argInt(tt,entry,defaultval)
  26.     PROC argString(tt,entry,defaultstring)
  27.  
  28.   boopsi.m:
  29.     PROC callHookA(h,obj,msg)
  30.     PROC coerceMethodA(cl,obj,msg)
  31.     PROC doMethodA(obj,msg)
  32.     PROC doSuperMethodA(cl,obj,msg)
  33.     PROC setSuperAttrsA(cl,obj,msg)
  34.  
  35.   cx.m:
  36.     PROC freeIEvents(events)
  37.     PROC hotKey(description,port,id)
  38.     PROC invertString(str,km)
  39.     PROC invertStringRev(str,km)
  40.     PROC userFilter(tt,action_name,default_descr)
  41.  
  42.   interrupts.m:
  43.     PROC addTOF(i,p,a)
  44.     PROC remTOF(i)
  45.     PROC waitbeam(pos)
  46.  
  47.   io.m:
  48.     PROC beginIO(ioreq)
  49.     PROC createExtIO(port,ioSize)
  50.     PROC deleteExtIO(ioReq)
  51.     PROC createStdIO(port)
  52.     PROC deleteStdIO(ioReq)
  53.  
  54.   lists.m:
  55.     PROC newList(mlh)
  56.  
  57.   ports.m:
  58.     PROC createPort(name,pri)
  59.     PROC deletePort(port)
  60.  
  61.   random.m:
  62.     PROC fastRand(num)
  63.     PROC rangeRand(num)
  64.  
  65.   tasks.m:
  66.     PROC createTask(name,pri,initPC,stackSize)
  67.     PROC deleteTask(tc)
  68.  
  69.   time.m:
  70.     PROC timeDelay(unit,seconds,micros)
  71.  
  72. There are also a number of test programs, which show how to use many of
  73. the functions.
  74.  
  75.  
  76. Documentation
  77. -------------
  78.  
  79. The documentation on amiga.lib serves as adequate documentation of these
  80. functions, with the following observations:
  81.  
  82.   argarray.m:
  83.     o   argArrayInit() takes only an optional string.  This can be a string
  84.       of arguments like the E global "arg" (which is the default).  This
  85.       string is only used if "wbmessage" is NIL, and is *altered* if used
  86.       (i.e., the result is a manipulation of the string, and so by default
  87.       "arg" will be affected).  If you don't like this, pass this function
  88.       a copy of your arguments string (and be careful not to free it until
  89.       you've finished with the result of this function).
  90.  
  91.   boopsi.m:
  92.     o   callHookA() is like CallHookPkt() from utility.library except it does
  93.       not require the utility.library to be open!
  94.     o   setSuperAttrsA() replaces the stack-based (varargs) function
  95.       SetSuperAttrs().  setSuperAttrsA() takes a pointer to a Boopsi message
  96.       as its third argument (so you would usually use a typed list).
  97.  
  98.   cx.m:
  99.     o   invertStringRev() is like InvertString() except it does not require
  100.       you to reverse the string to be inverted.  See testcx.e.
  101.     o   userFilter(tt, action_name, default_descr) creates a CxFilter object
  102.       with a description string taken from the tooltype defined by
  103.       "action_name" in the tooltypes array "tt" (which is usually the result
  104.       of a call to argArrayInit()).  If the tooltype is not found then the
  105.       "default_descr" is used instead.
  106.  
  107.   interrupts.m:
  108.     o  waitbeam(pos) waits until the VBeam position is at least "pos".
  109.  
  110.   tasks.m:
  111.     o   createTask() can has slightly enhanced error checking if you are
  112.       running V37+.
  113.  
  114. The main reason for the creation of these modules was my translations of the
  115. RKRM examples.  These should provide even more useful documentation.
  116.