scm/guile-debugger.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2010 Ian Hulin <ian@hulin.org.uk>
   4 ;;;;
   5 ;;;; LilyPond is free software: you can redistribute it and/or modify
   6 ;;;; it under the terms of the GNU General Public License as published by
   7 ;;;; the Free Software Foundation, either version 3 of the License, or
   8 ;;;; (at your option) any later version.
   9 ;;;;
  10 ;;;; LilyPond is distributed in the hope that it will be useful,
  11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ;;;; GNU General Public License for more details.
  14 ;;;;
  15 ;;;; You should have received a copy of the GNU General Public License
  16 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 (define-module (scm guile-debugger)
  19   #:use-module (ice-9 debugger)
  20   #:use-module (ice-9 debugging traps)
  21   #:use-module (ice-9 debugging trace)
  22   #:use-module (ice-9 debugging steps)
  23   #:use-module (ice-9 debugging ice-9-debugger-extensions)
  24   #:use-module (ice-9 readline)
  25   #:export (set-break!
  26             clear-break!
  27             set-trace-call!
  28             clear-trace-call!
  29             set-trace-subtree!
  30             clear-trace-subtree!
  31             debug-help))
  32
  33 (define (set-break! proc)
  34   (install-trap (make <procedure-trap>
  35                   #:procedure proc
  36                   #:behaviour debug-trap)))
  37 (define (clear-break! proc)
  38   (uninstall-trap (make <procedure-trap>
  39                     #:procedure proc
  40                     #:behaviour debug-trap)))
  41
  42
  43 (define (set-trace-call! proc)
  44   (install-trap (make <procedure-trap>
  45                   #:procedure proc
  46                   #:behaviour (list trace-trap
  47                                     trace-at-exit))))
  48 (define (clear-trace-call! proc)
  49   (uninstall-trap (make <procedure-trap>
  50                     #:procedure proc
  51                     #:behaviour (list trace-trap
  52                                       trace-at-exit))))
  53
  54 (define (set-trace-subtree! proc)
  55   (install-trap (make <procedure-trap>
  56                   #:procedure proc
  57                   #:behaviour (list trace-trap
  58                                     trace-until-exit))))
  59
  60 (define (clear-trace-subtree! proc)
  61   (uninstall-trap (make <procedure-trap>
  62                     #:procedure proc
  63                     #:behaviour (list trace-trap
  64                                       trace-until-exit))))
  65
  66 (define (debug-help )
  67   (display "\nYou may add the following commands as debugging statements in your source file\n")
  68   (display "or enter the set-x! commands at the guile prompt:\n\n")
  69   (display " (set-break! <procedure>)\n")
  70   (display "   causes guile to enter debugger on a call to <procedure>\n")
  71   (display " (clear-break! <procedure>)\n")
  72   (display "   disables a breakpoint previously set on a call to <procedure>\n")
  73   (display " (set-trace-call! <procedure>)\n")
  74   (display "   prints out a line when Scheme enters or exits <procedure>\n")
  75   (display " (clear-trace-call! <procedure>)\n")
  76   (display "   turns off tracing calls to <procedure>\n")
  77   (display " (set-trace-subtree! <procedure>)\n")
  78   (display "   displays each line of Scheme code executed during a call to <procedure>\n")
  79   (display " (clear-trace-subtree! <procedure>)\n")
  80   (display "   turns off tracing code during calls to <procedure>\n")
  81   (newline))