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