elisp/geiser-racket.el

   1 ;; geiser-racket.el -- geiser support for Racket scheme
   2
   3 ;; Copyright (C) 2009, 2010, 2011, 2012 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-image)
  18 (require 'geiser-syntax)
  19 (require 'geiser-custom)
  20 (require 'geiser-base)
  21 (require 'geiser)
  22
  23 \f
  24 ;;; Customization:
  25
  26 (defgroup geiser-racket nil
  27   "Customization for Geiser's Racket flavour."
  28   :group 'geiser)
  29
  30 (geiser-custom--defcustom geiser-racket-binary
  31   (cond ((eq system-type 'windows-nt) "Racket.exe")
  32         (t "racket"))
  33   "Name to use to call the racket executable when starting a REPL."
  34   :type '(choice string (repeat string))
  35   :group 'geiser-racket)
  36
  37 (geiser-custom--defcustom geiser-racket-gracket-binary
  38   (cond ((eq system-type 'windows-nt) "GRacket-text.exe")
  39         (t "gracket-text"))
  40   "Name to use to call the gracket executable when starting a REPL.
  41 This executable is used by `run-gracket', and, if
  42 `geiser-racket-use-gracket-p' is set to t, by `run-racket'."
  43   :type '(choice string (repeat string))
  44   :group 'geiser-racket)
  45
  46 (geiser-custom--defcustom geiser-racket-collects nil
  47   "A list of paths to be added to racket's collection directories."
  48   :type '(repeat file)
  49   :group 'geiser-racket)
  50
  51 (geiser-custom--defcustom geiser-racket-init-file "~/.racket-geiser"
  52   "Initialization file with user code for the racket REPL."
  53   :type 'string
  54   :group 'geiser-racket)
  55
  56 (geiser-custom--defcustom geiser-racket-use-gracket-p nil
  57   "Whether to use the gracket binary to start Racket REPLs."
  58   :type 'boolean
  59   :group 'geiser-racket)
  60
  61 (geiser-custom--defcustom geiser-racket-extra-keywords
  62     '("define-syntax-rule" "provide" "require"
  63       "unless" "when" "with-handlers")
  64   "Extra keywords highlighted in Racket buffers."
  65   :type '(repeat string)
  66   :group 'geiser-racket)
  67
  68 \f
  69 ;;; REPL support:
  70
  71 (defsubst geiser-racket--real-binary ()
  72   (if geiser-racket-use-gracket-p
  73       geiser-racket-gracket-binary
  74     geiser-racket-binary))
  75
  76 (defun geiser-racket--binary ()
  77   (let ((binary (geiser-racket--real-binary)))
  78     (if (listp binary) (car binary) binary)))
  79
  80 (defun geiser-racket--parameters ()
  81   "Return a list with all parameters needed to start racket.
  82 This function uses `geiser-racket-init-file' if it exists."
  83   (let ((init-file (and (stringp geiser-racket-init-file)
  84                         (expand-file-name geiser-racket-init-file)))
  85         (binary (geiser-racket--real-binary))
  86         (rackdir (expand-file-name "racket/" geiser-scheme-dir)))
  87     `("-i" "-q"
  88       "-S" ,rackdir
  89       ,@(apply 'append (mapcar (lambda (p) (list "-S" p))
  90                                geiser-racket-collects))
  91       ,@(and (listp binary) (cdr binary))
  92       ,@(and init-file (file-readable-p init-file) (list "-f" init-file))
  93       "-f" ,(expand-file-name "geiser/startup.rkt" rackdir))))
  94
  95 (defconst geiser-racket--prompt-regexp "\\(mzscheme\\|racket\\)@[^ ]*?> ")
  96
  97 (defun geiser-racket--startup (remote)
  98   (if geiser-image-cache-dir
  99       (geiser-eval--send/wait
 100        `(:eval (image-cache ,geiser-image-cache-dir) geiser/user))
 101     (setq geiser-image-cache-dir
 102           (geiser-eval--send/result '(:eval (image-cache) geiser/user)))))
 103
 104 \f
 105 ;;; Remote REPLs
 106
 107 (defun connect-to-racket ()
 108   "Start a Racket REPL connected to a remote process.
 109
 110 The remote process needs to be running a REPL server started
 111 using start-geiser, a procedure in the geiser/server module."
 112   (interactive)
 113   (geiser-connect 'racket))
 114
 115
 116 \f
 117 ;;; Evaluation support:
 118
 119 (defun geiser-racket--language ()
 120   (save-excursion
 121     (goto-char (point-min))
 122     (if (re-search-forward
 123          "^\\(?:#lang\\|(module +[^ ]+?\\) +\\([^ ]+?\\|([^)]+)\\) *$" nil t)
 124         (car (geiser-syntax--read-from-string (match-string-no-properties 1)))
 125       "#f")))
 126
 127 (defun geiser-racket--enter-command (module)
 128   (when (stringp module)
 129     (cond ((zerop (length module)) ",enter #f")
 130           ((file-name-absolute-p module) (format ",enter %S" module))
 131           (t (format ",enter %s" module)))))
 132
 133 (defun geiser-racket--geiser-procedure (proc &rest args)
 134   (case proc
 135     ((eval compile)
 136      (format ",geiser-eval %s %s %s"
 137              (or (car args) "#f")
 138              (geiser-racket--language)
 139              (mapconcat 'identity (cdr args) " ")))
 140     ((load-file compile-file)
 141      (format ",geiser-eval geiser/main racket (geiser:%s %s)"
 142              proc (car args)))
 143     ((no-values) ",geiser-no-values")
 144     (t (format ",apply geiser:%s (%s)" proc (mapconcat 'identity args " ")))))
 145
 146 (defconst geiser-racket--module-re
 147   "^(module +\\([^ ]+\\)")
 148
 149 (defun geiser-racket--explicit-module ()
 150   (save-excursion
 151     (goto-char (point-min))
 152     (and (re-search-forward geiser-racket--module-re nil t)
 153          (ignore-errors
 154            (car (geiser-syntax--read-from-string
 155                  (match-string-no-properties 1)))))))
 156
 157 (defsubst geiser-racket--implicit-module ()
 158   (save-excursion
 159     (goto-char (point-min))
 160     (if (re-search-forward "^#lang " nil t)
 161         (buffer-file-name)
 162       :f)))
 163
 164 (defun geiser-racket--get-module (&optional module)
 165   (cond ((and (null module) (buffer-file-name)))
 166         ;; (geiser-racket--explicit-module)
 167         ((null module) (geiser-racket--implicit-module))
 168         ((symbolp module) module)
 169         ((and (stringp module) (file-name-absolute-p module)) module)
 170         ((stringp module) (make-symbol module))
 171         (t nil)))
 172
 173 (defun geiser-racket--symbol-begin (module)
 174   (save-excursion (skip-syntax-backward "^-()>") (point)))
 175
 176 (defun geiser-racket--import-command (module)
 177   (and (stringp module)
 178        (not (zerop (length module)))
 179        (format "(require %s)" module)))
 180
 181 (defun geiser-racket--exit-command ()
 182   (comint-send-eof)
 183   (get-buffer-process (current-buffer)))
 184
 185 (defconst geiser-racket--binding-forms
 186   '("for" "for/list" "for/hash" "for/hasheq" "for/and" "for/or"
 187     "for/lists" "for/first" "for/last" "for/fold"
 188     "for:" "for/list:" "for/hash:" "for/hasheq:" "for/and:" "for/or:"
 189     "for/lists:" "for/first:" "for/last:" "for/fold:"
 190     "define-syntax-rule"))
 191
 192 (defconst geiser-racket--binding-forms*
 193   '("for*" "for*/list" "for*/lists" "for*/hash" "for*/hasheq" "for*/and"
 194     "for*/or" "for*/first" "for*/last" "for*/fold"
 195     "for*:" "for*/list:" "for*/lists:" "for*/hash:" "for*/hasheq:" "for*/and:"
 196     "for*/or:" "for*/first:" "for*/last:" "for*/fold:"))
 197 \f
 198 ;;; External help
 199
 200 (defsubst geiser-racket--get-help (symbol module)
 201   (geiser-eval--send/wait
 202    `(:eval (get-help ',symbol '(:module ,module)) geiser/autodoc)))
 203
 204 (defun geiser-racket--external-help (id module)
 205   (message "Looking up manual for '%s'..." id)
 206   (let ((out (geiser-eval--retort-output
 207               (geiser-racket--get-help id module))))
 208     (when (and out (string-match " but provided by:\n +\\(.+\\)\n" out))
 209       (geiser-racket--get-help id (match-string 1 out))))
 210   (minibuffer-message "%s done" (current-message))
 211   t)
 212
 213 \f
 214 ;;; Error display
 215
 216 (defconst geiser-racket--file-rxs
 217   '(nil
 218     "path:\"?\\([^>\"\n]+\\)\"?>"
 219     "module: \"\\([^>\"\n]+\\)\""))
 220
 221 (defconst geiser-racket--geiser-file-rx
 222   (format "^%s/?racket/geiser" (regexp-quote geiser-scheme-dir)))
 223
 224 (defun geiser-racket--purge-trace ()
 225   (save-excursion
 226     (while (re-search-forward geiser-racket--geiser-file-rx nil t)
 227       (kill-whole-line))))
 228
 229 (defun geiser-racket--display-error (module key msg)
 230   (when key
 231     (insert "Error: ")
 232     (geiser-doc--insert-button key nil 'racket)
 233     (newline 2))
 234   (when msg
 235     (let ((p (point)))
 236       (insert msg)
 237       (let ((end (point)))
 238         (goto-char p)
 239         (when key (geiser-racket--purge-trace))
 240         (mapc 'geiser-edit--buttonize-files geiser-racket--file-rxs)
 241         (goto-char end)
 242         (newline))))
 243   (or key (not (zerop (length msg)))))
 244
 245 \f
 246 ;;; Trying to ascertain whether a buffer is mzscheme scheme:
 247
 248 (defun geiser-racket--guess ()
 249   (or (save-excursion
 250         (goto-char (point-min))
 251         (re-search-forward "#lang " nil t))
 252       (geiser-racket--explicit-module)))
 253
 254 \f
 255 ;;; Keywords and syntax
 256
 257 (defun geiser-racket--keywords ()
 258   (append '(("^#lang\\>" . 0)
 259             ("\\[\\(else\\)\\>" . 1))
 260           (when geiser-racket-extra-keywords
 261             `((,(format "[[(]%s\\>" (regexp-opt geiser-racket-extra-keywords 1))
 262                . 1)))))
 263
 264 (geiser-syntax--scheme-indent
 265  (begin0 1)
 266  (case-lambda: 0)
 267  (class* defun)
 268  (compound-unit/sig 0)
 269  (define: defun)
 270  (for 1)
 271  (for* 1)
 272  (for*/and 1)
 273  (for*/first 1)
 274  (for*/fold 2)
 275  (for*/hash 1)
 276  (for*/hasheq 1)
 277  (for*/hasheqv 1)
 278  (for*/last 1)
 279  (for*/list 1)
 280  (for*/lists 2)
 281  (for*/or 1)
 282  (for*/product 1)
 283  (for*/sum 1)
 284  (for*/vector 1)
 285  (for/and 1)
 286  (for/first 1)
 287  (for/fold 2)
 288  (for/hash 1)
 289  (for/hasheq 1)
 290  (for/hasheqv 1)
 291  (for/last 1)
 292  (for/list 1)
 293  (for/lists 2)
 294  (for/or 1)
 295  (for/product 1)
 296  (for/sum 1)
 297  (for/vector 1)
 298  (instantiate 2)
 299  (interface 1)
 300  (lambda/kw 1)
 301  (lambda: 1)
 302  (let*-values: 1)
 303  (let+ 1)
 304  (let-values: 1)
 305  (let/cc: 1)
 306  (let: 1)
 307  (letrec-values: 1)
 308  (letrec: 1)
 309  (mixin 2)
 310  (module defun)
 311  (module+ defun)
 312  (parameterize-break 1)
 313  (quasisyntax/loc 1)
 314  (send* 1)
 315  (splicing-let 1)
 316  (splicing-let-syntax 1)
 317  (splicing-let-syntaxes 1)
 318  (splicing-let-values 1)
 319  (splicing-letrec 1)
 320  (splicing-letrec-syntax 1)
 321  (splicing-letrec-syntaxes 1)
 322  (splicing-letrec-syntaxes+values 1)
 323  (splicing-letrec-values 1)
 324  (splicing-local 1)
 325  (syntax-id-rules defun)
 326  (syntax/loc 1)
 327  (type-case defun)
 328  (unit defun)
 329  (unit/sig 2)
 330  (with-handlers 1)
 331  (with-handlers: 1))
 332
 333
 334 \f
 335 ;;; Implementation definition:
 336
 337 (define-geiser-implementation racket
 338   (unsupported-procedures '(callers callees generic-methods))
 339   (binary geiser-racket--binary)
 340   (arglist geiser-racket--parameters)
 341   (repl-startup geiser-racket--startup)
 342   (prompt-regexp geiser-racket--prompt-regexp)
 343   (marshall-procedure geiser-racket--geiser-procedure)
 344   (find-module geiser-racket--get-module)
 345   (enter-command geiser-racket--enter-command)
 346   (import-command geiser-racket--import-command)
 347   (exit-command geiser-racket--exit-command)
 348   (find-symbol-begin geiser-racket--symbol-begin)
 349   (display-error geiser-racket--display-error)
 350   (external-help geiser-racket--external-help)
 351   (check-buffer geiser-racket--guess)
 352   (keywords geiser-racket--keywords)
 353   (binding-forms geiser-racket--binding-forms)
 354   (binding-forms* geiser-racket--binding-forms*))
 355
 356 (geiser-impl--add-to-alist 'regexp "\\.ss$" 'racket t)
 357 (geiser-impl--add-to-alist 'regexp "\\.rkt$" 'racket t)
 358
 359 (defun run-gracket ()
 360   "Start the Racket REPL using gracket instead of plain racket."
 361   (interactive)
 362   (let ((geiser-racket-use-gracket-p t))
 363     (run-racket)))
 364
 365 \f
 366 (provide 'geiser-racket)