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