Commit | Line | Data |
---|---|---|
76889e51 RS |
1 | ;;; dirtrack.el --- Directory Tracking by watching the prompt |
2 | ||
3 | ;; Copyright (C) 1996 Free Software Foundation, Inc. | |
4 | ||
d1212648 | 5 | ;; Author: Peter Breton <pbreton@cs.umb.edu> |
76889e51 RS |
6 | ;; Created: Sun Nov 17 1996 |
7 | ;; Keywords: processes | |
9b4b0c9e | 8 | ;; Time-stamp: <1999-02-21 01:27:24 pbreton> |
76889e51 RS |
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. | |
45 | ;; | |
46 | ;; Note that directory tracking is done by matching regular expressions, | |
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 | ;; | |
d1212648 | 52 | ;; 2) Set the variable `dirtrack-list' to an appropriate value. This |
76889e51 RS |
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. | |
55 | ;; The second is a number which tells which regular expression group to | |
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). | |
59 | ;; | |
60 | ;; Determining this information may take some experimentation. Setting | |
d1212648 | 61 | ;; the variable `dirtrack-debug' may help; it causes the directory-tracking |
261f6363 KH |
62 | ;; filter to log messages to the buffer `dirtrack-debug-buffer'. You can easily |
63 | ;; toggle this setting with the `dirtrack-debug-toggle' function. | |
76889e51 | 64 | ;; |
83897674 | 65 | ;; 3) Add a hook to shell-mode to enable the directory tracking: |
76889e51 RS |
66 | ;; |
67 | ;; (add-hook 'shell-mode-hook | |
68 | ;; (function (lambda () | |
9b4b0c9e | 69 | ;; (setq comint-preoutput-filter-functions |
76889e51 | 70 | ;; (append (list 'dirtrack) |
9b4b0c9e | 71 | ;; comint-preoutput-filter-functions))))) |
76889e51 RS |
72 | ;; |
73 | ;; You may wish to turn ordinary shell tracking off by calling | |
d1212648 | 74 | ;; `shell-dirtrack-toggle' or setting `shell-dirtrackp'. |
76889e51 RS |
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. | |
d1212648 RS |
86 | ;; |
87 | ;; Here's one from Stephen Eglen: | |
88 | ;; | |
89 | ;; Running under tcsh: | |
90 | ;; (setq-default dirtrack-list '("^%E \\([^ ]+\\)" 1)) | |
91 | ;; | |
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: | |
95 | ;; | |
96 | ;; set prompt = "%%E %~ %h% " | |
97 | ;; | |
98 | ;; This produces a prompt of the form: | |
99 | ;; %E /var/spool 10% | |
100 | ;; | |
101 | ;; This saves me from having to use the %E prefix in other non-emacs | |
102 | ;; shells. | |
261f6363 KH |
103 | ;; |
104 | ;; A final note: | |
105 | ;; | |
9b4b0c9e RS |
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 | |
261f6363 KH |
112 | ;; with a ~ in it). |
113 | ;; | |
9b4b0c9e RS |
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. | |
76889e51 RS |
118 | |
119 | ;;; Code: | |
120 | ||
121 | (eval-when-compile | |
122 | (require 'comint) | |
123 | (require 'shell)) | |
124 | ||
d1212648 RS |
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) | |
76889e51 RS |
135 | "*List for directory tracking. |
136 | First item is a regexp that describes where to find the path in a prompt. | |
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 | |
d1212648 RS |
139 | be on a single line." |
140 | :group 'dirtrack | |
141 | :type '(sexp (regexp :tag "Prompt Expression") | |
142 | (integer :tag "Regexp Group") | |
143 | (boolean :tag "Multiline Prompt") | |
144 | ) | |
145 | ) | |
76889e51 RS |
146 | |
147 | (make-variable-buffer-local 'dirtrack-list) | |
148 | ||
d1212648 RS |
149 | (defcustom dirtrack-debug nil |
150 | "*If non-nil, the function `dirtrack' will report debugging info." | |
151 | :group 'dirtrack | |
152 | :type 'boolean | |
153 | ) | |
76889e51 | 154 | |
d1212648 RS |
155 | (defcustom dirtrack-debug-buffer "*Directory Tracking Log*" |
156 | "Buffer to write directory tracking debug information." | |
157 | :group 'dirtrack | |
158 | :type 'string | |
159 | ) | |
76889e51 | 160 | |
d1212648 RS |
161 | (defcustom dirtrackp t |
162 | "*If non-nil, directory tracking via `dirtrack' is enabled." | |
163 | :group 'dirtrack | |
164 | :type 'boolean | |
165 | ) | |
76889e51 RS |
166 | |
167 | (make-variable-buffer-local 'dirtrackp) | |
168 | ||
d1212648 | 169 | (defcustom dirtrack-directory-function |
76889e51 RS |
170 | (if (memq system-type (list 'ms-dos 'windows-nt)) |
171 | 'dirtrack-windows-directory-function | |
172 | 'dirtrack-default-directory-function) | |
d1212648 RS |
173 | "*Function to apply to the prompt directory for comparison purposes." |
174 | :group 'dirtrack | |
175 | :type 'function | |
176 | ) | |
76889e51 | 177 | |
d1212648 | 178 | (defcustom dirtrack-canonicalize-function |
76889e51 RS |
179 | (if (memq system-type (list 'ms-dos 'windows-nt)) |
180 | 'downcase 'identity) | |
d1212648 RS |
181 | "*Function to apply to the default directory for comparison purposes." |
182 | :group 'dirtrack | |
183 | :type 'function | |
184 | ) | |
185 | ||
12b0f451 KH |
186 | (defcustom dirtrack-directory-change-hook nil |
187 | "Hook that is called when a directory change is made." | |
188 | :group 'dirtrack | |
189 | :type 'function | |
190 | ) | |
191 | ||
192 | ||
d1212648 RS |
193 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
194 | ;; Functions | |
195 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
76889e51 RS |
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. | |
207 | Such a directory is all lowercase, has forward-slashes as delimiters, | |
208 | and ends with a forward slash." | |
209 | (let ((directory dir)) | |
d1212648 | 210 | (setq directory (downcase (dirtrack-replace-slash directory t))) |
76889e51 RS |
211 | (if (not (char-equal ?/ (string-to-char (substring directory -1)))) |
212 | (concat directory "/") | |
213 | directory))) | |
214 | ||
d1212648 RS |
215 | (defconst dirtrack-forward-slash (regexp-quote "/")) |
216 | (defconst dirtrack-backward-slash (regexp-quote "\\")) | |
76889e51 | 217 | |
d1212648 | 218 | (defun dirtrack-replace-slash (string &optional opposite) |
76889e51 RS |
219 | "Replace forward slashes with backwards ones. |
220 | If additional argument is non-nil, replace backwards slashes with | |
221 | forward ones." | |
d1212648 RS |
222 | (let ((orig (if opposite |
223 | dirtrack-backward-slash | |
224 | dirtrack-forward-slash)) | |
225 | (replace (if opposite | |
226 | dirtrack-forward-slash | |
227 | dirtrack-backward-slash)) | |
76889e51 RS |
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 | ||
261f6363 KH |
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 | ||
76889e51 RS |
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) | |
8e717a45 | 254 | (goto-char (point-max)) |
76889e51 RS |
255 | (insert (concat string "\n")) |
256 | (set-buffer buf) | |
257 | )) | |
258 | ||
259 | ;;;###autoload | |
260 | (defun dirtrack (input) | |
9b4b0c9e RS |
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 | ||
269 | You can enable directory tracking by adding this function to | |
270 | `comint-output-filter-functions'. | |
271 | " | |
76889e51 RS |
272 | (if (null dirtrackp) |
273 | nil | |
7ff58c39 RS |
274 | (let (prompt-path |
275 | matched | |
76889e51 | 276 | (current-dir default-directory) |
8e717a45 | 277 | (dirtrack-regexp (nth 0 dirtrack-list)) |
76889e51 RS |
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 | |
7ff58c39 | 285 | (setq matched (string-match dirtrack-regexp input))) |
76889e51 RS |
286 | ;; No match |
287 | (if (null matched) | |
288 | (and dirtrack-debug | |
289 | (dirtrack-debug-message | |
290 | (format | |
12b0f451 KH |
291 | "Input `%s' failed to match regexp: %s" |
292 | input dirtrack-regexp))) | |
76889e51 | 293 | (setq prompt-path |
7ff58c39 | 294 | (substring input |
76889e51 RS |
295 | (match-beginning match-num) (match-end match-num))) |
296 | ;; Empty string | |
297 | (if (not (> (length prompt-path) 0)) | |
298 | (and dirtrack-debug | |
299 | (dirtrack-debug-message "Match is empty string")) | |
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 | |
306 | (dirtrack-debug-message | |
307 | (format | |
308 | "Prompt is %s\nCurrent directory is %s" | |
309 | prompt-path current-dir))) | |
310 | ;; Compare them | |
311 | (if (or (string= current-dir prompt-path) | |
312 | (string= current-dir | |
313 | (abbreviate-file-name prompt-path))) | |
314 | (and dirtrack-debug | |
315 | (dirtrack-debug-message | |
316 | (format "Not changing directory"))) | |
8e717a45 RS |
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) | |
12b0f451 | 322 | (run-hooks dirtrack-directory-change-hook) |
8e717a45 RS |
323 | dirtrack-debug |
324 | (dirtrack-debug-message | |
325 | (format "Changing directory to %s" prompt-path))) | |
326 | (error "Directory %s does not exist" prompt-path))) | |
9b4b0c9e RS |
327 | ))))) |
328 | input) | |
76889e51 RS |
329 | |
330 | (provide 'dirtrack) | |
331 | ||
332 | ;;; dirtrack.el ends here |