Change Log of Cursory
Manage Emacs cursor styles using presets
This document contains the release notes for each tagged commit on the project’s main git repository: https://github.com/protesilaos/cursory.
The newest release is at the top. For further details, please consult the manual: https://protesilaos.com/emacs/cursory.
Table of Contents
1. Version 1.2.0 on 2025-07-22
This version contains small additions to a stable package.
1.1. Set the last preset when starting up Emacs
The new function cursory-set-last-or-fallback
makes it easier to set
the last known preset when starting Emacs or via a hook such as after-init-hook
.
Internally, it takes care to fall back to a set of default values that
always work.
Before the introduction of cursory-set-last-or-fallback
users had to
do something like this:
;; Old way of setting a preset:
(cursory-set-preset (or cursory-last-selected-preset cursory-recovered-preset 'box))
;; Old way of doing the above via a hook:
(add-hook 'after-init-hook (lambda () (cursory-set-preset (or cursory-last-selected-preset cursory-recovered-preset 'box))))
Those would also fail if the named preset did not exist (box
in the
above example). Whereas the addition of a fallback preset guarantees a
result that works.
Note that I am defining the cursory-fallback-preset
using defconst
instead of exposing it as a user option. This is to avoid a scenario
where the values are accidentally set incorrectly.
1.2. Presets can define a :cursor-color
This is a new attribute which corresponds to the background value of
the cursor
face.
- When the value is nil or
unspecified
(the default), Cursory does not modify thecursor
face. - When the value is a hexadecimal RGB color value, like
#123456
it is used as-is. Same if it is a named color among those produced by the commandlist-colors-display
. - When the value is the symbol of a face (unquoted), then the
foreground of that face is used for the
cursor
face, falling back todefault
.
Concretely, users can have something like this in their configuration:
(setq cursory-presets
'((box
:cursor-color "#21439f"
:blink-cursor-interval 1.2)
(baring
:cursor-type (bar . 2)
:cursor-color error ; the `error' face will typically be red (see `list-faces-display')
:blink-cursor-interval 0.8)
(underscore
:cursor-color "green" ; see `list-colors-display'
:cursor-type (hbar . 1)
:blink-cursor-interval 0.3
:blink-cursor-blinks 50)
(t ; the default values
:cursor-color unspecified ; use the theme's original
:cursor-type box
:cursor-in-non-selected-windows hollow
:blink-cursor-mode 1
:blink-cursor-blinks 10
:blink-cursor-interval 0.2
:blink-cursor-delay 0.2)))
Remember to read the documentation of cursory-presets
for all the rest.
1.3. The cursory-mode
persists the :cursor-color
while changing themes
Before, the cursory-mode
would only take care to save the last
selected preset and to persist it across Emacs sessions. In addition
to that, it now also ensures that loading a new theme does not
override the :cursor-color
.
1.4. The cursory-set-preset
prompt is smarter about its default value
When the cursory-set-preset
is called interactively, it uses the
minibuffer to prompt for a preset among the cursory-presets
.
In the past, its default value would simply be the last selected
preset. Cursory would not check whether that symbol was still a member
of the cursory-presets
. This had the potential to set the wrong
configurations.
Now the prompt only uses as its default value the last selected and existing preset among those found in the history of selections. It will not provide a default if it cannot find any.
Note that the “default value” in the context of the minibuffer refers
to the input that will normally be provided if the user types RET
without writing anything into the minibuffer.
2. Version 1.1.0 on 2024-09-14
Cursory is in a stable state. This version includes quality-of-life refinements.
2.1. The cursory-mode
simplifies how the state is stored
Cursory has functions to store and restore its state. In previous
versions, we would document how to use those by adding them to the
relevant hooks. This approach still works, though we now provide an
easier way to achieve the same result: just enable the cursory-mode
.
Technically, all this does is to set the hooks if enabled, and unsets them if disabled.
The “restore” phase is the same as before. For example:
;; Set last preset, if available, or fall back to the `bar' preset
;; from the `cursory-presets'.
(cursory-set-preset (or (cursory-restore-latest-preset) 'bar))
2.2. Use the cursory-set-preset-hook
The cursory-set-preset-hook
is a normal hook (where functions are
invoked without any arguments), which is called after the command
cursory-set-preset
. Here are some ideas on how to use it:
;; Imagine you have a preset where you want minimal cursor styles.
;; You call this `focus' and want when you switch to it to change the
;; cursor color.
(defun my-cursory-change-color ()
"Change to a subtle color when the `focus' Cursory preset is selected."
(if (eq cursory-last-selected-preset 'focus)
(set-face-background 'cursor "#999999")
(face-spec-recalc 'cursor nil)))
;; Here we just show how to disable a given mode. Of course, we can
;; have something more sophisticated, which stores the last value and
;; restores it if the condition we are testing for here is not met.
;; Keeping it simple for now.
(defun my-cursory-change-color-disable-line-numbers ()
"Disable line numbers if the Cursory preset is `presentation' or `focus'."
(when (member cursory-last-selected-preset '(presentation focus))
(display-line-numbers-mode -1)))
I am happy to include more examples here, if users have any questions.
2.3. Miscellaneous
- Fixed a dependency for older Emacs versions. The
subr-x
, which is built into Emacs, needs to be explicitly loaded at compile time. This makes some parts of the code work as expected. Thanks to Mehdi Khawari for reporting the problem and Nicholas Vollmer for suggesting this change. The exchange took place in issue 1: https://github.com/protesilaos/cursory/issues/1. Users should already have this change, as I published a minor release for it (version1.0.1
). - Added some missing metadata to the manual. This is useful for the indices and COPYING section.
- Updated the relevant links to the package sources. The main repository is now on GitHub.
3. Version 1.0.0 on 2023-06-09
Cursory has been in a stable state for a long time. I use it daily and am happy with what it does. This version refactors parts of the code in the interest of legibility/hackability, while providing a quality-of-life feature for users.
3.1. A preset can now inherit from another
In the interest of defining multiple presets while avoiding
duplication, the user option cursory-presets
now accepts an
:inherit
property. For example:
(setq cursory-presets
'(
;; Sample code here ...
(bar
:cursor-type (bar . 2)
:cursor-in-non-selected-windows hollow
:blink-cursor-mode 1
:blink-cursor-blinks 10
:blink-cursor-interval 0.5
:blink-cursor-delay 0.2)
(bar-no-other-window
:inherit bar
:cursor-in-non-selected-windows nil)
;; More sample code here ...
))
Presets were already capable of getting properties from a default t
preset. Now they can be controlled with greater precision.
The value of cursory-presets
is updated accordingly to benefit from
this mechanism and to showcase how it is done:
(defcustom cursory-presets
'((box
:blink-cursor-interval 0.8)
(box-no-blink
:blink-cursor-mode -1)
(bar
:cursor-type (bar . 2)
:blink-cursor-interval 0.5)
(bar-no-other-window
:inherit bar
:cursor-in-non-selected-windows nil)
(underscore
:cursor-type (hbar . 3)
:blink-cursor-blinks 50)
(underscore-thin-other-window
:inherit underscore
:cursor-in-non-selected-windows (hbar . 1))
(t ; the default values
:cursor-type box
:cursor-in-non-selected-windows hollow
:blink-cursor-mode 1
:blink-cursor-blinks 10
:blink-cursor-interval 0.2
:blink-cursor-delay 0.2))
;; Omitting the doc string for demo purposes...
)
In the above sample, we notice both the :inherit
property and the
default t
preset with all its properties. Presets beside t
act as
overrides of the defaults and, as such, need only consist of the
properties that change from the default. In the case of an
:inherit
, properties are first taken from the inherited preset and
then the default one.
4. Version 0.3.0 on 2022-09-04
Implemented a mechanism to read fallback values for the presets specified in the user option
cursory-presets
. In practical terms, there can now be at
preset which holds the default values. Any other named preset overrides thet
, so it only needs to specify the properties that differ from the defaults. Sample using the original value:(setq cursory-presets '((box :blink-cursor-interval 0.8) (box-no-blink :blink-cursor-mode -1) (bar :cursor-type (bar . 2) :blink-cursor-interval 0.5) (underscore :cursor-type (hbar . 3) :blink-cursor-blinks 50) (t ; the default values :cursor-type box :cursor-in-non-selected-windows hollow :blink-cursor-mode 1 :blink-cursor-blinks 10 :blink-cursor-interval 0.2 :blink-cursor-delay 0.2)))
- Expanded the available properties of the user option
cursory-presets
to accept a value for the:blink-cursor-mode
key (as seen in the above code block). It is either1
or-1
and is passed to the functionblink-cursor-mode
. The former value enables the mode, the latter disables it. This letscursory-presets
set theblink-cursor-mode
per stylistic variant. - Refined the default value of the minibuffer prompt that is used by the
command
cursory-set-preset
. The default value now is the previous element in the history, if it exists. This makes it easier to toggle between the last two choices (select the default value simply by pressingRET
without any further input). - Specified a
:package-version
for all user options. The user is informed in relevant Help buffers about the last version that introduced or iterated on the variable. - The
cursory
group now references the Info manual that ships with the GNU ELPA package. A link is shown in Custom UI buffers.
5. Version 0.2.0 on 2022-07-01
This is a stability release that introduces minor tweaks while formalising point releases which were already available to users.
- When there is only one preset defined in the user option
cursory-presets
the commandcursory-set-preset
will not prompt for completion. It will apply the sole preset outright. Simplified the sample code in the manual for restoring the last preset after starting Emacs. The code is now written as follows:
;; Set last preset or fall back to desired style from `cursory-presets'. (cursory-set-preset (or (cursory-restore-latest-preset) 'bar))
Thanks to Christopher League for the original idea over at the
fontaine
mailing list (Fontaine is another package of mine): https://lists.sr.ht/~protesilaos/fontaine/%3C87sfpop0dm.fsf@contrapunctus.net%3E#%3C87pmksoyv6.fsf@contrapunctus.net%3ESimplified the value of the
cursory-presets
user option. It now looks like this:'((bar :cursor-type (bar . 2) :cursor-in-non-selected-windows hollow :blink-cursor-blinks 10 :blink-cursor-interval 0.5 :blink-cursor-delay 0.2) (box :cursor-type box :cursor-in-non-selected-windows hollow :blink-cursor-blinks 10 :blink-cursor-interval 0.5 :blink-cursor-delay 0.2) (underscore :cursor-type (hbar . 3) :cursor-in-non-selected-windows hollow :blink-cursor-blinks 50 :blink-cursor-interval 0.2 :blink-cursor-delay 0.2))
Thanks to Philip Kaludercic for the patch.
- Fixed the
:type
of thecursory-presets
declaration. The Custom UI should now be able to read all values properly. Courtesy of Philip Kaludercic. - Named the mailing list address as the
Maintainer:
of Cursory. Together with the other package headers, it helps the user find our primary sources. This is to conform with work being done in package.el by Philip Kaludercic. I was informed about it here: https://lists.sr.ht/~protesilaos/general-issues/%3C875ykl84yi.fsf%40posteo.net%3E. - Included a reference to the “devel” version of GNU ELPA. My blog post covers the technicalities: https://protesilaos.com/codelog/2022-05-13-emacs-elpa-devel/.
Mentioned in the manual the
electric-cursor
package. The text reads thus:The
electric-cursor
package by Case Duckworth lets the user automatically change the cursor style when a certain mode is activated. For example, the box is the default and switches to a bar whenoverwrite-mode
is on: https://github.com/duckwork/electric-cursor.
6. Version 0.1.0 on 2022-04-15
Initial release of the package. Please read the manual.
The core idea for this package was implemented in the prot-cursor.el
file that is part of my dotfiles (now deprecated). I was using it at
least since the end of 2020 or beginning of 2021.