home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 390.lha / ReqLibrary / reqreadme < prev    next >
Encoding:
Text File  |  1990-07-01  |  5.9 KB  |  165 lines
  1.  
  2.  
  3. =============================================================================
  4. Official release of version 1.22, Jan '90
  5.  
  6.  
  7. Req.library  is Copyright ©1989, 1990 by C.W.  Fox and Bruce Dawson.  It is
  8. freely  distributable.  No charge may be made for it's distribution, except
  9. for a nominal media fee.
  10.  
  11.      Feel free to distribute and use this library with your programs, along
  12. with a notice that the library is 'FreeWare'.
  13.  
  14.     The  requester  library  must  be  distributed  with  the file read.me,
  15. explaining  the  requester library to users.  We would appreciate it if the
  16. programmer   documentation  was  distributed  as  well,  but  this  is  not
  17. mandatory.   The  programmer documentation includes the descriptions of the
  18. library  and  its  functions (req.doc), and the three include files (req.h,
  19. reqbase.h and reqbase.i).
  20.  
  21. =============================================================================
  22.  
  23.     Hello! This is the introduction to the all-new "req.library"!
  24.  
  25.     What is it?
  26.  
  27.     Req.library  adds  user-friendliness  to  the  Amiga's  user interface.
  28. While  all  that  intuition  offers the programmer is a boring, inflexible,
  29. slow,   painful   requester,   req.library   allows  fast  &  user-friendly
  30. requesters.   Notice  I said 'requesters', as they include a text requester
  31. (who's  size  is  automatically  figured  from  the body of text within), a
  32. colour  requester  (intelligent  enough  to  correctly  size  it's  palette
  33. according  to  the  depth  of the screen), string and int requesters, and a
  34. file  requester!!!  Not to mention numerous gadget creation routines, and a
  35. real-time scroll routine.
  36.  
  37.     The  nice thing about the gadget creation routines, is that they create
  38. fully  re-entrant  gadgets,  so  if you wish to run a routine over and over
  39. (for,  say, a multi-window program), you may feel free.  All you do is pass
  40. a  buffer  (the  sizes required are defined in reqbase.i and reqbase.h) and
  41. they will fill it in.
  42.  
  43.     (Please see req.doc for a more comprehensive explanation).
  44.  
  45.   Here is an overview of the files included in this ZOO archive:
  46.  
  47.     reqreadme             This file.
  48.     read.me               The file which must be distributed with
  49.                           req.library
  50.     areqglue.o            Gluecode for aztec C. Link with your C code.
  51.     lreqglue.o            Gluecode for Lattice C. Link with your C code.
  52.     reqglue.asm           Sourcecode for the gluecode.
  53.     customizefile.asm     How to customize the file requester.
  54.     customizefile         The executable of the file requester customizer.
  55.     reqbase.h             The C include file. Put it in include/libraries
  56.     reqbase.i             The asm include file. Put it in include/libraries
  57.     showoffreq.c          The C source code for the req demo program.
  58.     showoffreq            The req demo executable.
  59.     req.library           The actual library. This goes in libs:
  60.     reqproto.h            The prototype file for Lattice C
  61.     req.doc               The instructions and calling conventions.
  62.     macros.i              Some handy macros.
  63.  
  64.     ath.zoo               Athello- Othello for the Amiga! Includes game executable
  65.                           and sourcecode for brain programs that interface with
  66.                           it (so you can be a brain-surgeon too! :) This game is
  67.                           also freely distributable, and someday I may release
  68.                           the source.
  69.  
  70. -----------------------------------------------------------------------------
  71.     Included  is  a  demo  program called Showoffreq, which opens a screen
  72. with  text  gadgets in it, one per requester, and lets you try out many of
  73. the  requesters.   You  can look at the source code for examples of how to
  74. call  the  different  requesters.   If  you  wish  to  experiment with the
  75. requesters, this might be a good place to start.
  76.  
  77.  
  78. To compile showoffreq.c under Lattice, use:
  79.  
  80.                lc -Lcd+lib:lreqglue.o showoffreq
  81.  
  82.  
  83.  
  84.  
  85. To compile showoffreq.c under Aztec, use:
  86.  
  87.                cc showoffreq -oo/showoffreq.o
  88.  
  89.                ln -w +Q -o showoffreq o/showoffreq.o lib:areqglue.o -lc
  90.  
  91. -----------------------------------------------------------------------------
  92.  
  93.                                For Assembly
  94.  
  95. -----------------------------------------------------------------------------
  96.  
  97.     To  use  req.library  from  assembly  language  is quite easy.  So far,
  98. nothing's been said about it, so here is some info.
  99.  
  100.     First  of  all,  the library is EXACTLY like system libraries; you open
  101. it, call functions, and then close it.  We've included some macros that may
  102. make working with it a bit easier.  All you have to include to actually use
  103. the req.library is reqbase.i.  This contains all the function offsets.  You
  104. may  wish  to call the functions directly, or use a bit of gluecode to make
  105. things even easier.  If you wish to do it all yourself, then all you've got
  106. to  do  is  include  reqbase.i.   If you wish to use some pre-made function
  107. setup, then you have to link with the appropriate reqglue.o (lreqglue.o for
  108. Lattice, and areqglue.o for Aztec).
  109.  
  110.  
  111.  
  112.  
  113.  
  114. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  115.  
  116.   To link with lreqglue.o (for Lattice), an example linkfile might look like
  117. this:
  118.  
  119. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  120.  
  121. FROM
  122. lib:startup.o
  123. obj/file1.o
  124. obj/file2.o
  125. obj/data.o
  126. obj/menus.o
  127. lib:lreqglue.o
  128.  
  129. LIB
  130. lib:amiga.lib
  131.  
  132. TO
  133. file
  134.  
  135. nodebug smallcode smalldata
  136.  
  137. BATCH
  138.  
  139. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  140.  
  141. and to use this linkfile, just say:
  142.  
  143.     blink with <linkfile>
  144.  
  145.  
  146.  
  147.  
  148. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  149.  
  150. To link with areqglue.o (for Aztec), an example linkfile might look like this:
  151.  
  152.  
  153.  
  154. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  155.  
  156. ln -w +Q -o file1 o/file1.o lib:areqglue.o -lc
  157.  
  158. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  159.  
  160. and to use this linkfile, just say:
  161.  
  162.     ln -f <linkfile>
  163.  
  164.  
  165.