51d3b1b424
This is first of three big naming convention updates that have been a
long time coming. With 2.1 on the horizon, all the breaking updates will
batched together in preparation for the long haul.
In this commit, we do away with the asterix to communicate that a
function is an advice function, and we replace it with the '-a' suffix.
e.g.
doom*shut-up -> doom-shut-up-a
doom*recenter -> doom-recenter-a
+evil*static-reindent -> +evil--static-reindent-a
The rationale behind this change is:
1. Elisp's own formatting/indenting tools would occasionally struggle
with | and * (particularly pp and cl-prettyprint). They have no
problem with / and :, fortunately.
2. External syntax highlighters (like pygmentize, discord markdown or
github markdown) struggle with it, sometimes refusing to highlight
code beyond these symbols.
3. * and | are less expressive than - and -- in communicating the
intended visibility, versatility and stability of a function.
4. It complicated the regexps we must use to search for them.
5. They were arbitrary and over-complicated to begin with, decided
on haphazardly way back when Doom was simply "my private config".
Anyhow, like how predicate functions have the -p suffix, we'll adopt the
-a suffix for advice functions, -h for hook functions and -fn for
variable functions.
Other noteable changes:
- Replaces advice-{add,remove}! macro with new def-advice!
macro. The old pair weren't as useful. The new def-advice! saves on a
lot of space.
- Removed "stage" assertions to make sure you were using the right
macros in the right place. Turned out to not be necessary, we'll
employ better checks later.
|
||
|---|---|---|
| .. | ||
| autoload | ||
| test | ||
| +hacks.el | ||
| config.el | ||
| README.org | ||
ui/popup
Table of Contents TOC
Description
This module provides a customizable popup window management system.
Not all windows are created equally. Some are less important. Some I want gone once they have served their purpose, like code output or a help buffer. Others I want to stick around, like a scratch buffer or org-capture popup.
More than that, popups ought to be the second class citizens of my editor;
spawned off to the side, discarded with the push of a button (e.g. ESC or
C-g), and easily restored if I want to see them again. Of course, this system
should clean up after itself and kill off buffers I mark as transient.
Module Flags
+allEnables fallback rules to ensure all temporary/special buffers (whose name begins with a space or asterix) are treated as popups.+defaultsEnables reasonable default popup rules for a variety of buffers.
Prerequisites
This module has no external prerequisites.
Configuration
set-popup-rule! and set-popup-rules!
This module has two functions for defining your own rules for popups:
(set-popup-rule! PREDICATE &key IGNORE ACTIONS SIDE SIZE WIDTH HEIGHT SLOT VSLOT TTL QUIT SELECT MODELINE AUTOSAVE PARAMETERS)
(set-popup-rules! &rest RULESETS)
PREDICATE is a predicate function or regexp string to match against the
buffer's name. You'll find comprehensive documentation on the other keywords in
set-popup-rule!'s docstring (SPC h f set-popup-rule!).
Popup rules end up in
display-buffer-alist, which instructsdisplay-buffercalls on how to set up windows for buffers that meet certain conditions. However, some plugins can avoid it entirely if they useset-bufferorswitch-to-buffer, which don't obeydisplay-buffer-alist.
Multiple popup rules can be defined with set-popup-rules!:
(set-popup-rules!
'(("^ \\*" :slot -1) ; fallback rule for special buffers
("^\\*" :select t)
("^\\*Completions" :slot -1 :transient 0)
("^\\*\\(?:scratch\\|Messages\\)" :transient t)
("^\\*Help" :slot -1 :size 0.2 :select t)
("^\\*doom:"
:size 0.35 :select t :modeline t :quit t :transient t)))
Omitted parameters in a set-popup-rules! will use the defaults set in
+popup-defaults.
Disabling hidden mode-line in popups
The mode-line is hidden in popups, by default. To disable this, you can either:
-
Change the default
:modelineproperty in+popup-defaults:;; put in private/$USER/config.el (map-put +popup-defaults :modeline t)A value of
twill instruct popups to use the default mode-line. Any popup rule with a:modelineproperty can still override this. -
Completely disable management of the mode-line in popups:
;; in ~/.doom.d/config.el (remove-hook '+popup-buffer-mode-hook #'+popup|set-modeline-on-enable)
Appendix
Commands
+popup/other(aliased toother-popup, bound toC-x p)+popup/toggle+popup/close+popup/close-all+popup/toggle+popup/restore+popup/raise
Library
-
Functions
+popup-window-p WINDOW+popup-buffer-p BUFFER+popup-buffer BUFFER &optional ALIST+popup-parameter PARAMETER &optional WINDOW+popup-parameter-fn PARAMETER &optional WINDOW+popup-windows
-
Macros
without-popups!save-popups!
-
Hooks
+popup|adjust-fringes+popup|set-modeline+popup|close-on-escape+popup|cleanup-rules
-
Minor modes
+popup-mode+popup-buffer-mode
Hacks
help-modehas been advised to follow file links in the buffer you were in before entering the popup, rather than in a new window.wgrepbuffers are advised to close themselves when aborting or committing changes.persp-modeis advised to restore popup windows when loading a session from file.- Interactive calls to
windmove-*commands (used byevil-window-*commands) will ignore theno-other-windowwindow parameter, allowing you to switch to popup windows as if they're ordinary windows. balance-windowshas been advised to close popups while it does its business, then restore them afterwards.neotreeadvisesbalance-windows, which causes major slow-downs when paired with ourbalance-windowadvice, so we removes neotree's advice.org-modeis an ongoing (and huge) effort. It has a scorched-earth window management system I'm not fond of. ie. it kills all windows and monopolizes the frame. On top of that, it really likes to useswitch-to-bufferfor most of its buffer management, which completely bypassesdisplay-buffer-alist. Some work has gone into reversing this.