branch: elpa/inf-clojure
commit 3e27093ca39964a1d6f142f00e2ff8bd5497a2eb
Author: Bozhidar Batsov <bozhi...@tradeo.com>
Commit: Bozhidar Batsov <bozhi...@tradeo.com>
Initial commit
---
README.md | 57 +++++++
inf-clojure.el | 479 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 536 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37b1753
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+[![License GPL 3][badge-license]][copying]
+[![MELPA][melpa-badge]][melpa-package]
+[![MELPA Stable][melpa-stable-badge]][melpa-stable-package]
+
+# Inf Clojure
+
+This package provides basic interaction with a Clojure subprocess (REPL).
+
+For a more powerful/full-featured solution see [CIDER][].
+
+## Installation
+
+Available on all major `package.el` community maintained repos - [MELPA
Stable][],
+[MELPA][] and [Marmalade][] repos.
+
+MELPA Stable and Marmalade are recommended as they have the latest stable
version.
+MELPA has a development snapshot for users who don't mind breakage but
+don't want to run from a git checkout.
+
+You can install `inf-clojure` using the following command:
+
+<kbd>M-x package-install [RET] inf-clojure [RET]</kbd>
+
+or if you'd rather keep it in your dotfiles:
+
+```el
+(unless (package-installed-p 'inf-clojure)
+ (package-refresh-contents))
+```
+
+If the installation doesn't work try refreshing the package list:
+
+<kbd>M-x package-refresh-contents</kbd>
+
+## Usage
+
+`M-x inf-clojure` or `C-c C-z` within a Clojure source file.
+
+## License
+
+Copyright © 2014 Bozhidar Batsov and [contributors][].
+
+Distributed under the GNU General Public License; type <kbd>C-h C-c</kbd> to
view it.
+
+[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
+[melpa-badge]: http://melpa.org/packages/inf-clojure-badge.svg
+[melpa-stable-badge]: http://stable.melpa.org/packages/inf-clojure-badge.svg
+[melpa-package]: http://melpa.org/#/inf-clojure
+[melpa-stable-package]: http://stable.melpa.org/#/inf-clojure
+[marmalade]: https://marmalade-repo.org
+[COPYING]: http://www.gnu.org/copyleft/gpl.html
+[badge-travis]:
https://travis-ci.org/clojure-emacs/inf-clojure.svg?branch=master
+[CIDER]: https://github.com/clojure-emacs/cider
+[Leiningen]: http://leiningen.org
+[contributors]: https://github.com/clojure-emacs/inf-clojure/contributors
+[melpa]: http://melpa.org
+[melpa stable]: http://stable.melpa.org
diff --git a/inf-clojure.el b/inf-clojure.el
new file mode 100644
index 0000000..18b0140
--- /dev/null
+++ b/inf-clojure.el
@@ -0,0 +1,479 @@
+;;; inf-clojure.el --- an inferior-clojure mode
+
+;; Copyright (C) Bozhidar Batsov
+
+;; Authors: Bozhidar Batsov <bozhi...@batsov.com>
+;; Olin Shivers <shiv...@cs.cmu.edu>
+;; Keywords: processes, clojure
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; inf-lisp adapted for Clojure.
+
+;;; Code:
+
+(require 'comint)
+(require 'clojure-mode)
+
+
+(defgroup inf-clojure nil
+ "Run an outside Clojure in an Emacs buffer."
+ :group 'clojure)
+
+(defcustom inf-clojure-prompt-read-only t
+ "If non-nil, the prompt will be read-only.
+
+Also see the description of `ielm-prompt-read-only'."
+ :type 'boolean
+ :group 'inf-clojure)
+
+(defcustom inf-clojure-filter-regexp
+ "\\`\\s *\\(:\\(\\w\\|\\s_\\)\\)?\\s *\\'"
+ "What not to save on inferior Clojure's input history.
+Input matching this regexp is not saved on the input history in Inferior
Clojure
+mode. Default is whitespace followed by 0 or 1 single-letter colon-keyword
+\(as in :a, :c, etc.)"
+ :type 'regexp
+ :group 'inf-clojure)
+
+(defvar inf-clojure-mode-map
+ (let ((map (copy-keymap comint-mode-map)))
+ (define-key map "\C-x\C-e" 'clojure-eval-last-sexp)
+ (define-key map "\C-c\C-l" 'clojure-load-file)
+ (define-key map "\C-c\C-a" 'clojure-show-arglist)
+ (define-key map "\C-c\C-v" 'clojure-show-var-documentation)
+ map))
+
+(easy-menu-define
+ inf-clojure-menu
+ inf-clojure-mode-map
+ "Inferior Clojure Menu"
+ '("Inf-Clojure"
+ ["Eval Last Sexp" clojure-eval-last-sexp t]
+ "--"
+ ["Load File..." clojure-load-file t]
+ "--"
+ ["Show Arglist..." clojure-show-arglist t]
+ ["Describe Symbol..." clojure-describe-sym t]
+ ["Show Documentation for Function..." clojure-show-function-documentation
t]
+ ["Show Documentation for Variable..." clojure-show-variable-documentation
t]))
+
+;;; These commands augment Clojure mode, so you can process Clojure code in
+;;; the source files.
+(define-key clojure-mode-map "\M-\C-x" 'clojure-eval-defun) ; Gnu
convention
+(define-key clojure-mode-map "\C-x\C-e" 'clojure-eval-last-sexp) ; Gnu
convention
+(define-key clojure-mode-map "\C-c\C-e" 'clojure-eval-defun)
+(define-key clojure-mode-map "\C-c\C-r" 'clojure-eval-region)
+(define-key clojure-mode-map "\C-c\C-n" 'clojure-eval-form-and-next)
+(define-key clojure-mode-map "\C-c\C-p" 'clojure-eval-paragraph)
+(define-key clojure-mode-map "\C-c\C-z" 'switch-to-clojure)
+(define-key clojure-mode-map "\C-c\C-l" 'clojure-load-file)
+(define-key clojure-mode-map "\C-c\C-a" 'clojure-show-arglist)
+(define-key clojure-mode-map "\C-c\C-d" 'clojure-describe-sym)
+(define-key clojure-mode-map "\C-c\C-f" 'clojure-show-function-documentation)
+(define-key clojure-mode-map "\C-c\C-v" 'clojure-show-variable-documentation)
+
+(defcustom inf-clojure-program "lein repl"
+ "Program name for invoking an inferior Clojure in Inferior Clojure mode."
+ :type 'string
+ :group 'inf-clojure)
+
+(defcustom inf-clojure-load-command "(clojure.core/load-file \"%s\")\n"
+ "Format-string for building a Clojure expression to load a file.
+This format string should use `%s' to substitute a file name
+and should result in a Clojure expression that will command the inferior
Clojure
+to load that file.~"
+ :type 'string
+ :group 'inf-clojure)
+
+(defcustom inf-clojure-prompt "^[^=> \n]+=> *"
+ "Regexp to recognize prompts in the Inferior Clojure mode."
+ :type 'regexp
+ :group 'inf-clojure)
+
+(defvar inf-clojure-buffer nil "The current inf-clojure process buffer.
+
+MULTIPLE PROCESS SUPPORT
+===========================================================================
+To run multiple Clojure processes, you start the first up
+with \\[inf-clojure]. It will be in a buffer named `*inf-clojure*'.
+Rename this buffer with \\[rename-buffer]. You may now start up a new
+process with another \\[inf-clojure]. It will be in a new buffer,
+named `*inf-clojure*'. You can switch between the different process
+buffers with \\[switch-to-buffer].
+
+Commands that send text from source buffers to Clojure processes --
+like `clojure-eval-defun' or `clojure-show-arglist' -- have to choose a process
+to send to, when you have more than one Clojure process around. This
+is determined by the global variable `inf-clojure-buffer'. Suppose you
+have three inferior Clojures running:
+ Buffer Process
+ foo inf-clojure
+ bar inf-clojure<2>
+ *inf-clojure* inf-clojure<3>
+If you do a \\[clojure-eval-defun] command on some Clojure source code,
+what process do you send it to?
+
+- If you're in a process buffer (foo, bar, or *inf-clojure*),
+ you send it to that process.
+- If you're in some other buffer (e.g., a source file), you
+ send it to the process attached to buffer `inf-clojure-buffer'.
+This process selection is performed by function `inf-clojure-proc'.
+
+Whenever \\[inf-clojure] fires up a new process, it resets
+`inf-clojure-buffer' to be the new process's buffer. If you only run
+one process, this does the right thing. If you run multiple
+processes, you might need to change `inf-clojure-buffer' to
+whichever process buffer you want to use.")
+
+(defvar inf-clojure-mode-hook '()
+ "Hook for customizing Inferior Clojure mode.")
+
+(put 'inf-clojure-mode 'mode-class 'special)
+
+(define-derived-mode inf-clojure-mode comint-mode "Inferior Clojure"
+ "Major mode for interacting with an inferior Clojure process.
+Runs a Clojure interpreter as a subprocess of Emacs, with Clojure I/O through
an
+Emacs buffer. Variable `inf-clojure-program' controls which Clojure
interpreter
+is run. Variables `inf-clojure-prompt', `inf-clojure-filter-regexp' and
+`inf-clojure-load-command' can customize this mode for different Clojure
+interpreters.
+
+For information on running multiple processes in multiple buffers, see
+documentation for variable `inf-clojure-buffer'.
+
+\\{inf-clojure-mode-map}
+
+Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
+`inf-clojure-mode-hook' (in that order).
+
+You can send text to the inferior Clojure process from other buffers containing
+Clojure source.
+ `switch-to-clojure' switches the current buffer to the Clojure process
buffer.
+ `clojure-eval-defun' sends the current defun to the Clojure process.
+ `clojure-eval-region' sends the current region to the Clojure process.
+
+ Prefixing the clojure-eval/defun/region commands with
+ a \\[universal-argument] causes a switch to the Clojure process buffer
after sending
+ the text.
+
+Commands:\\<inf-clojure-mode-map>
+\\[comint-send-input] after the end of the process' output sends the text from
the
+ end of process to point.
+\\[comint-send-input] before the end of the process' output copies the sexp
ending at point
+ to the end of the process' output, and sends it.
+\\[comint-copy-old-input] copies the sexp ending at point to the end of the
process' output,
+ allowing you to edit it before sending it.
+If `comint-use-prompt-regexp' is nil (the default), \\[comint-insert-input] on
old input
+ copies the entire old input to the end of the process' output, allowing
+ you to edit it before sending it. When not used on old input, or if
+ `comint-use-prompt-regexp' is non-nil, \\[comint-insert-input] behaves
according to
+ its global binding.
+\\[backward-delete-char-untabify] converts tabs to spaces as it moves back.
+\\[clojure-indent-line] indents for Clojure; with argument, shifts rest
+ of expression rigidly with the current line.
+\\[indent-sexp] does \\[clojure-indent-line] on each line starting within
following expression.
+Paragraphs are separated only by blank lines. Semicolons start comments.
+If you accidentally suspend your process, use \\[comint-continue-subjob]
+to continue it."
+ (setq comint-prompt-regexp inf-clojure-prompt)
+ (setq mode-line-process '(":%s"))
+ (lisp-mode-variables nil)
+ (setq comint-get-old-input (function clojure-get-old-input))
+ (setq comint-input-filter (function clojure-input-filter))
+ (set (make-local-variable 'comint-prompt-read-only)
inf-clojure-prompt-read-only)
+ (add-hook 'completion-at-point-functions 'inf-clojure-completion-at-point
nil t))
+
+(defun clojure-get-old-input ()
+ "Return a string containing the sexp ending at point."
+ (save-excursion
+ (let ((end (point)))
+ (backward-sexp)
+ (buffer-substring (point) end))))
+
+(defun clojure-input-filter (str)
+ "t if STR does not match `inf-clojure-filter-regexp'."
+ (not (string-match inf-clojure-filter-regexp str)))
+
+;;;###autoload
+(defun inf-clojure (cmd)
+ "Run an inferior Clojure process, input and output via buffer
`*inf-clojure*'.
+If there is a process already running in `*inf-clojure*', just switch
+to that buffer.
+With argument, allows you to edit the command line (default is value
+of `inf-clojure-program'). Runs the hooks from
+`inf-clojure-mode-hook' (after the `comint-mode-hook' is run).
+\(Type \\[describe-mode] in the process buffer for a list of commands.)"
+ (interactive (list (if current-prefix-arg
+ (read-string "Run clojure: " inf-clojure-program)
+ inf-clojure-program)))
+ (if (not (comint-check-proc "*inf-clojure*"))
+ (let ((cmdlist (split-string cmd)))
+ (set-buffer (apply (function make-comint)
+ "inf-clojure" (car cmdlist) nil (cdr cmdlist)))
+ (inf-clojure-mode)))
+ (setq inf-clojure-buffer "*inf-clojure*")
+ (pop-to-buffer-same-window "*inf-clojure*"))
+
+;;;###autoload
+(defalias 'run-clojure 'inf-clojure)
+
+(defun clojure-eval-paragraph (&optional and-go)
+ "Send the current paragraph to the inferior Clojure process.
+Prefix argument means switch to the Clojure buffer afterwards."
+ (interactive "P")
+ (save-excursion
+ (mark-paragraph)
+ (clojure-eval-region (point) (mark) and-go)))
+
+(defun clojure-eval-region (start end &optional and-go)
+ "Send the current region to the inferior Clojure process.
+Prefix argument means switch to the Clojure buffer afterwards."
+ (interactive "r\nP")
+ (comint-send-region (inf-clojure-proc) start end)
+ (comint-send-string (inf-clojure-proc) "\n")
+ (if and-go (switch-to-clojure t)))
+
+(defun clojure-eval-string (string)
+ "Send the string to the inferior Clojure process to be executed."
+ (comint-send-string (inf-clojure-proc) (concat string "\n")))
+
+(defun clojure-do-defun (do-string do-region)
+ "Send the current defun to the inferior Clojure process.
+The actually processing is done by `do-string' and `do-region'
+ which determine whether the code is compiled before evaluation.
+DEFVAR forms reset the variables to the init values."
+ (save-excursion
+ (end-of-defun)
+ (skip-chars-backward " \t\n\r\f") ; Makes allegro happy
+ (let ((end (point)) (case-fold-search t))
+ (beginning-of-defun)
+ (funcall do-region (point) end))))
+
+(defun clojure-eval-defun (&optional and-go)
+ "Send the current defun to the inferior Clojure process.
+DEFVAR forms reset the variables to the init values.
+Prefix argument means switch to the Clojure buffer afterwards."
+ (interactive "P")
+ (clojure-do-defun 'clojure-eval-string 'clojure-eval-region)
+ (if and-go (switch-to-clojure t)))
+
+(defun clojure-eval-last-sexp (&optional and-go)
+ "Send the previous sexp to the inferior Clojure process.
+Prefix argument means switch to the Clojure buffer afterwards."
+ (interactive "P")
+ (clojure-eval-region (save-excursion (backward-sexp) (point)) (point)
and-go))
+
+(defun clojure-eval-form-and-next ()
+ "Send the previous sexp to the inferior Clojure process and move to the next
one."
+ (interactive "")
+ (while (not (zerop (car (syntax-ppss))))
+ (up-list))
+ (clojure-eval-last-sexp)
+ (forward-sexp))
+
+(defun switch-to-clojure (eob-p)
+ "Switch to the inferior Clojure process buffer.
+With argument, positions cursor at end of buffer."
+ (interactive "P")
+ (if (get-buffer-process inf-clojure-buffer)
+ (let ((pop-up-frames
+ ;; Be willing to use another frame
+ ;; that already has the window in it.
+ (or pop-up-frames
+ (get-buffer-window inf-clojure-buffer t))))
+ (pop-to-buffer inf-clojure-buffer))
+ (run-clojure inf-clojure-program))
+ (when eob-p
+ (push-mark)
+ (goto-char (point-max))))
+
+
+;;; Now that clojure-eval-/defun/region takes an optional prefix arg,
+;;; these commands are redundant. But they are kept around for the user
+;;; to bind if he wishes, for backwards functionality, and because it's
+;;; easier to type C-c e than C-u C-c C-e.
+
+(defun clojure-eval-region-and-go (start end)
+ "Send the current region to the inferior Clojure, and switch to its buffer."
+ (interactive "r")
+ (clojure-eval-region start end t))
+
+(defun clojure-eval-defun-and-go ()
+ "Send the current defun to the inferior Clojure, and switch to its buffer."
+ (interactive)
+ (clojure-eval-defun t))
+
+(defvar clojure-prev-l/c-dir/file nil
+ "Record last directory and file used in loading or compiling.
+This holds a cons cell of the form `(DIRECTORY . FILE)'
+describing the last `clojure-load-file' command.")
+
+(defcustom clojure-source-modes '(clojure-mode)
+ "Used to determine if a buffer contains Clojure source code.
+If it's loaded into a buffer that is in one of these major modes, it's
+considered a Clojure source file by `clojure-load-file' and
`clojure-compile-file'.
+Used by these commands to determine defaults."
+ :type '(repeat symbol)
+ :group 'inf-clojure)
+
+(defun clojure-load-file (file-name)
+ "Load a Clojure file into the inferior Clojure process."
+ (interactive (comint-get-source "Load Clojure file: "
clojure-prev-l/c-dir/file
+ clojure-source-modes nil)) ; nil because LOAD
+ ; doesn't need an exact name
+ (comint-check-source file-name) ; Check to see if buffer needs saved.
+ (setq clojure-prev-l/c-dir/file (cons (file-name-directory file-name)
+ (file-name-nondirectory file-name)))
+ (comint-send-string (inf-clojure-proc)
+ (format inf-clojure-load-command file-name))
+ (switch-to-clojure t))
+
+
+;;; Documentation functions: function doc, var doc, arglist, and
+;;; describe symbol.
+;;; ===========================================================================
+
+;;; Command strings
+;;; ===============
+
+(defvar clojure-var-doc-command
+ "(clojure.repl/doc %s)\n"
+ "Command to query inferior Clojure for a var's documentation.")
+
+(defvar clojure-arglist-command
+ "(:arglists (clojure.core/meta #'%s))\n"
+ "Command to query inferior Clojure for a function's arglist.")
+
+;;; Ancillary functions
+;;; ===================
+
+;;; Reads a string from the user.
+(defun clojure-symprompt (prompt default)
+ (list (let* ((prompt (if default
+ (format "%s (default %s): " prompt default)
+ (concat prompt ": ")))
+ (ans (read-string prompt)))
+ (if (zerop (length ans)) default ans))))
+
+
+;;; Adapted from function-called-at-point in help.el.
+(defun clojure-fn-called-at-pt ()
+ "Returns the name of the function called in the current call.
+The value is nil if it can't find one."
+ (condition-case nil
+ (save-excursion
+ (save-restriction
+ (narrow-to-region (max (point-min) (- (point) 1000)) (point-max))
+ (backward-up-list 1)
+ (forward-char 1)
+ (let ((obj (read (current-buffer))))
+ (and (symbolp obj) obj))))
+ (error nil)))
+
+
+;;; Adapted from variable-at-point in help.el.
+(defun clojure-var-at-pt ()
+ (condition-case ()
+ (save-excursion
+ (forward-sexp -1)
+ (skip-chars-forward "'")
+ (let ((obj (read (current-buffer))))
+ (and (symbolp obj) obj)))
+ (error nil)))
+
+
+;;; Documentation functions: var doc and arglist.
+;;; ======================================================================
+
+(defun clojure-show-var-documentation (var)
+ "Send a command to the inferior Clojure to give documentation for VAR.
+See variable `clojure-var-doc-command'."
+ (interactive (clojure-symprompt "Var doc" (clojure-var-at-pt)))
+ (comint-proc-query (inf-clojure-proc) (format clojure-var-doc-command var)))
+
+(defun clojure-show-arglist (fn)
+ "Send a query to the inferior Clojure for the arglist for function FN.
+See variable `clojure-arglist-command'."
+ (interactive (clojure-symprompt "Arglist" (clojure-fn-called-at-pt)))
+ (comint-proc-query (inf-clojure-proc) (format clojure-arglist-command fn)))
+
+
+;; "Returns the current inferior Clojure process.
+;; See variable `inf-clojure-buffer'."
+(defun inf-clojure-proc ()
+ (let ((proc (get-buffer-process (if (derived-mode-p 'inf-clojure-mode)
+ (current-buffer)
+ inf-clojure-buffer))))
+ (or proc
+ (error "No Clojure subprocess; see variable `inf-clojure-buffer'"))))
+
+(defun inf-clojure-completions (expr)
+ "Return a list of completions for the Clojure expression starting with EXPR."
+ (let* ((proc (inf-clojure-proc))
+ (line (buffer-substring (save-excursion (move-beginning-of-line 1)
+ (point))
+ (point)))
+ (comint-filt (process-filter proc))
+ (kept "")
+ completions)
+ (set-process-filter proc (lambda (proc string) (setq kept (concat kept
string))))
+ (unwind-protect
+ (let ((completion-snippet
+ (format
+ "(complete.core/completions \"%s\")\n"
(substring-no-properties expr))))
+ (process-send-string proc completion-snippet)
+ (while (and (not (string-match inf-clojure-prompt kept))
+ (accept-process-output proc 2)))
+ (setq completions (butlast (split-string kept "\r?\n") 2))
+ ;; Subprocess echoes output on Windows and OS X.
+ (when (and completions (string= (concat (car completions) "\n")
completion-snippet))
+ (setq completions (cdr completions))))
+ (set-process-filter proc comint-filt))
+ completions))
+
+(defconst inf-clojure-clojure-expr-break-chars " \t\n\"\'`><,;|&{(")
+
+(defun inf-clojure-completion-bounds-of-expr-at-point ()
+ "Return bounds of expression at point to complete."
+ (when (not (memq (char-syntax (following-char)) '(?w ?_)))
+ (save-excursion
+ (let ((end (point)))
+ (skip-chars-backward (concat "^" inf-clojure-clojure-expr-break-chars))
+ (cons (point) end)))))
+
+(defun inf-clojure-completion-expr-at-point ()
+ "Return expression at point to complete."
+ (let ((bounds (inf-clojure-completion-bounds-of-expr-at-point)))
+ (and bounds
+ (buffer-substring (car bounds) (cdr bounds)))))
+
+(defun inf-clojure-completion-at-point ()
+ "Retrieve the list of completions and prompt the user.
+Returns the selected completion or nil."
+ (let ((bounds (inf-clojure-completion-bounds-of-expr-at-point)))
+ (when bounds
+ (list (car bounds) (cdr bounds)
+ (if (fboundp 'completion-table-with-cache)
+ (completion-table-with-cache #'inf-clojure-completions)
+ (completion-table-dynamic #'inf-clojure-completions))))))
+
+
+(provide 'inf-clojure)
+
+;;; inf-clojure.el ends here
