1 ;;; company-files.el --- company-mode completion back-end for file paths
3 ;; Copyright (C) 2009-2011, 2014 Free Software Foundation, Inc.
5 ;; Author: Nikolaj Schumacher
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 (defun company-files--directory-files (dir prefix)
34 (directory-files dir nil "\\`[^.]\\|\\`.[^.]")
35 (file-name-all-completions prefix dir))))
37 (defvar company-files--regexps
38 (let* ((root (if (eq system-type 'windows-nt)
41 (begin (concat "\\(?:\\.\\{1,2\\}/\\|~/\\|" root "\\)")))
42 (list (concat "\"\\(" begin "[^\"\n]*\\)")
43 (concat "\'\\(" begin "[^\'\n]*\\)")
44 (concat "\\(?:[ \t]\\|^\\)\\(" begin "[^ \t\n]*\\)"))))
46 (defun company-files--grab-existing-name ()
47 ;; Grab the file name.
48 ;; When surrounded with quotes, it can include spaces.
50 (and (cl-dolist (regexp company-files--regexps)
51 (when (setq file (company-grab-line regexp 1))
53 (setq dir (file-name-directory file))
54 (not (string-match "//" dir))
56 (file-name-all-completions (file-name-nondirectory file) dir)
59 (defvar company-files--completion-cache nil)
61 (defun company-files--complete (prefix)
62 (let* ((dir (file-name-directory prefix))
63 (key (list (file-name-nondirectory prefix)
64 (expand-file-name dir)
65 (nth 5 (file-attributes dir))))
66 (file (file-name-nondirectory prefix))
67 (completion-ignore-case read-file-name-completion-ignore-case)
68 candidates directories)
69 (unless (company-file--keys-match-p key (car company-files--completion-cache))
70 (dolist (file (company-files--directory-files dir file))
71 (setq file (concat dir file))
72 (push file candidates)
73 (when (file-directory-p file)
74 (push file directories)))
75 (dolist (directory (reverse directories))
76 ;; Add one level of children.
77 (dolist (child (company-files--directory-files directory ""))
78 (push (concat directory
79 (unless (eq (aref directory (1- (length directory))) ?/) "/")
81 (setq company-files--completion-cache (cons key (nreverse candidates))))
82 (all-completions prefix
83 (cdr company-files--completion-cache))))
85 (defun company-file--keys-match-p (new old)
86 (and (equal (cdr old) (cdr new))
87 (string-prefix-p (car old) (car new))))
90 (defun company-files (command &optional arg &rest ignored)
91 "`company-mode' completion back-end existing file names.
92 Completions works for proper absolute and relative files paths.
93 File paths with spaces are only supported inside strings."
94 (interactive (list 'interactive))
96 (interactive (company-begin-backend 'company-files))
97 (prefix (company-files--grab-existing-name))
98 (candidates (company-files--complete arg))
99 (location (cons (dired-noselect
100 (file-name-directory (directory-file-name arg))) 1))
104 (provide 'company-files)
105 ;;; company-files.el ends here