blob: 8012c0ba81fda9cc680d27c48fb0d14077eb31ad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
## Protection
Sometimes you don't want some functions to run in indirect buffers (inner
modes). Either you want them to run in the base (host mode) buffer or not to run
at all.
Polymode provides two generic protection functions which can be used as around advice:
- `polymode-with-current-base-buffer` - run the function inside the base buffer
- `polymode-inhibit-in-indirect-buffers` - don't run the function at all when invoked in indirect buffers
## Synchronizing State Across Polymode Buffers
Each major mode has its own buffer. This is generally a good thing and leads to
a highly composable and modularized design. Mainly because each modes does not
have to deal with other modes.
But there is a price to pay - some state and actions need to be shared across
buffers and it's not always obvious what to synchronize and what not. Things
like points, text properties, minor-modes, buffer-undo-lists, overlays are
examples of the sate that needs to be synchronized.
### Variables and Minor Modes
Polymode automatically synchronizes stated defined in the following
variables. Users and mode authors should add to these variables. In case of a
generic use cases, please open an issue with a suggestion.
- `polymode-move-these-vars-from-base-buffer` - Variables transferred from base buffer on switch to inner mode buffer.
- `polymode-move-these-vars-from-old-buffer` - Variables transferred from old buffer to new buffer on buffer switch.
- `polymode-move-these-minor-modes-from-base-buffer` - Minor modes "transferred" from the base (host-mode) buffer to inner-mode buffer on buffer switch.
- `polymode-move-these-minor-modes-from-old-buffer` - Minor modes "transferred" from the old buffer to new buffer on buffer switch.
Polymode also runs the following hooks on each buffer switch. Use these hooks to
synchronize your specific state if it cannot be done with the above generic
variables.
- `polymode-before-switch-buffer-hook`
- `polymode-after-switch-buffer-hook`
### Hooks
By default Emacs runs `pre-command-hook`/`post-command-hook` and
`before-change-functions`/`after-change-functions` only in the original
buffer. On a few occasions these actions should propagate to other buffers. Most
commonly such actions manipulate and update local state in the corresponding
buffers.
In order to make this task easier, `polymode` maintains a list of function
symbols which, if present in the local hook, should be run in other buffers when
corresponding hook is triggered in the current buffer. A function is run in the
other buffer only if it is present in the other buffer's hook.
- `polymode-run-these-pre-commands-in-other-buffers` - `pre-command-hook` functions to run in other buffers
- `polymode-run-these-post-commands-in-other-buffers` - `post-command-hook` functions to run in other buffers
- `polymode-run-these-before-change-functions-in-other-buffers` - `before-change-functions` to run in other buffers
- `polymode-run-these-after-change-functions-in-other-buffers` - `after-change-functions` to run in other buffers
|
