feature/popup: move hacks to +hacks.el
This commit is contained in:
Henrik Lissner
parent
4bd74d9653
commit
d675ade45d
2 changed files with 164 additions and 118 deletions
163
modules/feature/popup/+hacks.el
Normal file
163
modules/feature/popup/+hacks.el
Normal file
|
|
@ -0,0 +1,163 @@
|
||||||
|
;;; feature/popup/+hacks.el -*- lexical-binding: t; -*-
|
||||||
|
|
||||||
|
;; What follows are all the hacks needed to get various parts of Emacs and other
|
||||||
|
;; plugins to cooperate with the popup management system. Essentially, it comes
|
||||||
|
;; down to:
|
||||||
|
;;
|
||||||
|
;; 1. Making plugins that control their own window environment less greedy (e.g.
|
||||||
|
;; org agenda, trying to reconfigure the entire frame to pop up one tiny
|
||||||
|
;; window).
|
||||||
|
;; 2. Forcing plugins to use `display-buffer' and `pop-to-buffer' instead of
|
||||||
|
;; `switch-to-buffer' (which is unaffected by `display-buffer-alist', which
|
||||||
|
;; this module heavily relies on).
|
||||||
|
;; 3. Closing popups (temporarily) before functions that are highly destructive
|
||||||
|
;; to the illusion of popup control get run (with the use of the
|
||||||
|
;; `save-popups!' macro).
|
||||||
|
;;
|
||||||
|
;; Keep in mind, all this black magic may break in future updates, and will need
|
||||||
|
;; to be watched carefully for corner cases.
|
||||||
|
;;
|
||||||
|
;; Hacks should be kept in alphabetical order, named after the feature they
|
||||||
|
;; modify, and should follow a ;; `package-name' header line.
|
||||||
|
|
||||||
|
;;
|
||||||
|
;; Core functions
|
||||||
|
;;
|
||||||
|
|
||||||
|
;; Don't try to resize popup windows
|
||||||
|
(advice-add #'balance-windows :around #'+popup*save)
|
||||||
|
|
||||||
|
|
||||||
|
;;
|
||||||
|
;; External functions
|
||||||
|
;;
|
||||||
|
|
||||||
|
;; `help-mode'
|
||||||
|
(after! help-mode
|
||||||
|
(defun doom--switch-from-popup (location)
|
||||||
|
(let (origin)
|
||||||
|
(save-popups!
|
||||||
|
(switch-to-buffer (car location) nil t)
|
||||||
|
(if (not (cdr location))
|
||||||
|
(message "Unable to find location in file")
|
||||||
|
(goto-char (cdr location))
|
||||||
|
(recenter)
|
||||||
|
(setq origin (selected-window))))
|
||||||
|
(+popup/close)
|
||||||
|
(select-window origin)))
|
||||||
|
|
||||||
|
;; Help buffers use `pop-to-window' to decide where to open followed links,
|
||||||
|
;; which can be unpredictable. It should *only* replace the original buffer we
|
||||||
|
;; opened the popup from. To fix this these three button types need to be
|
||||||
|
;; redefined to set aside the popup before following a link.
|
||||||
|
(define-button-type 'help-function-def
|
||||||
|
:supertype 'help-xref
|
||||||
|
'help-function
|
||||||
|
(lambda (fun file)
|
||||||
|
(require 'find-func)
|
||||||
|
(when (eq file 'C-source)
|
||||||
|
(setq file (help-C-file-name (indirect-function fun) 'fun)))
|
||||||
|
(doom--switch-from-popup (find-function-search-for-symbol fun nil file))))
|
||||||
|
|
||||||
|
(define-button-type 'help-variable-def
|
||||||
|
:supertype 'help-xref
|
||||||
|
'help-function
|
||||||
|
(lambda (var &optional file)
|
||||||
|
(when (eq file 'C-source)
|
||||||
|
(setq file (help-C-file-name var 'var)))
|
||||||
|
(doom--switch-from-popup (find-variable-noselect var file))))
|
||||||
|
|
||||||
|
(define-button-type 'help-face-def
|
||||||
|
:supertype 'help-xref
|
||||||
|
'help-function
|
||||||
|
(lambda (fun file)
|
||||||
|
(require 'find-func)
|
||||||
|
(doom--switch-from-popup (find-function-search-for-symbol fun 'defface file)))))
|
||||||
|
|
||||||
|
|
||||||
|
;; `neotree'
|
||||||
|
(after! neotree
|
||||||
|
(advice-remove #'balance-windows #'ad-Advice-balance-windows))
|
||||||
|
|
||||||
|
|
||||||
|
;; `org'
|
||||||
|
(after! org
|
||||||
|
(set! :popup "^ ?\\*Org \\(todo\\|Links\\)" '((slot . -1) (size . shrink-window-if-larger-than-buffer)))
|
||||||
|
(set! :popup "^\\*Org Agenda" '((slot . -1) (size . 20)))
|
||||||
|
(set! :popup "^\\*Org Src" '((size . 0.3)) '((quit) (select . t)))
|
||||||
|
|
||||||
|
;; Org has a scorched-earth window management system I'm not fond of. i.e. it
|
||||||
|
;; kills all windows and monopolizes the frame. No thanks. We can do better
|
||||||
|
;; ourselves.
|
||||||
|
(defun +popup*suppress-delete-other-windows (orig-fn &rest args)
|
||||||
|
(if +popup-mode
|
||||||
|
(cl-letf (((symbol-function 'delete-other-windows)
|
||||||
|
(symbol-function 'ignore)))
|
||||||
|
(apply orig-fn args))
|
||||||
|
(apply orig-fn args)))
|
||||||
|
(advice-add #'org-add-log-note :around #'+popup*suppress-delete-other-windows)
|
||||||
|
(advice-add #'org-capture-place-template :around #'+popup*suppress-delete-other-windows)
|
||||||
|
(advice-add #'org-export--dispatch-ui :around #'+popup*suppress-delete-other-windows)
|
||||||
|
|
||||||
|
(defun +popup*org-src-pop-to-buffer (orig-fn buffer _context)
|
||||||
|
"Hand off the src-block window to the popup system by using `display-buffer'
|
||||||
|
instead of switch-to-buffer-*."
|
||||||
|
(if +popup-mode
|
||||||
|
(if (eq org-src-window-setup 'switch-invisibly) ; for internal calls
|
||||||
|
(set-buffer buffer)
|
||||||
|
(display-buffer buffer))
|
||||||
|
(funcall orig-fn buffer context)))
|
||||||
|
(advice-add #'org-src-switch-to-buffer :around #'+popup*org-src-pop-to-buffer)
|
||||||
|
(setq org-src-window-setup 'other-window)
|
||||||
|
|
||||||
|
;; Ensure todo, agenda, and other minor popups are delegated to the popup system.
|
||||||
|
(defun +popup*org-pop-to-buffer (orig-fn buf &optional norecord)
|
||||||
|
"Use `pop-to-buffer' instead of `switch-to-buffer' to open buffer.'"
|
||||||
|
(if +popup-mode
|
||||||
|
(pop-to-buffer
|
||||||
|
(cond ((stringp buf) (get-buffer-create buf))
|
||||||
|
((bufferp buf) buf)
|
||||||
|
(t (error "Invalid buffer %s" buf))))
|
||||||
|
(funcall orig-fn buf norecord)))
|
||||||
|
(advice-add #'org-switch-to-buffer-other-window :around #'+popup*org-pop-to-buffer)
|
||||||
|
|
||||||
|
;; `org-agenda'
|
||||||
|
(setq org-agenda-window-setup 'other-window
|
||||||
|
org-agenda-restore-windows-after-quit nil)
|
||||||
|
(add-hook 'org-agenda-finalize-hook #'org-fit-window-to-buffer)
|
||||||
|
;; Don't monopolize frame!
|
||||||
|
(advice-add #'org-agenda :around #'+popup*suppress-delete-other-windows))
|
||||||
|
|
||||||
|
|
||||||
|
;; `persp-mode'
|
||||||
|
(progn
|
||||||
|
(defun +popup*persp-mode-restore-popups (&rest _)
|
||||||
|
"Restore popup windows when loading a perspective from file."
|
||||||
|
(dolist (window (window-list))
|
||||||
|
(when (+popup-parameter 'popup window)
|
||||||
|
(+popup--init window))))
|
||||||
|
(advice-add #'persp-load-state-from-file :after #'+popup*persp-mode-restore-popups))
|
||||||
|
|
||||||
|
|
||||||
|
;; `wgrep'
|
||||||
|
(progn
|
||||||
|
;; close the popup after you're done with a wgrep buffer
|
||||||
|
(advice-add #'wgrep-abort-changes :after #'+popup*close)
|
||||||
|
(advice-add #'wgrep-finish-edit :after #'+popup*close))
|
||||||
|
|
||||||
|
|
||||||
|
;; `windmove'
|
||||||
|
(progn
|
||||||
|
;; Users should be about to hop into popups easily, but Elisp shouldn't.
|
||||||
|
(defun doom*ignore-window-parameters (orig-fn &rest args)
|
||||||
|
"Allow *interactive* window moving commands to traverse popups."
|
||||||
|
(cl-letf (((symbol-function #'windmove-find-other-window)
|
||||||
|
(lambda (dir &optional arg window)
|
||||||
|
(window-in-direction
|
||||||
|
(pcase dir (`up 'above) (`down 'below) (_ dir))
|
||||||
|
window (bound-and-true-p +popup-mode) arg windmove-wrap-around t))))
|
||||||
|
(apply orig-fn args)))
|
||||||
|
(advice-add #'windmove-up :around #'doom*ignore-window-parameters)
|
||||||
|
(advice-add #'windmove-down :around #'doom*ignore-window-parameters)
|
||||||
|
(advice-add #'windmove-left :around #'doom*ignore-window-parameters)
|
||||||
|
(advice-add #'windmove-right :around #'doom*ignore-window-parameters))
|
||||||
|
|
@ -158,121 +158,4 @@ ALIST supports one custom parameter: `size', which will resolve to
|
||||||
;; Hacks
|
;; Hacks
|
||||||
;;
|
;;
|
||||||
|
|
||||||
(advice-add #'balance-windows :around #'+popup*save)
|
(load! +hacks)
|
||||||
|
|
||||||
(defun doom*ignore-window-parameters (orig-fn &rest args)
|
|
||||||
"Allow *interactive* window moving commands to traverse popups."
|
|
||||||
(cl-letf (((symbol-function #'windmove-find-other-window)
|
|
||||||
(lambda (dir &optional arg window)
|
|
||||||
(window-in-direction
|
|
||||||
(pcase dir (`up 'above) (`down 'below) (_ dir))
|
|
||||||
window (bound-and-true-p +popup-mode) arg windmove-wrap-around t))))
|
|
||||||
(apply orig-fn args)))
|
|
||||||
(advice-add #'windmove-up :around #'doom*ignore-window-parameters)
|
|
||||||
(advice-add #'windmove-down :around #'doom*ignore-window-parameters)
|
|
||||||
(advice-add #'windmove-left :around #'doom*ignore-window-parameters)
|
|
||||||
(advice-add #'windmove-right :around #'doom*ignore-window-parameters)
|
|
||||||
|
|
||||||
;; `help-mode'
|
|
||||||
(after! help-mode
|
|
||||||
(defun doom--switch-from-popup (location)
|
|
||||||
(let (origin)
|
|
||||||
(save-popups!
|
|
||||||
(switch-to-buffer (car location) nil t)
|
|
||||||
(if (not (cdr location))
|
|
||||||
(message "Unable to find location in file")
|
|
||||||
(goto-char (cdr location))
|
|
||||||
(recenter)
|
|
||||||
(setq origin (selected-window))))
|
|
||||||
(+popup/close)
|
|
||||||
(select-window origin)))
|
|
||||||
|
|
||||||
;; Help buffers use `pop-to-window' to decide where to open followed links,
|
|
||||||
;; which can be unpredictable. It should *only* replace the original buffer we
|
|
||||||
;; opened the popup from. To fix this these three button types need to be
|
|
||||||
;; redefined to set aside the popup before following a link.
|
|
||||||
(define-button-type 'help-function-def
|
|
||||||
:supertype 'help-xref
|
|
||||||
'help-function
|
|
||||||
(lambda (fun file)
|
|
||||||
(require 'find-func)
|
|
||||||
(when (eq file 'C-source)
|
|
||||||
(setq file (help-C-file-name (indirect-function fun) 'fun)))
|
|
||||||
(doom--switch-from-popup (find-function-search-for-symbol fun nil file))))
|
|
||||||
|
|
||||||
(define-button-type 'help-variable-def
|
|
||||||
:supertype 'help-xref
|
|
||||||
'help-function
|
|
||||||
(lambda (var &optional file)
|
|
||||||
(when (eq file 'C-source)
|
|
||||||
(setq file (help-C-file-name var 'var)))
|
|
||||||
(doom--switch-from-popup (find-variable-noselect var file))))
|
|
||||||
|
|
||||||
(define-button-type 'help-face-def
|
|
||||||
:supertype 'help-xref
|
|
||||||
'help-function
|
|
||||||
(lambda (fun file)
|
|
||||||
(require 'find-func)
|
|
||||||
(doom--switch-from-popup (find-function-search-for-symbol fun 'defface file)))))
|
|
||||||
|
|
||||||
;; `neotree'
|
|
||||||
(after! neotree
|
|
||||||
(advice-remove #'balance-windows #'ad-Advice-balance-windows))
|
|
||||||
|
|
||||||
;; `wgrep'
|
|
||||||
(after! wgrep
|
|
||||||
;; close the popup after you're done with a wgrep buffer
|
|
||||||
(advice-add #'wgrep-abort-changes :after #'+popup*close)
|
|
||||||
(advice-add #'wgrep-finish-edit :after #'+popup*close))
|
|
||||||
|
|
||||||
;; `org'
|
|
||||||
(after! org
|
|
||||||
(set! :popup "^ ?\\*Org \\(todo\\|Links\\)" '((slot . -1) (size . shrink-window-if-larger-than-buffer)))
|
|
||||||
(set! :popup "^\\*Org Agenda" '((slot . -1) (size . 20)))
|
|
||||||
(set! :popup "^\\*Org Src" '((size . 0.3)) '((quit) (select . t)))
|
|
||||||
|
|
||||||
;; Org has a scorched-earth window management system I'm not fond of. i.e. it
|
|
||||||
;; kills all windows and monopolizes the frame. No thanks. We can do better
|
|
||||||
;; ourselves.
|
|
||||||
(defun +popup*suppress-delete-other-windows (orig-fn &rest args)
|
|
||||||
(cl-letf (((symbol-function 'delete-other-windows)
|
|
||||||
(symbol-function 'ignore)))
|
|
||||||
(apply orig-fn args)))
|
|
||||||
(advice-add #'org-add-log-note :around #'+popup*suppress-delete-other-windows)
|
|
||||||
(advice-add #'org-capture-place-template :around #'+popup*suppress-delete-other-windows)
|
|
||||||
(advice-add #'org-export--dispatch-ui :around #'+popup*suppress-delete-other-windows)
|
|
||||||
|
|
||||||
(defun doom*org-src-pop-to-buffer (buffer _context)
|
|
||||||
"Hand off the src-block window to the popup system by using `display-buffer'
|
|
||||||
instead of switch-to-buffer-*."
|
|
||||||
(if (eq org-src-window-setup 'switch-invisibly) ; for internal calls
|
|
||||||
(set-buffer buffer)
|
|
||||||
(display-buffer buffer)))
|
|
||||||
(advice-add #'org-src-switch-to-buffer :override #'doom*org-src-pop-to-buffer)
|
|
||||||
(setq org-src-window-setup 'other-window)
|
|
||||||
|
|
||||||
;; Ensure todo, agenda, and other minor popups are delegated to the popup system.
|
|
||||||
(defun +popup*org-pop-to-buffer (buf &optional _norecord)
|
|
||||||
"Use `pop-to-buffer' instead of `switch-to-buffer' to open buffer.'"
|
|
||||||
(pop-to-buffer
|
|
||||||
(cond ((stringp buf) (get-buffer-create buf))
|
|
||||||
((bufferp buf) buf)
|
|
||||||
(t (error "Invalid buffer %s" buf)))))
|
|
||||||
(advice-add #'org-switch-to-buffer-other-window :override #'+popup*org-pop-to-buffer)
|
|
||||||
|
|
||||||
;; `org-agenda'
|
|
||||||
(setq org-agenda-window-setup 'other-window
|
|
||||||
org-agenda-restore-windows-after-quit nil)
|
|
||||||
(add-hook 'org-agenda-finalize-hook #'org-fit-window-to-buffer)
|
|
||||||
;; Don't monopolize frame!
|
|
||||||
(advice-add #'org-agenda :around #'+popup*suppress-delete-other-windows))
|
|
||||||
|
|
||||||
;; `persp-mode'
|
|
||||||
(after! persp-mode
|
|
||||||
(defun +popup*persp-mode-restore-popups (&rest _)
|
|
||||||
"Restore popup windows when loading a perspective from file."
|
|
||||||
(dolist (window (window-list))
|
|
||||||
(when (+popup-parameter 'popup window)
|
|
||||||
(+popup--init window))))
|
|
||||||
(advice-add #'persp-load-state-from-file :after #'+popup*persp-mode-restore-popups))
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue