Annotation of gforth/debugs.fs, revision 1.20

1.1       anton       1: \ Simple debugging aids
                      2: 
1.17      anton       3: \ Copyright (C) 1995,1997,1999,2002,2003,2004,2005,2006,2007 Free Software Foundation, Inc.
1.1       anton       4: 
                      5: \ This file is part of Gforth.
                      6: 
                      7: \ Gforth is free software; you can redistribute it and/or
                      8: \ modify it under the terms of the GNU General Public License
1.18      anton       9: \ as published by the Free Software Foundation, either version 3
1.1       anton      10: \ of the License, or (at your option) any later version.
                     11: 
                     12: \ This program is distributed in the hope that it will be useful,
                     13: \ but WITHOUT ANY WARRANTY; without even the implied warranty of
                     14: \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     15: \ GNU General Public License for more details.
                     16: 
                     17: \ You should have received a copy of the GNU General Public License
1.18      anton      18: \ along with this program. If not, see http://www.gnu.org/licenses/.
1.1       anton      19: 
                     20: 
                     21: \ They are meant to support a different style of debugging than the
                     22: \ tracing/stepping debuggers used in languages with long turn-around
                     23: \ times.
                     24: 
                     25: \ IMO, a much better (faster) way in fast-compilig languages is to add
                     26: \ printing code at well-selected places, let the program run, look at
                     27: \ the output, see where things went wrong, add more printing code, etc.,
                     28: \ until the bug is found.
                     29: 
                     30: \ We support fast insertion and removal of the printing code.
                     31: 
                     32: \ !!Warning: the default debugging actions will destroy the contents
                     33: \ of the pictured numeric output string (i.e., don't use ~~ between <#
                     34: \ and #>).
                     35: 
                     36: require source.fs
                     37: 
1.4       crook      38: defer printdebugdata ( -- ) \ gforth print-debug-data
1.1       anton      39: ' .s IS printdebugdata
1.7       anton      40: defer .debugline ( nfile nline -- ) \ gforth print-debug-line
1.10      anton      41: \G Print the source code location indicated by @var{nfile nline}, and
                     42: \G additional debugging information; the default @code{.debugline}
                     43: \G prints the additional information with @code{printdebugdata}.
1.1       anton      44: 
1.7       anton      45: : (.debugline) ( nfile nline -- )
                     46:     cr .sourcepos ." :"
1.1       anton      47:     \ it would be nice to print the name of the following word,
                     48:     \ but that's not easily possible for primitives
                     49:     printdebugdata
                     50:     cr ;
                     51: 
1.20    ! anton      52: stderr value debug-fid ( -- fid )
        !            53: \G (value) Debugging output prints to this file
1.19      anton      54: 
1.7       anton      55: ' (.debugline) IS .debugline
1.1       anton      56: 
1.19      anton      57: : .debugline-directed ( nfile nline -- )
                     58:     ['] .debugline debug-fid outfile-execute ;
1.14      anton      59: 
1.10      anton      60: :noname ( -- )
1.19      anton      61:     current-sourcepos .debugline-directed ;
1.10      anton      62: :noname ( compilation  -- ; run-time  -- )
1.19      anton      63:     compile-sourcepos POSTPONE .debugline-directed ;
1.12      anton      64: interpret/compile: ~~ ( -- ) \ gforth tilde-tilde
1.10      anton      65: \G Prints the source code location of the @code{~~} and the stack
                     66: \G contents with @code{.debugline}.
                     67: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>