elisp/geiser-chicken.el

   1 ;; geiser-chicken.el -- chicken's implementation of the geiser protocols
   2
   3 ;; Copyright (C) 2014, 2015 Daniel Leslie
   4
   5 ;; Based on geiser-guile.el by Jose Antonio Ortego Ruize
   6
   7 ;; This program is free software; you can redistribute it and/or
   8 ;; modify it under the terms of the Modified BSD License. You should
   9 ;; have received a copy of the license along with this program. If
  10 ;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
  11
  12 ;; Start date: Sun Mar 08, 2009 23:03
  13
  14
  15 (require 'geiser-connection)
  16 (require 'geiser-syntax)
  17 (require 'geiser-custom)
  18 (require 'geiser-base)
  19 (require 'geiser-eval)
  20 (require 'geiser-edit)
  21 (require 'geiser-log)
  22 (require 'geiser)
  23
  24 (require 'compile)
  25 (require 'info-look)
  26
  27 (eval-when-compile (require 'cl))
  28
  29 (defconst geiser-chicken-builtin-keywords
  30   '("and-let*" "assume" "compiler-typecase" "cond-expand" "condition-case"
  31     "cut" "cute" "declare" "define-constant" "define-inline" "define-interface"
  32     "define-record" "define-record-type" "define-specialization"
  33     "define-syntax-rule" "define-type" "define-values" "dotimes" "ecase"
  34     "fluid-let" "foreign-lambda" "foreign-lambda*" "foreign-primitive"
  35     "foreign-safe-lambda" "foreign-safe-lambda*" "functor" "handle-exceptions"
  36     "import" "let*-values" "let-location" "let-optionals" "let-optionals*"
  37     "let-values" "letrec*" "letrec-values" "match-letrec" "module"
  38     "parameterize" "regex-case" "require-extension" "select" "set!"
  39     "unless" "use" "when" "with-input-from-pipe" "match" "match-lambda"
  40     "match-lambda*" "match-let" "match-let*" "receive"))
  41
  42 \f
  43 ;;; Customization:
  44
  45 (defgroup geiser-chicken nil
  46   "Customization for Geiser's Chicken flavour."
  47   :group 'geiser)
  48
  49 (geiser-custom--defcustom geiser-chicken-prefix-delimiters
  50     '("^:" "^#")
  51     "Regex to match symbol prefix delimiters."
  52   :type '(repeat string)
  53   :group 'geiser-chicken)
  54
  55 (geiser-custom--defcustom geiser-chicken-binary
  56   (cond ((eq system-type 'windows-nt) '("csi.exe" "-:c"))
  57         ((eq system-type 'darwin) "csi")
  58         (t "csi"))
  59   "Name to use to call the Chicken executable when starting a REPL."
  60   :type '(choice string (repeat string))
  61   :group 'geiser-chicken)
  62
  63 (geiser-custom--defcustom geiser-chicken-load-path nil
  64   "A list of paths to be added to Chicken's load path when it's
  65 started."
  66   :type '(repeat file)
  67   :group 'geiser-chicken)
  68
  69 (geiser-custom--defcustom geiser-chicken-compile-geiser-p t
  70   "Non-nil means that the Geiser runtime will be compiled on load."
  71   :type 'boolean
  72   :group 'geiser-chicken)
  73
  74 (geiser-custom--defcustom geiser-chicken-init-file "~/.chicken-geiser"
  75   "Initialization file with user code for the Chicken REPL.
  76 If all you want is to load ~/.csirc, set
  77 `geiser-chicken-load-init-file-p' instead."
  78   :type 'string
  79   :group 'geiser-chicken)
  80
  81 (geiser-custom--defcustom geiser-chicken-load-init-file-p nil
  82   "Whether to load ~/.chicken when starting Chicken.
  83 Note that, due to peculiarities in the way Chicken loads its init
  84 file, using `geiser-chicken-init-file' is not equivalent to setting
  85 this variable to t."
  86   :type 'boolean
  87   :group 'geiser-chicken)
  88
  89 (geiser-custom--defcustom geiser-chicken-extra-keywords nil
  90   "Extra keywords highlighted in Chicken scheme buffers."
  91   :type '(repeat string)
  92   :group 'geiser-chicken)
  93
  94 (geiser-custom--defcustom geiser-chicken-case-sensitive-p t
  95   "Non-nil means keyword highlighting is case-sensitive."
  96   :type 'boolean
  97   :group 'geiser-chicken)
  98
  99 \f
 100 ;;; REPL support:
 101
 102 (defun geiser-chicken--binary ()
 103   (if (listp geiser-chicken-binary)
 104       (car geiser-chicken-binary)
 105     geiser-chicken-binary))
 106
 107 (defun geiser-chicken--parameters ()
 108   "Return a list with all parameters needed to start Chicken.
 109 This function uses `geiser-chicken-init-file' if it exists."
 110   (let ((init-file (and (stringp geiser-chicken-init-file)
 111                         (expand-file-name geiser-chicken-init-file)))
 112         (n-flags (and (not geiser-chicken-load-init-file-p) '("-n"))))
 113   `(,@(and (listp geiser-chicken-binary) (cdr geiser-chicken-binary))
 114     ,@n-flags "-include-path" ,(expand-file-name "chicken/" geiser-scheme-dir)
 115     ,@(apply 'append (mapcar (lambda (p) (list "-include-path" p))
 116                              geiser-chicken-load-path))
 117     ,@(and init-file (file-readable-p init-file) (list init-file)))))
 118
 119 (defconst geiser-chicken--prompt-regexp "#[^;]*;[^:0-9]*:?[0-9]+> ")
 120
 121 \f
 122 ;;; Evaluation support:
 123
 124 (defun geiser-chicken--geiser-procedure (proc &rest args)
 125   (let ((fmt
 126          (case proc
 127            ((eval compile)
 128             (let ((form (mapconcat 'identity (cdr args) " ")))
 129               (format ",geiser-eval %s %s" (or (car args) "#f") form)))
 130            ((load-file compile-file)
 131             (format ",geiser-load-file %s" (car args)))
 132            ((no-values)
 133             ",geiser-no-values")
 134            (t
 135             (let ((form (mapconcat 'identity args " ")))
 136               (format "(geiser-%s %s)" proc form))))))
 137     ;;(message fmt)
 138     fmt))
 139
 140 (defconst geiser-chicken--module-re
 141   "( *module +\\(([^)]+)\\|[^ ]+\\)\\|( *define-library +\\(([^)]+)\\|[^ ]+\\)")
 142
 143 (defun geiser-chicken--get-module (&optional module)
 144   (cond ((null module)
 145          (save-excursion
 146            (geiser-syntax--pop-to-top)
 147            (if (or (re-search-backward geiser-chicken--module-re nil t)
 148                    (looking-at geiser-chicken--module-re)
 149                    (re-search-forward geiser-chicken--module-re nil t))
 150                (geiser-chicken--get-module (match-string-no-properties 1))
 151              :f)))
 152         ((listp module) module)
 153         ((stringp module)
 154          (condition-case nil
 155              (car (geiser-syntax--read-from-string module))
 156            (error :f)))
 157         (t :f)))
 158
 159 (defun geiser-chicken--module-cmd (module fmt &optional def)
 160   (when module
 161     (let* ((module (geiser-chicken--get-module module))
 162            (module (cond ((or (null module) (eq module :f)) def)
 163                          (t (format "%s" module)))))
 164       (and module (format fmt module)))))
 165
 166 (defun geiser-chicken--import-command (module)
 167   (geiser-chicken--module-cmd module "(use %s)"))
 168
 169 (defun geiser-chicken--enter-command (module)
 170   (geiser-chicken--module-cmd module ",m %s" module))
 171
 172 (defun geiser-chicken--exit-command () ",q")
 173
 174 (defun geiser-chicken--symbol-begin (module)
 175   (let ((distance-to-beginning-of-line (- (point) (line-beginning-position))))
 176     (apply
 177      'max
 178      (append
 179       (list (save-excursion (beginning-of-line) (point))
 180             (save-excursion (skip-syntax-backward "^-()>" distance-to-beginning-of-line)
 181                             (point)))
 182       (mapcar
 183        (lambda (match-string)
 184          (save-excursion (skip-chars-backward match-string distance-to-beginning-of-line)
 185                          (point)))
 186        geiser-chicken-prefix-delimiters)))))
 187
 188 \f
 189 ;;; Error display
 190
 191 (defun geiser-chicken--display-error (module key msg)
 192   (newline)
 193   (when (stringp msg)
 194     (save-excursion (insert msg))
 195     (geiser-edit--buttonize-files))
 196   (and (not key) msg (not (zerop (length msg)))))
 197
 198 \f
 199 ;;; Trying to ascertain whether a buffer is Chicken Scheme:
 200
 201 (defconst geiser-chicken--guess-re
 202   (regexp-opt (append '("csi" "chicken") geiser-chicken-builtin-keywords)))
 203
 204 (defun geiser-chicken--guess ()
 205   (save-excursion
 206     (goto-char (point-min))
 207     (re-search-forward geiser-chicken--guess-re nil t)))
 208
 209 (defun geiser-chicken--external-help (id module)
 210   "Loads chicken doc into a buffer"
 211   (browse-url (format "http://api.call-cc.org/cdoc?q=%s&query-name=Look+up" id)))
 212
 213 \f
 214 ;;; Keywords and syntax
 215
 216 (defun geiser-chicken--keywords ()
 217   `((,(format "[[(]%s\\>" (regexp-opt geiser-chicken-builtin-keywords 1)) . 1)))
 218
 219 (geiser-syntax--scheme-indent
 220  (receive 2)
 221  (match 1)
 222  (match-lambda 0)
 223  (match-lambda* 0)
 224  (match-let scheme-let-indent)
 225  (match-let* 1)
 226  (match-letrec 1)
 227  (declare 0)
 228  (cond-expand 0)
 229  (let-values scheme-let-indent)
 230  (let*-values scheme-let-indent)
 231  (letrec-values 1)
 232  (letrec* 1)
 233  (parameterize scheme-let-indent)
 234  (let-location 1)
 235  (foreign-lambda 2)
 236  (foreign-lambda* 2)
 237  (foreign-primitive 2)
 238  (foreign-safe-lambda 2)
 239  (foreign-safe-lambda* 2)
 240  (set! 1)
 241  (let-optionals* 2)
 242  (let-optionals 2)
 243  (condition-case 1)
 244  (fluid-let 1)
 245  (and-let* 1)
 246  (assume 1)
 247  (cut 1)
 248  (cute 1)
 249  (when 1)
 250  (unless 1)
 251  (dotimes 1)
 252  (compiler-typecase 1)
 253  (ecase 1)
 254  (use 0)
 255  (require-extension 0)
 256  (import 0)
 257  (handle-exceptions 2)
 258  (regex-case 1)
 259  (define-inline 1)
 260  (define-constant 1)
 261  (define-syntax-rule 1)
 262  (define-record-type 1)
 263  (define-values 1)
 264  (define-record 1)
 265  (define-specialization 1)
 266  (define-type 1)
 267  (with-input-from-pipe 1)
 268  (with-output-to-pipe 1)
 269  (select 1)
 270  (functor 3)
 271  (define-interface 1)
 272  (module 2))
 273
 274 \f
 275 ;;; REPL startup
 276
 277 (defconst geiser-chicken-minimum-version "4.8.0.0")
 278
 279 (defun geiser-chicken--version (binary)
 280   (shell-command-to-string (format "%s -e \"(display (chicken-version))\""
 281                                    binary)))
 282
 283 (defun connect-to-chicken ()
 284   "Start a Chicken REPL connected to a remote process."
 285   (interactive)
 286   (geiser-connect 'chicken))
 287
 288 (defun geiser-chicken--compile-or-load (force-load)
 289   (let ((target
 290          (expand-file-name "chicken/geiser/emacs.so" geiser-scheme-dir))
 291         (source
 292          (expand-file-name "chicken/geiser/emacs.scm" geiser-scheme-dir))
 293         (force-load (or force-load (eq system-type 'windows-nt)))
 294         (suppression-prefix
 295          "(define geiser-stdout (current-output-port))(current-output-port (make-output-port (lambda a #f) (lambda a #f)))")
 296         (suppression-postfix
 297          "(current-output-port geiser-stdout)"))
 298     (let ((load-sequence
 299            (cond
 300             (force-load
 301              (format "(load \"%s\")\n" source))
 302             ((file-exists-p target)
 303              (format "%s(load \"%s\")(import geiser)%s\n"
 304                      suppression-prefix target suppression-postfix))
 305             (t
 306              (format "%s(use utils)(compile-file \"%s\" options: '(\"-O3\") output-file: \"%s\" load: #t)(import geiser)%s\n"
 307                      suppression-prefix source target suppression-postfix)))))
 308       (geiser-eval--send/wait load-sequence))))
 309
 310 (defun geiser-chicken--startup (remote)
 311   (compilation-setup t)
 312   (geiser-chicken--compile-or-load (not geiser-chicken-compile-geiser-p)))
 313
 314 \f
 315 ;;; Implementation definition:
 316
 317 (define-geiser-implementation chicken
 318   (unsupported-procedures '(callers callees generic-methods))
 319   (binary geiser-chicken--binary)
 320   (arglist geiser-chicken--parameters)
 321   (version-command geiser-chicken--version)
 322   (minimum-version geiser-chicken-minimum-version)
 323   (repl-startup geiser-chicken--startup)
 324   (prompt-regexp geiser-chicken--prompt-regexp)
 325   (debugger-prompt-regexp nil)
 326   (enter-debugger nil)
 327   (marshall-procedure geiser-chicken--geiser-procedure)
 328   (find-module geiser-chicken--get-module)
 329   (enter-command geiser-chicken--enter-command)
 330   (exit-command geiser-chicken--exit-command)
 331   (import-command geiser-chicken--import-command)
 332   (find-symbol-begin geiser-chicken--symbol-begin)
 333   (display-error geiser-chicken--display-error)
 334   (external-help geiser-chicken--external-help)
 335   (check-buffer geiser-chicken--guess)
 336   (keywords geiser-chicken--keywords)
 337   (case-sensitive geiser-chicken-case-sensitive-p))
 338
 339 (geiser-impl--add-to-alist 'regexp "\\.scm$" 'chicken t)
 340 (geiser-impl--add-to-alist 'regexp "\\.release-info$" 'chicken t)
 341 (geiser-impl--add-to-alist 'regexp "\\.meta$" 'chicken t)
 342 (geiser-impl--add-to-alist 'regexp "\\.setup$" 'chicken t)
 343
 344 (provide 'geiser-chicken)