Commit | Line | Data |
---|---|---|
76889e51 RS |
1 | ;;; dirtrack.el --- Directory Tracking by watching the prompt |
2 | ||
e91081eb | 3 | ;; Copyright (C) 1996, 2001, 2002, 2003, 2004, 2005, |
d7a0267c | 4 | ;; 2006, 2007 Free Software Foundation, Inc. |
76889e51 | 5 | |
d1212648 | 6 | ;; Author: Peter Breton <pbreton@cs.umb.edu> |
76889e51 RS |
7 | ;; Created: Sun Nov 17 1996 |
8 | ;; Keywords: processes | |
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 | |
b4aa6026 | 14 | ;; the Free Software Foundation; either version 3, or (at your option) |
76889e51 RS |
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 | |
086add15 LK |
24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 | ;; Boston, MA 02110-1301, USA. | |
76889e51 RS |
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 | |
df8a0bff | 32 | ;; Emacs shell-mode. However, this package makes one strong assumption: |
76889e51 | 33 | ;; that you can customize your shell's prompt to contain the |
df8a0bff | 34 | ;; current working directory. Most shells do support this, including |
76889e51 RS |
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 | |
df8a0bff | 37 | ;; Windows shells. If you cannot do this, or do not wish to, this package |
76889e51 RS |
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. | |
c60ee5e7 JB |
45 | ;; |
46 | ;; Note that directory tracking is done by matching regular expressions, | |
76889e51 | 47 | ;; therefore it is *VERY IMPORTANT* for your prompt to be easily |
df8a0bff | 48 | ;; distinguishable from other output. If your prompt regexp is too general, |
76889e51 RS |
49 | ;; you will see error messages from the dirtrack filter as it attempts to cd |
50 | ;; to non-existent directories. | |
51 | ;; | |
df8a0bff | 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. | |
c60ee5e7 | 55 | ;; The second is a number which tells which regular expression group to |
df8a0bff SM |
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 | |
76889e51 | 58 | ;; 'comint.el' assume a single-line prompt (eg, comint-bol). |
c60ee5e7 | 59 | ;; |
df8a0bff | 60 | ;; Determining this information may take some experimentation. Setting |
d1212648 | 61 | ;; the variable `dirtrack-debug' may help; it causes the directory-tracking |
df8a0bff | 62 | ;; filter to log messages to the buffer `dirtrack-debug-buffer'. You can easily |
261f6363 | 63 | ;; toggle this setting with the `dirtrack-debug-toggle' function. |
c60ee5e7 | 64 | ;; |
83897674 | 65 | ;; 3) Add a hook to shell-mode to enable the directory tracking: |
76889e51 RS |
66 | ;; |
67 | ;; (add-hook 'shell-mode-hook | |
df8a0bff | 68 | ;; (lambda () (add-hook 'comint-preoutput-filter-functions 'dirtrack nil t))) |
76889e51 RS |
69 | ;; |
70 | ;; You may wish to turn ordinary shell tracking off by calling | |
d1212648 | 71 | ;; `shell-dirtrack-toggle' or setting `shell-dirtrackp'. |
76889e51 RS |
72 | ;; |
73 | ;; Examples: | |
74 | ;; | |
75 | ;; 1) On Windows NT, my prompt is set to emacs$S$P$G. | |
76 | ;; 'dirtrack-list' is set to (list "^emacs \\([a-zA-Z]:.*\\)>" 1) | |
77 | ;; | |
78 | ;; 2) On Solaris running bash, my prompt is set like this: | |
79 | ;; PS1="\w\012emacs@\h(\!) [\t]% " | |
80 | ;; 'dirtrack-list' is set to (list "^\\([/~].*\\)\nemacs@[^%]+% *" 1 t) | |
81 | ;; | |
82 | ;; I'd appreciate other examples from people who use this package. | |
c60ee5e7 | 83 | ;; |
d1212648 RS |
84 | ;; Here's one from Stephen Eglen: |
85 | ;; | |
86 | ;; Running under tcsh: | |
87 | ;; (setq-default dirtrack-list '("^%E \\([^ ]+\\)" 1)) | |
c60ee5e7 | 88 | ;; |
d1212648 RS |
89 | ;; It might be worth mentioning in your file that emacs sources start up |
90 | ;; files of the form: ~/.emacs_<SHELL> where <SHELL> is the name of the | |
91 | ;; shell. So for example, I have the following in ~/.emacs_tcsh: | |
c60ee5e7 | 92 | ;; |
d1212648 | 93 | ;; set prompt = "%%E %~ %h% " |
c60ee5e7 | 94 | ;; |
d1212648 | 95 | ;; This produces a prompt of the form: |
c60ee5e7 JB |
96 | ;; %E /var/spool 10% |
97 | ;; | |
d1212648 RS |
98 | ;; This saves me from having to use the %E prefix in other non-emacs |
99 | ;; shells. | |
261f6363 KH |
100 | ;; |
101 | ;; A final note: | |
c60ee5e7 | 102 | ;; |
9b4b0c9e RS |
103 | ;; I run LOTS of shell buffers through Emacs, sometimes as different users |
104 | ;; (eg, when logged in as myself, I'll run a root shell in the same Emacs). | |
105 | ;; If you do this, and the shell prompt contains a ~, Emacs will interpret | |
106 | ;; this relative to the user which owns the Emacs process, not the user | |
df8a0bff | 107 | ;; who owns the shell buffer. This may cause dirtrack to behave strangely |
9b4b0c9e | 108 | ;; (typically it reports that it is unable to cd to a directory |
261f6363 KH |
109 | ;; with a ~ in it). |
110 | ;; | |
9b4b0c9e RS |
111 | ;; The same behavior can occur if you use dirtrack with remote filesystems |
112 | ;; (using telnet, rlogin, etc) as Emacs will be checking the local | |
df8a0bff | 113 | ;; filesystem, not the remote one. This problem is not specific to dirtrack, |
9b4b0c9e | 114 | ;; but also affects file completion, etc. |
76889e51 RS |
115 | |
116 | ;;; Code: | |
117 | ||
118 | (eval-when-compile | |
119 | (require 'comint) | |
120 | (require 'shell)) | |
121 | ||
d1212648 RS |
122 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
123 | ;; Customization Variables | |
124 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
125 | ||
126 | (defgroup dirtrack nil | |
127 | "Directory tracking by watching the prompt." | |
128 | :prefix "dirtrack-" | |
129 | :group 'shell) | |
130 | ||
131 | (defcustom dirtrack-list (list "^emacs \\([a-zA-Z]:.*\\)>" 1) | |
df8a0bff | 132 | "List for directory tracking. |
76889e51 | 133 | First item is a regexp that describes where to find the path in a prompt. |
4f5ab6d5 JB |
134 | Second is a number, the regexp group to match. Optional third item is |
135 | whether the prompt is multi-line. If nil or omitted, prompt is assumed to | |
d1212648 RS |
136 | be on a single line." |
137 | :group 'dirtrack | |
c60ee5e7 | 138 | :type '(sexp (regexp :tag "Prompt Expression") |
d1212648 | 139 | (integer :tag "Regexp Group") |
df8a0bff | 140 | (boolean :tag "Multiline Prompt"))) |
76889e51 RS |
141 | |
142 | (make-variable-buffer-local 'dirtrack-list) | |
143 | ||
d1212648 | 144 | (defcustom dirtrack-debug nil |
df8a0bff | 145 | "If non-nil, the function `dirtrack' will report debugging info." |
d1212648 | 146 | :group 'dirtrack |
df8a0bff | 147 | :type 'boolean) |
76889e51 | 148 | |
d1212648 RS |
149 | (defcustom dirtrack-debug-buffer "*Directory Tracking Log*" |
150 | "Buffer to write directory tracking debug information." | |
151 | :group 'dirtrack | |
df8a0bff | 152 | :type 'string) |
76889e51 | 153 | |
d1212648 | 154 | (defcustom dirtrackp t |
df8a0bff | 155 | "If non-nil, directory tracking via `dirtrack' is enabled." |
d1212648 | 156 | :group 'dirtrack |
df8a0bff | 157 | :type 'boolean) |
76889e51 RS |
158 | |
159 | (make-variable-buffer-local 'dirtrackp) | |
160 | ||
c60ee5e7 JB |
161 | (defcustom dirtrack-directory-function |
162 | (if (memq system-type (list 'ms-dos 'windows-nt 'cygwin)) | |
76889e51 | 163 | 'dirtrack-windows-directory-function |
df8a0bff SM |
164 | 'file-name-as-directory) |
165 | "Function to apply to the prompt directory for comparison purposes." | |
d1212648 | 166 | :group 'dirtrack |
df8a0bff | 167 | :type 'function) |
76889e51 | 168 | |
c60ee5e7 JB |
169 | (defcustom dirtrack-canonicalize-function |
170 | (if (memq system-type (list 'ms-dos 'windows-nt 'cygwin)) | |
76889e51 | 171 | 'downcase 'identity) |
df8a0bff | 172 | "Function to apply to the default directory for comparison purposes." |
d1212648 | 173 | :group 'dirtrack |
df8a0bff | 174 | :type 'function) |
d1212648 | 175 | |
12b0f451 KH |
176 | (defcustom dirtrack-directory-change-hook nil |
177 | "Hook that is called when a directory change is made." | |
178 | :group 'dirtrack | |
df8a0bff | 179 | :type 'hook) |
12b0f451 KH |
180 | |
181 | ||
d1212648 RS |
182 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
183 | ;; Functions | |
184 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
76889e51 | 185 | |
76889e51 RS |
186 | |
187 | (defun dirtrack-windows-directory-function (dir) | |
188 | "Return a canonical directory for comparison purposes. | |
c60ee5e7 | 189 | Such a directory is all lowercase, has forward-slashes as delimiters, |
76889e51 | 190 | and ends with a forward slash." |
df8a0bff | 191 | (file-name-as-directory (downcase (subst-char-in-string ?\\ ?/ dir)))) |
76889e51 | 192 | |
b9e316dd PB |
193 | (defun dirtrack-cygwin-directory-function (dir) |
194 | "Return a canonical directory taken from a Cygwin path for comparison purposes." | |
195 | (if (string-match "/cygdrive/\\([A-Z]\\)\\(.*\\)" dir) | |
196 | (concat (match-string 1 dir) ":" (match-string 2 dir)) | |
197 | dir)) | |
198 | ||
76889e51 RS |
199 | ;; Copied from shell.el |
200 | (defun dirtrack-toggle () | |
201 | "Enable or disable Dirtrack directory tracking in a shell buffer." | |
202 | (interactive) | |
df8a0bff SM |
203 | (if (setq dirtrackp (not dirtrackp)) |
204 | (add-hook 'comint-preoutput-filter-functions 'dirtrack nil t) | |
205 | (remove-hook 'comint-preoutput-filter-functions 'dirtrack t)) | |
76889e51 RS |
206 | (message "Directory tracking %s" (if dirtrackp "ON" "OFF"))) |
207 | ||
261f6363 KH |
208 | (defun dirtrack-debug-toggle () |
209 | "Enable or disable Dirtrack debugging." | |
210 | (interactive) | |
211 | (setq dirtrack-debug (not dirtrack-debug)) | |
212 | (message "Directory debugging %s" (if dirtrack-debug "ON" "OFF")) | |
213 | (and dirtrack-debug | |
214 | (display-buffer (get-buffer-create dirtrack-debug-buffer)))) | |
215 | ||
76889e51 RS |
216 | (defun dirtrack-debug-message (string) |
217 | (let ((buf (current-buffer)) | |
218 | (debug-buf (get-buffer-create dirtrack-debug-buffer)) | |
219 | ) | |
220 | (set-buffer debug-buf) | |
8e717a45 | 221 | (goto-char (point-max)) |
76889e51 RS |
222 | (insert (concat string "\n")) |
223 | (set-buffer buf) | |
224 | )) | |
225 | ||
226 | ;;;###autoload | |
227 | (defun dirtrack (input) | |
9b4b0c9e RS |
228 | "Determine the current directory by scanning the process output for a prompt. |
229 | The prompt to look for is the first item in `dirtrack-list'. | |
230 | ||
231 | You can toggle directory tracking by using the function `dirtrack-toggle'. | |
232 | ||
233 | If directory tracking does not seem to be working, you can use the | |
234 | function `dirtrack-debug-toggle' to turn on debugging output. | |
235 | ||
c60ee5e7 | 236 | You can enable directory tracking by adding this function to |
df8a0bff SM |
237 | `comint-output-filter-functions'." |
238 | (if (or (null dirtrackp) | |
239 | ;; No output? | |
240 | (eq (point) (point-min))) | |
76889e51 | 241 | nil |
7ff58c39 | 242 | (let (prompt-path |
76889e51 | 243 | (current-dir default-directory) |
8e717a45 | 244 | (dirtrack-regexp (nth 0 dirtrack-list)) |
76889e51 | 245 | (match-num (nth 1 dirtrack-list)) |
df8a0bff SM |
246 | ;; Currently unimplemented, it seems. --Stef |
247 | (multi-line (nth 2 dirtrack-list))) | |
248 | (save-excursion | |
249 | ;; No match | |
250 | (if (null (string-match dirtrack-regexp input)) | |
251 | (and dirtrack-debug | |
252 | (dirtrack-debug-message | |
253 | (format | |
254 | "Input `%s' failed to match `dirtrack-regexp'" input))) | |
255 | (setq prompt-path (match-string match-num input)) | |
256 | ;; Empty string | |
257 | (if (not (> (length prompt-path) 0)) | |
258 | (and dirtrack-debug | |
259 | (dirtrack-debug-message "Match is empty string")) | |
260 | ;; Transform prompts into canonical forms | |
261 | (setq prompt-path (funcall dirtrack-directory-function | |
262 | prompt-path)) | |
263 | (setq current-dir (funcall dirtrack-canonicalize-function | |
264 | current-dir)) | |
265 | (and dirtrack-debug | |
266 | (dirtrack-debug-message | |
267 | (format | |
268 | "Prompt is %s\nCurrent directory is %s" | |
269 | prompt-path current-dir))) | |
270 | ;; Compare them | |
271 | (if (or (string= current-dir prompt-path) | |
272 | (string= current-dir | |
273 | (abbreviate-file-name prompt-path))) | |
274 | (and dirtrack-debug | |
275 | (dirtrack-debug-message | |
276 | (format "Not changing directory"))) | |
277 | ;; It's possible that Emacs will think the directory | |
278 | ;; won't exist (eg, rlogin buffers) | |
279 | (if (file-accessible-directory-p prompt-path) | |
280 | ;; Change directory | |
281 | (and (shell-process-cd prompt-path) | |
282 | (run-hooks 'dirtrack-directory-change-hook) | |
283 | dirtrack-debug | |
284 | (dirtrack-debug-message | |
285 | (format "Changing directory to %s" prompt-path))) | |
286 | (error "Directory %s does not exist" prompt-path))) | |
287 | ))))) | |
9b4b0c9e | 288 | input) |
76889e51 RS |
289 | |
290 | (provide 'dirtrack) | |
291 | ||
df8a0bff | 292 | ;; arch-tag: 168de071-be88-4937-aff6-2aba9f328d5a |
76889e51 | 293 | ;;; dirtrack.el ends here |