home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 2: Collection B / 17Bit_Collection_B.iso / files / 1462.dms / in.adf / ForProgrammers / reqreadme < prev    next >
Encoding:
Text File  |  1991-09-10  |  5.1 KB  |  150 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. =============================================================================
  15.  
  16.     Hello! This is the introduction to the all-new "req.library"!
  17.  
  18.     What is it?
  19.  
  20.     Req.library  adds  user-friendliness  to  the  Amiga's  user interface.
  21. While  all  that  intuition  offers the programmer is a boring, inflexible,
  22. slow,   painful   requester,   req.library   allows  fast  &  user-friendly
  23. requesters.   Notice  I said 'requesters', as they include a text requester
  24. (who's  size  is  automatically  figured  from  the body of text within), a
  25. colour  requester  (intelligent  enough  to  correctly  size  it's  palette
  26. according  to  the  depth  of the screen), string and int requesters, and a
  27. file  requester!!!  Not to mention numerous gadget creation routines, and a
  28. real-time scroll routine.
  29.  
  30.     The  nice thing about the gadget creation routines, is that they create
  31. fully  re-entrant  gadgets,  so  if you wish to run a routine over and over
  32. (for,  say, a multi-window program), you may feel free.  All you do is pass
  33. a  buffer  (the  sizes required are defined in reqbase.i and reqbase.h) and
  34. they will fill it in.
  35.  
  36.     (Please see req.doc for a more comprehensive explanation).
  37.  
  38.   Here is an overview of the files included in this ZOO archive:
  39.  
  40.     reqreadme             This file.
  41.     areqglue.o            Gluecode for aztec C. Link with your C code.
  42.     lreqglue.o            Gluecode for Lattice C. Link with your C code.
  43.     reqglue.asm           Sourcecode for the gluecode.
  44.     customizefile.asm     How to customize the file requester.
  45.     customizefile         The executable of the file requester customizer.
  46.     reqbase.h             The C include file. Put it in include/libraries
  47.     reqbase.i             The asm include file. Put it in include/libraries
  48.     showoffreq.c          The C source code for the req demo program.
  49.     showoffreq            The req demo executable.
  50.     req.library           The actual library. This goes in libs:
  51.     reqproto.h            The prototype file for Lattice C
  52.     req.doc               The instructions and calling conventions.
  53.     macros.i              Some handy macros.
  54.  
  55. -----------------------------------------------------------------------------
  56.     Included  is  a  demo  program called Showoffreq, which opens a screen
  57. with  text  gadgets in it, one per requester, and lets you try out many of
  58. the  requesters.   You  can look at the source code for examples of how to
  59. call  the  different  requesters.   If  you  wish  to  experiment with the
  60. requesters, this might be a good place to start.
  61.  
  62.  
  63. To compile showoffreq.c under Lattice, use:
  64.  
  65.                lc -Lcd+lib:lreqglue.o showoffreq
  66.  
  67.  
  68.  
  69.  
  70. To compile showoffreq.c under Aztec, use:
  71.  
  72.                cc showoffreq -oo/showoffreq.o
  73.  
  74.                ln -w +Q -o showoffreq o/showoffreq.o lib:areqglue.o -lc
  75.  
  76. -----------------------------------------------------------------------------
  77.  
  78.                                For Assembly
  79.  
  80. -----------------------------------------------------------------------------
  81.  
  82.     To  use  req.library  from  assembly  language  is quite easy.  So far,
  83. nothing's been said about it, so here is some info.
  84.  
  85.     First  of  all,  the library is EXACTLY like system libraries; you open
  86. it, call functions, and then close it.  We've included some macros that may
  87. make working with it a bit easier.  All you have to include to actually use
  88. the req.library is reqbase.i.  This contains all the function offsets.  You
  89. may  wish  to call the functions directly, or use a bit of gluecode to make
  90. things even easier.  If you wish to do it all yourself, then all you've got
  91. to  do  is  include  reqbase.i.   If you wish to use some pre-made function
  92. setup, then you have to link with the appropriate reqglue.o (lreqglue.o for
  93. Lattice, and areqglue.o for Aztec).
  94.  
  95.  
  96.  
  97.  
  98.  
  99. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  100.  
  101.   To link with lreqglue.o (for Lattice), an example linkfile might look like
  102. this:
  103.  
  104. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  105.  
  106. FROM
  107. lib:startup.o
  108. obj/file1.o
  109. obj/file2.o
  110. obj/data.o
  111. obj/menus.o
  112. lib:lreqglue.o
  113.  
  114. LIB
  115. lib:amiga.lib
  116.  
  117. TO
  118. file
  119.  
  120. nodebug smallcode smalldata
  121.  
  122. BATCH
  123.  
  124. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  125.  
  126. and to use this linkfile, just say:
  127.  
  128.     blink with <linkfile>
  129.  
  130.  
  131.  
  132.  
  133. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  134.  
  135. To link with areqglue.o (for Aztec), an example linkfile might look like this:
  136.  
  137.  
  138.  
  139. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  140.  
  141. ln -w +Q -o file1 o/file1.o lib:areqglue.o -lc
  142.  
  143. ---cut here---cut here---cut here---cut here---cut here---cut here---cut here
  144.  
  145. and to use this linkfile, just say:
  146.  
  147.     ln -f <linkfile>
  148.  
  149.  
  150.