diff options
author | William Carroll <wpcarro@gmail.com> | 2022-07-30T18·19-0700 |
---|---|---|
committer | clbot <clbot@tvl.fyi> | 2022-08-01T17·39+0000 |
commit | 6882b9575865c407d22386da065a370fdbc80396 (patch) | |
tree | 84326469e58e34fe7ac94ffabd79e6d389bd0a3d /users/wpcarro/emacs/.emacs.d/wpc | |
parent | 081742a07e7bf438655b390f46e0ce103a0b0e55 (diff) |
feat(wpcarro/emacs): Package vterm-mgt.el r/4363
Pretty useful (but still needs some polishing) library for working with `vterm`, which I use on a daily basis. Change-Id: Ic6693f52ad9b16b0b4dd1338aedeeccd6ff15379 Reviewed-on: https://cl.tvl.fyi/c/depot/+/6017 Reviewed-by: wpcarro <wpcarro@gmail.com> Autosubmit: wpcarro <wpcarro@gmail.com> Tested-by: BuildkiteCI
Diffstat (limited to 'users/wpcarro/emacs/.emacs.d/wpc')
-rw-r--r-- | users/wpcarro/emacs/.emacs.d/wpc/vterm-mgt.el | 142 |
1 files changed, 0 insertions, 142 deletions
diff --git a/users/wpcarro/emacs/.emacs.d/wpc/vterm-mgt.el b/users/wpcarro/emacs/.emacs.d/wpc/vterm-mgt.el deleted file mode 100644 index 29c24d89ec9c..000000000000 --- a/users/wpcarro/emacs/.emacs.d/wpc/vterm-mgt.el +++ /dev/null @@ -1,142 +0,0 @@ -;;; vterm-mgt.el --- Help me manage my vterm instances -*- lexical-binding: t -*- - -;; Author: William Carroll <wpcarro@gmail.com> -;; Version: 0.0.1 -;; Package-Requires: ((emacs "25.1")) - -;;; Commentary: -;; Supporting functions to instantiate vterm buffers, kill existing vterm -;; buffers, rename vterm buffers, cycle forwards and backwards through vterm -;; buffers. -;; -;; Many of the functions defined herein are intended to be bound to -;; `vterm-mode-map'. Some assertions are made to guard against calling -;; functions that are intended to be called from outside of a vterm buffer. -;; These assertions shouldn't error when the functions are bound to -;; `vterm-mode-map'. If for some reason, you'd like to bind these functions to -;; a separate keymap, caveat emptor. - -;;; Code: - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; Dependencies -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -(require 'dash) -(require 'cycle) -(require 'vterm) - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; Configuration -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -(defgroup vterm-mgt nil - "Customization options for `vterm-mgt'.") - -(defcustom vterm-mgt-scroll-on-focus nil - "When t, call `end-of-buffer' after focusing a vterm instance." - :type '(boolean) - :group 'vterm-mgt) - -(defconst vterm-mgt--instances (cycle-new) - "A cycle tracking all of my vterm instances.") - -(defun vterm-mgt--instance? (b) - "Return t if the buffer B is a vterm instance." - (equal 'vterm-mode (buffer-local-value 'major-mode b))) - -(defmacro vterm-mgt--assert-vterm-buffer () - "Error when the `current-buffer' is not a vterm buffer." - '(prelude-assert (vterm-mgt--instance? (current-buffer)))) - -(defun vterm-mgt-next () - "Replace the current buffer with the next item in `vterm-mgt--instances'. -This function should be called from a buffer running vterm." - (interactive) - (vterm-mgt--assert-vterm-buffer) - (vterm-mgt-reconcile-state) - (cycle-focus-item! (current-buffer) vterm-mgt--instances) - (switch-to-buffer (cycle-next! vterm-mgt--instances)) - (when vterm-mgt-scroll-on-focus (end-of-buffer))) - -(defun vterm-mgt-prev () - "Replace the current buffer with the previous item in `vterm-mgt--instances'. -This function should be called from a buffer running vterm." - (interactive) - (vterm-mgt--assert-vterm-buffer) - (vterm-mgt-reconcile-state) - (cycle-focus-item! (current-buffer) vterm-mgt--instances) - (switch-to-buffer (cycle-prev! vterm-mgt--instances)) - (when vterm-mgt-scroll-on-focus (end-of-buffer))) - -(defun vterm-mgt-instantiate () - "Create a new vterm instance. - -Prefer calling this function instead of `vterm'. This function ensures that the - newly created instance is added to `vterm-mgt--instances'. - -If however you must call `vterm', if you'd like to cycle through vterm - instances, make sure you call `vterm-mgt-reconcile-state' to allow vterm-mgt - to collect any untracked vterm instances." - (interactive) - (vterm-mgt-reconcile-state) - (let ((buffer (vterm t))) - (cycle-append! buffer vterm-mgt--instances) - (cycle-focus-item! buffer vterm-mgt--instances))) - -(defun vterm-mgt-kill () - "Kill the current buffer and remove it from `vterm-mgt--instances'. -This function should be called from a buffer running vterm." - (interactive) - (vterm-mgt--assert-vterm-buffer) - (let* ((buffer (current-buffer))) - (when (kill-buffer buffer) - (vterm-mgt-reconcile-state)))) - -(defun vterm-mgt-find-or-create () - "Call `switch-to-buffer' on a focused vterm instance if there is one. - -When `cycle-focused?' returns nil, focus the first item in the cycle. When -there are no items in the cycle, call `vterm-mgt-instantiate' to create a vterm -instance." - (interactive) - (vterm-mgt-reconcile-state) - (if (cycle-empty? vterm-mgt--instances) - (vterm-mgt-instantiate) - (if (cycle-focused? vterm-mgt--instances) - (switch-to-buffer (cycle-current vterm-mgt--instances)) - (progn - (cycle-jump! 0 vterm-mgt--instances) - (switch-to-buffer (cycle-current vterm-mgt--instances)))))) - -(defun vterm-mgt-rename-buffer (name) - "Rename the current buffer ensuring that its NAME is wrapped in *vterm*<...>. -This function should be called from a buffer running vterm." - (interactive "SRename vterm buffer: ") - (vterm-mgt--assert-vterm-buffer) - (rename-buffer (format "*vterm*<%s>" name))) - -(defun vterm-mgt-reconcile-state () - "Fill `vterm-mgt--instances' with the existing vterm buffers. - -If for whatever reason, the state of `vterm-mgt--instances' is corrupted and - misaligns with the state of vterm buffers in Emacs, use this function to - restore the state." - (interactive) - (setq vterm-mgt--instances - (->> (buffer-list) - (-filter #'vterm-mgt--instance?) - cycle-from-list))) - -(defun vterm-mgt-select () - "Select a vterm instance by name from the list in `vterm-mgt--instances'." - (interactive) - (vterm-mgt-reconcile-state) - (switch-to-buffer - (completing-read "Switch to vterm: " - (->> vterm-mgt--instances - cycle-to-list - (-map #'buffer-name))))) - -(provide 'vterm-mgt) -;;; vterm-mgt.el ends here |