TODO

   1 for 0.7.0:
   2
   3 * filed off the roughest edges (or, perhaps, at least hammered down the
   4         protruding rusty nails and snipped off the trailing razor wire,
   5         leaving some filing for later:-) from the monster
   6         EVAL/EVAL-WHEN/%COMPILE/DEFUN/DEFSTRUCT cleanup:
   7         ** substantially rewrote DEFSTRUCT implementation to work
   8                 cleanly with EVAL-WHEN, not sleazily use DEFUN for
   9                 structure functions, implement out-of-line structure
  10                 accessors as closures, reduce or eliminate non-ANSI
  11                 magicality of structure functions
  12                 *** made structure type tests work again
  13                 *** got rid of bogus warnings about "redefinition" of
  14                         structure accessors
  15         ** made inlining DEFUN inside MACROLET work again
  16         ** made %COMPILE set up debugging data more like the way the
  17                 debugger expects (and maybe even completely
  18                 correctly:-)
  19 * incompatible changes listed in NEWS:
  20         ** changed debugger prompt to "5]", "5[2]", "5[3]", etc.
  21         ** changed default output representation of *PRINT-ESCAPE*-ed
  22                 unprintable ASCII characters to #\Nul, #\Soh, etc.
  23 * some easy FIXMEs with high disruptive potential:
  24         ** Search lists go away.
  25         ** Grep for ~D and and change most of them to ~S.
  26 * more renaming in global external names:
  27         ** used DEFINE-THE-FOO-THING and DEFFOO style consistently (and
  28                 deprecated supported extensions named in the DEF-FOO
  29                 style, e.g. SB-ALIEN:DEF-ALIEN-ROUTINE)
  30         ** reserved DO-FOO-style names for iteration macros
  31         ** finished s/FUNCTION/FUN/
  32         ** s/VARIABLE/VAR/
  33         ** s/TOPLEVEL/TOP-LEVEL/
  34 * global style systematization:
  35         ** s/#'(lambda/(lambda/
  36         ** four-space indentation in C
  37 =======================================================================
  38 for early 0.7.x:
  39
  40 * building with CLISP (or explaining why not)
  41 * faster bootstrapping (both make.sh and slam.sh)
  42         ** added mechanisms for automatically finding dead code, and
  43                 used them to remove dead code
  44         ** moved stuff from warm init into cold init where possible
  45                 (so that slam.sh will run faster and also just because
  46                 ideally everything would be in cold init)
  47         ** profiled and tweaked
  48 * more EVAL/EVAL-WHEN/%COMPILE/DEFUN/DEFSTRUCT cleanup:
  49         ** made %COMPILE understand magicality of DEFUN FOO
  50                 w.r.t. e.g. preexisting inlineness of FOO
  51         ** used %COMPILE where COMPILE-TOP-LEVEL used to be used
  52         ** removed now-redundant COMPILE-TOP-LEVEL and
  53                 FUNCTIONAL-KIND=:TOP-LEVEL stuff from the compiler
  54         ** made FUNCTION-NAME logic work on closures, so that
  55                 various public functions like CL:PACKAGEP which
  56                 are now implemented as closures (because
  57                 they're structure slot accessors) won't be so
  58                 nasty in the debugger
  59 * rewrote long-standing confusing error restarts for redefining
  60         DEFSTRUCTs
  61 * outstanding embarrassments
  62         ** cut-and-pasted DEF-BOOLEAN-ATTRIBUTE (maybe easier to fix
  63                 now that EVAL-WHEN does what it should..)
  64         ** incomplete manual
  65         ** :IGNORE-ERRORS-P cruft in stems-and-flags.lisp-expr
  66         ** weird double-loading (first in GENESIS, then in warm init)
  67                 of src/assembly/target/*.lisp stuff, and the associated
  68                 weirdness of the half-baked state (compiler almost but
  69                 not quite ready for prime time..) of the system after
  70                 cold init
  71 * fixups now feasible because of pre7 changes
  72         ** ANSIfied DECLAIM INLINE stuff (deprecating MAYBE-INLINE)
  73 * miscellaneous simple refactoring
  74         * belated renaming:
  75                 ** renamed %PRIMITIVE to %VOP
  76         * These days ANSI C has inline functions, so..
  77                 ** redid many cpp macros as inline functions:
  78                         HeaderValue, Pointerp, CEILING, ALIGNED_SIZE,
  79                         GET_FREE_POINTER, SET_FREE_POINTER,
  80                         GET_GC_TRIGGER, SET_GC_TRIGGER, GetBSP, SetBSP,
  81                         os_trunc_foo(), os_round_up_foo()
  82                 ** removed various avoid-evaluating-C-macro-arg-twice
  83                         cruft
  84 * added mechanisms for automatically finding dead symbols is
  85         package-data.lisp-expr (i.e. those symbols not bound,
  86         fbound, defined as types, or whatever), and used them
  87         to remove dead symbols
  88 * made system handle stack overflow safely unless SAFETY is dominated
  89         by SPEED or SPACE
  90 =======================================================================
  91 for 1.0:
  92
  93 * refactored in preparation for moving CLOS into cold init and merging
  94         SB-PCL:FOO with CL:FOO (for FOO=CLASS, FOO=CLASS-OF, etc.)
  95         ** systematized support for MOP (new regression tests, maybe
  96                 new SB-MOP package..) to try to make sure things don't
  97                 get mislaid in the upcoming CLOS restructuring
  98         ** extracted type system from SB-KERNEL into new SB-TYPE
  99                 package
 100         ** reimplemented GENERIC-FUNCTION as a primitive object (or
 101                 maybe made SB-MOP:FUNCALLABLE-STANDARD-OBJECT the
 102                 primitive object, and then let GENERIC-FUNCTIONs
 103                 inherit from that) instead of structures with
 104                 :ALTERNATE-METACLASS and funcallableness. Now
 105                 FUNCALLABLE-INSTANCE can go away. (And now the new
 106                 funcallable primitive objects need to go into
 107                 collections like *FUN-HEADER-WIDETAGS* where
 108                 FUNCALLABLE-INSTANCE objects used to be.)
 109         ** reimplemented CONDITIONs as primitive objects instead of
 110                 structures with :ALTERNATE-METACLASS. Now (between
 111                 this and the change to GENERIC-FUNCTIONs)
 112                 DEFSTRUCT :ALTERNATE-METACLASS can go away.
 113         ** (maybe) Now INSTANCE_POINTER_LOWTAG can become just
 114                 STRUCTURE_POINTER_LOWTAG, and the concept of
 115                 SB-KERNEL:INSTANCE (including INSTANCEP,
 116                 (SPECIFIER-TYPE 'INSTANCE), etc.) can go away.
 117 * moved CLOS into cold init, in order to allow CLOS to be used in the
 118         implementation of the core system (e.g. the type system and the
 119         compiler) and in order to support merger of CL:CLASS with
 120         SB-PCL:CLASS
 121 * (maybe) eliminated warm init altogether in favor of cold init
 122 * (maybe, especially if warm init can be eliminated) rationalized
 123         the build process, fixing miscellaneous pre-0.5.0 stuff that's
 124         transparently not the right thing
 125         ** removed separate build directories, now just building in
 126                 place with .sbclcoldfasl extensions
 127 * (maybe) more refactoring in preparation for merging SB-PCL:FOO
 128         into CL:FOO: reimplemented type system OO dispatch
 129         (!DEFINE-TYPE-METHOD, etc.) in terms of CLOS OO dispatch
 130 * merged SB-PCL:FOO into CL:FOO (and similarly CLASS-OF, etc.)
 131 * added some automatic tests for basic binary compatibility, in hopes
 132         that it might be practical to maintain binary compatibility
 133         between minor maintenance releases on the stable branch (but no
 134         promises, sorry, since I've never tried to do this before, and
 135         have no idea how much of a pain this'll be)
 136 =======================================================================
 137 other priorities, no particular time:
 138
 139 * bug fixes, especially really annoying bugs (ANSI or not) and any
 140         ANSI bugs (i.e. not just bugs in extras like the debugger or
 141         "declarations are assertions", but violations of the standard)
 142 * better communication with the outside world (scratching WHN's
 143         personal itch): I don't want socket-level stuff so much as I
 144         want RPC-level or higher (CORBA?) interfaces and (possibly
 145         through RPC or CORBA) GUI support
 146 =======================================================================
 147 important but out of scope (for WHN, anyway: Patches from other people
 148 are still welcome!) until after 1.0:
 149         * DYNAMIC-EXTENT
 150         * sadly deteriorated support for ANSI-style block compilation
 151                 (static linking of DEFUNs within a single file or
 152                 WITH-COMPILATION-UNIT)
 153         * various GC issues (exuberant cut-and-paste coding,
 154                 possibly dangerously over-conservative handling
 155                 of neighbors of function objects, general GC efficiency)
 156         * package issues other than SB!TYPE, SB!MOP, and dead exported
 157                 symbols
 158         * Any systematic effort to fix compiler consistency checks is
 159                 out of scope. (However, it still might be possible to
 160                 determine that some or all of them are hopelessly stale
 161                 and delete them.)
 162 ===============================================================================
 163 other known issues with no particular target date:
 164
 165 bugs listed on the man page
 166
 167 hundreds of FIXME notes in the sources from WHN
 168
 169 various other unfinished business from CMU CL and before, marked with
 170   "XX" or "XXX" or "###" or "***" or "???" or "pfw" or "@@@@" or "zzzzz"
 171 or probably also other codes that I haven't noticed or have forgotten.
 172
 173 (Things marked as KLUDGE are in general things which are ugly or
 174 confusing, but that, for whatever reason, may stay that way
 175 indefinitely.)
 176 =======================================================================
 177 "There's nothing an agnostic can't do as long as he doesn't know
 178 whether he believes in anything or not."
 179   -- Monty Python.
 180
 181 "God grant me serenity to accept the code I cannot change, courage to
 182 change the code I can, and wisdom to know the difference."
 183   -- Erik Naggum
 184
 185 "Accumulation of half-understood design decisions eventually chokes a
 186 program as a water weed chokes a canal. By refactoring you can ensure
 187 that your full understanding of how the program should be designed is
 188 always reflected in the program. As a water weed quickly spreads its
 189 tendrils, partially understood design decisions quickly spread their
 190 effects throughout your program. No one or two or even ten individual
 191 actions will be enough to eradicate the problem."
 192   -- Martin Fowler, in _Refactoring: Improving the Design of Existing
 193      Code_, p. 360
 194
 195 "I wish I didn't know now what I didn't know then."
 196   -- Bob Seger