pd.if.org Git - pdclib/blob - Notes.txt

   1 $Id$
   2
   3 Credits
   4 =======
   5
   6 The vast majority of PDCLib is original work by me. I felt it was the only way
   7 to ensure that the code was indeed free of third-party rights, and thus free to
   8 be released into the Public Domain.
   9
  10 Another issue was that of coding style, quality and stability of the code, and
  11 the urge to really understand every miniscule part of the code as to be able to
  12 maintain it well once v1.0 has been released.
  13
  14 That is not to say there are no credits to be given. To the contrary:
  15
  16 Paul Edwards (author of the PDPCLIB), for inspirational code fragments, thanks.
  17
  18 P.J. Plauger (author of "The Standard C Library"), for a book without which I
  19 would not have been able to create PDCLib at this quality, thanks.
  20
  21 Paul Bourke (author of mathlib), for allowing me access to a complete math
  22 library under public domain terms so I could use it as a reference, thanks.
  23
  24 Peter ("Candy") Bindels (netizen of mega-tokyo.com), who located a copy of Cody
  25 & Waite's "Software Manual for the Elementary Functions" for me and saved me
  26 serious cash in the process, thanks.
  27
  28 Michael Moody, who contributed the generic implementation for <stdarg.h> which
  29 can now be found in <_PDCLIB_config.h> to the Public Domain, thanks.
  30
  31 Rod Pemberton, for pointing out several flaws in early versions of PDCLib and
  32 giving other valuable hints, thanks.
  33
  34 Everyone involved in the first, "public" attempt at PDCLib, for bearing with me
  35 when I restarted from scratch, thanks.
  36
  37 Lennart Fridén and Sammy Nordström, who have been great pals even after I sunk
  38 another project that had eaten countless hours of work between the three of us,
  39 thanks.
  40
  41 My wife and daughter, for sharing husband and daddy with this strange machine,
  42 thanks.
  43
  44
  45 Style
  46 =====
  47
  48 I followed a set of guidelines in creating PDCLib. If you find some piece that
  49 does not adhere to them, that's a bug worth reporting. I mean it. I am a bit
  50 obsessive when it comes to coding style. ;-)
  51
  52 - all the stuff that is not part of the standard specification is "hidden" in
  53   the _PDCLIB_* namespace - functions, variables, macros, files, directories.
  54   This is to make it easier to distinguish between what the standard dictates
  55   and what I added to make PDCLib work.
  56
  57 - any internal includes (i.e. those not specified by the standard) have their
  58   header guards defined in the *including* file, for a tiny bit of performance.
  59
  60 - I always try to minimize the use of local variables. Wherever possible I used
  61   the parameters directly, and deferred declaration of locals to the innermost
  62   block of statements, in hopes that it might reduce memory footprint when the
  63   library is compiled with a compiler that is not that great at optimization.
  64
  65 - every function, every static data item that could possibly be shared, got its
  66   own implementation file. This means the library itself is probably larger than
  67   strictly necessary, and might take a couple of clock cycles longer to link,
  68   but it reduces size of fully-linked object files / executables.
  69
  70 - where possible, I tried to share functionality between similar functions (as
  71   can be seen in the atoi() and strtol() function families). This means one or
  72   two additional function calls, but again reduces memory footprint and eases
  73   maintenance of the library.
  74
  75 - standard function arguments are named exactly as in the standard document.
  76
  77 - the standard is taken quite literally in places. For example, memcpy() really
  78   copies char-wise. This runs contrary to earlier claims of performance, but is
  79   consistent with the *letter* of the standard, and you will probably use your
  80   compiler builtins (through a platform overlay) anyhow.
  81
  82 - every file (except the top-level *.txt files) has an Id and a Name tag, so
  83   that the CVS Id string is on file for *every* code file, and the release tag
  84   is on file for every code file in a release package.
  85
  86 - PDCLib code has no bias towards POSIX; indeed the absence of POSIX tidbits is
  87   one of its hallmarks. However, PDCLib also has no bias *against* POSIX, and
  88   when one platform abstraction is as good as another, I chose the POSIX one for
  89   sheer familiarity. (This is mainly referring to naming and parameter lists of
  90   OS "glue" functions.)
  91
  92 - identifiers are tersely named, but not cryptically abbreviated, and should be
  93   intuitive enough to allow easy understanding of PDCLib inner workings.
  94
  95 - I disagree with the notion that good code needs no comments. Code tells you
  96   *how*, but not the *why*, and you have to figure out the *what* yourself. So
  97   I added comments to every nontrivial piece of code explaining my motives and
  98   hopefully keeping overly ambitious editors from repeating my mistakes. The
  99   header files especially should be self-documenting to the point of being a
 100   suitable replacement for any library reference book you might be using.