home *** CD-ROM | disk | FTP | other *** search
/ Megahits 4 / MegaHits_Vol.4.iso / mui / dev / gui / muibuilder / mb / asm / sslib.readme < prev   
Encoding:
Text File  |  1994-10-24  |  5.4 KB  |  138 lines
  1.  
  2.  
  3.                 Special Support Library
  4.  
  5.                   Version 3.0
  6.  
  7.          (c) 1993 Martin Mares, MJSoft System Software
  8.  
  9. ================================================================================
  10.  
  11.  
  12. Preface
  13. =======
  14.  
  15.    The Special Support Library, accompanying utilities and their documentation
  16. are Copyright (c) Martin Mares, MJSoft System Software, Prague, Czech Republic.
  17.  
  18.    This  archive  can  be  freely redistributed, as long as all of its files are
  19. included   in   their   original   form  without  any  additions,  deletions  or
  20. modifications,  and  no more than a nominal fee is charged for its distribution.
  21. All  copyright notices in the programs and accompanying documentation files must
  22. remain  on  their  places.  Also '.displayme' and other similar files may not be
  23. added.  This is generally known as FREEWARE.
  24.  
  25.    The only one exception to the previously mentioned distribution rights is the
  26. library  code  itself  (ss.library),  which may be distributed separately in any
  27. kind  of software package (including commercial one), but the documentation must
  28. inform the user that SS.library has been developed by MJSoft System Software and
  29. that there is no warranty on it.
  30.  
  31.    Special  permission is given to Fred Fish to distribute this program on his
  32. "Fish Disks".
  33.  
  34.    This  software  is  provided  "AS  IS"  without  warranty of any kind, either
  35. expressed  or  implied.   The author is not responsible for any damage caused by
  36. it.
  37.  
  38.  
  39. About SS Library:
  40. =================
  41.  
  42.    The Special Support Library is a small library written to simplify
  43. development of small assembly programs. These programs usually contain
  44. small routine, which is preceeded by some sort of startup code for argument
  45. parsing, WB startup, opening of required libraries and similar actions.
  46. With SSLib, you include only a significantly less piece of code for loading
  47. of the library (this startup is usually generated by the "start" macro in
  48. ssmac.h).
  49.  
  50.    But SSLib is very useful not only for small programs, but also for large
  51. projects, because it offers a very powerful object tracking mechanism based
  52. on ideas of the arp.library.
  53.  
  54.    There are listed some features of SSLib:
  55.  
  56.     (a) The library currently doesn't contain any support of calling from
  57.     high-level languages (C, Pascal, Modula, Oberon, False, ADA, RTL/2,
  58.     PL/M, AMOS, Forth, AmigaBasic, GFABasic, REXX, PostScript, TeX,
  59.     Metafont, DBase 6.0, DML, ISM, Logo, GCL, Prolog, SmallTalk,
  60.     BCPL, Lisp and ...).
  61.  
  62.     (b) SSLib requires kickstart V37 or higher, but you may call OpenLibrary
  63.     with older kickstarts. In this case, SSLib will display an alert
  64.     informing the user about this fact and will refuse to open.
  65.  
  66.     (c) SSLib uses A5 to store base of its variables. But it doesn't steal
  67.     you an address register, because you can simply use this register
  68.     to index your own BSS variables (special variables defined by SS
  69.     (see SS.i) are stored BELOW A5, your own ABOVE A5. A5 itself
  70.     points to pointer to SSBase, therefore you can obtain this value
  71.     needed for calling of SSLib with minimal overhead).
  72.  
  73.     (d) SSLib installs its own exception handler to all tasks using StartupInit.
  74.     This exception handler displays contents of all the registers and
  75.     allows the user to select if he wants to Suspend the program, Reboot
  76.     the system or to try to Abort the program (it will automatically
  77.     free all tracked resources, but it could result in a crash if there's
  78.     something rotten in the system).
  79.  
  80.     (e) SSLib performs parsing of arguments (from both CLI and Workbench).
  81.  
  82.     (f) ssmac.h contains a powerful set of universal and special macros which
  83.     simplify writing of programs. (But these macros might have problems
  84.     with some compilers. If you fix some of these problems, send me
  85.     updated version and I will include it in the next release of SSLib.)
  86.  
  87.     (g) SSLib offers fast memory pool management mechanism allowing quick
  88.     manipulation with small chunks of memory. The tracking functions
  89.     use their own memory pool to increase execution speed.
  90.  
  91.     (h) Tasks can define their own low-memory handling routine, which is called
  92.         whenever some memory allocation fails (this feature is supported by
  93.         exec V39+, but this works under V37+; these routines are called by
  94.         library expunge code, therefore the library itself must use alternate
  95.         OpenCount).
  96.  
  97.     (i) Example programs are not included in this archive. They are distributed
  98.     separately.
  99.  
  100.    For other information, see the rest of this file, SSLib.doc, SS.i, ssmac.doc
  101. and all text files in this archive.
  102.  
  103. Future plans:
  104. =============
  105.  
  106.    - Some sort of string parsing mechanism.
  107.  
  108.    - Callability from high-level languages.
  109.  
  110.    - Some support of graphics. (It won't be included in SS.library. I plan to
  111. write new library (called SSG.library) as an extension of SS). These functions
  112. will probably support some sort of adaptive design and automatic handling
  113. of IDCMP messages.
  114.  
  115.    - Many other things including better macro set.
  116.  
  117. Files in this archive:
  118. ======================
  119.  
  120. History        list of modifications
  121. SSLib.doc    library doc
  122. SSMac.h        standard set of support macros
  123. SSMac.doc    description of the macros
  124. SS.i        library include file
  125. SS.library    the library itself
  126. SSDiag        small diagnostic utility
  127. SSDiag.doc    description of SSDiag
  128. TExtract    text hunk extractor
  129. TExtract.doc    description of TExtract
  130.  
  131. Final words:
  132. ============
  133.  
  134.   Thanks to PCSoft and Short Software for many good suggestions and bug reports.
  135.  
  136.   Send all comments and bug reports to mjsoft@k332.feld.cvut.cz.
  137.  
  138.