elisp/geiser-debug.el

   1 ;;; geiser-debug.el -- displaying debug information and evaluation results
   2
   3 ;; Copyright (C) 2009, 2010 Jose Antonio Ortega Ruiz
   4
   5 ;; This program is free software; you can redistribute it and/or
   6 ;; modify it under the terms of the Modified BSD License. You should
   7 ;; have received a copy of the license along with this program. If
   8 ;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
   9
  10 ;; Start date: Mon Feb 23, 2009 22:34
  11
  12 \f
  13
  14 (require 'geiser-autodoc)
  15 (require 'geiser-impl)
  16 (require 'geiser-eval)
  17 (require 'geiser-menu)
  18 (require 'geiser-popup)
  19 (require 'geiser-base)
  20
  21 \f
  22 ;;; Debug buffer mode:
  23
  24 (defvar geiser-debug-mode-map
  25   (let ((map (make-sparse-keymap)))
  26     (suppress-keymap map)
  27     (set-keymap-parent map button-buffer-map)
  28     map))
  29
  30 (defun geiser-debug-mode ()
  31   "A major mode for displaying Scheme compilation and evaluation results.
  32 \\{geiser-debug-mode-map}"
  33   (interactive)
  34   (kill-all-local-variables)
  35   (buffer-disable-undo)
  36   (use-local-map geiser-debug-mode-map)
  37   (set-syntax-table scheme-mode-syntax-table)
  38   (setq mode-name "Geiser DBG")
  39   (setq major-mode 'geiser-debug-mode)
  40   (setq buffer-read-only t))
  41
  42 (defun geiser-debug--button-p (nextp)
  43   (let ((m (funcall (if nextp 'next-button 'previous-button) (point))))
  44     (and m (funcall (if nextp '< '>) (point) (marker-position m)))))
  45
  46 (geiser-menu--defmenu debug geiser-debug-mode-map
  47   ("Next error" "n" forward-button :enable (geiser-debug--button-p t))
  48   ("Previous error" "p" backward-button :enable (geiser-debug--button-p t))
  49   --
  50   ("Quit" nil View-quit))
  51
  52 \f
  53 ;;; Buffer for displaying evaluation results:
  54
  55 (geiser-popup--define debug "*Geiser dbg*" geiser-debug-mode)
  56
  57 \f
  58 ;;; Displaying retorts
  59
  60 (geiser-impl--define-caller geiser-debug--display-error
  61     display-error (module key message)
  62     "This method takes 3 parameters (a module name, the error key,
  63 and the accompanying error message) and should display
  64 (in the current buffer) a formatted version of the error. If the
  65 error was successfully displayed, the call should evaluate to a
  66 non-null value.")
  67
  68 (defun geiser-debug--display-retort (what ret &optional res)
  69   (let* ((err (geiser-eval--retort-error ret))
  70          (key (geiser-eval--error-key err))
  71          (output (geiser-eval--retort-output ret))
  72          (impl geiser-impl--implementation)
  73          (module (geiser-eval--get-module)))
  74     (if (eq key 'geiser-debugger)
  75         (progn
  76           (switch-to-geiser nil nil (current-buffer))
  77           (geiser-debug--display-error impl module key output))
  78       (geiser-debug--with-buffer
  79         (erase-buffer)
  80         (insert what)
  81         (newline 2)
  82         (when (and res (not err))
  83           (insert res)
  84           (newline 2))
  85         (unless (geiser-debug--display-error impl module key output)
  86           (when err (insert (geiser-eval--error-str err) "\n\n"))
  87           (when output (insert output "\n\n")))
  88         (goto-char (point-min)))
  89       (when (or err (and output (> (length output) 0)))
  90         (geiser-debug--pop-to-buffer)))))
  91
  92 (defsubst geiser-debug--wrap-region (str)
  93   (format "(begin %s)" str))
  94
  95 (defun geiser-debug--unwrap (str)
  96   (if (string-match "(begin[ \t\n\v\r]+\\(.+\\)*)" str)
  97       (match-string 1 str)
  98     str))
  99
 100 (defun geiser-debug--send-region (compile start end and-go wrap)
 101   (let* ((str (buffer-substring-no-properties start end))
 102          (wrapped (if wrap (geiser-debug--wrap-region str) str))
 103          (code `(,(if compile :comp :eval) (:scm ,wrapped)))
 104          (ret (geiser-eval--send/wait code))
 105          (res (geiser-eval--retort-result-str ret))
 106          (err (geiser-eval--retort-error ret)))
 107     (geiser-autodoc--clean-cache)
 108     (when and-go (funcall and-go))
 109     (when (not err) (message "%s" res))
 110     (geiser-debug--display-retort str ret res)))
 111
 112 (defun geiser-debug--expand-region (start end all wrap)
 113   (let* ((str (buffer-substring-no-properties start end))
 114          (wrapped (if wrap (geiser-debug--wrap-region str) str))
 115          (code `(:eval ((:ge macroexpand) (quote (:scm ,wrapped))
 116                         ,(if all :t :f))))
 117          (ret (geiser-eval--send/wait code))
 118          (err (geiser-eval--retort-error ret))
 119          (result (geiser-eval--retort-result ret)))
 120     (if err
 121         (geiser-debug--display-retort str ret)
 122       (geiser-debug--with-buffer
 123         (erase-buffer)
 124         (insert (format "%s" (if wrap (geiser-debug--unwrap result) result)))
 125         (goto-char (point-min)))
 126       (geiser-debug--pop-to-buffer))))
 127
 128 \f
 129 (provide 'geiser-debug)
 130 ;;; geiser-debug.el ends here