;;; ui/workspaces/config.el -*- lexical-binding: t; -*- ;; `persp-mode' gives me workspaces, a workspace-restricted `buffer-list', and ;; file-based session persistence. I used workgroups2 before this, but abandoned ;; it because it was unstable and slow; `persp-mode' is neither (and still ;; maintained). ;; ;; NOTE persp-mode requires `workgroups' for file persistence in Emacs 24.4. (defvar +workspaces-main "main" "The name of the primary and initial workspace, which cannot be deleted.") (defvar +workspaces-switch-project-function #'doom-project-find-file "The function to run after `projectile-switch-project' or `counsel-projectile-switch-project'. This function must take one argument: the new project directory.") (defvar +workspaces-on-switch-project-behavior 'non-empty "Controls the behavior of workspaces when switching to a new project. Can be one of the following: t Always create a new workspace for the project 'non-empty Only create a new workspace if the current one already has buffers associated with it. nil Never create a new workspace on project switch.") ;; FIXME actually use this for wconf bookmark system (defvar +workspaces-data-file "_workspaces" "The basename of the file to store single workspace perspectives. Will be stored in `persp-save-dir'.") (defvar +workspace--old-uniquify-style nil) ;; ;; Packages (use-package! persp-mode :commands persp-switch-to-buffer :init (add-hook 'doom-init-modules-hook (defun +workspaces-init-h () (unless noninteractive ;; Remove default buffer predicate so persp-mode can put in its own (delq! 'buffer-predicate default-frame-alist 'assq) (require 'persp-mode) (if (daemonp) (add-hook 'after-make-frame-functions #'persp-mode-start-and-remove-from-make-frame-hook) (persp-mode +1))))) :config (setq persp-autokill-buffer-on-remove 'kill-weak persp-nil-hidden t persp-auto-save-fname "autosave" persp-save-dir (concat doom-etc-dir "workspaces/") persp-set-last-persp-for-new-frames t persp-switch-to-added-buffer nil persp-remove-buffers-from-nil-persp-behaviour nil persp-auto-resume-time -1 ; Don't auto-load on startup persp-auto-save-opt (if noninteractive 0 1)) ; auto-save on kill (advice-add #'persp-asave-on-exit :around #'+workspaces-autosave-real-buffers-a) (add-hook! '(persp-mode-hook persp-after-load-state-functions) (defun +workspaces-ensure-main-workspace-h (&rest _) "Ensure the main workspace exists and the nil workspace is never active." (when persp-mode (let (persp-before-switch-functions) ;; The default perspective persp-mode creates (`persp-nil-name') is ;; special and doesn't represent a real persp object, so buffers can't ;; really be assigned to it, among other quirks. We create a *real* main ;; workspace to fill this role. (unless (persp-get-by-name +workspaces-main) (persp-add-new +workspaces-main)) ;; Switch to it if we're in the nil perspective (dolist (frame (frame-list)) (when (string= (safe-persp-name (get-current-persp frame)) persp-nil-name) (persp-frame-switch +workspaces-main frame) ;; Fix #319: the warnings buffer gets swallowed by creating ;; `+workspaces-main', so we display it manually, if it exists. (when-let (warnings (get-buffer "*Warnings*")) (save-excursion (display-buffer-in-side-window warnings '((window-height . shrink-window-if-larger-than-buffer))))))))))) (add-hook! 'persp-mode-hook (defun +workspaces-init-persp-mode-h () (cond (persp-mode ;; `uniquify' breaks persp-mode. It renames old buffers, which causes ;; errors when switching between perspective (their buffers are ;; serialized by name and persp-mode expects them to have the same ;; name when restored). (when uniquify-buffer-name-style (setq +workspace--old-uniquify-style uniquify-buffer-name-style)) (setq uniquify-buffer-name-style nil) ;; Ensure `persp-kill-buffer-query-function' is last (remove-hook 'kill-buffer-query-functions #'persp-kill-buffer-query-function) (add-hook 'kill-buffer-query-functions #'persp-kill-buffer-query-function t) ;; Restrict buffer list to workspace (advice-add #'doom-buffer-list :override #'+workspace-buffer-list)) (t (when +workspace--old-uniquify-style (setq uniquify-buffer-name-style +workspace--old-uniquify-style)) (advice-remove #'doom-buffer-list #'+workspace-buffer-list))))) ;; We don't rely on the built-in mechanism for auto-registering a buffer to ;; the current workspace; some buffers slip through the cracks. Instead, we ;; add buffers when they are switched to. (setq persp-add-buffer-on-find-file nil persp-add-buffer-on-after-change-major-mode nil) (add-hook! 'doom-switch-buffer-hook (defun +workspaces-add-current-buffer-h () "Add current buffer to focused perspective." (when persp-mode (persp-add-buffer (current-buffer) (get-current-persp))))) (add-to-list 'persp-add-buffer-on-after-change-major-mode-filter-functions #'doom-unreal-buffer-p) (defadvice! +workspaces--evil-alternate-buffer-a (&optional window) "Make `evil-alternate-buffer' ignore buffers outside the current workspace." :override #'evil-alternate-buffer (let* ((prev-buffers (if persp-mode (cl-remove-if-not #'persp-contain-buffer-p (window-prev-buffers) :key #'car) (window-prev-buffers))) (head (car prev-buffers))) (if (eq (car head) (window-buffer window)) (cadr prev-buffers) head))) ;; Delete the current workspace if closing the last open window (define-key! persp-mode-map [remap delete-window] #'+workspace/close-window-or-workspace [remap evil-delete-window] #'+workspace/close-window-or-workspace) ;; per-frame workspaces (setq persp-init-frame-behaviour t persp-init-new-frame-behaviour-override nil persp-interactive-init-frame-behaviour-override #'+workspaces-associate-frame-fn persp-emacsclient-init-frame-behaviour-override #'+workspaces-associate-frame-fn) (add-hook 'delete-frame-functions #'+workspaces-delete-associated-workspace-h) ;; per-project workspaces, but reuse current workspace if empty (setq projectile-switch-project-action #'+workspaces-set-project-action-fn counsel-projectile-switch-project-action '(1 ("o" +workspaces-switch-to-project-h "open project in new workspace") ("O" counsel-projectile-switch-project-action "jump to a project buffer or file") ("f" counsel-projectile-switch-project-action-find-file "jump to a project file") ("d" counsel-projectile-switch-project-action-find-dir "jump to a project directory") ("b" counsel-projectile-switch-project-action-switch-to-buffer "jump to a project buffer") ("m" counsel-projectile-switch-project-action-find-file-manually "find file manually from project root") ("w" counsel-projectile-switch-project-action-save-all-buffers "save all project buffers") ("k" counsel-projectile-switch-project-action-kill-buffers "kill all project buffers") ("r" counsel-projectile-switch-project-action-remove-known-project "remove project from known projects") ("c" counsel-projectile-switch-project-action-compile "run project compilation command") ("C" counsel-projectile-switch-project-action-configure "run project configure command") ("e" counsel-projectile-switch-project-action-edit-dir-locals "edit project dir-locals") ("v" counsel-projectile-switch-project-action-vc "open project in vc-dir / magit / monky") ("s" (lambda (project) (let ((projectile-switch-project-action (lambda () (call-interactively #'+ivy/project-search)))) (counsel-projectile-switch-project-by-name project))) "search project") ("xs" counsel-projectile-switch-project-action-run-shell "invoke shell from project root") ("xe" counsel-projectile-switch-project-action-run-eshell "invoke eshell from project root") ("xt" counsel-projectile-switch-project-action-run-term "invoke term from project root") ("X" counsel-projectile-switch-project-action-org-capture "org-capture into project"))) (add-hook 'projectile-after-switch-project-hook #'+workspaces-switch-to-project-h) ;; In some scenarios, persp-mode throws error when Emacs tries to die, ;; preventing its death and trapping us in Emacs. (defun +workspaces*ignore-errors-on-kill-emacs (orig-fn) (ignore-errors (funcall orig-fn))) (advice-add #'persp-kill-emacs-h :around #'+workspaces*ignore-errors-on-kill-emacs) ;; Fix #1017: stop session persistence from restoring a broken posframe (after! posframe (add-hook 'persp-after-load-state-functions (defun +workspaces-delete-all-posframes-h (&rest _) (posframe-delete-all)))) ;; ;; eshell (persp-def-buffer-save/load :mode 'eshell-mode :tag-symbol 'def-eshell-buffer :save-vars '(major-mode default-directory)) ;; compile (persp-def-buffer-save/load :mode 'compilation-mode :tag-symbol 'def-compilation-buffer :save-vars '(major-mode default-directory compilation-directory compilation-environment compilation-arguments)) ;; Restore indirect buffers (defvar +workspaces--indirect-buffers-to-restore nil) (persp-def-buffer-save/load :tag-symbol 'def-indirect-buffer :predicate #'buffer-base-buffer :save-function (lambda (buf tag vars) (list tag (buffer-name buf) vars (buffer-name (buffer-base-buffer buf)))) :load-function (lambda (savelist &rest _rest) (cl-destructuring-bind (buf-name _vars base-buf-name &rest _) (cdr savelist) (push (cons buf-name base-buf-name) +workspaces--indirect-buffers-to-restore) nil))) (add-hook 'persp-after-load-state-functions (defun +workspaces-reload-indirect-buffers-h (&rest _) (dolist (ibc +workspaces--indirect-buffers-to-restore) (cl-destructuring-bind (buffer-name . base-buffer-name) ibc (when (buffer-live-p (get-buffer base-buffer-name)) (when (get-buffer buffer-name) (setq buffer-name (generate-new-buffer-name buffer-name))) (make-indirect-buffer bb buffer-name t)))) (setq +workspaces--indirect-buffers-to-restore nil))))