1 ;;; dirtrack.el --- Directory Tracking by watching the prompt
3 ;; Copyright (C) 1996 Free Software Foundation, Inc.
5 ;; Author: Peter Breton <pbreton@cs.umb.edu>
6 ;; Created: Sun Nov 17 1996
8 ;; Time-stamp: <1998-03-14 09:24:38 pbreton>
10 ;; This file is part of GNU Emacs.
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)
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.
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.
29 ;; Shell directory tracking by watching the prompt.
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.
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
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.
52 ;; 2) Set the variable `dirtrack-list' to an appropriate value. This
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).
60 ;; Determining this information may take some experimentation. Setting
61 ;; the variable `dirtrack-debug' may help; it causes the directory-tracking
62 ;; filter to log messages to the buffer `dirtrack-debug-buffer'. You can easily
63 ;; toggle this setting with the `dirtrack-debug-toggle' function.
65 ;; 3) Add a hook to shell-mode to enable the directory tracking:
67 ;; (add-hook 'shell-mode-hook
68 ;; (function (lambda ()
69 ;; (setq comint-output-filter-functions
70 ;; (append (list 'dirtrack)
71 ;; comint-output-filter-functions)))))
73 ;; You may wish to turn ordinary shell tracking off by calling
74 ;; `shell-dirtrack-toggle' or setting `shell-dirtrackp'.
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)
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)
85 ;; I'd appreciate other examples from people who use this package.
87 ;; Here's one from Stephen Eglen:
89 ;; Running under tcsh:
90 ;; (setq-default dirtrack-list '("^%E \\([^ ]+\\)" 1))
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:
96 ;; set prompt = "%%E %~ %h% "
98 ;; This produces a prompt of the form:
101 ;; This saves me from having to use the %E prefix in other non-emacs
106 ;; I run LOTS of shell buffers through Emacs, sometimes as different users (eg, when
107 ;; logged in as myself, I'll run a root shell in the same Emacs). If you do this, and
108 ;; the shell prompt contains a ~, Emacs will interpret this relative to the user which
109 ;; owns the Emacs process, not the user who owns the shell buffer. This may cause
110 ;; dirtrack to behave strangely (typically it reports that it is unable to cd to a directory
113 ;; The same behavior can occur if you use dirtrack with remote filesystems (using telnet,
114 ;; rlogin, etc) as Emacs will be checking the local filesystem, not the remote one.
115 ;; This problem is not specific to dirtrack, but also affects file completion, etc.
123 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
124 ;; Customization Variables
125 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
127 (defgroup dirtrack nil
128 "Directory tracking by watching the prompt."
132 (defcustom dirtrack-list
(list "^emacs \\([a-zA-Z]:.*\\)>" 1)
133 "*List for directory tracking.
134 First item is a regexp that describes where to find the path in a prompt.
135 Second is a number, the regexp group to match. Optional third item is
136 whether the prompt is multi-line. If nil or omitted, prompt is assumed to
137 be on a single line."
139 :type
'(sexp (regexp :tag
"Prompt Expression")
140 (integer :tag
"Regexp Group")
141 (boolean :tag
"Multiline Prompt")
145 (make-variable-buffer-local 'dirtrack-list
)
147 (defcustom dirtrack-debug nil
148 "*If non-nil, the function `dirtrack' will report debugging info."
153 (defcustom dirtrack-debug-buffer
"*Directory Tracking Log*"
154 "Buffer to write directory tracking debug information."
159 (defcustom dirtrackp t
160 "*If non-nil, directory tracking via `dirtrack' is enabled."
165 (make-variable-buffer-local 'dirtrackp
)
167 (defcustom dirtrack-directory-function
168 (if (memq system-type
(list 'ms-dos
'windows-nt
))
169 'dirtrack-windows-directory-function
170 'dirtrack-default-directory-function
)
171 "*Function to apply to the prompt directory for comparison purposes."
176 (defcustom dirtrack-canonicalize-function
177 (if (memq system-type
(list 'ms-dos
'windows-nt
))
179 "*Function to apply to the default directory for comparison purposes."
184 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
186 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
188 (defun dirtrack-default-directory-function (dir)
189 "Return a canonical directory for comparison purposes.
190 Such a directory ends with a forward slash."
191 (let ((directory dir
))
192 (if (not (char-equal ?
/ (string-to-char (substring directory -
1))))
193 (concat directory
"/")
196 (defun dirtrack-windows-directory-function (dir)
197 "Return a canonical directory for comparison purposes.
198 Such a directory is all lowercase, has forward-slashes as delimiters,
199 and ends with a forward slash."
200 (let ((directory dir
))
201 (setq directory
(downcase (dirtrack-replace-slash directory t
)))
202 (if (not (char-equal ?
/ (string-to-char (substring directory -
1))))
203 (concat directory
"/")
206 (defconst dirtrack-forward-slash
(regexp-quote "/"))
207 (defconst dirtrack-backward-slash
(regexp-quote "\\"))
209 (defun dirtrack-replace-slash (string &optional opposite
)
210 "Replace forward slashes with backwards ones.
211 If additional argument is non-nil, replace backwards slashes with
213 (let ((orig (if opposite
214 dirtrack-backward-slash
215 dirtrack-forward-slash
))
216 (replace (if opposite
217 dirtrack-forward-slash
218 dirtrack-backward-slash
))
221 (while (string-match orig newstring
)
222 (setq newstring
(replace-match replace nil t newstring
)))
225 ;; Copied from shell.el
226 (defun dirtrack-toggle ()
227 "Enable or disable Dirtrack directory tracking in a shell buffer."
229 (setq dirtrackp
(not dirtrackp
))
230 (message "Directory tracking %s" (if dirtrackp
"ON" "OFF")))
232 (defun dirtrack-debug-toggle ()
233 "Enable or disable Dirtrack debugging."
235 (setq dirtrack-debug
(not dirtrack-debug
))
236 (message "Directory debugging %s" (if dirtrack-debug
"ON" "OFF"))
238 (display-buffer (get-buffer-create dirtrack-debug-buffer
))))
240 (defun dirtrack-debug-message (string)
241 (let ((buf (current-buffer))
242 (debug-buf (get-buffer-create dirtrack-debug-buffer
))
244 (set-buffer debug-buf
)
245 (goto-char (point-max))
246 (insert (concat string
"\n"))
251 (defun dirtrack (input)
255 (current-dir default-directory
)
257 (dirtrack-regexp (nth 0 dirtrack-list
))
258 (match-num (nth 1 dirtrack-list
))
259 (multi-line (nth 2 dirtrack-list
))
262 (if (eq (point) (point-min))
265 (goto-char (point-max))
266 ;; Look for the prompt
271 comint-last-output-start
274 (setq matched
(looking-at dirtrack-regexp
)))
278 (dirtrack-debug-message
280 "Failed to match regexp: %s"
283 (buffer-substring-no-properties
284 (match-beginning match-num
) (match-end match-num
)))
286 (if (not (> (length prompt-path
) 0))
288 (dirtrack-debug-message "Match is empty string"))
289 ;; Transform prompts into canonical forms
290 (setq prompt-path
(funcall dirtrack-directory-function
292 (setq current-dir
(funcall dirtrack-canonicalize-function
295 (dirtrack-debug-message
297 "Prompt is %s\nCurrent directory is %s"
298 prompt-path current-dir
)))
300 (if (or (string= current-dir prompt-path
)
302 (abbreviate-file-name prompt-path
)))
304 (dirtrack-debug-message
305 (format "Not changing directory")))
306 ;; It's possible that Emacs will think the directory
307 ;; won't exist (eg, rlogin buffers)
308 (if (file-accessible-directory-p prompt-path
)
310 (and (shell-process-cd prompt-path
)
312 (dirtrack-debug-message
313 (format "Changing directory to %s" prompt-path
)))
314 (error "Directory %s does not exist" prompt-path
)))
319 ;;; dirtrack.el ends here