Mercurial > emacs
annotate lisp/dirtrack.el @ 23651:dcd6688d67be
(MULTIBYTE_BYTES_WIDTH): Check validity of a multibyte character.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Fri, 06 Nov 1998 00:44:16 +0000 |
parents | ce9dd8548989 |
children | 6c6028a96f5a |
rev | line source |
---|---|
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 | |
21183 | 8 ;; Time-stamp: <1998-03-14 09:24:38 pbreton> |
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. | |
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 ;; | |
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. | |
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 | |
21183 | 61 ;; the variable `dirtrack-debug' may help; it causes the directory-tracking |
23390
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
62 ;; filter to log messages to the buffer `dirtrack-debug-buffer'. You can easily |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
63 ;; toggle this setting with the `dirtrack-debug-toggle' function. |
16817 | 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 () | |
69 ;; (setq comint-output-filter-functions | |
70 ;; (append (list 'dirtrack) | |
71 ;; comint-output-filter-functions))))) | |
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. | |
21183 | 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. | |
23390
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
103 ;; |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
104 ;; A final note: |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
105 ;; |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
106 ;; I run LOTS of shell buffers through Emacs, sometimes as different users (eg, when |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
107 ;; logged in as myself, I'll run a root shell in the same Emacs). If you do this, and |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
108 ;; the shell prompt contains a ~, Emacs will interpret this relative to the user which |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
109 ;; owns the Emacs process, not the user who owns the shell buffer. This may cause |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
110 ;; dirtrack to behave strangely (typically it reports that it is unable to cd to a directory |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
111 ;; with a ~ in it). |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
112 ;; |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
113 ;; The same behavior can occur if you use dirtrack with remote filesystems (using telnet, |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
114 ;; rlogin, etc) as Emacs will be checking the local filesystem, not the remote one. |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
115 ;; This problem is not specific to dirtrack, but also affects file completion, etc. |
16817 | 116 |
117 ;;; Code: | |
118 | |
119 (eval-when-compile | |
120 (require 'comint) | |
121 (require 'shell)) | |
122 | |
21183 | 123 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
124 ;; Customization Variables | |
125 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
126 | |
127 (defgroup dirtrack nil | |
128 "Directory tracking by watching the prompt." | |
129 :prefix "dirtrack-" | |
130 :group 'shell) | |
131 | |
132 (defcustom dirtrack-list (list "^emacs \\([a-zA-Z]:.*\\)>" 1) | |
16817 | 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 | |
21183 | 137 be on a single line." |
138 :group 'dirtrack | |
139 :type '(sexp (regexp :tag "Prompt Expression") | |
140 (integer :tag "Regexp Group") | |
141 (boolean :tag "Multiline Prompt") | |
142 ) | |
143 ) | |
16817 | 144 |
145 (make-variable-buffer-local 'dirtrack-list) | |
146 | |
21183 | 147 (defcustom dirtrack-debug nil |
148 "*If non-nil, the function `dirtrack' will report debugging info." | |
149 :group 'dirtrack | |
150 :type 'boolean | |
151 ) | |
16817 | 152 |
21183 | 153 (defcustom dirtrack-debug-buffer "*Directory Tracking Log*" |
154 "Buffer to write directory tracking debug information." | |
155 :group 'dirtrack | |
156 :type 'string | |
157 ) | |
16817 | 158 |
21183 | 159 (defcustom dirtrackp t |
160 "*If non-nil, directory tracking via `dirtrack' is enabled." | |
161 :group 'dirtrack | |
162 :type 'boolean | |
163 ) | |
16817 | 164 |
165 (make-variable-buffer-local 'dirtrackp) | |
166 | |
21183 | 167 (defcustom dirtrack-directory-function |
16817 | 168 (if (memq system-type (list 'ms-dos 'windows-nt)) |
169 'dirtrack-windows-directory-function | |
170 'dirtrack-default-directory-function) | |
21183 | 171 "*Function to apply to the prompt directory for comparison purposes." |
172 :group 'dirtrack | |
173 :type 'function | |
174 ) | |
16817 | 175 |
21183 | 176 (defcustom dirtrack-canonicalize-function |
16817 | 177 (if (memq system-type (list 'ms-dos 'windows-nt)) |
178 'downcase 'identity) | |
21183 | 179 "*Function to apply to the default directory for comparison purposes." |
180 :group 'dirtrack | |
181 :type 'function | |
182 ) | |
183 | |
184 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
185 ;; Functions | |
186 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
16817 | 187 |
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 "/") | |
194 directory))) | |
195 | |
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)) | |
21183 | 201 (setq directory (downcase (dirtrack-replace-slash directory t))) |
16817 | 202 (if (not (char-equal ?/ (string-to-char (substring directory -1)))) |
203 (concat directory "/") | |
204 directory))) | |
205 | |
21183 | 206 (defconst dirtrack-forward-slash (regexp-quote "/")) |
207 (defconst dirtrack-backward-slash (regexp-quote "\\")) | |
16817 | 208 |
21183 | 209 (defun dirtrack-replace-slash (string &optional opposite) |
16817 | 210 "Replace forward slashes with backwards ones. |
211 If additional argument is non-nil, replace backwards slashes with | |
212 forward ones." | |
21183 | 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)) | |
16817 | 219 (newstring string) |
220 ) | |
221 (while (string-match orig newstring) | |
222 (setq newstring (replace-match replace nil t newstring))) | |
223 newstring)) | |
224 | |
225 ;; Copied from shell.el | |
226 (defun dirtrack-toggle () | |
227 "Enable or disable Dirtrack directory tracking in a shell buffer." | |
228 (interactive) | |
229 (setq dirtrackp (not dirtrackp)) | |
230 (message "Directory tracking %s" (if dirtrackp "ON" "OFF"))) | |
231 | |
23390
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
232 (defun dirtrack-debug-toggle () |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
233 "Enable or disable Dirtrack debugging." |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
234 (interactive) |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
235 (setq dirtrack-debug (not dirtrack-debug)) |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
236 (message "Directory debugging %s" (if dirtrack-debug "ON" "OFF")) |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
237 (and dirtrack-debug |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
238 (display-buffer (get-buffer-create dirtrack-debug-buffer)))) |
ce9dd8548989
Mentioned dirtrack-debug-toggle in the docs.
Karl Heuer <kwzh@gnu.org>
parents:
21183
diff
changeset
|
239 |
16817 | 240 (defun dirtrack-debug-message (string) |
241 (let ((buf (current-buffer)) | |
242 (debug-buf (get-buffer-create dirtrack-debug-buffer)) | |
243 ) | |
244 (set-buffer debug-buf) | |
16960
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
245 (goto-char (point-max)) |
16817 | 246 (insert (concat string "\n")) |
247 (set-buffer buf) | |
248 )) | |
249 | |
250 ;;;###autoload | |
251 (defun dirtrack (input) | |
252 (if (null dirtrackp) | |
253 nil | |
254 (let ((prompt-path) | |
255 (current-dir default-directory) | |
256 (matched) | |
16960
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
257 (dirtrack-regexp (nth 0 dirtrack-list)) |
16817 | 258 (match-num (nth 1 dirtrack-list)) |
259 (multi-line (nth 2 dirtrack-list)) | |
260 ) | |
261 ;; No output? | |
262 (if (eq (point) (point-min)) | |
263 nil | |
264 (save-excursion | |
16960
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
265 (goto-char (point-max)) |
16817 | 266 ;; Look for the prompt |
267 (if multi-line | |
16960
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
268 (setq matched |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
269 (re-search-backward |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
270 dirtrack-regexp |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
271 comint-last-output-start |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
272 t)) |
16817 | 273 (beginning-of-line) |
274 (setq matched (looking-at dirtrack-regexp))) | |
275 ;; No match | |
276 (if (null matched) | |
277 (and dirtrack-debug | |
278 (dirtrack-debug-message | |
279 (format | |
280 "Failed to match regexp: %s" | |
281 dirtrack-regexp))) | |
282 (setq prompt-path | |
283 (buffer-substring-no-properties | |
284 (match-beginning match-num) (match-end match-num))) | |
285 ;; Empty string | |
286 (if (not (> (length prompt-path) 0)) | |
287 (and dirtrack-debug | |
288 (dirtrack-debug-message "Match is empty string")) | |
289 ;; Transform prompts into canonical forms | |
290 (setq prompt-path (funcall dirtrack-directory-function | |
291 prompt-path)) | |
292 (setq current-dir (funcall dirtrack-canonicalize-function | |
293 current-dir)) | |
294 (and dirtrack-debug | |
295 (dirtrack-debug-message | |
296 (format | |
297 "Prompt is %s\nCurrent directory is %s" | |
298 prompt-path current-dir))) | |
299 ;; Compare them | |
300 (if (or (string= current-dir prompt-path) | |
301 (string= current-dir | |
302 (abbreviate-file-name prompt-path))) | |
303 (and dirtrack-debug | |
304 (dirtrack-debug-message | |
305 (format "Not changing directory"))) | |
16960
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
306 ;; It's possible that Emacs will think the directory |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
307 ;; won't exist (eg, rlogin buffers) |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
308 (if (file-accessible-directory-p prompt-path) |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
309 ;; Change directory |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
310 (and (shell-process-cd prompt-path) |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
311 dirtrack-debug |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
312 (dirtrack-debug-message |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
313 (format "Changing directory to %s" prompt-path))) |
8c56da3f7f7f
(dirtrack-debug-message): Put output at end of buffer.
Richard M. Stallman <rms@gnu.org>
parents:
16817
diff
changeset
|
314 (error "Directory %s does not exist" prompt-path))) |
16817 | 315 ))))))) |
316 | |
317 (provide 'dirtrack) | |
318 | |
319 ;;; dirtrack.el ends here |