annotate lisp/locate.el @ 112425:9f7614f1a892

Merge from emacs-23
author Glenn Morris <rgm@gnu.org>
date Sat, 22 Jan 2011 11:36:45 -0800
parents 417b1e4d63cd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17517
8f952e921136 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 16795
diff changeset
1 ;;; locate.el --- interface to the locate command
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
104932
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
3 ;; Copyright (C) 1996, 1998, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 111777
diff changeset
4 ;; 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5
21184
aba31b37562b (locate-current-line-number): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents: 21056
diff changeset
6 ;; Author: Peter Breton <pbreton@cs.umb.edu>
29156
af5c31a82586 Add finder keywords.
Dave Love <fx@gnu.org>
parents: 29155
diff changeset
7 ;; Keywords: unix files
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
13 ;; the Free Software Foundation, either version 3 of the License, or
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
14 ;; (at your option) any later version.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 ;;; Commentary:
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
26 ;; Search a database of files and use dired commands on the result.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 ;; Locate.el provides an interface to a program which searches a
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; database of file names. By default, this program is the GNU locate
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; command, but it could also be the BSD-style find command, or even a
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;; user specified command.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 ;; To use the BSD-style "fast find", or any other shell command of the
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
34 ;; form
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 ;; SHELLPROGRAM Name-to-find
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;;
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
38 ;; set the variable `locate-command' in your .emacs file.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 ;;
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
40 ;; To use a more complicated expression, create a function which
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
41 ;; takes a string (the name to find) as input and returns a list.
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
42 ;; The first element should be the command to be executed, the remaining
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
43 ;; elements should be the arguments (including the name to find). Then put
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 ;;
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
45 ;; (setq locate-make-command-line 'my-locate-command-line)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 ;; in your .emacs, using the name of your function in place of
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
48 ;; my-locate-command-line.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 ;; You should make sure that whichever command you use works correctly
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 ;; from a shell prompt. GNU locate and BSD find expect the file databases
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 ;; to either be in standard places or located via environment variables.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 ;; If the latter, make sure these environment variables are set in
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
54 ;; your emacs process.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 ;; Locate-mode assumes that each line output from the locate-command
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 ;; consists exactly of a file name, possibly preceded or trailed by
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 ;; whitespace. If your file database has other information on the line (for
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
59 ;; example, the file size), you will need to redefine the function
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
60 ;; `locate-get-file-positions' to return a list consisting of the first
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 ;; character in the file name and the last character in the file name.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 ;; To use locate-mode, simply type M-x locate and then the string
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 ;; you wish to find. You can use almost all of the dired commands in
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 ;; the resulting *Locate* buffer. It is worth noting that your commands
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 ;; do not, of course, affect the file database. For example, if you
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 ;; compress a file in the locate buffer, the actual file will be
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 ;; compressed, but the entry in the file database will not be
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 ;; affected. Consequently, the database and the filesystem will be out
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
70 ;; of sync until the next time the database is updated.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 ;;
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
72 ;; The command `locate-with-filter' keeps only lines matching a
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 ;; regular expression; this is often useful to constrain a big search.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
76 ;;;;; Building a database of files ;;;;;;;;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
77 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
78 ;; You can create a simple files database with a port of the Unix find command
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
79 ;; and one of the various Windows NT various scheduling utilities,
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
80 ;; for example the AT command from the NT Resource Kit, WinCron which is
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
81 ;; included with Microsoft FrontPage, or the shareware NTCron program.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
82 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
83 ;; To set up a function which searches the files database, do something
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
84 ;; like this:
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
85 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
86 ;; (defvar locate-fcodes-file "c:/users/peter/fcodes")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
87 ;; (defvar locate-make-command-line 'nt-locate-make-command-line)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
88 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
89 ;; (defun nt-locate-make-command-line (arg)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
90 ;; (list "grep" "-i" arg locate-fcodes-file))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
91 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
92 ;;;;;;;; ADVICE For dired-make-relative: ;;;;;;;;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
93 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
94 ;; For certain dired commands to work right, you should also include the
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
95 ;; following in your _emacs/.emacs:
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
96 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
97 ;; (defadvice dired-make-relative (before set-no-error activate)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
98 ;; "For locate mode and Windows, don't return errors"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
99 ;; (if (and (eq major-mode 'locate-mode)
111461
2b266010d0b7 system-type related trivia.
Glenn Morris <rgm@gnu.org>
parents: 111449
diff changeset
100 ;; (memq system-type '(windows-nt ms-dos)))
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
101 ;; (ad-set-arg 2 t)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
102 ;; ))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
103 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
104 ;; Otherwise, `dired-make-relative' will give error messages like
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
105 ;; "FILENAME: not in directory tree growing at /"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
106
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
107
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 ;;; Code:
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109
104932
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
110 (require 'dired)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 ;; Variables
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
113
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
114 (defvar locate-current-filter nil)
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
115 (defvar locate-local-filter nil)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
116 (defvar locate-local-search nil)
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
117 (defvar locate-local-prompt nil)
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
118
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
119 (defgroup locate nil
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
120 "Interface to the locate command."
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
121 :prefix "locate-"
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
122 :group 'external)
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
123
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
124 (defcustom locate-command "locate"
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
125 "Executable program for searching a database of files.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
126 The Emacs commands `locate' and `locate-with-filter' use this.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
127 The value should be a program that can be called from a shell
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
128 with one argument, SEARCH-STRING. The program determines which
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
129 database it searches. The output of the program should consist
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
130 of those file names in the database that match SEARCH-STRING,
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
131 listed one per line, possibly with leading or trailing
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
132 whitespace. If the output is in another form, you may have to
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
133 redefine the function `locate-get-file-positions'.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
134
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
135 The program may interpret SEARCH-STRING as a literal string, a
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
136 shell pattern or a regular expression. The exact rules of what
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
137 constitutes a match may also depend on the program.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
138
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
139 The standard value of this variable is \"locate\".
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
140 This program normally searches a database of all files on your
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
141 system, or of all files that you have access to. Consult the
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
142 documentation of that program for the details about how it determines
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
143 which file names match SEARCH-STRING. (Those details vary highly with
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
144 the version.)"
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
145 :type 'string
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
146 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147
111777
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
148 (defcustom locate-post-command-hook nil
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
149 "List of hook functions run after `locate' (see `run-hooks')."
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
150 :type 'hook
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
151 :group 'locate)
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
152
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 (defvar locate-history-list nil
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154 "The history list used by the \\[locate] command.")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
155
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
156 (defvar locate-grep-history-list nil
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
157 "The history list used by the \\[locate-with-filter] command.")
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
158
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
159 (defcustom locate-make-command-line 'locate-default-make-command-line
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
160 "Function used to create the locate command line.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
161 The Emacs commands `locate' and `locate-with-filter' use this.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
162 This function should take one argument, a string (the name to find)
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
163 and return a list of strings. The first element of the list should be
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
164 the name of a command to be executed by a shell, the remaining elements
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
165 should be the arguments to that command (including the name to find)."
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
166 :type 'function
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
167 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
168
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
169 (defcustom locate-buffer-name "*Locate*"
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
170 "Name of the buffer to show results from the \\[locate] command."
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
171 :type 'string
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
172 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
173
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
174 (defcustom locate-fcodes-file nil
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
175 "File name for the database of file names used by `locate'.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
176 If non-nil, `locate' uses this name in the header of the `*Locate*'
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
177 buffer. If nil, it mentions no file name in that header.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
178
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
179 Just setting this variable does not actually change the database
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
180 that `locate' searches. The executive program that the Emacs
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
181 function `locate' uses, as given by the variables `locate-command'
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
182 or `locate-make-command-line', determines the database."
67910
6b29582fc810 * locate.el (locate-fcodes-file, locate-header-face):
Juri Linkov <juri@jurta.org>
parents: 67805
diff changeset
183 :type '(choice (const :tag "None" nil) file)
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
184 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
186 (defcustom locate-header-face nil
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
187 "Face used to highlight the locate header."
67910
6b29582fc810 * locate.el (locate-fcodes-file, locate-header-face):
Juri Linkov <juri@jurta.org>
parents: 67805
diff changeset
188 :type '(choice (const :tag "None" nil) face)
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
189 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
191 ;;;###autoload
105939
a0f778f4a995 * term/x-win.el (x-gtk-stock-map):
Dan Nicolaescu <dann@ics.uci.edu>
parents: 104932
diff changeset
192 (defcustom locate-ls-subdir-switches (purecopy "-al")
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
193 "`ls' switches for inserting subdirectories in `*Locate*' buffers.
55952
8fa8ca76955c (locate-ls-subdir-switches): Minor doc change (filling).
Luc Teirlinck <teirllm@auburn.edu>
parents: 55948
diff changeset
194 This should contain the \"-l\" switch, but not the \"-F\" or \"-b\" switches."
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
195 :type 'string
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
196 :group 'locate
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 55952
diff changeset
197 :version "22.1")
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
198
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
199 (defcustom locate-update-when-revert nil
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
200 "This option affects how the *Locate* buffer gets reverted.
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
201 If non-nil, offer to update the locate database when reverting that buffer.
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
202 \(Normally, you need to have root privileges for this to work. See the
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
203 option `locate-update-path'.)
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
204 If nil, reverting does not update the locate database."
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
205 :type 'boolean
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
206 :group 'locate
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
207 :version "22.1")
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
208
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
209 (defcustom locate-update-command "updatedb"
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
210 "The executable program used to update the locate database."
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
211 :type 'string
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
212 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
214 (defcustom locate-update-path "/"
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
215 "The default directory from where `locate-update-command' is called.
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
216 Usually, root permissions are required to run that command. This
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
217 can be achieved by setting this option to \"/su::\" or \"/sudo::\"
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
218 \(if you have the appropriate authority). If your current user
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
219 permissions are sufficient to run the command, you can set this
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
220 option to \"/\"."
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
221 :type 'string
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
222 :group 'locate
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
223 :version "22.1")
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
224
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
225 (defcustom locate-prompt-for-command nil
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
226 "If non-nil, the `locate' command prompts for a command to run.
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
227 Otherwise, that behavior is invoked via a prefix argument.
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
228
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
229 Setting this option non-nil actually inverts the meaning of a prefix arg;
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
230 that is, with a prefix arg, you get the default behavior."
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
231 :group 'locate
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
232 :type 'boolean)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
233
111777
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
234 (defcustom locate-mode-hook nil
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
235 "List of hook functions run by `locate-mode' (see `run-mode-hooks')."
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
236 :type 'hook
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
237 :group 'locate)
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
238
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239 ;; Functions
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241 (defun locate-default-make-command-line (search-string)
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
242 (list locate-command search-string))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243
28413
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
244 (defun locate-word-at-point ()
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
245 (let ((pt (point)))
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
246 (buffer-substring-no-properties
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
247 (save-excursion
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
248 (skip-chars-backward "-a-zA-Z0-9.")
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
249 (point))
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
250 (save-excursion
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
251 (skip-chars-forward "-a-zA-Z0-9.")
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
252 (skip-chars-backward "." pt)
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
253 (point)))))
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
254
77470
84802af12767 Add comment.
Chong Yidong <cyd@stupidchicken.com>
parents: 77450
diff changeset
255 ;; Function for use in interactive declarations.
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
256 (defun locate-prompt-for-search-string ()
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
257 (if (or (and current-prefix-arg
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
258 (not locate-prompt-for-command))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
259 (and (not current-prefix-arg) locate-prompt-for-command))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
260 (let ((locate-cmd (funcall locate-make-command-line "")))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
261 (read-from-minibuffer
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
262 "Run locate (like this): "
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
263 (cons
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
264 (concat (car locate-cmd) " "
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
265 (mapconcat 'identity (cdr locate-cmd) " "))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
266 (+ 2 (length (car locate-cmd))))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
267 nil nil 'locate-history-list))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
268 (let* ((default (locate-word-at-point))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
269 (input
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
270 (read-from-minibuffer
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
271 (if (> (length default) 0)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
272 (format "Locate (default %s): " default)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
273 (format "Locate: "))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
274 nil nil nil 'locate-history-list default t)))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
275 (and (equal input "") default
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
276 (setq input default))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
277 input)))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
278
22346
63a521c6f816 *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 21584
diff changeset
279 ;;;###autoload
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
280 (defun locate (search-string &optional filter arg)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
281 "Run the program `locate', putting results in `*Locate*' buffer.
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
282 Pass it SEARCH-STRING as argument. Interactively, prompt for SEARCH-STRING.
111352
9c78ac7dcdf0 * lisp/locate.el (locate, locate-mode): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
283 With prefix arg ARG, prompt for the exact shell command to run instead.
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
284
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
285 This program searches for those file names in a database that match
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
286 SEARCH-STRING and normally outputs all matching absolute file names,
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
287 one per line. The database normally consists of all files on your
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
288 system, or of all files that you have access to. Consult the
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
289 documentation of the program for the details about how it determines
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
290 which file names match SEARCH-STRING. (Those details vary highly with
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
291 the version.)
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
292
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
293 You can specify another program for this command to run by customizing
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
294 the variables `locate-command' or `locate-make-command-line'.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
295
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
296 The main use of FILTER is to implement `locate-with-filter'. See
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
297 the docstring of that function for its meaning.
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
298
111352
9c78ac7dcdf0 * lisp/locate.el (locate, locate-mode): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
299 After preparing the results buffer, this runs `dired-mode-hook' and
9c78ac7dcdf0 * lisp/locate.el (locate, locate-mode): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
300 then `locate-post-command-hook'."
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301 (interactive
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
302 (list
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
303 (locate-prompt-for-search-string)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
304 nil
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
305 current-prefix-arg))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
306
41202
e9fb112f3550 (locate): Show default locate pattern within the
Richard M. Stallman <rms@gnu.org>
parents: 39184
diff changeset
307 (if (equal search-string "")
42317
c427880038a5 (locate): Remove dot at the end of error argument.
Pavel Janík <Pavel@Janik.cz>
parents: 41629
diff changeset
308 (error "Please specify a filename to search for"))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
309 (let* ((locate-cmd-list (funcall locate-make-command-line search-string))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
310 (locate-cmd (car locate-cmd-list))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
311 (locate-cmd-args (cdr locate-cmd-list))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
312 (run-locate-command
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
313 (or (and arg (not locate-prompt-for-command))
111352
9c78ac7dcdf0 * lisp/locate.el (locate, locate-mode): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
314 (and (not arg) locate-prompt-for-command))))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
315
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316 ;; Find the Locate buffer
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
317 (save-window-excursion
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
318 (set-buffer (get-buffer-create locate-buffer-name))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
319 (locate-mode)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
320 (let ((inhibit-read-only t)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
321 (buffer-undo-list t))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
322 (erase-buffer)
72745
3e504dad08cd (locate-current-search): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 71600
diff changeset
323
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
324 (setq locate-current-filter filter)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
325 (set (make-local-variable 'locate-local-search) search-string)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
326 (set (make-local-variable 'locate-local-filter) filter)
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
327 (set (make-local-variable 'locate-local-prompt) run-locate-command)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
328
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
329 (if run-locate-command
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
330 (shell-command search-string locate-buffer-name)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
331 (apply 'call-process locate-cmd nil t nil locate-cmd-args))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
332
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
333 (and filter
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
334 (locate-filter-output filter))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335
111352
9c78ac7dcdf0 * lisp/locate.el (locate, locate-mode): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
336 (locate-do-setup search-string)))
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
337 (and (not (string-equal (buffer-name) locate-buffer-name))
108722
0d6255a71f15 * locate.el (locate): Use pop-to-buffer instead of
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
338 (pop-to-buffer locate-buffer-name))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
339
28413
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
340 (run-hooks 'dired-mode-hook)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
341 (dired-next-line 3) ;move to first matching file.
111352
9c78ac7dcdf0 * lisp/locate.el (locate, locate-mode): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
342 (run-hooks 'locate-post-command-hook)))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
343
22347
f53740d7d40d *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 22346
diff changeset
344 ;;;###autoload
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
345 (defun locate-with-filter (search-string filter &optional arg)
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
346 "Run the executable program `locate' with a filter.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
347 This function is similar to the function `locate', which see.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
348 The difference is that, when invoked interactively, the present function
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
349 prompts for both SEARCH-STRING and FILTER. It passes SEARCH-STRING
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
350 to the locate executable program. It produces a `*Locate*' buffer
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
351 that lists only those lines in the output of the locate program that
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
352 contain a match for the regular expression FILTER; this is often useful
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
353 to constrain a big search.
26578
8ea5bfbb88f8 (locate-with-filter): Doc fix.
Gerd Moellmann <gerd@gnu.org>
parents: 26043
diff changeset
354
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
355 ARG is the interactive prefix arg, which has the same effect as in `locate'.
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
356
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
357 When called from Lisp, this function is identical with `locate',
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
358 except that FILTER is not optional."
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 (interactive
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
360 (list
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
361 (locate-prompt-for-search-string)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
362 (read-from-minibuffer "Filter: " nil nil
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
363 nil 'locate-grep-history-list)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
364 current-prefix-arg))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
365 (locate search-string filter arg))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
366
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367 (defun locate-filter-output (filter)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 "Filter output from the locate command."
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 (goto-char (point-min))
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
370 (keep-lines filter))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371
104932
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
372 (defvar locate-mode-map
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
373 (let ((map (copy-keymap dired-mode-map)))
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
374 ;; Undefine Useless Dired Menu bars
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
375 (define-key map [menu-bar Dired] 'undefined)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
376 (define-key map [menu-bar subdir] 'undefined)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
377 (define-key map [menu-bar mark executables] 'undefined)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
378 (define-key map [menu-bar mark directory] 'undefined)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
379 (define-key map [menu-bar mark directories] 'undefined)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
380 (define-key map [menu-bar mark symlinks] 'undefined)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
381 (define-key map [M-mouse-2] 'locate-mouse-view-file)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
382 (define-key map "\C-c\C-t" 'locate-tags)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
383 (define-key map "l" 'locate-do-redisplay)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
384 (define-key map "U" 'dired-unmark-all-files)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
385 (define-key map "V" 'locate-find-directory)
61bdc52b913e (top-level): Always require dired.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
386 map)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 "Local keymap for Locate mode buffers.")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389 ;; This variable is used to indent the lines and then to search for
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
390 ;; the file name
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
391 (defconst locate-filename-indentation 4
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
392 "The amount of indentation for each file.")
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 (defun locate-get-file-positions ()
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
395 "Return list of start and end of the file name on the current line.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
396 This is a list of two buffer positions.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
397
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
398 You should only call this function on lines that contain a file name
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
399 listed by the locate program. Inside inserted subdirectories, or if
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
400 there is no file name on the current line, the return value is
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
401 meaningless. You can check whether the current line contains a file
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
402 listed by the locate program, using the function
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
403 `locate-main-listing-line-p'."
82788
eeb100f7184f (locate-get-file-positions): Use
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 78236
diff changeset
404 (list (+ locate-filename-indentation
eeb100f7184f (locate-get-file-positions): Use
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 78236
diff changeset
405 (line-beginning-position))
eeb100f7184f (locate-get-file-positions): Use
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 78236
diff changeset
406 ;; Assume names end at the end of the line.
eeb100f7184f (locate-get-file-positions): Use
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 78236
diff changeset
407 (line-end-position)))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 ;; From SQL-mode
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
410 (defun locate-current-line-number ()
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 "Return the current line number, as an integer."
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 (+ (count-lines (point-min) (point))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 (if (eq (current-column) 0)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 1
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 0)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
417 ;; You should only call this function on lines that contain a file name
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
418 ;; listed by the locate program. Inside inserted subdirectories, or if
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
419 ;; there is no file name on the current line, the return value is
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
420 ;; meaningless. You can check whether the current line contains a file
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
421 ;; listed by the locate program, using the function
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
422 ;; `locate-main-listing-line-p'.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 (defun locate-get-filename ()
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 (let ((pos (locate-get-file-positions))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
425 (lineno (locate-current-line-number)))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
426 (and (not (eq lineno 1))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
427 (not (eq lineno 2))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428 (buffer-substring (elt pos 0) (elt pos 1)))))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
430 (defun locate-main-listing-line-p ()
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
431 "Return t if current line contains a file name listed by locate.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
432 This function returns nil if the current line either contains no
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
433 file name or is inside a subdirectory."
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
434 (save-excursion
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
435 (forward-line 0)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
436 (looking-at (concat "."
74233
4267b07f90ba (locate-main-listing-line-p, locate-mode, locate-do-setup): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents: 72745
diff changeset
437 (make-string (1- locate-filename-indentation) ?\s)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
438 "\\(/\\|[A-Za-z]:\\)"))))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
439
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
440 (defun locate-mouse-view-file (event)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441 "In Locate mode, view a file, using the mouse."
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
442 (interactive "@e")
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 (save-excursion
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444 (goto-char (posn-point (event-start event)))
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
445 (if (locate-main-listing-line-p)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
446 (view-file (locate-get-filename))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
447 (message "This command only works inside main listing."))))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
448
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
449 ;; Define a mode for locate
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
450 ;; Default directory is set to "/" so that dired commands, which
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
451 ;; expect to be in a tree, will work properly
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 (defun locate-mode ()
55711
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
453 "Major mode for the `*Locate*' buffer made by \\[locate].
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
454 \\<locate-mode-map>\
55711
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
455 In that buffer, you can use almost all the usual dired bindings.
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
456 \\[locate-find-directory] visits the directory of the file on the current line.
111352
9c78ac7dcdf0 * lisp/locate.el (locate, locate-mode): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
457 This function runs `locate-mode-hook' before returning.
55711
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
458
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
459 Operating on listed files works, but does not always
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
460 automatically update the buffer as in ordinary Dired.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
461 This is true both for the main listing and for subdirectories.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
462 Reverting the buffer using \\[revert-buffer] deletes all subdirectories.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
463 Specific `locate-mode' commands, such as \\[locate-find-directory],
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
464 do not work in subdirectories.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
465
55711
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
466 \\{locate-mode-map}"
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
467 ;; Not to be called interactively.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 (kill-all-local-variables)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
469 ;; Avoid clobbering this variable
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
470 (make-local-variable 'dired-subdir-alist)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 (use-local-map locate-mode-map)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472 (setq major-mode 'locate-mode
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 mode-name "Locate"
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
474 default-directory "/"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
475 buffer-read-only t
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
476 selective-display t)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
477 (dired-alist-add-1 default-directory (point-min-marker))
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
478 (set (make-local-variable 'dired-directory) "/")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
479 (set (make-local-variable 'dired-subdir-switches) locate-ls-subdir-switches)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
480 (setq dired-switches-alist nil)
66325
fda96ff4c7e5 * files.el (directory-listing-before-filename-regexp): New
Michael Albinus <michael.albinus@gmx.de>
parents: 65680
diff changeset
481 (make-local-variable 'directory-listing-before-filename-regexp)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
482 ;; This should support both Unix and Windoze style names
66325
fda96ff4c7e5 * files.el (directory-listing-before-filename-regexp): New
Michael Albinus <michael.albinus@gmx.de>
parents: 65680
diff changeset
483 (setq directory-listing-before-filename-regexp
111777
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
484 (concat "^.\\("
74233
4267b07f90ba (locate-main-listing-line-p, locate-mode, locate-do-setup): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents: 72745
diff changeset
485 (make-string (1- locate-filename-indentation) ?\s)
111777
68ad8caf0020 Fix bug #7308 with `locate' on MS-Windows.
Eli Zaretskii <eliz@gnu.org>
parents: 111352
diff changeset
486 "\\)\\|"
66325
fda96ff4c7e5 * files.el (directory-listing-before-filename-regexp): New
Michael Albinus <michael.albinus@gmx.de>
parents: 65680
diff changeset
487 (default-value 'directory-listing-before-filename-regexp)))
16795
2a9ae2be61ae (locate-mode): Locally set dired-move-to-filename-regexp,
Richard M. Stallman <rms@gnu.org>
parents: 16781
diff changeset
488 (make-local-variable 'dired-actual-switches)
2a9ae2be61ae (locate-mode): Locally set dired-move-to-filename-regexp,
Richard M. Stallman <rms@gnu.org>
parents: 16781
diff changeset
489 (setq dired-actual-switches "")
2a9ae2be61ae (locate-mode): Locally set dired-move-to-filename-regexp,
Richard M. Stallman <rms@gnu.org>
parents: 16781
diff changeset
490 (make-local-variable 'dired-permission-flags-regexp)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
491 (setq dired-permission-flags-regexp
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
492 (concat "^.\\("
74233
4267b07f90ba (locate-main-listing-line-p, locate-mode, locate-do-setup): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents: 72745
diff changeset
493 (make-string (1- locate-filename-indentation) ?\s)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
494 "\\)\\|"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
495 (default-value 'dired-permission-flags-regexp)))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
496 (make-local-variable 'revert-buffer-function)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
497 (setq revert-buffer-function 'locate-update)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
498 (set (make-local-variable 'page-delimiter) "\n\n")
62735
86807c2c8e61 (locate-mode): Use run-mode-hooks.
Lute Kamstra <lute@gnu.org>
parents: 59996
diff changeset
499 (run-mode-hooks 'locate-mode-hook))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
501 (defun locate-do-setup (search-string)
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
502 (goto-char (point-min))
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
503 (save-excursion
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
504
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
505 ;; Nothing returned from locate command?
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
506 (and (eobp)
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
507 (progn
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
508 (kill-buffer locate-buffer-name)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
509 (if locate-current-filter
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
510 (error "Locate: no match for %s in database using filter %s"
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
511 search-string locate-current-filter)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
512 (error "Locate: no match for %s in database" search-string))))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
513
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
514 (locate-insert-header search-string)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
515
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
516 (while (not (eobp))
74233
4267b07f90ba (locate-main-listing-line-p, locate-mode, locate-do-setup): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents: 72745
diff changeset
517 (insert-char ?\s locate-filename-indentation t)
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
518 (locate-set-properties)
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
519 (forward-line 1)))
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
520 (goto-char (point-min)))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522 (defun locate-set-properties ()
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523 (save-excursion
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524 (let ((pos (locate-get-file-positions)))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
525 (dired-insert-set-properties (elt pos 0) (elt pos 1)))))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527 (defun locate-insert-header (search-string)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
528 ;; There needs to be a space before `Matches, because otherwise,
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
529 ;; `*!" would erase the `M'. We can not use two spaces, or the line
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
530 ;; would mistakenly fit `dired-subdir-regexp'.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
531 (let ((locate-format-string " /:\n Matches for %s")
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 (locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 (concat " *Matches for \\(" (regexp-quote search-string) "\\)"))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 (locate-format-args (list search-string))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 )
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
536
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
537 (and locate-fcodes-file
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 (setq locate-format-string
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 (concat locate-format-string " in %s")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 (concat locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 " in \\("
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 (regexp-quote locate-fcodes-file)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 "\\)")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 locate-format-args
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 (append (list locate-fcodes-file) locate-format-args)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
548 (and locate-current-filter
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 (setq locate-format-string
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 (concat locate-format-string " using filter %s")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 (concat locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553 " using filter "
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554 "\\("
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555 (regexp-quote locate-current-filter)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
556 "\\)")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557 locate-format-args
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 (append (list locate-current-filter) locate-format-args)))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
559
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 (setq locate-format-string
39184
99eeeafafa93 (locate-insert-header): Remove unnecessary
Gerd Moellmann <gerd@gnu.org>
parents: 31237
diff changeset
561 (concat locate-format-string ":\n\n")
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 locate-regexp-match
39184
99eeeafafa93 (locate-insert-header): Remove unnecessary
Gerd Moellmann <gerd@gnu.org>
parents: 31237
diff changeset
563 (concat locate-regexp-match ":\n"))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
564
16795
2a9ae2be61ae (locate-mode): Locally set dired-move-to-filename-regexp,
Richard M. Stallman <rms@gnu.org>
parents: 16781
diff changeset
565 (insert (apply 'format locate-format-string (reverse locate-format-args)))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
566
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 (save-excursion
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 (goto-char (point-min))
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
569 (forward-line 1)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 (if (not (looking-at locate-regexp-match))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 nil
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572 (add-text-properties (match-beginning 1) (match-end 1)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
573 (list 'face locate-header-face))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574 (and (match-beginning 2)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 (add-text-properties (match-beginning 2) (match-end 2)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 (list 'face locate-header-face)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
577 (and (match-beginning 3)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578 (add-text-properties (match-beginning 3) (match-end 3)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 (list 'face locate-header-face)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 ))))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 (defun locate-tags ()
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 "Visit a tags table in `*Locate*' mode."
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 (interactive)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
585 (if (locate-main-listing-line-p)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
586 (let ((tags-table (locate-get-filename)))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
587 (and (y-or-n-p (format "Visit tags table %s? " tags-table))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
588 (visit-tags-table tags-table)))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
589 (message "This command only works inside main listing.")))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
590
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
591 ;; From Stephen Eglen <stephen@cns.ed.ac.uk>
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
592 (defun locate-update (ignore1 ignore2)
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
593 "Revert the *Locate* buffer.
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
594 If `locate-update-when-revert' is non-nil, offer to update the
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
595 locate database using the shell command in `locate-update-command'."
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
596 (let ((locate-buffer-name (buffer-name))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
597 (locate-prompt-for-command locate-local-prompt))
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
598 (and locate-update-when-revert
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
599 (yes-or-no-p "Update locate database (may take a few seconds)? ")
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
600 ;; `expand-file-name' is used in order to autoload Tramp if
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
601 ;; necessary. It cannot be loaded when `default-directory'
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
602 ;; is remote.
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
603 (let ((default-directory (expand-file-name locate-update-path)))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
604 (shell-command locate-update-command)))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
605 (locate locate-local-search locate-local-filter)))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
606
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
607 ;;; Modified three functions from `dired.el':
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
608 ;;; dired-find-directory,
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
609 ;;; dired-find-directory-other-window
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
610 ;;; dired-get-filename
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
611
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
612 (defun locate-find-directory ()
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
613 "Visit the directory of the file mentioned on this line."
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
614 (interactive)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
615 (if (locate-main-listing-line-p)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
616 (let ((directory-name (locate-get-dirname)))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
617 (if (file-directory-p directory-name)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
618 (find-file directory-name)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
619 (if (file-symlink-p directory-name)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
620 (error "Directory is a symlink to a nonexistent target")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
621 (error "Directory no longer exists; run `updatedb' to update database"))))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
622 (message "This command only works inside main listing.")))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
623
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
624 (defun locate-find-directory-other-window ()
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
625 "Visit the directory of the file named on this line in other window."
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
626 (interactive)
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
627 (if (locate-main-listing-line-p)
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
628 (find-file-other-window (locate-get-dirname))
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
629 (message "This command only works inside main listing.")))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
630
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
631 ;; You should only call this function on lines that contain a file name
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
632 ;; listed by the locate program. Inside inserted subdirectories, or if
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
633 ;; there is no file name on the current line, the return value is
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
634 ;; meaningless. You can check whether the current line contains a file
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
635 ;; listed by the locate program, using the function
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
636 ;; `locate-main-listing-line-p'.
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
637 (defun locate-get-dirname ()
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
638 "Return the directory name of the file mentioned on this line."
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
639 (let (file (filepos (locate-get-file-positions)))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
640 (if (setq file (buffer-substring (nth 0 filepos) (nth 1 filepos)))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
641 (progn
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
642 ;; Get rid of the mouse-face property that file names have.
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
643 (set-text-properties 0 (length file) nil file)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
644 (setq file (file-name-directory file))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
645 ;; Unquote names quoted by ls or by dired-insert-directory.
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
646 ;; Using read to unquote is much faster than substituting
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
647 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
648 (setq file
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
649 (read
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
650 (concat "\""
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
651 ;; some ls -b don't escape quotes, argh!
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
652 ;; This is not needed for GNU ls, though.
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
653 (or (dired-string-replace-match
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
654 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
655 file)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
656 "\"")))))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
657 (and file buffer-file-coding-system
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
658 (not file-name-coding-system)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
659 (setq file (encode-coding-string file buffer-file-coding-system)))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
660 file))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
661
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
662 ;; Only for GNU locate
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
663 (defun locate-in-alternate-database (search-string database)
77603
880a458895b9 (locate-in-alternate-database): Doc fix mistakenly left out of
Glenn Morris <rgm@gnu.org>
parents: 77503
diff changeset
664 "Run the GNU locate program, using an alternate database.
77503
40acbd9992e2 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
665
40acbd9992e2 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
666 This command only works if you use GNU locate. It does not work
40acbd9992e2 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
667 properly if `locate-prompt-for-command' is set to t. In that
40acbd9992e2 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
668 case, you can just run the regular `locate' command and specify
40acbd9992e2 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
669 the database on the command line."
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
670 (interactive
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
671 (list
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
672 (progn
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
673 ;; (require 'locate)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
674 (read-from-minibuffer "Locate: " nil nil
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
675 nil 'locate-history-list))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
676 (read-file-name "Locate using Database: " )
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
677 ))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
678 (or (file-exists-p database)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
679 (error "Database file %s does not exist" database))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
680 (let ((locate-make-command-line
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
681 (function (lambda (string)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
682 (cons locate-command
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
683 (list (concat "--database="
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
684 (expand-file-name database))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
685 string))))))
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
686 (locate search-string)))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
688 (defun locate-do-redisplay (&optional arg test-for-subdir)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
689 "Like `dired-do-redisplay', but adapted for `*Locate*' buffers."
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
690 (interactive "P\np")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
691 (if (string= (dired-current-directory) "/")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
692 (message "This command only works in subdirectories.")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
693 (let ((dired-actual-switches locate-ls-subdir-switches))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
694 (dired-do-redisplay arg test-for-subdir))))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
695
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696 (provide 'locate)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 ;;; locate.el ends here