misc/fuel/fuel-debug-uses.el

   1 ;;; fuel-debug-uses.el -- retrieving USING: stanzas
   2
   3 ;; Copyright (C) 2008 Jose Antonio Ortega Ruiz
   4 ;; See http://factorcode.org/license.txt for BSD license.
   5
   6 ;; Author: Jose Antonio Ortega Ruiz <jao@gnu.org>
   7 ;; Keywords: languages, fuel, factor
   8 ;; Start date: Tue Dec 23, 2008 04:23
   9
  10 ;;; Comentary:
  11
  12 ;; Support for getting and updating factor source vocabulary lists.
  13
  14 ;;; Code:
  15
  16 (require 'fuel-debug)
  17 (require 'fuel-eval)
  18 (require 'fuel-popup)
  19 (require 'fuel-font-lock)
  20 (require 'fuel-base)
  21
  22
  23 \f
  24 ;;; Customization:
  25
  26 (fuel-font-lock--defface fuel-font-lock-debug-missing-vocab
  27   'font-lock-warning-face fuel-debug "missing vocabulary names")
  28
  29 (fuel-font-lock--defface fuel-font-lock-debug-unneeded-vocab
  30   'font-lock-warning-face fuel-debug "unneeded vocabulary names")
  31
  32 (fuel-font-lock--defface fuel-font-lock-debug-uses-header
  33   'bold fuel-debug "headers in Uses buffers")
  34
  35 \f
  36 ;;; Utility functions:
  37
  38 (defsubst fuel-debug--at-eou-p ()
  39   (looking-at ".*\\_<;\\_>"))
  40
  41 (defun fuel-debug--file-lines (file)
  42   (when (file-readable-p file)
  43     (with-current-buffer (find-file-noselect file)
  44       (save-excursion
  45         (goto-char (point-min))
  46         (let ((lines) (in-usings))
  47           (while (not (eobp))
  48             (when (looking-at "^USING: ") (setq in-usings t))
  49             (unless in-usings
  50               (let ((line (substring-no-properties (thing-at-point 'line) 0 -1)))
  51                 (unless (or (empty-string-p line)
  52                             (fuel--string-prefix-p "! " line))
  53                   (push line lines))))
  54             (when (and in-usings (fuel-debug--at-eou-p)) (setq in-usings nil))
  55             (forward-line))
  56           (reverse lines))))))
  57
  58 (defun fuel-debug--highlight-names (names ref face)
  59   (dolist (n names)
  60     (when (not (member n ref))
  61       (put-text-property 0 (length n) 'face face n))))
  62
  63 (defun fuel-debug--uses-new-uses (file uses)
  64   (pop-to-buffer (find-file-noselect file))
  65   (goto-char (point-min))
  66   (if (re-search-forward "^USING: " nil t)
  67       (let ((begin (point))
  68             (end (or (and (re-search-forward "\\_<;\\_>") (point)) (point))))
  69         (kill-region begin end))
  70     (re-search-forward "^IN: " nil t)
  71     (beginning-of-line)
  72     (open-line 2)
  73     (insert "USING: "))
  74   (insert (mapconcat 'identity uses " ") " ;")
  75   (fill-paragraph nil))
  76
  77 (defun fuel-debug--uses-filter (restarts)
  78   (let ((result) (i 1) (rn 0))
  79     (dolist (r restarts (reverse result))
  80       (setq rn (1+ rn))
  81       (when (string-match "Use the .+ vocabulary\\|Defer" r)
  82         (push (list i rn r) result)
  83         (setq i (1+ i))))))
  84
  85 \f
  86 ;;; Retrieving USINGs:
  87
  88 (fuel-popup--define fuel-debug--uses-buffer
  89   "*fuel uses*" 'fuel-debug-uses-mode)
  90
  91 (make-variable-buffer-local
  92  (defvar fuel-debug--uses nil))
  93
  94 (make-variable-buffer-local
  95  (defvar fuel-debug--uses-file nil))
  96
  97 (make-variable-buffer-local
  98  (defvar fuel-debug--uses-restarts nil))
  99
 100 (defsubst fuel-debug--uses-insert-title ()
 101   (insert "Infering USING: stanza for " fuel-debug--uses-file ".\n\n"))
 102
 103 (defun fuel-debug--uses-prepare (file)
 104   (fuel--with-popup (fuel-debug--uses-buffer)
 105     (setq fuel-debug--uses-file file
 106           fuel-debug--uses nil
 107           fuel-debug--uses-restarts nil)
 108     (erase-buffer)
 109     (fuel-debug--uses-insert-title)))
 110
 111 (defun fuel-debug--uses-clean ()
 112   (setq fuel-debug--uses-file nil
 113         fuel-debug--uses nil
 114         fuel-debug--uses-restarts nil))
 115
 116 (defun fuel-debug--uses-for-file (file)
 117   (let* ((lines (fuel-debug--file-lines file))
 118          (cmd `(:fuel ((V{ ,@lines } fuel-get-uses)) t t)))
 119     (fuel-debug--uses-prepare file)
 120     (fuel--with-popup (fuel-debug--uses-buffer)
 121       (insert "Asking Factor. Please, wait ...\n")
 122       (fuel-eval--send cmd 'fuel-debug--uses-cont))
 123     (fuel-popup--display (fuel-debug--uses-buffer))))
 124
 125 (defun fuel-debug--uses-cont (retort)
 126   (let ((uses (fuel-eval--retort-result retort))
 127         (err (fuel-eval--retort-error retort)))
 128     (if uses (fuel-debug--uses-display uses)
 129       (fuel-debug--uses-display-err retort))))
 130
 131 (defun fuel-debug--insert-vlist (title vlist)
 132   (goto-char (point-max))
 133   (insert title "\n\n  ")
 134   (let ((i 0) (step 5))
 135     (dolist (v vlist)
 136       (setq i (1+ i))
 137       (insert v)
 138       (insert (if (zerop (mod i step)) "\n  " " ")))
 139     (unless (zerop (mod i step)) (newline))
 140     (newline)))
 141
 142 (defun fuel-debug--uses-display (uses)
 143   (let* ((inhibit-read-only t)
 144          (old (with-current-buffer (find-file-noselect fuel-debug--uses-file)
 145                 (fuel-syntax--usings)))
 146          (old (sort old 'string<))
 147          (new (sort uses 'string<)))
 148     (erase-buffer)
 149     (fuel-debug--uses-insert-title)
 150     (if (equalp old new)
 151         (progn
 152           (insert "Current USING: is already fine!. Type 'q' to bury buffer.\n")
 153           (fuel-debug--uses-clean))
 154       (fuel-debug--highlight-names old new 'fuel-font-lock-debug-unneeded-vocab)
 155       (fuel-debug--highlight-names new old 'fuel-font-lock-debug-missing-vocab)
 156       (fuel-debug--insert-vlist "Current vocabulary list:" old)
 157       (newline)
 158       (fuel-debug--insert-vlist "Correct vocabulary list:" new)
 159       (setq fuel-debug--uses new)
 160       (insert "\nType 'y' to update your USING: to the new one.\n"))))
 161
 162 (defun fuel-debug--uses-display-err (retort)
 163   (let* ((inhibit-read-only t)
 164          (err (fuel-eval--retort-error retort))
 165          (restarts (fuel-debug--uses-filter (fuel-eval--error-restarts err)))
 166          (unique (= 1 (length restarts))))
 167     (erase-buffer)
 168     (fuel-debug--uses-insert-title)
 169     (insert (fuel-eval--retort-output retort))
 170     (newline)
 171     (if (not restarts)
 172         (insert "\nSorry, couldn't infer the vocabulary list.\n")
 173       (setq fuel-debug--uses-restarts restarts)
 174       (if unique (fuel-debug--uses-restart 1)
 175         (insert "\nPlease, type the number of the desired vocabulary:\n\n")
 176         (dolist (r restarts)
 177           (insert (format " :%s %s\n" (first r) (third r))))))))
 178
 179 (defun fuel-debug--uses-update-usings ()
 180   (interactive)
 181   (let ((inhibit-read-only t))
 182     (when (and fuel-debug--uses-file fuel-debug--uses)
 183       (fuel-debug--uses-new-uses fuel-debug--uses-file fuel-debug--uses)
 184       (message "USING: updated!")
 185       (with-current-buffer (fuel-debug--uses-buffer)
 186         (insert "\n Done!")
 187         (fuel-debug--uses-clean)
 188         (fuel-popup--quit)))))
 189
 190 (defun fuel-debug--uses-restart (n)
 191   (when (and (> n 0) (<= n (length fuel-debug--uses-restarts)))
 192     (let* ((inhibit-read-only t)
 193            (restart (format ":%s" (cadr (nth (1- n) fuel-debug--uses-restarts))))
 194            (cmd `(:fuel ([ (:factor ,restart) ] fuel-with-autouse) t t)))
 195       (setq fuel-debug--uses-restarts nil)
 196       (insert "\nAsking Factor. Please, wait ...\n")
 197       (fuel-eval--send cmd 'fuel-debug--uses-cont))))
 198
 199 \f
 200 ;;; Fuel uses mode:
 201
 202 (defvar fuel-debug-uses-mode-map
 203   (let ((map (make-keymap)))
 204     (suppress-keymap map)
 205     (dotimes (n 9)
 206       (define-key map (vector (+ ?1 n))
 207         `(lambda () (interactive) (fuel-debug--uses-restart ,(1+ n)))))
 208     (define-key map "y" 'fuel-debug--uses-update-usings)
 209     (define-key map "\C-c\C-c" 'fuel-debug--uses-update-usings)
 210     map))
 211
 212 (defun fuel-debug-uses-mode ()
 213   "A major mode for displaying Factor's USING: inference results."
 214   (interactive)
 215   (kill-all-local-variables)
 216   (buffer-disable-undo)
 217   (setq major-mode 'fuel-debug-uses-mode)
 218   (setq mode-name "Fuel Uses:")
 219   (use-local-map fuel-debug-uses-mode-map))
 220
 221 \f
 222 (provide 'fuel-debug-uses)
 223 ;;; fuel-debug-uses.el ends here