]> code.delx.au - gnu-emacs-elpa/blob - multishell.el
multishell - add paths to shells started without one, when dir tracking
[gnu-emacs-elpa] / multishell.el
1 ;;; multishell.el --- facilitate multiple local and remote shell buffers
2
3 ;; Copyright (C) 1999-2016 Free Software Foundation, Inc. and Ken Manheimer
4
5 ;; Author: Ken Manheimer <ken.manheimer@gmail.com>
6 ;; Version: 1.0.8
7 ;; Created: 1999 -- first public availability
8 ;; Keywords: processes
9 ;; URL: https://github.com/kenmanheimer/EmacsMultishell
10 ;;
11 ;;; Commentary:
12 ;;
13 ;; Easily use and navigate multiple shell buffers, including remote shells.
14 ;; Fundamentally, multishell is the function `multishell-pop-to-shell' -
15 ;; a la `pop-to-buffer' - plus a keybinding. Together, they enable you to:
16 ;;
17 ;; * Get to the input point from wherever you are in a shell buffer,
18 ;; ... or to any of your shell buffers, from anywhere inside emacs.
19 ;;
20 ;; * Use universal arguments to launch and choose among alternate shell buffers,
21 ;; ... and change which is the current default.
22 ;;
23 ;; * Easily restart disconnected shells, or shells from prior sessions
24 ;; ... the latter from Emacs builtin savehist minibuf history persistence
25 ;;
26 ;; * Append a path to a new shell name to launch a shell in that directory,
27 ;; ... and use a path with Emacs tramp syntax to launch a remote shell -
28 ;; for example:
29 ;;
30 ;; * `#root/sudo:root@localhost:/etc` for a buffer named "*#root*" with a
31 ;; root shell starting in /etc.
32 ;;
33 ;; * `/ssh:example.net:` for a shell buffer in your homedir on example.net.
34 ;; The buffer will be named "*example.net*".
35 ;;
36 ;; * `#ex/ssh:example.net|sudo:root@example.net:/var/log` for a root shell
37 ;; starting in /var/log on example.net named "*#ex*".
38 ;;
39 ;; * 'interior/ssh:gateway.corp.com|ssh:interior.corp.com:' to go via
40 ;; gateway.corp.com to your homedir on interior.corp.com. The buffer
41 ;; will be named "*interior*". You could append a sudo hop, and so on.
42 ;;
43 ;; * Thanks to tramp, file visits from the shell will seamlessly be in
44 ;; the auspices of the target account, and relative to the current
45 ;; directory, on the host where the shell is running.
46 ;;
47 ;; See the `multishell-pop-to-shell` docstring for details.
48 ;;
49 ;; Customize-group `multishell' to select and activate a keybinding and set
50 ;; various behaviors. Customize-group `savehist' to preserve buffer
51 ;; names/paths across emacs restarts.
52 ;;
53 ;; Please use
54 ;; [the multishell repository](https://github.com/kenmanheimer/EmacsMultishell)
55 ;; issue tracker to report problems, suggestions, etc, and see that
56 ;; repository for a bit more documentation.
57 ;;
58 ;; Change Log:
59 ;;
60 ;; * 2016-01-24 1.0.8 Ken Manheimer:
61 ;; - Work around the shell/tramp mishandling of remote+sudo+homedir problem!
62 ;; The work around is clean and simple, basically using high-level `cd'
63 ;; API and not messing with the low-level default-directory setting.
64 ;; (Turns out the problem was not in my local config. Good riddance to the
65 ;; awkward failure handler!)
66 ;; - Clean up code resolving the destination shell, starting to document the
67 ;; decision tree in the process. See getting-to-a-shell.md in the
68 ;; multishell repository, https://github.com/kenmanheimer/EmacsMultishell
69 ;; - There may be some shake-out on resolving the destination shell, but
70 ;; this release gets the fundamental functionality soundly in place.
71 ;; * 2016-01-23 1.0.7 Ken Manheimer:
72 ;; - Remove notes about tramp remote+sudo+homedir problem. Apparently it's
73 ;; due to something in my local site configuration (happens with -q but
74 ;; not -Q).
75 ;; * 2016-01-22 1.0.6 Ken Manheimer:
76 ;; - Add multishell-version function.
77 ;; - Tweak commentary/comments/docstrings.
78 ;; - Null old multishell-buffer-name-history var, if present.
79 ;; * 2016-01-16 1.0.5 Ken Manheimer:
80 ;; - History now includes paths, when designated.
81 ;; - Actively track current directory in history entries that have a path.
82 ;; Custom control: multishell-history-entry-tracks-current-directory
83 ;; - Offer to remove shell's history entry when buffer is killed.
84 ;; (Currently the only UI mechanism to remove history entries.)
85 ;; - Fix - prevent duplicate entries for same name but different paths
86 ;; - Fix - recognize and respect tramp path syntax to start in home dir
87 ;; - Simplify history var name, migrate existing history if any from old name
88 ;; * 2016-01-04 1.0.4 Ken Manheimer - Released to ELPA
89 ;; * 2016-01-02 Ken Manheimer - working on this in public, but not yet released.
90 ;;
91 ;; TODO:
92 ;;
93 ;; * Find suitable, internally consistent ways to tidy completions, eg:
94 ;; - first list completions for active shells, then present but inactive,
95 ;; then historical
96 ;; - some way for user to toggle between presenting just buffer names vs
97 ;; full buffer/path
98 ;; - without cutting user off from easy editing of path
99 ;; - maybe use keybindings that wrap minibuffer completion keys
100 ;; - minibuffer-local-completion-map, minibuffer-local-must-match-map
101 ;; - setup minibuffer with these vars just before doing completions
102 ;; - minibuffer exit reverts these vars, if necessary
103 ;; - toggles between name and name/path if repeat count provided
104 ;; - and an instruction about toggling in the completion buffer
105 ;; - eventually? "multishell-list-all", based on tabulated-list-mode
106 ;; - list-environment package is small, tidy, may be an easy template?
107 ;; - sort based on existing vs just historical
108 ;; - launch
109 ;; - rename, change path, and remove history entries
110 ;; - could we use it as the transient completions help window?
111 ;; * Investigate whether we can recognize and provide for failed hops.
112 ;; - Tramp doesn't provide useful reactions for any hop but the first
113 ;; - Might be stuff we can do to detect and convey failures?
114 ;; - Might be no recourse but to seek tramp changes.
115 ;; * Add custom shell launch prep actions
116 ;; - shell commands to execute when shell name or path matches a regexp
117 ;; - list of [regexp, which (name, path, or both), command]
118 ;; - for, eg, knock commands or interface activations, whatever
119 ;; * Try minibuffer field boundary at beginning of tramp path, to see whether
120 ;; the field boundary magically enables tramp path completion.
121 ;; * Assess whether deletion of history entry via kill-buffer is sufficient.
122
123 ;;; Code:
124
125 (require 'comint)
126 (require 'shell)
127 (require 'savehist)
128
129 (defvar multishell-version "1.0.8")
130 (defun multishell-version (&optional here)
131 "Return string describing the loaded multishell version."
132 (interactive "P")
133 (let ((msg (concat "Multishell " multishell-version)))
134 (if here (insert msg)
135 (if (called-interactively-p 'interactive)
136 (message "%s" msg)
137 msg))))
138
139 (defgroup multishell nil
140 "Allout extension that highlights outline structure graphically.
141
142 Customize `allout-widgets-auto-activation' to activate allout-widgets
143 with allout-mode."
144 :group 'shell)
145
146 (defcustom multishell-command-key "\M- "
147 "The key to use if `multishell-activate-command-key' is true.
148
149 You can instead manually bind `multishell-pop-to-shell` using emacs
150 lisp, eg: (global-set-key \"\\M- \" 'multishell-pop-to-shell)."
151 :type 'key-sequence
152 :group 'multishell)
153
154 (defvar multishell--responsible-for-command-key nil
155 "Coordination for multishell key assignment.")
156 (defun multishell-activate-command-key-setter (symbol setting)
157 "Implement `multishell-activate-command-key' choice."
158 (set-default 'multishell-activate-command-key setting)
159 (when (or setting multishell--responsible-for-command-key)
160 (multishell-implement-command-key-choice (not setting))))
161 (defun multishell-implement-command-key-choice (&optional unbind)
162 "If settings dicate, implement binding of multishell command key.
163
164 If optional UNBIND is true, globally unbind the key.
165
166 * `multishell-activate-command-key' - Set this to get the binding or not.
167 * `multishell-command-key' - The key to use for the binding, if appropriate."
168 (cond (unbind
169 (when (and (boundp 'multishell-command-key) multishell-command-key)
170 (global-unset-key multishell-command-key)))
171 ((not (and (boundp 'multishell-activate-command-key)
172 (boundp 'multishell-command-key)))
173 nil)
174 ((and multishell-activate-command-key multishell-command-key)
175 (setq multishell--responsible-for-command-key t)
176 (global-set-key multishell-command-key 'multishell-pop-to-shell))))
177
178 (defcustom multishell-activate-command-key nil
179 "Set this to impose the `multishell-command-key' binding.
180
181 You can instead manually bind `multishell-pop-to-shell` using emacs
182 lisp, eg: (global-set-key \"\\M- \" 'multishell-pop-to-shell)."
183 :type 'boolean
184 :set 'multishell-activate-command-key-setter
185 :group 'multishell)
186
187 ;; Implement the key customization whenever the package is loaded:
188 (if (fboundp 'with-eval-after-load)
189 (with-eval-after-load "multishell"
190 (multishell-implement-command-key-choice))
191 (eval-after-load "multishell"
192 (multishell-implement-command-key-choice)))
193
194 (defcustom multishell-pop-to-frame nil
195 "*If non-nil, jump to a frame already showing the shell, if another one is.
196
197 Otherwise, disregard already-open windows on the shell if they're
198 in another frame, and open a new window on the shell in the
199 current frame.
200
201 \(Use `pop-up-windows' to change multishell other-window vs
202 current-window behavior.)"
203 :type 'boolean
204 :group 'multishell)
205
206 (defcustom multishell-history-entry-tracks-current-directory t
207 "Maintain shell's current directory in its multishell history entry.
208
209 When set, the history entry for shells started with explicit
210 paths will track the shell's current working directory. (Explicit
211 paths will not be added to local shells started without one,
212 however.)
213
214 If `savehist-save-minibuffer-history' is enabled, the current
215 working directory of shells \(that were started with an explicit
216 path) will be conveyed between emacs sessions."
217 :type 'boolean
218 :group 'multishell)
219
220 (defvar multishell-history nil
221 "Name/path entries, most recent first.")
222 ;; Migrate the few pre 1.0.5 users to changed history var:
223 (when (and (not multishell-history)
224 (boundp 'multishell-buffer-name-history)
225 multishell-buffer-name-history)
226 (setq multishell-history multishell-buffer-name-history
227 multishell-buffer-name-history nil))
228
229 (defvar multishell-primary-name "*shell*"
230 "Default shell name for un-modified multishell-pop-to-shell buffer target.
231
232 This is set by `multishell-pop-to-shell' as the current default,
233 when invoked with doubled universal argument.
234
235 If you want the designated primary that you have at the end of
236 one emacs session to be resumed at the next, customize
237 `savehist-additional-variables' to include the
238 `multishell-primary-name'.")
239
240 ;; Multiple entries happen because completion also adds name to history.
241 (defun multishell-register-name-to-path (name path)
242 "Add or replace entry associating NAME with PATH in `multishell-history'.
243
244 If NAME already had a PATH and new PATH is empty, retain the prior one.
245
246 Promote added/changed entry to the front of the list."
247 ;; Add or promote to the front, tracking path changes in the process.
248 (let* ((entries (multishell-history-entries name))
249 (path (or path "")))
250 (dolist (entry entries)
251 (when (string= path "")
252 ;; Retain explicit established path.
253 (setq path (cadr (multishell-split-entry entry))))
254 (setq multishell-history (delete entry multishell-history)))
255 (setq multishell-history (push (concat name path)
256 multishell-history))))
257
258 (defun multishell-history-entries (name)
259 "Return `multishell-history' entry that starts with NAME, or nil if none."
260 (save-match-data
261 (let ((match-expr (concat "^" name "\\\(/.*$\\\)?$"))
262 got)
263 (dolist (entry multishell-history)
264 (when (and (string-match match-expr entry)
265 (not (member entry got)))
266 (setq got (cons entry got))))
267 got)))
268
269 (defun multishell-pop-to-shell (&optional arg)
270 "Easily navigate to and within multiple shell buffers, local and remote.
271
272 Use universal arguments to launch and choose between alternate
273 shell buffers and to select which is default. Append a path to
274 a new shell name to launch a shell in that directory, and use
275 Emacs tramp syntax to launch a remote shell.
276
277 Customize-group `multishell' to set up a key binding and tweak behaviors.
278
279 ==== Basic operation:
280
281 - If the current buffer is shell-mode (or shell-mode derived)
282 buffer then focus is moved to the process input point.
283
284 \(You can use a universal argument go to a different shell
285 buffer when already in a buffer that has a process - see
286 below.)
287
288 - If not in a shell buffer (or with universal argument), go to a
289 window that is already showing the (a) shell buffer, if any.
290
291 In this case, the cursor is left in its prior position in the
292 shell buffer. Repeating the command will then go to the
293 process input point, per the first item in this list.
294
295 We respect `pop-up-windows', so you can adjust it to set the
296 other-buffer/same-buffer behavior.
297
298 - Otherwise, start a new shell buffer, using the current
299 directory as the working directory.
300
301 If a buffer with the resulting name exists and its shell process
302 was disconnected or otherwise stopped, it's resumed.
303
304 ===== Universal arg to start and select between named shell buffers:
305
306 You can name alternate shell buffers to create or return to using
307 single or doubled universal arguments:
308
309 - With a single universal argument, prompt for the buffer name
310 to use (without the asterisks that shell mode will put around
311 the name), defaulting to 'shell'.
312
313 Completion is available.
314
315 This combination makes it easy to start and switch across
316 multiple shell restarts.
317
318 - A double universal argument will prompt for the name *and* set
319 the default to that name, so the target shell becomes the
320 primary.
321
322 See `multishell-primary-name' for info about preserving the
323 setting across emacs restarts.
324
325 ===== Select starting directory and remote host:
326
327 The shell buffer name you give to the prompt for a universal arg
328 can include an appended path. That will be used for the startup
329 directory. You can use tramp remote syntax to specify a remote
330 shell. If there is an element after a final '/', that's used for
331 the buffer name. Otherwise, the host, domain, or path is used.
332
333 For example:
334
335 * '#root/sudo:root@localhost:/etc' for a buffer named \"*#root*\" with a
336 root shell starting in /etc.
337
338 * '/ssh:example.net:' for a shell buffer in your homedir on example.net.
339 The buffer will be named \"*example.net*\".
340
341 * '#ex/ssh:example.net|sudo:root@example.net:/var/log' for a root shell
342 starting in /var/log on example.net named \"*#ex*\".
343
344 * 'interior/ssh:gateway.corp.com|ssh:interior.corp.com:' to go
345 via gateway.corp.com to your homedir on interior.corp.com. The
346 buffer will be named \"*interior*\". You could append a sudo
347 hop to the path, combining the previous example, and so on.
348
349 File visits from the shell, and many common emacs activities like
350 dired, will be on the host where the shell is running, in the
351 auspices of the target account, and relative to the current
352 directory.
353
354 You can change the startup path for a shell buffer by editing it
355 at the completion prompt. The new path will not take effect for
356 an already-running shell.
357
358 To remove a shell buffer's history entry, kill the buffer and
359 affirm removal of the entry when prompted.
360
361 ===== Activate savehist to retain shell buffer names and paths across Emacs restarts:
362
363 To have emacs maintain your history of shell buffer names and paths,
364 customize the savehist group to activate savehist."
365
366 (interactive "P")
367
368 (let* ((from-buffer (current-buffer))
369 (from-buffer-is-shell (derived-mode-p 'shell-mode))
370 (primary-name-unbracketed (multishell-unbracket-asterisks
371 multishell-primary-name))
372 (fallthrough-name (if from-buffer-is-shell
373 (buffer-name from-buffer)
374 primary-name-unbracketed))
375 (doublearg (equal arg '(16)))
376 (target-name-and-path
377 (multishell-resolve-target-name-and-path
378 (if arg
379 (or (multishell-read-bare-shell-buffer-name
380 (format "Shell buffer name [%s]%s "
381 primary-name-unbracketed
382 (if doublearg " <==" ":"))
383 primary-name-unbracketed)
384 primary-name-unbracketed)
385 fallthrough-name)))
386 (use-path (cadr target-name-and-path))
387 (target-shell-buffer-name (car target-name-and-path))
388 (target-buffer (get-buffer target-shell-buffer-name))
389 (curr-buff-proc (get-buffer-process from-buffer))
390 inwin
391 already-there)
392
393 ;; Register early so the entry is pushed to the front:
394 (multishell-register-name-to-path (multishell-unbracket-asterisks
395 target-shell-buffer-name)
396 use-path)
397
398 (when doublearg
399 (setq multishell-primary-name target-shell-buffer-name))
400
401 ;; Situate:
402
403 (cond
404
405 ((and (or curr-buff-proc from-buffer-is-shell)
406 (not arg)
407 (eq from-buffer target-buffer)
408 (not (eq target-shell-buffer-name (buffer-name from-buffer))))
409 ;; In a shell buffer, but not named - stay in buffer, but go to end.
410 (setq already-there t))
411
412 ((string= (buffer-name) target-shell-buffer-name)
413 ;; Already in the specified shell buffer:
414 (setq already-there t))
415
416 ((or (not target-buffer)
417 (not (setq inwin
418 (multishell-get-visible-window-for-buffer target-buffer))))
419 ;; No preexisting shell buffer, or not in a visible window:
420 (when (not (get-buffer target-shell-buffer-name))
421 (message "Creating new shell buffer '%s'" target-shell-buffer-name))
422 (pop-to-buffer target-shell-buffer-name pop-up-windows))
423
424 ;; Buffer exists and already has a window - jump to it:
425 (t (if (and multishell-pop-to-frame
426 inwin
427 (not (equal (window-frame (selected-window))
428 (window-frame inwin))))
429 (select-frame-set-input-focus (window-frame inwin)))
430 (if (not (string= (buffer-name (current-buffer))
431 target-shell-buffer-name))
432 (pop-to-buffer target-shell-buffer-name t))))
433
434 ;; We're in the buffer. Activate:
435
436 (if (not (comint-check-proc (current-buffer)))
437 (multishell-start-shell-in-buffer (buffer-name (current-buffer))
438 use-path))
439
440 ;; If the destination buffer has a stopped process, resume it:
441 (let ((process (get-buffer-process (current-buffer))))
442 (if (and process (equal 'stop (process-status process)))
443 (continue-process process)))
444
445 (when (or already-there
446 (equal (current-buffer) from-buffer))
447 (goto-char (point-max))
448 (and (get-buffer-process from-buffer)
449 (goto-char (process-mark (get-buffer-process from-buffer)))))))
450
451 (defun multishell-kill-buffer-query-function ()
452 "Offer to remove multishell-history entry for buffer."
453 ;; Removal choice is crucial, so users can, eg, kill a shell with huge
454 ;; output backlog, while keeping the history entry to easily restart it.
455 ;;
456 ;; We use kill-buffer-query-functions instead of kill-buffer-hook because:
457 ;;
458 ;; 1. It enables the user to remove the history without actually killing a
459 ;; running buffer, by not confirming the subsequent running-proc query.
460 ;; 2. kill-buffer-hooks often fails to run when killing shell buffers!
461 ;; It's probably due to failures in other hooks - beyond our control -
462 ;; and anyway, I like the first reason well enough.
463
464 ;; (Use condition-case to avoid inadvertant disruption of kill-buffer
465 ;; activity. kill-buffer happens behind the scenes a whole lot.)
466 (condition-case err
467 (dolist (entry (and (derived-mode-p 'shell-mode)
468 (multishell-history-entries
469 (multishell-unbracket-asterisks (buffer-name)))))
470 (when (and entry
471 (y-or-n-p (format "Remove multishell history entry `%s'? "
472 entry)))
473 (setq multishell-history
474 (delete entry multishell-history))))
475 (error
476 (message "multishell-kill-buffer-query-function error: %s" err)))
477 t)
478 (add-hook 'kill-buffer-query-functions 'multishell-kill-buffer-query-function)
479
480 (defun multishell-get-visible-window-for-buffer (buffer)
481 "Return visible window containing buffer."
482 (catch 'got-a-vis
483 (walk-windows
484 (function (lambda (win)
485 (if (and (eq (window-buffer win) buffer)
486 (equal (frame-parameter
487 (selected-frame) 'display)
488 (frame-parameter
489 (window-frame win) 'display)))
490 (throw 'got-a-vis win))))
491 nil 'visible)
492 nil))
493
494 (defun multishell-read-bare-shell-buffer-name (prompt default)
495 "PROMPT for shell buffer name, sans asterisks. Indicate DEFAULT in prompt.
496
497 Return the supplied name, if provided, else return nil."
498 (let* ((candidates
499 (append
500 ;; Plain shell buffer names appended with names from name/path hist:
501 (remq nil
502 (mapcar (lambda (buffer)
503 (let* ((name (multishell-unbracket-asterisks
504 (buffer-name buffer))))
505 (and (buffer-live-p buffer)
506 (with-current-buffer buffer
507 ;; Shell mode buffers.
508 (derived-mode-p 'shell-mode))
509 ;; Allow duplicates, as sign of buffers that
510 ;; currently exist vs historical entries.
511 ;;(not (multishell-history-entries name))
512 name)))
513 (buffer-list)))
514 multishell-history))
515 (got (completing-read prompt
516 ;; COLLECTION:
517 (reverse candidates)
518 ;; PREDICATE:
519 nil
520 ;; REQUIRE-MATCH:
521 'confirm
522 ;; INITIAL-INPUT
523 nil
524 ;; HIST:
525 'multishell-history)))
526 (if (not (string= got ""))
527 got
528 nil)))
529
530 (defun multishell-resolve-target-name-and-path (path-ish)
531 "Given name/tramp-path PATH-ISH, resolve buffer name and initial directory.
532
533 The name is the part of the string up to the first '/' slash, if
534 any. Missing pieces are filled in from remote path elements, if
535 any, and multishell history. Given a path and no name, either the
536 host-name, domain-name, final directory name, or local host name
537 is used.
538
539 Return them as a list (name path), with name asterisk-bracketed
540 and path nil if none resolved."
541 (let* ((splat (multishell-split-entry (or path-ish "")))
542 (name (car splat))
543 (path (cadr splat)))
544 (if path
545 (if (not name)
546 (setq name
547 (if (file-remote-p path)
548 (let ((vec (tramp-dissect-file-name path)))
549 (or (tramp-file-name-host vec)
550 (tramp-file-name-domain vec)
551 (tramp-file-name-localname vec)
552 system-name))
553 multishell-primary-name)))
554 ;; No path - get one from history, if present.
555 (when (not name)
556 (setq name multishell-primary-name))
557 (mapcar #'(lambda (entry)
558 (when (or (not path) (string= path ""))
559 (setq path (cadr (multishell-split-entry entry)))))
560 (multishell-history-entries
561 (multishell-unbracket-asterisks name))))
562 (list (multishell-bracket-asterisks name) path)))
563
564 (defun multishell-start-shell-in-buffer (buffer-name path)
565 "Start, restart, or continue a shell in BUFFER-NAME on PATH."
566 (let* ((buffer (get-buffer buffer-name))
567 is-remote is-active)
568
569 (set-buffer buffer)
570 (setq is-active (comint-check-proc buffer))
571
572 (when (and path (not is-active))
573
574 (when (and (derived-mode-p 'shell-mode) (file-remote-p path))
575 ;; Returning to disconnected remote shell - do some tidying:
576 (tramp-cleanup-connection
577 (tramp-dissect-file-name default-directory 'noexpand)
578 'keep-debug 'keep-password))
579
580 (message "Connecting to %s" path)
581 (cd path))
582
583 (shell buffer)))
584
585 (defun multishell-track-dirchange (name newpath)
586 "Change multishell history entry to track current directory."
587 (let* ((entries (multishell-history-entries name)))
588 (dolist (entry entries)
589 (let* ((name-path (multishell-split-entry entry))
590 (name (car name-path))
591 (path (or (cadr name-path) "")))
592 (when path
593 (let* ((is-remote (file-remote-p path))
594 (vec (and is-remote (tramp-dissect-file-name path nil)))
595 (localname (if is-remote
596 (tramp-file-name-localname vec)
597 path))
598 (newlocalname
599 (replace-regexp-in-string (if (string= localname "")
600 "$"
601 (regexp-quote localname))
602 ;; REP
603 newpath
604 ;; STRING
605 localname
606 ;; FIXEDCASE
607 t
608 ;; LITERAL
609 t
610 ))
611 (newpath (if is-remote
612 (tramp-make-tramp-file-name (aref vec 0)
613 (aref vec 1)
614 (aref vec 2)
615 newlocalname
616 (aref vec 4))
617 newpath))
618 (newentry (concat name newpath))
619 (membership (member entry multishell-history)))
620 (when membership
621 (setcar membership newentry))))))))
622 (defvar multishell-was-default-directory ()
623 "Provide for tracking directory changes.")
624 (make-variable-buffer-local 'multishell-was-default-directory)
625 (defun multishell-post-command-business ()
626 "Do multishell bookkeeping."
627 ;; Update multishell-history with dir changes.
628 (condition-case err
629 (when (and multishell-history-entry-tracks-current-directory
630 (derived-mode-p 'shell-mode))
631 (let ((curdir (if (file-remote-p default-directory)
632 (tramp-file-name-localname
633 (tramp-dissect-file-name default-directory))
634 default-directory)))
635 (when (not (string= curdir (or multishell-was-default-directory "")))
636 (multishell-track-dirchange (multishell-unbracket-asterisks
637 (buffer-name))
638 curdir))
639 (setq multishell-was-default-directory curdir)))
640 ;; To avoid disruption as a pervasive hook function, swallow all errors:
641 (error
642 (message "multishell-post-command-business error: %s" err))))
643 (add-hook 'post-command-hook 'multishell-post-command-business)
644
645 (defun multishell-split-entry (entry)
646 "Given multishell name/path ENTRY, return the separated name and path pair.
647
648 Returns nil for empty parts, rather than the empty string."
649 (save-match-data
650 (string-match "^\\([^/]*\\)\\(/?.*\\)?" entry)
651 (let ((name (match-string 1 entry))
652 (path (match-string 2 entry)))
653 (and (string= name "") (setq name nil))
654 (and (string= path "") (setq path nil))
655 (list name path))))
656 (defun multishell-bracket-asterisks (name)
657 "Return a copy of name, ensuring it has an asterisk at the beginning and end."
658 (if (not (string= (substring name 0 1) "*"))
659 (setq name (concat "*" name)))
660 (if (not (string= (substring name -1) "*"))
661 (setq name (concat name "*")))
662 name)
663 (defun multishell-unbracket-asterisks (name)
664 "Return a copy of name, removing asterisks, if any, at beginning and end."
665 (if (string= (substring name 0 1) "*")
666 (setq name (substring name 1)))
667 (if (string= (substring name -1) "*")
668 (setq name (substring name 0 -1)))
669 name)
670
671 (provide 'multishell)
672
673 ;;; multishell.el ends here