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