Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
2727 lines (2487 sloc) 112 KB
;;; helm-files.el --- helm file browser and related.
;; 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:
(require 'cl)
(require 'helm)
(require 'helm-utils)
(require 'helm-external)
(require 'helm-grep)
(require 'helm-match-plugin)
(require 'helm-help)
(require 'helm-locate)
(require 'helm-bookmark)
(require 'helm-tags)
(require 'helm-buffers)
(require 'thingatpt)
(require 'ffap)
(eval-when-compile (require 'dired))
(require 'dired-aux)
(require 'dired-x)
(require 'tramp)
(require 'image-dired)
(declare-function find-library-name "find-func.el" (library))
(declare-function secure-hash "ext:fns.c" (algorithm object &optional start end binary))
(declare-function w32-shell-execute "ext:w32fns.c" (operation document &optional parameters show-flag))
(declare-function gnus-dired-attach "ext:gnus-dired.el" (files-to-attach))
(declare-function image-dired-display-image "image-dired.el" (file &optional original-size))
(declare-function image-dired-update-property "image-dired.el" (prop value))
(declare-function eshell-read-aliases-list "em-alias")
(declare-function eshell-send-input "esh-mode" (&optional use-region queue-p no-newline))
(declare-function eshell-bol "esh-mode")
(declare-function helm-ls-git-ls "ext:helm-ls-git")
(declare-function helm-hg-find-files-in-project "ext:helm-ls-hg")
;;; Type attributes
(define-helm-type-attribute 'file
("Find file" . helm-find-many-files)
("Find file as root" . helm-find-file-as-root)
("Find file other window" . find-file-other-window)
("Find file other frame" . find-file-other-frame)
("Open dired in file's directory" . helm-c-open-dired)
("Grep File(s) `C-u recurse'" . helm-find-files-grep)
("Zgrep File(s) `C-u Recurse'" . helm-ff-zgrep)
("Pdfgrep File(s)" . helm-ff-pdfgrep)
("Checksum File" . helm-ff-checksum)
("Ediff File" . helm-find-files-ediff-files)
("Ediff Merge File" . helm-find-files-ediff-merge-files)
("Etags `M-., C-u tap, C-u C-u reload tag file'" . helm-ff-etags-select)
("View file" . view-file)
("Insert file" . insert-file)
("Delete file(s)" . helm-delete-marked-files)
("Open file externally (C-u to choose)" . helm-c-open-file-externally)
("Open file with default tool" . helm-c-open-file-with-default-tool)
("Find file in hex dump" . hexl-find-file))
(persistent-help . "Show this file")
(action-transformer helm-c-transform-file-load-el
(candidate-transformer helm-c-highlight-files
"File name.")
(defgroup helm-files nil
"Files applications and libraries for Helm."
:group 'helm)
(defcustom helm-c-boring-file-regexp-list
'("\\.git$" "\\.hg$" "\\.svn$" "\\.CVS$" "\\._darcs$" "\\.la$" "\\.o$" "~$")
"The regexp list matching boring files."
:group 'helm-files
:type '(repeat (choice regexp)))
(defcustom helm-for-files-preferred-list
"Your preferred sources to find files."
:type '(repeat (choice symbol))
:group 'helm-files)
(defcustom helm-tramp-verbose 0
"Just like `tramp-verbose' but specific to helm.
When set to 0 don't show tramp messages in helm.
If you want to have the default tramp messages set it to 3."
:type 'integer
:group 'helm-files)
(defcustom helm-ff-auto-update-initial-value t
"Auto update when only one candidate directory is matched.
This is the default value when starting `helm-find-files'."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-lynx-style-map t
"Use arrow keys to navigate with `helm-find-files'.
You will have to restart Emacs or reeval `helm-find-files-map'
and `helm-c-read-file-map' for this take effect."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-history-max-length 100
"Number of elements shown in `helm-find-files' history."
:group 'helm-files
:type 'integer)
(defcustom helm-ff-smart-completion t
"Try to complete filenames smarter when non--nil.
See `helm-ff-transform-fname-for-completion' for more info."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-tramp-not-fancy t
"No colors when listing remote files when set to non--nil.
This make listing much faster, specially on slow machines."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-exif-data-program "exiftran"
"Program used to extract exif data of an image file."
:group 'helm-files
:type 'string)
(defcustom helm-ff-exif-data-program-args "-d"
"Arguments used for `helm-ff-exif-data-program'."
:group 'helm-files
:type 'string)
(defcustom helm-ff-newfile-prompt-p t
"Whether Prompt or not when creating new file.
This set `ffap-newfile-prompt'."
:type 'boolean
:group 'helm-files)
(defcustom helm-ff-avfs-directory "~/.avfs"
"The default avfs directory, usually '~/.avfs'.
When this is set you will be able to expand archive filenames with `C-z'
inside an avfs directory mounted with mountavfs.
See <>."
:type 'string
:group 'helm-files)
(defcustom helm-ff-file-compressed-list '("gz" "bz2" "zip" "7z")
"Minimal list of compressed files extension."
:type '(repeat (choice string))
:group 'helm-files)
(defcustom helm-ff-printer-list nil
"A list of available printers on your system.
When non--nil let you choose a printer to print file.
Otherwise when nil the variable `printer-name' will be used.
On Unix based systems (lpstat command needed) you don't need to set this,
`helm-ff-find-printers' will find a list of available printers for you."
:type '(repeat (choice string))
:group 'helm-files)
(defcustom helm-ff-transformer-show-only-basename nil
"Show only basename of candidates in `helm-find-files'.
This can be toggled at anytime from `helm-find-files' with \
:type 'boolean
:group 'helm-files)
(defcustom helm-ff-quick-delete-dont-prompt-for-deletion nil
"Don't ask in persistent deletion of files when non--nil."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-signal-error-on-dot-files t
"Signal error when file is `.' or `..' on file deletion when non--nil.
Default is non--nil.
WARNING: Setting this to nil is unsafe and can cause deletion of a whole tree."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-search-library-in-sexp nil
"Search for library in `require' and `declare-function' sexp."
:group 'helm-files
:type 'boolean)
(defcustom helm-tooltip-hide-delay 25
"Hide tooltips automatically after this many seconds."
:group 'helm-files
:type 'integer)
(defcustom helm-ff-maximum-candidate-to-decorate 2000
"If length of candidates is superior to this value do not highlight them.
This happen only in `helm-find-files'."
:group 'helm-files
:type 'integer)
(defcustom helm-ff-file-name-history-use-recentf nil
"Use `recentf-list' instead of `file-name-history' in `helm-find-files'."
:group 'helm-files
:type 'boolean)
;;; Faces
(defface helm-ff-prefix
'((t (:background "yellow" :foreground "black")))
"Face used to prefix new file or url paths in `helm-find-files'."
:group 'helm-files)
(defface helm-ff-executable
'((t (:foreground "green")))
"Face used for executable files in `helm-find-files'."
:group 'helm-files)
(defface helm-ff-directory
'((t (:foreground "DarkRed" :background "LightGray")))
"Face used for directories in `helm-find-files'."
:group 'helm-files)
(defface helm-ff-symlink
'((t (:foreground "DarkOrange")))
"Face used for symlinks in `helm-find-files'."
:group 'helm-files)
(defface helm-ff-invalid-symlink
'((t (:foreground "black" :background "red")))
"Face used for invalid symlinks in `helm-find-files'."
:group 'helm-files)
(defface helm-ff-file
'((t (:inherit font-lock-builtin-face)))
"Face used for file names in `helm-find-files'."
:group 'helm-files)
;;; Helm-find-files - The helm file browser.
;; Keymaps
(defvar helm-find-files-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map helm-map)
(define-key map (kbd "C-]") 'helm-ff-run-toggle-basename)
(define-key map (kbd "C-x C-f") 'helm-ff-run-locate)
(define-key map (kbd "C-x C-d") 'helm-ff-run-browse-project)
(define-key map (kbd "C-s") 'helm-ff-run-grep)
(define-key map (kbd "M-g s") 'helm-ff-run-grep)
(define-key map (kbd "M-g p") 'helm-ff-run-pdfgrep)
(define-key map (kbd "M-g z") 'helm-ff-run-zgrep)
(define-key map (kbd "M-.") 'helm-ff-run-etags)
(define-key map (kbd "M-R") 'helm-ff-run-rename-file)
(define-key map (kbd "M-C") 'helm-ff-run-copy-file)
(define-key map (kbd "M-B") 'helm-ff-run-byte-compile-file)
(define-key map (kbd "M-L") 'helm-ff-run-load-file)
(define-key map (kbd "M-S") 'helm-ff-run-symlink-file)
(define-key map (kbd "M-H") 'helm-ff-run-hardlink-file)
(define-key map (kbd "M-D") 'helm-ff-run-delete-file)
(define-key map (kbd "M-K") 'helm-ff-run-kill-buffer-persistent)
(define-key map (kbd "C-d") 'helm-ff-persistent-delete)
(define-key map (kbd "M-e") 'helm-ff-run-switch-to-eshell)
(define-key map (kbd "<M-tab>") 'helm-ff-run-complete-fn-at-point)
(define-key map (kbd "C-c o") 'helm-ff-run-switch-other-window)
(define-key map (kbd "C-c C-o") 'helm-ff-run-switch-other-frame)
(define-key map (kbd "C-c C-x") 'helm-ff-run-open-file-externally)
(define-key map (kbd "C-c X") 'helm-ff-run-open-file-with-default-tool)
(define-key map (kbd "M-!") 'helm-ff-run-eshell-command-on-file)
(define-key map (kbd "C-=") 'helm-ff-run-ediff-file)
(define-key map (kbd "C-c =") 'helm-ff-run-ediff-merge-file)
(define-key map (kbd "M-p") 'helm-ff-run-switch-to-history)
(define-key map (kbd "C-c h") 'helm-ff-file-name-history)
(define-key map (kbd "M-i") 'helm-ff-properties-persistent)
(define-key map (kbd "C-c ?") 'helm-ff-help)
(define-key map (kbd "C-}") 'helm-narrow-window)
(define-key map (kbd "C-{") 'helm-enlarge-window)
(define-key map (kbd "C-<backspace>") 'helm-ff-run-toggle-auto-update)
(define-key map (kbd "M-a") 'helm-mark-all)
(define-key map (kbd "M-m") 'helm-toggle-all-marks)
(define-key map (kbd "M-u") 'helm-unmark-all)
(define-key map (kbd "C-c C-a") 'helm-ff-run-gnus-attach-files)
(define-key map (kbd "C-c p") 'helm-ff-run-print-file)
;; Next 2 have no effect if candidate is not an image file.
(define-key map (kbd "M-l") 'helm-ff-rotate-left-persistent)
(define-key map (kbd "M-r") 'helm-ff-rotate-right-persistent)
(define-key map (kbd "C-.") 'helm-find-files-down-one-level)
(define-key map (kbd "C-l") 'helm-find-files-down-one-level)
(define-key map (kbd "C-h C-b") 'helm-send-bug-report-from-helm)
(define-key map (kbd "C-h C-d") 'helm-debug-output)
(define-key map (kbd "C-x @") 'helm-ff-run-find-file-as-root)
(when helm-ff-lynx-style-map
(define-key map (kbd "<left>") 'helm-find-files-down-one-level)
(define-key map (kbd "<right>") 'helm-execute-persistent-action))
(delq nil map))
"Keymap for `helm-find-files'.")
(defvar helm-c-read-file-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map helm-map)
(define-key map (kbd "<C-return>") 'helm-cr-empty-string)
(define-key map (kbd "C-]") 'helm-ff-run-toggle-basename)
(define-key map (kbd "C-.") 'helm-find-files-down-one-level)
(define-key map (kbd "C-l") 'helm-find-files-down-one-level)
(define-key map (kbd "C-<backspace>") 'helm-ff-run-toggle-auto-update)
(define-key map (kbd "C-c ?") 'helm-read-file-name-help)
(when helm-ff-lynx-style-map
(define-key map (kbd "<left>") 'helm-find-files-down-one-level)
(define-key map (kbd "<right>") 'helm-execute-persistent-action)
(define-key map (kbd "C-o") nil)
(define-key map (kbd "<M-left>") 'helm-previous-source)
(define-key map (kbd "<M-right>") 'helm-next-source))
(delq nil map))
"Keymap for `helm-c-read-file-name'.")
(defvar helm-esh-on-file-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map helm-map)
(define-key map (kbd "C-c ?") 'helm-esh-help)
"Keymap for `helm-find-files-eshell-command-on-file'.")
;; Internal.
(defvar helm-c-find-files-doc-header " (`C-l': Go to precedent level)"
"*The doc that is inserted in the Name header of a find-files or dired source.")
(defvar helm-ff-auto-update-flag nil
"Internal, flag to turn on/off auto-update in `helm-find-files'.
Don't set it directly, use instead `helm-ff-auto-update-initial-value'.")
(defvar helm-ff-last-expanded nil
"Store last expanded directory or file.")
(defvar helm-ff-default-directory nil)
(defvar helm-ff-history nil)
(defvar helm-ff-cand-to-mark nil)
(defvar helm-ff-url-regexp
"Same as `ffap-url-regexp' but match earlier possible url.")
(defvar helm-c-source-find-files
`((name . "Find Files")
(header-name . (lambda (name)
(concat name helm-c-find-files-doc-header)))
(init . (lambda ()
(setq helm-ff-auto-update-flag
(candidates . helm-find-files-get-candidates)
(match . helm-ff-match-function)
(filtered-candidate-transformer helm-c-find-files-transformer)
(persistent-action . helm-find-files-persistent-action)
(persistent-help . "Hit1 Expand Candidate, Hit2 or (C-u) Find file")
(mode-line . helm-ff-mode-line-string)
(candidate-number-limit . 9999)
(action-transformer . helm-find-files-action-transformer)
. ,(delq
`(("Find File" . helm-c-find-file-or-marked)
("Find file in Dired" . helm-c-point-file-in-dired)
,(and (locate-library "elscreen")
'("Find file in Elscreen" . helm-elscreen-find-file))
("Checksum File" . helm-ff-checksum)
("Complete at point `M-tab'"
. helm-c-insert-file-name-completion-at-point)
("Open file externally `C-c C-x, C-u to choose'"
. helm-c-open-file-externally)
("Open file with default tool" . helm-c-open-file-with-default-tool)
("Grep File(s) `M-g s, C-u Recurse'" . helm-find-files-grep)
("Zgrep File(s) `M-g z, C-u Recurse'" . helm-ff-zgrep)
("Switch to Eshell `M-e'" . helm-ff-switch-to-eshell)
("Etags `M-., C-u tap, C-u C-u reload tag file'" . helm-ff-etags-select)
("Eshell command on file(s) `M-!, C-u run on all marked at once.'"
. helm-find-files-eshell-command-on-file)
("Find file as root" . helm-find-file-as-root)
("Find file in hex dump" . hexl-find-file)
("Ediff File `C-='" . helm-find-files-ediff-files)
("Ediff Merge File `C-c ='" . helm-find-files-ediff-merge-files)
("Delete File(s) `M-D'" . helm-delete-marked-files)
("Copy file(s) `M-C, C-u to follow'" . helm-find-files-copy)
("Rename file(s) `M-R, C-u to follow'" . helm-find-files-rename)
("Serial rename files" . helm-ff-serial-rename)
("Serial rename by symlinking files" . helm-ff-serial-rename-by-symlink)
("Serial rename by copying files" . helm-ff-serial-rename-by-copying)
("Symlink files(s) `M-S, C-u to follow'" . helm-find-files-symlink)
("Relsymlink file(s) `C-u to follow'" . helm-find-files-relsymlink)
("Hardlink file(s) `M-H, C-u to follow'" . helm-find-files-hardlink)
("Find file other window `C-c o'" . find-file-other-window)
("Switch to history `M-p'" . helm-find-files-switch-to-hist)
("Find file other frame `C-c C-o'" . find-file-other-frame)
("View file" . view-file)
("Print File `C-c p, C-u to refresh'" . helm-ff-print)
("Locate `C-x C-f, C-u to specify locate db'" . helm-ff-locate))))))
(defun helm-ff-match-function (candidate)
(string-match (regexp-quote helm-pattern) candidate))
(defun helm-find-files-set-prompt-for-action (action files)
"Set prompt for action ACTION for FILES."
(let ((len (length files)))
(format "%s *%s File(s)\n%s to: "
action len
(mapconcat (lambda (f)
(format "- %s\n" f)) files ""))))
(defun helm-dwim-target-directory ()
"Return value of `default-directory' of buffer in other window.
If there is only one window return the value ot `default-directory'
for current buffer."
(let ((num-windows (length (window-list))))
(if (> num-windows 1)
(other-window 1)
(car helm-ff-history)))))
(defun helm-find-files-do-action (action)
"Generic function for creating action from `helm-c-source-find-files'.
ACTION must be an action supported by `helm-dired-action'."
(let* ((ifiles (mapcar 'expand-file-name ; Allow modify '/foo/.' -> '/foo'
(cand (helm-get-selection)) ; Target
(prompt (helm-find-files-set-prompt-for-action
(capitalize (symbol-name action)) ifiles))
(parg helm-current-prefix-arg)
(dest (helm-c-read-file-name
:preselect (if helm-ff-transformer-show-only-basename
(helm-c-basename cand) cand)
:initial-input (helm-dwim-target-directory)
:history (helm-find-files-history :comp-read nil))))
dest :files ifiles :action action :follow parg)))
(defun helm-find-files-copy (candidate)
"Copy files from `helm-find-files'."
(helm-find-files-do-action 'copy))
(defun helm-find-files-rename (candidate)
"Rename files from `helm-find-files'."
(helm-find-files-do-action 'rename))
(defun helm-find-files-symlink (candidate)
"Symlink files from `helm-find-files'."
(helm-find-files-do-action 'symlink))
(defun helm-find-files-relsymlink (candidate)
"Relsymlink files from `helm-find-files'."
(helm-find-files-do-action 'relsymlink))
(defun helm-find-files-hardlink (candidate)
"Hardlink files from `helm-find-files'."
(helm-find-files-do-action 'hardlink))
(defun helm-find-files-byte-compile (candidate)
"Byte compile elisp files from `helm-find-files'."
(let ((files (helm-marked-candidates))
(parg helm-current-prefix-arg))
(loop for fname in files
do (byte-compile-file fname parg))))
(defun helm-find-files-load-files (candidate)
"Load elisp files from `helm-find-files'."
(let ((files (helm-marked-candidates)))
(loop for fname in files
do (load fname))))
(defun helm-find-files-ediff-files-1 (candidate &optional merge)
"Generic function to ediff/merge files in `helm-find-files'."
(let ((bname (helm-c-basename candidate))
(prompt (if merge "Ediff Merge `%s' With File: "
"Ediff `%s' With File: "))
(fun (if merge 'ediff-merge-files 'ediff-files)))
(funcall fun
(condition-case quit
(format prompt bname))
(quit ;; Hit C-g ask user to fallback to locate.
(if (y-or-n-p "Search file for ediff with locate? ")
(format prompt bname)
;; Check if -b option is available.
(if (and (eq system-type 'windows-nt)
(string-match "^es" helm-c-locate-command))
(concat bname " -b")))
(error "Error: Ediff Operation aborted")))))))
(defun helm-find-files-ediff-files (candidate)
(helm-find-files-ediff-files-1 candidate))
(defun helm-find-files-ediff-merge-files (candidate)
(helm-find-files-ediff-files-1 candidate 'merge))
(defun helm-find-files-grep (candidate)
"Default action to grep files from `helm-find-files'."
(helm-do-grep-1 (helm-marked-candidates) helm-current-prefix-arg))
(defun helm-ff-zgrep (candidate)
"Default action to zgrep files from `helm-find-files'."
(helm-ff-zgrep-1 (helm-marked-candidates) helm-current-prefix-arg))
(defun helm-ff-pdfgrep (candidate)
"Default action to pdfgrep files from `helm-find-files'."
(let ((cands (loop for file in (helm-marked-candidates)
if (or (string= (file-name-extension file) "pdf")
(string= (file-name-extension file) "PDF"))
collect file))
(helm-c-pdfgrep-default-function 'helm-c-pdfgrep-init))
(when cands
(helm-do-pdfgrep-1 cands))))
(defun helm-ff-etags-select (candidate)
"Default action to jump to etags from `helm-find-files'."
(when (get-buffer helm-action-buffer)
(kill-buffer helm-action-buffer))
(let* ((source-name (assoc-default 'name (helm-get-current-source)))
(default-directory (if (string= source-name "Find Files")
(file-name-directory candidate))))
(helm-c-etags-select helm-current-prefix-arg)))
(defun helm-find-files-switch-to-hist (candidate)
"Switch to helm-find-files history."
(helm-find-files t))
(defvar eshell-command-aliases-list nil)
(defvar helm-eshell-command-on-file-input-history nil)
(defun helm-find-files-eshell-command-on-file-1 (candidate &optional map)
"Run `eshell-command' on CANDIDATE or marked candidates.
This is done possibly with an eshell alias, if no alias found, you can type in
an eshell command.
Basename of CANDIDATE can be a wild-card.
e.g you can do \"eshell-command command *.el\"
Where \"*.el\" is the CANDIDATE.
It is possible to do eshell-command command <CANDIDATE> <some more args>
like this: \"command %s some more args\".
If MAP is given run `eshell-command' on all marked files at once,
Otherwise, run `eshell-command' on each marked files.
In other terms, with a prefix arg do on the three marked files
\"foo\" \"bar\" \"baz\":
\"eshell-command command foo bar baz\"
otherwise do
\"eshell-command command foo\"
\"eshell-command command bar\"
\"eshell-command command baz\"
If `eshell' or `eshell-command' have not been run once,
or if you have no eshell aliases `eshell-command-aliases-list'
will not be loaded first time you use this."
(when (or eshell-command-aliases-list
(y-or-n-p "Eshell is not loaded, run eshell-command without alias anyway? "))
(and eshell-command-aliases-list (eshell-read-aliases-list))
(let* ((cand-list (helm-marked-candidates))
(default-directory (or helm-ff-default-directory
;; If candidate is an url *-ff-default-directory is nil
;; so keep value of default-directory.
(command (helm-comp-read
"Command: "
(loop for (a . c) in eshell-command-aliases-list
when (string-match "\\(\\$1\\|\\$\\*\\)$" (car c))
collect (propertize a 'help-echo (car c)) into ls
finally return (sort ls 'string<))
:buffer "*helm eshell on file*"
:name "Eshell command"
:keymap helm-esh-on-file-map
'("Eshell alias"
"C-c ?: Help, \\[universal-argument]: Insert output at point")
(alias-value (car (assoc-default command eshell-command-aliases-list))))
(when (and (= (length cand-list) 1)
(string-match "[*]" (helm-c-basename (car cand-list))))
(setq cand-list (file-expand-wildcards (car cand-list) t)))
(if (or (equal helm-current-prefix-arg '(16))
(equal map '(16)))
;; Two time C-u from `helm-comp-read' mean print to current-buffer.
;; i.e `eshell-command' will use this value.
(setq current-prefix-arg '(16))
;; Else reset the value of `current-prefix-arg'
;; to avoid printing in current-buffer.
(setq current-prefix-arg nil))
(if (and (or
;; One prefix-arg have been passed before `helm-comp-read'.
;; If map have been set with C-u C-u (value == '(16))
;; ignore it.
(and map (equal map '(4)))
;; One C-u from `helm-comp-read'.
(equal helm-current-prefix-arg '(4))
;; An alias that finish with $*
(and alias-value
;; If command is an alias be sure it accept
;; more than one arg i.e $*.
(string-match "\\$\\*$" alias-value)))
(> (length cand-list) 1))
;; Run eshell-command with ALL marked files as arguments.
(let ((mapfiles (mapconcat 'shell-quote-argument cand-list " ")))
(if (string-match "'%s'\\|\"%s\"\\|%s" command)
(eshell-command (format command mapfiles)) ; See [1]
(eshell-command (format "%s %s" command mapfiles))))
;; Run eshell-command on EACH marked files.
(loop for i in cand-list
for bn = (helm-c-basename i)
for files = (format "'%s'" i)
for com = (if (string-match "'%s'\\|\"%s\"\\|%s" command)
;; [1] This allow to enter other args AFTER filename
;; i.e <command %s some_more_args>
(format command files)
(format "%s %s" command files))
do (eshell-command com))))))
(defun helm-find-files-eshell-command-on-file (candidate)
"Run `eshell-command' on CANDIDATE or marked candidates.
See `helm-find-files-eshell-command-on-file-1' for more info."
candidate helm-current-prefix-arg))
(defun helm-ff-switch-to-eshell (candidate)
"Switch to eshell and cd to `helm-ff-default-directory'."
(let ((cd-eshell #'(lambda ()
(goto-char (point-max))
(format "cd '%s'" helm-ff-default-directory))
(if (get-buffer "*eshell*")
(helm-c-switch-to-buffer "*eshell*")
(funcall cd-eshell))
(call-interactively 'eshell)
(funcall cd-eshell))))
(defun helm-ff-serial-rename-action (method)
"Rename all marked files to `helm-ff-default-directory' with METHOD.
See `helm-ff-serial-rename-1'."
(let* ((cands (helm-marked-candidates))
(def-name (car cands))
(name (read-string "NewName: "
"[0-9]+$" ""
(file-name-extension def-name)))))
(start (read-number "StartAtNumber: "))
(extension (read-string "Extension: "
(file-name-extension (car cands))))
(dir (expand-file-name
"Serial Rename to directory: "
(expand-file-name helm-ff-default-directory)
:test 'file-directory-p
:must-match t)))
(res (loop for f in cands
for bn = (helm-c-basename f)
for count from start
concat (format "%s <-> %s%s.%s\n"
bn name count extension))))
(if (y-or-n-p
(format "Result:\n %sRename like this to <%s> ? " res dir))
dir cands name start extension :method method)
(message nil)
(helm-find-files-1 dir))
(message "Operation aborted"))))
(defun helm-ff-member-directory-p (file directory)
(let ((dir-file (expand-file-name
(file-name-as-directory (file-name-directory file))))
(cur-dir (expand-file-name (file-name-as-directory directory))))
(string= dir-file cur-dir)))
(defun* helm-ff-serial-rename-1
(directory collection new-name start-at-num extension &key (method 'rename))
"rename files in COLLECTION to DIRECTORY with the prefix name NEW-NAME.
Rename start at number START-AT-NUM - ex: prefixname-01.jpg.
EXTENSION is the file extension to use, in empty prompt,
reuse the original extension of file.
METHOD can be one of rename, copy or symlink.
Files will be renamed if they are files of current directory, otherwise they
will be treated with METHOD.
Default METHOD is rename."
;; Maybe remove directories selected by error in collection.
(setq collection (remove-if 'file-directory-p collection))
(let* ((tmp-dir (file-name-as-directory
(concat (file-name-as-directory directory)
(symbol-name (gensym "tmp")))))
(fn (case method
(copy 'copy-file)
(symlink 'make-symbolic-link)
(rename 'rename-file)
(t (error "Error: Unknow method %s" method)))))
(make-directory tmp-dir)
;; Rename all files to tmp-dir with new-name.
;; If files are not from start directory, use method
;; to move files to tmp-dir.
(loop for i in collection
for count from start-at-num
for fnum = (if (< count 10) "0%s" "%s")
for nname = (concat tmp-dir new-name (format fnum count)
(if (not (string= extension ""))
(format ".%s" (replace-regexp-in-string
"[.]" "" extension))
(file-name-extension i 'dot)))
do (if (helm-ff-member-directory-p i directory)
(rename-file i nname)
(funcall fn i nname)))
;; Now move all from tmp-dir to destination.
(loop with dirlist = (directory-files
tmp-dir t directory-files-no-dot-files-regexp)
for f in dirlist do
(if (file-symlink-p f)
(make-symbolic-link (file-truename f)
(concat (file-name-as-directory directory)
(helm-c-basename f)))
(rename-file f directory))))
(delete-directory tmp-dir t))))
(defun helm-ff-serial-rename (candidate)
"Serial rename all marked files to `helm-ff-default-directory'.
Rename only file of current directory, and symlink files coming from
other directories.
See `helm-ff-serial-rename-1'."
(helm-ff-serial-rename-action 'rename))
(defun helm-ff-serial-rename-by-symlink (candidate)
"Serial rename all marked files to `helm-ff-default-directory'.
Rename only file of current directory, and symlink files coming from
other directories.
See `helm-ff-serial-rename-1'."
(helm-ff-serial-rename-action 'symlink))
(defun helm-ff-serial-rename-by-copying (candidate)
"Serial rename all marked files to `helm-ff-default-directory'.
Rename only file of current directory, and copy files coming from
other directories.
See `helm-ff-serial-rename-1'."
(helm-ff-serial-rename-action 'copy))
(defun helm-ff-toggle-auto-update (candidate)
(setq helm-ff-auto-update-flag (not helm-ff-auto-update-flag))
(message "[Auto expansion %s]"
(if helm-ff-auto-update-flag "enabled" "disabled")))
(defun helm-ff-run-toggle-auto-update ()
(when helm-alive-p
(helm-attrset 'toggle-auto-update 'helm-ff-toggle-auto-update)
(helm-execute-persistent-action 'toggle-auto-update)))
(defun helm-ff-run-switch-to-history ()
"Run Switch to history action from `helm-c-source-find-files'."
(when (helm-file-completion-source-p)
(helm-c-quit-and-execute-action 'helm-find-files-switch-to-hist)))
(defun helm-ff-run-grep ()
"Run Grep action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-grep)))
(defun helm-ff-run-pdfgrep ()
"Run Pdfgrep action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-pdfgrep)))
(defun helm-ff-run-zgrep ()
"Run Grep action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-zgrep)))
(defun helm-ff-run-copy-file ()
"Run Copy file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-copy)))
(defun helm-ff-run-rename-file ()
"Run Rename file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-rename)))
(defun helm-ff-run-byte-compile-file ()
"Run Byte compile file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-byte-compile)))
(defun helm-ff-run-load-file ()
"Run Load file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-load-files)))
(defun helm-ff-run-eshell-command-on-file ()
"Run eshell command on file action from `helm-c-source-find-files'."
(when helm-alive-p
(defun helm-ff-run-ediff-file ()
"Run Ediff file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-ediff-files)))
(defun helm-ff-run-ediff-merge-file ()
"Run Ediff merge file action from `helm-c-source-find-files'."
(when helm-alive-p
(defun helm-ff-run-symlink-file ()
"Run Symlink file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-symlink)))
(defun helm-ff-run-hardlink-file ()
"Run Hardlink file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-find-files-hardlink)))
(defun helm-ff-run-delete-file ()
"Run Delete file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-delete-marked-files)))
(defun helm-ff-run-complete-fn-at-point ()
"Run complete file name action from `helm-c-source-find-files'."
(when helm-alive-p
(defun helm-ff-run-switch-to-eshell ()
"Run switch to eshell action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-switch-to-eshell)))
(defun helm-ff-run-switch-other-window ()
"Run switch to other window action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'find-file-other-window)))
(defun helm-ff-run-switch-other-frame ()
"Run switch to other frame action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'find-file-other-frame)))
(defun helm-ff-run-open-file-externally ()
"Run open file externally command action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-c-open-file-externally)))
(defun helm-ff-run-open-file-with-default-tool ()
"Run open file externally command action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-c-open-file-with-default-tool)))
(defun helm-ff-locate (candidate)
"Locate action function for `helm-find-files'."
(let ((input (concat (helm-c-basename
;; The locate '-b' option doesn't exists
;; in everything (es).
(unless (and (eq system-type 'windows-nt)
(string-match "^es" helm-c-locate-command))
" -b"))))
(helm-locate-1 helm-current-prefix-arg nil 'from-ff input)))
(defun helm-ff-run-locate ()
"Run locate action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-locate)))
(defun helm-ff-run-find-file-as-root ()
(helm-c-quit-and-execute-action 'helm-find-file-as-root))
(defun helm-ff-run-gnus-attach-files ()
"Run gnus attach files command action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-gnus-attach-files)))
(defun helm-ff-run-etags ()
"Run Etags command action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-etags-select)))
(defun helm-ff-print (candidate)
"Print marked files.
You have to set in order
variables `lpr-command',`lpr-switches' and/or `printer-name'.
\(setq lpr-command \"gtklp\"\)
\(setq lpr-switches '(\"-P\")\)
\(setq printer-name \"Epson-Stylus-Photo-R265\"\)
Same as `dired-do-print' but for helm."
(when (or helm-current-prefix-arg
(not helm-ff-printer-list))
(setq helm-ff-printer-list
(let* ((file-list (helm-marked-candidates))
(len (length file-list))
(printer-name (if helm-ff-printer-list
"Printer: " helm-ff-printer-list)
(command (read-string
(format "Print *%s File(s):\n%s with: "
(lambda (f) (format "- %s\n" f))
file-list ""))
(when (and lpr-command
(or lpr-switches
(mapconcat 'identity
(cons lpr-command
(append (if (stringp lpr-switches)
(list lpr-switches)
(list printer-name)))
" "))))
(file-args (mapconcat #'(lambda (x)
(format "'%s'" x))
file-list " "))
(cmd-line (concat command " " file-args)))
(if command
(start-process-shell-command "helm-print" nil cmd-line)
(error "Error: Please verify your printer settings in Emacs."))))
(defun helm-ff-run-print-file ()
"Run Print file action from `helm-c-source-find-files'."
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-print)))
(defun helm-ff-checksum (file)
"Calculate the checksum of FILE.
Provide completion on different algorithms to use on Emacs24.
On Emacs23 only 'sha1' is available.
The checksum is copied to kill-ring."
(let ((algo-list (and (fboundp 'secure-hash)
'(md5 sha1 sha224 sha256 sha384 sha512))))
(if algo-list
(secure-hash (intern
"Algorithm: " algo-list))
(sha1 (with-temp-buffer
(insert-file-contents file)
(message "Checksum copied to kill-ring.")))
(defun helm-ff-toggle-basename (candidate)
(setq helm-ff-transformer-show-only-basename
(not helm-ff-transformer-show-only-basename))
(let ((target (if helm-ff-transformer-show-only-basename
(helm-c-basename candidate) candidate)))
(helm-force-update target)))
(defun helm-ff-run-toggle-basename ()
(when helm-alive-p
(helm-attrset 'toggle-basename 'helm-ff-toggle-basename)
(helm-execute-persistent-action 'toggle-basename)))
(defun* helm-reduce-file-name (fname level &key unix-close expand)
"Reduce FNAME by LEVEL from end or beginning depending LEVEL value.
If LEVEL is positive reduce from end else from beginning.
If UNIX-CLOSE is non--nil close filename with /.
If EXPAND is non--nil expand-file-name."
(let* ((exp-fname (expand-file-name fname))
(fname-list (split-string (if (or (string= fname "~/") expand)
exp-fname fname) "/" t))
(len (length fname-list))
(pop-list (if (< level 0)
(subseq fname-list (* level -1))
(subseq fname-list 0 (- len level))))
(result (mapconcat 'identity pop-list "/"))
(empty (string= result "")))
(when unix-close (setq result (concat result "/")))
(if (string-match "^~" result)
(if (string= result "~/") "~/" result)
(if (< level 0)
(if empty "../" (concat "../" result))
(cond ((eq system-type 'windows-nt)
(if empty (expand-file-name "/") ; Expand to "/" or "c:/".
(empty "/")
(concat "/" result)))))))
;; Internal
(defvar helm-file-completion-sources
'("Find Files" "Read File Name"
"Read File Name History" "Copy Files"
"Rename Files" "Symlink Files"
"Hardlink Files" "Write File" "Insert File")
"Sources that use the *find-files mechanism can be added here.
Sources generated by `helm-mode' don't need to be added here, it will
be done automatically.
You should not modify this yourself unless you know what you do.")
(defun helm-file-completion-source-p ()
"Return non--nil if current source is a file completion source.
A source is a file completion source if it is
one of `helm-file-completion-sources'.
Return nil if helm is not running."
(let ((cur-source (cdr (assoc 'name (helm-get-current-source)))))
(loop for i in helm-file-completion-sources
thereis (string= cur-source i))))
(defun helm-find-files-down-one-level (arg)
"Go down one level like unix command `cd ..'.
If prefix numeric arg is given go ARG level down."
(interactive "p")
(when (and (helm-file-completion-source-p)
(not (helm-ff-invalid-tramp-name-p)))
(setq helm-follow-mode nil))
;; When going to precedent level we want to be at the line
;; corresponding to actual directory, so store this info
;; in `helm-ff-last-expanded'.
(if (and (not (file-directory-p helm-pattern))
(file-exists-p helm-pattern))
(setq helm-ff-last-expanded helm-pattern)
(setq helm-ff-last-expanded helm-ff-default-directory))
(let ((new-pattern (helm-reduce-file-name helm-pattern arg
:unix-close t :expand t)))
(helm-set-pattern new-pattern))))
(defun helm-ff-retrieve-last-expanded ()
"Move overlay to last visited directory `helm-ff-last-expanded'.
This happen after using `helm-find-files-down-one-level',
or hitting C-z on \"..\"."
(when (and helm-ff-last-expanded
(let ((presel (if helm-ff-transformer-show-only-basename
(directory-file-name helm-ff-last-expanded))
(directory-file-name helm-ff-last-expanded))))
(when (re-search-forward (concat "^" (regexp-quote presel) "$") nil t)
(forward-line 0)
(setq helm-ff-last-expanded nil))))
(add-hook 'helm-after-update-hook 'helm-ff-retrieve-last-expanded)
;; Auto-update - helm-find-files auto expansion of directories.
(defun helm-ff-update-when-only-one-matched ()
"Expand to directory when sole completion.
When only one candidate is remaining and it is a directory,
expand to this directory."
(when (and helm-ff-auto-update-flag
(not (helm-ff-invalid-tramp-name-p)))
(let* ((history-p (string= (assoc-default
'name (helm-get-current-source))
"Read File Name History"))
(pat (if (string-match tramp-file-name-regexp
(helm-create-tramp-name helm-pattern)
(completed-p (string= (file-name-as-directory pat)
(when (and (or
;; Only one candidate remaining
;; and at least 2 char in basename.
(and (<= (helm-approximate-candidate-number) 2)
(>= (length (helm-c-basename helm-pattern)) 2))
;; Already completed.
(not history-p)) ; Don't try to auto complete in history.
(let ((cur-cand (prog2
(unless completed-p
;; Only one non--existing candidate
;; and one directory candidate, move to it.
(when (and (stringp cur-cand) (file-directory-p cur-cand))
(if (and (not (helm-dir-is-dot cur-cand)) ; [1]
;; Maybe we are here because completed-p is true
;; but check this again to be sure. (Windows fix)
(<= (helm-approximate-candidate-number) 2)) ; [2]
;; If after going to next line the candidate
;; is not one of "." or ".." [1]
;; and only one candidate is remaining [2],
;; assume candidate is a new directory to expand, and do it.
(helm-set-pattern (file-name-as-directory cur-cand))
;; The candidate is one of "." or ".."
;; that mean we have entered the last letter of the directory name
;; in prompt, so expansion is already done, just add the "/" at end
;; of name unless helm-pattern ends with "."
;; (i.e we are writing something starting with ".")
(unless (string-match "^.*[.]\\{1\\}$" helm-pattern)
;; Need to expand-file-name to avoid e.g /ssh:host:./ in prompt.
(expand-file-name (file-name-as-directory helm-pattern)))))
(add-hook 'helm-after-update-hook 'helm-ff-update-when-only-one-matched)
;; Allow expanding to home directory or root
;; when entering respectively "~/" or "//" at end of pattern.
;; e.g /home/thierry/labo/helm-config-qp/~/
;; will expand to "~/"
;; and /home/thierry/labo/helm-config-qp//
;; will expand to "/"
(defun helm-ff-auto-expand-to-home-or-root ()
"Goto home, root or default directory when pattern ends with ~/, /, or ./.
This happen only in function using sources that are
`helm-file-completion-source-p' compliant."
(when (and (helm-file-completion-source-p)
(string-match ".*\\(/~/\\|/\\{2\\}\\|/[.]\\{1\\}/\\)$"
(not (string-match helm-ff-url-regexp helm-pattern)))
(let ((match (match-string 1 helm-pattern)))
(cond ((string= match "//")
;; Expand to "/" or "c:/"
(setq helm-pattern (expand-file-name "/")))
((string= match "/~/")
(if (eq system-type 'windows-nt)
(setq helm-pattern (file-name-as-directory (getenv "HOME")))
(setq helm-pattern "~/")))
((string= match "/./")
(setq helm-pattern
(expand-file-name default-directory))))))
(setq helm-ff-default-directory helm-pattern)
;; For some reasons, i must use here with-current-buffer => mini buffer
;; and not `helm-set-pattern' that use with-selected-window => mini win.
(with-current-buffer (window-buffer (minibuffer-window))
(insert helm-pattern))))
(add-hook 'helm-after-update-hook 'helm-ff-auto-expand-to-home-or-root)
(defun helm-c-point-file-in-dired (file)
"Put point on filename FILE in dired buffer."
(dired (file-name-directory file))
(dired-goto-file file))
(defun helm-create-tramp-name (fname)
"Build filename for `helm-pattern' like /su:: or /sudo::."
(apply #'tramp-make-tramp-file-name
(loop with v = (tramp-dissect-file-name fname)
for i across v collect i)))
(defun* helm-ff-tramp-hostnames (&optional (pattern helm-pattern))
"Get a list of hosts for tramp method found in `helm-pattern'.
Argument PATTERN default to `helm-pattern', it is here only for debugging
(when (string-match tramp-file-name-regexp pattern)
(let ((method (match-string 1 pattern))
(tn (match-string 0 pattern))
(all-methods (mapcar 'car tramp-methods)))
(loop for (f . h) in (tramp-get-completion-function method)
append (loop for e in (funcall f (car h))
for host = (and (consp e) (cadr e))
when (and host (not (member host all-methods)))
collect (concat tn host)))
:test 'equal))))
(defun helm-ff-before-action-hook-fn ()
"Exit helm when user try to execute action on an invalid tramp fname."
(let ((cand (helm-get-selection)))
(when (and (helm-file-completion-source-p)
(helm-ff-invalid-tramp-name-p cand) ; Check candidate.
(helm-ff-invalid-tramp-name-p)) ; check helm-pattern.
(error "Error: Unknow file or directory `%s'" cand))))
(add-hook 'helm-before-action-hook 'helm-ff-before-action-hook-fn)
(defun* helm-ff-invalid-tramp-name-p (&optional (pattern helm-pattern))
"Return non--nil when PATTERN is an invalid tramp filename."
(string= (helm-ff-set-pattern pattern)
"Invalid tramp file name"))
(defun helm-ff-set-pattern (pattern)
"Handle tramp filenames in `helm-pattern'."
(let ((methods (mapcar 'car tramp-methods))
(reg "\\`/\\([^[/:]+\\|[^/]+]\\):.*:")
cur-method tramp-name)
(cond ((string= pattern "") "")
((string-match ".*\\(~?/?[.]\\{1\\}/\\)$" pattern)
(expand-file-name default-directory)))
((and (string-match ".*\\(~//\\|//\\)$" pattern)
(not (string-match helm-ff-url-regexp helm-pattern)))
(expand-file-name "/")) ; Expand to "/" or "c:/"
((string-match "^~\\|.*/~/$" pattern)
(let* ((home (expand-file-name (getenv "HOME"))))
(replace-match home nil t pattern)))
;; Match "/method:maybe_hostname:"
((and (string-match reg pattern)
(setq cur-method (match-string 1 pattern))
(member cur-method methods))
(setq tramp-name (helm-create-tramp-name
(match-string 0 pattern)))
(replace-match tramp-name nil t pattern))
;; Match "/hostname:"
((and (string-match tramp-file-name-regexp pattern)
(setq cur-method (match-string 1 pattern))
(and cur-method (not (member cur-method methods))))
(setq tramp-name (helm-create-tramp-name
(match-string 0 pattern)))
(replace-match tramp-name nil t pattern))
;; Match "/method:" in this case don't try to connect.
((and (not (string-match reg pattern))
(string-match tramp-file-name-regexp pattern)
(member (match-string 1 pattern) methods))
"Invalid tramp file name") ; Write in helm-buffer.
;; PATTERN is a directory, end it with "/".
;; This will make PATTERN not ending yet with "/"
;; candidate for `helm-ff-default-directory',
;; allowing `helm-ff-retrieve-last-expanded' to retrieve it
;; when descending level.
((file-directory-p pattern)
(file-name-as-directory pattern))
;; Return PATTERN unchanged.
(t pattern))))
(defun helm-find-files-get-candidates (&optional require-match)
"Create candidate list for `helm-c-source-find-files'."
(let* ((path (helm-ff-set-pattern helm-pattern))
(path-name-dir (if (file-directory-p path)
(file-name-as-directory path)
(file-name-directory path)))
(tramp-verbose helm-tramp-verbose)) ; No tramp message when 0.
(set-text-properties 0 (length path) nil path)
;; Don't set now `helm-pattern' if `path' == "Invalid tramp file name"
;; like that the actual value (e.g /ssh:) is passed to
;; `helm-ff-tramp-hostnames'.
(when (not (file-directory-p (file-name-directory path)))
(setq invalid-basedir t))
(unless (or (string= path "Invalid tramp file name") invalid-basedir)
(setq helm-pattern (helm-ff-transform-fname-for-completion path)))
(setq helm-ff-default-directory
(if (string= helm-pattern "")
(expand-file-name "/") ; Expand to "/" or "c:/"
;; If path is an url *default-directory have to be nil.
(unless (or (string-match helm-ff-url-regexp path)
(string-match ffap-url-regexp path))
(cond ((string= path "Invalid tramp file name")
(or (helm-ff-tramp-hostnames) ; Hostnames completion.
;; `helm-pattern' have not been modified yet.
;; Set it here to the value of `path' that should be now
;; "Invalid tramp file name" and set the candidates list
;; to ("Invalid tramp file name") to make `helm-pattern'
;; match single candidate "Invalid tramp file name".
(setq helm-pattern path)
;; "Invalid tramp file name" is now printed
;; in `helm-buffer'.
(list path))))
((or (file-regular-p path)
;; `ffap-url-regexp' don't match until url is complete.
(string-match helm-ff-url-regexp path)
(and (not (file-exists-p path)) (string-match "/$" path))
(and ffap-url-regexp (string-match ffap-url-regexp path)))
(list path))
((string= path "") (helm-ff-directory-files "/" t))
((and (file-directory-p path) (not (file-readable-p path)))
(list (format "Opening directory: access denied, `%s'" path)))
((file-directory-p path) (helm-ff-directory-files path t))
(append (unless require-match (list path))
(helm-ff-directory-files path-name-dir t))))))
(defun helm-ff-directory-files (directory &optional full)
"List contents of DIRECTORY.
Argument FULL mean absolute path.
It is same as `directory-files' but always returns the
dotted filename '.' and '..' even on root directories in Windows
(setq directory (file-name-as-directory
(expand-file-name directory)))
(let ((ls (directory-files
directory full directory-files-no-dot-files-regexp))
(dot (concat directory "."))
(dot2 (concat directory "..")))
(append (list dot dot2) ls)))
;; Internal
(defvar helm-ff-smart-completion-incompatible-methods '(multi1 multi3p))
(defun helm-ff-transform-fname-for-completion (fname)
"Return FNAME with it's basename modified as a regexp.
e.g foo => f.*o.*o.*
Treat special characters (\"^\" \".\" \"$\") differently:
e.g ^helm.el$ => \"^h.*e.*l.*m[.]e.*l$\"
If basename contain one or more space or if FNAME is a valid directory name,
return FNAME unchanged."
(let ((bn (helm-c-basename fname)))
(if (or (not helm-ff-smart-completion)
(memq helm-mp-matching-method
(string-match "\\s-" bn) ; Fall back to match-plugin.
(string-match "[*][.]?.*" bn) ; Allow entering wilcard.
(string-match "/$" fname) ; Allow mkdir.
(file-directory-p fname)
(string-match helm-ff-url-regexp fname))
;; Don't treat wildcards ("*") as regexp char.
;; (e.g ./foo/*.el => ./foo/[*].el)
(replace-regexp-in-string "[*]" "[*]" fname)
(setq bn (if (> (length bn) 2) ; Normal completion on first 2 char.
(helm-ff-mapconcat-candidate bn)
(concat (file-name-directory fname) bn))))
(defun helm-ff-mapconcat-candidate (candidate)
"Transform string CANDIDATE in regexp.
See `helm-ff-transform-fname-for-completion'."
(loop with ls with last-elm
for i in (split-string candidate "" t)
for rev = (reverse ls)
if (member i (list "." "$" "^"))
do (and ls
(setq ls (append (butlast ls)
(list (replace-regexp-in-string
"[.*]" "" (car (reverse ls)))))))
and collect (if (string= i ".") "[.]" i) into ls
collect (concat i ".*") into ls
do (setq last-elm i)
finally return (mapconcat 'identity ls "")))
(defun helm-dir-is-dot (dir)
(string-match "\\(?:/\\|\\`\\)\\.\\{1,2\\}\\'" dir))
(defun helm-ff-save-history ()
"Store the last value of `helm-ff-default-directory' in `helm-ff-history'."
(when (and helm-ff-default-directory
(push helm-ff-default-directory helm-ff-history)))
(add-hook 'helm-cleanup-hook 'helm-ff-save-history)
(defun helm-ff-valid-symlink-p (file)
(file-exists-p (file-truename file)))
(defun helm-get-default-mode-for-file (filename)
"Return the default mode to open FILENAME."
(let ((mode (loop for (r . m) in auto-mode-alist
thereis (and (string-match r filename) m))))
(or (and (symbolp mode) mode) "Fundamental")))
(defun helm-ff-properties (candidate)
"Show file properties of CANDIDATE in a tooltip or message."
(let* ((all (helm-file-attributes candidate))
(dired-line (helm-file-attributes
candidate :dired t :human-size t))
(type (getf all :type))
(mode-type (getf all :mode-type))
(owner (getf all :uid))
(owner-right (getf all :user t))
(group (getf all :gid))
(group-right (getf all :group))
(other-right (getf all :other))
(size (helm-file-human-size (getf all :size)))
(modif (getf all :modif-time))
(access (getf all :access-time))
(ext (helm-get-default-program-for-file candidate))
(tooltip-hide-delay (or helm-tooltip-hide-delay tooltip-hide-delay)))
(if (and (window-system) tooltip-mode)
(helm-c-basename candidate) "\n"
dired-line "\n"
(format "Mode: %s\n" (helm-get-default-mode-for-file candidate))
(format "Ext prog: %s\n" (or (and ext (replace-regexp-in-string
" %s" "" ext))
"Not defined"))
(format "Type: %s: %s\n" type mode-type)
(when (string= type "symlink")
(format "True name: '%s'\n"
(cond ((string-match "^\.#" (helm-c-basename candidate))
"Autosave symlink")
((helm-ff-valid-symlink-p candidate)
(file-truename candidate))
(t "Invalid Symlink"))))
(format "Owner: %s: %s\n" owner owner-right)
(format "Group: %s: %s\n" group group-right)
(format "Others: %s\n" other-right)
(format "Size: %s\n" size)
(format "Modified: %s\n" modif)
(format "Accessed: %s\n" access)))
(message dired-line) (sit-for 5))))
(defun helm-ff-properties-persistent ()
"Show properties without quitting helm."
(helm-attrset 'properties-action 'helm-ff-properties)
(helm-execute-persistent-action 'properties-action))
(defun helm-ff-persistent-delete ()
"Delete current candidate without quitting."
(helm-attrset 'quick-delete 'helm-ff-quick-delete)
(helm-execute-persistent-action 'quick-delete))
(defun helm-ff-dot-file-p (file)
"Check if FILE is `.' or `..'."
(member (helm-c-basename file) '("." "..")))
(defun helm-ff-quick-delete (candidate)
"Delete file CANDIDATE without quitting."
(let ((presel (prog1 (save-excursion
(let (sel)
(setq sel (helm-get-selection))
(if (string= sel candidate)
(progn (helm-previous-line)
(setq presel (if (and helm-ff-transformer-show-only-basename
(not (helm-ff-dot-file-p presel)))
(helm-c-basename presel) presel))
(if helm-ff-quick-delete-dont-prompt-for-deletion
(helm-c-delete-file candidate
(when (y-or-n-p (format "Really Delete file `%s'? " candidate))
(helm-c-delete-file candidate
(message nil))))
(helm-force-update presel)))
(defun helm-ff-kill-buffer-fname (candidate)
(let* ((buf (get-file-buffer candidate))
(buf-name (buffer-name buf)))
(if buf
(kill-buffer buf) (message "Buffer `%s' killed" buf))
(message "No buffer to kill"))))
(defun helm-ff-kill-or-find-buffer-fname (candidate)
"Find file CANDIDATE or kill it's buffer if it is visible.
Never kill `helm-current-buffer'.
Never kill buffer modified.
This is called normally on third hit of \
in `helm-find-files-persistent-action'."
(let* ((buf (get-file-buffer candidate))
(buf-name (buffer-name buf))
(win (get-buffer-window buf)))
(if (and buf win
(not (eq buf (get-buffer helm-current-buffer)))
(not (buffer-modified-p buf)))
(kill-buffer buf)
(set-window-buffer win helm-current-buffer)
(message "Buffer `%s' killed" buf-name))
(find-file candidate))))
(defun helm-ff-run-kill-buffer-persistent ()
"Execute `helm-ff-kill-buffer-fname' whitout quitting."
(when helm-alive-p
(helm-attrset 'kill-buffer-fname 'helm-ff-kill-buffer-fname)
(helm-execute-persistent-action 'kill-buffer-fname)))
(defun helm-ff-prefix-filename (fname &optional file-or-symlinkp new-file)
"Return filename FNAME maybe prefixed with [?] or [@].
If FILE-OR-SYMLINKP is non--nil this mean we assume FNAME is an
existing filename or valid symlink and there is no need to test it.
NEW-FILE when non--nil mean FNAME is a non existing file and
return FNAME prefixed with [?]."
(let* ((prefix-new (propertize
" " 'display
(propertize "[?]" 'face 'helm-ff-prefix)))
(prefix-url (propertize
" " 'display
(propertize "[@]" 'face 'helm-ff-prefix))))
(cond ((or file-or-symlinkp (file-exists-p fname)) fname)
((or (string-match helm-ff-url-regexp fname)
(string-match ffap-url-regexp fname))
(concat prefix-url " " fname))
((or new-file (not (file-exists-p fname)))
(concat prefix-new " " fname)))))
(defun helm-c-find-files-transformer (files sources)
"Transformer for `helm-c-source-find-files'.
Tramp files are not highlighted unless `helm-ff-tramp-not-fancy'
is non--nil."
(if (or (and (string-match tramp-file-name-regexp helm-pattern)
(> (length files) helm-ff-maximum-candidate-to-decorate))
(if helm-ff-transformer-show-only-basename
(loop for i in files collect
(if (helm-dir-is-dot i)
i (cons (helm-c-basename i) i)))
(helm-ff-highlight-files files sources)))
(defun helm-ff-highlight-files (files sources)
"Candidate transformer for `helm-c-source-find-files' without icons."
(loop for i in files
for disp = (if (and helm-ff-transformer-show-only-basename
(not (helm-dir-is-dot i))
(not (string-match ffap-url-regexp i))
(not (string-match helm-ff-url-regexp i)))
(helm-c-basename i) i)
for type = (car (file-attributes i))
(cond (;; A not already saved file.
(and (stringp type)
(not (helm-ff-valid-symlink-p i))
(not (string-match "^\.#" (helm-c-basename i))))
(cons (helm-ff-prefix-filename
(propertize disp 'face 'helm-ff-invalid-symlink) t)
;; A symlink.
((stringp type)
(cons (helm-ff-prefix-filename
(propertize disp 'face 'helm-ff-symlink) t)
;; A directory.
((eq t type)
(cons (helm-ff-prefix-filename
(propertize disp 'face 'helm-ff-directory) t)
;; An executable file.
((file-executable-p i)
(cons (helm-ff-prefix-filename
(propertize disp 'face 'helm-ff-executable) t)
;; A file.
((file-exists-p i)
(cons (helm-ff-prefix-filename
(propertize disp 'face 'helm-ff-file) t)
;; A non--existing file.
(cons (helm-ff-prefix-filename
(propertize disp 'face 'helm-ff-file) nil 'new-file)
(defun helm-find-files-action-transformer (actions candidate)
"Action transformer for `helm-c-source-find-files'."
(cond ((with-helm-current-buffer
(eq major-mode 'message-mode))
(append actions
'(("Gnus attach file(s)" . helm-ff-gnus-attach-files))))
((string-match (image-file-name-regexp) candidate)
(append actions
'(("Rotate image right `M-r'" . helm-ff-rotate-image-right)
("Rotate image left `M-l'" . helm-ff-rotate-image-left))))
((string-match "\.el$" (helm-aif (helm-marked-candidates)
(car it) candidate))
(append actions
'(("Byte compile lisp file(s) `M-B, C-u to load'"
. helm-find-files-byte-compile)
("Load File(s) `M-L'" . helm-find-files-load-files))))
((and (string-match "\.html?$" candidate)
(file-exists-p candidate))
(append actions
'(("Browse url file" . browse-url-of-file))))
((or (string= (file-name-extension candidate) "pdf")
(string= (file-name-extension candidate) "PDF"))
(append actions
'(("Pdfgrep File(s)" . helm-ff-pdfgrep))))
(t actions)))
(defun helm-ff-gnus-attach-files (candidate)
"Run `gnus-dired-attach' on `helm-marked-candidates' or CANDIDATE."
(let ((flist (helm-marked-candidates)))
(gnus-dired-attach flist)))
(defun helm-ff-rotate-current-image-1 (file &optional num-arg)
"Rotate current image at NUM-ARG degrees.
This is a destructive operation on FILE made by external tool mogrify."
(declare (special image-dired-display-image-buffer))
(setq file (file-truename file)) ; For symlinked images.
;; When FILE is not an image-file, do nothing.
(when (string-match (image-file-name-regexp) file)
(if (executable-find "mogrify")
(shell-command (format "mogrify -rotate %s %s"
(or num-arg 90)
(shell-quote-argument file)))
(when (buffer-live-p image-dired-display-image-buffer)
(kill-buffer image-dired-display-image-buffer))
(image-dired-display-image file)
(message nil)
(display-buffer (get-buffer image-dired-display-image-buffer)))
(error "mogrify not found"))))
(defun helm-ff-rotate-image-left (candidate)
"Rotate image file CANDIDATE left.
This affect directly file CANDIDATE."
(helm-ff-rotate-current-image-1 candidate -90))
(defun helm-ff-rotate-image-right (candidate)
"Rotate image file CANDIDATE right.
This affect directly file CANDIDATE."
(helm-ff-rotate-current-image-1 candidate))
(defun helm-ff-rotate-left-persistent ()
"Rotate image left without quitting helm."
(helm-attrset 'image-action1 'helm-ff-rotate-image-left)
(helm-execute-persistent-action 'image-action1))
(defun helm-ff-rotate-right-persistent ()
"Rotate image right without quitting helm."
(helm-attrset 'image-action2 'helm-ff-rotate-image-right)
(helm-execute-persistent-action 'image-action2))
(defun helm-ff-exif-data (candidate)
"Extract exif data from file CANDIDATE using `helm-ff-exif-data-program'."
(if (and helm-ff-exif-data-program
(executable-find helm-ff-exif-data-program))
(shell-command-to-string (format "%s %s %s"
(format "No program %s found to extract exif"
(defun helm-find-files-persistent-action (candidate)
"Open subtree CANDIDATE without quitting helm.
If CANDIDATE is not a directory expand CANDIDATE filename.
If CANDIDATE is alone, open file CANDIDATE filename.
That's mean:
First hit on C-z expand CANDIDATE second hit open file.
If a prefix arg is given or `helm-follow-mode' is on open file."
(let* ((follow (buffer-local-value
(get-buffer-create helm-buffer)))
(new-pattern (helm-get-selection))
(num-lines-buf (with-current-buffer helm-buffer
(count-lines (point-min) (point-max))))
;; `helm-insert-in-minibuffer' don't expand correctly fnames
;; (#Bugfix cursor coming back at bol).
;; So use a function using `minibuffer-window' instead.
(insert-in-minibuffer #'(lambda (fname)
(with-selected-window (minibuffer-window)
(unless follow
(set-text-properties 0 (length fname)
nil fname)
(insert fname))))))
(cond ((and (string= (helm-ff-set-pattern helm-pattern)
"Invalid tramp file name")
(string-match tramp-file-name-regexp candidate))
;; First hit insert hostname and
;; second hit insert ":" and expand.
(if (string= candidate helm-pattern)
(funcall insert-in-minibuffer (concat candidate ":"))
(funcall insert-in-minibuffer candidate)))
( ;; A symlink directory, expand it's truename.
(and (file-directory-p candidate) (file-symlink-p candidate))
(funcall insert-in-minibuffer (file-name-as-directory
(expand-file-name candidate)))))
;; A directory, open it.
((file-directory-p candidate)
(when (string= (helm-c-basename candidate) "..")
(setq helm-ff-last-expanded helm-ff-default-directory))
(funcall insert-in-minibuffer (file-name-as-directory
(expand-file-name candidate))))
;; A symlink file, expand to it's true name. (first hit)
((and (file-symlink-p candidate) (not current-prefix-arg) (not follow))
(funcall insert-in-minibuffer (file-truename candidate)))
;; A regular file, expand it, (first hit)
((and (>= num-lines-buf 3) (not current-prefix-arg) (not follow))
(funcall insert-in-minibuffer new-pattern))
;; An image file and it is the second hit on C-z,
;; show the file in `image-dired'.
((string-match (image-file-name-regexp) candidate)
(when (buffer-live-p image-dired-display-image-buffer)
(kill-buffer image-dired-display-image-buffer))
(image-dired-display-image candidate)
(message nil)
(helm-c-switch-to-buffer image-dired-display-image-buffer)
(with-current-buffer image-dired-display-image-buffer
(let ((exif-data (helm-ff-exif-data candidate)))
(image-dired-update-property 'help-echo exif-data))))
;; Allow browsing archive on avfs fs.
;; Assume volume is already mounted with mountavfs.
((and helm-ff-avfs-directory
(regexp-quote (expand-file-name helm-ff-avfs-directory))
(file-name-directory candidate))
(helm-ff-file-compressed-p candidate))
(funcall insert-in-minibuffer (concat candidate "#")))
;; On second hit we open file.
;; On Third hit we kill it's buffer maybe.
(helm-ff-kill-or-find-buffer-fname candidate)))))
(defun helm-ff-file-compressed-p (candidate)
"Whether CANDIDATE is a compressed file or not."
(member (file-name-extension candidate)
(defun helm-c-insert-file-name-completion-at-point (candidate)
"Insert file name completion at point."
(if buffer-read-only
(error "Error: Buffer `%s' is read-only" (buffer-name))
(let* ((end (point))
(guess (substring-no-properties (thing-at-point 'filename)))
(beg (- (point) (length guess)))
(full-path-p (or (string-match-p (concat "^" (getenv "HOME")) guess)
(string-match-p "^[^\~]" guess))))
(set-text-properties 0 (length candidate) nil candidate)
(if (and guess (not (string= guess ""))
(string-match-p "^\\(~/\\|/\\|[a-zA-Z]:/\\)" guess))
(delete-region beg end)
(insert (if full-path-p
(expand-file-name candidate)
(abbreviate-file-name candidate))))
(error "Aborting completion: No valid file name at point"))))))
(defun* helm-find-files-history (&key (comp-read t))
"The `helm-find-files' history.
Show the first `helm-ff-history-max-length' elements of
`helm-ff-history' in an `helm-comp-read'."
(let ((history (when helm-ff-history
(helm-fast-remove-dups helm-ff-history
:test 'equal))))
(when history
(setq helm-ff-history
(if (>= (length history) helm-ff-history-max-length)
(subseq history 0 helm-ff-history-max-length)
(if comp-read
"Switch to Directory: "
:name "Helm Find Files History"
:must-match t)
(defun helm-find-files-1 (fname &optional preselect)
"Find FNAME with `helm' completion.
Like `find-file' but with `helm' support.
Use it for non--interactive calls of `helm-find-files'."
(when (get-buffer helm-action-buffer)
(kill-buffer helm-action-buffer))
(let (;; Be sure we don't erase the precedent minibuffer if some.
(and helm-ff-auto-update-initial-value
(not (minibuffer-window-active-p (minibuffer-window)))))
(helm :sources 'helm-c-source-find-files
:input fname
:case-fold-search helm-file-name-case-fold-search
:keymap helm-find-files-map
:preselect preselect
:prompt "Find Files or Url: "
:buffer "*Helm Find Files*")))
(defun helm-find-files-initial-input (&optional input)
"Return INPUT if present, otherwise try to guess it."
(or (and input (or (and (file-remote-p input) input)
(expand-file-name input)))
(thing-at-point 'filename))))
(defun helm-find-files-input (file-at-pt thing-at-pt)
"Try to guess a default input for `helm-find-files'."
(let* ((def-dir (helm-c-current-directory))
(abs (and file-at-pt
(not (string-match ffap-url-regexp file-at-pt))
(expand-file-name file-at-pt def-dir)))
(lib (when helm-ff-search-library-in-sexp
(hlink (helm-ff-find-url-at-point))
(remp (and abs (file-remote-p abs)))
(file-p (and (not remp)
(not (string= file-at-pt ""))
(file-exists-p file-at-pt)
thing-at-pt (not (string= thing-at-pt ""))
(expand-file-name thing-at-pt def-dir))))))
(cond (lib) ; e.g we are inside a require sexp.
(hlink) ; String at point is an hyperlink.
(remp abs) ; A remote file
(file-p ; a regular file
;; Avoid ffap annoyances, don't use `ffap-alist'.
(let (ffap-alist)
(helm-aif (ffap-file-at-point)
(expand-file-name it))))
(t (and (not (string= file-at-pt "")) ; possibly an url or email.
(defun helm-ff-find-url-at-point ()
"Try to find link to an url in text-property at point."
(let* ((he (get-text-property (point) 'help-echo))
(ov (overlays-at (point)))
(ov-he (and ov (overlay-get
(car (overlays-at (point))) 'help-echo)))
(w3m-l (get-text-property (point) 'w3m-href-anchor))
(nt-prop (get-text-property (point) 'nt-link)))
;; Org link.
(when (and (stringp he) (string-match "^LINK: " he))
(setq he (replace-match "" t t he)))
(loop for i in (list he ov-he w3m-l nt-prop)
thereis (and (stringp i) (string-match ffap-url-regexp i) i))))
(defun helm-find-library-at-point ()
"Try to find library path at point.
Find inside `require' and `declare-function' sexp."
(require 'find-func)
(let* ((beg-sexp (save-excursion (search-backward "(" (point-at-bol) t)))
(end-sexp (save-excursion (search-forward ")" (point-at-eol) t)))
(sexp (and beg-sexp end-sexp
(1+ beg-sexp) (1- end-sexp)))))
(cond ((and sexp (string-match "require \'.+[^)]" sexp))
"'\\|\)\\|\(" ""
;; If require use third arg, ignore it,
;; always use library path found in `load-path'.
(second (split-string (match-string 0 sexp))))))
((and sexp (string-match-p "^declare-function" sexp))
"\"\\|ext:" ""
(third (split-string sexp)))))
(t nil)))))
;;; Helm completion for `write-file'.==> C-x C-w
(defvar helm-c-source-write-file
`((name . "Write File")
(header-name . (lambda (name)
(concat name helm-c-find-files-doc-header)))
(candidates . helm-find-files-get-candidates)
(filtered-candidate-transformer helm-c-find-files-transformer)
(persistent-action . helm-find-files-persistent-action)
(persistent-help . "Expand Candidate")
(keymap . ,helm-c-read-file-map)
(action .
(("Write File" . (lambda (candidate)
(write-file candidate 'confirm)))))))
;;; Helm completion for `insert-file'.==> C-x i
(defvar helm-c-source-insert-file
`((name . "Insert File")
(header-name . (lambda (name)
(concat name helm-c-find-files-doc-header)))
(candidates . helm-find-files-get-candidates)
(filtered-candidate-transformer helm-c-find-files-transformer)
(persistent-action . helm-find-files-persistent-action)
(persistent-help . "Expand Candidate")
(keymap . ,helm-c-read-file-map)
(action .
(("Insert File" . (lambda (candidate)
(when (y-or-n-p (format "Really insert %s in %s "
candidate helm-current-buffer))
(insert-file-contents candidate))))))))
;;; Helm completion for copy, rename and (rel)sym/hard/link files from dired.
(defvar helm-c-source-copy-files
`((name . "Copy Files")
(header-name . (lambda (name)
(concat name helm-c-find-files-doc-header)))
(candidates . helm-find-files-get-candidates)
(filtered-candidate-transformer helm-c-find-files-transformer)
(persistent-action . helm-find-files-persistent-action)
(persistent-help . "Expand Candidate")
(keymap . ,helm-c-read-file-map)
(action .
(("Copy File"
. (lambda (candidate)
(helm-dired-action candidate :action 'copy)))
("Copy and Follow"
. (lambda (candidate)
(helm-dired-action candidate :action 'copy :follow t)))))))
(defvar helm-c-source-rename-files
`((name . "Rename Files")
(header-name . (lambda (name)
(concat name helm-c-find-files-doc-header)))
(candidates . helm-find-files-get-candidates)
(filtered-candidate-transformer helm-c-find-files-transformer)
(persistent-action . helm-find-files-persistent-action)
(persistent-help . "Expand Candidate")
(keymap . ,helm-c-read-file-map)
(action .
(("Rename File"
. (lambda (candidate)
(helm-dired-action candidate :action 'rename)))
("Rename and Follow"
. (lambda (candidate)
(helm-dired-action candidate :action 'rename :follow t)))))))
(defvar helm-c-source-symlink-files
`((name . "Symlink Files")
(header-name . (lambda (name)
(concat name helm-c-find-files-doc-header)))
(candidates . helm-find-files-get-candidates)
(filtered-candidate-transformer helm-c-find-files-transformer)
(persistent-action . helm-find-files-persistent-action)
(persistent-help . "Expand Candidate")
(keymap . ,helm-c-read-file-map)
. (("Symlink File"
. (lambda (candidate)
(helm-dired-action candidate :action 'symlink)))
("RelSymlink File"
. (lambda (candidate)
(helm-dired-action candidate :action 'relsymlink)))))))
(defvar helm-c-source-hardlink-files
`((name . "Hardlink Files")
(header-name . (lambda (name)
(concat name helm-c-find-files-doc-header)))
(candidates . helm-find-files-get-candidates)
(filtered-candidate-transformer helm-c-find-files-transformer)
(persistent-action . helm-find-files-persistent-action)
(persistent-help . "Expand Candidate")
(keymap . ,helm-c-read-file-map)
. (("Hardlink File"
. (lambda (candidate)
(helm-dired-action candidate :action 'hardlink)))))))
(defun* helm-dired-action (candidate
&key action follow (files (dired-get-marked-files)))
Where ACTION is a symbol that can be one of:
'copy, 'rename, 'symlink,'relsymlink, 'hardlink.
Argument FOLLOW when non--nil specify to follow FILES to destination."
(declare (special helm-async-be-async))
(when (get-buffer dired-log-buffer) (kill-buffer dired-log-buffer))
(let ((fn (case action
('copy 'dired-copy-file)
('rename 'dired-rename-file)
('symlink 'make-symbolic-link)
('relsymlink 'dired-make-relative-symlink)
('hardlink 'dired-hardlink)))
(marker (case action
((copy rename) dired-keep-marker-copy)
('symlink dired-keep-marker-symlink)
('relsymlink dired-keep-marker-relsymlink)
('hardlink dired-keep-marker-hardlink)))
(dirflag (and (= (length files) 1)
(file-directory-p (car files))
(not (file-directory-p candidate))))
;; When FOLLOW is enabled, disable helm-async.
;; If it is globally disabled use this nil value.
(helm-async-be-async (and (boundp 'helm-async-be-async)
(not follow))))
fn (symbol-name action) files
;; CANDIDATE is the destination.
(if (file-directory-p candidate)
;; When CANDIDATE is a directory, build file-name in this directory.
;; Else we use CANDIDATE.
#'(lambda (from)
(expand-file-name (file-name-nondirectory from) candidate))
#'(lambda (from) candidate))
(push (file-name-as-directory
(if (file-directory-p candidate)
(expand-file-name candidate)
(file-name-directory candidate)))
;; If follow is non--nil we should not be in async mode.
(when (and follow (not (get-buffer dired-log-buffer)))
(let ((target (directory-file-name candidate)))
(setq helm-ff-cand-to-mark
(helm-get-dest-fnames-from-list files candidate dirflag))
(if (and dirflag (eq action 'rename))
(helm-find-files-1 (file-name-directory target)
(if helm-ff-transformer-show-only-basename
(helm-c-basename target) target))
(helm-find-files-1 (expand-file-name candidate))))
(setq helm-ff-cand-to-mark nil))))))
(defun helm-get-dest-fnames-from-list (flist dest-cand rename-dir-flag)
"Transform filenames of FLIST to abs of DEST-CAND.
If RENAME-DIR-FLAG is non--nil collect the `directory-file-name' of transformed
members of FLIST."
;; At this point files have been renamed/copied at destination.
;; That's mean DEST-CAND exists.
with dest = (expand-file-name dest-cand)
for src in flist
for basename-src = (helm-c-basename src)
for fname = (cond (rename-dir-flag (directory-file-name dest))
((file-directory-p dest)
(concat (file-name-as-directory dest) basename-src))
(t dest))
when (file-exists-p fname)
collect fname into tmp-list
finally return (sort tmp-list 'string<)))
(defun helm-ff-maybe-mark-candidates ()
"Mark all candidates of list `helm-ff-cand-to-mark'."
(when (and (string= (assoc-default 'name (helm-get-current-source))
(assoc-default 'name helm-c-source-find-files))
(while helm-ff-cand-to-mark
(if (string= (car helm-ff-cand-to-mark) (helm-get-selection))
(setq helm-ff-cand-to-mark (cdr helm-ff-cand-to-mark)))
(unless (helm-this-visible-mark)
(add-hook 'helm-after-update-hook #'helm-ff-maybe-mark-candidates)
(defun* helm-dired-do-action-on-file (&key action)
(let* ((files (dired-get-marked-files))
(len (length files))
(fname (if (> len 1)
(format "* %d Files" len)
(car files)))
(source (case action
('copy 'helm-c-source-copy-files)
('rename 'helm-c-source-rename-files)
('symlink 'helm-c-source-symlink-files)
('hardlink 'helm-c-source-hardlink-files)))
(prompt-fm (case action
('copy "Copy %s to: ")
('rename "Rename %s to: ")
('symlink "Symlink %s to: ")
('hardlink "Hardlink %s to: ")))
(buffer (case action
('copy "*Helm Copy Files*")
('rename "*Helm Rename Files*")
('symlink "*Helm Symlink Files*")
('hardlink "*Helm Hardlink Files*")))
(helm-mp-highlight-delay nil))
(helm :sources source
:input (or (dired-dwim-target-directory)
(expand-file-name (helm-c-current-directory)))
:preselect (dired-get-filename)
:prompt (format prompt-fm fname)
:keymap helm-c-read-file-map
:buffer buffer)))
(define-minor-mode helm-dired-mode
"Enable helm completion in Dired functions.
Bindings affected are C, R, S, H.
This is deprecated for Emacs24+ users, use `helm-mode' instead."
:group 'helm-files
:global t
(if helm-dired-mode
'dired-do-copy 'helm-dired-copy-file dired-mode-map)
'dired-do-rename 'helm-dired-rename-file dired-mode-map)
'dired-do-symlink 'helm-dired-symlink-file dired-mode-map)
'dired-do-hardlink 'helm-dired-hardlink-file dired-mode-map))
'helm-dired-copy-file 'dired-do-copy dired-mode-map)
'helm-dired-rename-file 'dired-do-rename dired-mode-map)
'helm-dired-symlink-file 'dired-do-symlink dired-mode-map)
'helm-dired-hardlink-file 'dired-do-hardlink dired-mode-map)))
(defalias 'helm-dired-bindings 'helm-dired-mode)
;;; Routines for files
(defun helm-c-file-buffers (filename)
"Returns a list of buffer names corresponding to FILENAME."
(let ((name (expand-file-name filename))
(buf-list ()))
(dolist (buf (buffer-list) buf-list)
(let ((bfn (buffer-file-name buf)))
(when (and bfn (string= name bfn))
(push (buffer-name buf) buf-list))))))
(defun helm-c-delete-file (file &optional error-if-dot-file-p synchro)
"Delete the given file after querying the user.
Ask to kill buffers associated with that file, too."
(when (and error-if-dot-file-p
(helm-ff-dot-file-p file))
(error "Error: Cannot operate on `.' or `..'"))
(let ((buffers (helm-c-file-buffers file)))
(if (or (< emacs-major-version 24)
;; `dired-delete-file' in Emacs versions < 24
;; doesn't support delete-by-moving-to-trash
;; so use `delete-directory' and `delete-file'
;; that handle it.
(cond ((and (not (file-symlink-p file))
(file-directory-p file)
(directory-files file t dired-re-no-dot))
(when (y-or-n-p (format "Recursive delete of `%s'? " file))
(delete-directory file 'recursive)))
((and (not (file-symlink-p file))
(file-directory-p file))
(delete-directory file))
(t (delete-file file)))
file dired-recursive-deletes delete-by-moving-to-trash))
(when buffers
(dolist (buf buffers)
(when (y-or-n-p (format "Kill buffer %s, too? " buf))
(kill-buffer buf))))))
(defun helm-delete-marked-files (ignore)
(let* ((files (helm-marked-candidates))
(len (length files)))
(if (not (y-or-n-p
(format "Delete *%s File(s):\n%s"
(mapconcat (lambda (f) (format "- %s\n" f)) files ""))))
(message "(No deletions performed)")
(dolist (i files)
(set-text-properties 0 (length i) nil i)
(helm-c-delete-file i helm-ff-signal-error-on-dot-files))
(message "%s File(s) deleted" len))))
(defun helm-c-find-file-or-marked (candidate)
"Open file CANDIDATE or open helm marked files in background."
(let ((marked (helm-marked-candidates))
(url-p (and ffap-url-regexp
(string-match ffap-url-regexp candidate)))
(ffap-newfile-prompt helm-ff-newfile-prompt-p)
(find-file-wildcards nil)
#'(lambda (dir &optional helm-ff)
(when (y-or-n-p (format "Create directory `%s'? " dir))
(let ((dirfname (directory-file-name dir)))
(if (file-exists-p dirfname)
"Mkdir: Unable to create directory `%s': file exists."
(helm-c-basename dirfname))
(make-directory dir 'parent)))
(or (and helm-ff (helm-find-files-1 dir)) t)))))
(if (> (length marked) 1)
;; Open all marked files in background and display
;; the first one.
(progn (mapc 'find-file-noselect (cdr marked))
(find-file (car marked)))
(if (and (not (file-exists-p candidate))
(not url-p)
(string-match "/$" candidate))
;; A a non--existing filename ending with /
;; Create a directory and jump to it.
(funcall make-dir-fn candidate 'helm-ff)
;; A non--existing filename NOT ending with / or
;; an existing filename, create or jump to it.
;; If the basedir of candidate doesn't exists,
;; ask for creating it.
(let ((dir (file-name-directory candidate)))
(if (or (file-directory-p dir) url-p)
(find-file-at-point (car marked))
(and (funcall make-dir-fn dir)
(find-file-at-point candidate))))))))
(defun helm-c-shadow-boring-files (files)
"Files matching `helm-c-boring-file-regexp' will be
displayed with the `file-name-shadow' face if available."
(helm-shadow-entries files helm-c-boring-file-regexp-list))
(defun helm-c-skip-boring-files (files)
"Files matching `helm-c-boring-file-regexp' will be skipped."
(helm-skip-entries files helm-c-boring-file-regexp-list))
(defun helm-c-skip-current-file (files)
"Current file will be skipped."
(remove (buffer-file-name helm-current-buffer) files))
(defun helm-c-w32-pathname-transformer (args)
"Change undesirable features of windows pathnames to ones more acceptable to
other candidate transformers."
(if (eq system-type 'windows-nt)
(lambda (x)
"/cygdrive/\\(.\\)" "\\1:"
(replace-regexp-in-string "\\\\" "/" x)))
(defvar helm-canonical-home
(regexp-quote (expand-file-name "~")))
(defun helm-shorten-home-path-1 (file)
(if (and (stringp file)
(string-match (concat "\\`" helm-canonical-home) file))
(cons (replace-match "~" nil nil file) file)
(defun helm-c-shorten-home-path (files)
"Replaces /home/user with ~."
(helm-transform-mapcar #'helm-shorten-home-path-1 files))
;;; List of files gleaned from every dired buffer
(defun helm-c-files-in-all-dired-candidates ()
(lambda (dir)
(cond ((listp dir) ;filelist
((equal "" (file-name-nondirectory dir)) ;dir
(directory-files dir t))
(t ;wildcard
(file-expand-wildcards dir t))))
(delq nil
(mapcar (lambda (buf)
(set-buffer buf)
(when (eq major-mode 'dired-mode)
(if (consp dired-directory)
(cdr dired-directory) ;filelist
dired-directory))) ;dir or wildcard
;; (dired '("~/" "~/.emacs-custom.el" "~/.emacs.bmk"))
(defun helm-c-transform-file-load-el (actions candidate)
"Add action to load the file CANDIDATE if it is an emacs lisp
file. Else return ACTIONS unmodified."
(if (member (file-name-extension candidate) '("el" "elc"))
(append actions '(("Load Emacs Lisp File" . load-file)))
(defun helm-c-transform-file-browse-url (actions candidate)
"Add an action to browse the file CANDIDATE if it is a html file or URL.
Else return ACTIONS unmodified."
(let ((browse-action '("Browse with Browser" . browse-url)))
(cond ((string-match "^http\\|^ftp" candidate)
(cons browse-action actions))
((string-match "\\.html?$" candidate)
(append actions (list browse-action)))
(t actions))))
(defvar helm-c-source-files-in-all-dired
'((name . "Files in all dired buffer.")
(candidates . helm-c-files-in-all-dired-candidates)
(type . file)))
;;; File Cache
(defvar helm-c-file-cache-initialized-p nil)
(defvar helm-c-file-cache-files nil)
(defvar helm-c-source-file-cache
`((name . "File Cache")
. (lambda ()
(require 'filecache nil t)
(unless helm-c-file-cache-initialized-p
(setq helm-c-file-cache-files
(loop for item in file-cache-alist append
(destructuring-bind (base &rest dirs) item
(loop for dir in dirs collect
(concat dir base)))))
(defadvice file-cache-add-file (after file-cache-list activate)
(add-to-list 'helm-c-file-cache-files (expand-file-name file)))
(setq helm-c-file-cache-initialized-p t))))
(keymap . ,helm-generic-files-map)
(help-message . helm-generic-file-help-message)
(mode-line . helm-generic-file-mode-line-string)
(candidates . helm-c-file-cache-files)
(match helm-c-match-on-basename)
(type . file)))
;;; ffap
(eval-when-compile (require 'ffap))
(defvar helm-c-source-ffap-guesser
`((name . "File at point")
(init . (lambda () (require 'ffap)))
(candidates . (lambda ()
(list it))))
(keymap . ,helm-generic-files-map)
(help-message . helm-generic-file-help-message)
(mode-line . helm-generic-file-mode-line-string)
(type . file)))
;;; ffap with line number
(defun helm-c-ffap-file-line-at-point ()
"Get (FILENAME . LINENO) at point."
(helm-aif (let (ffap-alist) (ffap-file-at-point))
(when (and (search-forward it nil t)
(looking-at ":\\([0-9]+\\)"))
(cons it (string-to-number (match-string 1)))))))
(defun helm-c-ffap-line-candidates ()
(helm-attrset 'ffap-line-location (helm-c-ffap-file-line-at-point)))
(helm-aif (helm-attr 'ffap-line-location)
(destructuring-bind (file . line) it
(list (cons (format "%s (line %d)" file line) file)))))
;;; Goto line after opening file by `helm-c-source-ffap-line'.
(defun helm-c-ffap-line-goto-line ()
(when (car (helm-attr 'ffap-line-location))
(get-file-buffer (car (helm-attr 'ffap-line-location))))
(helm-goto-line (cdr (helm-attr 'ffap-line-location)))))
(helm-attrset 'ffap-line-location nil))))
(add-hook 'helm-after-action-hook 'helm-c-ffap-line-goto-line)
(add-hook 'helm-after-persistent-action-hook 'helm-c-ffap-line-goto-line)
(defvar helm-c-source-ffap-line
`((name . "File/Lineno at point")
(init . (lambda () (require 'ffap)))
(candidates . helm-c-ffap-line-candidates)
(keymap . ,helm-map)
(type . file)))
;;; Outliner
(defvar helm-outline-goto-near-line-flag t)
(defvar helm-outline-using nil)
(defun helm-after-update-hook--outline ()
(if (and (eq helm-outline-using t)
(eq helm-outline-goto-near-line-flag t))
(add-hook 'helm-after-update-hook 'helm-after-update-hook--outline)
(defun helm-outline-goto-near-line ()
;; TODO need consideration whether to update position by every input.
(when t ; (equal helm-pattern "")
(helm-goto-line 2)
(let ((lineno (with-helm-current-buffer
(line-number-at-pos (car helm-current-position)))))
(block exit
(while (<= (progn (skip-chars-forward " ")
(or (number-at-point) lineno))
(forward-line 1)
(when (eobp)
(forward-line -1)
(return-from exit))))
(forward-line -1)
(and (bobp) (forward-line 1))
(and (helm-pos-header-line-p) (forward-line -2))
;;; File name history
(defvar helm-c-source-file-name-history
'((name . "File Name History")
(candidates . file-name-history)
(match-strict . helm-c-match-on-basename)
(type . file)))
(defvar helm-c-source-ff-file-name-history
`((name . "File name history")
(init . (lambda ()
(when helm-ff-file-name-history-use-recentf
(require 'recentf)
(or recentf-mode (recentf-mode 1)))))
(candidates . (lambda ()
(if helm-ff-file-name-history-use-recentf
(match-strict . helm-c-match-on-basename)
(candidate-number-limit . ,history-length)
(action . (("find file in helm"
. (lambda (candidate)
(expand-file-name candidate))))))))
(defun helm-ff-file-name-history ()
"Switch to `file-name-history' without quitting `helm-find-files'."
(helm :sources 'helm-c-source-ff-file-name-history
:buffer "*helm-file-name-history*"
:allow-nest t
:resume 'noresume))
;;; Recentf files
(defvar helm-c-source-recentf
`((name . "Recentf")
(init . (lambda ()
(require 'recentf)
(or recentf-mode (recentf-mode 1))))
(candidates . recentf-list)
(keymap . ,helm-generic-files-map)
(help-message . helm-generic-file-help-message)
(mode-line . helm-generic-file-mode-line-string)
(action . ,(cdr (helm-get-actions-from-type
"See (info \"(emacs)File Conveniences\").
Set `recentf-max-saved-items' to a bigger value if default is too small.")
;;; Browse project
;; Need dependencies:
;; <>
;; <>
;; Only hg and git are supported for now.
(defun helm-browse-project ()
"Browse files and see status of project with its vcs.
Only hg and git are supported for now.
Fall back to `helm-find-files' if directory is not under
control of one of those vcs.
Need dependencies:
(cond ((and (fboundp 'helm-ls-git-root-dir)
((and (fboundp 'helm-hg-root)
(t (helm-find-files nil))))
(defun helm-ff-browse-project (candidate)
(with-helm-default-directory helm-ff-default-directory
(defun helm-ff-run-browse-project ()
(when helm-alive-p
(helm-c-quit-and-execute-action 'helm-ff-browse-project)))
;;; session.el files
;; sesion ( is an alternative to
;; recentf that saves recent file history and much more.
(defvar helm-c-source-session
`((name . "Session")
(candidates . (lambda ()
(delete-if-not #'(lambda (f)
(or (string-match tramp-file-name-regexp f)
(file-exists-p f)))
(mapcar 'car session-file-alist))))
(match helm-c-match-on-file-name
(keymap . ,helm-generic-files-map)
(help-message . helm-generic-file-help-message)
(mode-line . helm-generic-file-mode-line-string)
(action . ,(cdr (helm-get-actions-from-type
"File list from emacs-session.")
;;; Files in current dir
(defun helm-c-highlight-files (files)
"A basic transformer for helm files sources.
Colorize only symlinks, directories and files."
(loop for i in (helm-c-skip-boring-files files)
for disp = (if (and helm-ff-transformer-show-only-basename
(not (helm-dir-is-dot i))
(not (string-match ffap-url-regexp i))
(not (string-match helm-ff-url-regexp i)))
(helm-c-basename i) i)
for type = (car (file-attributes i))
(cond ((and helm-ff-tramp-not-fancy
(string-match tramp-file-name-regexp i))
(cons disp i))
((stringp type)
(cons (propertize disp
'face 'helm-ff-symlink
'help-echo (expand-file-name i))
((eq type t)
(cons (propertize disp
'face 'helm-ff-directory
'help-echo (expand-file-name i))
(t (cons (propertize disp
'face 'helm-ff-file
'help-echo (expand-file-name i))
(defvar helm-c-source-files-in-current-dir
`((name . "Files from Current Directory")
(candidates . (lambda ()
(let ((dir (helm-c-current-directory)))
(when (file-accessible-directory-p dir)
(directory-files dir t))))))
(keymap . ,helm-generic-files-map)
(help-message . helm-generic-file-help-message)
(mode-line . helm-generic-file-mode-line-string)
(type . file)))
(defun helm-find-files (arg)
"Preconfigured `helm' for helm implementation of `find-file'.
Called with a prefix arg show history if some.
Don't call it from programs, use `helm-find-files-1' instead.
This is the starting point for nearly all actions you can do on files."
(interactive "P")
(declare (special org-directory))
(let ((any-input (if (and arg helm-ff-history)
(presel (buffer-file-name (current-buffer))))
(cond ((and (eq major-mode 'org-agenda-mode)
(not any-input))
(setq any-input (expand-file-name org-directory)))
((and (eq major-mode 'dired-mode) any-input)
(setq presel any-input)
(setq any-input (file-name-directory any-input))))
(set-text-properties 0 (length any-input) nil any-input)
(unless any-input
(setq any-input (expand-file-name (helm-c-current-directory))))
any-input (if helm-ff-transformer-show-only-basename
(and presel (helm-c-basename presel))
(defun helm-write-file ()
"Preconfigured `helm' providing completion for `write-file'."
(let ((helm-mp-highlight-delay nil))
(helm :sources 'helm-c-source-write-file
:input (expand-file-name default-directory)
:prompt "Write buffer to file: "
:buffer "*Helm write file*")))
(defun helm-insert-file ()
"Preconfigured `helm' providing completion for `insert-file'."
(let ((helm-mp-highlight-delay nil))
(helm :sources 'helm-c-source-insert-file
:input (expand-file-name default-directory)
:prompt "Insert file: "
:buffer "*Helm insert file*")))
(defun helm-dired-rename-file ()
"Preconfigured `helm' to rename files from dired."
(helm-dired-do-action-on-file :action 'rename))
(defun helm-dired-copy-file ()
"Preconfigured `helm' to copy files from dired."
(helm-dired-do-action-on-file :action 'copy))
(defun helm-dired-symlink-file ()
"Preconfigured `helm' to symlink files from dired."
(helm-dired-do-action-on-file :action 'symlink))
(defun helm-dired-hardlink-file ()
"Preconfigured `helm' to hardlink files from dired."
(helm-dired-do-action-on-file :action 'hardlink))
(defun helm-for-files ()
"Preconfigured `helm' for opening files.
Run all sources defined in `helm-for-files-preferred-list'."
(let ((helm-ff-transformer-show-only-basename nil))
(helm-other-buffer helm-for-files-preferred-list "*helm for files*")))
(defun helm-recentf ()
"Preconfigured `helm' for `recentf'."
(helm-other-buffer 'helm-c-source-recentf "*helm recentf*"))
(provide 'helm-files)
;; Local Variables:
;; byte-compile-warnings: (not cl-functions obsolete)
;; coding: utf-8
;; indent-tabs-mode: nil
;; byte-compile-dynamic: t
;; End:
;;; helm-files.el ends here
Jump to Line
Something went wrong with that request. Please try again.