include/README

   1 Short:    Boopsi, cross compiling and debug support macros
   2 Author:   bernie@cosmos.it (Bernardo Innocenti)
   3 Uploader: bernie@cosmos.it (Bernardo Innocenti)
   4 Type:     dev/src
   5 Version:  2.0
   6
   7  During the developement of my projects I've written some useful
   8 macros that simplify some common problems. The macros have eventually
   9 grown to full header files that I'm now using almost everywhere.
  10
  11  I've packaged all these headers in a distribution archive, in the hope
  12 that they will be useful to other programmers as well.
  13
  14
  15  - CompilerSpecific.h
  16         Defines wrappers for several compiler dependent constructs,
  17         including function attributes and register specification for
  18         function arguments. Supports SAS/C, gcc, EGCS, Storm C, Maxon C,
  19         DICE and Aztec C.
  20
  21  - BoopsiStubs.h
  22         Using these inline versions of the amiga.lib boopsi support functions
  23         results in faster and smaller code against their linked library
  24         counterparts. When debug is active, these functions will also
  25         validate the parameters you pass in.
  26
  27  - BoopsiLib.h
  28         Additional macros and inline functions for boopsi class developement.
  29
  30  - DebugMacros.h
  31         Some handy debug macros which are automatically excluded when the
  32         DEBUG preprocessor symbol isn't defined. To make debug executables,
  33         you must link with debug.lib or any linker module containing a
  34         kprintf()-like function.
  35
  36  - DiagnosticMacros.h
  37         Some handy macros to dump some common system structs to the
  38         debug console. Use DUMP_XXX(pointer) in your code to get a
  39         detailed dump of the structure contents.
  40
  41  - ListMacros.h
  42         Some handy macros for list operations. Using these macros is faster
  43         than calling their exec.library equivalents, but they will eventually
  44         make your code a little bigger and are also subject to common macro
  45         side effects.