Annotation of gforth/debugs.fs, revision 1.15

1.1       anton       1: \ Simple debugging aids
                      2: 
1.15    ! anton       3: \ Copyright (C) 1995,1997,1999,2002,2003,2004,2005,2006 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
                      9: \ as published by the Free Software Foundation; either version 2
                     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
                     18: \ along with this program; if not, write to the Free Software
1.6       anton      19: \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.1       anton      20: 
                     21: 
                     22: \ They are meant to support a different style of debugging than the
                     23: \ tracing/stepping debuggers used in languages with long turn-around
                     24: \ times.
                     25: 
                     26: \ IMO, a much better (faster) way in fast-compilig languages is to add
                     27: \ printing code at well-selected places, let the program run, look at
                     28: \ the output, see where things went wrong, add more printing code, etc.,
                     29: \ until the bug is found.
                     30: 
                     31: \ We support fast insertion and removal of the printing code.
                     32: 
                     33: \ !!Warning: the default debugging actions will destroy the contents
                     34: \ of the pictured numeric output string (i.e., don't use ~~ between <#
                     35: \ and #>).
                     36: 
                     37: require source.fs
                     38: 
1.4       crook      39: defer printdebugdata ( -- ) \ gforth print-debug-data
1.1       anton      40: ' .s IS printdebugdata
1.7       anton      41: defer .debugline ( nfile nline -- ) \ gforth print-debug-line
1.10      anton      42: \G Print the source code location indicated by @var{nfile nline}, and
                     43: \G additional debugging information; the default @code{.debugline}
                     44: \G prints the additional information with @code{printdebugdata}.
1.1       anton      45: 
1.7       anton      46: : (.debugline) ( nfile nline -- )
                     47:     cr .sourcepos ." :"
1.1       anton      48:     \ it would be nice to print the name of the following word,
                     49:     \ but that's not easily possible for primitives
                     50:     printdebugdata
                     51:     cr ;
                     52: 
1.7       anton      53: ' (.debugline) IS .debugline
1.1       anton      54: 
1.14      anton      55: : .debugline-stderr ( nfile nline -- )
                     56:     stderr >outfile .debugline outfile< ;
                     57: 
1.10      anton      58: :noname ( -- )
1.14      anton      59:     current-sourcepos .debugline-stderr ;
1.10      anton      60: :noname ( compilation  -- ; run-time  -- )
1.14      anton      61:     compile-sourcepos POSTPONE .debugline-stderr ;
1.12      anton      62: interpret/compile: ~~ ( -- ) \ gforth tilde-tilde
1.10      anton      63: \G Prints the source code location of the @code{~~} and the stack
                     64: \G contents with @code{.debugline}.
                     65: 

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