Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

590 lines (522 sloc) 22.441 kb
;;; helm-elisp.el --- Elisp symbols completion for helm.
;; Copyright (C) 2012 Thierry Volpiatto <>
;; This program 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.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <>.
;;; Code:
(eval-when-compile (require 'cl))
(require 'helm)
(require 'helm-utils)
(require 'helm-info)
(require 'helm-eval)
(require 'advice)
(defgroup helm-elisp nil
"Elisp related Applications and libraries for Helm."
:group 'helm)
(defcustom helm-c-turn-on-show-completion t
"Display candidate in buffer while moving selection when non--nil."
:group 'helm-elisp
:type 'boolean)
(defcustom helm-c-show-completion-use-special-display t
"A special display will be used in lisp completion if non--nil.
All functions that are wrapped in macro `with-helm-show-completion'
will be affected."
:group 'helm-elisp
:type 'boolean)
(defcustom helm-c-show-completion-min-window-height 7
"Minimum completion window height used in show completion.
This is used in macro `with-helm-show-completion'."
:group 'helm-elisp
:type 'integer)
(defcustom helm-lisp-completion-or-indent-delay 0.6
"After this delay `helm-lisp-completion-counter' is reset to 0.
This allow to indent again without completing lisp symbol after this delay.
Default is 0.6 seconds."
:group 'helm-elisp
:type 'number)
;;; Faces
(defface helm-lisp-show-completion
'((t (:background "DarkSlateGray")))
"Face used for showing candidates in `helm-lisp-completion'."
:group 'helm-elisp)
(defface helm-lisp-completion-info
'((t (:foreground "red")))
"Face used for showing info in `helm-lisp-completion'."
:group 'helm-elisp)
;;; Show completion.
;; Provide show completion with macro `with-helm-show-completion'.
(defvar helm-c-show-completion-overlay nil)
;; Called each time cursor move in helm-buffer.
(defun helm-c-show-completion ()
(overlay-put helm-c-show-completion-overlay
'display (helm-get-selection))))
(defun helm-c-show-completion-init-overlay (beg end)
(and helm-c-turn-on-show-completion
(setq helm-c-show-completion-overlay (make-overlay beg end))
(overlay-put helm-c-show-completion-overlay
'face 'helm-lisp-show-completion)))
(defun helm-c-show-completion-display-function (buffer)
"A special resized helm window is used depending on position in BUFFER."
(with-selected-window (selected-window)
(let* ((screen-size (+ (count-screen-lines (window-start) (point) t)
1 ; mode-line
(if header-line-format 1 0))) ; header-line
(def-size (- (window-height)
(upper-height (max window-min-height (min screen-size def-size)))
(recenter -1)
(set-window-buffer (if (active-minibuffer-window)
(split-window nil upper-height))
(defmacro with-helm-show-completion (beg end &rest body)
"Show helm candidate in an overlay at point.
BEG and END are the beginning and end position of the current completion
in `helm-current-buffer'.
BODY is an helm call where we want to enable show completion.
If `helm-c-turn-on-show-completion' is nil just do nothing."
(declare (indent 2) (debug t))
`(let ((helm-move-selection-after-hook
(and helm-c-turn-on-show-completion
(append (list 'helm-c-show-completion)
(helm-c-show-completion-init-overlay ,beg ,end)
(let ((helm-display-function
(if helm-c-show-completion-use-special-display
(and helm-c-turn-on-show-completion
(delete-overlay helm-c-show-completion-overlay)))))
;;; Lisp symbol completion.
(defun helm-lisp-completion-at-point ()
"Helm lisp symbol completion at point."
(let* ((data (lisp-completion-at-point))
(beg (car data))
(end (point)) ; 'cadr data' is wrong when no space after point.
(plist (nthcdr 3 data))
(pred (plist-get plist :predicate))
(lgst-len 0)
(target (and beg end (buffer-substring-no-properties beg end)))
(candidates (and data (all-completions target (nth 2 data) pred)))
(helm-quit-if-no-candidate t)
(helm-execute-action-at-once-if-one t)
(member 'helm-compile-source--match-plugin
(if candidates
(with-helm-show-completion beg end
;; Overlay is initialized now in helm-current-buffer.
'((name . "Lisp completion")
(init . (lambda ()
(with-current-buffer (helm-candidate-buffer 'global)
(loop for sym in candidates
for len = (length sym)
when (> len lgst-len) do (setq lgst-len len)
do (insert (concat sym "\n"))))))
(persistent-action . helm-lisp-completion-persistent-action)
(persistent-help . "Show brief doc in mode-line")
(filtered-candidate-transformer helm-lisp-completion-transformer)
(action . (lambda (candidate)
(delete-region beg end)
(insert candidate))))
:input (if helm-match-plugin-enabled (concat target " ") target)
:resume 'noresume))
(message "[No Match]"))))
(defun helm-lisp-completion-persistent-action (candidate)
(let ((cursor-in-echo-area t)
(intern candidate))
'face 'helm-lisp-completion-info))))
(defun helm-lisp-completion-transformer (candidates source)
"Helm candidates transformer for lisp completion."
(declare (special lgst-len))
(loop for c in candidates
for sym = (intern c)
for annot = (cond ((commandp sym) " (Com)")
((fboundp sym) " (Fun)")
((boundp sym) " (Var)")
((facep sym) " (Face)"))
for spaces = (make-string (- lgst-len (length c)) ? )
collect (cons (concat c spaces annot) c)))
(defun helm-c-get-first-line-documentation (sym)
"Return first line documentation of symbol SYM.
If SYM is not documented, return \"Not documented\"."
(let ((doc (cond ((fboundp sym)
(documentation sym t))
((boundp sym)
(documentation-property sym 'variable-documentation t))
((facep sym)
(face-documentation sym))
(t nil))))
(if (and doc (not (string= doc ""))
;; `documentation' return "\n\n(args...)"
;; for CL-style functions.
(not (string-match-p "^\n\n" doc)))
(car (split-string doc "\n"))
"Not documented")))
;;; File completion.
;; Complete file name at point.
(defun helm-c-thing-before-point ()
"Get symbol name before point."
(let ((beg (point)))
;; older regexp "\(\\|\\s-\\|^\\|\\_<\\|\r\\|'\\|#'"
(when (re-search-backward
"\\_<" (field-beginning nil nil (point-at-bol)) t)
(buffer-substring-no-properties beg (match-end 0))))))
(defun helm-c-complete-file-name-at-point ()
"Complete file name at point."
(let* ((tap (thing-at-point 'filename))
(init (and tap
(substring-no-properties tap))))
(end (point))
(beg (- (point) (length tap)))
(helm-quit-if-no-candidate t)
(helm-execute-action-at-once-if-one t)
(with-helm-show-completion beg end
(setq completion (helm-c-read-file-name "FileName: "
:initial-input init)))
(when (and completion (not (string= completion "")))
(delete-region beg end) (insert completion))))
;; Internal
(defvar helm-lisp-completion-counter 0)
(defun helm-lisp-completion-at-point-or-indent (arg)
"First call indent and second call complete lisp symbol.
The second call should happen before `helm-lisp-completion-or-indent-delay',
after this delay, next call will indent again.
After completion, next call is always indent.
See that like click and double mouse click.
One hit indent, two quick hits maybe indent and complete."
(interactive "P")
;; Be sure `indent-for-tab-command' will not try
;; to use `completion-at-point'.
(let ((tab-always-indent (if (eq tab-always-indent 'complete)
t tab-always-indent)))
(incf helm-lisp-completion-counter)
(if (> helm-lisp-completion-counter 1)
(indent-for-tab-command arg))
;; After `helm-lisp-completion-or-indent-delay' seconds
;; reset to 0.
(run-with-timer helm-lisp-completion-or-indent-delay nil
#'(lambda ()
(setq helm-lisp-completion-counter 0)))
;; Always reset to 0 at second hit.
(when (eq helm-lisp-completion-counter 2)
(setq helm-lisp-completion-counter 0)))))
(defun helm-lisp-completion-or-file-name-at-point ()
"Complete lisp symbol or filename at point.
Filename completion happen if string start after
a double quote or between."
(let* ((tap (thing-at-point 'filename)))
(if (and tap (save-excursion
(when (and ;; Allow completing symbols in docstrings
(not (search-backward "`" (point-at-bol) t))
(search-backward "\"" (point-at-bol) t))
(forward-char 1) (not (looking-at " ")))))
;;; Apropos
(defun helm-c-apropos-init (test default)
"Init candidates buffer for `helm-c-apropos' sources."
(with-current-buffer (helm-candidate-buffer 'global)
(goto-char (point-min))
(when (and default (stringp default)
;; Some defaults args result as
;; (symbol-name nil) == "nil".
;; e.g debug-on-entry.
(not (string= default "nil"))
(funcall test (intern default)))
(insert (concat default "\n")))
(loop with all = (all-completions "" obarray test)
for sym in all
unless (and default (eq sym default))
do (insert (concat sym "\n")))))
(defun helm-c-source-emacs-variables (&optional default)
`((name . "Variables")
(init . (lambda ()
(helm-c-apropos-init 'boundp ,default)))
(persistent-action . helm-lisp-completion-persistent-action)
(persistent-help . "Show brief doc in mode-line")
(action . (("Describe Variable" . helm-c-describe-variable)
("Find Variable" . helm-c-find-variable)))))
(defun helm-c-source-emacs-faces (&optional default)
`((name . "Faces")
(init . (lambda ()
(helm-c-apropos-init 'facep ,default)))
(persistent-action . helm-lisp-completion-persistent-action)
(persistent-help . "Show brief doc in mode-line")
(filtered-candidate-transformer . (lambda (candidates source)
(loop for c in candidates
collect (propertize c 'face (intern c)))))
(action . (lambda (candidate)
(describe-face (intern candidate))))))
(defun helm-c-source-helm-attributes (&optional default)
`((name . "Helm attributes")
(candidates . (lambda ()
(mapcar 'symbol-name helm-additional-attributes)))
(action . (lambda (candidate)
(with-output-to-temp-buffer "*Help*"
(princ (get (intern candidate) 'helm-attrdoc)))))))
(defun helm-c-source-emacs-commands (&optional default)
`((name . "Commands")
(init . (lambda ()
(helm-c-apropos-init 'commandp ,default)))
(persistent-action . helm-lisp-completion-persistent-action)
(persistent-help . "Show brief doc in mode-line")
(action . (("Describe Function" . helm-c-describe-function)
("Find Function" . helm-c-find-function)))))
(defun helm-c-source-emacs-functions (&optional default)
`((name . "Functions")
(init . (lambda ()
(helm-c-apropos-init #'(lambda (x) (and (fboundp x)
(not (commandp x))))
(persistent-action . helm-lisp-completion-persistent-action)
(persistent-help . "Show brief doc in mode-line")
(action . (("Describe Function" . helm-c-describe-function)
("Find Function" . helm-c-find-function)))))
(defun helm-c-apropos ()
"Preconfigured helm to describe commands, functions, variables and faces."
(let ((default (thing-at-point 'symbol)))
(helm :sources
(mapcar (lambda (func)
(funcall func default))
;;; Advices
(defvar helm-c-source-advice
'((name . "Function Advice")
(candidates . helm-c-advice-candidates)
(action ("Toggle Enable/Disable" . helm-c-advice-toggle))
(persistent-action . helm-c-advice-persistent-action)
(persistent-help . "Describe function / C-u C-z: Toggle advice")))
(defun helm-c-advice-candidates ()
(loop for (fname) in ad-advised-functions
for function = (intern fname)
(loop for class in ad-advice-classes append
(loop for advice in (ad-get-advice-info-field function class)
for enabled = (ad-advice-enabled advice)
(cons (format
"%s %s %s"
(if enabled "Enabled " "Disabled")
(propertize fname 'face 'font-lock-function-name-face)
(ad-make-single-advice-docstring advice class nil))
(list function class advice))))))
(defun helm-c-advice-persistent-action (func-class-advice)
(if current-prefix-arg
(helm-c-advice-toggle func-class-advice)
(describe-function (car func-class-advice))))
(defun helm-c-advice-toggle (func-class-advice)
(destructuring-bind (function class advice) func-class-advice
(cond ((ad-advice-enabled advice)
(ad-advice-set-enabled advice nil)
(message "Disabled"))
(t ;disabled
(ad-advice-set-enabled advice t)
(message "Enabled")))
(ad-activate function)
(and helm-in-persistent-action
(defun helm-c-advice-update-current-display-string ()
(let ((newword (cond ((looking-at "Disabled") "Enabled")
((looking-at "Enabled") "Disabled")))
(when newword
(delete-region (point) (progn (forward-word 1) (point)))
(insert newword)))))
(defun helm-manage-advice ()
"Preconfigured `helm' to disable/enable function advices."
(helm-other-buffer 'helm-c-source-advice "*helm advice*"))
;;; Elisp library scan
(defvar helm-c-source-elisp-library-scan
'((name . "Elisp libraries (Scan)")
(init . (helm-c-elisp-library-scan-init))
(action ("Find library"
. (lambda (candidate) (find-file (find-library-name candidate))))
("Find library other window"
. (lambda (candidate)
(find-file-other-window (find-library-name candidate))))
("Load library"
. (lambda (candidate) (load-library candidate))))))
(defun helm-c-elisp-library-scan-init ()
"Init helm buffer status."
(let ((helm-buffer (helm-candidate-buffer 'global))
(library-list (helm-c-elisp-library-scan-list)))
(with-current-buffer helm-buffer
(dolist (library library-list)
(insert (format "%s\n" library))))))
(defun helm-c-elisp-library-scan-list (&optional dirs string)
"Do completion for file names passed to `locate-file'.
DIRS is directory to search path.
STRING is string to match."
;; Use `load-path' as path when ignore `dirs'.
(or dirs (setq dirs load-path))
;; Init with blank when ignore `string'.
(or string (setq string ""))
;; Get library list.
(let ((string-dir (file-name-directory string))
;; File regexp that suffix match `load-file-rep-suffixes'.
(match-regexp (format "^.*\\.el%s$" (regexp-opt load-file-rep-suffixes)))
(dolist (dir dirs)
(unless dir
(setq dir default-directory))
(if string-dir
(setq dir (expand-file-name string-dir dir)))
(when (file-directory-p dir)
(dolist (file (file-name-all-completions
(file-name-nondirectory string) dir))
;; Suffixes match `load-file-rep-suffixes'.
(setq name (if string-dir (concat string-dir file) file))
(if (string-match match-regexp name)
(add-to-list 'names name)))))
(defun helm-c-set-variable (var)
"Set value to VAR interactively."
(let ((sym (helm-c-symbolify var)))
(set sym (eval-minibuffer (format "Set %s: " var)
(prin1-to-string (symbol-value sym))))))
;;; Type attributes
(let ((actions '(("Describe command" . describe-function)
("Add command to kill ring" . helm-c-kill-new)
("Go to command's definition" . find-function)
("Debug on entry" . debug-on-entry)
("Cancel debug on entry" . cancel-debug-on-entry)
("Trace function" . trace-function)
("Trace function (background)" . trace-function-background)
("Untrace function" . untrace-function))))
(define-helm-type-attribute 'command
`((action ("Call interactively" . helm-c-call-interactively)
(coerce . helm-c-symbolify)
(persistent-action . describe-function))
"Command. (string or symbol)")
(define-helm-type-attribute 'function
`((action . ,actions)
(action-transformer helm-c-transform-function-call-interactively)
(candidate-transformer helm-c-mark-interactive-functions)
(coerce . helm-c-symbolify))
"Function. (string or symbol)"))
(define-helm-type-attribute 'variable
'((action ("Describe variable" . describe-variable)
("Add variable to kill ring" . helm-c-kill-new)
("Go to variable's definition" . find-variable)
("Set variable" . helm-c-set-variable))
(coerce . helm-c-symbolify))
(define-helm-type-attribute 'timer
'((real-to-display . helm-c-timer-real-to-display)
(action ("Cancel Timer" . cancel-timer)
("Describe Function" . (lambda (tm) (describe-function (timer--function tm))))
("Find Function" . (lambda (tm) (find-function (timer--function tm)))))
(persistent-action . (lambda (tm) (describe-function (timer--function tm))))
(persistent-help . "Describe Function"))
;;; Elisp Timers.
(defvar helm-c-source-absolute-time-timers
'((name . "Absolute Time Timers")
(candidates . timer-list)
(type . timer)))
(defvar helm-c-source-idle-time-timers
'((name . "Idle Time Timers")
(candidates . timer-idle-list)
(type . timer)))
(defun helm-c-timer-real-to-display (timer)
(format "%s repeat=%5S %s(%s)"
(let ((time (timer--time timer)))
(if (timer--idle-delay timer)
(format-time-string "idle-for=%5s" time)
(format-time-string "%m/%d %T" time)))
(timer--repeat-delay timer)
(timer--function timer)
(mapconcat 'prin1-to-string (timer--args timer) " ")))
(defun helm-timers ()
"Preconfigured `helm' for timers."
(helm-other-buffer '(helm-c-source-absolute-time-timers
"*helm timers*"))
;;; Complex command history
(defvar helm-c-source-complex-command-history
'((name . "Complex Command History")
(candidates . (lambda () (mapcar 'prin1-to-string command-history)))
(type . sexp)))
(defun helm-complex-command-history ()
(helm :sources 'helm-c-source-complex-command-history
:buffer "*helm complex commands*"))
(provide 'helm-elisp)
;; Local Variables:
;; byte-compile-warnings: (not cl-functions obsolete)
;; coding: utf-8
;; indent-tabs-mode: nil
;; byte-compile-dynamic: t
;; End:
;;; helm-elisp.el ends here
Jump to Line
Something went wrong with that request. Please try again.