|
16817
|
1 ;;; dirtrack.el --- Directory Tracking by watching the prompt
|
|
|
2
|
|
|
3 ;; Copyright (C) 1996 Free Software Foundation, Inc.
|
|
|
4
|
|
21183
|
5 ;; Author: Peter Breton <pbreton@cs.umb.edu>
|
|
16817
|
6 ;; Created: Sun Nov 17 1996
|
|
|
7 ;; Keywords: processes
|
|
49549
|
8 ;; Time-stamp: <2003-01-31 16:15:05 jbarranquero>
|
|
16817
|
9
|
|
|
10 ;; This file is part of GNU Emacs.
|
|
|
11
|
|
|
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
|
13 ;; it under the terms of the GNU General Public License as published by
|
|
|
14 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
15 ;; any later version.
|
|
|
16
|
|
|
17 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
20 ;; GNU General Public License for more details.
|
|
|
21
|
|
|
22 ;; You should have received a copy of the GNU General Public License
|
|
|
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
|
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
25 ;; Boston, MA 02111-1307, USA.
|
|
|
26
|
|
|
27 ;;; Commentary:
|
|
|
28
|
|
|
29 ;; Shell directory tracking by watching the prompt.
|
|
|
30 ;;
|
|
|
31 ;; This is yet another attempt at a directory-tracking package for
|
|
|
32 ;; Emacs shell-mode. However, this package makes one strong assumption:
|
|
|
33 ;; that you can customize your shell's prompt to contain the
|
|
|
34 ;; current working directory. Most shells do support this, including
|
|
|
35 ;; almost every type of Bourne and C shell on Unix, the native shells on
|
|
|
36 ;; Windows95 (COMMAND.COM) and Windows NT (CMD.EXE), and most 3rd party
|
|
|
37 ;; Windows shells. If you cannot do this, or do not wish to, this package
|
|
|
38 ;; will be useless to you.
|
|
|
39 ;;
|
|
|
40 ;; Installation:
|
|
|
41 ;;
|
|
|
42 ;; 1) Set your shell's prompt to contain the current working directory.
|
|
|
43 ;; You may need to consult your shell's documentation to find out how to
|
|
|
44 ;; do this.
|
|
49549
|
45 ;;
|
|
|
46 ;; Note that directory tracking is done by matching regular expressions,
|
|
16817
|
47 ;; therefore it is *VERY IMPORTANT* for your prompt to be easily
|
|
|
48 ;; distinguishable from other output. If your prompt regexp is too general,
|
|
|
49 ;; you will see error messages from the dirtrack filter as it attempts to cd
|
|
|
50 ;; to non-existent directories.
|
|
|
51 ;;
|
|
21183
|
52 ;; 2) Set the variable `dirtrack-list' to an appropriate value. This
|
|
16817
|
53 ;; should be a list of two elements: the first is a regular expression
|
|
|
54 ;; which matches your prompt up to and including the pathname part.
|
|
49549
|
55 ;; The second is a number which tells which regular expression group to
|
|
16817
|
56 ;; match to extract only the pathname. If you use a multi-line prompt,
|
|
|
57 ;; add 't' as a third element. Note that some of the functions in
|
|
|
58 ;; 'comint.el' assume a single-line prompt (eg, comint-bol).
|
|
49549
|
59 ;;
|
|
16817
|
60 ;; Determining this information may take some experimentation. Setting
|
|
21183
|
61 ;; the variable `dirtrack-debug' may help; it causes the directory-tracking
|
|
23390
|
62 ;; filter to log messages to the buffer `dirtrack-debug-buffer'. You can easily
|
|
|
63 ;; toggle this setting with the `dirtrack-debug-toggle' function.
|
|
49549
|
64 ;;
|
|
17930
|
65 ;; 3) Add a hook to shell-mode to enable the directory tracking:
|
|
16817
|
66 ;;
|
|
|
67 ;; (add-hook 'shell-mode-hook
|
|
|
68 ;; (function (lambda ()
|
|
24370
|
69 ;; (setq comint-preoutput-filter-functions
|
|
16817
|
70 ;; (append (list 'dirtrack)
|
|
24370
|
71 ;; comint-preoutput-filter-functions)))))
|
|
16817
|
72 ;;
|
|
|
73 ;; You may wish to turn ordinary shell tracking off by calling
|
|
21183
|
74 ;; `shell-dirtrack-toggle' or setting `shell-dirtrackp'.
|
|
16817
|
75 ;;
|
|
|
76 ;; Examples:
|
|
|
77 ;;
|
|
|
78 ;; 1) On Windows NT, my prompt is set to emacs$S$P$G.
|
|
|
79 ;; 'dirtrack-list' is set to (list "^emacs \\([a-zA-Z]:.*\\)>" 1)
|
|
|
80 ;;
|
|
|
81 ;; 2) On Solaris running bash, my prompt is set like this:
|
|
|
82 ;; PS1="\w\012emacs@\h(\!) [\t]% "
|
|
|
83 ;; 'dirtrack-list' is set to (list "^\\([/~].*\\)\nemacs@[^%]+% *" 1 t)
|
|
|
84 ;;
|
|
|
85 ;; I'd appreciate other examples from people who use this package.
|
|
49549
|
86 ;;
|
|
21183
|
87 ;; Here's one from Stephen Eglen:
|
|
|
88 ;;
|
|
|
89 ;; Running under tcsh:
|
|
|
90 ;; (setq-default dirtrack-list '("^%E \\([^ ]+\\)" 1))
|
|
49549
|
91 ;;
|
|
21183
|
92 ;; It might be worth mentioning in your file that emacs sources start up
|
|
|
93 ;; files of the form: ~/.emacs_<SHELL> where <SHELL> is the name of the
|
|
|
94 ;; shell. So for example, I have the following in ~/.emacs_tcsh:
|
|
49549
|
95 ;;
|
|
21183
|
96 ;; set prompt = "%%E %~ %h% "
|
|
49549
|
97 ;;
|
|
21183
|
98 ;; This produces a prompt of the form:
|
|
49549
|
99 ;; %E /var/spool 10%
|
|
|
100 ;;
|
|
21183
|
101 ;; This saves me from having to use the %E prefix in other non-emacs
|
|
|
102 ;; shells.
|
|
23390
|
103 ;;
|
|
|
104 ;; A final note:
|
|
49549
|
105 ;;
|
|
24370
|
106 ;; I run LOTS of shell buffers through Emacs, sometimes as different users
|
|
|
107 ;; (eg, when logged in as myself, I'll run a root shell in the same Emacs).
|
|
|
108 ;; If you do this, and the shell prompt contains a ~, Emacs will interpret
|
|
|
109 ;; this relative to the user which owns the Emacs process, not the user
|
|
|
110 ;; who owns the shell buffer. This may cause dirtrack to behave strangely
|
|
|
111 ;; (typically it reports that it is unable to cd to a directory
|
|
23390
|
112 ;; with a ~ in it).
|
|
|
113 ;;
|
|
24370
|
114 ;; The same behavior can occur if you use dirtrack with remote filesystems
|
|
|
115 ;; (using telnet, rlogin, etc) as Emacs will be checking the local
|
|
|
116 ;; filesystem, not the remote one. This problem is not specific to dirtrack,
|
|
|
117 ;; but also affects file completion, etc.
|
|
16817
|
118
|
|
|
119 ;;; Code:
|
|
|
120
|
|
|
121 (eval-when-compile
|
|
|
122 (require 'comint)
|
|
|
123 (require 'shell))
|
|
|
124
|
|
21183
|
125 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
126 ;; Customization Variables
|
|
|
127 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
128
|
|
|
129 (defgroup dirtrack nil
|
|
|
130 "Directory tracking by watching the prompt."
|
|
|
131 :prefix "dirtrack-"
|
|
|
132 :group 'shell)
|
|
|
133
|
|
|
134 (defcustom dirtrack-list (list "^emacs \\([a-zA-Z]:.*\\)>" 1)
|
|
16817
|
135 "*List for directory tracking.
|
|
|
136 First item is a regexp that describes where to find the path in a prompt.
|
|
49549
|
137 Second is a number, the regexp group to match. Optional third item is
|
|
|
138 whether the prompt is multi-line. If nil or omitted, prompt is assumed to
|
|
21183
|
139 be on a single line."
|
|
|
140 :group 'dirtrack
|
|
49549
|
141 :type '(sexp (regexp :tag "Prompt Expression")
|
|
21183
|
142 (integer :tag "Regexp Group")
|
|
|
143 (boolean :tag "Multiline Prompt")
|
|
|
144 )
|
|
|
145 )
|
|
16817
|
146
|
|
|
147 (make-variable-buffer-local 'dirtrack-list)
|
|
|
148
|
|
21183
|
149 (defcustom dirtrack-debug nil
|
|
|
150 "*If non-nil, the function `dirtrack' will report debugging info."
|
|
|
151 :group 'dirtrack
|
|
|
152 :type 'boolean
|
|
|
153 )
|
|
16817
|
154
|
|
21183
|
155 (defcustom dirtrack-debug-buffer "*Directory Tracking Log*"
|
|
|
156 "Buffer to write directory tracking debug information."
|
|
|
157 :group 'dirtrack
|
|
|
158 :type 'string
|
|
|
159 )
|
|
16817
|
160
|
|
21183
|
161 (defcustom dirtrackp t
|
|
|
162 "*If non-nil, directory tracking via `dirtrack' is enabled."
|
|
|
163 :group 'dirtrack
|
|
|
164 :type 'boolean
|
|
|
165 )
|
|
16817
|
166
|
|
|
167 (make-variable-buffer-local 'dirtrackp)
|
|
|
168
|
|
49549
|
169 (defcustom dirtrack-directory-function
|
|
|
170 (if (memq system-type (list 'ms-dos 'windows-nt 'cygwin))
|
|
16817
|
171 'dirtrack-windows-directory-function
|
|
|
172 'dirtrack-default-directory-function)
|
|
21183
|
173 "*Function to apply to the prompt directory for comparison purposes."
|
|
|
174 :group 'dirtrack
|
|
|
175 :type 'function
|
|
|
176 )
|
|
16817
|
177
|
|
49549
|
178 (defcustom dirtrack-canonicalize-function
|
|
|
179 (if (memq system-type (list 'ms-dos 'windows-nt 'cygwin))
|
|
16817
|
180 'downcase 'identity)
|
|
21183
|
181 "*Function to apply to the default directory for comparison purposes."
|
|
|
182 :group 'dirtrack
|
|
|
183 :type 'function
|
|
|
184 )
|
|
|
185
|
|
23851
|
186 (defcustom dirtrack-directory-change-hook nil
|
|
|
187 "Hook that is called when a directory change is made."
|
|
|
188 :group 'dirtrack
|
|
35967
|
189 :type 'hook
|
|
23851
|
190 )
|
|
|
191
|
|
|
192
|
|
21183
|
193 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
194 ;; Functions
|
|
|
195 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
16817
|
196
|
|
|
197 (defun dirtrack-default-directory-function (dir)
|
|
|
198 "Return a canonical directory for comparison purposes.
|
|
|
199 Such a directory ends with a forward slash."
|
|
|
200 (let ((directory dir))
|
|
|
201 (if (not (char-equal ?/ (string-to-char (substring directory -1))))
|
|
|
202 (concat directory "/")
|
|
|
203 directory)))
|
|
|
204
|
|
|
205 (defun dirtrack-windows-directory-function (dir)
|
|
|
206 "Return a canonical directory for comparison purposes.
|
|
49549
|
207 Such a directory is all lowercase, has forward-slashes as delimiters,
|
|
16817
|
208 and ends with a forward slash."
|
|
|
209 (let ((directory dir))
|
|
21183
|
210 (setq directory (downcase (dirtrack-replace-slash directory t)))
|
|
16817
|
211 (if (not (char-equal ?/ (string-to-char (substring directory -1))))
|
|
|
212 (concat directory "/")
|
|
|
213 directory)))
|
|
|
214
|
|
21183
|
215 (defconst dirtrack-forward-slash (regexp-quote "/"))
|
|
|
216 (defconst dirtrack-backward-slash (regexp-quote "\\"))
|
|
16817
|
217
|
|
21183
|
218 (defun dirtrack-replace-slash (string &optional opposite)
|
|
16817
|
219 "Replace forward slashes with backwards ones.
|
|
49549
|
220 If additional argument is non-nil, replace backwards slashes with
|
|
16817
|
221 forward ones."
|
|
49549
|
222 (let ((orig (if opposite
|
|
|
223 dirtrack-backward-slash
|
|
21183
|
224 dirtrack-forward-slash))
|
|
49549
|
225 (replace (if opposite
|
|
|
226 dirtrack-forward-slash
|
|
21183
|
227 dirtrack-backward-slash))
|
|
16817
|
228 (newstring string)
|
|
|
229 )
|
|
|
230 (while (string-match orig newstring)
|
|
|
231 (setq newstring (replace-match replace nil t newstring)))
|
|
|
232 newstring))
|
|
|
233
|
|
|
234 ;; Copied from shell.el
|
|
|
235 (defun dirtrack-toggle ()
|
|
|
236 "Enable or disable Dirtrack directory tracking in a shell buffer."
|
|
|
237 (interactive)
|
|
|
238 (setq dirtrackp (not dirtrackp))
|
|
|
239 (message "Directory tracking %s" (if dirtrackp "ON" "OFF")))
|
|
|
240
|
|
23390
|
241 (defun dirtrack-debug-toggle ()
|
|
|
242 "Enable or disable Dirtrack debugging."
|
|
|
243 (interactive)
|
|
|
244 (setq dirtrack-debug (not dirtrack-debug))
|
|
|
245 (message "Directory debugging %s" (if dirtrack-debug "ON" "OFF"))
|
|
|
246 (and dirtrack-debug
|
|
|
247 (display-buffer (get-buffer-create dirtrack-debug-buffer))))
|
|
|
248
|
|
16817
|
249 (defun dirtrack-debug-message (string)
|
|
|
250 (let ((buf (current-buffer))
|
|
|
251 (debug-buf (get-buffer-create dirtrack-debug-buffer))
|
|
|
252 )
|
|
|
253 (set-buffer debug-buf)
|
|
16960
|
254 (goto-char (point-max))
|
|
16817
|
255 (insert (concat string "\n"))
|
|
|
256 (set-buffer buf)
|
|
|
257 ))
|
|
|
258
|
|
|
259 ;;;###autoload
|
|
|
260 (defun dirtrack (input)
|
|
24370
|
261 "Determine the current directory by scanning the process output for a prompt.
|
|
|
262 The prompt to look for is the first item in `dirtrack-list'.
|
|
|
263
|
|
|
264 You can toggle directory tracking by using the function `dirtrack-toggle'.
|
|
|
265
|
|
|
266 If directory tracking does not seem to be working, you can use the
|
|
|
267 function `dirtrack-debug-toggle' to turn on debugging output.
|
|
|
268
|
|
49549
|
269 You can enable directory tracking by adding this function to
|
|
24370
|
270 `comint-output-filter-functions'.
|
|
|
271 "
|
|
16817
|
272 (if (null dirtrackp)
|
|
|
273 nil
|
24355
f0b106582755
(dirtrack): Check for the prompt in the input string instead of the buffer.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
274 (let (prompt-path
|
f0b106582755
(dirtrack): Check for the prompt in the input string instead of the buffer.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
275 matched
|
|
16817
|
276 (current-dir default-directory)
|
|
16960
|
277 (dirtrack-regexp (nth 0 dirtrack-list))
|
|
16817
|
278 (match-num (nth 1 dirtrack-list))
|
|
|
279 (multi-line (nth 2 dirtrack-list))
|
|
|
280 )
|
|
|
281 ;; No output?
|
|
|
282 (if (eq (point) (point-min))
|
|
|
283 nil
|
|
|
284 (save-excursion
|
24355
f0b106582755
(dirtrack): Check for the prompt in the input string instead of the buffer.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
285 (setq matched (string-match dirtrack-regexp input)))
|
|
16817
|
286 ;; No match
|
|
|
287 (if (null matched)
|
|
|
288 (and dirtrack-debug
|
|
49549
|
289 (dirtrack-debug-message
|
|
|
290 (format
|
|
|
291 "Input `%s' failed to match regexp: %s"
|
|
23851
|
292 input dirtrack-regexp)))
|
|
49549
|
293 (setq prompt-path
|
24355
f0b106582755
(dirtrack): Check for the prompt in the input string instead of the buffer.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
294 (substring input
|
|
16817
|
295 (match-beginning match-num) (match-end match-num)))
|
|
|
296 ;; Empty string
|
|
|
297 (if (not (> (length prompt-path) 0))
|
|
|
298 (and dirtrack-debug
|
|
49549
|
299 (dirtrack-debug-message "Match is empty string"))
|
|
16817
|
300 ;; Transform prompts into canonical forms
|
|
|
301 (setq prompt-path (funcall dirtrack-directory-function
|
|
|
302 prompt-path))
|
|
|
303 (setq current-dir (funcall dirtrack-canonicalize-function
|
|
|
304 current-dir))
|
|
|
305 (and dirtrack-debug
|
|
49549
|
306 (dirtrack-debug-message
|
|
16817
|
307 (format
|
|
|
308 "Prompt is %s\nCurrent directory is %s"
|
|
49549
|
309 prompt-path current-dir)))
|
|
16817
|
310 ;; Compare them
|
|
|
311 (if (or (string= current-dir prompt-path)
|
|
49549
|
312 (string= current-dir
|
|
16817
|
313 (abbreviate-file-name prompt-path)))
|
|
|
314 (and dirtrack-debug
|
|
49549
|
315 (dirtrack-debug-message
|
|
16817
|
316 (format "Not changing directory")))
|
|
16960
|
317 ;; It's possible that Emacs will think the directory
|
|
|
318 ;; won't exist (eg, rlogin buffers)
|
|
|
319 (if (file-accessible-directory-p prompt-path)
|
|
|
320 ;; Change directory
|
|
|
321 (and (shell-process-cd prompt-path)
|
|
32664
|
322 (run-hooks 'dirtrack-directory-change-hook)
|
|
16960
|
323 dirtrack-debug
|
|
49549
|
324 (dirtrack-debug-message
|
|
16960
|
325 (format "Changing directory to %s" prompt-path)))
|
|
|
326 (error "Directory %s does not exist" prompt-path)))
|
|
24370
|
327 )))))
|
|
|
328 input)
|
|
16817
|
329
|
|
|
330 (provide 'dirtrack)
|
|
|
331
|
|
|
332 ;;; dirtrack.el ends here
|
