Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
298 lines (264 sloc) 11.6 KB
;;; helm-locate.el --- helm interface for locate.
;; 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 <>.
;; NOTE for WINDOZE users:
;; You have to install Everything with his command line interface here:
;;; Code:
(eval-when-compile (require 'cl))
(require 'helm)
(defgroup helm-locate nil
"Locate related Applications and libraries for Helm."
:group 'helm)
(defcustom helm-locate-db-file-regexp "m?locate\.db$"
"Default regexp to match locate database.
If nil Search in all files."
:type 'string
:group 'helm-locate)
(defcustom helm-ff-locate-db-filename "locate.db"
"The basename of the locatedb file you use locally in your directories.
When this is set and `helm' find such a file in the directory from
where you launch locate, it will use this file and will not prompt you
for a db file.
Note that this happen only when locate is launched with a prefix arg."
:group 'helm-locate
:type 'string)
(defcustom helm-c-locate-command nil
"A list of arguments for locate program.
Normally you should not have to modify this yourself.
If nil it will be calculated when `helm-locate' startup
with these default values for different systems:
Gnu/linux: \"locate %s -r %s\"
berkeley-unix: \"locate %s %s\"
windows-nt: \"es %s -r %s\"
Others: \"locate %s %s\"
This string will be passed to format so it should end with `%s'.
The first format spec is used for the \"-i\" value of locate/es,
So don't set it directly but use `helm-locate-case-fold-search'
for this.
The \"-r\" option must be the last option."
:type 'string
:group 'helm-locate)
(defcustom helm-locate-create-db-command
"updatedb -l 0 -o %s -U %s"
"Command used to create a locale locate db file."
:type 'string
:group 'helm-locate)
(defcustom helm-locate-case-fold-search helm-case-fold-search
"It have the same meaning as `helm-case-fold-search'.
The -i option of locate will be used depending of value of
`helm-pattern' when this is set to 'smart.
When nil \"-i\" will not be used at all.
and when non--nil it will always be used.
NOTE: the -i option of the \"es\" command used on windows does
the opposite of \"locate\" command."
:group 'helm-locate
:type 'symbol)
(defvar helm-generic-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-s") 'helm-ff-run-grep)
(define-key map (kbd "M-g s") 'helm-ff-run-grep)
(define-key map (kbd "M-g z") 'helm-ff-run-zgrep)
(define-key map (kbd "M-g p") 'helm-ff-run-pdfgrep)
(define-key map (kbd "M-D") 'helm-ff-run-delete-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 "C-c o") 'helm-ff-run-switch-other-window)
(define-key map (kbd "M-i") 'helm-ff-properties-persistent)
(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-etags)
(define-key map (kbd "C-w") 'helm-yank-text-at-point)
(define-key map (kbd "C-c ?") 'helm-generic-file-help)
"Generic Keymap for files.")
(defun helm-ff-find-locatedb (&optional from-ff)
"Try to find if a local locatedb file is available.
The search is done in `helm-ff-default-directory' or
fall back to `default-directory' if FROM-FF is nil."
(when helm-ff-locate-db-filename
(cond ((and helm-ff-default-directory
(file-exists-p (expand-file-name
((and (not from-ff)
(file-exists-p (expand-file-name
(defun helm-locate-1 (&optional localdb init from-ff default)
"Generic function to run Locate.
if LOCALDB is non--nil search and use a local locate db file.
INIT is a string to use as initial input in prompt.
See `helm-locate-with-db' and `helm-locate'."
(require 'helm-mode)
(and localdb
(or (helm-ff-find-locatedb from-ff)
"Choose or create Locate Db file (locate.db): "
:initial-input (or helm-ff-default-directory
:marked-candidates t
:preselect helm-locate-db-file-regexp
:persistent-action #'(lambda (candidate)
(if (file-directory-p candidate)
(message "Error: The locate Db should be a file")
(format helm-locate-create-db-command
(if helm-ff-transformer-show-only-basename
(helm-c-basename candidate)
:persistent-help "Create locale locate Db"
:test #'(lambda (x)
(if helm-locate-db-file-regexp
;; Select only locate db files and directories
;; to allow navigation.
(or (string-match
helm-locate-db-file-regexp x)
(file-directory-p x))
init default))
(defun helm-locate-set-command ()
"Setup `helm-c-locate-command' if not already defined."
(unless helm-c-locate-command
(setq helm-c-locate-command
(case system-type
('gnu/linux "locate %s -r %s")
('berkeley-unix "locate %s %s")
('windows-nt "es %s -r %s")
(t "locate %s %s")))))
(defvar helm-file-name-history nil)
(defun helm-locate-with-db (&optional db initial-input default)
"Run locate -d DB.
If DB is not given or nil use locate without -d option.
Argument DB can be given as a string or list of db files.
Argument INITIAL-INPUT is a string to use as initial-input.
See also `helm-locate'."
(when (and db (stringp db)) (setq db (list db)))
(let ((helm-ff-transformer-show-only-basename nil)
(if db
(format "locate -d %s"
(mapconcat 'identity
;; Remove eventually
;; marked directories by error.
(loop for i in db
unless (file-directory-p i)
collect i) ":"))
(setq helm-file-name-history (mapcar 'helm-c-basename file-name-history))
(helm :sources 'helm-c-source-locate
:buffer "*helm locate*"
:input initial-input
:default default
:history 'helm-file-name-history)))
(defun helm-c-locate-init ()
"Initialize async locate process for `helm-c-source-locate'."
(let* ((locate-is-es (string-match "^es" helm-c-locate-command))
(case-sensitive-flag (if locate-is-es "-i" ""))
(ignore-case-flag (if locate-is-es "" "-i"))
"locate-process" helm-buffer
(format helm-c-locate-command
(case helm-locate-case-fold-search
(smart (let ((case-fold-search nil))
(if (string-match "[A-Z]" helm-pattern)
(t (if helm-locate-case-fold-search
(get-process "locate-process")
#'(lambda (process event)
(if (string= event "finished\n")
(setq mode-line-format
'(" " mode-line-buffer-identification " "
(line-number-mode "%l") " "
(:eval (propertize
(format "[Locate Process Finish- (%s results)]"
(max (1- (count-lines
(point-min) (point-max))) 0))
'face 'helm-grep-finish))))
(helm-log "Error: Locate %s"
(replace-regexp-in-string "\n" "" event))))))))
(defvar helm-c-source-locate
`((name . "Locate")
(init . helm-locate-set-command)
(candidates-process . helm-c-locate-init)
(type . file)
(requires-pattern . 3)
(history . ,'helm-file-name-history)
(keymap . ,helm-generic-files-map)
(help-message . helm-generic-file-help-message)
(candidate-number-limit . 9999)
(mode-line . helm-generic-file-mode-line-string)
"Find files matching the current input pattern with locate.")
(defun helm-c-locate-read-file-name (prompt &optional init)
"Search a file with locate and return it's filename.
Use argument PROMPT and INIT for `helm' arguments
prompt and input."
(helm :sources
'((name . "Locate")
(candidates-process . helm-c-locate-init)
(action . identity)
(requires-pattern . 3)
(candidate-number-limit . 9999)
(mode-line . helm-generic-file-mode-line-string)
:prompt prompt
:input init
:buffer "*helm locate rfn*"))
(defun helm-locate (arg)
"Preconfigured `helm' for Locate.
Note: you can add locate options after entering pattern.
See 'man locate' for valid options.
You can specify a specific database with prefix argument ARG \(C-u\).
Many databases can be used: navigate and mark them.
See also `helm-locate-with-db'.
To create a user specific db, use
\"updatedb -l 0 -o db_path -U directory\".
Where db_path is a filename matched by
(interactive "P")
(setq helm-ff-default-directory default-directory)
(helm-locate-1 arg))
(provide 'helm-locate)
;; Local Variables:
;; byte-compile-warnings: (not cl-functions obsolete)
;; coding: utf-8
;; indent-tabs-mode: nil
;; End:
;;; helm-locate.el ends here
Jump to Line
Something went wrong with that request. Please try again.