annotate lisp/locate.el @ 79126:649994f034f1

*** empty log message ***
author Juanma Barranquero <lekktu@gmail.com>
date Wed, 17 Oct 2007 08:51:04 +0000
parents 9355f9b7bbff
children 73661ddc7ac7 eeb100f7184f f55f9811f5d7
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
64762
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64091
diff changeset
3 ;; Copyright (C) 1996, 1998, 2001, 2002, 2003, 2004,
75347
e3694f1cb928 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 74233
diff changeset
4 ;; 2005, 2006, 2007 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
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
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
78236
9355f9b7bbff Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 77603
diff changeset
13 ;; the Free Software Foundation; either version 3, or (at your option)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; any later version.
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
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64091
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 62735
diff changeset
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 62735
diff changeset
24 ;; Boston, MA 02110-1301, USA.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
28 ;; 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
29 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; Locate.el provides an interface to a program which searches a
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;; database of file names. By default, this program is the GNU locate
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 ;; 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
33 ;; user specified command.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 ;; 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
36 ;; form
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 ;; SHELLPROGRAM Name-to-find
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 ;;
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
40 ;; set the variable `locate-command' in your .emacs file.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 ;;
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
42 ;; 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
43 ;; 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
44 ;; 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
45 ;; 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
46 ;;
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
47 ;; (setq locate-make-command-line 'my-locate-command-line)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 ;; 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
50 ;; my-locate-command-line.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 ;; You should make sure that whichever command you use works correctly
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 ;; 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
54 ;; to either be in standard places or located via environment variables.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 ;; 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
56 ;; your emacs process.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 ;; Locate-mode assumes that each line output from the locate-command
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 ;; consists exactly of a file name, possibly preceded or trailed by
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 ;; 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
61 ;; 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
62 ;; `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
63 ;; 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
64 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 ;; 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
66 ;; 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
67 ;; the resulting *Locate* buffer. It is worth noting that your commands
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 ;; do not, of course, affect the file database. For example, if you
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 ;; compress a file in the locate buffer, the actual file will be
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 ;; compressed, but the entry in the file database will not be
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 ;; 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
72 ;; of sync until the next time the database is updated.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 ;;
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
74 ;; The command `locate-with-filter' keeps only lines matching a
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 ;; regular expression; this is often useful to constrain a big search.
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 ;;
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
78 ;;;;; Building a database of files ;;;;;;;;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
79 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
80 ;; 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
81 ;; 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
82 ;; 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
83 ;; included with Microsoft FrontPage, or the shareware NTCron program.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
84 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
85 ;; 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
86 ;; like this:
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
87 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
88 ;; (defvar locate-fcodes-file "c:/users/peter/fcodes")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
89 ;; (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
90 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
91 ;; (defun nt-locate-make-command-line (arg)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
92 ;; (list "grep" "-i" arg locate-fcodes-file))
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 ;;;;;;;; ADVICE For dired-make-relative: ;;;;;;;;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
95 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
96 ;; 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
97 ;; following in your _emacs/.emacs:
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
98 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
99 ;; (defadvice dired-make-relative (before set-no-error activate)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
100 ;; "For locate mode and Windows, don't return errors"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
101 ;; (if (and (eq major-mode 'locate-mode)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
102 ;; (memq system-type (list 'windows-nt 'ms-dos)))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
103 ;; (ad-set-arg 2 t)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
104 ;; ))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
105 ;;
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
106 ;; Otherwise, `dired-make-relative' will give error messages like
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
107 ;; "FILENAME: not in directory tree growing at /"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
108
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
109
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 ;;; Code:
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 (eval-when-compile
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 (require 'dired))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 ;; Variables
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
116
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
117 (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
118 (defvar locate-local-filter nil)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
119 (defvar locate-local-search nil)
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
120 (defvar locate-local-prompt nil)
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
121
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
122 (defgroup locate nil
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
123 "Interface to the locate command."
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
124 :prefix "locate-"
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
125 :group 'external)
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
126
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
127 (defcustom locate-command "locate"
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
128 "Executable program for searching a database of files.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
129 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
130 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
131 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
132 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
133 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
134 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
135 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
136 redefine the function `locate-get-file-positions'.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
137
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
138 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
139 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
140 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
141
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
142 The standard value of this variable is \"locate\".
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
143 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
144 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
145 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
146 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
147 the version.)"
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
148 :type 'string
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
149 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151 (defvar locate-history-list nil
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152 "The history list used by the \\[locate] command.")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
154 (defvar locate-grep-history-list nil
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
155 "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
156
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
157 (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
158 "Function used to create the locate command line.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
159 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
160 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
161 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
162 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
163 should be the arguments to that command (including the name to find)."
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
164 :type 'function
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
165 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
166
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
167 (defcustom locate-buffer-name "*Locate*"
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
168 "Name of the buffer to show results from the \\[locate] command."
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
169 :type 'string
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
170 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
172 (defcustom locate-fcodes-file nil
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
173 "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
174 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
175 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
176
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
177 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
178 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
179 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
180 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
181 :type '(choice (const :tag "None" nil) file)
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
182 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
184 (defcustom locate-header-face nil
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
185 "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
186 :type '(choice (const :tag "None" nil) face)
20845
2fd9f2883ad4 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 17517
diff changeset
187 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
189 ;;;###autoload
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
190 (defcustom locate-ls-subdir-switches "-al"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
191 "`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
192 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
193 :type 'string
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
194 :group 'locate
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 55952
diff changeset
195 :version "22.1")
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
196
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
197 (defcustom locate-update-when-revert nil
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
198 "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
199 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
200 \(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
201 option `locate-update-path'.)
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
202 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
203 :type 'boolean
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
204 :group 'locate
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
205 :version "22.1")
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
206
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
207 (defcustom locate-update-command "updatedb"
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
208 "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
209 :type 'string
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
210 :group 'locate)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
212 (defcustom locate-update-path "/"
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
213 "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
214 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
215 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
216 \(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
217 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
218 option to \"/\"."
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
219 :type 'string
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
220 :group 'locate
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
221 :version "22.1")
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
222
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
223 (defcustom locate-prompt-for-command nil
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
224 "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
225 Otherwise, that behavior is invoked via a prefix argument.
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
226
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
227 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
228 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
229 :group 'locate
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
230 :type 'boolean)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
231
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 ;; Functions
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 (defun locate-default-make-command-line (search-string)
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
235 (list locate-command search-string))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236
28413
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
237 (defun locate-word-at-point ()
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
238 (let ((pt (point)))
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
239 (buffer-substring-no-properties
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
240 (save-excursion
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
241 (skip-chars-backward "-a-zA-Z0-9.")
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
242 (point))
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
243 (save-excursion
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
244 (skip-chars-forward "-a-zA-Z0-9.")
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
245 (skip-chars-backward "." pt)
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
246 (point)))))
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
247
77470
84802af12767 Add comment.
Chong Yidong <cyd@stupidchicken.com>
parents: 77450
diff changeset
248 ;; Function for use in interactive declarations.
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
249 (defun locate-prompt-for-search-string ()
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
250 (if (or (and current-prefix-arg
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
251 (not locate-prompt-for-command))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
252 (and (not current-prefix-arg) locate-prompt-for-command))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
253 (let ((locate-cmd (funcall locate-make-command-line "")))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
254 (read-from-minibuffer
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
255 "Run locate (like this): "
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
256 (cons
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
257 (concat (car locate-cmd) " "
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
258 (mapconcat 'identity (cdr locate-cmd) " "))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
259 (+ 2 (length (car locate-cmd))))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
260 nil nil 'locate-history-list))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
261 (let* ((default (locate-word-at-point))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
262 (input
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
263 (read-from-minibuffer
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
264 (if (> (length default) 0)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
265 (format "Locate (default %s): " default)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
266 (format "Locate: "))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
267 nil nil nil 'locate-history-list default t)))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
268 (and (equal input "") default
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
269 (setq input default))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
270 input)))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
271
22346
63a521c6f816 *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 21584
diff changeset
272 ;;;###autoload
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
273 (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
274 "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
275 Pass it SEARCH-STRING as argument. Interactively, prompt for SEARCH-STRING.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
276 With prefix arg, prompt for the exact shell command to run instead.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
277
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
278 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
279 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
280 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
281 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
282 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
283 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
284 the version.)
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
285
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
286 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
287 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
288
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
289 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
290 the docstring of that function for its meaning.
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
291
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
292 ARG is the interactive prefix arg."
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293 (interactive
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
294 (list
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
295 (locate-prompt-for-search-string)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
296 nil
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
297 current-prefix-arg))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
298
41202
e9fb112f3550 (locate): Show default locate pattern within the
Richard M. Stallman <rms@gnu.org>
parents: 39184
diff changeset
299 (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
300 (error "Please specify a filename to search for"))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
301 (let* ((locate-cmd-list (funcall locate-make-command-line search-string))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302 (locate-cmd (car locate-cmd-list))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303 (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
304 (run-locate-command
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
305 (or (and arg (not locate-prompt-for-command))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
306 (and (not arg) locate-prompt-for-command)))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
307 )
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
308
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309 ;; Find the Locate buffer
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
310 (save-window-excursion
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
311 (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
312 (locate-mode)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
313 (let ((inhibit-read-only t)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
314 (buffer-undo-list t))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
315 (erase-buffer)
72745
3e504dad08cd (locate-current-search): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 71600
diff changeset
316
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
317 (setq locate-current-filter filter)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
318 (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
319 (set (make-local-variable 'locate-local-filter) filter)
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
320 (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
321
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
322 (if run-locate-command
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
323 (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
324 (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
325
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
326 (and filter
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
327 (locate-filter-output filter))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
328
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
329 (locate-do-setup search-string)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
330 ))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
331 (and (not (string-equal (buffer-name) locate-buffer-name))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
332 (switch-to-buffer-other-window locate-buffer-name))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
333
28413
abd1f2362ae0 Add locate-word-at-point function
Peter Breton <pbreton@attbi.com>
parents: 26578
diff changeset
334 (run-hooks 'dired-mode-hook)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
335 (dired-next-line 3) ;move to first matching file.
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
336 (run-hooks 'locate-post-command-hook)
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
337 )
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
338 )
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339
22347
f53740d7d40d *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 22346
diff changeset
340 ;;;###autoload
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
341 (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
342 "Run the executable program `locate' with a filter.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
343 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
344 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
345 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
346 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
347 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
348 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
349 to constrain a big search.
26578
8ea5bfbb88f8 (locate-with-filter): Doc fix.
Gerd Moellmann <gerd@gnu.org>
parents: 26043
diff changeset
350
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
351 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
352
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
353 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
354 except that FILTER is not optional."
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355 (interactive
77450
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
356 (list
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
357 (locate-prompt-for-search-string)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
358 (read-from-minibuffer "Filter: " nil nil
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
359 nil 'locate-grep-history-list)
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
360 current-prefix-arg))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
361 (locate search-string filter arg))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 (defun locate-filter-output (filter)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 "Filter output from the locate command."
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 (goto-char (point-min))
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
366 (keep-lines filter))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 (defvar locate-mode-map nil
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 "Local keymap for Locate mode buffers.")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
370 (if locate-mode-map
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371 nil
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 (require 'dired)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
375 (setq locate-mode-map (copy-keymap dired-mode-map))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377 ;; Undefine Useless Dired Menu bars
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 (define-key locate-mode-map [menu-bar Dired] 'undefined)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 (define-key locate-mode-map [menu-bar subdir] 'undefined)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 (define-key locate-mode-map [menu-bar mark executables] 'undefined)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 (define-key locate-mode-map [menu-bar mark directory] 'undefined)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 (define-key locate-mode-map [menu-bar mark directories] 'undefined)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 (define-key locate-mode-map [menu-bar mark symlinks] 'undefined)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
386 (define-key locate-mode-map [M-mouse-2] 'locate-mouse-view-file)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
387 (define-key locate-mode-map "\C-c\C-t" 'locate-tags)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
389 (define-key locate-mode-map "l" 'locate-do-redisplay)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
390 (define-key locate-mode-map "U" 'dired-unmark-all-files)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
391 (define-key locate-mode-map "V" 'locate-find-directory)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
392 )
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 ;; 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
395 ;; the file name
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396 (defconst locate-filename-indentation 4
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
397 "The amount of indentation for each file.")
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 (defun locate-get-file-positions ()
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
400 "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
401 This is a list of two buffer positions.
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
402
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
403 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
404 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
405 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
406 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
407 listed by the locate program, using the function
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
408 `locate-main-listing-line-p'."
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 (save-excursion
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
410 (end-of-line)
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
411 (let ((eol (point)))
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
412 (beginning-of-line)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
413
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
414 ;; Assumes names end at the end of the line
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
415 (forward-char locate-filename-indentation)
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
416 (list (point) eol))))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 ;; From SQL-mode
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
419 (defun locate-current-line-number ()
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 "Return the current line number, as an integer."
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 (+ (count-lines (point-min) (point))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422 (if (eq (current-column) 0)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 1
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 0)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
426 ;; 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
427 ;; 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
428 ;; 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
429 ;; 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
430 ;; listed by the locate program, using the function
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
431 ;; `locate-main-listing-line-p'.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432 (defun locate-get-filename ()
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
433 (let ((pos (locate-get-file-positions))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
434 (lineno (locate-current-line-number)))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
435 (and (not (eq lineno 1))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
436 (not (eq lineno 2))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
437 (buffer-substring (elt pos 0) (elt pos 1)))))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
439 (defun locate-main-listing-line-p ()
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
440 "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
441 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
442 file name or is inside a subdirectory."
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
443 (save-excursion
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
444 (forward-line 0)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
445 (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
446 (make-string (1- locate-filename-indentation) ?\s)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
447 "\\(/\\|[A-Za-z]:\\)"))))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
448
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
449 (defun locate-mouse-view-file (event)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
450 "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
451 (interactive "@e")
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 (save-excursion
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
453 (goto-char (posn-point (event-start event)))
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
454 (if (locate-main-listing-line-p)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
455 (view-file (locate-get-filename))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
456 (message "This command only works inside main listing."))))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458 ;; Define a mode for locate
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459 ;; Default directory is set to "/" so that dired commands, which
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 ;; expect to be in a tree, will work properly
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461 (defun locate-mode ()
55711
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
462 "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
463 \\<locate-mode-map>\
55711
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
464 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
465 \\[locate-find-directory] visits the directory of the file on the current line.
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
466
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
467 Operating on listed files works, but does not always
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
468 automatically update the buffer as in ordinary Dired.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
469 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
470 Reverting the buffer using \\[revert-buffer] deletes all subdirectories.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
471 Specific `locate-mode' commands, such as \\[locate-find-directory],
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
472 do not work in subdirectories.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
473
55711
0033865a2a2f (locate-prompt-for-command): Shorten first line of docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
474 \\{locate-mode-map}"
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
475 ;; Not to be called interactively.
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 (kill-all-local-variables)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
477 ;; Avoid clobbering this variable
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
478 (make-local-variable 'dired-subdir-alist)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 (use-local-map locate-mode-map)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 (setq major-mode 'locate-mode
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 mode-name "Locate"
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
482 default-directory "/"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
483 buffer-read-only t
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
484 selective-display t)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
485 (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
486 (set (make-local-variable 'dired-directory) "/")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
487 (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
488 (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
489 (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
490 ;; 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
491 (setq directory-listing-before-filename-regexp
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
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 "\\(/\\|[A-Za-z]:\\)\\|"
66325
fda96ff4c7e5 * files.el (directory-listing-before-filename-regexp): New
Michael Albinus <michael.albinus@gmx.de>
parents: 65680
diff changeset
495 (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
496 (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
497 (setq dired-actual-switches "")
2a9ae2be61ae (locate-mode): Locally set dired-move-to-filename-regexp,
Richard M. Stallman <rms@gnu.org>
parents: 16781
diff changeset
498 (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
499 (setq dired-permission-flags-regexp
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
500 (concat "^.\\("
74233
4267b07f90ba (locate-main-listing-line-p, locate-mode, locate-do-setup): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents: 72745
diff changeset
501 (make-string (1- locate-filename-indentation) ?\s)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
502 "\\)\\|"
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
503 (default-value 'dired-permission-flags-regexp)))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
504 (make-local-variable 'revert-buffer-function)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
505 (setq revert-buffer-function 'locate-update)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
506 (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
507 (run-mode-hooks 'locate-mode-hook))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
509 (defun locate-do-setup (search-string)
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
510 (goto-char (point-min))
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
511 (save-excursion
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
512
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
513 ;; Nothing returned from locate command?
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
514 (and (eobp)
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
515 (progn
77355
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
516 (kill-buffer locate-buffer-name)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
517 (if locate-current-filter
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
518 (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
519 search-string locate-current-filter)
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
520 (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
521
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
522 (locate-insert-header search-string)
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
523
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
524 (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
525 (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
526 (locate-set-properties)
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
527 (forward-line 1)))
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
528 (goto-char (point-min)))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 (defun locate-set-properties ()
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 (save-excursion
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 (let ((pos (locate-get-file-positions)))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
533 (dired-insert-set-properties (elt pos 0) (elt pos 1)))))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 (defun locate-insert-header (search-string)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
536 ;; 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
537 ;; `*!" 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
538 ;; would mistakenly fit `dired-subdir-regexp'.
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
539 (let ((locate-format-string " /:\n Matches for %s")
16781
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 " *Matches for \\(" (regexp-quote search-string) "\\)"))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 (locate-format-args (list search-string))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 )
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
544
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
545 (and locate-fcodes-file
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 (setq locate-format-string
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 (concat locate-format-string " in %s")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 (concat locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 " in \\("
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 (regexp-quote locate-fcodes-file)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 "\\)")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553 locate-format-args
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554 (append (list locate-fcodes-file) locate-format-args)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
556 (and locate-current-filter
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557 (setq locate-format-string
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 (concat locate-format-string " using filter %s")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 (concat locate-regexp-match
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 " using filter "
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 "\\("
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 (regexp-quote locate-current-filter)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 "\\)")
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 locate-format-args
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 (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
567
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 (setq locate-format-string
39184
99eeeafafa93 (locate-insert-header): Remove unnecessary
Gerd Moellmann <gerd@gnu.org>
parents: 31237
diff changeset
569 (concat locate-format-string ":\n\n")
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 locate-regexp-match
39184
99eeeafafa93 (locate-insert-header): Remove unnecessary
Gerd Moellmann <gerd@gnu.org>
parents: 31237
diff changeset
571 (concat locate-regexp-match ":\n"))
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
572
16795
2a9ae2be61ae (locate-mode): Locally set dired-move-to-filename-regexp,
Richard M. Stallman <rms@gnu.org>
parents: 16781
diff changeset
573 (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
574
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 (save-excursion
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 (goto-char (point-min))
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
577 (forward-line 1)
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578 (if (not (looking-at locate-regexp-match))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 nil
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 (add-text-properties (match-beginning 1) (match-end 1)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 (list 'face locate-header-face))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 (and (match-beginning 2)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 (add-text-properties (match-beginning 2) (match-end 2)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 (list 'face locate-header-face)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585 (and (match-beginning 3)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586 (add-text-properties (match-beginning 3) (match-end 3)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587 (list 'face locate-header-face)))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 ))))
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590 (defun locate-tags ()
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 "Visit a tags table in `*Locate*' mode."
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 (interactive)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
593 (if (locate-main-listing-line-p)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
594 (let ((tags-table (locate-get-filename)))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
595 (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
596 (visit-tags-table tags-table)))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
597 (message "This command only works inside main listing.")))
21056
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
598
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
599 ;; From Stephen Eglen <stephen@cns.ed.ac.uk>
124580b805a3 (locate-update): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20845
diff changeset
600 (defun locate-update (ignore1 ignore2)
71600
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
601 "Revert the *Locate* buffer.
6958f9575abf (locate-update-when-revert): New option.
Luc Teirlinck <teirllm@auburn.edu>
parents: 69501
diff changeset
602 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
603 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
604 (let ((locate-buffer-name (buffer-name))
86642e7d62bb (locate-local-prompt): New var.
Chong Yidong <cyd@stupidchicken.com>
parents: 77355
diff changeset
605 (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
606 (and locate-update-when-revert
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
607 (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
608 ;; `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
609 ;; 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
610 ;; is remote.
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
611 (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
612 (shell-command locate-update-command)))
beb9c71a4357 Revert 2006-09-09 and 2007-04-20 changes.
Chong Yidong <cyd@stupidchicken.com>
parents: 77335
diff changeset
613 (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
614
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
615 ;;; Modified three functions from `dired.el':
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
616 ;;; dired-find-directory,
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
617 ;;; dired-find-directory-other-window
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
618 ;;; dired-get-filename
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
619
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
620 (defun locate-find-directory ()
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
621 "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
622 (interactive)
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
623 (if (locate-main-listing-line-p)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
624 (let ((directory-name (locate-get-dirname)))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
625 (if (file-directory-p directory-name)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
626 (find-file directory-name)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
627 (if (file-symlink-p directory-name)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
628 (error "Directory is a symlink to a nonexistent target")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
629 (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
630 (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
631
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
632 (defun locate-find-directory-other-window ()
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
633 "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
634 (interactive)
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
635 (if (locate-main-listing-line-p)
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
636 (find-file-other-window (locate-get-dirname))
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
637 (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
638
69501
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
639 ;; 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
640 ;; 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
641 ;; 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
642 ;; 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
643 ;; listed by the locate program, using the function
c22f46390a8f (locate-command, locate-make-command-line)
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
644 ;; `locate-main-listing-line-p'.
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
645 (defun locate-get-dirname ()
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
646 "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
647 (let (file (filepos (locate-get-file-positions)))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
648 (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
649 (progn
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
650 ;; 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
651 (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
652 (setq file (file-name-directory file))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
653 ;; 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
654 ;; 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
655 ;; \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
656 (setq file
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
657 (read
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
658 (concat "\""
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
659 ;; 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
660 ;; 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
661 (or (dired-string-replace-match
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
662 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
663 file)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
664 "\"")))))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
665 (and file buffer-file-coding-system
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
666 (not file-name-coding-system)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
667 (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
668 file))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
669
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
670 ;; Only for GNU locate
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
671 (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: 77561
diff changeset
672 "Run the GNU locate program, using an alternate database.
77561
8823a1f17d51 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
673
8823a1f17d51 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
674 This command only works if you use GNU locate. It does not work
8823a1f17d51 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
675 properly if `locate-prompt-for-command' is set to t. In that
8823a1f17d51 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
676 case, you can just run the regular `locate' command and specify
8823a1f17d51 Luc Teirlinck <teirllm at dms.auburn.edu>:
Glenn Morris <rgm@gnu.org>
parents: 77470
diff changeset
677 the database on the command line."
26043
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
678 (interactive
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
679 (list
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
680 (progn
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
681 ;; (require 'locate)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
682 (read-from-minibuffer "Locate: " nil nil
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
683 nil 'locate-history-list))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
684 (read-file-name "Locate using Database: " )
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
685 ))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
686 (or (file-exists-p database)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
687 (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
688 (let ((locate-make-command-line
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
689 (function (lambda (string)
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
690 (cons locate-command
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
691 (list (concat "--database="
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
692 (expand-file-name database))
255f19f33b82 (locate-in-alternate-database): Added this function
Peter Breton <pbreton@attbi.com>
parents: 22347
diff changeset
693 string))))))
31237
0c53ed643c7c (locate) Cleaned up locate command's interactive prompting
Peter Breton <pbreton@attbi.com>
parents: 29156
diff changeset
694 (locate search-string)))
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695
55939
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
696 (defun locate-do-redisplay (&optional arg test-for-subdir)
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
697 "Like `dired-do-redisplay', but adapted for `*Locate*' buffers."
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
698 (interactive "P\np")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
699 (if (string= (dired-current-directory) "/")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
700 (message "This command only works in subdirectories.")
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
701 (let ((dired-actual-switches locate-ls-subdir-switches))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
702 (dired-do-redisplay arg test-for-subdir))))
fb2c1d5537f3 Merge the two `Commentary' sections.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55711
diff changeset
703
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 (provide 'locate)
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49597
diff changeset
706 ;;; arch-tag: 60c4d098-b5d5-4b3c-a3e0-51a2e9f43898
16781
d63e41403d58 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707 ;;; locate.el ends here