home *** CD-ROM | disk | FTP | other *** search
/ fxPAINT 1.0 / fxPAINT 1.0.iso / developers / plugins / exampleplugin / clibreadmes / clib37x.readme < prev    next >
Encoding:
Text File  |  1997-12-29  |  13.2 KB  |  289 lines
  1. Short: example.library in 100% C (SAS/Storm/Maxon/GCC/VBCC/...)
  2. Type: dev/c
  3. Uploader: Andreas_Kleinert@t-online.de
  4. Author: (various, see below)
  5.  
  6.   example.library V37.22 (29.12.97)
  7.  
  8.   An Amiga shared library in 100 % C language - coming with sources.
  9.  
  10.   Compiler Checklist:        Compiler           Support
  11.                              -------------------------------
  12.    (see README.<compiler>    SAS/C 6.5x         yes
  13.     for more information)    MaxonC 3.x         yes
  14.                              StormC 2.x         yes
  15.                              DICE 3.x           (not tested, but likely)
  16.                              GCC 2.7.2.1        yes
  17.                              AztecC             (not tested)
  18.                              vbcc 0.5+          yes
  19.  
  20.   OS Checklist:              Operating System   Support
  21.                              -------------------------------
  22.                              Amiga OS 37-40     yes
  23.                              AROS 1.x           yes (AROS source tree)
  24.  
  25.  
  26.   Original SAS/C and StormC version (C) 1996-97 by Andreas R. Kleinert,
  27.   MaxonC version changes done 1996 by Helmut Hummel and Stephan Rupprecht.
  28.   GCC version changes done 1997 by Stefan Fuchs and Gunter Nikl.
  29.   AROS source tree done 1997 by Aaron Digulla.
  30.   VBCC version changes done 1997 by Patrizio Biancalani.
  31.   All rights reserved.
  32.   ----------------------------------------------------------------------
  33.   This sample library intends to make Amiga shared library sources
  34.   compileable with any available Amiga C compiler - without any
  35.   changes to the source code.
  36.   And maybe in the future also running under any Amiga compatible
  37.   operating system with any CPU.
  38.  
  39.   The first goal seams to be easily done: nearly any noticeable compiler
  40.   for the Amiga does support generation of libraries by special
  41.   linker commands and pre-generated object files.
  42.  
  43.   But when looking into the details, one will find out, that these
  44.   linker functionality just reduces the influence of the programmer
  45.   on how his sources are handled, that the pre-generated object
  46.   files just originally were done in Assembler, and that each compiler
  47.   does define its own interface definitions and usage rules.
  48.  
  49.   But as a programmer, it is important to have control over the _complete_
  50.   source code and to be able to compile it _anywhere_ with only
  51.   minor changes, even better without any changes.
  52.  
  53.   Since most Amiga system modules - noticeable Libraries, Devices and
  54.   Resources - do have startup-modules and other larger parts completely
  55.   written in Assembler language, the most important task for getting
  56.   inter-compiler and operating system independant sources in my opinion
  57.   is, to completely migrate the interfaces to C language (but different
  58.   to AROS, for example, it is most important, to keep the sources running
  59.   under the current 68k AmigaOS in the _first_ place).
  60.  
  61.   This goal basically has been reached already, still missing of
  62.   course are some of the less Amiga-native compilers and of course
  63.   tests with any kind of "AmigaOS for PowerPC".
  64.  
  65.   But since Assembler is nearly as portability-hostile as BCPL _today_
  66.   we may come quite close to the goal defined above by just moving
  67.   towards C.
  68.  
  69.   Translate your 68k-assembler library startup-codes smartly
  70.   to C by simply using this source-code as an advice how to do it.
  71.  
  72.   For testing: install the (re)compiled example.library to LIBS: and
  73.   start the test program - it should pop up a requester, then.
  74.  
  75.   If you can submit adjustments for the other compilers as mentioned
  76.   above: feel free to send these.
  77.   ---
  78.   Feel free to use this source for own projects.
  79.  
  80.   It is allowed to be spread and distributed anywhere, as far
  81.   as my consent is concerned.
  82.  
  83.   Amiga International, or the current owner of the technologie,
  84.   is allowed to always put this source on their newest
  85.   Developer CD-ROM.
  86.  
  87.   Thanks and credits will always be appreciated - for example,
  88.   you MAY, but NEED NOT:
  89.   give me credits in your program's docs, send me keyfiles for
  90.   your programs using the library, and so on.
  91.   But that's simply voluntarily.
  92.  
  93.    _________________________________________________________
  94.   |      You may reach me the following way.                |
  95.   |    Send bug-reports, money or whatever to:              |
  96.   |---------------------------------------------------------|
  97.   |        * SuperView Development & Registration *         |
  98.   |          * DRAFU Development & Registration *           |
  99.   |       * Image Engineer Registration Site Europe *       |
  100.   |                                                         |
  101.   |                                                         |
  102.   |                  PerSuaSiVe SoftWorX                    |
  103.   |                                                         |
  104.   |                  Andreas R. Kleinert                    |
  105.   |                  Sandstrasse 1                          |
  106.   |                  D-57072 Siegen                         |
  107.   |                  Germany, Europe                        |
  108.   |                                                         |
  109.   | Any snail mail to the old address will still be routed. |
  110.   |                                                         |
  111.   |                  Phone:  +49-271-22869 also FAX + AM    |
  112.   |                          +49-271-22838                  |
  113.   |                                                         |
  114.   |                  Weekdays after 17.00h.                 |
  115.   |                                                         |
  116.   |         When calling via phone you may leave a message, |
  117.   |         if I'm not available - but don't expect me      |
  118.   |         calling back to USA, Australia, ... since       |
  119.   |         german phone rates are HIGHLY expensive.        |
  120.   |_________________________________________________________|
  121.  
  122.     http://home.t-online.de/home/Andreas_Kleinert/
  123.  
  124.   eMail:
  125.  
  126.         Please send binaries via ARK@News.wwbnet.de, and keep
  127.         them smaller than 16 KB. Please think twice before
  128.         sending them - my postbox is not unlimited in size.
  129.  
  130.            - Fido    Andreas Kleinert 2:2457/350.18
  131.            - Usenet
  132.                      Andreas_Kleinert@superview.ftn.neckar-alb.de (Fido-Gate)
  133.                      Andreas_Kleinert@t-online.de                 (T-Online)
  134.                      ARK@News.wwbnet.de                           (Z-Netz)
  135.                      ARK@amigaworld.com                           (AmigaWorld)
  136.  
  137.            - If nothing else works, try one of these public
  138.              Fido-Usenet gateways:
  139.  
  140.                In Germany:
  141.                  Andreas_Kleinert@p18.f350.n2457.z2.fido.sub.org
  142.  
  143.                From USA or elsewhere:
  144.                  Andreas_Kleinert@p18.f350.n2457.z2.fidonet.org
  145.  
  146.  
  147.  Known Bugs:        - some versions of DOpus and all Installer versions
  148.                       can't fetch the version information from the
  149.                       library binary due to some bugs in their code.
  150.                       Newer DOpus versions have this fixed and C:Version
  151.                       for example did that task always.
  152.  
  153.  
  154.  History:
  155.  
  156.  V37.22 (29.12.97): - fixed TestExampleLib.c
  157.                       (-> Stephan Rupprecht)
  158.                     - updated Stephan's email address
  159.                       (now is: stephan.rupprecht@metronet.de)
  160.                     - renamed "c_lib" directory and "ReadMe_First"
  161.                       to CLib37x#?
  162.  
  163.  V37.21 (19.12.97): - adjusted "compiler.h" as suggested by Volker Barthelmann
  164.                       (VBCC), done by Patrizio Biancalani
  165.                     - updated Patrizio's email address (-> ReadMe.VBCC)
  166.                     - fixed my email, too (how did that COB.wwbnet.de make
  167.                       it into this readme again ?)
  168.                     - "compiler.h" now protected from multiple #inclusion
  169.  
  170.  V37.20 (02.12.97): - added VBCC support, done by Patrizio Biancalani
  171.                       <P.Biancalani@agora.stm.it>
  172.  
  173.  V37.17 (24.10.97): - updated "ReadMe_MAXON" and added a bug-description
  174.                       (plus workaround) as supplied by Stephan Rupprecht
  175.                       <Rupprecht_Verwertung@t-online.de>
  176.                       [ 29/12/97: stephan.rupprecht@metronet.de ]
  177.  
  178.  V37.16 (23.8.97) : - V37.15 - frozen AROS spin-off
  179.                     - AROS-Version now included with AROS package, separately
  180.                     - added comments about Forbid/Permit/Wait/single-threading
  181.                       to the Library access functions
  182.                     - also commented the rest a little bit
  183.                       (-> maybe some certain people from comp.sys.amiga.programmer
  184.                           now feel better - but then again... maybe not ;)
  185.  
  186.  V37.14 (13.8.97) : - AROS: - the LH1_ to LH2_ macro replacements in
  187.                               "compiler.h" had been wrongly defined
  188.                             - "BPTR" type only was available under AROS,
  189.                               now using "struct SegList *"
  190.                             - AROS version now does compile under AmigaOS
  191.                               with SAS/C 6.58, too
  192.                     - "APTR seglist" now "struct SegList *"
  193.  
  194.  V37.13 (19.7.97) : - GNU makefile had lost its TABs
  195.                       (-> Gunter Nikl)
  196.  
  197.  V37.12 (29.6.97) : - fixed memory bug-fix (argh)
  198.                       (-> Gunter Nikl)
  199.                     - changed/applied GCC adjustments
  200.                       (-> diffs by Gunter Nikl)
  201.  
  202.  V37.11 (24.6.97) : - added "known bugs" section
  203.                     - LibInit now delocates library base on error
  204.                       (NULL return)
  205.                       (-> Gunter Nikl)
  206.                     - added AROS version, and created an additional
  207.                       source tree for it, since I did not get it compiled
  208.                       with SAS/C 6.57 and there's perhaps additional
  209.                       #ifdef stuf to be done. Anyone likes to merge these ?
  210.                       (-> Aaron Digulla)
  211.  
  212.  V37.10 (6.4.97) :  - added GCC version by Stefan Fuchs, snfuchs@sokrates.franken.de.
  213.                       Thanks !
  214.                     - some small changes to docs, includes and comments
  215.                     - still missing: DICE, Aztec, vbcc. Who does it ?
  216.                     - fixed ftn email address
  217.  
  218.  V37.6 (27.3.97) :  - finetuning
  219.  
  220.  V37.5 (24.1.97) :  - rewrote docs
  221.                     - added basic support for compiler independent
  222.                       register naming and SAS/C keyword replacements
  223.                       (compiler.h). Thus sources now should be easily
  224.                       adaptable for GCC as well.
  225.  
  226.  V37.4 (8.1.97) :   - added FD file
  227.                     - added new pragma file (and dir) as
  228.                       include/pragma/example_lib.h
  229.                       which works with Aztec, Maxon, Storm,
  230.                       DICE and SAS C compilers.
  231.                       Thanks to fd2pragma and Dirk Stoecker.
  232.                     - some fixes to the readme files
  233.                     - updated eMail list
  234.  
  235.  V37.3 (3.1.97) :   - slightly changed SCOPTIONS
  236.                     - fixed some style things (APTR and library casts)
  237.                     - changed note about library opening at L_OpenLibs()
  238.                     - now compileable with StormC 2.0 as well
  239.                       (not tested with 1.1) - see readme file for StormC
  240.                     - added project file for StormC 2.0, smakefile still
  241.                       present - select, which one you'd like to use
  242.  
  243.  V37.2 (12.12.96) : - applied some more changes and fixes
  244.                       (-> suggested by Helmut Hummel)
  245.                     - added icons
  246.                       (-> from Helmut Hummel)
  247.  
  248.  V37.1 (4.12.96) : - bumped version to V37
  249.                    - added MaxonC 3.x version by applying changes
  250.                      to the SAS/C sources and adding Maxon
  251.                      specific make and configuration files
  252.                      (-> all done by Helmut Hummel, see Readme.MAXON)
  253.                    - added StormC support
  254.                    - yet missing: DICE, Aztec, GNU. Who does it ?
  255.  
  256.  V1.4 (30.11.96) : - added SAS/C specific Ctrl-C disabling code
  257.                    - made some workarounds compiler sensitive
  258.                    - redone all with SAS/C V6.57
  259.                    - 944 Bytes ;-)
  260.  
  261.  V1.3 (13.9.96) :  - when starting lib as executable, -1 must be returned
  262.                    - now caching SysBase
  263.                    - added some comments, where changes should not
  264.                      be applied
  265.                    - added note about sharing library bases
  266.                    - documented and modified sample function,
  267.                      so that correct a0/a1/d0/d1 and a6 usage becomes
  268.                      more obviously and verbose
  269.                    - still 940 bytes ;-)
  270.  
  271.  V1.2 (5.9.96)  :  - fixed some things resulting out of a
  272.                      discussion in Z-Netz
  273.  
  274.  V1.1 (1.9.96)  :  - small changes in style
  275.                      (only bumped versions of changed modules):
  276.                        o moved "examplebase.h" to include/example/
  277.                          (so also adjusted LibInit.c, StartUp.c
  278.                           and SCOPTIONS for reflecting that)
  279.                        o SampleFuncs.h did contain wrong prototype
  280.                          (did not matter, since only used for
  281.                           ULONG function table within StartUp.c)
  282.                        o explicitely __aligned ROMTag structure
  283.  
  284.  V1.0 (14.8.96) : - first release
  285.  
  286.  
  287.  ---
  288.  All mentioned trademarks are subject to their owners.
  289.