;; Copyright (C) 2009 Nikolaj Schumacher
;;
;; Author: Nikolaj Schumacher <bugs * nschum de>
-;; Version: 0.1.5
+;; Version: 0.2.1
;; Keywords: abbrev, convenience, matchis
;; URL: http://nschum.de/src/emacs/company/
;; Compatibility: GNU Emacs 22.x, GNU Emacs 23.x
;; ('candidates (list "foobar" "foobaz" "foobarbaz"))
;; ('meta (format "This value is named %s" arg))))
;;
+;; Sometimes it is a good idea to mix two back-ends together, for example to
+;; enrich gtags with dabbrev text (to emulate local variables):
+;;
+;; (defun gtags-gtags-dabbrev-backend (command &optional arg &rest ignored)
+;; (case command
+;; (prefix (company-gtags 'prefix))
+;; (candidates (append (company-gtags 'candidates arg)
+;; (company-dabbrev 'candidates arg)))))
+;;
;; Known Issues:
;; When point is at the very end of the buffer, the pseudo-tooltip appears very
-;; wrong.
+;; wrong, unless company is allowed to temporarily insert a fake newline.
+;; This behavior is enabled by `company-end-of-buffer-workaround'.
;;
;;; Change Log:
;;
+;; 2009-04-05 (0.2.1)
+;; Improved Emacs Lisp back-end behavior for local variables.
+;; Added `company-elisp-detect-function-context' option.
+;; The mouse can now be used for selection.
+;;
+;; 2009-03-22 (0.2)
+;; Added `company-show-location'.
+;; Added etags back-end.
+;; Added work-around for end-of-buffer bug.
;; Added `company-filter-candidates'.
;; More local Lisp variables are now included in the candidates.
;;
(add-to-list 'debug-ignored-errors "^Preview frontend cannot be used twice$")
(add-to-list 'debug-ignored-errors "^Echo area cannot be used twice$")
(add-to-list 'debug-ignored-errors "^No documentation available$")
+(add-to-list 'debug-ignored-errors "^No location available$")
(add-to-list 'debug-ignored-errors "^Company not enabled$")
(add-to-list 'debug-ignored-errors "^Company not in search mode$")
(add-to-list 'debug-ignored-errors "^No candidate number ")
"*Face used for the selection in the tool tip."
:group 'company)
+(defface company-tooltip-mouse
+ '((default :inherit highlight))
+ "*Face used for the tool tip item under the mouse."
+ :group 'company)
+
(defface company-tooltip-common
'((t :inherit company-tooltip
:foreground "red"))
"*Face used for the common part of the completion preview."
:group 'company)
+(defface company-preview-search
+ '((t :inherit company-preview
+ :background "blue1"))
+ "*Face used for the search string in the completion preview."
+ :group 'company)
+
(defface company-echo nil
"*Face used for completions in the echo area."
:group 'company)
(set variable value))
(defcustom company-frontends '(company-pseudo-tooltip-unless-just-one-frontend
- company-preview-if-just-one-frontend
+ company-preview-frontend
company-echo-metadata-frontend)
"*The list of active front-ends (visualizations).
Each front-end is a function that takes one argument. It is called with
(function :tag "custom function" nil))))
(defcustom company-backends '(company-elisp company-nxml company-css
- company-semantic company-gtags company-oddmuse
- company-files company-dabbrev)
+ company-semantic company-gtags company-etags
+ company-oddmuse company-files company-dabbrev)
"*The list of active back-ends (completion engines).
Each back-end is a function that takes a variable number of arguments.
The first argument is the command requested from the back-end. It is one
create a buffer (preferably with `company-doc-buffer'), fill it with
documentation and return it.
+'location: The second argument is a completion candidate. The back-end can
+return the cons of buffer and buffer location, or of file and line
+number where the completion candidate was defined.
+
The back-end should return nil for all commands it does not support or
does not know about."
:group 'company
:type '(choice (const :tag "off" nil)
(const :tag "on" t)))
+(defvar company-end-of-buffer-workaround t
+ "*Work around a visualization bug when completing at the end of the buffer.
+The work-around consists of adding a newline.")
+
;;; mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar company-mode-map (make-sparse-keymap)
(define-key keymap (kbd "M-p") 'company-select-previous)
(define-key keymap (kbd "<down>") 'company-select-next)
(define-key keymap (kbd "<up>") 'company-select-previous)
+ (define-key keymap [down-mouse-1] 'ignore)
+ (define-key keymap [down-mouse-3] 'ignore)
+ (define-key keymap [mouse-1] 'company-complete-mouse)
+ (define-key keymap [mouse-3] 'company-select-mouse)
+ (define-key keymap [up-mouse-1] 'ignore)
+ (define-key keymap [up-mouse-3] 'ignore)
(define-key keymap "\C-m" 'company-complete-selection)
(define-key keymap "\t" 'company-complete-common)
(define-key keymap (kbd "<f1>") 'company-show-doc-buffer)
+ (define-key keymap "\C-w" 'company-show-location)
(define-key keymap "\C-s" 'company-search-candidates)
(define-key keymap "\C-\M-s" 'company-filter-candidates)
(dotimes (i 10)
called before `company-idle-delay', completion will also start.
Completions can be searched with `company-search-candidates' or
-`company-filter-candidates'.
+`company-filter-candidates'. These can be used while completion is
+inactive, as well.
The completion data is retrieved using `company-backends' and displayed using
`company-frontends'.
(defvar company-timer nil)
+(defvar company-added-newline nil)
+(make-variable-buffer-local 'company-added-newline)
+
(defsubst company-strip-prefix (str)
(substring str (length company-prefix)))
(unless (funcall company-backend 'sorted)
(setq candidates (sort candidates 'string<)))
candidates)))
+ (unless company-candidates-cache
+ (company-call-frontends 'show))
(unless (assoc prefix company-candidates-cache)
(push (cons prefix company-candidates) company-candidates-cache))
company-candidates)
(unless company-candidates
(let (prefix)
(dolist (backend company-backends)
- (and (fboundp backend)
- (setq prefix (funcall backend 'prefix))
- (company-should-complete prefix)
- (setq company-backend backend)
- (company-calculate-candidates prefix))
- (return prefix)))))
+ (when (and (fboundp backend)
+ (setq prefix (funcall backend 'prefix)))
+ (setq company-backend backend)
+ (when (company-should-complete prefix)
+ (company-calculate-candidates prefix))
+ (return prefix))))))
(if company-candidates
(progn
+ (when (and company-end-of-buffer-workaround (eobp))
+ (save-excursion (insert "\n"))
+ (setq company-added-newline (buffer-chars-modified-tick)))
(setq company-point (point))
(company-enable-overriding-keymap company-active-map)
(company-call-frontends 'update))
(company-cancel)))
(defun company-cancel ()
- (setq company-backend nil
+ (and company-added-newline
+ (> (point-max) (point-min))
+ (let ((tick (buffer-chars-modified-tick)))
+ (delete-region (1- (point-max)) (point-max))
+ (equal tick company-added-newline))
+ ;; Only set unmodified when tick remained the same since insert.
+ (set-buffer-modified-p nil))
+ (setq company-added-newline nil
+ company-backend nil
company-prefix nil
company-candidates nil
company-candidates-length nil
;; Don't start again, unless started manually.
(setq company-point (point)))
+(defsubst company-keep (command)
+ (and (symbolp command) (get command 'company-keep)))
+
(defun company-pre-command ()
- (unless (eq this-command 'company-show-doc-buffer)
+ (unless (company-keep this-command)
(condition-case err
(when company-candidates
(company-call-frontends 'pre-command))
(company-uninstall-map))
(defun company-post-command ()
- (unless (eq this-command 'company-show-doc-buffer)
+ (unless (company-keep this-command)
(condition-case err
(progn
(unless (equal (point) company-point)
candidate))
`(string-match ,company-search-string candidate))))
(company-update-candidates
- (company-apply-predicate company-candidates company-candidates-predicate)))
+ (company-apply-predicate company-candidates company-candidates-predicate))
+ ;; Invalidate cache.
+ (setq company-candidates-cache (cons company-prefix company-candidates)))
(defun company-filter-printing-char ()
(interactive)
(when (company-manual-begin)
(company-set-selection (1- company-selection))))
+(defun company-select-mouse (event)
+ "Select the candidate picked by the mouse."
+ (interactive "e")
+ (when (nth 4 (event-start event))
+ (company-set-selection (- (cdr (posn-col-row (event-start event)))
+ (cdr (posn-col-row (posn-at-point)))
+ 1))
+ t))
+
+(defun company-complete-mouse (event)
+ "Complete the candidate picked by the mouse."
+ (interactive "e")
+ (when (company-select-mouse event)
+ (company-complete-selection)))
+
(defun company-complete-selection ()
"Complete the selected candidate."
(interactive)
(erase-buffer)
(current-buffer)))
+(defmacro company-electric (&rest body)
+ (declare (indent 0) (debug t))
+ `(if company-mode
+ (when (company-manual-begin)
+ (save-window-excursion
+ (let ((height (window-height))
+ (row (cdr (posn-col-row (posn-at-point)))))
+ ,@body
+ (and (< (window-height) height)
+ (< (- (window-height) row 2) company-tooltip-limit)
+ (recenter (- (window-height) row 2)))
+ (while (eq 'scroll-other-window
+ (key-binding (vector (list (read-event)))))
+ (call-interactively 'scroll-other-window))
+ (when last-input-event
+ (clear-this-command-keys t)
+ (setq unread-command-events (list last-input-event))))))
+ (error "Company not enabled")))
+
(defun company-show-doc-buffer ()
"Temporarily show a buffer with the complete documentation for the selection."
(interactive)
- (unless company-mode (error "Company not enabled"))
- (when (company-manual-begin)
- (save-window-excursion
- (let* ((height (window-height))
- (row (cdr (posn-col-row (posn-at-point))))
- (selected (nth company-selection company-candidates))
- (buffer (funcall company-backend 'doc-buffer selected)))
- (if (not buffer)
- (error "No documentation available.")
- (display-buffer buffer)
- (and (< (window-height) height)
- (< (- (window-height) row 2) company-tooltip-limit)
- (recenter (- (window-height) row 2)))
- (while (eq 'scroll-other-window
- (key-binding (vector (list (read-event)))))
- (scroll-other-window))
- (when last-input-event
- (clear-this-command-keys t)
- (setq unread-command-events (list last-input-event))))))))
+ (company-electric
+ (let ((selected (nth company-selection company-candidates)))
+ (display-buffer (or (funcall company-backend 'doc-buffer selected)
+ (error "No documentation available")) t))))
+(put 'company-show-doc-buffer 'company-keep t)
+
+(defun company-show-location ()
+ "Temporarily display a buffer showing the selected candidate in context."
+ (interactive)
+ (company-electric
+ (let* ((selected (nth company-selection company-candidates))
+ (location (funcall company-backend 'location selected))
+ (pos (or (cdr location) (error "No location available")))
+ (buffer (or (and (bufferp (car location)) (car location))
+ (find-file-noselect (car location) t))))
+ (with-selected-window (display-buffer buffer t)
+ (if (bufferp (car location))
+ (goto-char pos)
+ (goto-line pos))
+ (set-window-start nil (point))))))
+(put 'company-show-location 'company-keep t)
;;; pseudo-tooltip ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defun company-fill-propertize (line width selected)
(setq line (company-safe-substring line 0 width))
- (add-text-properties 0 width (list 'face 'company-tooltip) line)
+ (add-text-properties 0 width '(face company-tooltip
+ mouse-face company-tooltip-mouse)
+ line)
(add-text-properties 0 (length company-common)
- (list 'face 'company-tooltip-common) line)
+ '(face company-tooltip-common
+ mouse-face company-tooltip-mouse)
+ line)
(when selected
(if (and company-search-string
(string-match (regexp-quote company-search-string) line
(length company-prefix)))
(progn
(add-text-properties (match-beginning 0) (match-end 0)
- '(face company-tooltip-selection) line)
+ '(face company-tooltip-selection)
+ line)
(when (< (match-beginning 0) (length company-common))
(add-text-properties (match-beginning 0) (length company-common)
'(face company-tooltip-common-selection)
line)))
- (add-text-properties 0 width '(face company-tooltip-selection) line)
+ (add-text-properties 0 width '(face company-tooltip-selection
+ mouse-face company-tooltip-selection)
+ line)
(add-text-properties 0 (length company-common)
- (list 'face 'company-tooltip-common-selection)
+ '(face company-tooltip-common-selection
+ mouse-face company-tooltip-selection)
line)))
line)
(setq company-preview-overlay (make-overlay pos pos))
- (let ((completion (company-strip-prefix (nth company-selection
- company-candidates))))
+ (let ((completion(nth company-selection company-candidates)))
+ (setq completion (propertize completion 'face 'company-preview))
+ (add-text-properties 0 (length company-common)
+ '(face company-preview-common) completion)
+
+ ;; Add search string
+ (and company-search-string
+ (string-match (regexp-quote company-search-string) completion)
+ (add-text-properties (match-beginning 0)
+ (match-end 0)
+ '(face company-preview-search)
+ completion))
+
+ (setq completion (company-strip-prefix completion))
+
(and (equal pos (point))
(not (equal completion ""))
(add-text-properties 0 1 '(cursor t) completion))
- (setq completion (propertize completion 'face 'company-preview))
- (add-text-properties 0 (- (length company-common) (length company-prefix))
- '(face company-preview-common) completion)
-
(overlay-put company-preview-overlay 'after-string completion)
(overlay-put company-preview-overlay 'window (selected-window))))