elisp/geiser-racket.el

   1 ;; geiser-racket.el -- geiser support for Racket scheme
   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: Sat Apr 25, 2009 21:13
  11
  12 \f
  13
  14 (require 'geiser-edit)
  15 (require 'geiser-doc)
  16 (require 'geiser-eval)
  17 (require 'geiser-syntax)
  18 (require 'geiser-custom)
  19 (require 'geiser-base)
  20
  21 \f
  22 ;;; Customization:
  23
  24 (defgroup geiser-racket nil
  25   "Customization for Geiser's Racket flavour."
  26   :group 'geiser)
  27
  28 (geiser-custom--defcustom geiser-racket-binary
  29   (cond ((eq system-type 'windows-nt) "Racket.exe")
  30         (t "racket"))
  31   "Name to use to call the racket executable when starting a REPL."
  32   :type '(choice string (repeat string))
  33   :group 'geiser-racket)
  34
  35 (geiser-custom--defcustom geiser-racket-gracket-binary
  36   (cond ((eq system-type 'windows-nt) "GRacket-text.exe")
  37         (t "gracket-text"))
  38   "Name to use to call the gracket executable when starting a REPL.
  39 This executable is used by `run-gracket', and, if
  40 `geiser-racket-use-gracket-p' is set to t, by `run-racket'."
  41   :type '(choice string (repeat string))
  42   :group 'geiser-racket)
  43
  44 (geiser-custom--defcustom geiser-racket-collects nil
  45   "A list of paths to be added to racket's collection directories."
  46   :type '(repeat file)
  47   :group 'geiser-racket)
  48
  49 (geiser-custom--defcustom geiser-racket-init-file "~/.racket-geiser"
  50   "Initialization file with user code for the racket REPL."
  51   :type 'string
  52   :group 'geiser-racket)
  53
  54 (geiser-custom--defcustom geiser-racket-use-gracket-p nil
  55   "Whether to use the gracket binary to start Racket REPLs."
  56   :type 'boolean
  57   :group 'geiser-racket)
  58
  59
  60 \f
  61 ;;; REPL support:
  62
  63 (defsubst geiser-racket--real-binary ()
  64   (if geiser-racket-use-gracket-p
  65       geiser-racket-gracket-binary
  66     geiser-racket-binary))
  67
  68 (defun geiser-racket--binary ()
  69   (let ((binary (geiser-racket--real-binary)))
  70     (if (listp binary) (car binary) binary)))
  71
  72 (defun geiser-racket--parameters ()
  73   "Return a list with all parameters needed to start racket.
  74 This function uses `geiser-racket-init-file' if it exists."
  75   (let ((init-file (and (stringp geiser-racket-init-file)
  76                         (expand-file-name geiser-racket-init-file)))
  77         (binary (geiser-racket--real-binary)))
  78     `("-i" "-q"
  79       "-S" ,(expand-file-name "racket/" geiser-scheme-dir)
  80       ,@(apply 'append (mapcar (lambda (p) (list "-S" p)) geiser-racket-collects))
  81       ,@(and (listp binary) (cdr binary))
  82       ,@(and init-file (file-readable-p init-file) (list "-f" init-file))
  83       "-f" ,(expand-file-name "racket/geiser.rkt" geiser-scheme-dir))))
  84
  85 (defconst geiser-racket--prompt-regexp "^=?\\(mzscheme\\|racket\\)@[^ ]*?> ")
  86
  87 \f
  88 ;;; Evaluation support:
  89
  90 (defun geiser-racket--language ()
  91   (save-excursion
  92     (goto-char (point-min))
  93     (if (re-search-forward
  94          "^\\(?:#lang\\|(module +[^ ]+?\\) +\\([^ ]+?\\|([^)]+)\\) *$" nil t)
  95         (car (geiser-syntax--read-from-string (match-string-no-properties 1)))
  96       "#f")))
  97
  98 (defun geiser-racket--geiser-procedure (proc &rest args)
  99   (case proc
 100     ((eval compile)
 101      (format ",geiser-eval %s %s %s"
 102              (or (car args) "#f")
 103              (geiser-racket--language)
 104              (mapconcat 'identity (cdr args) " ")))
 105     ((load-file compile-file)
 106      (format ",geiser-eval geiser/main racket (geiser:%s %s)"
 107              proc (car args)))
 108     ((no-values) ",geiser-no-values")
 109     (t (format ",apply geiser:%s (%s)" proc (mapconcat 'identity args " ")))))
 110
 111 (defconst geiser-racket--module-re
 112   "^(module +\\([^ ]+\\)")
 113
 114 (defun geiser-racket--explicit-module ()
 115   (save-excursion
 116     (goto-char (point-min))
 117     (and (re-search-forward geiser-racket--module-re nil t)
 118          (ignore-errors
 119            (car (geiser-syntax--read-from-string
 120                  (match-string-no-properties 1)))))))
 121
 122 (defsubst geiser-racket--implicit-module ()
 123   (save-excursion
 124     (goto-char (point-min))
 125     (if (re-search-forward "^#lang " nil t)
 126         (buffer-file-name)
 127       :f)))
 128
 129 (defun geiser-racket--get-module (&optional module)
 130   (cond ((and (null module) (buffer-file-name)))
 131         ;; (geiser-racket--explicit-module)
 132         ((null module) (geiser-racket--implicit-module))
 133         ((symbolp module) module)
 134         ((and (stringp module) (file-name-absolute-p module)) module)
 135         ((stringp module) (intern module))
 136         (t nil)))
 137
 138 (defun geiser-racket--symbol-begin (module)
 139   (save-excursion (skip-syntax-backward "^-()>") (point)))
 140
 141 (defun geiser-racket--enter-command (module)
 142   (when (stringp module)
 143     (cond ((zerop (length module)) ",enter #f")
 144           ((file-name-absolute-p module) (format ",enter (file %S)" module))
 145           (t (format ",enter %s" module)))))
 146
 147 (defun geiser-racket--import-command (module)
 148   (and (stringp module)
 149        (not (zerop (length module)))
 150        (format "(require %s)" module)))
 151
 152 (defun geiser-racket--exit-command ()
 153   (comint-send-eof)
 154   (get-buffer-process (current-buffer)))
 155
 156 (defconst geiser-racket--binding-forms
 157   '(for for/list for/hash for/hasheq for/and for/or
 158     for/lists for/first for/last for/fold
 159     for: for/list: for/hash: for/hasheq: for/and: for/or:
 160     for/lists: for/first: for/last: for/fold:))
 161
 162 (defconst geiser-racket--binding-forms*
 163   '(for* for*/list for*/lists for*/hash for*/hasheq for*/and
 164     for*/or for*/first for*/last for*/fold
 165     for*: for*/list: for*/lists: for*/hash: for*/hasheq: for*/and:
 166     for*/or: for*/first: for*/last: for*/fold:))
 167 \f
 168 ;;; External help
 169
 170 (defsubst geiser-racket--get-help (symbol module)
 171   (geiser-eval--send/wait
 172    `(:eval (get-help ',symbol '(:module ,module)) geiser/autodoc)))
 173
 174 (defun geiser-racket--external-help (id module)
 175   (message "Requesting help for '%s'..." id)
 176   (let ((out (geiser-eval--retort-output
 177               (geiser-racket--get-help id module))))
 178     (when (and out (string-match " but provided by:\n +\\(.+\\)\n" out))
 179       (geiser-racket--get-help id (match-string 1 out))))
 180   (minibuffer-message "%s done" (current-message))
 181   t)
 182
 183 \f
 184 ;;; Error display
 185
 186 (defconst geiser-racket--file-rxs
 187   '(nil
 188     "path:\"?\\([^>\"\n]+\\)\"?>"
 189     "module: \"\\([^>\"\n]+\\)\""))
 190
 191 (defconst geiser-racket--geiser-file-rx
 192   (format "^%s/?racket/geiser" (regexp-quote geiser-scheme-dir)))
 193
 194 (defun geiser-racket--purge-trace ()
 195   (save-excursion
 196     (while (re-search-forward geiser-racket--geiser-file-rx nil t)
 197       (kill-whole-line))))
 198
 199 (defun geiser-racket--display-error (module key msg)
 200   (when key
 201     (insert "Error: ")
 202     (geiser-doc--insert-button key nil 'racket)
 203     (newline 2))
 204   (when msg
 205     (let ((p (point)))
 206       (insert msg)
 207       (when key
 208         (let ((end (point)))
 209         (goto-char p)
 210         (geiser-racket--purge-trace)
 211         (mapc 'geiser-edit--buttonize-files geiser-racket--file-rxs)
 212         (goto-char end)
 213         (newline)))))
 214   (or key (not (zerop (length msg)))))
 215
 216 \f
 217 ;;; Trying to ascertain whether a buffer is mzscheme scheme:
 218
 219 (defun geiser-racket--guess ()
 220   (or (save-excursion
 221         (goto-char (point-min))
 222         (re-search-forward "#lang " nil t))
 223       (geiser-racket--explicit-module)))
 224
 225 \f
 226 ;;; Remote REPLs
 227
 228 (defun connect-to-racket ()
 229   "Start a Racket REPL connected to a remote process.
 230
 231 The remote process needs to be running a REPL server started
 232 using start-geiser, a procedure in the geiser/server module."
 233   (interactive)
 234   (geiser-connect 'racket))
 235
 236
 237 \f
 238 ;;; Implementation definition:
 239
 240 (define-geiser-implementation racket
 241   (unsupported-procedures '(callers callees generic-methods))
 242   (binary geiser-racket--binary)
 243   (arglist geiser-racket--parameters)
 244   (startup)
 245   (eot-regexp "\0")
 246   (prompt-regexp geiser-racket--prompt-regexp)
 247   (marshall-procedure geiser-racket--geiser-procedure)
 248   (find-module geiser-racket--get-module)
 249   (enter-command geiser-racket--enter-command)
 250   (import-command geiser-racket--import-command)
 251   (exit-command geiser-racket--exit-command)
 252   (find-symbol-begin geiser-racket--symbol-begin)
 253   (display-error geiser-racket--display-error)
 254   (display-help geiser-racket--external-help)
 255   (check-buffer geiser-racket--guess)
 256   (binding-forms geiser-racket--binding-forms)
 257   (binding-forms* geiser-racket--binding-forms*))
 258
 259 (geiser-impl--add-to-alist 'regexp "\\.ss$" 'racket t)
 260 (geiser-impl--add-to-alist 'regexp "\\.rkt$" 'racket t)
 261
 262 (defun run-gracket ()
 263   "Start the Racket REPL using gracket instead of plain racket."
 264   (interactive)
 265   (let ((geiser-racket-use-gracket-p t))
 266     (run-racket)))
 267
 268 \f
 269 (provide 'geiser-racket)
 270 ;;; geiser-racket.el ends here