;; Copyright (C) 1999-2016 Free Software Foundation, Inc. and Ken Manheimer
;; Author: Ken Manheimer <ken.manheimer@gmail.com>
-;; Version: 1.0.8
+;; Version: 1.0.9
;; Created: 1999 -- first public availability
;; Keywords: processes
;; URL: https://github.com/kenmanheimer/EmacsMultishell
;; * Thanks to tramp, file visits from the shell will seamlessly be in
;; the auspices of the target account, and relative to the current
;; directory, on the host where the shell is running.
-;;
+;;
+;; * Manage your list of shells, current and past, as a collection.
+;;
;; See the `multishell-pop-to-shell` docstring for details.
;;
;; Customize-group `multishell' to select and activate a keybinding and set
;;
;; Change Log:
;;
+;; * 2016-01-30 1.0.9 Ken Manheimer:
+;; - Add multishell-list for managing the collection of current and
+;; history-registered shells: edit, delete, and switch/pop to entries.
+;; Easy access by invoking `multishell-pop-to-shell' from in the
+;; `multishell-pop-to-shell' universal arg prompts.
+;; - Duplicate existing shell buffer names in completions, for distinction.
+;; - Add paths to buffers started without one, when multishell history dir
+;; tracking is enabled.
+;; - Major code cleanup:
+;; - Simplify multishell-start-shell-in-buffer, in particular using
+;; shell function, rather than unnecessarily going underneath it.
+;; - Establish multishell-name-from-entry as canonical name resolver.
+;; - Fallback to eval-after-load in emacs versions that lack
+;; with-eval-after-load (eg, emacs 23).
+;; - save-match-data, where match-string is used
+;; - resituate some helpers
;; * 2016-01-24 1.0.8 Ken Manheimer:
;; - Work around the shell/tramp mishandling of remote+sudo+homedir problem!
;; The work around is clean and simple, basically using high-level `cd'
;; * 2016-01-04 1.0.4 Ken Manheimer - Released to ELPA
;; * 2016-01-02 Ken Manheimer - working on this in public, but not yet released.
;;
-;; TODO:
+;; TODO and Known Issues:
;;
-;; * Find suitable, internally consistent ways to tidy completions, eg:
-;; - first list completions for active shells, then present but inactive,
-;; then historical
-;; - some way for user to toggle between presenting just buffer names vs
-;; full buffer/path
-;; - without cutting user off from easy editing of path
-;; - maybe use keybindings that wrap minibuffer completion keys
-;; - minibuffer-local-completion-map, minibuffer-local-must-match-map
-;; - setup minibuffer with these vars just before doing completions
-;; - minibuffer exit reverts these vars, if necessary
-;; - toggles between name and name/path if last command was one of them
-;; - and an instruction in the completion buffer
-;; - "complete again immediately to toggle name vs name/path completions"
;; * Add custom shell launch prep actions
+;; - for, eg, port knocking, interface activations
;; - shell commands to execute when shell name or path matches a regexp
-;; - list of [regexp, which (name, path, or both), command]
-;; - for, eg, knock commands or interface activations, whatever
+;; - list of (regexp, which - name, path, or both, command)
+;; * Adapt multishell-list facilities for all-completions
+;; - See info on minibuffer-completion-help, display-completion-list
+;; - implement markup for mouse selection
+;; * Investigate whether we can recognize and provide for failed hops.
+;; - Tramp doesn't provide useful reactions for any hop but the first
+;; - Might be stuff we can do to detect and convey failures?
+;; - Might be no recourse but to seek tramp changes.
;; * Try minibuffer field boundary at beginning of tramp path, to see whether
;; the field boundary magically enables tramp path completion.
-;; * Assess whether deletion of history entry via kill-buffer is sufficient.
;;; Code:
(require 'comint)
(require 'shell)
(require 'savehist)
+(require 'multishell-list)
-(defvar multishell-version "1.0.8")
+(defvar multishell-version "1.0.9")
(defun multishell-version (&optional here)
"Return string describing the loaded multishell version."
(interactive "P")
:group 'multishell)
;; Implement the key customization whenever the package is loaded:
-(with-eval-after-load "multishell"
- (multishell-implement-command-key-choice))
+(if (fboundp 'with-eval-after-load)
+ (with-eval-after-load "multishell"
+ (multishell-implement-command-key-choice))
+ (eval-after-load "multishell"
+ (multishell-implement-command-key-choice)))
(defcustom multishell-pop-to-frame nil
"*If non-nil, jump to a frame already showing the shell, if another one is.
(defvar multishell-primary-name "*shell*"
"Default shell name for un-modified multishell-pop-to-shell buffer target.
-This is adjusted by `multishell-pop-to-shell' when it is
-invoked (with doubled universal argument) to set the default.
-
-To track the current primary across emacs restarts, add the name
-of this variable to `savehist-additional-variables' by
-customizing the latter.")
-
-;;; Can't just add multishell-primary-name to savehist-additional-variables
-;;; - it'll be lost any time the user runs emacs without loading
-;;; multishell. So instead, inform the user that they can customize
-;;; savehist-additional-variables.
-;;;
-;;; I suspect that including savehist-additional-variables *on*
-;;; savehist-additional-variables could avoid this problem, as long as it
-;;; doesn't conflict with user customizations. However, even if that works,
-;;; doing so from multishell would change a behavior (for the better, but)
-;;; beyond multishell's scope, making the change hard to track down.
-
-;; (when (not (member 'multishell-primary-name
-;; savehist-additional-variables))
-;; (setq savehist-additional-variables
-;; (cons 'multishell-primary-name savehist-additional-variables)))
+This is set by `multishell-pop-to-shell' as the current default,
+when invoked with doubled universal argument.
+
+If you want the designated primary that you have at the end of
+one emacs session to be resumed at the next, customize
+`savehist-additional-variables' to include the
+`multishell-primary-name'.")
;; Multiple entries happen because completion also adds name to history.
(defun multishell-register-name-to-path (name path)
(defun multishell-history-entries (name)
"Return `multishell-history' entry that starts with NAME, or nil if none."
- (let ((match-expr (concat "^" name "\\\(/.*$\\\)?$"))
- got)
+ (let (got)
(dolist (entry multishell-history)
- (when (and (string-match match-expr entry)
+ (when (and (string-equal name (multishell-name-from-entry entry))
(not (member entry got)))
(setq got (cons entry got))))
got))
-(defun multishell-pop-to-shell (&optional arg)
+;;;###autoload
+(defun multishell-pop-to-shell (&optional arg name here)
"Easily navigate to and within multiple shell buffers, local and remote.
-Use universal arguments to launch and choose between alternate
-shell buffers and to select which is default. Append a path to
-a new shell name to launch a shell in that directory, and use
-Emacs tramp syntax to launch a remote shell.
+Use a single `universal-argument' (\\[universal-argument]) to launch and choose between
+nalternate shell buffers, and a doubled universal argument to also set your
+choice as the ongoing default. Append a path to a new shell name to launch
+a shell in that directory, and use Emacs tramp syntax to launch a remote
+shell. There is a shortcut to manage your list of current and
+historical shells, collectively, using `multishell-list' - see below.
Customize-group `multishell' to set up a key binding and tweak behaviors.
+Manage your collection of current and historical shells by
+recursively invoking \\[multishell-pop-to-shell] at either of the
+`multishell-pop-to-shell' universal argument prompts, or at any time via
+\\[multishell-list]. Hit ? in the listing buffer for editing commands.
+
==== Basic operation:
- If the current buffer is shell-mode (or shell-mode derived)
===== Universal arg to start and select between named shell buffers:
-You can name alternate shell buffers to create or return to using
-single or doubled universal arguments:
+You can name alternate shell buffers to create or return to, by
+prefixing your \\[multishell-pop-to-shell] invocation with single or double
+`universal-argument', \\[universal-argument]:
- With a single universal argument, prompt for the buffer name
to use (without the asterisks that shell mode will put around
See `multishell-primary-name' for info about preserving the
setting across emacs restarts.
+ - Manage your collection of current and historical shells by
+ recursively invoking \\[multishell-pop-to-shell] at either of the
+ `multishell-pop-to-shell' universal argument prompts, or at any
+ time via \\[multishell-list]. Hit ? in the listing buffer for
+ editing commands.
+
===== Select starting directory and remote host:
The shell buffer name you give to the prompt for a universal arg
buffer will be named \"*interior*\". You could append a sudo
hop to the path, combining the previous example, and so on.
-Thanks to tramp, file visits from the shell, and many common
-emacs activities, like dired, will seamlessly be in the auspices
-of the target account, and relative to the current directory, on
-the host where the shell is running.
+File visits from the shell, and many common emacs activities like
+dired, will be on the host where the shell is running, in the
+auspices of the target account, and relative to the current
+directory.
You can change the startup path for a shell buffer by editing it
-at the completion prompt. The new path will be preserved in
-history but will not take effect for an already-running shell.
+at the completion prompt. The new path will not take effect for
+an already-running shell.
To remove a shell buffer's history entry, kill the buffer and
affirm removal of the entry when prompted.
(interactive "P")
+ (let ((token '(token)))
+ (if (window-minibuffer-p)
+ (throw 'multishell-do-list token)
+ (if (equal token
+ (catch 'multishell-do-list
+ (multishell-pop-to-shell-worker arg name here)))
+ (multishell-list)))))
+
+(defun multishell-pop-to-shell-worker (&optional arg name here)
+ "Do real work of `multishell-pop-to-shell', which see."
(let* ((from-buffer (current-buffer))
(from-buffer-is-shell (derived-mode-p 'shell-mode))
- (primary-name-unbracketed (multishell-unbracket-asterisks
+ (primary-name-unbracketed (multishell-unbracket
multishell-primary-name))
(fallthrough-name (if from-buffer-is-shell
(buffer-name from-buffer)
(doublearg (equal arg '(16)))
(target-name-and-path
(multishell-resolve-target-name-and-path
- (if arg
- (or (multishell-read-bare-shell-buffer-name
- (format "Shell buffer name [%s]%s "
- primary-name-unbracketed
- (if doublearg " <==" ":"))
- primary-name-unbracketed)
- primary-name-unbracketed)
- fallthrough-name)))
+ (cond (name name)
+ (arg
+ (or (multishell-read-unbracketed-entry
+ (format "Shell buffer name [%s]%s "
+ primary-name-unbracketed
+ (if doublearg " <==" ":"))
+ primary-name-unbracketed)
+ primary-name-unbracketed))
+ (t fallthrough-name))))
(use-path (cadr target-name-and-path))
(target-shell-buffer-name (car target-name-and-path))
(target-buffer (get-buffer target-shell-buffer-name))
already-there)
;; Register early so the entry is pushed to the front:
- (multishell-register-name-to-path (multishell-unbracket-asterisks
+ (multishell-register-name-to-path (multishell-unbracket
target-shell-buffer-name)
use-path)
(not (setq inwin
(multishell-get-visible-window-for-buffer target-buffer))))
;; No preexisting shell buffer, or not in a visible window:
- (pop-to-buffer target-shell-buffer-name pop-up-windows))
+ (when (not (get-buffer target-shell-buffer-name))
+ (message "Creating new shell buffer '%s'" target-shell-buffer-name))
+ (if here
+ (switch-to-buffer target-shell-buffer-name)
+ (pop-to-buffer target-shell-buffer-name pop-up-windows)))
- ;; Buffer exists and already has a window - jump to it:
+ ;; Buffer exists and already has a window - jump to it:
(t (if (and multishell-pop-to-frame
inwin
(not (equal (window-frame (selected-window))
(select-frame-set-input-focus (window-frame inwin)))
(if (not (string= (buffer-name (current-buffer))
target-shell-buffer-name))
- (pop-to-buffer target-shell-buffer-name t))))
+ (if here
+ (switch-to-buffer target-shell-buffer-name)
+ (pop-to-buffer target-shell-buffer-name t)))))
;; We're in the buffer. Activate:
(and (get-buffer-process from-buffer)
(goto-char (process-mark (get-buffer-process from-buffer)))))))
+(defun multishell-delete-history-name (name &optional ask)
+ "Remove all multishell history entries for NAME.
+
+if optional ask is non-nil (default nil), ask before each deletion.
+
+Return the last entry deleted."
+ (let (got)
+ (dolist (entry (multishell-history-entries name) got)
+ (when (and entry
+ (or (not ask)
+ (y-or-n-p (format "Remove multishell history entry `%s'? "
+ entry))))
+ (setq got entry
+ multishell-history (delete entry multishell-history))))))
+
(defun multishell-kill-buffer-query-function ()
"Offer to remove multishell-history entry for buffer."
;; Removal choice is crucial, so users can, eg, kill a shell with huge
;; (Use condition-case to avoid inadvertant disruption of kill-buffer
;; activity. kill-buffer happens behind the scenes a whole lot.)
(condition-case err
- (dolist (entry (and (derived-mode-p 'shell-mode)
- (multishell-history-entries
- (multishell-unbracket-asterisks (buffer-name)))))
- (when (and entry
- (y-or-n-p (format "Remove multishell history entry `%s'? "
- entry)))
- (setq multishell-history
- (delete entry multishell-history))))
+ (and (derived-mode-p 'shell-mode)
+ (multishell-delete-history-name
+ (multishell-unbracket (buffer-name))
+ t))
(error
(message "multishell-kill-buffer-query-function error: %s" err)))
t)
nil 'visible)
nil))
-(defun multishell-read-bare-shell-buffer-name (prompt default)
+(defun multishell-all-entries (&optional active-duplicated)
+ "Return multishell history, with active buffers listed first.
+
+Optional ACTIVE-DUPLICATED will return a copy of
+`multishell-history' with unbracketed names of active buffers,
+sans paths, appended to the list, so they have short and long
+completions."
+ ;; Reorder so active lead present lead historical entries:
+ (let (active-entries active-names present past splat name path buffer)
+ (dolist (entry multishell-history)
+ (setq splat (multishell-split-entry entry)
+ name (car splat)
+ path (cadr splat)
+ buffer (and name (get-buffer (multishell-bracket name))))
+ (if (buffer-live-p buffer)
+ (if (comint-check-proc buffer)
+ (setq active-entries (push entry active-entries)
+ active-names (push name active-names))
+ (setq present (push entry present)))
+ (setq past (push entry past))))
+ (setq multishell-history (append active-entries present past))
+ (if active-duplicated
+ (append multishell-history active-names)
+ multishell-history)))
+
+(defun multishell-read-unbracketed-entry (prompt default &optional initial)
"PROMPT for shell buffer name, sans asterisks. Indicate DEFAULT in prompt.
-Return the supplied name, if provided, else return nil."
- (let* ((candidates
- (append
- ;; Plain shell buffer names appended with names from name/path hist:
- (remq nil
- (mapcar (lambda (buffer)
- (let* ((name (multishell-unbracket-asterisks
- (buffer-name buffer))))
- (and (buffer-live-p buffer)
- (with-current-buffer buffer
- ;; Shell mode buffers.
- (derived-mode-p 'shell-mode))
- (not (multishell-history-entries name))
- name)))
- (buffer-list)))
- multishell-history))
+Optional INITIAL is preliminary value to be edited.
+
+Input and completion can include associated path, if any.
+
+Return what's provided, if anything, else nil."
+ (let* ((candidates (multishell-all-entries 'active-duplicated))
(got (completing-read prompt
;; COLLECTION:
(reverse candidates)
;; REQUIRE-MATCH:
'confirm
;; INITIAL-INPUT
- nil
+ initial
;; HIST:
'multishell-history)))
(if (not (string= got ""))
Return them as a list (name path), with name asterisk-bracketed
and path nil if none resolved."
(let* ((splat (multishell-split-entry (or path-ish "")))
- (name (car splat))
- (path (cadr splat)))
- (if path
- (if (not name)
- (setq name
- (if (file-remote-p path)
- (let ((vec (tramp-dissect-file-name path)))
- (or (tramp-file-name-host vec)
- (tramp-file-name-domain vec)
- (tramp-file-name-localname vec)
- system-name))
- multishell-primary-name)))
- ;; No path - get one from history, if present.
- (when (not name)
- (setq name multishell-primary-name))
+ (path (cadr splat))
+ (name (or (car splat) (multishell-name-from-entry path))))
+ (when (not path)
+ ;; Get path from history, if present.
(mapcar #'(lambda (entry)
(when (or (not path) (string= path ""))
(setq path (cadr (multishell-split-entry entry)))))
(multishell-history-entries
- (multishell-unbracket-asterisks name))))
- (list (multishell-bracket-asterisks name) path)))
-
-(defun multishell-bracket-asterisks (name)
- "Return a copy of name, ensuring it has an asterisk at the beginning and end."
- (if (not (string= (substring name 0 1) "*"))
- (setq name (concat "*" name)))
- (if (not (string= (substring name -1) "*"))
- (setq name (concat name "*")))
- name)
-(defun multishell-unbracket-asterisks (name)
- "Return a copy of name, removing asterisks, if any, at beginning and end."
- (if (string= (substring name 0 1) "*")
- (setq name (substring name 1)))
- (if (string= (substring name -1) "*")
- (setq name (substring name 0 -1)))
- name)
+ (multishell-unbracket name))))
+ (list (multishell-bracket name) path)))
+
+(defun multishell-name-from-entry (entry)
+ "Derive a name for a shell buffer according to ENTRY."
+ (if (not entry)
+ (multishell-unbracket multishell-primary-name)
+ (let* ((splat (multishell-split-entry entry))
+ (name (car splat))
+ (path (cadr splat)))
+ (or name
+ (if (file-remote-p path)
+ (let ((vec (tramp-dissect-file-name path)))
+ (or (tramp-file-name-host vec)
+ (tramp-file-name-domain vec)
+ (tramp-file-name-localname vec)
+ system-name))
+ (multishell-unbracket multishell-primary-name))))))
(defun multishell-start-shell-in-buffer (buffer-name path)
- "Ensure a shell is started, with name NAME and PATH."
- ;; We work around shell-mode's bracketing of the buffer name, and do
- ;; some tramp-mode hygiene for remote connections.
-
- (let* ((buffer buffer-name)
- (prog (or explicit-shell-file-name
- (getenv "ESHELL")
- (getenv "SHELL")
- "/bin/sh"))
- (name (file-name-nondirectory prog))
- (startfile (concat "~/.emacs_" name))
- (xargs-name (intern-soft (concat "explicit-" name "-args")))
- is-remote)
- (set-buffer buffer-name)
- (setq is-remote (and path (file-remote-p path)))
- (when (and is-remote
- (derived-mode-p 'shell-mode)
- (not (comint-check-proc (current-buffer))))
- ;; We're returning to an already established but disconnected remote
- ;; shell, tidy it:
- (tramp-cleanup-connection
- (tramp-dissect-file-name default-directory 'noexpand)
- 'keep-debug 'keep-password))
- (when is-remote
- (message "Connecting to %s" path))
- (if (and path (not (string= path "")))
- (cd path))
- (setq buffer (set-buffer (apply 'make-comint
- (multishell-unbracket-asterisks buffer-name)
- prog
- (if (file-exists-p startfile)
- startfile)
- (if (and xargs-name
- (boundp xargs-name))
- (symbol-value xargs-name)
- '("-i")))))
- (shell-mode)))
+ "Start, restart, or continue a shell in BUFFER-NAME on PATH."
+ (let* ((buffer (get-buffer buffer-name))
+ is-active)
+
+ (set-buffer buffer)
+ (setq is-active (comint-check-proc buffer))
+
+ (when (and path (not is-active))
+
+ (when (and (derived-mode-p 'shell-mode) (file-remote-p path))
+ ;; Returning to disconnected remote shell - do some tidying:
+ (tramp-cleanup-connection
+ (tramp-dissect-file-name default-directory 'noexpand)
+ 'keep-debug 'keep-password))
+
+ (when (file-remote-p path) (message "Connecting to %s" path))
+ (cd path))
+
+ (shell buffer)))
(defun multishell-track-dirchange (name newpath)
"Change multishell history entry to track current directory."
(dolist (entry entries)
(let* ((name-path (multishell-split-entry entry))
(name (car name-path))
- (path (cadr name-path)))
+ (path (or (cadr name-path) "")))
(when path
(let* ((is-remote (file-remote-p path))
(vec (and is-remote (tramp-dissect-file-name path nil)))
(aref vec 2)
newlocalname
(aref vec 4))
- newlocalname))
+ newpath))
(newentry (concat name newpath))
(membership (member entry multishell-history)))
(when membership
(tramp-file-name-localname
(tramp-dissect-file-name default-directory))
default-directory)))
- (when (and multishell-was-default-directory
- (not (string= curdir multishell-was-default-directory)))
- (multishell-track-dirchange (multishell-unbracket-asterisks
- (buffer-name))
+ (when (not (string= curdir (or multishell-was-default-directory "")))
+ (multishell-track-dirchange (multishell-unbracket (buffer-name))
curdir))
(setq multishell-was-default-directory curdir)))
;; To avoid disruption as a pervasive hook function, swallow all errors:
"Given multishell name/path ENTRY, return the separated name and path pair.
Returns nil for empty parts, rather than the empty string."
- (string-match "^\\([^/]*\\)\\(/?.*\\)?" entry)
- (let ((name (match-string 1 entry))
- (path (match-string 2 entry)))
- (and (string= name "") (setq name nil))
- (and (string= path "") (setq path nil))
- (list name path)))
+ (save-match-data
+ (string-match "^\\([^/]*\\)\\(/?.*\\)?" entry)
+ (let ((name (match-string 1 entry))
+ (path (match-string 2 entry)))
+ (and (string= name "") (setq name nil))
+ (and (string= path "") (setq path nil))
+ (list name path))))
+(defun multishell-bracket (name)
+ "Return a copy of name, ensuring it has an asterisk at the beginning and end."
+ (if (not (string= (substring name 0 1) "*"))
+ (setq name (concat "*" name)))
+ (if (not (string= (substring name -1) "*"))
+ (setq name (concat name "*")))
+ name)
+(defun multishell-unbracket (name)
+ "Return a copy of name, removing asterisks, if any, at beginning and end."
+ (if (string= (substring name 0 1) "*")
+ (setq name (substring name 1)))
+ (if (string= (substring name -1) "*")
+ (setq name (substring name 0 -1)))
+ name)
(provide 'multishell)