pax_global_header00006660000000000000000000000064150046323730014515gustar00rootroot0000000000000052 comment=25b994a565ce8035330b0a3071ee430c0282349e transient-0.8.8/000077500000000000000000000000001500463237300135415ustar00rootroot00000000000000transient-0.8.8/.elpaignore000066400000000000000000000001711500463237300156660ustar00rootroot00000000000000*~ .elpaignore .gitignore .mailmap Makefile default.mk docs/Makefile docs/htmlxref.cnf docs/transient.texi lisp/Makefile transient-0.8.8/.github/000077500000000000000000000000001500463237300151015ustar00rootroot00000000000000transient-0.8.8/.github/ISSUE_TEMPLATES/000077500000000000000000000000001500463237300174075ustar00rootroot00000000000000transient-0.8.8/.github/ISSUE_TEMPLATES/bug_report.md000066400000000000000000000015431500463237300221040ustar00rootroot00000000000000--- title: name: đŸĒŗ Bug report about: Report a defect. Do not use this for support requests and feature suggestions. --- Please explain (1) what behavior you expected (2) what behavior you observed (3) and how we can reproduce the issue. You don't have to quote the above lines to do that. Please include a backtrace in your report. In most cases doing: M-x toggle-debug-on-error RET and then going through the steps again should result in a backtrace. Also post the output of: M-x magit-version RET Before reporting a defect please try to reproduce it using an Emacs instance in which only Magit and its dependencies have been loaded. Other packages or your configuration should not be loaded. This makes it easier to determine whether the issue lays with Magit or something else. ---- now delete this line and everything above ---- transient-0.8.8/.github/ISSUE_TEMPLATES/config.yml000066400000000000000000000021221500463237300213740ustar00rootroot00000000000000blank_issues_enabled: false contact_links: - name: "💕 Please support my work on Transient and other Emacs projects" url: https://github.com/sponsors/tarsius about: Thanks! Any support helps. These donations from users are my only income. - name: "💡 Suggest a feature ☛ please open a discussion instead of an issue" url: https://github.com/magit/transient/discussions/categories/ideas about: Start a discussion suggesting an improvement or a new feature. - name: "🆘 Ask the community for support" url: https://www.reddit.com/r/emacs about: Please also consider supporting others. - name: "🆘 Ask the maintainers for support ☛ please open a discussion" url: https://github.com/magit/transient/discussions/categories/q-a about: Please keep in mind that our bandwidth is limited. - name: "ℹī¸ Transient FAQ" url: https://magit.vc/manual/transient/FAQ.html about: Others might have had the same question before. - name: "ℹī¸ Transient Manual" url: https://magit.vc/manual/transient/#Top about: The fine manual may also be of use. transient-0.8.8/.github/workflows/000077500000000000000000000000001500463237300171365ustar00rootroot00000000000000transient-0.8.8/.github/workflows/compile.yml000066400000000000000000000002211500463237300213040ustar00rootroot00000000000000name: Compile on: [push, pull_request] jobs: compile: name: Compile uses: emacscollective/workflows/.github/workflows/compile.yml@main transient-0.8.8/.github/workflows/manual.yml000066400000000000000000000004761500463237300211450ustar00rootroot00000000000000name: Manual on: push: branches: main tags: "v[0-9]+.[0-9]+.[0-9]+" jobs: manual: name: Manual uses: emacscollective/workflows/.github/workflows/manual.yml@main secrets: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} transient-0.8.8/.github/workflows/stats.yml000066400000000000000000000005071500463237300210210ustar00rootroot00000000000000name: Statistics on: push: branches: main schedule: - cron: '3 13 * * 1' jobs: stats: name: Statistics uses: emacscollective/workflows/.github/workflows/stats.yml@main secrets: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} transient-0.8.8/.gitignore000066400000000000000000000003151500463237300155300ustar00rootroot00000000000000/config.mk /docs/*.html /docs/*.info /docs/*.pdf /docs/*.texi /docs/.revdesc /docs/dir /docs/stats/ /lisp/*-autoloads.el /lisp/*-pkg.el /lisp/*.elc /docs/transient/ # For ELPA: /*-autoloads.el /*-pkg.el transient-0.8.8/.mailmap000066400000000000000000000000431500463237300151570ustar00rootroot00000000000000Naoya Yamashita transient-0.8.8/CHANGELOG000066400000000000000000001363611500463237300147650ustar00rootroot00000000000000# -*- mode: org -*- * v0.8.8 2025-05-01 - Added option ~transient-common-command-prefix~ to allow using a key other than ~C-x~ as the prefix key used for many commands common to all transient menus. Because the use of the ~C-x~ prefix for these commands causes many global bindings to be shadowed even for menus that allow invoking non-suffix commands, I highly recommend that users customize this. 7d08039c - Added option ~transient-error-on-insert-failure~, defaulting to ~nil~. I.e., go back to the pre-v0.8.7 behavior by default but let users opt-in to errors for certain minor issues. #374 - Address a conflict with the keyboard used by the Android port. #376. * v0.8.7 2025-04-01 - Added new hook ~transient-post-exit-hook~. 55050b60 - ~transient-insert-suffix~ and ~transient-append-suffix~ now signal error if the specified location is invalid. #374 Bug fixes: - Autoloaded commands were loaded too late in ~transient-init-suffix~, resulting in the suffix prototype object not being used. 00112c11 * v0.8.6 2025-03-15 Bug fixes: - ~transient-show-summary~ errored for commands that have neither a summary nor a docstring. 0886651d - ~transient-format-description~ errored for ~transient-information~ and ~transient-information*~ suffixes. #366 - ~transient--wrap-command~ failed to load autoloaded commands. 40308623 - ~transient-suffix-object~ errored if a command is bound more than once and is invoked using the mouse or ~RET~. f69e1286 - For some releases ~transient-suffix-object~ errored if it could not identify a unique suffix, which helped establish that it is in fact legitimate to use this function as a predicate. No longer error if there are zero matches, but continue to error if their are multiple matches that cannot be disambiguated. 4a06aeb0 * v0.8.5 2025-03-01 - Added new faces ~transient-key-recurse~ and ~transient-key-stack~. 58e22554 Bug fixes: - ~transient--setup-recursion~ did not consider the ~resurse~ shorthand. 32a7e256 - The parent group was not always stored in suffix objects. #354 - Invoking a suffix of a sub-prefix (which is configured to return to the outer prefix), did exit instead of returning, if the suffix's own behavior was not explicitly specified. #352 - The color of a suffix that returns to the outer prefix, was wrong when there isn't actually an outer prefix. e88005d2 - When potentially removing other bindings for the same command while adding a new binding, false-negative avoidance was too heavily favored over false-positive avoidance. #355 - Defining the ~transient-higher-level~ face involves calling ~face-attributes~ on another face. That call requested the value for the current frame (which may not exist yet) instead of using the default. #359 - When the transient window is hidden while the minibuffer is used, then it was not restored if using Helm. #361 - Non-suffix command that aren't accessed via a symbol, were not properly wrapped to ensure post-command cleanup happens even in case of an error or if the user aborts a minibuffer use, causing the menu window to get stuck. 08201f06 * v0.8.4 2025-02-01 - Added new option ~transient-show-docstring-format~. 65cd6cec - Unless called with a prefix argument, ~transient-toggle-docstrings~ now only shows docstrings for the current menu invocation. 13f3f5e0 - The ~##~ macro from the ~llama~ package can now be used after keywords in group specifications (including suffix bindings). 7c650436 - Suffix commands can now be advised using the new ~advice~ and ~advice*~ slots available for suffixes and groups. This feature is still experimental. #340 - ~transient-scope~ can now also match against prefix classes, not just specific prefix commands. #334 - The default level of a suffix command can now be set via its prototype, using the new function ~transient-set-default-level~. f6c249c7 * v0.8.3 2025-01-03 - Added new constant ~transient-version~. 3022f6d5 * v0.8.2 2025-01-01 - Added support for displaying the transient menu in a dedicated frame. bf58c0bb - When including a group via a variable, the imported value can now be a top-level group. eebcbe30 - The transient window is now fitted to its buffer horizontally as well. fd9811ea - Added new command ~transient-copy-menu-text~. 042f37aa - Added new command ~transient-toggle-docstrings~. 52679f98 - Added new command ~transient-describe~, which can be bound as many times as needed to show help for arbitrary things. 5a18a791 Bug fixes: - The use of ~display-buffer-full-frame~ was prevented too aggressively. 5353464b - Fixed remembering and restoring the old value of the ~no-other-window~ window parameter. de984302 - When a command is bound multiple times and the instances use different transient behavior, then the behavior (and color) for the last binding was used for all bindings. fe71a7e7, a99dcda9 - Enabling ~transient-force-single-column~ resulted in an error. 28347e59 - ~transient-toggle-common~ used to exit the menu. 98c01b84 * v0.8.1 2024-12-08 Bug fixes: - Interactively setting the level of a transient prefix resulted in an error. #337. * v0.8.0 2024-12-06 - While the minibuffer is in use, the menu window is now hidden by default. The new option ~transient-show-during-minibuffer-read~ not only controls whether the menu stays visible while the minibuffer is in use, but also whether it may be resized if necessary. This new option replaces ~transient-hide-during-minibuffer-read~. #330 - When returning to a prefix whose ~refresh-suffixes~ slot is non-nil, its suffixes are now re-initialized. #327 - Added documentation for ~inapt-if*~ slots to manual. 179545a6 - ~transient-args~ now takes a prefix command or a list of prefix commands as argument. - ~transient-scope~ now takes a prefix command or a list of prefix commands and/or a prefix class or list of prefix classes as arguments. It can still be called without any argument, but that should only be done in functions that take part in setting up a menu, not in a suffix command. - Added new generic function ~transient-prefix-value~, giving finer control over how the value returned by ~transient-args~ is determined. - Added support for implementing ~transient-init-scope~ methods for prefix classes. - ~transient-setup-buffer-hook~ is now run later to allow overriding more default settings. - The new prefix slots ~display-action~ and ~mode-line-format~, can be used to override ~transient-display-buffer-action~ and ~transient-mode-line-format~ for individual prefix menus. #332 - Updated the manual considerably. Bug fixes: - Fixes some menu navigation edge-cases. * v0.7.9 2024-11-04 Bug fixes: - Fixed a recent regression in ~transient-suffix-object~. #325 - The height of the transient window was fixed even it used the full frame height. 5478d4e6 * v0.7.8 2024-11-02 - Additional potential mistakes in menu definitions are now detected. bbda5bb6, 8873c300 - Added new (and still experimental) ~environment~ prefix slot, which can be used to, for example, implement a cache to be used while refreshing the menu. 05c011b8 - When navigating through the menu using the keyboard or hovering a suffix command with the mouse, information about the command is now shown in the echo area or using a tooltip. #282 Bug fixes: - When the command that exits a transient uses the minibuffer, ~transient-current-*~ variables were not immediately reset to ~nil~. #323 - Key sequences with three or more events broke ~transient-suffix-object~. #324 * v0.7.7 2024-10-04 Bug fix: - Fix a regression introduced by the previous commit, which broke dynamic prefixes that use a ~:setup-children~ function to prepare their suffixes. #313 * v0.7.6 2024-10-01 - ~transient-active-prefix~ now accepts a single prefix symbol, in place of a list of such symbols. #307 - ~other-frame-prefix~ and ~other-window-prefix~ can now be used while a transient prefix is active. #305 - Added new macro ~transient-with-help-window~ for use in ~:show-help~ functions. #309 * v0.7.5 2024-09-01 - Updated tooling. Bug fixes: - ~static-if~ is now used correctly. 0e35673e - When an existing window ends up being used to display the transient buffer, then the previous value of the ~no-other-window~ parameter is now restored, when the transient is exited. #302 - The names assigned to suffixes, which are defined using lambdas in the prefix definition, are now guaranteed to be unique. #304 * v0.7.4 2024-08-05 - Added new function ~transient-active-prefix~. * v0.7.3 2024-07-13 - Refactored code responsible for inserting columns. Bug fix: - The ~transient-current-*~ variables are intended to only be used by suffix commands, when they are invoked from a prefix. Previously they were only cleared when the prefix is ultimately exited, which meant that they unintentionally were accessible in timers. Now the values of these variables are nil when used outside their intended scope. 0e0ece32, f2cb28a5 * v0.7.2 2024-06-24 - Added support for adding suffixes that activate value presets. #183 Bug fix: - Restored the ability to individually set infix arguments if the prefix's ~refresh-suffixes~ slot is non-nil. 8db5f0fd * v0.7.1 2024-06-19 - Added a workaround for ~emoji.el~ from Emacs 29.1 calling an internal function using an outdated number of arguments. #288 * v0.7.0 2024-06-18 - Added new macro ~transient-augment-suffix~, which can be used to specify the suffix behavior of a command that was previously defined as a prefix, using ~transient-define-prefix~. 2fd3ea14 - Added new function ~transient-scope~, which is just a convenient way to get the value of the ~scope~ slot of the ~transient-prefix-object~. 7f6c39c5 - Added new hook ~transient-setup-buffer-hook~, which is run early when setting the transient menu buffer. #283 - Added new class ~transient-information*~, a variant of recently added ~transient-information~ class. 8a80e952 - By default our macros that define commands, mark those as for interactive use only. ~(declare (interactive-only nil))~ can now be used to overwrite that. fcc60e27 - Groups now also accept ~:inapt*~ predicates. 3d395d64 - Spaces between columns is reduced from three to two. dd93001e - Removed unused ~transient-plist-to-alist~ function. 1251faf0 Bug fixes: - ~transient--force-fixed-pitch~ was run to late to always succeed. #283 - Key binding conflict detection was too strict, taking hypothetical bindings for inapt commands into account. c356d1bc - Key binding conflict detection did not consider bindings in regular keymaps, such as ~transient-base-map~. 2698d62d - ~func-arity~ gets confused when a function is advised, so we had to add a wrapper function ~transient--func-arity~. 91dd7bb3 - Some mistakes, that can be expected to occur when defining suffix and prefix commands, were not detected. 7e827c31 * v0.6.0 2024-03-21 - On Emacs 28.1 and later, all infix commands and suffix commands that are defined inline (i.e., using a lambda when defining a prefix command), are now hidden from ~execute-extended-command~ (aka ~M-x~) /by default/. It was already possible to hide these commands, but users had to opt-in explicitly. After refactoring how these commands are declared to be unsuitable for ~M-x~, it is now possible to hide them /without/ also hiding other, unrelated kinds of unsuitable commands. I recommend that you instruct ~M-x~ to hide /all/ unsuitable command. This requires that you customizing ~read-extended-command-predicate~, because the Emacs authors have decided that this should be an opt-in feature. Note that this has no effect on Emacs releases before 28.1. - Added documentation stating that ~:class~ has to be specified when using ~:setup-children~. beecdc85 - Added a new prefix slot ~column-widths~, which can be used to specify the minimal width of each column in all ~transient-columns~ groups of that prefix. 92e8952e - When assigning a name to a suffix that is defined inline, we no longer use the suffix description, iff that would result in an overly long name. 81a108ba - Functions used as the value of face slots can now take one argument, the suffix object. Functions that take zero arguments are still supported. Additionally, ~transient--pending-suffix~ is bound around calls to these functions, but it is better to pass the object as an argument. f582a9bc - The new ~definition~ suffix slot can be used to specify a default function definition that is used if no function body is provided using ~transient-define-suffix~. 5b334a51 - Taught ~transient-suffix-object~ about ~transient--pending-suffix~. 20a3770d Bug fixes: - If ~transient-parse-suffix~ and ~transient-parse-suffixes~ are called with an invalid value for their ~prefix~ argument, they failed to detect that. 03e752d9 - If ~nil~ is encountered inside a group specification, that was silently ignored. Now an error is signaled. 8c01a1eb - ~find-function~ wasn't able to locate the definitions of infix commands anymore. a30df67b - There was no binding for ~ignore-preserving-kill-region~ in ~transient-predicate-map~. 0fc87002 - Invoking a non-symbolic non-suffix command, caused an error. bd2a5ea0 - When a group begins with an included subgroup, that affected what group class was assumed, in the absence of an explicit specification. df36bc87 - ~transient--suspend-override~ failed to move out of the minibuffer before refreshing the transient buffer. 833143ba - When a suffix command signaled an error during a trivial phase (which does not involve, e.g., the minibuffer), then the transient window was not deleted when the debugger was entered. 9d8f361f - When a prefix was refreshed, the wrong color was used for suffix commands that exit the prefix, indicating that would cause a return to the outer prefix, even though there is none. f51c144a - Calling ~transient-infix-read~ with an invalid value, resulted in a confusing error. Now an appropriate error is used. 3ebb6acf - When third-party code or user customization managed to display another buffer in our dedicated window, then that buffer got killed when we tried to kill the transient buffer. #271 * v0.5.3 2023-12-16 - Fixed regression when setting ~:pad-keys~ for a ~transient-columns~ group. #269 * v0.5.2 2023-12-05 - Fixed formatting issues in the manual. * v0.5.1 2023-12-05 - Added a new introduction by JD Smith (@jdtsmith). Bug fixes: - Faces that use a box are now defined more defensively to protect against unexpected values and provide reasonable fallback colors. 413310cd, b8aefce3 - Only prepare to return to the parent transient if there actually is a parent. The only negative effect of failing to do this was that the suffix was colored wrong, since ~transient--do-return~ falls back to behave like ~transient--do-exit~. 5f2cfc9f * v0.5.0 2023-11-28 - Some suffix commands exit the transient from which they were invoked, while others don't (allowing the user to invoke another suffix without first having to enter the transient again). Until now it wasn't possible to tell which category any given suffix falls into, at least not by default. Now the key binding of each suffix is colorized to indicate its transient behavior. Red means that the suffix exits the transient, and blue means that it does not. Keys for suffixes that currently cannot be invoked are gray. Likewise, the thin line, that is drawn between the transient popup buffer and the minibuffer, is used to indicate what happens, if you invoke a command that is not a suffix. Most prefixes do not allow non-suffixes to be invoked, so this line usually is gray. c8a9ac51 - Many faces have also been improved. This involves changing which built-in faces they inherit from, some explicit changes to their appearance, and semantic clarifications. Of course your mileage may vary — it's possible that some face just happened to look right with your chosen theme, but now it has to be themed to achieve that again. 47d3f01d 71d16d86 et al. - Added a new face, ~transient-delimiter~, which is used for parentheses around values and the pipe character used to separate possible values from each other. 567b5d54 - Added a new command ~transient-toggle-level-limit~, bound to ~C-x a~, which temporarily shows all suffix commands a transient has to offer. This makes it possible to occasionally use more obscure commands and arguments, without having to always display them. For more information see [[https://magit.vc/manual/transient/Enabling-and-Disabling-Suffixes.html][Enabling and Disabling Suffixes]]. #243 The changes described below, only directly affect package authors and users who implement their own transients. If that does not describe you, then all you have to know is that many features were fine-tuned and otherwise improved, opening up some new use-cases and making some things easier to implement. This will hopefully lead to improvements in your favorite transient-using packages in the coming months. - It sometimes makes sense to bind multiple keys to the same suffix command, e.g., because they behave differently based on the suffix description, or some other slot that can be set per binding. Previously these bindings shared a visibility level; how this can be set individually. #153 - While functions are run, which format strings to be inserted into the transient buffer or to determine whether other aspects of a suffix, that transient buffer no longer is the current buffer. Instead the buffer in which the prefix and its suffixes operate, is the current buffer. This affects functions such as ~transient-format-description~ and those found in predicate slots such as ~if~. In contexts where the transient buffer is needed but the other buffer happens to be current, the new macro ~transient-with-shadowed-buffer~ can be used to temporarily change that. - The new suffix slots ~face~ and ~inapt-face~ can be used to specify how a suffix looks, which in simple cases is more convenient than using a function as ~description~ and adding the face there. The values of these slots should be faces or functions that returns a face. The default for ~inapt-face~ is ~transient-inapt-suffix~, but in some cases it is undesirable to apply this face to the whole description, so this can be overridden by setting this slot to ~nil~ for individual suffixes. The default for ~face~ is ~nil~. c2a75880 8e15a29b 71399d21 - Added new variables ~transient--pending-suffix~ and ~transient--pending-group~, which are bound while a suffix/group is being inserted. These are mostly intended for internal purposes, but in some rare complex cases package authors might need them too. 0717589a 70e8dc80 - Sometimes it is useful to display some information in the transient buffer, which is not associated with a suffix command. The new class ~transient-information~ can be used for that purpose. Children that use this class are very similar to regular suffixes, the lack of a command binding being nearly the only difference. #226 - Instead of a list of choices, the value of a suffix's ~choices~ slot can now be a function that returns such a list. #212 - Per-suffix functions that format its description (specified using the ~description~ slot) can now optionally take one instead of zero argument, the respective suffix object. 09be367b - Added a new command ~transient-echo-arguments~ intended for use in examples and bug reports, when a prefix must bind some command, but it does not really matter which. Using this command is less verbose than having to implement a dummy every time, and it comes with some goodies. I.e., it reports information about the prefix from which it was invoked. faa3d09d - When a command was defined using ~transient-define-suffix~ and an alias for that command was created using ~defalias~, then the alias had no access to the associated suffix object. Now it does, which makes it possible to bind the same command multiple times in a prefix, and make it behave differently depending on the symbol-name that was used to invoke it. f43aee1a - The values of a prefix's ~transient-suffix~ and ~transient-non-suffix~ slots should now be a boolean. The value of the ~transient-suffix~ slot has to be handled differently for different types of suffixes. I.e., infix arguments must ignore it, and sub-prefixes must honor it but to do so they must use a different pre-command. Previously booleans were not supported and the previously recommended values, ~transient--do-stay~ and ~transient--do-exit~ are still supported (but they are "corrected" for sub-prefixes). For the ~transient~ slot the use of booleans was always allowed and recommended. 8098d175 - For sub-prefixes a value of ~t~ for the ~transient-suffix~ slot of the parent prefix now means that suffixes, which exit the sub-prefix, return to the parent prefix, instead of exiting that as well. 784887b7 5ad5b627 - In addition to booleans and pre-commands, the values of the ~transient-suffix~, ~transient-non-suffix~ and ~transient~ slots may now also be pre-command "shorthands", e.g., use ~leave~ instead of ~transient--do-leave~ (which in some cases is a good value for `transient-non-suffix`). 9617b6c7 - ~transient--do-replace~ now behaves as documented and implied by its name. Use the new ~transient--do-stack~ if you want to return to the outer prefix. 94661e0c - Added a new prefix slot ~transient-switch-frame~, which allows specifying the transient behavior of ~switch-frame~ per prefix and independently of the transient behavior of other non-suffixes (specified using the ~transient-non-suffix~ slot). 609dabfd - Added a new function ~transient-prefix-object~ to allow package authors to avoid the following unfortunate complication. While a transient is being setup or refreshed (which involves preparing its suffixes) the variable ~transient--prefix~ can be used to access the prefix object. Thus this is what has to be used in suffix methods such as ~transient-format-description~, and in object-specific functions that are stored in suffix slots such as ~description~. When a suffix command is invoked (i.e., in its ~interactive~ form and function body) then the variable ~transient-current-prefix~ has to be used instead. Two distinct variables are needed, because any prefix may itself be used as a suffix of another prefix, and such sub-prefixes have to be able to tell themselves apart from the prefix they were invoked from. Regular suffix commands, which are not prefixes, do not have to concern themselves with this distinction, so they can use this function instead. In the context of a plain suffix, it always returns the value of the appropriate variable. 37307c1b Bug fixes: - cc0fa805 transient--post-command: Redisplay after universal argument - dd970cd4 Compile suffix commands that are defined inside prefix definitions - b150b48b transient-quit-one: Cancel prefix-arg instead of exiting transient - 7c08beb8 Revert "transient-{set,save,reset}: Stay transient" - f8209cc8 transient--maybe-pad-keys: Ignore raw strings - 0a0ba1aa transient--do-leave: Actually behave as documented - ed5bd6fd transient-infix-set(argument): Fix disabling incompatible options - 3a2b936a Fix highlighting infix for which user input is being read - d834f764 transient-format(around:suffix): Don't attempt to highlight full line - af6eb310 transient-format: Only highlight infix if minibuffer is used - b1d1c369 Prevent temporary faces from leaking back into objects - 307695d2 transient-format-description(around:suffix): Combine faces - 7f0215c4 transient-format-value(option,value): Use argument faces Also contains various documentation updates and a lot of code clean-ups. This release drops support for Emacs 25. The last Emacs 25 release (25.3) was released in 2017; over six years ago. The current Emacs version is 29.1; that's four major releases since 25.1. * v0.4.3 2023-08-25 - Added a second implementation of ~transient--wrap-command~, taking advantage of improvements in Emacs 30. * v0.4.2 2023-08-25 - Infix commands are only useful when invoked from a transient prefix command and ~execute-extended-command~ should not offer them as completion candidates. In the past we used a weird kludge to accomplish that, but now we rely on ~read-extended-command-predicate~. That allowed the removal of some complications and made it possible to fix a bug in ~transient--wrap-command~. To hide infix commands, users now have to update to Emacs 28, or later, and customize ~read-extended-command-predicate~. #+begin_src emacs-lisp (setq read-extended-command-predicate 'command-completion-default-include-p) #+end_src - Due to changes in Emacs 29.1, pretty-printing isn't consistent across Emacs releases anymore by default, which is unfortunate in our case because we use it to write to files that are likely to be checked into version control. We now force the use of the old style across releases. * v0.4.1 2023-06-02 Bug fixes: - 070d47b0 Support searches that end right after suffix - ab831828 transient--insert-group(columns): Drop separator before first column - 62edeffd #247 Fix bug using :incompatible using suffixes before infixes - 6efa9fad transient-predicate-map: Bind univeral-argument-more * v0.4.0 2023-05-10 - Transient has to update state after every suffix command. If that fails for some reason, then Emacs ends up in an badly broken state. It was rare, but in the worst case scenario, that meant that Emacs refused to call any more commands and had to be killed. Naturally ~post-command-hook~ is the first choice to run something after commands, but unfortunately that hook is not guaranteed to run only once, and worse it is not guaranteed run /after/ the command. Working around this limitation made an essential part of Transient much more complex and fragile. As new edge-cases were discovered, new and increasingly desperate heuristics had to be added, until I finally decided that relying solely on hooks was just not feasible. Now ~pre-command-hook~ is used to advice ~this-command~, to add an around advice, which ensures that the state update takes place, even when ~post-command-hook~ is run prematurely. The advice wraps both the function body and the interactive spec with ~unwind-protect~, so we can finally be sure that the state change is always performed, and that the advice is removed again. It has been an interesting journey, and I have documented it in long commit messages. If you are interested in the details, see 7b8a7d71 (which still tries to avoid using any advice), 51c68c87, 52cac9c0, bug#61179 and bug#61176. - The ~transient-define-prefix~ now expands to code instead of data, meaning that lambda expressions are finally properly evaluated and byte-compiled. ea851f3b e88f51d6 277e5f2d a1774182 - Popup navigation is no longer considered a second-class feature and is enabled by default. Some transients allow arbitrary non-suffixes to be invoked, so some key bindings, which were previously used for popup navigation, had to be removed, to avoid conflicts. 98d50202 ff - Each prefix and suffix can now have its own help function. This is configured using the new ~show-help~ slot. ea5ac99f - The ~transient-options~ class now supports two types of options that can have multiple values: repeated option-value pairs and a final option that takes all remaining arguments as value. #154 - Added support for the use of non-proportional text in the transient popup. 7f5520b3 - Imenu was taught about Transient's definition macros. #178 - It is now possible to return to the parent prefix from a sub-prefix. e90f7a16 - Boolean values of the ~transient~ slot of sub-prefixes are now interpreted correctly. 4a36b1d9 - Added new option ~transient-hide-during-minibuffer-read~. 5762bd9a - Added new option ~transient-align-variable-pitch~. cda6a120 - Added new command ~transient-reset~, which clears the set and saved value of the active transient. 51585b8d - When using Emacs 28, ~execute-extended-command~ can be told to ignore transient infix commands. Even when using that Emacs version, that command does not ignore any commands by default, but this behavior can be easily be enabled using: (setq read-extended-command-predicate 'command-completion-default-include-p) Infix arguments are implemented as commands, so they by default show up as completion candidates of ~execute-extended-command~, which is useless because they are only intended to be invoked from transient prefix commands. Enable this feature to prevent that. - Added new command ~transient-toggle-debug~. b466cd9a - Depend on the Compat package, allowing me to use convenient features that were added to Emacs over the last few years, without having to wait another few years until everybody has updated to a reasonably recent Emacs release. 5ae3c401 - Added basic support for suffixes that span multiple lines (multi-row cells). #193 - Infix arguments can now be invoked following a prefix argument. To use a negative prefix argument use "C--". "-" cannot be used anymore because it conflicts with the most common prefix key used for infix arguments. ed2febd0 - Removed obsolete aliases for functions deprecated in v0.3.0. #192 - Duplicated suffix commands are now disambiguated, making it possible to bind a command multiple times as a suffix of a transient command, but still have it do different things depending on what binding is used, based on the value of some slot of the corresponding suffix object, similar to how ~self-insert-command~ inserts the pressed key. f27c840a - ~recursive-edit~ and ~top-level~ can now be used while a transient is active. fcdeadc1 5a1b2bac - Switched to Emacs 29's new keymap functions, which are also supported in newer releases, thanks to the Compat package. 87f70af5 5a966aa8 Bug fixes: - 938b0591 #173 transient--show: Set point after displaying window again - 202271f7 Resurrect transient-files class - c26cbac5 #181 transient-{init,set}-value: Use case-sensitive matching - 28491e1f Properly deal with stealth undefined command - 143a1393 transient-infix-read: Always enable-recursive-minibuffers - 76b77e01 magit--{pre,post}-command: Add emergency exits - 09b436fa transient--debug: Ignore error in transient--suffix-symbol - f2e0dfcc transient--get-predicate-for: Ignore error in transient--suffix-symbol - bf29731a transient--post-command: Don't pop and push equal redisplay maps - 3c78b10f transient--redisplay: Don't redisplay during mouse-drag-region - 714e3482 No longer always suspend when handle-switch-frame is called - ecb815bc transient--abort-commands: Add keyboard-escape-quit - 8b1f8dcc transient--minibuffer-depth: Must always be a number - 686b7ebc Fix handling of sub-prefix command that use the minibuffer - a19faa1c Return to outer prefix when minibuffer is aborted for sub-prefix - 4477555b transient--post-exit: Deal with unbound transient slot properly - 0f39af0e #188 transient-format-description: Use cl-call-next-method - 1fd1cf51 When highlighting suffixes not normally displayed consider group level - 7c771c94 Do not let-bind overriding-terminal-local-map to nil - 31d355b5 transient-set-level: Refresh shown levels after setting one - bb056e71 Invoke suffix commands directly when a button is pushed - 270eff1c Fix redisplay when popup navigation is enabled - 81b2b912 Use this-original-command again - d4fb853d #198 transient--show: Also hide the header-line - 7467a79c transient--suspend-override: Cancel display timer - 5686a792 transient--suspend-override: Cancel prefix key display - 1c84d7ad Remap kp-subtract, kp-equal and kp-add - 5302db18 Once popup is showing keep doing so until full exit - cc887ebe transient--delay-post-command: Fix execute-extended-command handling - 3b267425 transient--fit-window-to-buffer: Use correct package prefix - 9d4fabc3 #208 transient--describe-function: Handle renamed help buffer - 555792f7 #209 Fix setting level of anonymous infixes - 0a3b22f1 #215 transient--delay-post-command: Account for events returned as vector - ad953cc3 #204 transient--insert-group: Add fallback for failed alignment calculation - 5337e5eb #230 transient-define-{*}: Error if ARGLIST is missing - d800ce01 Use equal to compare with empty vector - 3657117b #234 transient--parse-suffix: Detect when mandatory command is missing - f88cbbc5 #234 transient--parse-suffix: Differentiate command and desc lambda - 0204a243 #234 transient--parse-suffix: Define suffix aliases at load-time - 0ae0de43 #241 transient--invalid: Add special-case for anonymous inapt commands - af7fe42b #244 transient--parse-suffix: Don't try to evaluate closures again - 6ff5c51f transient-isearch-abort: Fix partial match case Also contains various documentation updates, code clean-ups and build improvements. * v0.3.7 2021-10-25 - Added an additional safety hatch to prevent Emacs from entering an inconsistent state when an unexpected error occurs. 99e48369 - Added support for implementing section movement commands in third-party packages. This was requested by the maintainer of Emacspeak. Because they would be of very limited use to sighted users no such commands are added to Transient itself. 769219b5 - ~transient-read-number-{N0,N+,N}~ now support infix arguments that have three different states: disabled, enabled without an empty value, and enabled with a non-empty value. 626d105e - If a command is called as a suffix of itself, then the help command shows the function definition instead of the man-page as it usually does for prefixes. e17e2b2f - Give users more control over how the transient buffer is displayed. Various aspects that were previously hardcoded can now be changed using the ~transient-display-buffer-action~ option. 7c677737 - Added support for adding suffixes that might be neither defined nor autoloaded when the prefix is invoked. This usually results in an error and while it is now possible to override that using an extra step, it is still discouraged. 6842305e Bug fixes: - 1e740608 transient-map: Bind C-u to universal-argument - e9048100 Explicitly call transient--pre-command in button action - be119ee4 Export variables for transient non-infix suffixes - b526b9c7 transient-infix-set: Consider all incompatibility rules - 7126d6aa Fix hydra-inspired colors - 0c2255a2 transient-get-value: Add an emergency exit Also contains various documentation updates and code clean-ups. * v0.3.6 2021-07-01 - Added new option ~transient-force-single-column~, which may be useful for low vision. #122 - Added new option ~transient-highlight-higher-levels~, which is intended for package authors. 90a05622 * v0.3.5 2021-06-16 - Added a kludge to work around some unexpected Emacs behavior. ef921d30 - When showing help for a suffix that is also a subprefix, then also consider the manpage that is set for the prefix, if any. a9bdd013 * v0.3.4 2021-05-25 - Very minor changes. * v0.3.3 2021-05-24 - Added SPDX-License-Identifier library header. 7d3d8d79 * v0.3.2 2021-04-20 - Fixed an error message. c145229a * v0.3.1 2021-04-19 - Changed ~transient-prefix~'s ~suffix-description~ slot to be initially unbound, as was always intended. c28b8a4 - Added new functions ~transient-read-file~ and ~transient-read-existing-file~. a3b44224 * v0.3.0 2021-02-21 - Added a temporary kludge to prevent a transient from being invoked while the minibuffer is active. A future release will enable this again, once we are sure that cannot cause Emacs to enter an inconsistent state, that causes most events to be ignored. #112 - Improved the backtrace that is shown when a fatal error occurred in a critical context. This involved some back and forth. See commits mentioning the "emergency exit". - Added support for defining a per-prefix fallback suffix description function, which is used for suffixes that do not explicitly provide a description. The new ~suffix-description~ slot is used to specify that function. The new ~transient-command-summary-or-name~ function is useful, not just as an example. 8b22b52b - Added ~transient-arg-value~, which can be used to extract the values of individual arguments in the output of ~transient-args~. d76f73f8 - Added support for using variables in group and suffix definitions of a prefix. Such indirect specifications are resolved when the transient prefix is being defined. #101 - No longer bind ~M-~ to any common suffix commands; freeing this namespace for a variety of uses in individual transient. A few existing bindings had to be changed because of this. 990eb0a2 - Added ~transient-suffixes~ function, which is useful when ~transient-args~ is not sufficient because one needs the suffix objects, not just their values. #98 - Added ~init-value~ slot for infix and prefix objects. If this value bound then it is called with the object as only argument instead of the primary ~transient-init-value~ method of the object class. #96, 3284f6a0 - Added ~unsavable~ slot for infix objects. If this is non-nil, then the value of the infix is removed from the prefix value before saving, setting and adding to history. #96 - Added support for right padding the keys of all suffixes in a group. This is controlled using the new ~pad-keys~ slot of group objects. 7502390b, 293a437d - Added support for delaying setup of the suffixes of a prefix until that is invoked. Also added support for using unnamed functions as suffix commands. Taken together these changes make it possible to dynamically create the list of suffixed. See the ~notmuch-transient~ package for two examples: ~notmuch-search-transient~ and ~notmuch-tag-transient~. f2252d53, a3e53633 - Added the infix class ~transient-lisp-variable~. 2d8ceff4 - Added ~transient-infix-read~, which allows arbitrary commands to read a value the same way as would the infix command that is provided as an argument to this function. 73694be4 - Added support for coloring suffixes in a Hydra-like fashion. To enable this, customize option ~transient-semantic-coloring~. 248862c5 - Added support for disabling and dimming suffix commands that are currently not suitable, instead of completely hiding them. #80 - Autoload functions that serve a purpose similar to that of ~define-key~. #85 - Consistently use ~transient-~ as the prefix of all symbols. The old names remain available as obsolete aliases. dd0c44cb - Added support for scrolling the transient popup buffer using the scroll bar. #84 - Various bug fixes. 48238bf5 Allow invoking arbitrary prefixes as non-suffixes d85eb790 transient-read-directory: Pass read value through file-local-name f086cb62 transient--insert-suffix: Allow same key with different predicates d555d260 transient-format-description(lisp-variable): Return string 0d79ccfa transient--parse-suffix: Don't fallback to read-string for options f88dbc43 transient-suffix-object: Support all suffixes b343e2a3 transient-infix-read: Fix ivy specific kludge 55bad195 transient--pp-to-file: Bugfix c1df3b21 Ensure we use symbols in a few more places 769fa438 transient-set-level: Fix edge-case 88d935c7 transient-display-buffer-action: inhibit-same-window by default * v0.2.0 2020-02-26 - ~transient-args~ must now be called with a transient prefix command as argument. It is now the only argument and its value must be a symbol now, an object is no longer supported. When this command does not match ~current-transient-command~, then this function now returns the set, saved or default value. 0312b93, 7d0db28, d33fe5a, a6ce195 - No longer use the last history element as initial minibuffer input by default. Added new option ~transient-read-with-initial-input~ to allow users to restore the old default. dcf7a4d, 5decc6e - The set and saved values were not always used. #68 - Added support for inserting and removing groups. #36 - Added support for specifying where to insert elements and groups using coordinates. #26 - Added support for moving the cursor inside the transient popup buffer using the arrow keys or Isearch, and for invoke suffix commands using RET or mouse clicks. Unlike Magit-Popup, Transient doesn't make the transient popup buffer the current buffer. This is important when invoking suffix commands that take the current position into account, but it has the drawback that we do not get these features for free. Because I also consider them unnecessary I did not implement them initially. Turns out quite a few users strongly disagree. Set ~transient-enable-popup-navigation~ to ~t~ to enable these features. #42 - Explicitly support Edebug. Previously when Edebug was triggered while a transient was active, then Emacs entered an unrecoverable state. #19 - No longer attempt to display a thin line in termcap frames. 0a96a57 - Work around some Ivy bugs/incompatibilities. af243d5, fed7ab1 - The new option ~transient-force-fixed-pitch~ allows users to use a monospaced font in transient's popup buffer even if they use a proportional font for the rest of Emacs. #25, #67 - Adapted to backward incompatible changes in Emacs 27 that prevented faces from extending to the edge of the window as expected. c1ae1ee - No longer depend on dash (or any other third-party package). #66 - When a transient has conflicting key bindings and Transient is configure to warn about that, then Emacs entered an unrecoverable state instead. 75de1f0 - ~transient-format-value~ now supports options with multiple values. #65 - Removing a suffix based on its position was broken. 41cbf49 - In our popup buffers disable the tab feature that Emacs 27 introduces. #62 - Inserting a new suffix next to another ended up replacing the latter instead if its key binding was defined in the suffix object. #58 - ~transient-undefined~ learned to make some noise. #57 - Fix replacing a suffix with another suffix bound to the same key. 5a360bb, 4ce1868 - Characters are no longer allowed as pseudo suffixes. To insert a an empty cell into a table use the empty string instead. 71687ba - Added new variable ~transient--buffer-name~. #45 - Some misconfiguration that affects how the transient popup buffer is displayed could lead to Emacs entering an unrecoverable state. #34, #44 - The echo area is now cleared when the transient popup buffer is shown. afdf1f0 - If ~transient-show-popup~ is 0 or a negative number, then not even a one-line summary is shown initially. #41 - Added new function ~transient-read-directory~. a87cb2c - ~define-transient-command~ now supports specifying the level of a suffix using the ~:level~ keyword argument. 6506cfd - The mode-related suffix predicates now also support a list of modes as argument in addition to a single mode as before. 1c6afb8 - The new ~incompatible~ slot of prefix objects makes it possible to specify which arguments should be autoatically disabled when the user enables certain other arguments. 544b3bb - ~transient--history-push~ is now defined as generic function. 47b7975 - The a new ~history-key~ slot and ~transient--history-key~ generic function for prefix objects. 3668aeb, e627d45 - Disallow setting the level of essential suffixes that are shared between all transients. #29 - The active infix is now highlight while reading its value from the user. #30 - The commands ~transient-set~ and ~transient-save~ can now be configured to exit the transient, though by default they still don't. a47ae94 - Always respect the ~transient~ slot of a suffix, even if that suffix has a binding in ~transient-predicate-map~. 919fc66 - Added new generic functions ~transient-set-value~ and ~transient-save-value~ intended for prefix commands. ebe9d9d - It is no longer possible to set a prefix level to 0, which is an invalid value. #28 - All transient prefix and suffix commands are now automatically declared to be for interactive use only. a6295fa - Infix arguments are no longer added to ~command-history~ because these entries were both useless and extremely noisy. #23 - ~digit-argument~ no longer exits the transient. 5f0ec7d - A new keymap, ~transient-base-map~ was added to make it easier to change key bindings that are shared between all transients. This new keymap is used as the parent of all the other keymaps that are shared between all transients. - Added new commands ~transient-scroll-up~ and ~transient-scroll-down~, which scroll the transient window. ~C-v~ and ~M-v~ (and ~~ and ~~) are bound to these commands. These keys were chosen they are bound to scrolling commands in the global map too. This made it necessary to find a new binding for ~transient-show~, which ~C-t~ is bound to now. #17 - The new option ~transient-mode-line-format~ allows users to use a mode-line for the transient popup buffer instead of just a thin line that separates it from the echo area. When using a non-standard value for ~transient-display-buffer-action~ it may be necessary to do that. #17 - The new option ~transient-display-buffer-action~ allows users to specify how a window is selected to display the transient popup buffer. The ~lv~ library is no longer used. #17 - The window that was selected before the transient window was shown is no longer re-selected before calling a suffix that exits the transient. If a suffix changes the selected window unintentionally, then that is a bug. This makes it possible to intentionally change the window layout using transients. - An infix is a special kind of suffix. Depending on context "suffixes" means "suffixes (including infixes)" or "non-infix suffixes". This is now mention in a few places where users might otherwise get confused. - Stopped claiming that the transient is shown in the "echo area", because technically that is not correct. Instead talk about the "popup buffer". - Fixed handling of suffix commands that are undefined at the time the prefix is invoked. This is still an error, but the error message now explains what is wrong. a729bbb - Fixed saving values/history/levels, making sure that the printed expression is never abbreviated. #15 - Fixed jumping to the correct place in a manpage when showing the documentation for an infix argument. c4bf4af - Bound ~ESC ESC ESC~ to ~transient-quit-all~ because the convention is that it should be possible to exit any temporary state using this binding. #12 - Fixed referencing suffix bindings by their key when the key binding is defined in the suffix object instead of in the suffix spec. e4ffb97 - Remove trailing whitespace from popup text for the benefit of users who have set enabled ~show-trailing-whitespace~ globally. 0758efa - Fixed showing available bindings on a single line instead of using the usual popup buffer. 2f011c9, 99d3bf6 - Added a line between the ~lv~ window and the echo area. ca18bb6 - Fixed adding a new suffix at the end of a group and removing a group's last suffix. #20, #6 - No longer use ~cl-typep~, which appears to have a bug on Emacs 25. 9183fe1 - Fixed ~lisp~ make target. 170a3fd - Fixed reading a number as the value of an infix. 8219c0b - Various bug fixes to ~transient--goto-argument-description~ (4f80a89), ~transient-show-help~ (ccac95e), ~transient-infix-read~ (7bf9759). * v0.1.0 2019-01-14 - First release. transient-0.8.8/LICENSE000066400000000000000000001045151500463237300145540ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . transient-0.8.8/Makefile000066400000000000000000000025761500463237300152130ustar00rootroot00000000000000-include config.mk include default.mk .PHONY: lisp docs all: lisp docs help: $(info make all - generate lisp and manual) $(info make lisp - generate byte-code and autoloads) $(info make redo - re-generate byte-code and autoloads) $(info make docs - generate all manual formats) $(info make redo-docs - re-generate all manual formats) $(info make texi - generate texi manual) $(info make info - generate info manual) $(info make html - generate html manual file) $(info make html-dir - generate html manual directory) $(info make pdf - generate pdf manual) $(info make publish - publish snapshot manuals) $(info make release - publish release manuals) $(info make stats - generate statistics) $(info make stats-upload - publish statistics) $(info make clean - remove most generated files) @printf "\n" lisp: @$(MAKE) -C lisp lisp redo: @$(MAKE) -C lisp clean lisp docs: @$(MAKE) -C docs docs redo-docs: @$(MAKE) -C docs redo-docs texi: @$(MAKE) -C docs texi info: @$(MAKE) -C docs info html: @$(MAKE) -C docs html html-dir: @$(MAKE) -C docs html-dir pdf: @$(MAKE) -C docs pdf publish: @$(MAKE) -C docs publish release: @$(MAKE) -C docs release stats: @$(MAKE) -C docs stats stats-upload: @$(MAKE) -C docs stats-upload clean: @$(MAKE) -C lisp clean @$(MAKE) -C docs clean transient-0.8.8/README.org000066400000000000000000000100151500463237300152040ustar00rootroot00000000000000* Transient command menus Transient is the library used to implement the keyboard-driven “menus” in [[https://github.com/magit/magit/][Magit]]. It is distributed as a separate package, so that it can be used to implement similar menus in [[https://melpa.org/#/transient][other packages]]. ** Some things that Transient can do - Display current state of arguments - Display and manage lifecycle of modal bindings - Contextual user interface - Flow control for wizard-like composition of interactive forms - History & persistence - Rendering arguments for controlling CLI programs ** Complexity in CLI programs Complexity tends to grow with time. How do you manage the complexity of commands? Consider the humble shell command =ls=. It now has over /fifty/ command line options. Some of these are boolean flags (=ls -l=). Some take arguments (=ls --sort=s=). Some have no effect unless paired with other flags (=ls -lh=). Some are mutually exclusive. Some shell commands even have so many options that they introduce /subcommands/ (=git branch=, =git commit=), each with their own rich set of options (=git branch -f=). ** Using Transient for composing interactive commands What about Emacs commands used interactively? How do these handle options? One solution is to make many versions of the same command, so you don't need to! Consider: =delete-other-windows= vs. =delete-other-windows-vertically= (among many similar examples). Some Emacs commands will simply prompt you for the next "argument" (=M-x switch-to-buffer=). Another common solution is to use prefix arguments which usually start with =C-u=. Sometimes these are sensibly numerical in nature (=C-u 4 M-x forward-paragraph= to move forward 4 paragraphs). But sometimes they function instead as boolean "switches" (=C-u C-SPACE= to jump to the last mark instead of just setting it, =C-u C-u C-SPACE= to unconditionally set the mark). Since there aren't many standards for the use of prefix options, you have to read the command's documentation to find out what the possibilities are. But when an Emacs command grows to have a truly large set of options and arguments, with dependencies between them, lots of option values, etc., these simple approaches just don't scale. Transient is designed to solve this issue. Think of it as the humble prefix argument =C-u=, /raised to the power of 10/. Like =C-u=, it is key driven. Like the shell, it supports boolean "flag" options, options that take arguments, and even "sub-commands", with their own options. But instead of searching through a man page or command documentation, well-designed transients /guide/ their users to the relevant set of options (and even their possible values!) directly, taking into account any important pre-existing Emacs settings. And while for shell commands like =ls=, there is only one way to "execute" (hit =Return=!), transients can "execute" using multiple different keys tied to one of many self-documenting /actions/ (imagine having 5 different colored return keys on your keyboard!). Transients make navigating and setting large, complex groups of command options and arguments easy. Fun even. Once you've tried it, it's hard to go back to the =C-u what can I do here again?= way. [[http://readme.emacsair.me/transient.png]] #+html:

#+html: Compile #+html: Manual #+html: GNU ELPA #+html: MELPA Stable #+html: MELPA transient-0.8.8/default.mk000066400000000000000000000015751500463237300155260ustar00rootroot00000000000000TOP := $(dir $(lastword $(MAKEFILE_LIST))) PKG = transient ELS = $(PKG).el ELCS = $(ELS:.el=.elc) DEPS = compat DEPS += seq DOMAIN ?= magit.vc CFRONT_DIST ?= E2LUHBKU1FBV02 VERSION ?= $(shell test -e $(TOP).git && git describe --tags --abbrev=0 | cut -c2-) REVDESC := $(shell test -e $(TOP).git && git describe --tags) EMACS ?= emacs EMACS_ARGS ?= --eval "(progn \ (put 'if-let 'byte-obsolete-info nil) \ (put 'when-let 'byte-obsolete-info nil))" LOAD_PATH ?= $(addprefix -L ../../,$(DEPS)) LOAD_PATH += -L . ifndef ORG_LOAD_PATH ORG_LOAD_PATH = -L ../../org/lisp endif INSTALL_INFO ?= $(shell command -v ginstall-info || printf install-info) MAKEINFO ?= makeinfo MANUAL_HTML_ARGS ?= --css-ref /assets/page.css GITSTATS ?= gitstats GITSTATS_DIR ?= $(TOP)docs/stats GITSTATS_ARGS ?= -c style=https://magit.vc/assets/stats.css -c max_authors=999 transient-0.8.8/docs/000077500000000000000000000000001500463237300144715ustar00rootroot00000000000000transient-0.8.8/docs/.orgconfig000066400000000000000000000030471500463237300164530ustar00rootroot00000000000000# -*- mode:org -*- # Copyright (C) 2021-2025 Jonas Bernoulli # SPDX-License-Identifier: GPL-3.0-or-later # URL: https://github.com/emacscollective/org-macros # Visit that to see these macros in a human-readable format. #+language: en #+options: H:4 num:3 toc:2 compact-itemx:t #+property: header-args :eval never #+macro: year (eval (format-time-string "%Y")) #+macro: version (eval (if-let ((tag (ignore-errors (car (process-lines "git" "describe" "--exact-match"))))) (concat "version " (substring tag 1)) (or (ignore-errors (car (process-lines "git" "describe"))) (concat "version " (or $1 ""))))) #+macro: kbd (eval (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (let (case-fold-search) (replace-regexp-in-string (regexp-opt '("BS" "TAB" "RET" "ESC" "SPC" "DEL" "LFD" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words) "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t)))) #+macro: kbdvar (eval (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (let (case-fold-search) (replace-regexp-in-string "<\\([a-zA-Z-]+\\)>" "@@texinfo:@var{@@\\1@@texinfo:}@@" (replace-regexp-in-string (regexp-opt '("BS" "TAB" "RET" "ESC" "SPC" "DEL" "LFD" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words) "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t) t)))) #+macro: codevar (eval (format "@@texinfo:@code{@@%s@@texinfo:}@@" (let (case-fold-search) (replace-regexp-in-string "\\([A-Z][A-Z-]+\\)" "@@texinfo:@var{@@\\&@@texinfo:}@@" $1 t)))) #+macro: var @@texinfo:@var{@@$1@@texinfo:}@@ #+macro: dfn @@texinfo:@dfn{@@$1@@texinfo:}@@ transient-0.8.8/docs/Makefile000066400000000000000000000076331500463237300161420ustar00rootroot00000000000000-include ../config.mk include ../default.mk docs: texi info html html-dir pdf texi: $(PKG).texi info: $(PKG).info dir html: $(PKG).html html-dir: $(PKG)/index.html pdf: $(PKG).pdf ORG_ARGS = --batch -Q $(ORG_LOAD_PATH) ORG_EVAL += --eval "(setq indent-tabs-mode nil)" ORG_EVAL += --eval "(setq org-src-preserve-indentation nil)" ORG_EVAL += --funcall org-texinfo-export-to-texinfo redo-docs: @touch $(PKG).org @make docs .revdesc: ; _ := $(shell test "$(REVDESC)" = "$$(cat .revdesc 2> /dev/null)" ||\ echo "$(REVDESC)" > .revdesc) %.texi: %.org .orgconfig .revdesc @printf "Generating $@\n" @$(EMACS) $(ORG_ARGS) $< $(ORG_EVAL) @sed -i -e 's/“/``/g' -e "s/”/''/g" -e '$$a\' $(PKG).texi #' %.info: %.texi @printf "Generating $@\n" @$(MAKEINFO) --no-split $< -o $@ dir: $(PKG).info @printf "Generating $@\n" @printf "%s" $^ | xargs -n 1 $(INSTALL_INFO) --dir=$@ HTML_FIXUP_CSS = '//a\ \ \n\ \n\ \n\ \n\ \n' HTML_FIXUP_ONLOAD = 's///' HTML_FIXUP_MENU = '/<\/body>/i
<\/div>' %.html: %.texi @printf "Generating $@\n" @$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) $< @sed -i -e $(HTML_FIXUP_CSS) -e $(HTML_FIXUP_ONLOAD) -e $(HTML_FIXUP_MENU) $@ %/index.html: %.texi @printf "Generating $(PKG)/*.html\n" @rm -rf $(PKG) @$(MAKEINFO) --html -o $(PKG)/ $(MANUAL_HTML_ARGS) $< @for f in $$(find $(PKG) -name '*.html') ; do \ sed -i -e $(HTML_FIXUP_CSS) -e $(HTML_FIXUP_ONLOAD) -e $(HTML_FIXUP_MENU) $$f ; \ done %.pdf: %.texi @printf "Generating $@\n" @texi2pdf --clean $< > /dev/null PUBLISH_PATH ?= /manual/ RELEASE_PATH ?= /manual/$(VERSION)/ S3_BUCKET ?= s3://$(DOMAIN) PUBLISH_TARGET = $(S3_BUCKET)$(PUBLISH_PATH) RELEASE_TARGET = $(S3_BUCKET)$(RELEASE_PATH) CFRONT_PATHS = $(PKG).html $(PKG).pdf $(PKG)/* comma := , empty := space := $(empty) $(empty) publish: redo-docs @aws s3 cp $(PKG).html $(PUBLISH_TARGET) @aws s3 cp $(PKG).pdf $(PUBLISH_TARGET) @aws s3 sync $(PKG) $(PUBLISH_TARGET)$(PKG)/ @printf "Generating CDN invalidation\n" @aws cloudfront create-invalidation --distribution-id $(CFRONT_DIST) --paths \ "$(subst $(space),$(comma),$(addprefix $(PUBLISH_PATH),$(CFRONT_PATHS)))" > /dev/null release: redo-docs @aws s3 cp $(PKG).html $(RELEASE_TARGET) @aws s3 cp $(PKG).pdf $(RELEASE_TARGET) @aws s3 sync $(PKG) $(RELEASE_TARGET)$(PKG)/ @aws s3 cp $(PUBLISH_TARGET)dir.html $(RELEASE_TARGET)dir.html @aws s3 cp $(PUBLISH_TARGET)dir/index.html $(RELEASE_TARGET)dir/index.html @printf "Generating CDN invalidation\n" @aws cloudfront create-invalidation --distribution-id $(CFRONT_DIST) --paths \ "$(subst $(space),$(comma),$(addprefix $(RELEASE_PATH),$(CFRONT_PATHS)))" > /dev/null .PHONY: stats stats: @printf "Generating statistics\n" @$(GITSTATS) $(GITSTATS_ARGS) $(TOP) $(GITSTATS_DIR) stats-upload: @printf "Uploading statistics...\n" @aws s3 sync $(GITSTATS_DIR) $(S3_BUCKET)/stats/$(PKG) @printf "Uploaded to $(S3_BUCKET)/stats/$(PKG)\n" @printf "Generating CDN invalidation\n" @aws cloudfront create-invalidation \ --distribution-id $(CFRONT_DIST) --paths "/stats/*" > /dev/null CLEAN = $(PKG).info dir $(PKG) $(PKG).html $(PKG).pdf clean: @printf " Cleaning docs/*...\n" @rm -rf $(CLEAN) transient-0.8.8/docs/gpl.texi000066400000000000000000001044211500463237300161500ustar00rootroot00000000000000@c The GNU General Public License. @center Version 3, 29 June 2007 @c This file is intended to be included within another document, @c hence no sectioning command or @node. @display Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{https://fsf.org/} Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. @end display @heading Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program---to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. @heading TERMS AND CONDITIONS @enumerate 0 @item Definitions. ``This License'' refers to version 3 of the GNU General Public License. ``Copyright'' also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. ``The Program'' refers to any copyrightable work licensed under this License. Each licensee is addressed as ``you''. ``Licensees'' and ``recipients'' may be individuals or organizations. To ``modify'' a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a ``modified version'' of the earlier work or a work ``based on'' the earlier work. A ``covered work'' means either the unmodified Program or a work based on the Program. To ``propagate'' a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To ``convey'' a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays ``Appropriate Legal Notices'' to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. @item Source Code. The ``source code'' for a work means the preferred form of the work for making modifications to it. ``Object code'' means any non-source form of a work. A ``Standard Interface'' means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The ``System Libraries'' of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A ``Major Component'', in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The ``Corresponding Source'' for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. @item Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. @item Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. @item Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. @item Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: @enumerate a @item The work must carry prominent notices stating that you modified it, and giving a relevant date. @item The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to ``keep intact all notices''. @item You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. @item If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. @end enumerate A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an ``aggregate'' if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. @item Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: @enumerate a @item Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. @item Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. @item Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. @item Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. @item Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. @end enumerate A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A ``User Product'' is either (1) a ``consumer product'', which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, ``normally used'' refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. ``Installation Information'' for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. @item Additional Terms. ``Additional permissions'' are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: @enumerate a @item Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or @item Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or @item Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or @item Limiting the use for publicity purposes of names of licensors or authors of the material; or @item Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or @item Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. @end enumerate All other non-permissive additional terms are considered ``further restrictions'' within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. @item Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. @item Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. @item Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An ``entity transaction'' is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. @item Patents. A ``contributor'' is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's ``contributor version''. A contributor's ``essential patent claims'' are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, ``control'' includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a ``patent license'' is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To ``grant'' such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. ``Knowingly relying'' means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is ``discriminatory'' if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. @item No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. @item Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. @item Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License ``or any later version'' applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. @item Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. @item Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. @item Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. @end enumerate @heading END OF TERMS AND CONDITIONS @heading How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the ``copyright'' line and a pointer to where the full notice is found. @smallexample @var{one line to give the program's name and a brief idea of what it does.} Copyright (C) @var{year} @var{name of author} This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see @url{https://www.gnu.org/licenses/}. @end smallexample Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: @smallexample @var{program} Copyright (C) @var{year} @var{name of author} This program comes with ABSOLUTELY NO WARRANTY; for details type @samp{show w}. This is free software, and you are welcome to redistribute it under certain conditions; type @samp{show c} for details. @end smallexample The hypothetical commands @samp{show w} and @samp{show c} should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an ``about box''. You should also get your employer (if you work as a programmer) or school, if any, to sign a ``copyright disclaimer'' for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see @url{https://www.gnu.org/licenses/}. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read @url{https://www.gnu.org/licenses/why-not-lgpl.html}. transient-0.8.8/docs/htmlxref.cnf000066400000000000000000000017371500463237300170220ustar00rootroot00000000000000# https://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Configuration.html EMACS = https://www.gnu.org/software/emacs/manual auth mono ${EMACS}/html_mono/auth.html auth node ${EMACS}/html_node/auth/ ediff mono ${EMACS}/html_mono/ediff.html ediff node ${EMACS}/html_node/ediff/ elisp mono ${EMACS}/html_mono/elisp.html elisp node ${EMACS}/html_node/elisp/ emacs mono ${EMACS}/html_mono/emacs.html emacs node ${EMACS}/html_node/emacs/ MAGIT = https://magit.vc/manual forge mono ${MAGIT}/forge.html forge node ${MAGIT}/forge/ ghub mono ${MAGIT}/ghub.html ghub node ${MAGIT}/ghub/ magit mono ${MAGIT}/magit.html magit node ${MAGIT}/magit/ transient mono ${MAGIT}/transient.html transient node ${MAGIT}/transient/ with-editor mono ${MAGIT}/with-editor.html with-editor node ${MAGIT}/with-editor/ MIRROR = https://emacsmirror.net/manual borg mono ${MAGIT}/borg.html borg node ${MAGIT}/borg/ epkg mono ${MAGIT}/epkg.html epkg node ${MAGIT}/epkg/ transient-0.8.8/docs/transient.org000066400000000000000000003347221500463237300172240ustar00rootroot00000000000000#+title: Transient User and Developer Manual :PREAMBLE: #+author: Jonas Bernoulli #+email: emacs.transient@jonas.bernoulli.dev #+date: 2018-{{{year}}} #+texinfo_dir_category: Emacs misc features #+texinfo_dir_title: Transient: (transient). #+texinfo_dir_desc: Transient Commands #+subtitle: for version 0.8.8 #+setupfile: .orgconfig Transient is the library used to implement the keyboard-driven “menus” in Magit. It is distributed as a separate package, so that it can be used to implement similar menus in other packages. This manual can be bit hard to digest when getting started. A useful resource to get over that hurdle is Psionic K's interactive tutorial, available at https://github.com/positron-solutions/transient-showcase. #+texinfo: @noindent This manual is for Transient version 0.8.8. #+texinfo: @insertcopying :END: * Introduction Transient is the library used to implement the keyboard-driven {{{dfn(menus)}}} in Magit. It is distributed as a separate package, so that it can be used to implement similar menus in other packages. This manual can be bit hard to digest when getting started. A useful resource to get over that hurdle is Psionic K's interactive tutorial, available at https://github.com/positron-solutions/transient-showcase. ** Some things that Transient can do :PROPERTIES: :UNNUMBERED: notoc :END: - Display current state of arguments - Display and manage lifecycle of modal bindings - Contextual user interface - Flow control for wizard-like composition of interactive forms - History & persistence - Rendering arguments for controlling CLI programs ** Complexity in CLI programs :PROPERTIES: :UNNUMBERED: notoc :END: Complexity tends to grow with time. How do you manage the complexity of commands? Consider the humble shell command =ls=. It now has over /fifty/ command line options. Some of these are boolean flags (=ls -l=). Some take arguments (=ls --sort=s=). Some have no effect unless paired with other flags (=ls -lh=). Some are mutually exclusive. Some shell commands even have so many options that they introduce /subcommands/ (=git branch=, =git commit=), each with their own rich set of options (=git branch -f=). ** Using Transient for composing interactive commands :PROPERTIES: :UNNUMBERED: notoc :END: What about Emacs commands used interactively? How do these handle options? One solution is to make many versions of the same command, so you don't need to! Consider: =delete-other-windows= vs. =delete-other-windows-vertically= (among many similar examples). Some Emacs commands will simply prompt you for the next "argument" (=M-x switch-to-buffer=). Another common solution is to use prefix arguments which usually start with =C-u=. Sometimes these are sensibly numerical in nature (=C-u 4 M-x forward-paragraph= to move forward 4 paragraphs). But sometimes they function instead as boolean "switches" (=C-u C-SPACE= to jump to the last mark instead of just setting it, =C-u C-u C-SPACE= to unconditionally set the mark). Since there aren't many standards for the use of prefix options, you have to read the command's documentation to find out what the possibilities are. But when an Emacs command grows to have a truly large set of options and arguments, with dependencies between them, lots of option values, etc., these simple approaches just don't scale. Transient is designed to solve this issue. Think of it as the humble prefix argument =C-u=, /raised to the power of 10/. Like =C-u=, it is key driven. Like the shell, it supports boolean "flag" options, options that take arguments, and even "sub-commands", with their own options. But instead of searching through a man page or command documentation, well-designed transients /guide/ their users to the relevant set of options (and even their possible values!) directly, taking into account any important pre-existing Emacs settings. And while for shell commands like =ls=, there is only one way to "execute" (hit =Return=!), transients can "execute" using multiple different keys tied to one of many self-documenting /actions/ (imagine having 5 different colored return keys on your keyboard!). Transients make navigating and setting large, complex groups of command options and arguments easy. Fun even. Once you've tried it, it's hard to go back to the =C-u what can I do here again?= way. * Usage ** Invoking Transients #+cindex: invoking transients A transient prefix command is invoked like any other command by pressing the key that is bound to that command. The main difference to other commands is that a transient prefix command activates a transient keymap, which temporarily binds the transient's infix and suffix commands, and that those bindings are shown in menu buffer, which is displayed in a new window, until the menu is exited. Bindings from other keymaps may, or may not, be disabled while the transient state is in effect. There are two kinds of commands that are available after invoking a transient prefix command; infix and suffix commands. Infix commands set some value (which is then shown in the menu buffer), without leaving the transient. Suffix commands, on the other hand, usually quit the transient and they may use the values set by the infix commands, i.e., the infix *arguments*. Instead of setting arguments to be used by a suffix command, infix commands may also set some value by side-effect, e.g., by setting the value of some variable. ** Aborting and Resuming Transients #+cindex: aborting transients #+cindex: resuming transients #+cindex: quit transient To quit the transient without invoking a suffix command press {{{kbd(C-g)}}}. Key bindings in transient keymaps may be longer than a single event. After pressing a valid prefix key, all commands whose bindings do not begin with that prefix key are temporarily unavailable and grayed out. To abort the prefix key press {{{kbd(C-g)}}} (which in this case only quits the prefix key, but not the complete transient). A transient prefix command can be bound as a suffix of another transient. Invoking such a suffix replaces the current transient state with a new transient state, i.e., the available bindings change and the information displayed in the menu buffer is updated accordingly. Pressing {{{kbd(C-g)}}} while a nested transient is active only quits the innermost transient, causing a return to the previous transient. {{{kbd(C-q)}}} or {{{kbd(C-z)}}} on the other hand always exits all transients. If you use the latter, then you can later resume the stack of transients using {{{kbd(M-x transient-resume)}}}. #+attr_texinfo: :compact t - Key: C-g (transient-quit-seq) :: - Key: C-g (transient-quit-one) :: This key quits the currently active incomplete key sequence, if any, or else the current transient. When quitting the current transient, it returns to the previous transient, if any. Transient's predecessor bound {{{kbd(q)}}} instead of {{{kbd(C-g)}}} to the quit command. To learn how to get that binding back see ~transient-bind-q-to-quit~'s documentation string. - Key: C-q (transient-quit-all) :: This command quits the currently active incomplete key sequence, if any, and all transients, including the active transient and all suspended transients, if any. - Key: C-z (transient-suspend) :: Like ~transient-quit-all~, this command quits an incomplete key sequence, if any, and all transients. Additionally, it saves the stack of transients so that it can easily be resumed (which is particularly useful if you quickly need to do “something else” and the stack is deeper than a single transient, and/or you have already changed the values of some infix arguments). Note that only a single stack of transients can be saved at a time. If another stack is already saved, then saving a new stack discards the previous stack. - Key: M-x transient-resume :: This command resumes the previously suspended stack of transients, if any. ** Common Suffix Commands #+cindex: common suffix commands A few shared suffix commands are available in all transients. These suffix commands are not shown permanently in every menu by default. Most of these commands share a common prefix key and pressing that key causes the common commands to be temporarily shown in the active menu. - User Option: transient-show-common-commands :: This option controls whether shared suffix commands are permanently shown alongside the menu-specific infix and suffix commands. By default, the shared commands are not permanently shown to avoid wasting precious space and overwhelming the user with too many choices. If you prefer to always see these commands, then set this option to a non-~nil~ value. Alternatively the value can be toggled for the current Emacs session only, using ~transient-toggle-common~, described below. - User Option: transient-common-command-prefix :: This option specifies the prefix key used in all transient menus to invoke most of the shared commands, which are available in all transient menus. By default these bindings are only shown after pressing that prefix key and before following that up with a valid key binding (but see the previous option). For historic reasons {{{kbd(C-x)}}} is used by default, but users are encouraged to pick another key, preferably one that is not commonly used in Emacs but is still convenient to them. Usually, while a transient menu is active, the user cannot invoke commands that are not bound in the menu itself. For those menus it does not matter, if {{{kbd(C-x)}}} or another commonly used prefix key is used for common menu commands. However, certain other, newer menus do not suppress key bindings established outside the menu itself, and in those cases a binding for a common menu command could shadow an external binding. For example, {{{kbd(C-x C-s)}}} could not be used to invoke ~save-buffer~, if that binding is shadowed by the menu binding for ~transient-save~. Which key is most suitable depends on the user's preferences, but good choices may include function keys and {{{kbd(C-z)}}} (for many keyboard layouts {{{kbd(z)}}} is right next to {{{kbd(x)}}}, and invoking ~suspend-frame~, while a transient menu is active, would not be a good idea anyway). - Key: C-x t (transient-toggle-common) :: This command toggles whether the generic commands, that are common to all transients, are permanently displayed or only after typing the incomplete prefix key sequence{{{kbd()}}}. This only affects the current Emacs session. The other common commands are described in either the previous or in one of the following sections. ** Saving Values #+cindex: saving values of arguments After setting the infix arguments in a transient, the user can save those arguments for future invocations. Most transients will start out with the saved arguments when they are invoked. There are a few exceptions, though. Some transients are designed so that the value that they use is stored externally as the buffer-local value of some variable. Invoking such a transient again uses the buffer-local value. [fn:1] If the user does not save the value and just exits using a regular suffix command, then the value is merely saved to the transient's history. That value won't be used when the transient is next invoked, but it is easily accessible (see [[*Using History]]). Option ~transient-common-command-prefix~ controls the prefix key used in the following bindings. For simplicity's sake the default, {{{kbd(C-x)}}}, is shown below. - Key: C-x s (transient-set) :: This command saves the value of the active transient for this Emacs session. - Key: C-x C-s (transient-save) :: This command saves the value of the active transient persistently across Emacs sessions. - Key: C-x C-k (transient-reset) :: This command clears the set and saved values of the active transient. - User Option: transient-values-file :: This option names the file that is used to persist the values of transients between Emacs sessions. [fn:1] ~magit-diff~ and ~magit-log~ are two prominent examples, and their handling of buffer-local values is actually a bit more complicated than outlined above and even customizable. ** Using History #+cindex: value history Every time the user invokes a suffix command the transient's current value is saved to its history. These values can be cycled through, the same way one can cycle through the history of commands that read user-input in the minibuffer. Option ~transient-common-command-prefix~ controls the prefix key used in the following bindings. For simplicity's sake the default, {{{kbd(C-x)}}}, is shown below. #+attr_texinfo: :compact t - Key: C-M-p (transient-history-prev) :: - Key: C-x p :: This command switches to the previous value used for the active transient. - Key: C-M-n (transient-history-next) :: - Key: C-x n :: This command switches to the next value used for the active transient. In addition to the transient-wide history, infixes can have their own history. When an infix reads user-input using the minibuffer, the user can use the regular minibuffer history commands to cycle through previously used values. Usually the same keys as those mentioned above are bound to those commands. Authors of transients should arrange for different infix commands that read the same kind of value to also use the same history key (see [[*Suffix Slots]]). Both kinds of history are saved to a file when Emacs is exited. - User Option: transient-save-history :: This option controls whether the history of transient commands is saved when exiting Emacs. - User Option: transient-history-file :: This option names the file that is used to persist the history of transients and their infixes between Emacs sessions. - User Option: transient-history-limit :: This option controls how many history elements are kept at the time the history is saved in ~transient-history-file~. ** Getting Help for Suffix Commands #+cindex: getting help Transients can have many suffixes and infixes that the user might not be familiar with. To make it trivial to get help for these, Transient provides access to the documentation directly from the active transient. - Key: C-h (transient-help) :: This command enters help mode. When help mode is active, typing a key shows information about the suffix command that the key normally is bound to (instead of invoking it). Pressing {{{kbd(C-h)}}} a second time shows information about the /prefix/ command. After typing a key, the stack of transient states is suspended and information about the suffix command is shown instead. Typing {{{kbd(q)}}} in the help buffer buries that buffer and resumes the transient state. What sort of documentation is shown depends on how the transient was defined. For infix commands that represent command-line arguments this ideally shows the appropriate manpage. ~transient-help~ then tries to jump to the correct location within that. Info manuals are also supported. The fallback is to show the command's documentation string, for non-infix suffixes this is usually appropriate. ** Enabling and Disabling Suffixes #+cindex: enabling suffixes #+cindex: disabling suffixes The user base of a package that uses transients can be very diverse. This is certainly the case for Magit; some users have been using it and Git for a decade, while others are just getting started now. #+cindex: levels For that reason a mechanism is needed that authors can use to classify a transient's infixes and suffixes along the essentials...everything spectrum. We use the term {{{dfn(levels)}}} to describe that mechanism. #+cindex: transient-level Each suffix command is placed on a level and each transient has a level (called {{{dfn(transient-level)}}}), which controls which suffix commands are available. Integers between 1 and 7 (inclusive) are valid levels. For suffixes, 0 is also valid; it means that the suffix is not displayed at any level. The levels of individual transients and/or their individual suffixes can be changed interactively, by invoking the menu and entering its “edit” mode using the command ~transient-set-level~, as described below. The default level for both transients and their suffixes is 4. The ~transient-default-level~ option only controls the default for transients. The default suffix level is always 4. The authors of transients should place certain suffixes on a higher level, if they expect that it won't be of use to most users, and they should place very important suffixes on a lower level, so that they remain available even if the user lowers the transient level. - User Option: transient-default-level :: This option controls which suffix levels are made available by default. It sets the transient-level for transients for which the user has not set that individually. - User Option: transient-levels-file :: This option names the file that is used to persist the levels of transients and their suffixes between Emacs sessions. Option ~transient-common-command-prefix~ controls the prefix key used in the following bindings. For simplicity's sake the default, {{{kbd(C-x)}}}, is shown below. - Key: C-x l (transient-set-level) :: This command enters edit mode. When edit mode is active, then all infixes and suffixes that are currently usable are displayed along with their levels. The colors of the levels indicate whether they are enabled or not. The level of the transient is also displayed along with some usage information. In edit mode, pressing the key that would usually invoke a certain suffix instead prompts the user for the level that suffix should be placed on. Help mode is available in edit mode. To change the transient level press {{{kbd(C-x l)}}} again. To exit edit mode press {{{kbd(C-g)}}}. Note that edit mode does not display any suffixes that are not currently usable. ~magit-rebase~, for example, shows different suffixes depending on whether a rebase is already in progress or not. The predicates also apply in edit mode. Therefore, to control which suffixes are available given a certain state, you have to make sure that that state is currently active. - Key: C-x a (transient-toggle-level-limit) :: This command toggle whether suffixes that are on levels higher than the level specified by ~transient-default-level~ are temporarily available anyway. - Function: transient-set-default-level suffix level :: This function sets the default level of the suffix COMMAND to LEVEL. If a suffix command appears in multiple menus, it may make sense to consistently change its level in all those menus at once. For example, the ~--gpg-sign~ argument (which is implemented using the command ~magit:--gpg-sign~), is bound in all of Magit's menu which create commits. Users who sometimes sign their commits would want that argument to be available in all of these menus, while for users who never sign it is just unnecessary noise in any menus. To always make ~--gpg-sign~ available, use: #+begin_src emacs-lisp (transient-set-default-level 'magit:--gpg-sign 1) #+end_src To never make ~--gpg-sign~ available, use: #+begin_src emacs-lisp (transient-set-default-level 'magit:--gpg-sign 0) #+end_src This sets the level in the suffix prototype object for this command. Commands only have a suffix prototype if they were defined using one of ~transient-define-argument~, ~transient-define-infix~ and ~transient-define-suffix~. For all other commands this would signal an error. (This is one of the reasons why package authors should use one of these functions to define shared suffix commands, and especially shared arguments.) If the user changes the level of a suffix in a particular menu, using {{{kbd(C-x l)}}} as shown above, then that obviously shadows the default. It is also possible to set the level of a suffix binding in a particular menu, either when defining the menu using ~transient-define-prefix,~ or later using ~transient-insert-suffix~. If such bindings specify a level, then that also overrides the default. (Per-suffix default levels is a new feature, so you might encounter this quite often.) ** Other Commands When invoking a transient in a small frame, the transient window may not show the complete buffer, making it necessary to scroll, using the following commands. These commands are never shown in the transient window, and the key bindings are the same as for ~scroll-up-command~ and ~scroll-down-command~ in other buffers. - Command: transient-scroll-up arg :: This command scrolls text of transient's menu window upward {{{var(ARG)}}} lines. If {{{var(ARG)}}} is ~nil~, then it scrolls near full screen. This is a wrapper around ~scroll-up-command~ (which see). - Command: transient-scroll-down arg :: This command scrolls text of transient's menu window down {{{var(ARG)}}} lines. If {{{var(ARG)}}} is ~nil~, then it scrolls near full screen. This is a wrapper around ~scroll-down-command~ (which see). The following commands are not available by default. If you would like to use them for all menus, bind them in ~transient-map~. - Command: transient-copy-menu-text :: This command copies the contents of the menu buffer to the kill ring. - Command: transient-toggle-docstrings :: This command toggle between showing suffix descriptions in the menu (as usual) or showing the first lines of the respective docstrings in their place. For commands that do not have a docstring, always display the suffix description. Because there likely isn't enough room to display multiple docstrings side-by-side, a single column is used when displaying docstrings. ** Configuration More options are described in [[* Common Suffix Commands]], in [[* Saving Values]], in [[* Using History]] and in [[* Enabling and Disabling Suffixes]]. *** Essential Options :PROPERTIES: :UNNUMBERED: notoc :END: Two more essential options are documented in [[* Common Suffix Commands]]. - User Option: transient-show-popup :: This option controls whether and when transient's menu buffer is shown. - If ~t~ (the default), then the buffer is shown as soon as a transient prefix command is invoked. - If ~nil~, then the buffer is not shown unless the user explicitly requests it, by pressing an incomplete prefix key sequence. - If a number, then the a brief one-line summary is shown instead of the menu buffer. If zero or negative, then not even that summary is shown; only the pressed key itself is shown. The buffer is shown once the user explicitly requests it by pressing an incomplete prefix key sequence. Unless this is zero, the menu is shown after that many seconds of inactivity (using the absolute value). - User Option: transient-show-during-minibuffer-read :: This option controls whether the transient menu continues to be displayed while the minibuffer is used to read user input. This is only relevant to commands that do not close the menu, such as commands that set infix arguments. If a command exits the menu, and uses the minibuffer, then the menu is always closed before the minibuffer is entered, irrespective of the value of this option. When ~nil~ (the default), hide the menu while the minibuffer is in use. When ~t~, keep showing the menu, but allow for the menu window to be resized, to ensure that completion candidates can be displayed. When ~fixed~, keep showing the menu and prevent it from being resized, which may make it impossible to display the completion candidates. If that ever happens for you, consider using ~t~ or an integer, as described below. If the value is ~fixed~ and the menu window uses the full height of its frame, then the former is ignored and resizing is allowed anyway. This is necessary because individual menus may use unusual display actions different from what ~transient-display-buffer-action~ specifies (likely to display that menu in a side-window). When using a third-party mode, which automatically resizes windows (e.g., by calling ~balance-windows~ on ~post-command-hook~), then ~fixed~ (or ~nil~) is likely a better choice than ~t~. The value can also be an integer, in which case the behavior depends on whether at least that many lines are left to display windows other than the menu window. If that is the case, display the menu and preserve the size of that window. Otherwise, allow resizing the menu window if the number is positive, or hide the menu if it is negative. - User Option: transient-read-with-initial-input :: This option controls whether the last history element is used as the initial minibuffer input when reading the value of an infix argument from the user. If ~nil~, there is no initial input and the first element has to be accessed the same way as the older elements. - User Option: transient-enable-popup-navigation :: This option controls whether navigation commands are enabled in transient's menu buffer. If the value is ~verbose~ (the default), brief documentation about the command under point is additionally show in the echo area. While a transient is active the menu buffer is not the current buffer, making it necessary to use dedicated commands to act on that buffer itself. If this option is non-~nil~, then the following features are available: - {{{kbd(UP)}}} moves the cursor to the previous suffix. - {{{kbd(DOWN)}}} moves the cursor to the next suffix. - {{{kbd(M-RET)}}} invokes the suffix the cursor is on. - {{{kbd(mouse-1)}}} invokes the clicked on suffix. - {{{kbd(C-s)}}} and {{{kbd(C-r)}}} start isearch in the menu buffer. By default {{{kbd(M-RET)}}} is bound to ~transient-push-button~, instead of {{{kbd(RET)}}}, because if a transient allows the invocation of non-suffixes, then it is likely, that you would want {{{kbd(RET)}}} to do what it would do if no transient were active." - User Option: transient-display-buffer-action :: This option specifies the action used to display the transient's menu buffer. The menu buffer is displayed in a window using {{{codevar((display-buffer BUFFER transient-display-buffer-action))}}}. The value of this option has the form {{{codevar((FUNCTION . ALIST))}}}, where {{{var(FUNCTION)}}} is a function or a list of functions. Each such function should accept two arguments: a buffer to display and an alist of the same form as {{{var(ALIST)}}}. See [[info:elisp#Choosing Window]], for details. The default is: #+BEGIN_SRC emacs-lisp (display-buffer-in-side-window (side . bottom) (dedicated . t) (inhibit-same-window . t)) #+END_SRC This displays the window at the bottom of the selected frame. For alternatives see [[info:elisp#Buffer Display Action Functions]], and [[info:elisp#Buffer Display Action Alists]]. When you switch to a different ACTION, you should keep the ALIST entries for ~dedicated~ and ~inhibit-same-window~ in most cases. Do not drop them because you are unsure whether they are needed; if you are unsure, then keep them. Note that the buffer that was current before the transient buffer is shown should remain the current buffer. Many suffix commands act on the thing at point, if appropriate, and if the transient buffer became the current buffer, then that would change what is at point. To that effect ~inhibit-same-window~ ensures that the selected window is not used to show the transient buffer. It may be possible to display the window in another frame, but whether that works in practice depends on the window-manager. If the window manager selects the new window (Emacs frame), then that unfortunately changes which buffer is current. If you change the value of this option, then you might also want to change the value of ~transient-mode-line-format~. This user option may be overridden if ~:display-action~ is passed when creating a new prefix with ~transient-define-prefix~. *** Accessibility Options :PROPERTIES: :UNNUMBERED: notoc :END: - User Option: transient-force-single-column :: This option controls whether the use of a single column to display suffixes is enforced. This might be useful for users with low vision who use large text and might otherwise have to scroll in two dimensions. *** Auxiliary Options :PROPERTIES: :UNNUMBERED: notoc :END: - User Option: transient-mode-line-format :: This option controls whether transient's menu buffer has a mode-line, separator line, or neither. If ~nil~, then the buffer has no mode-line. If the buffer is not displayed right above the echo area, then this probably is not a good value. If ~line~ (the default) or a natural number, then the buffer has no mode-line, but a line is drawn in its place. If a number is used, that specifies the thickness of the line. On termcap frames we cannot draw lines, so there ~line~ and numbers are synonyms for ~nil~. The color of the line is used to indicate if non-suffixes are allowed and whether they exit the transient. The foreground color of ~transient-key-noop~ (if non-suffixes are disallowed), ~transient-key-stay~ (if allowed and transient stays active), or ~transient-key-exit~ (if allowed and they exit the transient) is used to draw the line. This user option may be overridden if ~:mode-line-format~ is passed when creating a new prefix with ~transient-define-prefix~. Otherwise this can be any mode-line format. See [[info:elisp#Mode Line Format]], for details. - User Option: transient-semantic-coloring :: This option controls whether colors are used to indicate the transient behavior of commands. If non-~nil~, then the key binding of each suffix is colorized to indicate whether it exits the transient state or not. The color of the prefix is indicated using the line that is drawn when the value of ~transient-mode-line-format~ is ~line~. - User Option: transient-highlight-mismatched-keys :: This option controls whether key bindings of infix commands that do not match the respective command-line argument should be highlighted. For other infix commands this option has no effect. When this option is non-~nil~, the key binding for an infix argument is highlighted when only a long argument (e.g., ~--verbose~) is specified but no shorthand (e.g., ~-v~). In the rare case that a shorthand is specified but the key binding does not match, then it is highlighted differently. Highlighting mismatched key bindings is useful when learning the arguments of the underlying command-line tool; you wouldn't want to learn any short-hands that do not actually exist. The highlighting is done using one of the faces ~transient-mismatched-key~ and ~transient-nonstandard-key~. - User Option: transient-substitute-key-function :: This function is used to modify key bindings. If the value of this option is ~nil~ (the default), then no substitution is performed. This function is called with one argument, the prefix object, and must return a key binding description, either the existing key description it finds in the ~key~ slot, or the key description that replaces the prefix key. It could be used to make other substitutions, but that is discouraged. For example, {{{kbd(=)}}} is hard to reach using my custom keyboard layout, so I substitute {{{kbd(()}}} for that, which is easy to reach using a layout optimized for lisp. #+BEGIN_SRC emacs-lisp (setq transient-substitute-key-function (lambda (obj) (let ((key (oref obj key))) (if (string-match "\\`\\(=\\)[a-zA-Z]" key) (replace-match "(" t t key 1) key)))) #+END_SRC - User Option: transient-align-variable-pitch :: This option controls whether columns are aligned pixel-wise in the menu buffer. If this is non-~nil~, then columns are aligned pixel-wise to support variable-pitch fonts. Keys are not aligned, so you should use a fixed-pitch font for the ~transient-key~ face. Other key faces inherit from that face unless a theme is used that breaks that relationship. This option is intended for users who use a variable-pitch font for the ~default~ face. - User Option: transient-force-fixed-pitch :: This option controls whether to force the use of a monospaced font in menu buffer. Even if you use a proportional font for the ~default~ face, you might still want to use a monospaced font in the menu buffer. Setting this option to ~t~ causes ~default~ to be remapped to ~fixed-pitch~ in that buffer. *** Developer Options :PROPERTIES: :UNNUMBERED: notoc :END: These options are mainly intended for developers. - User Option: transient-detect-key-conflicts :: This option controls whether key binding conflicts should be detected at the time the transient is invoked. If so, this results in an error, which prevents the transient from being used. Because of that, conflicts are ignored by default. Conflicts cannot be determined earlier, i.e., when the transient is being defined and when new suffixes are being added, because at that time there can be false-positives. It is actually valid for multiple suffixes to share a common key binding, provided the predicates of those suffixes prevent that more than one of them is enabled at a time. - User Option: transient-error-on-insert-failure :: This option controls whether to signal an error when ~transient-insert-suffix~ or ~transient-append-suffix~ failed to insert a suffix into an existing prefix. By default a warning is shown instead. - User Option: transient-highlight-higher-levels :: This option controls whether suffixes that would not be available by default are highlighted. When non-~nil~ then the descriptions of suffixes are highlighted if their level is above 4, the default of ~transient-default-level~. Assuming you have set that variable to 7, this highlights all suffixes that won't be available to users without them making the same customization. *** Hook Variables :PROPERTIES: :UNNUMBERED: notoc :END: - Variable: transient-exit-hook :: This hook is run after a transient menu is exited, even if another transient menu becomes active at the same time. - Variable: transient-post-exit-hook :: This hook is run after a transient menu is exited, provided no other transient menu becomes active at the same time. - Variable: transient-setup-buffer-hook :: This hook is run when the transient buffer is being setup. That buffer is current and empty when this hook is runs. * Modifying Existing Transients #+cindex: modifying existing transients To an extent, transients can be customized interactively, see [[*Enabling and Disabling Suffixes]]. This section explains how existing transients can be further modified non-interactively. Let's begin with an example: #+begin_src emacs-lisp (transient-append-suffix 'magit-patch-apply "-3" '("-R" "Apply in reverse" "--reverse")) #+end_src This inserts a new infix argument to toggle the ~--reverse~ argument after the infix argument that toggles ~-3~ in ~magit-patch-apply~. The following functions share a few arguments: - {{{var(PREFIX)}}} is a transient prefix command, a symbol. - {{{var(SUFFIX)}}} is a transient infix or suffix specification in the same form as expected by ~transient-define-prefix~. Note that an infix is a special kind of suffix. Depending on context “suffixes” means “suffixes (including infixes)” or “non-infix suffixes”. Here it means the former. See [[*Suffix Specifications]]. {{{var(SUFFIX)}}} may also be a group in the same form as expected by ~transient-define-prefix~. See [[*Group Specifications]]. - {{{var(LOC)}}} is a command, a key vector, a key description (a string as returned by ~key-description~), or a list specifying coordinates (the last element may also be a command or key). For example ~(1 0 -1)~ identifies the last suffix (~-1~) of the first subgroup (~0~) of the second group (~1~). If {{{var(LOC)}}} is a list of coordinates, then it can be used to identify a group, not just an individual suffix command. The function ~transient-get-suffix~ can be useful to determine whether a certain coordination list identifies the suffix or group that you expect it to identify. In hairy cases it may be necessary to look at the definition of the transient prefix command. These functions operate on the information stored in the ~transient--layout~ property of the {{{var(PREFIX)}}} symbol. Suffix entries in that tree are not objects but have the form {{{codevar((LEVEL CLASS PLIST))}}}, where {{{var(PLIST)}}} should set at least ~:key~, ~:description~ and ~:command~. - Function: transient-insert-suffix prefix loc suffix &optional keep-other :: - Function: transient-append-suffix prefix loc suffix &optional keep-other :: These functions insert the suffix or group {{{var(SUFFIX)}}} into {{{var(PREFIX)}}} before or after {{{var(LOC)}}}. Conceptually adding a binding to a transient prefix is similar to adding a binding to a keymap, but this is complicated by the fact that multiple suffix commands can be bound to the same key, provided they are never active at the same time, see [[*Predicate Slots]]. Unfortunately both false-positives and false-negatives are possible. To deal with the former use non-~nil~ {{{var(KEEP-OTHER.)}}} The symbol ~always~ prevents the removal of a false-positive in some cases where other non-~nil~ values would fail. To deal with false-negatives remove the conflicting binding separately, using ~transient-remove-suffix~. - Function: transient-replace-suffix prefix loc suffix :: This function replaces the suffix or group at {{{var(LOC)}}} in {{{var(PREFIX)}}} with suffix or group {{{var(SUFFIX)}}}. - Function: transient-remove-suffix prefix loc :: This function removes the suffix or group at {{{var(LOC)}}} in {{{var(PREFIX)}}}. - Function: transient-get-suffix prefix loc :: This function returns the suffix or group at {{{var(LOC)}}} in {{{var(PREFIX)}}}. The returned value has the form mentioned above. - Function: transient-suffix-put prefix loc prop value :: This function edits the suffix or group at {{{var(LOC)}}} in {{{var(PREFIX)}}}, by setting the {{{var(PROP)}}} of its plist to {{{var(VALUE)}}}. Most of these functions do not signal an error if they cannot perform the requested modification. The functions that insert new suffixes show a warning if {{{var(LOC)}}} cannot be found in {{{var(PREFIX,)}}} without signaling an error. The reason for doing it like this is that establishing a key binding (and that is what we essentially are trying to do here) should not prevent the rest of the configuration from loading. Among these functions only ~transient-get-suffix~ and ~transient-suffix-put~ signal an error by default. If you really want the insert functions to also signal an error, set ~transient-error-on-insert-failure~ to ~t~. * Defining New Commands ** Technical Introduction Taking inspiration from prefix keys and prefix arguments, Transient implements a similar abstraction involving a prefix command, infix arguments and suffix commands. When the user calls a transient prefix command, a transient (temporary) keymap is activated, which binds the transient's infix and suffix commands, and functions that control the transient state are added to ~pre-command-hook~ and ~post-command-hook~. The available suffix and infix commands and their state are shown in a menu buffer until the transient state is exited by invoking a suffix command. Calling an infix command causes its value to be changed. How that is done depends on the type of the infix command. The simplest case is an infix command that represents a command-line argument that does not take a value. Invoking such an infix command causes the switch to be toggled on or off. More complex infix commands may read a value from the user, using the minibuffer. Calling a suffix command usually causes the transient to be exited; the transient keymaps and hook functions are removed, the menu buffer no longer shows information about the (no longer bound) suffix commands, the values of some public global variables are set, while some internal global variables are unset, and finally the command is actually called. Suffix commands can also be configured to not exit the transient. A suffix command can, but does not have to, use the infix arguments in much the same way any command can choose to use or ignore the prefix arguments. For a suffix command that was invoked from a transient, the variable ~transient-current-suffixes~ and the function ~transient-args~ serve about the same purpose as the variables ~prefix-arg~ and ~current-prefix-arg~ do for any command that was called after the prefix arguments have been set using a command such as ~universal-argument~. #+cindex: command dispatchers Transient can be used to implement simple “command dispatchers”. The main benefit then is that the user can see all the available commands in a temporarily shown buffer, which can be thought of as a “menu”. That is useful by itself because it frees the user from having to remember all the keys that are valid after a certain prefix key or command. Magit's ~magit-dispatch~ (on {{{kbd(C-x M-g)}}}) command is an example of using Transient to merely implement a command dispatcher. In addition to that, Transient also allows users to interactively pass arguments to commands. These arguments can be much more complex than what is reasonable when using prefix arguments. There is a limit to how many aspects of a command can be controlled using prefix arguments. Furthermore, what a certain prefix argument means for different commands can be completely different, and users have to read documentation to learn and then commit to memory what a certain prefix argument means to a certain command. Transient suffix commands, on the other hand, can accept dozens of different arguments without the user having to remember anything. When using Transient, one can call a command with arguments that are just as complex as when calling the same function non-interactively from Lisp. Invoking a transient suffix command with arguments is similar to invoking a command in a shell with command-line completion and history enabled. One benefit of the Transient interface is that it remembers history not only on a global level (“this command was invoked using these arguments, and previously it was invoked using those other arguments”), but also remembers the values of individual arguments independently. See [[*Using History]]. After a transient prefix command is invoked, {{{kbdvar(C-h )}}} can be used to show the documentation for the infix or suffix command that {{{kbdvar()}}} is bound to (see [[*Getting Help for Suffix Commands]]), and infixes and suffixes can be removed from the transient using {{{kbdvar(C-x l )}}}. Infixes and suffixes that are disabled by default can be enabled the same way. See [[*Enabling and Disabling Suffixes]]. Transient ships with support for a few different types of specialized infix commands. A command that sets a command line option, for example, has different needs than a command that merely toggles a boolean flag. Additionally, Transient provides abstractions for defining new types, which the author of Transient did not anticipate (or didn't get around to implementing yet). Note that suffix commands also support regular prefix arguments. A suffix command may even be called with both infix and prefix arguments at the same time. If you invoke a command as a suffix of a transient prefix command, but also want to pass prefix arguments to it, then first invoke the prefix command, and only after doing that invoke the prefix arguments, before finally invoking the suffix command. If you instead began by providing the prefix arguments, then those would apply to the prefix command, not the suffix command. Likewise, if you want to change infix arguments before invoking a suffix command with prefix arguments, then change the infix arguments before invoking the prefix arguments. In other words, regular prefix arguments always apply to the next command, and since transient prefix, infix and suffix commands are just regular commands, the same applies to them. (Regular prefix keys behave differently because they are not commands at all, instead they are just incomplete key sequences, and those cannot be interrupted with prefix commands.) ** Defining Transients A transient consists of a prefix command and at least one suffix command, though usually a transient has several infix and suffix commands. The below macro defines the transient prefix command *and* binds the transient's infix and suffix commands. In other words, it defines the complete transient, not just the transient prefix command that is used to invoke that transient. - Macro: transient-define-prefix name arglist [docstring] [keyword value]... group... [body...] :: This macro defines {{{var(NAME)}}} as a transient prefix command and binds the transient's infix and suffix commands. {{{var(ARGLIST)}}} are the arguments that the prefix command takes. {{{var(DOCSTRING)}}} is the documentation string and is optional. These arguments can optionally be followed by keyword-value pairs. Each key has to be a keyword symbol, either ~:class~ or a keyword argument supported by the constructor of that class. The ~transient-prefix~ class is used if the class is not specified explicitly. {{{var(GROUP)}}}s add key bindings for infix and suffix commands and specify how these bindings are presented in the menu buffer. At least one {{{var(GROUP)}}} has to be specified. See [[*Binding Suffix and Infix Commands]]. The {{{var(BODY)}}} is optional. If it is omitted, then {{{var(ARGLIST)}}} is ignored and the function definition becomes: #+BEGIN_SRC emacs-lisp (lambda () (interactive) (transient-setup 'NAME)) #+END_SRC If {{{var(BODY)}}} is specified, then it must begin with an ~interactive~ form that matches {{{var(ARGLIST)}}}, and it must call ~transient-setup~. It may, however, call that function only when some condition is satisfied. #+cindex: scope of a transient All transients have a (possibly ~nil~) value, which is exported when suffix commands are called, so that they can consume that value. For some transients it might be necessary to have a sort of secondary value, called a “scope”. Such a scope would usually be set in the command's ~interactive~ form and has to be passed to the setup function: #+BEGIN_SRC emacs-lisp (transient-setup 'NAME nil nil :scope SCOPE) #+END_SRC For example, the scope of the ~magit-branch-configure~ transient is the branch whose variables are being configured. ** Binding Suffix and Infix Commands The macro ~transient-define-prefix~ is used to define a transient. This defines the actual transient prefix command (see [[*Defining Transients]]) and adds the transient's infix and suffix bindings, as described below. Users and third-party packages can add additional bindings using functions such as ~transient-insert-suffix~ (see [[*Modifying Existing Transients]]). These functions take a “suffix specification” as one of their arguments, which has the same form as the specifications used in ~transient-define-prefix~. *** Group Specifications #+cindex: group specifications The suffix and infix commands of a transient are organized in groups. The grouping controls how the descriptions of the suffixes are outlined visually but also makes it possible to set certain properties for a set of suffixes. Several group classes exist, some of which organize suffixes in subgroups. In most cases the class does not have to be specified explicitly, but see [[*Group Classes]]. Groups are specified in the call to ~transient-define-prefix~, using vectors. Because groups are represented using vectors, we cannot use square brackets to indicate an optional element and instead use curly brackets to do the latter. Group specifications then have this form: #+begin_src emacs-lisp [{LEVEL} {DESCRIPTION} {KEYWORD VALUE}... ELEMENT...] #+end_src The {{{var(LEVEL)}}} is optional and defaults to 4. See [[*Enabling and Disabling Suffixes]]. The {{{var(DESCRIPTION)}}} is optional. If present, it is used as the heading of the group. The {{{var(KEYWORD)}}}-{{{var(VALUE)}}} pairs are optional. Each keyword has to be a keyword symbol, either ~:class~ or a keyword argument supported by the constructor of that class. - One of these keywords, ~:description~, is equivalent to specifying {{{var(DESCRIPTION)}}} at the very beginning of the vector. The recommendation is to use ~:description~ if some other keyword is also used, for consistency, or {{{var(DESCRIPTION)}}} otherwise, because it looks better. - Likewise ~:level~ is equivalent to {{{var(LEVEL)}}}. - Other important keywords include the ~:if...~ and ~:inapt-if...~ keywords. These keywords control whether the group is available in a certain situation. For example, one group of the ~magit-rebase~ transient uses ~:if magit-rebase-in-progress-p~, which contains the suffixes that are useful while rebase is already in progress; and another that uses ~:if-not magit-rebase-in-progress-p~, which contains the suffixes that initiate a rebase. These predicates can also be used on individual suffixes and are only documented once, see [[*Predicate Slots]]. - The value of ~:hide~, if non-~nil~, is a predicate that controls whether the group is hidden by default. The key bindings for suffixes of a hidden group should all use the same prefix key. Pressing that prefix key should temporarily show the group and its suffixes, which assumes that a predicate like this is used: #+BEGIN_SRC emacs-lisp (lambda () (eq (car transient--redisplay-key) ?\C-c)) ; the prefix key shared by all bindings #+END_SRC - The value of ~:setup-children~, if non-~nil~, is a function that takes one argument, a potentially list of children, and must return a list of children or an empty list. This can either be used to somehow transform the group's children that were defined the normal way, or to dynamically create the children from scratch. The returned children must have the same form as stored in the prefix's ~transient--layout~ property, but it is often more convenient to use the same form as understood by ~transient-define-prefix~, described below. If you use the latter approach, you can use the ~transient-parse-suffixes~ and ~transient-parse-suffix~ functions to transform them from the convenient to the expected form. Depending on the used group class, ~transient-parse-suffixes~'s SUFFIXES must be a list of group vectors (for ~transient-columns~) or a list of suffix lists (for all other group classes). If you explicitly specify children and then transform them using ~:setup-children~, then the class of the group is determined as usual, based on explicitly specified children. If you do not explicitly specify children and thus rely solely on ~:setup-children~, then you must specify the class using ~:class~. For backward compatibility, if you fail to do so, ~transient-column~ is used and a warning is displayed. This warning will eventually be replaced with an error. #+BEGIN_SRC emacs-lisp (transient-define-prefix my-finder-by-keyword () "Select a keyword and list matching packages." ;; The real `finder-by-keyword' is more convenient ;; of course, but that is not the point here. [:class transient-columns :setup-children (lambda (_) (transient-parse-suffixes 'my-finder-by-keyword (let ((char (1- ?A))) (mapcar ; a list ... (lambda (partition) (vconcat ; of group vectors ... (mapcar (lambda (elt) (let ((keyword (symbol-name (car elt)))) ; ... where each suffix is a list (list (format "%c" (cl-incf char)) keyword (lambda () (interactive) (finder-list-matches keyword))))) partition))) (seq-partition finder-known-keywords 7)))))]) #+END_SRC - The boolean ~:pad-keys~ argument controls whether keys of all suffixes contained in a group are right padded, effectively aligning the descriptions. - If a keyword argument accepts a function as value, you an use a ~lambda~ expression. As a special case, the ~##~ macro (which returns a ~lambda~ expression and is implemented in the ~llama~ package) is also supported. Inside group specifications, the use of ~##~ is not supported anywhere but directly following a keyword symbol. The {{{var(ELEMENT)}}}s are either all subgroups, or all suffixes and strings. (At least currently no group type exists that would allow mixing subgroups with commands at the same level, though in principle there is nothing that prevents that.) If the {{{var(ELEMENT)}}}s are not subgroups, then they can be a mixture of lists, which specify commands, and strings. Strings are inserted verbatim into the buffer. The empty string can be used to insert gaps between suffixes, which is particularly useful if the suffixes are outlined as a table. Inside group specifications, including inside contained suffix specifications, nothing has to be quoted and quoting anyway is invalid. The value following a keyword, can be explicitly unquoted using ~,~. This feature is experimental and should be avoided. The form of suffix specifications is documented in the next node. *** Suffix Specifications #+cindex: suffix specifications A transient's suffix and infix commands are bound when the transient prefix command is defined using ~transient-define-prefix~, see [[*Defining Transients]]. The commands are organized into groups, see [[*Group Specifications]]. Here we describe the form used to bind an individual suffix command. The same form is also used when later binding additional commands using functions such as ~transient-insert-suffix~, see [[*Modifying Existing Transients]]. Note that an infix is a special kind of suffix. Depending on context “suffixes” means “suffixes (including infixes)” or “non-infix suffixes”. Here it means the former. Suffix specifications have this form: #+begin_src emacs-lisp ([LEVEL] [KEY [DESCRIPTION]] COMMAND|ARGUMENT [KEYWORD VALUE]...) #+end_src {{{var(LEVEL)}}}, {{{var(KEY)}}} and {{{var(DESCRIPTION)}}} can also be specified using the {{{var(KEYWORD)}}}s ~:level~, ~:key~ and ~:description~. If the object that is associated with {{{var(COMMAND)}}} sets these properties, then they do not have to be specified here. You can however specify them here anyway, possibly overriding the object's values just for the binding inside this transient. - {{{var(LEVEL)}}} is the suffix level, an integer between 1 and 7. See [[*Enabling and Disabling Suffixes]]. - {{{var(KEY)}}} is the key binding, either a vector or key description string. - {{{var(DESCRIPTION)}}} is the description, either a string or a function that takes zero or one arguments (the suffix object) and returns a string. The function should be a lambda expression to avoid ambiguity. In some cases a symbol that is bound as a function would also work but to be safe you should use ~:description~ in that case. The next element is either a command or an argument. This is the only argument that is mandatory in all cases. - {{{var(COMMAND)}}} should be a symbol that is bound as a function, which has to be defined or at least autoloaded as a command by the time the containing prefix command is invoked. Any command will do; it does not need to have an object associated with it (as would be the case if ~transient-define-suffix~ or ~transient-define-infix~ were used to define it). COMMAND can also be a ~lambda~ expression. As mentioned above, the object that is associated with a command can be used to set the default for certain values that otherwise have to be set in the suffix specification. Therefore if there is no object, then you have to make sure to specify the {{{var(KEY)}}} and the {{{var(DESCRIPTION)}}}. As a special case, if you want to add a command that might be neither defined nor autoloaded, you can use a workaround like: #+BEGIN_SRC emacs-lisp (transient-insert-suffix 'some-prefix "k" '("!" "Ceci n'est pas une commande" no-command :if (lambda () (featurep 'no-library)))) #+END_SRC Instead of ~featurep~ you could also use ~require~ with a non-~nil~ value for {{{var(NOERROR)}}}. - The mandatory argument can also be a command-line argument, a string. In that case an anonymous command is defined and bound. Instead of a string, this can also be a list of two strings, in which case the first string is used as the short argument (which can also be specified using ~:shortarg~) and the second as the long argument (which can also be specified using ~:argument~). Only the long argument is displayed in the menu buffer. See ~transient-detect-key-conflicts~ for how the short argument may be used. Unless the class is specified explicitly, the appropriate class is guessed based on the long argument. If the argument ends with === (e.g., =--format==) then ~transient-option~ is used, otherwise ~transient-switch~. Finally, details can be specified using optional {{{var(KEYWORD)}}}-{{{var(VALUE)}}} pairs. Each keyword has to be a keyword symbol, either ~:class~ or a keyword argument supported by the constructor of that class. See [[*Suffix Slots]]. If a keyword argument accepts a function as value, you an use a ~lambda~ expression. As a special case, the ~##~ macro (which returns a ~lambda~ expression and is implemented in the ~llama~ package) is also supported. Inside suffix bindings, the use of ~##~ is not supported anywhere but directly following a keyword symbol. ** Defining Suffix and Infix Commands #+cindex: defining suffix commands #+cindex: defining infix commands Note that an infix is a special kind of suffix. Depending on context “suffixes” means “suffixes (including infixes)” or “non-infix suffixes”. - Macro: transient-define-suffix name arglist [docstring] [keyword value]... body... :: This macro defines {{{var(NAME)}}} as a transient suffix command. {{{var(ARGLIST)}}} are the arguments that the command takes. {{{var(DOCSTRING)}}} is the documentation string and is optional. These arguments can optionally be followed by keyword-value pairs. Each keyword has to be a keyword symbol, either ~:class~ or a keyword argument supported by the constructor of that class. The ~transient-suffix~ class is used if the class is not specified explicitly. The {{{var(BODY)}}} must begin with an ~interactive~ form that matches {{{var(ARGLIST)}}}. The infix arguments are usually accessed by using ~transient-args~ inside ~interactive~. - Macro: transient-define-infix name arglist [docstring] [keyword value]... :: This macro defines {{{var(NAME)}}} as a transient infix command. {{{var(ARGLIST)}}} is always ignored (but mandatory never-the-less) and reserved for future use. {{{var(DOCSTRING)}}} is the documentation string and is optional. At least one key-value pair is required. All transient infix commands are ~equal~ to each other (but not ~eq~). It is meaningless to define an infix command, without providing at least one keyword argument (usually ~:argument~ or ~:variable~, depending on the class). The suffix class defaults to ~transient-switch~ and can be set using the ~:class~ keyword. The function definition is always: #+BEGIN_SRC emacs-lisp (lambda () (interactive) (let ((obj (transient-suffix-object))) (transient-infix-set obj (transient-infix-read obj))) (transient--show)) #+END_SRC ~transient-infix-read~ and ~transient-infix-set~ are generic functions. Different infix commands behave differently because the concrete methods are different for different infix command classes. In rare cases the above command function might not be suitable, even if you define your own infix command class. In that case you have to use ~transient-define-suffix~ to define the infix command and use ~t~ as the value of the ~:transient~ keyword. - Macro: transient-define-argument name arglist [docstring] [keyword value]... :: This macro defines {{{var(NAME)}}} as a transient infix command. This is an alias for ~transient-define-infix~. Only use this alias to define an infix command that actually sets an infix argument. To define an infix command that, for example, sets a variable, use ~transient-define-infix~ instead. ** Using Infix Arguments The functions and the variables described below allow suffix commands to access the value of the transient from which they were invoked; which is the value of its infix arguments. These variables are set when the user invokes a suffix command that exits the transient, but before actually calling the command. When returning to the command-loop after calling the suffix command, the arguments are reset to ~nil~ (which causes the function to return ~nil~ too). Like for Emacs's prefix arguments, it is advisable, but not mandatory, to access the infix arguments inside the command's ~interactive~ form. The preferred way of doing that is to call the ~transient-args~ function, which for infix arguments serves about the same purpose as ~prefix-arg~ serves for prefix arguments. - Function: transient-args prefix :: This function returns the value of the transient prefix command {{{var(PREFIX)}}}. If the current command was invoked from the transient prefix command {{{var(PREFIX)}}}, then it returns the active infix arguments. If the current command was not invoked from {{{var(PREFIX)}}}, then it returns the set, saved or default value for {{{var(PREFIX)}}}. - Function: transient-get-value :: This function returns the value of the current prefix. This is mostly intended for internal use, but may also be of use in ~transient-set-value~ and ~transient-save-value~ methods. Unlike ~transient-args~, this does not include the values of suffixes whose ~unsavable~ slot is non-~nil~. - Function: transient-arg-value arg args :: This function returns the value of {{{var(ARG)}}} as it appears in {{{var(ARGS)}}}. For a switch a boolean is returned. For an option the value is returned as a string, using the empty string for the empty value, or ~nil~ if the option does not appear in {{{var(ARGS)}}}. - Function: transient-suffixes prefix :: This function returns the suffixes of the transient prefix command {{{var(PREFIX)}}}. This is a list of objects. This function should only be used if you need the objects (as opposed to just their values) and if the current command is not being invoked from {{{var(PREFIX)}}}. ** Using Prefix Scope Some transients have a sort of secondary value, called a scope. A prefix's scope can be accessed using ~transient-scope~; similar to how its value can be accessed using ~transient-args~. - Function: transient-scope prefixes classes :: This function returns the scope of the active or current transient prefix command. If optional PREFIXES and CLASSES are both nil, return the scope of the prefix currently being setup, making this variation useful, e.g., in ~:if*~ predicates. If no prefix is being setup, but the current command was invoked from some prefix, then return the scope of that. If PREFIXES is non-nil, it must be a prefix command or a list of such commands. If CLASSES is non-nil, it must be a prefix class or a list of such classes. When this function is called from the body or the ~interactive~ form of a suffix command, PREFIXES and/or CLASSES should be non-nil. If either is non-nil, try the following in order: - If the current suffix command was invoked from a prefix, which appears in PREFIXES, return the scope of that prefix. - If the current suffix command was invoked from a prefix, and its class derives from one of the CLASSES, return the scope of that prefix. - If a prefix is being setup and it appears in PREFIXES, return its scope. - If a prefix is being setup and its class derives from one of the CLASSES, return its scope. - Finally try to return the default scope of the first command in PREFIXES. This only works if that slot is set in the respective class definition or using its `transient-init-scope' method. If no prefix matches, return nil. ** Current Suffix Command - Function: transient-suffix-object command :: This function returns the object associated with the current suffix command. Each suffix commands is associated with an object, which holds additional information about the suffix, such as its value (in the case of an infix command, which is a kind of suffix command). This function is intended to be called by infix commands, which are usually aliases of ~transient--default-infix-command~, which is defined like this: #+begin_src emacs-lisp (defun transient--default-infix-command () (interactive) (let ((obj (transient-suffix-object))) (transient-infix-set obj (transient-infix-read obj))) (transient--show)) #+end_src (User input is read outside of ~interactive~ to prevent the command from being added to ~command-history~.) Such commands need to be able to access their associated object to guide how ~transient-infix-read~ reads the new value and to store the read value. Other suffix commands (including non-infix commands) may also need the object to guide their behavior. This function attempts to return the object associated with the current suffix command even if the suffix command was not invoked from a transient. (For some suffix command that is a valid thing to do, for others it is not.) In that case ~nil~ may be returned, if the command was not defined using one of the macros intended to define such commands. The optional argument COMMAND is intended for internal use. If you are contemplating using it in your own code, then you should probably use this instead: #+begin_src emacs-lisp (get COMMAND 'transient--suffix) #+end_src - Variable: transient-current-suffixes :: The suffixes of the transient from which this suffix command was invoked. This is a list of objects. Usually it is sufficient to instead use the function ~transient-args~, which returns a list of values. In complex cases it might be necessary to use this variable instead, i.e., if you need access to information beside the value. ** Current Prefix Command - Function: transient-prefix-object :: This function returns the current prefix as an object. While a transient is being setup or refreshed (which involves preparing its suffixes) the variable ~transient--prefix~ can be used to access the prefix object. Thus this is what has to be used in suffix methods such as ~transient-format-description~, and in object-specific functions that are stored in suffix slots such as ~description~. When a suffix command is invoked (i.e., in its ~interactive~ form and function body) then the variable ~transient-current-prefix~ has to be used instead. Two distinct variables are needed, because any prefix may itself be used as a suffix of another prefix, and such sub-prefixes have to be able to tell themselves apart from the prefix they were invoked from. Regular suffix commands, which are not prefixes, do not have to concern themselves with this distinction, so they can use this function instead. In the context of a plain suffix, it always returns the value of the appropriate variable. - Variable: transient-current-prefix :: The transient from which this suffix command was invoked. The value is a ~transient-prefix~ object, which holds information associated with the transient prefix command. - Variable: transient-current-command :: The transient from which this suffix command was invoked. The value is a symbol, the transient prefix command. - Function: transient-active-prefix &optional prefixes :: This function returns the active transient object. It returns ~nil~ if there is no active transient, if the transient buffer isn't shown, and while the active transient is suspended (e.g., while the minibuffer is in use). Unlike ~transient-current-prefix~, which is only ever non-~nil~ in code that is run directly by a command that is invoked while a transient is current, this function is also suitable for use in asynchronous code, such as timers and callbacks (this function's main use-case). If optional PREFIXES is non-~nil~, it must be a prefix command symbol or a list of symbols, in which case the active transient object is only returned if it matches one of the PREFIXES. ** Transient State #+cindex: transient state Invoking a transient prefix command “activates” the respective transient, i.e., it puts a transient keymap into effect, which binds the transient's infix and suffix commands. The default behavior while a transient is active is as follows: - Invoking an infix command does not affect the transient state; the transient remains active. - Invoking a (non-infix) suffix command “deactivates” the transient state by removing the transient keymap and performing some additional cleanup. - Invoking a command that is bound in a keymap other than the transient keymap is disallowed and trying to do so results in a warning. This does not “deactivate” the transient. The behavior can be changed for all suffixes of a particular prefix and/or for individual suffixes. The values should nearly always be booleans, but certain functions, called “pre-commands”, can also be used. These functions are named ~transient--do-VERB~, and the symbol ~VERB~ can be used as a shorthand. A boolean is interpreted as answering the question "does the transient stay active, when this command is invoked?" ~t~ means that the transient stays active, while ~nil~ means that invoking the command exits the transient. Note that when the suffix is a “sub-prefix”, invoking that command always activates that sub-prefix, causing the outer prefix to no longer be active and displayed. Here ~t~ means that when you exit the inner prefix, then the outer prefix becomes active again, while ~nil~ means that all outer prefixes are exited at once. - The behavior for non-suffixes can be set for a particular prefix, by the prefix's ~transient-non-suffix~ slot to a boolean, a suitable pre-command function, or a shorthand for such a function. See [[*Pre-commands for Non-Suffixes]]. - The common behavior for the suffixes of a particular prefix can be set using the prefix's ~transient-suffixes~ slot. The value specified in this slot does *not* affect infixes. Because it affects both regular suffixes as well as sub-prefixes, which have different needs, it is best to avoid explicitly specifying a function. - The behavior of an individual suffix can be changed using its ~transient~ slot. While it is usually best to use a boolean, for this slot it can occasionally make sense to specify a function explicitly. Note that this slot can be set when defining a suffix command using ~transient-define-suffix~ and/or in the definition of the prefix. If set in both places, then the latter takes precedence, as usual. The available pre-command functions are documented in the following sub-sections. They are called by ~transient--pre-command~, a function on ~pre-command-hook~, and the value that they return determines whether the transient is exited. To do so the value of one of the constants ~transient--exit~ or ~transient--stay~ is used (that way we don't have to remember if ~t~ means “exit” or “stay”). Additionally, these functions may change the value of ~this-command~ (which explains why they have to be called using ~pre-command-hook~), call ~transient-export~, ~transient--stack-zap~ or ~transient--stack-push~; and set the values of ~transient--exitp~, ~transient--helpp~ or ~transient--editp~. For completeness sake, some notes about complications: - The transient-ness of certain built-in suffix commands is specified using ~transient-predicate-map~. This is a special keymap, which binds commands to pre-commands (as opposed to keys to commands) and takes precedence over the prefix's ~transient-suffix~ slot, but not the suffix's ~transient~ slot. - While a sub-prefix is active we nearly always want {{{kbd(C-g)}}} to take the user back to the “super-prefix”, even when the other suffixes don't do that. However, in rare cases this may not be desirable, in which case ~replace~ can be used as the value of the sub-prefix's ~transient~ slot. *** Pre-commands for Infixes :PROPERTIES: :UNNUMBERED: notoc :END: The default for infixes is ~transient--do-stay~. This is also the only function that makes sense for infixes, which is why this predicate is used even if the value of the prefix's ~transient-suffix~ slot is ~t~. In extremely rare cases, one might want to use something else, which can be done by setting the infix's ~transient~ slot directly. - Function: transient--do-stay :: Call the command without exporting variables and stay transient. *** Pre-commands for Suffixes :PROPERTIES: :UNNUMBERED: notoc :END: By default, invoking a suffix causes the transient to be exited. The behavior for an individual suffix command can be changed by setting its ~transient~ slot to a boolean (which is highly recommended), or to one of the following pre-commands. - Function: transient--do-exit :: Call the command after exporting variables and exit the transient. - Function: transient--do-return :: Call the command after exporting variables and return to the parent prefix. If there is no parent prefix, then call ~transient--do-exit~. - Function: transient--do-call :: Call the command after exporting variables and stay transient. The following pre-commands are only suitable for sub-prefixes. It is not necessary to explicitly use these predicates because the correct predicate is automatically picked based on the value of the ~transient~ slot for the sub-prefix itself. - Function: transient--do-recurse :: Call the transient prefix command, preparing for return to outer transient. Whether we actually return to the parent transient is ultimately under the control of each invoked suffix. The difference between this pre-command and ~transient--do-stack~ is that it changes the value of the ~transient-suffix~ slot to ~t~. If there is no parent transient, then only call this command and skip the second step. - Function: transient--do-stack :: Call the transient prefix command, stacking the active transient. Push the active transient to the transient stack. Unless ~transient--do-recurse~ is explicitly used, this pre-command is automatically used for suffixes that are prefixes themselves, i.e., for sub-prefixes. - Function: transient--do-replace :: Call the transient prefix command, replacing the active transient. Do not push the active transient to the transient stack. Unless ~transient--do-recurse~ is explicitly used, this pre-command is automatically used for suffixes that are prefixes themselves, i.e., for sub-prefixes. - Function: transient--do-suspend :: Suspend the active transient, saving the transient stack. This is used by the command ~transient-suspend~ and optionally also by “external events” such as ~handle-switch-frame~. Such bindings should be added to ~transient-predicate-map~. *** Pre-commands for Non-Suffixes :PROPERTIES: :UNNUMBERED: notoc :END: By default, non-suffixes (commands that are bound in other keymaps beside the transient keymap) cannot be invoked. Trying to invoke such a command results in a warning and the transient stays active. If you want a different behavior, then set the ~transient-non-suffix~ slot of the transient prefix command. The value should be a boolean, answering the question, "is it allowed to invoke non-suffix commands?, a pre-command function, or a shorthand for such a function. If the value is ~t~, then non-suffixes can be invoked, when it is ~nil~ (the default) then they cannot be invoked. The only other recommended value is ~leave~. If that is used, then non-suffixes can be invoked, but if one is invoked, then that exits the transient. - Function: transient--do-warn :: Call ~transient-undefined~ and stay transient. - Function: transient--do-stay :: Call the command without exporting variables and stay transient. - Function: transient--do-leave :: Call the command without exporting variables and exit the transient. # transient--do-noop intentionally left undocumented. *** Special Pre-Commands :PROPERTIES: :UNNUMBERED: notoc :END: - Function: transient--do-quit-one :: If active, quit help or edit mode, else exit the active transient. This is used when the user pressed {{{kbd(C-g)}}}. - Function: transient--do-quit-all :: Exit all transients without saving the transient stack. This is used when the user pressed {{{kbd(C-q)}}}. - Function: transient--do-suspend :: Suspend the active transient, saving the transient stack. This is used when the user pressed {{{kbd(C-z)}}}. * Classes and Methods #+cindex: classes and methods Transient uses classes and generic functions to make it possible to define new types of suffix and prefix commands, which are similar to existing types, but behave differently in some respects. Every prefix, infix and suffix command is associated with an object, which holds information, which controls certain aspects of its behavior. This happens in two ways. - Associating a command with a certain class gives the command a type. This makes it possible to use generic functions to do certain things that have to be done differently depending on what type of command it acts on. That in turn makes it possible for third-parties to add new types without having to convince the maintainer of Transient, that that new type is important enough to justify adding a special case to a dozen or so functions. - Associating a command with an object makes it possible to easily store information that is specific to that particular command. Two commands may have the same type, but obviously their key bindings and descriptions still have to be different, for example. The values of some slots are functions. The ~reader~ slot for example holds a function that is used to read a new value for an infix command. The values of such slots are regular functions. Generic functions are used when a function should do something different based on the type of the command, i.e., when all commands of a certain type should behave the same way but different from the behavior for other types. Object slots that hold a regular function as value are used when the task that they perform is likely to differ even between different commands of the same type. ** Group Classes The type of a group can be specified using the ~:class~ property at the beginning of the class specification, e.g., ~[:class transient-columns ...]~ in a call to ~transient-define-prefix~. - The abstract ~transient-child~ class is the base class of both ~transient-group~ (and therefore all groups) as well as of ~transient-suffix~ (and therefore all suffix and infix commands). This class exists because the elements (or “children”) of certain groups can be other groups instead of suffix and infix commands. - The abstract ~transient-group~ class is the superclass of all other group classes. - The ~transient-column~ class is the simplest group. This is the default “flat” group. If the class is not specified explicitly and the first element is not a vector (i.e., not a group), then this class is used. This class displays each element on a separate line. - The ~transient-row~ class displays all elements on a single line. - The ~transient-columns~ class displays commands organized in columns. Direct elements have to be groups whose elements have to be commands or strings. Each subgroup represents a column. This class takes care of inserting the subgroups' elements. This is the default “nested” group. If the class is not specified explicitly and the first element is a vector (i.e., a group), then this class is used. - The ~transient-subgroups~ class wraps other groups. Direct elements have to be groups whose elements have to be commands or strings. This group inserts an empty line between subgroups. The subgroups themselves are responsible for displaying their elements. ** Group Methods - Function: transient-setup-children group children :: This generic function can be used to setup the children or a group. The default implementation usually just returns the children unchanged, but if the ~setup-children~ slot of {{{var(GROUP)}}} is non-~nil~, then it calls that function with {{{var(CHILDREN)}}} as the only argument and returns the value. The children are given as a (potentially empty) list consisting of either group or suffix specifications. These functions can make arbitrary changes to the children including constructing new children from scratch. - Function: transient--insert-group group :: This generic function formats the group and its elements and inserts the result into the current buffer, which is a temporary buffer. The contents of that buffer are later inserted into the menu buffer. Functions that are called by this function may need to operate in the buffer from which the transient was called. To do so they can temporarily make the ~transient--shadowed-buffer~ the current buffer. ** Prefix Classes Transient itself provides a single class for prefix commands, ~transient-prefix~, but package authors may wish to define specialized classes. Doing so makes it possible to change the behavior of the set of prefix commands that use that class, by implementing specialized methods for certain generic functions (see [[* Prefix Methods]]). A transient prefix command's object is stored in the ~transient--prefix~ property of the command symbol. While a transient is active, a clone of that object is stored in the variable ~transient--prefix~. A clone is used because some changes that are made to the active transient's object should not affect later invocations. ** Suffix Classes - All suffix and infix classes derive from ~transient-suffix~, which in turn derives from ~transient-child~, from which ~transient-group~ also derives (see [[*Group Classes]]). - All infix classes derive from the abstract ~transient-infix~ class, which in turn derives from the ~transient-suffix~ class. Infixes are a special type of suffixes. The primary difference is that infixes always use the ~transient--do-stay~ pre-command, while non-infix suffixes use a variety of pre-commands (see [[*Transient State]]). Doing that is most easily achieved by using this class, though theoretically it would be possible to define an infix class that does not do so. If you do that then you get to implement many methods. Also, infixes and non-infix suffixes are usually defined using different macros (see [[*Defining Suffix and Infix Commands]]). - Classes used for infix commands that represent arguments should be derived from the abstract ~transient-argument~ class. - The ~transient-switch~ class (or a derived class) is used for infix arguments that represent command-line switches (arguments that do not take a value). - The ~transient-option~ class (or a derived class) is used for infix arguments that represent command-line options (arguments that do take a value). - The ~transient-switches~ class can be used for a set of mutually exclusive command-line switches. - The ~transient-files~ class can be used for a =--= argument that indicates that all remaining arguments are files. - Classes used for infix commands that represent variables should derived from the abstract ~transient-variable~ class. - The ~transient-information~ and ~transient-information*~ classes are special in that suffixes that use these class are not associated with a command and thus also not with any key binding. Such suffixes are only used to display arbitrary information, and that anywhere a suffix can appear. Display-only suffix specifications take these form: #+begin_src emacs-lisp ([LEVEL] :info DESCRIPTION [KEYWORD VALUE]...) ([LEVEL] :info* DESCRIPTION [KEYWORD VALUE]...) #+end_src The ~:info~ and ~:info*~ keyword arguments replaces the ~:description~ keyword used for other suffix classes. Other keyword arguments that you might want to set, include ~:face~, predicate keywords (such as ~:if~ and ~:inapt-if~), and ~:format~. By default the value of ~:format~ includes ~%k~, which for this class is replaced with the empty string or spaces, if keys are being padded in the containing group. The only difference between these two classes is that ~:info*~ aligns its description with the descriptions of suffix commands, while for ~:info~ the description bleeds into the area where suffixes display their key bindings. - The ~transient-lisp-variable~ class can be used to show and change the value of lisp variables. This class is not fully featured yet and it is somewhat likely that future improvements won't be fully backward compatible. - The ~transient-describe-target~ class is used by the command ~transient-describe~. - The ~transient-value-preset~ class is used to implement the command ~transient-preset~, which activates a value preset. Magit defines additional classes, which can serve as examples for the fancy things you can do without modifying Transient. Some of these classes will likely get generalized and added to Transient. For now they are very much subject to change and not documented. ** Prefix Methods To get information about the methods implementing these generic functions use ~describe-function~. - Function: transient-init-value obj :: This generic function sets the initial value of the object {{{var(OBJ)}}}. Methods exist for both prefix and suffix objects. The default method for prefix objects sets the value of OBJ's ~value~ slot to the set, saved or default value. The value that is set for the current session is preferred over the saved value, which is preferred over the default value. The default value is determined using the generic function ~transient-default-value~. If you need to change how the value for a prefix class is determined, its usually sufficient to implement a method for that function. - Function: transient-default-value obj :: This generic function returns the default value of the object {{{var(OBJ)}}}. Methods exist for both prefix and suffix objects. The default method for prefix objects returns the value of the ~default-value~ slot if that is bound and not a function. If it is a function, that is called to get the value. If the slot is unbound, ~nil~ is returned. - Function: transient-prefix-value obj :: This generic function returns the value of the prefix object {{{var(OBJ)}}}. The respective generic function for infix and suffix objects is named ~transient-infix-value~. - Function: transient-init-scope obj :: This generic function sets the scope of the object {{{var(OBJ)}}}. Methods exist for both prefix and suffix objects. This function is called for all prefix and suffix commands, but unless a concrete method is implemented this falls through to the default implementation, which is a noop. ~transient-set-value~, ~transient-save-value~, ~transient-reset-value~, ~transient--history-key~, ~transient--history-push~ and ~transient--history-init~ are other generic functions dealing with the value of prefix objects. See their doc-strings for more information. ~transient-show-help~ is another generic function implemented for prefix commands. The default method effectively describes the command using ~describe-function~. ** Suffix Methods To get information about the methods implementing these generic functions use ~describe-function~. *** Suffix Value Methods - Function: transient-init-value obj :: This generic function sets the initial value of the object {{{var(OBJ)}}}. Methods exist for both prefix and suffix objects. For ~transient-argument~ objects this function handles setting the value by itself. For other ~transient-suffix~ objects (including ~transient-infix~ objects), this calls ~transient-default-value~ and uses the value returned by that, unless it is the special value ~eieio--unbound~, which indicates that there is no default value. Since that is what the default method for ~transient-suffix~ objects does, both of these functions effectively are noops for these classes. If you implement a class that derives from ~transient-infix~ directly, then you must implement a dedicated method for this function and/or ~transient-default-value~. - Function: transient-default-value obj :: This generic function returns the default value of the object {{{var(OBJ)}}}. Methods exist for both prefix and suffix objects. - Function: transient-infix-read obj :: This generic function determines the new value of the infix object {{{var(OBJ)}}}. This function merely determines the value; ~transient-infix-set~ is used to actually store the new value in the object. For most infix classes this is done by reading a value from the user using the reader specified by the ~reader~ slot (using the ~transient-infix-value~ method described below). For some infix classes the value is changed without reading anything in the minibuffer, i.e., the mere act of invoking the infix command determines what the new value should be, based on the previous value. - Function: transient-prompt obj :: This generic function returns the prompt to be used to read infix object {{{var(OBJ)}}}'s value. - Function: transient-infix-set obj value :: This generic function sets the value of infix object {{{var(OBJ)}}} to {{{var(VALUE)}}}. - Function: transient-infix-value obj :: This generic function returns the value of the suffix object {{{var(OBJ)}}}. This function is called by ~transient-args~ (which see), meaning this function is how the value of a transient is determined so that the invoked suffix command can use it. Currently most values are strings, but that is not set in stone. ~nil~ is not a value, it means “no value”. Usually only infixes have a value, but see the method for ~transient-suffix~. - Function: transient-init-scope obj :: This generic function sets the scope of the object {{{var(OBJ)}}}. Methods exist for both prefix and suffix objects. The scope is actually a property of the transient prefix, not of individual suffixes. However it is possible to invoke a suffix command directly instead of from a transient. In that case, if the suffix expects a scope, then it has to determine that itself and store it in its ~scope~ slot. This function is called for all prefix and suffix commands, but unless a concrete method is implemented, this falls through to the default implementation, which is a noop. *** Suffix Format Methods # Low-level transient--init-suffix-key intentionally left out. - Function: transient-format obj :: This generic function formats and returns {{{var(OBJ)}}} for display. When this function is called, then the current buffer is some temporary buffer. If you need the buffer from which the prefix command was invoked to be current, then do so by temporarily making ~transient--source-buffer~ current. - Function: transient-format-key obj :: This generic function formats {{{var(OBJ)}}}'s ~key~ for display and returns the result. - Function: transient-format-description obj :: This generic function formats {{{var(OBJ)}}}'s ~description~ for display and returns the result. - Function: transient-format-value obj :: This generic function formats {{{var(OBJ)}}}'s value for display and returns the result. - Function: transient-show-help obj :: Show help for the prefix, infix or suffix command represented by {{{var(OBJ)}}}. Regardless of OBJ's type, if its ~show-help~ slot is non-~nil~, that must be a function, which takes OBJ is its only argument. It must prepare, display and return a buffer, and select the window used to display it. The ~transient-show-help-window~ macro is intended for use in such functions. For prefixes, show the info manual, if that is specified using the ~info-manual~ slot. Otherwise, show the manpage if that is specified using the ~man-page~ slot. Otherwise, show the command's documentation string. For suffixes, show the command's documentation string. For infixes, show the manpage if that is specified. Otherwise show the command's documentation string. - Macro: transient-with-help-window &rest body :: Evaluate BODY, send output to ~*Help*~ buffer, and display it in a window. Select the help window, and make the help buffer current and return it. - Function: transient-show-summary obj &optional return :: This generic function shows or, if optional RETURN is non-~nil~, returns a brief summary about the command at point or hovered with the mouse. This function is called when the mouse is moved over a command and (if the value of ~transient-enable-popup-navigation~ is ~verbose~) when the user navigates to a command using the keyboard. If OBJ's ~summary~ slot is a string, that is used. If ~summary~ is a function, that is called with OBJ as the only argument and the returned string is used. If ~summary~ is or returns something other than a string or ~nil~, no summary is shown. If ~summary~ is or returns ~nil~, the first line of the documentation string is used, if any. If RETURN is non-~nil~, this function returns the summary instead of showing it. This is used when a tooltip is needed. ** Prefix Slots *** Value and Scope :PROPERTIES: :UNNUMBERED: notoc :END: - ~default-value~ The default value of the prefix. Use the keyword argument ~:value~ (sic) to set this slot in the definition of a prefix. - ~init-value~ A function that is responsible for setting the object's value. If bound, then this is called with the object as the only argument. Usually this is not bound, in which case the object's primary ~transient-init-value~ method is called instead. - ~history-key~ If multiple prefix commands should share a single value, then this slot has to be set to the same value for all of them. You probably don't want that. - ~incompatible~ A list of lists. Each sub-list specifies a set of mutually exclusive arguments. Enabling one of these arguments causes the others to be disabled. An argument may appear in multiple sub-lists. Arguments must me given in the same form as used in the ~argument~ or ~argument-format~ slot of the respective suffix objects, usually something like ~--switch~ or ~--option=%s~. For options and ~transient-switches~ suffixes it is also possible to match against a specific value, as returned by ~transient-infix-value~, for example, ~--option=one~. - ~scope~ For some transients it might be necessary to have a sort of secondary value, called a “scope”. See ~transient-define-prefix~. *** Behavior :PROPERTIES: :UNNUMBERED: notoc :END: - ~transient-suffix~, ~transient-non-suffix~ and ~transient-switch-frame~ play a part when determining whether the currently active transient prefix command remains active/transient when a suffix or arbitrary non-suffix command is invoked. See [[*Transient State]]. - ~refresh-suffixes~ Normally suffix objects and keymaps are only setup once, when the prefix is invoked. Setting this to ~t~, causes them to be recreated after every command. This is useful when using ~:if...~ predicates, and those need to be rerun for some reason. Doing this is somewhat costly, and there is a risk of losing state, so this is disabled by default and still considered experimental. - ~environment~ A function used to establish an environment while initializing, refreshing or redisplaying a transient prefix menu. This is useful to establish a cache, in case multiple suffixes require the same expensive work. The provided function is called with at least one argument, the function for which it establishes the environment. It must ~funcall~ that function with no arguments. During initialization the second argument is the prefix object being initialized. This slot is still experimental. *** Appearance :PROPERTIES: :UNNUMBERED: notoc :END: - ~display-action~ determines how this prefix is displayed, overriding ~transient-display-buffer-action~. It should have the same type. - ~mode-line-format~ is this prefix's mode line format, overriding ~transient-mode-line-format~. It should have the same type. - ~column-widths~ is only respected inside ~transient-columns~ groups and allows aligning columns across separate instances of that. A list of integers. - ~variable-pitch~ controls whether alignment is done pixel-wise to account for use of variable-pitch characters, which is useful, e.g., when using emoji. *** Documentation :PROPERTIES: :UNNUMBERED: notoc :END: - ~show-help~, ~man-page~ or ~info-manual~ can be used to specify the documentation for the prefix and its suffixes. The command ~transient-help~ uses the function ~transient-show-help~ (which see) to lookup and use these values. - ~suffix-description~ can be used to specify a function which provides fallback descriptions for suffixes that lack a description. This is intended to be temporarily used when implementing of a new prefix command, at which time ~transient-command-summary-or-name~ is a useful value. *** Internal :PROPERTIES: :UNNUMBERED: notoc :END: These slots are mostly intended for internal use. They should not be set in calls to ~transient-define-prefix~. - ~prototype~ When a transient prefix command is invoked, then a clone of that object is stored in the global variable ~transient--prefix~ and the prototype is stored in the clone's ~prototype~ slot. - ~command~ The command, a symbol. Each transient prefix command consists of a command, which is stored in a symbol's function slot and an object, which is stored in the ~transient--prefix~ property of the same symbol. - ~level~ The level of the prefix commands. The suffix commands whose layer is equal or lower are displayed. See [[*Enabling and Disabling Suffixes]]. - ~value~ The likely outdated value of the prefix. Instead of accessing this slot directly you should use the function ~transient-get-value~, which is guaranteed to return the up-to-date value. - ~history~ and ~history-pos~ are used to keep track of historic values. Unless you implement your own ~transient-infix-read~ method you should not have to deal with these slots. - ~unwind-suffix~ is used internally to ensure transient state is properly exited, even in case of an error. ** Suffix Slots Here we document most of the slots that are only available for suffix objects. Some slots are shared by suffix and group objects, they are documented in [[*Predicate Slots]]. Also see [[*Suffix Classes]]. *** Slots of ~transient-child~ :PROPERTIES: :UNNUMBERED: notoc :END: This is the abstract superclass of ~transient-suffix~ and ~transient-group~. This is where the shared ~if*~ and ~inapt-if*~ slots (see [[*Predicate Slots]]), the ~level~ slot (see [[*Enabling and Disabling Suffixes]]), and the ~advice~ and ~advice*~ slots (see [[*Slots of ~transient-suffix~]]) are defined. - ~parent~ The object for the parent group. *** Slots of ~transient-suffix~ :PROPERTIES: :UNNUMBERED: notoc :END: - ~key~ The key, a key vector or a key description string. - ~command~ The command, a symbol. - ~transient~ Whether to stay transient. See [[*Transient State]]. - ~format~ The format used to display the suffix in the menu buffer. It must contain the following %-placeholders: - ~%k~ For the key. - ~%d~ For the description. - ~%v~ For the infix value. Non-infix suffixes don't have a value. - ~description~ The description, either a string or a function, which is called with zero or one argument (the suffix object), and returns a string. - ~face~ Face used for the description. In simple cases it is easier to use this instead of using a function as ~description~ and adding the styling there. ~face~ is appended using ~add-face-text-property~. - ~show-help~ A function used to display help for the suffix. If unspecified, the prefix controls how help is displayed for its suffixes. See also function ~transient-show-help~. - ~summary~ The summary displayed in the echo area, or as a tooltip. If this is ~nil~, which it usually should be, the first line of the documentation string is used instead. See ~transient-show-summary~ for details. - ~definition~ A command, which is used if the body is omitted when defining a command using ~transient-define-suffix~. The following two slots are experimental. They can also be set for a group, in which case they apply to all suffixes in that group, except for suffixes that set the same slot to a non-nil value. - ~advice~ A function used to advise the command. The advise is called using ~(apply advice command args)~, i.e., it behaves like an "around" advice. - ~advice*~ A function used to advise the command. Unlike ~advice~, this advises not only the command body but also its ~interactive~ spec. If both slots are non-nil, ~advice~ is used for the body and ~advice*~ is used for the ~interactive~ form. When advising the ~interactive~ spec, called using ~(funcall advice #'advice-eval-interactive-spec spec)~. *** Slots of ~transient-infix~ :PROPERTIES: :UNNUMBERED: notoc :END: Some of these slots are only meaningful for some of the subclasses. They are defined here anyway to allow sharing certain methods. - ~argument~ The long argument, e.g., ~--verbose~. - ~shortarg~ The short argument, e.g., ~-v~. - ~value~ The value. Should not be accessed directly. - ~init-value~ Function that is responsible for setting the object's value. If bound, then this is called with the object as the only argument. Usually this is not bound, in which case the object's primary ~transient-init-value~ method is called instead. - ~unsavable~ Whether the value of the suffix is not saved as part of the prefixes. - ~multi-value~ For options, whether the option can have multiple values. If this is non-~nil~, then the values are read using ~completing-read-multiple~ by default and if you specify your own reader, then it should read the values using that function or similar. Supported non-~nil~ values are: - Use ~rest~ for an option that can have multiple values. This is useful e.g., for an ~--~ argument that indicates that all remaining arguments are files (such as ~git log -- file1 file2~). In the list returned by ~transient-args~ such an option and its values are represented by a single list of the form ~(ARGUMENT . VALUES)~. - Use ~repeat~ for an option that can be specified multiple times. In the list returned by ~transient-args~ each instance of the option and its value appears separately in the usual from, for example: ~("--another-argument" "--option=first" "--option=second")~. In both cases the option's values have to be specified in the default value of a prefix using the same format as returned by ~transient-args~, e.g., ~("--other" "--o=1" "--o=2" ("--" "f1" "f2"))~. - ~always-read~ For options, whether to read a value on every invocation. If this is ~nil~, then options that have a value are simply unset and have to be invoked a second time to set a new value. - ~allow-empty~ For options, whether the empty string is a valid value. - ~history-key~ The key used to store the history. This defaults to the command name. This is useful when multiple infixes should share the same history because their values are of the same kind. - ~reader~ The function used to read the value of an infix. Not used for switches. The function takes three arguments, {{{var(PROMPT)}}}, {{{var(INITIAL-INPUT)}}} and {{{var(HISTORY)}}}, and must return a string. - ~prompt~ The prompt used when reading the value, either a string or a function that takes the object as the only argument and which returns a prompt string. - ~choices~ A list of valid values, or a function that returns such a list. The latter is not implemented for ~transient-switches~, because I couldn't think of a use-case. How exactly the choices are used varies depending on the class of the suffix. *** Slots of ~transient-variable~ :PROPERTIES: :UNNUMBERED: notoc :END: - ~variable~ The variable. *** Slots of ~transient-switches~ :PROPERTIES: :UNNUMBERED: notoc :END: - ~argument-format~ The display format. Must contain ~%s~, one of the ~choices~ is substituted for that. E.g., ~--%s-order~. - ~argument-regexp~ The regexp used to match any one of the switches. E.g., ~\\(--\\(topo\\|author-date\\|date\\)-order\\)~. ** Predicate Slots Suffix and group objects share two sets of predicate slots that control whether a group or suffix should be available depending on some state. Only one slot from each set can be used at the same time. It is undefined which slot is honored if you use more than one. Predicates from the first group control whether the suffix is present in the menu at all. - ~if~ Enable if predicate returns non-~nil~. - ~if-not~ Enable if predicate returns ~nil~. - ~if-non-nil~ Enable if variable's value is non-~nil~. - ~if-nil~ Enable if variable's value is ~nil~. - ~if-mode~ Enable if major-mode matches value. - ~if-not-mode~ Enable if major-mode does not match value. - ~if-derived~ Enable if major-mode derives from value. - ~if-not-derived~ Enable if major-mode does not derive from value. Predicates from the second group control whether the suffix can be invoked. The suffix is shown in the menu regardless, but when it is considered "inapt", then it is grayed out to indicated that it currently cannot be invoked. - ~inapt-if~ Inapt if predicate returns non-~nil~. - ~inapt-if-not~ Inapt if predicate returns ~nil~. - ~inapt-if-non-nil~ Inapt if variable's value is non-~nil~. - ~inapt-if-nil~ Inapt if variable's value is ~nil~. - ~inapt-if-mode~ Inapt if major-mode matches value. - ~inapt-if-not-mode~ Inapt if major-mode does not match value. - ~inapt-if-derived~ Inapt if major-mode derives from value. - ~inapt-if-not-derived~ Inapt if major-mode does not derive from value. By default these predicates run when the prefix command is invoked, but this can be changes, using the ~refresh-suffixes~ prefix slot. See [[*Prefix Slots]]. One more slot is shared between group and suffix classes, ~level~. Like the slots documented above, it is a predicate, but it is used for a different purpose. The value has to be an integer between 1 and 7. ~level~ controls whether a suffix or a group should be available depending on user preference. See [[*Enabling and Disabling Suffixes]]. * FAQ :PROPERTIES: :APPENDIX: t :END: ** Can I control how the menu buffer is displayed? :PROPERTIES: :UNNUMBERED: notoc :END: Yes, see ~transient-display-buffer-action~ in [[*Configuration]]. You can also control how the menu buffer is displayed on a case-by-case basis by passing ~:display-action~ to ~transient-define-prefix~. ** How can I copy text from the menu buffer? :PROPERTIES: :UNNUMBERED: notoc :END: To be able to mark text in Transient's menu buffer using the mouse, you have to add the below binding. Note that for technical reasons, the region won't be visualized, while doing so. After you have quit the transient menu, you will be able to yank it in another buffer. #+begin_src emacs-lisp (keymap-set transient-predicate-map "" #'transient--do-stay) #+end_src ** How can I autoload prefix and suffix commands? :PROPERTIES: :UNNUMBERED: notoc :END: If your package only supports Emacs 30, just prefix the definition with ~;;;###autoload~. If your package supports released versions of Emacs, you unfortunately have to use a long form autoload comment as described in [[info:elisp#Autoload]]. #+begin_src emacs-lisp ;;;###autoload (autoload 'magit-dispatch "magit" nil t) (transient-define-prefix magit-dispatch () ...) #+end_src ** How does Transient compare to prefix keys and universal arguments? :PROPERTIES: :UNNUMBERED: notoc :END: See https://github.com/magit/transient/wiki/Comparison-with-prefix-keys-and-universal-arguments. ** How does Transient compare to Magit-Popup and Hydra? :PROPERTIES: :UNNUMBERED: notoc :END: See https://github.com/magit/transient/wiki/Comparison-with-other-packages. ** Why does {{{kbd(q)}}} not quit popups anymore? :PROPERTIES: :UNNUMBERED: notoc :END: I agree that {{{kbd(q)}}} is a good binding for commands that quit something. This includes quitting whatever transient is currently active, but it also includes quitting whatever it is that some specific transient is controlling. The transient ~magit-blame~ for example binds {{{kbd(q)}}} to the command that turns ~magit-blame-mode~ off. So I had to decide if {{{kbd(q)}}} should quit the active transient (like Magit-Popup used to) or whether {{{kbd(C-g)}}} should do that instead, so that {{{kbd(q)}}} could be bound in individual transient to whatever commands make sense for them. Because all other letters are already reserved for use by individual transients, I have decided to no longer make an exception for {{{kbd(q)}}}. If you want to get {{{kbd(q)}}}'s old binding back then you can do so. Doing that is a bit more complicated than changing a single key binding, so I have implemented a function, ~transient-bind-q-to-quit~ that makes the necessary changes. See its documentation string for more information. * Keystroke Index :PROPERTIES: :APPENDIX: t :INDEX: ky :COOKIE_DATA: recursive :END: * Command and Function Index :PROPERTIES: :APPENDIX: t :INDEX: fn :END: * Variable Index :PROPERTIES: :APPENDIX: t :INDEX: vr :END: * Concept Index :PROPERTIES: :APPENDIX: t :INDEX: cp :END: * GNU General Public License :PROPERTIES: :APPENDIX: t :END: #+texinfo: @include gpl.texi * Copying :PROPERTIES: :COPYING: t :END: #+begin_quote Copyright (C) 2018--{{{year}}} Free Software Foundation, Inc. You can redistribute this document and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This document is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. #+end_quote # LocalWords: ARGLIST ARGS CLI DOCSTRING ELEMENTs EVAL GROUPs Infixes # LocalWords: Infixes KEYWORDs LOC LocalWords MERCHANTABILITY Magit # LocalWords: Magit's Makefile OBJ OBJ's Pre alist arglist # LocalWords: args autoloaded boolean booleans customizable docstring # LocalWords: eval featurep infixes init isearch keymap keymaps loc # LocalWords: magit manpage minibuffer monospaced ness nilly noop noops # LocalWords: plist pre prev rebase redisplay src subclass subclasses # LocalWords: subcommands subprocess superclass tooltip termcap utils # IMPORTANT: Also update ORG_ARGS and ORG_EVAL in the Makefile. # Local Variables: # indent-tabs-mode: nil # org-hide-macro-markers: t # org-src-preserve-indentation: nil # End: transient-0.8.8/docs/transient.texi000066400000000000000000003450351500463237300174050ustar00rootroot00000000000000\input texinfo @c -*- texinfo -*- @c %**start of header @setfilename transient.info @settitle Transient User and Developer Manual @documentencoding UTF-8 @documentlanguage en @c %**end of header @copying @quotation Copyright (C) 2018--2025 Free Software Foundation, Inc. You can redistribute this document and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This document is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU General Public License for more details. @end quotation @end copying @dircategory Emacs misc features @direntry * Transient: (transient). Transient Commands. @end direntry @finalout @titlepage @title Transient User and Developer Manual @subtitle for version 0.8.8 @author Jonas Bernoulli @page @vskip 0pt plus 1filll @insertcopying @end titlepage @contents @ifnottex @node Top @top Transient User and Developer Manual Transient is the library used to implement the keyboard-driven ``menus'' in Magit. It is distributed as a separate package, so that it can be used to implement similar menus in other packages. This manual can be bit hard to digest when getting started. A useful resource to get over that hurdle is Psionic K's interactive tutorial, available at @uref{https://github.com/positron-solutions/transient-showcase}. @noindent This manual is for Transient version 0.8.8. @insertcopying @end ifnottex @menu * Introduction:: * Usage:: * Modifying Existing Transients:: * Defining New Commands:: * Classes and Methods:: * FAQ:: * Keystroke Index:: * Command and Function Index:: * Variable Index:: * Concept Index:: * GNU General Public License:: @detailmenu --- The Detailed Node Listing --- Usage * Invoking Transients:: * Aborting and Resuming Transients:: * Common Suffix Commands:: * Saving Values:: * Using History:: * Getting Help for Suffix Commands:: * Enabling and Disabling Suffixes:: * Other Commands:: * Configuration:: Defining New Commands * Technical Introduction:: * Defining Transients:: * Binding Suffix and Infix Commands:: * Defining Suffix and Infix Commands:: * Using Infix Arguments:: * Using Prefix Scope:: * Current Suffix Command:: * Current Prefix Command:: * Transient State:: Classes and Methods * Group Classes:: * Group Methods:: * Prefix Classes:: * Suffix Classes:: * Prefix Methods:: * Suffix Methods:: * Prefix Slots:: * Suffix Slots:: * Predicate Slots:: @end detailmenu @end menu @node Introduction @chapter Introduction Transient is the library used to implement the keyboard-driven @dfn{menus} in Magit. It is distributed as a separate package, so that it can be used to implement similar menus in other packages. This manual can be bit hard to digest when getting started. A useful resource to get over that hurdle is Psionic K's interactive tutorial, available at @uref{https://github.com/positron-solutions/transient-showcase}. @anchor{Some things that Transient can do} @heading Some things that Transient can do @itemize @item Display current state of arguments @item Display and manage lifecycle of modal bindings @item Contextual user interface @item Flow control for wizard-like composition of interactive forms @item History & persistence @item Rendering arguments for controlling CLI programs @end itemize @anchor{Complexity in CLI programs} @heading Complexity in CLI programs Complexity tends to grow with time. How do you manage the complexity of commands? Consider the humble shell command @samp{ls}. It now has over @emph{fifty} command line options. Some of these are boolean flags (@samp{ls -l}). Some take arguments (@samp{ls --sort=s}). Some have no effect unless paired with other flags (@samp{ls -lh}). Some are mutually exclusive. Some shell commands even have so many options that they introduce @emph{subcommands} (@samp{git branch}, @samp{git commit}), each with their own rich set of options (@samp{git branch -f}). @anchor{Using Transient for composing interactive commands} @heading Using Transient for composing interactive commands What about Emacs commands used interactively? How do these handle options? One solution is to make many versions of the same command, so you don't need to! Consider: @samp{delete-other-windows} vs. @samp{delete-other-windows-vertically} (among many similar examples). Some Emacs commands will simply prompt you for the next "argument" (@samp{M-x switch-to-buffer}). Another common solution is to use prefix arguments which usually start with @samp{C-u}. Sometimes these are sensibly numerical in nature (@samp{C-u 4 M-x forward-paragraph} to move forward 4 paragraphs). But sometimes they function instead as boolean "switches" (@samp{C-u C-SPACE} to jump to the last mark instead of just setting it, @samp{C-u C-u C-SPACE} to unconditionally set the mark). Since there aren't many standards for the use of prefix options, you have to read the command's documentation to find out what the possibilities are. But when an Emacs command grows to have a truly large set of options and arguments, with dependencies between them, lots of option values, etc., these simple approaches just don't scale. Transient is designed to solve this issue. Think of it as the humble prefix argument @samp{C-u}, @emph{raised to the power of 10}. Like @samp{C-u}, it is key driven. Like the shell, it supports boolean "flag" options, options that take arguments, and even "sub-commands", with their own options. But instead of searching through a man page or command documentation, well-designed transients @emph{guide} their users to the relevant set of options (and even their possible values!) directly, taking into account any important pre-existing Emacs settings. And while for shell commands like @samp{ls}, there is only one way to "execute" (hit @samp{Return}!), transients can "execute" using multiple different keys tied to one of many self-documenting @emph{actions} (imagine having 5 different colored return keys on your keyboard!). Transients make navigating and setting large, complex groups of command options and arguments easy. Fun even. Once you've tried it, it's hard to go back to the @samp{C-u what can I do here again?} way. @node Usage @chapter Usage @menu * Invoking Transients:: * Aborting and Resuming Transients:: * Common Suffix Commands:: * Saving Values:: * Using History:: * Getting Help for Suffix Commands:: * Enabling and Disabling Suffixes:: * Other Commands:: * Configuration:: @end menu @node Invoking Transients @section Invoking Transients @cindex invoking transients A transient prefix command is invoked like any other command by pressing the key that is bound to that command. The main difference to other commands is that a transient prefix command activates a transient keymap, which temporarily binds the transient's infix and suffix commands, and that those bindings are shown in menu buffer, which is displayed in a new window, until the menu is exited. Bindings from other keymaps may, or may not, be disabled while the transient state is in effect. There are two kinds of commands that are available after invoking a transient prefix command; infix and suffix commands. Infix commands set some value (which is then shown in the menu buffer), without leaving the transient. Suffix commands, on the other hand, usually quit the transient and they may use the values set by the infix commands, i.e., the infix @strong{arguments}. Instead of setting arguments to be used by a suffix command, infix commands may also set some value by side-effect, e.g., by setting the value of some variable. @node Aborting and Resuming Transients @section Aborting and Resuming Transients @cindex aborting transients @cindex resuming transients @cindex quit transient To quit the transient without invoking a suffix command press @kbd{C-g}. Key bindings in transient keymaps may be longer than a single event. After pressing a valid prefix key, all commands whose bindings do not begin with that prefix key are temporarily unavailable and grayed out. To abort the prefix key press @kbd{C-g} (which in this case only quits the prefix key, but not the complete transient). A transient prefix command can be bound as a suffix of another transient. Invoking such a suffix replaces the current transient state with a new transient state, i.e., the available bindings change and the information displayed in the menu buffer is updated accordingly. Pressing @kbd{C-g} while a nested transient is active only quits the innermost transient, causing a return to the previous transient. @kbd{C-q} or @kbd{C-z} on the other hand always exits all transients. If you use the latter, then you can later resume the stack of transients using @kbd{M-x transient-resume}. @table @asis @item @kbd{C-g} (@code{transient-quit-seq}) @itemx @kbd{C-g} (@code{transient-quit-one}) @kindex C-g @kindex C-g @findex transient-quit-seq @findex transient-quit-one This key quits the currently active incomplete key sequence, if any, or else the current transient. When quitting the current transient, it returns to the previous transient, if any. @end table Transient's predecessor bound @kbd{q} instead of @kbd{C-g} to the quit command. To learn how to get that binding back see @code{transient-bind-q-to-quit}'s documentation string. @table @asis @item @kbd{C-q} (@code{transient-quit-all}) @kindex C-q @findex transient-quit-all This command quits the currently active incomplete key sequence, if any, and all transients, including the active transient and all suspended transients, if any. @item @kbd{C-z} (@code{transient-suspend}) @kindex C-z @findex transient-suspend Like @code{transient-quit-all}, this command quits an incomplete key sequence, if any, and all transients. Additionally, it saves the stack of transients so that it can easily be resumed (which is particularly useful if you quickly need to do ``something else'' and the stack is deeper than a single transient, and/or you have already changed the values of some infix arguments). Note that only a single stack of transients can be saved at a time. If another stack is already saved, then saving a new stack discards the previous stack. @item @kbd{M-x transient-resume} @findex transient-resume This command resumes the previously suspended stack of transients, if any. @end table @node Common Suffix Commands @section Common Suffix Commands @cindex common suffix commands A few shared suffix commands are available in all transients. These suffix commands are not shown permanently in every menu by default. Most of these commands share a common prefix key and pressing that key causes the common commands to be temporarily shown in the active menu. @defopt transient-show-common-commands This option controls whether shared suffix commands are permanently shown alongside the menu-specific infix and suffix commands. By default, the shared commands are not permanently shown to avoid wasting precious space and overwhelming the user with too many choices. If you prefer to always see these commands, then set this option to a non-@code{nil} value. Alternatively the value can be toggled for the current Emacs session only, using @code{transient-toggle-common}, described below. @end defopt @defopt transient-common-command-prefix This option specifies the prefix key used in all transient menus to invoke most of the shared commands, which are available in all transient menus. By default these bindings are only shown after pressing that prefix key and before following that up with a valid key binding (but see the previous option). For historic reasons @kbd{C-x} is used by default, but users are encouraged to pick another key, preferably one that is not commonly used in Emacs but is still convenient to them. Usually, while a transient menu is active, the user cannot invoke commands that are not bound in the menu itself. For those menus it does not matter, if @kbd{C-x} or another commonly used prefix key is used for common menu commands. However, certain other, newer menus do not suppress key bindings established outside the menu itself, and in those cases a binding for a common menu command could shadow an external binding. For example, @kbd{C-x C-s} could not be used to invoke @code{save-buffer}, if that binding is shadowed by the menu binding for @code{transient-save}. Which key is most suitable depends on the user's preferences, but good choices may include function keys and @kbd{C-z} (for many keyboard layouts @kbd{z} is right next to @kbd{x}, and invoking @code{suspend-frame}, while a transient menu is active, would not be a good idea anyway). @end defopt @table @asis @item @kbd{C-x t} (@code{transient-toggle-common}) @kindex C-x t @findex transient-toggle-common This command toggles whether the generic commands, that are common to all transients, are permanently displayed or only after typing the incomplete prefix key sequence@kbd{}. This only affects the current Emacs session. @end table The other common commands are described in either the previous or in one of the following sections. @node Saving Values @section Saving Values @cindex saving values of arguments After setting the infix arguments in a transient, the user can save those arguments for future invocations. Most transients will start out with the saved arguments when they are invoked. There are a few exceptions, though. Some transients are designed so that the value that they use is stored externally as the buffer-local value of some variable. Invoking such a transient again uses the buffer-local value. @footnote{@code{magit-diff} and @code{magit-log} are two prominent examples, and their handling of buffer-local values is actually a bit more complicated than outlined above and even customizable.} If the user does not save the value and just exits using a regular suffix command, then the value is merely saved to the transient's history. That value won't be used when the transient is next invoked, but it is easily accessible (see @ref{Using History}). Option @code{transient-common-command-prefix} controls the prefix key used in the following bindings. For simplicity's sake the default, @kbd{C-x}, is shown below. @table @asis @item @kbd{C-x s} (@code{transient-set}) @kindex C-x s @findex transient-set This command saves the value of the active transient for this Emacs session. @item @kbd{C-x C-s} (@code{transient-save}) @kindex C-x C-s @findex transient-save This command saves the value of the active transient persistently across Emacs sessions. @item @kbd{C-x C-k} (@code{transient-reset}) @kindex C-x C-k @findex transient-reset This command clears the set and saved values of the active transient. @end table @defopt transient-values-file This option names the file that is used to persist the values of transients between Emacs sessions. @end defopt @node Using History @section Using History @cindex value history Every time the user invokes a suffix command the transient's current value is saved to its history. These values can be cycled through, the same way one can cycle through the history of commands that read user-input in the minibuffer. Option @code{transient-common-command-prefix} controls the prefix key used in the following bindings. For simplicity's sake the default, @kbd{C-x}, is shown below. @table @asis @item @kbd{C-M-p} (@code{transient-history-prev}) @itemx @kbd{C-x p} @kindex C-M-p @kindex C-x p @findex transient-history-prev This command switches to the previous value used for the active transient. @item @kbd{C-M-n} (@code{transient-history-next}) @itemx @kbd{C-x n} @kindex C-M-n @kindex C-x n @findex transient-history-next This command switches to the next value used for the active transient. @end table In addition to the transient-wide history, infixes can have their own history. When an infix reads user-input using the minibuffer, the user can use the regular minibuffer history commands to cycle through previously used values. Usually the same keys as those mentioned above are bound to those commands. Authors of transients should arrange for different infix commands that read the same kind of value to also use the same history key (see @ref{Suffix Slots}). Both kinds of history are saved to a file when Emacs is exited. @defopt transient-save-history This option controls whether the history of transient commands is saved when exiting Emacs. @end defopt @defopt transient-history-file This option names the file that is used to persist the history of transients and their infixes between Emacs sessions. @end defopt @defopt transient-history-limit This option controls how many history elements are kept at the time the history is saved in @code{transient-history-file}. @end defopt @node Getting Help for Suffix Commands @section Getting Help for Suffix Commands @cindex getting help Transients can have many suffixes and infixes that the user might not be familiar with. To make it trivial to get help for these, Transient provides access to the documentation directly from the active transient. @table @asis @item @kbd{C-h} (@code{transient-help}) @kindex C-h @findex transient-help This command enters help mode. When help mode is active, typing a key shows information about the suffix command that the key normally is bound to (instead of invoking it). Pressing @kbd{C-h} a second time shows information about the @emph{prefix} command. After typing a key, the stack of transient states is suspended and information about the suffix command is shown instead. Typing @kbd{q} in the help buffer buries that buffer and resumes the transient state. @end table What sort of documentation is shown depends on how the transient was defined. For infix commands that represent command-line arguments this ideally shows the appropriate manpage. @code{transient-help} then tries to jump to the correct location within that. Info manuals are also supported. The fallback is to show the command's documentation string, for non-infix suffixes this is usually appropriate. @node Enabling and Disabling Suffixes @section Enabling and Disabling Suffixes @cindex enabling suffixes @cindex disabling suffixes The user base of a package that uses transients can be very diverse. This is certainly the case for Magit; some users have been using it and Git for a decade, while others are just getting started now. @cindex levels For that reason a mechanism is needed that authors can use to classify a transient's infixes and suffixes along the essentials@dots{}everything spectrum. We use the term @dfn{levels} to describe that mechanism. @cindex transient-level Each suffix command is placed on a level and each transient has a level (called @dfn{transient-level}), which controls which suffix commands are available. Integers between 1 and 7 (inclusive) are valid levels. For suffixes, 0 is also valid; it means that the suffix is not displayed at any level. The levels of individual transients and/or their individual suffixes can be changed interactively, by invoking the menu and entering its ``edit'' mode using the command @code{transient-set-level}, as described below. The default level for both transients and their suffixes is 4. The @code{transient-default-level} option only controls the default for transients. The default suffix level is always 4. The authors of transients should place certain suffixes on a higher level, if they expect that it won't be of use to most users, and they should place very important suffixes on a lower level, so that they remain available even if the user lowers the transient level. @defopt transient-default-level This option controls which suffix levels are made available by default. It sets the transient-level for transients for which the user has not set that individually. @end defopt @defopt transient-levels-file This option names the file that is used to persist the levels of transients and their suffixes between Emacs sessions. @end defopt Option @code{transient-common-command-prefix} controls the prefix key used in the following bindings. For simplicity's sake the default, @kbd{C-x}, is shown below. @table @asis @item @kbd{C-x l} (@code{transient-set-level}) @kindex C-x l @findex transient-set-level This command enters edit mode. When edit mode is active, then all infixes and suffixes that are currently usable are displayed along with their levels. The colors of the levels indicate whether they are enabled or not. The level of the transient is also displayed along with some usage information. In edit mode, pressing the key that would usually invoke a certain suffix instead prompts the user for the level that suffix should be placed on. Help mode is available in edit mode. To change the transient level press @kbd{C-x l} again. To exit edit mode press @kbd{C-g}. Note that edit mode does not display any suffixes that are not currently usable. @code{magit-rebase}, for example, shows different suffixes depending on whether a rebase is already in progress or not. The predicates also apply in edit mode. Therefore, to control which suffixes are available given a certain state, you have to make sure that that state is currently active. @item @kbd{C-x a} (@code{transient-toggle-level-limit}) @kindex C-x a @findex transient-toggle-level-limit This command toggle whether suffixes that are on levels higher than the level specified by @code{transient-default-level} are temporarily available anyway. @end table @defun transient-set-default-level suffix level This function sets the default level of the suffix COMMAND to LEVEL@. If a suffix command appears in multiple menus, it may make sense to consistently change its level in all those menus at once. For example, the @code{--gpg-sign} argument (which is implemented using the command @code{magit:--gpg-sign}), is bound in all of Magit's menu which create commits. Users who sometimes sign their commits would want that argument to be available in all of these menus, while for users who never sign it is just unnecessary noise in any menus. To always make @code{--gpg-sign} available, use: @lisp (transient-set-default-level 'magit:--gpg-sign 1) @end lisp To never make @code{--gpg-sign} available, use: @lisp (transient-set-default-level 'magit:--gpg-sign 0) @end lisp This sets the level in the suffix prototype object for this command. Commands only have a suffix prototype if they were defined using one of @code{transient-define-argument}, @code{transient-define-infix} and @code{transient-define-suffix}. For all other commands this would signal an error. (This is one of the reasons why package authors should use one of these functions to define shared suffix commands, and especially shared arguments.) If the user changes the level of a suffix in a particular menu, using @kbd{C-x l} as shown above, then that obviously shadows the default. It is also possible to set the level of a suffix binding in a particular menu, either when defining the menu using @code{transient-define-prefix,} or later using @code{transient-insert-suffix}. If such bindings specify a level, then that also overrides the default. (Per-suffix default levels is a new feature, so you might encounter this quite often.) @end defun @node Other Commands @section Other Commands When invoking a transient in a small frame, the transient window may not show the complete buffer, making it necessary to scroll, using the following commands. These commands are never shown in the transient window, and the key bindings are the same as for @code{scroll-up-command} and @code{scroll-down-command} in other buffers. @deffn Command transient-scroll-up arg This command scrolls text of transient's menu window upward @var{ARG} lines. If @var{ARG} is @code{nil}, then it scrolls near full screen. This is a wrapper around @code{scroll-up-command} (which see). @end deffn @deffn Command transient-scroll-down arg This command scrolls text of transient's menu window down @var{ARG} lines. If @var{ARG} is @code{nil}, then it scrolls near full screen. This is a wrapper around @code{scroll-down-command} (which see). @end deffn The following commands are not available by default. If you would like to use them for all menus, bind them in @code{transient-map}. @deffn Command transient-copy-menu-text This command copies the contents of the menu buffer to the kill ring. @end deffn @deffn Command transient-toggle-docstrings This command toggle between showing suffix descriptions in the menu (as usual) or showing the first lines of the respective docstrings in their place. For commands that do not have a docstring, always display the suffix description. Because there likely isn't enough room to display multiple docstrings side-by-side, a single column is used when displaying docstrings. @end deffn @node Configuration @section Configuration More options are described in @ref{Common Suffix Commands}, in @ref{Saving Values}, in @ref{Using History} and in @ref{Enabling and Disabling Suffixes}. @anchor{Essential Options} @subheading Essential Options Two more essential options are documented in @ref{Common Suffix Commands}. @defopt transient-show-popup This option controls whether and when transient's menu buffer is shown. @itemize @item If @code{t} (the default), then the buffer is shown as soon as a transient prefix command is invoked. @item If @code{nil}, then the buffer is not shown unless the user explicitly requests it, by pressing an incomplete prefix key sequence. @item If a number, then the a brief one-line summary is shown instead of the menu buffer. If zero or negative, then not even that summary is shown; only the pressed key itself is shown. The buffer is shown once the user explicitly requests it by pressing an incomplete prefix key sequence. Unless this is zero, the menu is shown after that many seconds of inactivity (using the absolute value). @end itemize @end defopt @defopt transient-show-during-minibuffer-read This option controls whether the transient menu continues to be displayed while the minibuffer is used to read user input. This is only relevant to commands that do not close the menu, such as commands that set infix arguments. If a command exits the menu, and uses the minibuffer, then the menu is always closed before the minibuffer is entered, irrespective of the value of this option. When @code{nil} (the default), hide the menu while the minibuffer is in use. When @code{t}, keep showing the menu, but allow for the menu window to be resized, to ensure that completion candidates can be displayed. When @code{fixed}, keep showing the menu and prevent it from being resized, which may make it impossible to display the completion candidates. If that ever happens for you, consider using @code{t} or an integer, as described below. If the value is @code{fixed} and the menu window uses the full height of its frame, then the former is ignored and resizing is allowed anyway. This is necessary because individual menus may use unusual display actions different from what @code{transient-display-buffer-action} specifies (likely to display that menu in a side-window). When using a third-party mode, which automatically resizes windows (e.g., by calling @code{balance-windows} on @code{post-command-hook}), then @code{fixed} (or @code{nil}) is likely a better choice than @code{t}. The value can also be an integer, in which case the behavior depends on whether at least that many lines are left to display windows other than the menu window. If that is the case, display the menu and preserve the size of that window. Otherwise, allow resizing the menu window if the number is positive, or hide the menu if it is negative. @end defopt @defopt transient-read-with-initial-input This option controls whether the last history element is used as the initial minibuffer input when reading the value of an infix argument from the user. If @code{nil}, there is no initial input and the first element has to be accessed the same way as the older elements. @end defopt @defopt transient-enable-popup-navigation This option controls whether navigation commands are enabled in transient's menu buffer. If the value is @code{verbose} (the default), brief documentation about the command under point is additionally show in the echo area. While a transient is active the menu buffer is not the current buffer, making it necessary to use dedicated commands to act on that buffer itself. If this option is non-@code{nil}, then the following features are available: @itemize @item @kbd{@key{UP}} moves the cursor to the previous suffix. @item @kbd{@key{DOWN}} moves the cursor to the next suffix. @item @kbd{M-@key{RET}} invokes the suffix the cursor is on. @item @kbd{mouse-1} invokes the clicked on suffix. @item @kbd{C-s} and @kbd{C-r} start isearch in the menu buffer. @end itemize By default @kbd{M-@key{RET}} is bound to @code{transient-push-button}, instead of @kbd{@key{RET}}, because if a transient allows the invocation of non-suffixes, then it is likely, that you would want @kbd{@key{RET}} to do what it would do if no transient were active." @end defopt @defopt transient-display-buffer-action This option specifies the action used to display the transient's menu buffer. The menu buffer is displayed in a window using @code{(display-buffer @var{BUFFER} transient-display-buffer-action)}. The value of this option has the form @code{(@var{FUNCTION} . @var{ALIST})}, where @var{FUNCTION} is a function or a list of functions. Each such function should accept two arguments: a buffer to display and an alist of the same form as @var{ALIST}. See @ref{Choosing Window,,,elisp,}, for details. The default is: @lisp (display-buffer-in-side-window (side . bottom) (dedicated . t) (inhibit-same-window . t)) @end lisp This displays the window at the bottom of the selected frame. For alternatives see @ref{Buffer Display Action Functions,,,elisp,}, and @ref{Buffer Display Action Alists,,,elisp,}. When you switch to a different ACTION, you should keep the ALIST entries for @code{dedicated} and @code{inhibit-same-window} in most cases. Do not drop them because you are unsure whether they are needed; if you are unsure, then keep them. Note that the buffer that was current before the transient buffer is shown should remain the current buffer. Many suffix commands act on the thing at point, if appropriate, and if the transient buffer became the current buffer, then that would change what is at point. To that effect @code{inhibit-same-window} ensures that the selected window is not used to show the transient buffer. It may be possible to display the window in another frame, but whether that works in practice depends on the window-manager. If the window manager selects the new window (Emacs frame), then that unfortunately changes which buffer is current. If you change the value of this option, then you might also want to change the value of @code{transient-mode-line-format}. This user option may be overridden if @code{:display-action} is passed when creating a new prefix with @code{transient-define-prefix}. @end defopt @anchor{Accessibility Options} @subheading Accessibility Options @defopt transient-force-single-column This option controls whether the use of a single column to display suffixes is enforced. This might be useful for users with low vision who use large text and might otherwise have to scroll in two dimensions. @end defopt @anchor{Auxiliary Options} @subheading Auxiliary Options @defopt transient-mode-line-format This option controls whether transient's menu buffer has a mode-line, separator line, or neither. If @code{nil}, then the buffer has no mode-line. If the buffer is not displayed right above the echo area, then this probably is not a good value. If @code{line} (the default) or a natural number, then the buffer has no mode-line, but a line is drawn in its place. If a number is used, that specifies the thickness of the line. On termcap frames we cannot draw lines, so there @code{line} and numbers are synonyms for @code{nil}. The color of the line is used to indicate if non-suffixes are allowed and whether they exit the transient. The foreground color of @code{transient-key-noop} (if non-suffixes are disallowed), @code{transient-key-stay} (if allowed and transient stays active), or @code{transient-key-exit} (if allowed and they exit the transient) is used to draw the line. This user option may be overridden if @code{:mode-line-format} is passed when creating a new prefix with @code{transient-define-prefix}. Otherwise this can be any mode-line format. See @ref{Mode Line Format,,,elisp,}, for details. @end defopt @defopt transient-semantic-coloring This option controls whether colors are used to indicate the transient behavior of commands. If non-@code{nil}, then the key binding of each suffix is colorized to indicate whether it exits the transient state or not. The color of the prefix is indicated using the line that is drawn when the value of @code{transient-mode-line-format} is @code{line}. @end defopt @defopt transient-highlight-mismatched-keys This option controls whether key bindings of infix commands that do not match the respective command-line argument should be highlighted. For other infix commands this option has no effect. When this option is non-@code{nil}, the key binding for an infix argument is highlighted when only a long argument (e.g., @code{--verbose}) is specified but no shorthand (e.g., @code{-v}). In the rare case that a shorthand is specified but the key binding does not match, then it is highlighted differently. Highlighting mismatched key bindings is useful when learning the arguments of the underlying command-line tool; you wouldn't want to learn any short-hands that do not actually exist. The highlighting is done using one of the faces @code{transient-mismatched-key} and @code{transient-nonstandard-key}. @end defopt @defopt transient-substitute-key-function This function is used to modify key bindings. If the value of this option is @code{nil} (the default), then no substitution is performed. This function is called with one argument, the prefix object, and must return a key binding description, either the existing key description it finds in the @code{key} slot, or the key description that replaces the prefix key. It could be used to make other substitutions, but that is discouraged. For example, @kbd{=} is hard to reach using my custom keyboard layout, so I substitute @kbd{(} for that, which is easy to reach using a layout optimized for lisp. @lisp (setq transient-substitute-key-function (lambda (obj) (let ((key (oref obj key))) (if (string-match "\\`\\(=\\)[a-zA-Z]" key) (replace-match "(" t t key 1) key)))) @end lisp @end defopt @defopt transient-align-variable-pitch This option controls whether columns are aligned pixel-wise in the menu buffer. If this is non-@code{nil}, then columns are aligned pixel-wise to support variable-pitch fonts. Keys are not aligned, so you should use a fixed-pitch font for the @code{transient-key} face. Other key faces inherit from that face unless a theme is used that breaks that relationship. This option is intended for users who use a variable-pitch font for the @code{default} face. @end defopt @defopt transient-force-fixed-pitch This option controls whether to force the use of a monospaced font in menu buffer. Even if you use a proportional font for the @code{default} face, you might still want to use a monospaced font in the menu buffer. Setting this option to @code{t} causes @code{default} to be remapped to @code{fixed-pitch} in that buffer. @end defopt @anchor{Developer Options} @subheading Developer Options These options are mainly intended for developers. @defopt transient-detect-key-conflicts This option controls whether key binding conflicts should be detected at the time the transient is invoked. If so, this results in an error, which prevents the transient from being used. Because of that, conflicts are ignored by default. Conflicts cannot be determined earlier, i.e., when the transient is being defined and when new suffixes are being added, because at that time there can be false-positives. It is actually valid for multiple suffixes to share a common key binding, provided the predicates of those suffixes prevent that more than one of them is enabled at a time. @end defopt @defopt transient-error-on-insert-failure This option controls whether to signal an error when @code{transient-insert-suffix} or @code{transient-append-suffix} failed to insert a suffix into an existing prefix. By default a warning is shown instead. @end defopt @defopt transient-highlight-higher-levels This option controls whether suffixes that would not be available by default are highlighted. When non-@code{nil} then the descriptions of suffixes are highlighted if their level is above 4, the default of @code{transient-default-level}. Assuming you have set that variable to 7, this highlights all suffixes that won't be available to users without them making the same customization. @end defopt @anchor{Hook Variables} @subheading Hook Variables @defvar transient-exit-hook This hook is run after a transient menu is exited, even if another transient menu becomes active at the same time. @end defvar @defvar transient-post-exit-hook This hook is run after a transient menu is exited, provided no other transient menu becomes active at the same time. @end defvar @defvar transient-setup-buffer-hook This hook is run when the transient buffer is being setup. That buffer is current and empty when this hook is runs. @end defvar @node Modifying Existing Transients @chapter Modifying Existing Transients @cindex modifying existing transients To an extent, transients can be customized interactively, see @ref{Enabling and Disabling Suffixes}. This section explains how existing transients can be further modified non-interactively. Let's begin with an example: @lisp (transient-append-suffix 'magit-patch-apply "-3" '("-R" "Apply in reverse" "--reverse")) @end lisp This inserts a new infix argument to toggle the @code{--reverse} argument after the infix argument that toggles @code{-3} in @code{magit-patch-apply}. The following functions share a few arguments: @itemize @item @var{PREFIX} is a transient prefix command, a symbol. @item @var{SUFFIX} is a transient infix or suffix specification in the same form as expected by @code{transient-define-prefix}. Note that an infix is a special kind of suffix. Depending on context ``suffixes'' means ``suffixes (including infixes)'' or ``non-infix suffixes''. Here it means the former. See @ref{Suffix Specifications}. @var{SUFFIX} may also be a group in the same form as expected by @code{transient-define-prefix}. See @ref{Group Specifications}. @item @var{LOC} is a command, a key vector, a key description (a string as returned by @code{key-description}), or a list specifying coordinates (the last element may also be a command or key). For example @code{(1 0 -1)} identifies the last suffix (@code{-1}) of the first subgroup (@code{0}) of the second group (@code{1}). If @var{LOC} is a list of coordinates, then it can be used to identify a group, not just an individual suffix command. The function @code{transient-get-suffix} can be useful to determine whether a certain coordination list identifies the suffix or group that you expect it to identify. In hairy cases it may be necessary to look at the definition of the transient prefix command. @end itemize These functions operate on the information stored in the @code{transient--layout} property of the @var{PREFIX} symbol. Suffix entries in that tree are not objects but have the form @code{(@var{LEVEL} @var{CLASS} @var{PLIST})}, where @var{PLIST} should set at least @code{:key}, @code{:description} and @code{:command}. @defun transient-insert-suffix prefix loc suffix &optional keep-other @end defun @defun transient-append-suffix prefix loc suffix &optional keep-other These functions insert the suffix or group @var{SUFFIX} into @var{PREFIX} before or after @var{LOC}. Conceptually adding a binding to a transient prefix is similar to adding a binding to a keymap, but this is complicated by the fact that multiple suffix commands can be bound to the same key, provided they are never active at the same time, see @ref{Predicate Slots}. Unfortunately both false-positives and false-negatives are possible. To deal with the former use non-@code{nil} @var{KEEP-OTHER@.} The symbol @code{always} prevents the removal of a false-positive in some cases where other non-@code{nil} values would fail. To deal with false-negatives remove the conflicting binding separately, using @code{transient-remove-suffix}. @end defun @defun transient-replace-suffix prefix loc suffix This function replaces the suffix or group at @var{LOC} in @var{PREFIX} with suffix or group @var{SUFFIX}. @end defun @defun transient-remove-suffix prefix loc This function removes the suffix or group at @var{LOC} in @var{PREFIX}. @end defun @defun transient-get-suffix prefix loc This function returns the suffix or group at @var{LOC} in @var{PREFIX}. The returned value has the form mentioned above. @end defun @defun transient-suffix-put prefix loc prop value This function edits the suffix or group at @var{LOC} in @var{PREFIX}, by setting the @var{PROP} of its plist to @var{VALUE}. @end defun Most of these functions do not signal an error if they cannot perform the requested modification. The functions that insert new suffixes show a warning if @var{LOC} cannot be found in @var{PREFIX} without signaling an error. The reason for doing it like this is that establishing a key binding (and that is what we essentially are trying to do here) should not prevent the rest of the configuration from loading. Among these functions only @code{transient-get-suffix} and @code{transient-suffix-put} signal an error by default. If you really want the insert functions to also signal an error, set @code{transient-error-on-insert-failure} to @code{t}. @node Defining New Commands @chapter Defining New Commands @menu * Technical Introduction:: * Defining Transients:: * Binding Suffix and Infix Commands:: * Defining Suffix and Infix Commands:: * Using Infix Arguments:: * Using Prefix Scope:: * Current Suffix Command:: * Current Prefix Command:: * Transient State:: @end menu @node Technical Introduction @section Technical Introduction Taking inspiration from prefix keys and prefix arguments, Transient implements a similar abstraction involving a prefix command, infix arguments and suffix commands. When the user calls a transient prefix command, a transient (temporary) keymap is activated, which binds the transient's infix and suffix commands, and functions that control the transient state are added to @code{pre-command-hook} and @code{post-command-hook}. The available suffix and infix commands and their state are shown in a menu buffer until the transient state is exited by invoking a suffix command. Calling an infix command causes its value to be changed. How that is done depends on the type of the infix command. The simplest case is an infix command that represents a command-line argument that does not take a value. Invoking such an infix command causes the switch to be toggled on or off. More complex infix commands may read a value from the user, using the minibuffer. Calling a suffix command usually causes the transient to be exited; the transient keymaps and hook functions are removed, the menu buffer no longer shows information about the (no longer bound) suffix commands, the values of some public global variables are set, while some internal global variables are unset, and finally the command is actually called. Suffix commands can also be configured to not exit the transient. A suffix command can, but does not have to, use the infix arguments in much the same way any command can choose to use or ignore the prefix arguments. For a suffix command that was invoked from a transient, the variable @code{transient-current-suffixes} and the function @code{transient-args} serve about the same purpose as the variables @code{prefix-arg} and @code{current-prefix-arg} do for any command that was called after the prefix arguments have been set using a command such as @code{universal-argument}. @cindex command dispatchers Transient can be used to implement simple ``command dispatchers''. The main benefit then is that the user can see all the available commands in a temporarily shown buffer, which can be thought of as a ``menu''. That is useful by itself because it frees the user from having to remember all the keys that are valid after a certain prefix key or command. Magit's @code{magit-dispatch} (on @kbd{C-x M-g}) command is an example of using Transient to merely implement a command dispatcher. In addition to that, Transient also allows users to interactively pass arguments to commands. These arguments can be much more complex than what is reasonable when using prefix arguments. There is a limit to how many aspects of a command can be controlled using prefix arguments. Furthermore, what a certain prefix argument means for different commands can be completely different, and users have to read documentation to learn and then commit to memory what a certain prefix argument means to a certain command. Transient suffix commands, on the other hand, can accept dozens of different arguments without the user having to remember anything. When using Transient, one can call a command with arguments that are just as complex as when calling the same function non-interactively from Lisp. Invoking a transient suffix command with arguments is similar to invoking a command in a shell with command-line completion and history enabled. One benefit of the Transient interface is that it remembers history not only on a global level (``this command was invoked using these arguments, and previously it was invoked using those other arguments''), but also remembers the values of individual arguments independently. See @ref{Using History}. After a transient prefix command is invoked, @kbd{C-h @var{KEY}} can be used to show the documentation for the infix or suffix command that @kbd{@var{KEY}} is bound to (see @ref{Getting Help for Suffix Commands}), and infixes and suffixes can be removed from the transient using @kbd{C-x l @var{KEY}}. Infixes and suffixes that are disabled by default can be enabled the same way. See @ref{Enabling and Disabling Suffixes}. Transient ships with support for a few different types of specialized infix commands. A command that sets a command line option, for example, has different needs than a command that merely toggles a boolean flag. Additionally, Transient provides abstractions for defining new types, which the author of Transient did not anticipate (or didn't get around to implementing yet). Note that suffix commands also support regular prefix arguments. A suffix command may even be called with both infix and prefix arguments at the same time. If you invoke a command as a suffix of a transient prefix command, but also want to pass prefix arguments to it, then first invoke the prefix command, and only after doing that invoke the prefix arguments, before finally invoking the suffix command. If you instead began by providing the prefix arguments, then those would apply to the prefix command, not the suffix command. Likewise, if you want to change infix arguments before invoking a suffix command with prefix arguments, then change the infix arguments before invoking the prefix arguments. In other words, regular prefix arguments always apply to the next command, and since transient prefix, infix and suffix commands are just regular commands, the same applies to them. (Regular prefix keys behave differently because they are not commands at all, instead they are just incomplete key sequences, and those cannot be interrupted with prefix commands.) @node Defining Transients @section Defining Transients A transient consists of a prefix command and at least one suffix command, though usually a transient has several infix and suffix commands. The below macro defines the transient prefix command @strong{and} binds the transient's infix and suffix commands. In other words, it defines the complete transient, not just the transient prefix command that is used to invoke that transient. @defmac transient-define-prefix name arglist [docstring] [keyword value]@dots{} group@dots{} [body@dots{}] This macro defines @var{NAME} as a transient prefix command and binds the transient's infix and suffix commands. @var{ARGLIST} are the arguments that the prefix command takes. @var{DOCSTRING} is the documentation string and is optional. These arguments can optionally be followed by keyword-value pairs. Each key has to be a keyword symbol, either @code{:class} or a keyword argument supported by the constructor of that class. The @code{transient-prefix} class is used if the class is not specified explicitly. @var{GROUP}s add key bindings for infix and suffix commands and specify how these bindings are presented in the menu buffer. At least one @var{GROUP} has to be specified. See @ref{Binding Suffix and Infix Commands}. The @var{BODY} is optional. If it is omitted, then @var{ARGLIST} is ignored and the function definition becomes: @lisp (lambda () (interactive) (transient-setup 'NAME)) @end lisp If @var{BODY} is specified, then it must begin with an @code{interactive} form that matches @var{ARGLIST}, and it must call @code{transient-setup}. It may, however, call that function only when some condition is satisfied. @cindex scope of a transient All transients have a (possibly @code{nil}) value, which is exported when suffix commands are called, so that they can consume that value. For some transients it might be necessary to have a sort of secondary value, called a ``scope''. Such a scope would usually be set in the command's @code{interactive} form and has to be passed to the setup function: @lisp (transient-setup 'NAME nil nil :scope SCOPE) @end lisp For example, the scope of the @code{magit-branch-configure} transient is the branch whose variables are being configured. @end defmac @node Binding Suffix and Infix Commands @section Binding Suffix and Infix Commands The macro @code{transient-define-prefix} is used to define a transient. This defines the actual transient prefix command (see @ref{Defining Transients}) and adds the transient's infix and suffix bindings, as described below. Users and third-party packages can add additional bindings using functions such as @code{transient-insert-suffix} (see @ref{Modifying Existing Transients}). These functions take a ``suffix specification'' as one of their arguments, which has the same form as the specifications used in @code{transient-define-prefix}. @anchor{Group Specifications} @subsection Group Specifications @cindex group specifications The suffix and infix commands of a transient are organized in groups. The grouping controls how the descriptions of the suffixes are outlined visually but also makes it possible to set certain properties for a set of suffixes. Several group classes exist, some of which organize suffixes in subgroups. In most cases the class does not have to be specified explicitly, but see @ref{Group Classes}. Groups are specified in the call to @code{transient-define-prefix}, using vectors. Because groups are represented using vectors, we cannot use square brackets to indicate an optional element and instead use curly brackets to do the latter. Group specifications then have this form: @lisp [@{LEVEL@} @{DESCRIPTION@} @{KEYWORD VALUE@}... ELEMENT...] @end lisp The @var{LEVEL} is optional and defaults to 4. See @ref{Enabling and Disabling Suffixes}. The @var{DESCRIPTION} is optional. If present, it is used as the heading of the group. The @var{KEYWORD}-@var{VALUE} pairs are optional. Each keyword has to be a keyword symbol, either @code{:class} or a keyword argument supported by the constructor of that class. @itemize @item One of these keywords, @code{:description}, is equivalent to specifying @var{DESCRIPTION} at the very beginning of the vector. The recommendation is to use @code{:description} if some other keyword is also used, for consistency, or @var{DESCRIPTION} otherwise, because it looks better. @item Likewise @code{:level} is equivalent to @var{LEVEL}. @item Other important keywords include the @code{:if...} and @code{:inapt-if...} keywords. These keywords control whether the group is available in a certain situation. For example, one group of the @code{magit-rebase} transient uses @code{:if magit-rebase-in-progress-p}, which contains the suffixes that are useful while rebase is already in progress; and another that uses @code{:if-not magit-rebase-in-progress-p}, which contains the suffixes that initiate a rebase. These predicates can also be used on individual suffixes and are only documented once, see @ref{Predicate Slots}. @item The value of @code{:hide}, if non-@code{nil}, is a predicate that controls whether the group is hidden by default. The key bindings for suffixes of a hidden group should all use the same prefix key. Pressing that prefix key should temporarily show the group and its suffixes, which assumes that a predicate like this is used: @lisp (lambda () (eq (car transient--redisplay-key) ?\C-c)) ; the prefix key shared by all bindings @end lisp @item The value of @code{:setup-children}, if non-@code{nil}, is a function that takes one argument, a potentially list of children, and must return a list of children or an empty list. This can either be used to somehow transform the group's children that were defined the normal way, or to dynamically create the children from scratch. The returned children must have the same form as stored in the prefix's @code{transient--layout} property, but it is often more convenient to use the same form as understood by @code{transient-define-prefix}, described below. If you use the latter approach, you can use the @code{transient-parse-suffixes} and @code{transient-parse-suffix} functions to transform them from the convenient to the expected form. Depending on the used group class, @code{transient-parse-suffixes}'s SUFFIXES must be a list of group vectors (for @code{transient-columns}) or a list of suffix lists (for all other group classes). If you explicitly specify children and then transform them using @code{:setup-children}, then the class of the group is determined as usual, based on explicitly specified children. If you do not explicitly specify children and thus rely solely on @code{:setup-children}, then you must specify the class using @code{:class}. For backward compatibility, if you fail to do so, @code{transient-column} is used and a warning is displayed. This warning will eventually be replaced with an error. @lisp (transient-define-prefix my-finder-by-keyword () "Select a keyword and list matching packages." ;; The real `finder-by-keyword' is more convenient ;; of course, but that is not the point here. [:class transient-columns :setup-children (lambda (_) (transient-parse-suffixes 'my-finder-by-keyword (let ((char (1- ?A))) (mapcar ; a list ... (lambda (partition) (vconcat ; of group vectors ... (mapcar (lambda (elt) (let ((keyword (symbol-name (car elt)))) ; ... where each suffix is a list (list (format "%c" (cl-incf char)) keyword (lambda () (interactive) (finder-list-matches keyword))))) partition))) (seq-partition finder-known-keywords 7)))))]) @end lisp @item The boolean @code{:pad-keys} argument controls whether keys of all suffixes contained in a group are right padded, effectively aligning the descriptions. @item If a keyword argument accepts a function as value, you an use a @code{lambda} expression. As a special case, the @code{##} macro (which returns a @code{lambda} expression and is implemented in the @code{llama} package) is also supported. Inside group specifications, the use of @code{##} is not supported anywhere but directly following a keyword symbol. @end itemize The @var{ELEMENT}s are either all subgroups, or all suffixes and strings. (At least currently no group type exists that would allow mixing subgroups with commands at the same level, though in principle there is nothing that prevents that.) If the @var{ELEMENT}s are not subgroups, then they can be a mixture of lists, which specify commands, and strings. Strings are inserted verbatim into the buffer. The empty string can be used to insert gaps between suffixes, which is particularly useful if the suffixes are outlined as a table. Inside group specifications, including inside contained suffix specifications, nothing has to be quoted and quoting anyway is invalid. The value following a keyword, can be explicitly unquoted using @code{,}. This feature is experimental and should be avoided. The form of suffix specifications is documented in the next node. @anchor{Suffix Specifications} @subsection Suffix Specifications @cindex suffix specifications A transient's suffix and infix commands are bound when the transient prefix command is defined using @code{transient-define-prefix}, see @ref{Defining Transients}. The commands are organized into groups, see @ref{Group Specifications}. Here we describe the form used to bind an individual suffix command. The same form is also used when later binding additional commands using functions such as @code{transient-insert-suffix}, see @ref{Modifying Existing Transients}. Note that an infix is a special kind of suffix. Depending on context ``suffixes'' means ``suffixes (including infixes)'' or ``non-infix suffixes''. Here it means the former. Suffix specifications have this form: @lisp ([LEVEL] [KEY [DESCRIPTION]] COMMAND|ARGUMENT [KEYWORD VALUE]...) @end lisp @var{LEVEL}, @var{KEY} and @var{DESCRIPTION} can also be specified using the @var{KEYWORD}s @code{:level}, @code{:key} and @code{:description}. If the object that is associated with @var{COMMAND} sets these properties, then they do not have to be specified here. You can however specify them here anyway, possibly overriding the object's values just for the binding inside this transient. @itemize @item @var{LEVEL} is the suffix level, an integer between 1 and 7. See @ref{Enabling and Disabling Suffixes}. @item @var{KEY} is the key binding, either a vector or key description string. @item @var{DESCRIPTION} is the description, either a string or a function that takes zero or one arguments (the suffix object) and returns a string. The function should be a lambda expression to avoid ambiguity. In some cases a symbol that is bound as a function would also work but to be safe you should use @code{:description} in that case. @end itemize The next element is either a command or an argument. This is the only argument that is mandatory in all cases. @itemize @item @var{COMMAND} should be a symbol that is bound as a function, which has to be defined or at least autoloaded as a command by the time the containing prefix command is invoked. Any command will do; it does not need to have an object associated with it (as would be the case if @code{transient-define-suffix} or @code{transient-define-infix} were used to define it). COMMAND can also be a @code{lambda} expression. As mentioned above, the object that is associated with a command can be used to set the default for certain values that otherwise have to be set in the suffix specification. Therefore if there is no object, then you have to make sure to specify the @var{KEY} and the @var{DESCRIPTION}. As a special case, if you want to add a command that might be neither defined nor autoloaded, you can use a workaround like: @lisp (transient-insert-suffix 'some-prefix "k" '("!" "Ceci n'est pas une commande" no-command :if (lambda () (featurep 'no-library)))) @end lisp Instead of @code{featurep} you could also use @code{require} with a non-@code{nil} value for @var{NOERROR}. @item The mandatory argument can also be a command-line argument, a string. In that case an anonymous command is defined and bound. Instead of a string, this can also be a list of two strings, in which case the first string is used as the short argument (which can also be specified using @code{:shortarg}) and the second as the long argument (which can also be specified using @code{:argument}). Only the long argument is displayed in the menu buffer. See @code{transient-detect-key-conflicts} for how the short argument may be used. Unless the class is specified explicitly, the appropriate class is guessed based on the long argument. If the argument ends with @samp{=} (e.g., @samp{--format=}) then @code{transient-option} is used, otherwise @code{transient-switch}. @end itemize Finally, details can be specified using optional @var{KEYWORD}-@var{VALUE} pairs. Each keyword has to be a keyword symbol, either @code{:class} or a keyword argument supported by the constructor of that class. See @ref{Suffix Slots}. If a keyword argument accepts a function as value, you an use a @code{lambda} expression. As a special case, the @code{##} macro (which returns a @code{lambda} expression and is implemented in the @code{llama} package) is also supported. Inside suffix bindings, the use of @code{##} is not supported anywhere but directly following a keyword symbol. @node Defining Suffix and Infix Commands @section Defining Suffix and Infix Commands @cindex defining suffix commands @cindex defining infix commands Note that an infix is a special kind of suffix. Depending on context ``suffixes'' means ``suffixes (including infixes)'' or ``non-infix suffixes''. @defmac transient-define-suffix name arglist [docstring] [keyword value]@dots{} body@dots{} This macro defines @var{NAME} as a transient suffix command. @var{ARGLIST} are the arguments that the command takes. @var{DOCSTRING} is the documentation string and is optional. These arguments can optionally be followed by keyword-value pairs. Each keyword has to be a keyword symbol, either @code{:class} or a keyword argument supported by the constructor of that class. The @code{transient-suffix} class is used if the class is not specified explicitly. The @var{BODY} must begin with an @code{interactive} form that matches @var{ARGLIST}. The infix arguments are usually accessed by using @code{transient-args} inside @code{interactive}. @end defmac @defmac transient-define-infix name arglist [docstring] [keyword value]@dots{} This macro defines @var{NAME} as a transient infix command. @var{ARGLIST} is always ignored (but mandatory never-the-less) and reserved for future use. @var{DOCSTRING} is the documentation string and is optional. At least one key-value pair is required. All transient infix commands are @code{equal} to each other (but not @code{eq}). It is meaningless to define an infix command, without providing at least one keyword argument (usually @code{:argument} or @code{:variable}, depending on the class). The suffix class defaults to @code{transient-switch} and can be set using the @code{:class} keyword. The function definition is always: @lisp (lambda () (interactive) (let ((obj (transient-suffix-object))) (transient-infix-set obj (transient-infix-read obj))) (transient--show)) @end lisp @code{transient-infix-read} and @code{transient-infix-set} are generic functions. Different infix commands behave differently because the concrete methods are different for different infix command classes. In rare cases the above command function might not be suitable, even if you define your own infix command class. In that case you have to use @code{transient-define-suffix} to define the infix command and use @code{t} as the value of the @code{:transient} keyword. @end defmac @defmac transient-define-argument name arglist [docstring] [keyword value]@dots{} This macro defines @var{NAME} as a transient infix command. This is an alias for @code{transient-define-infix}. Only use this alias to define an infix command that actually sets an infix argument. To define an infix command that, for example, sets a variable, use @code{transient-define-infix} instead. @end defmac @node Using Infix Arguments @section Using Infix Arguments The functions and the variables described below allow suffix commands to access the value of the transient from which they were invoked; which is the value of its infix arguments. These variables are set when the user invokes a suffix command that exits the transient, but before actually calling the command. When returning to the command-loop after calling the suffix command, the arguments are reset to @code{nil} (which causes the function to return @code{nil} too). Like for Emacs's prefix arguments, it is advisable, but not mandatory, to access the infix arguments inside the command's @code{interactive} form. The preferred way of doing that is to call the @code{transient-args} function, which for infix arguments serves about the same purpose as @code{prefix-arg} serves for prefix arguments. @defun transient-args prefix This function returns the value of the transient prefix command @var{PREFIX}. If the current command was invoked from the transient prefix command @var{PREFIX}, then it returns the active infix arguments. If the current command was not invoked from @var{PREFIX}, then it returns the set, saved or default value for @var{PREFIX}. @end defun @defun transient-get-value This function returns the value of the current prefix. This is mostly intended for internal use, but may also be of use in @code{transient-set-value} and @code{transient-save-value} methods. Unlike @code{transient-args}, this does not include the values of suffixes whose @code{unsavable} slot is non-@code{nil}. @end defun @defun transient-arg-value arg args This function returns the value of @var{ARG} as it appears in @var{ARGS}. For a switch a boolean is returned. For an option the value is returned as a string, using the empty string for the empty value, or @code{nil} if the option does not appear in @var{ARGS}. @end defun @defun transient-suffixes prefix This function returns the suffixes of the transient prefix command @var{PREFIX}. This is a list of objects. This function should only be used if you need the objects (as opposed to just their values) and if the current command is not being invoked from @var{PREFIX}. @end defun @node Using Prefix Scope @section Using Prefix Scope Some transients have a sort of secondary value, called a scope. A prefix's scope can be accessed using @code{transient-scope}; similar to how its value can be accessed using @code{transient-args}. @defun transient-scope prefixes classes This function returns the scope of the active or current transient prefix command. If optional PREFIXES and CLASSES are both nil, return the scope of the prefix currently being setup, making this variation useful, e.g., in @code{:if*} predicates. If no prefix is being setup, but the current command was invoked from some prefix, then return the scope of that. If PREFIXES is non-nil, it must be a prefix command or a list of such commands. If CLASSES is non-nil, it must be a prefix class or a list of such classes. When this function is called from the body or the @code{interactive} form of a suffix command, PREFIXES and/or CLASSES should be non-nil. If either is non-nil, try the following in order: @itemize @item If the current suffix command was invoked from a prefix, which appears in PREFIXES, return the scope of that prefix. @item If the current suffix command was invoked from a prefix, and its class derives from one of the CLASSES, return the scope of that prefix. @item If a prefix is being setup and it appears in PREFIXES, return its scope. @item If a prefix is being setup and its class derives from one of the CLASSES, return its scope. @item Finally try to return the default scope of the first command in PREFIXES@. This only works if that slot is set in the respective class definition or using its `transient-init-scope' method. @end itemize If no prefix matches, return nil. @end defun @node Current Suffix Command @section Current Suffix Command @defun transient-suffix-object command This function returns the object associated with the current suffix command. Each suffix commands is associated with an object, which holds additional information about the suffix, such as its value (in the case of an infix command, which is a kind of suffix command). This function is intended to be called by infix commands, which are usually aliases of @code{transient--default-infix-command}, which is defined like this: @lisp (defun transient--default-infix-command () (interactive) (let ((obj (transient-suffix-object))) (transient-infix-set obj (transient-infix-read obj))) (transient--show)) @end lisp (User input is read outside of @code{interactive} to prevent the command from being added to @code{command-history}.) Such commands need to be able to access their associated object to guide how @code{transient-infix-read} reads the new value and to store the read value. Other suffix commands (including non-infix commands) may also need the object to guide their behavior. This function attempts to return the object associated with the current suffix command even if the suffix command was not invoked from a transient. (For some suffix command that is a valid thing to do, for others it is not.) In that case @code{nil} may be returned, if the command was not defined using one of the macros intended to define such commands. The optional argument COMMAND is intended for internal use. If you are contemplating using it in your own code, then you should probably use this instead: @lisp (get COMMAND 'transient--suffix) @end lisp @end defun @defvar transient-current-suffixes The suffixes of the transient from which this suffix command was invoked. This is a list of objects. Usually it is sufficient to instead use the function @code{transient-args}, which returns a list of values. In complex cases it might be necessary to use this variable instead, i.e., if you need access to information beside the value. @end defvar @node Current Prefix Command @section Current Prefix Command @defun transient-prefix-object This function returns the current prefix as an object. While a transient is being setup or refreshed (which involves preparing its suffixes) the variable @code{transient--prefix} can be used to access the prefix object. Thus this is what has to be used in suffix methods such as @code{transient-format-description}, and in object-specific functions that are stored in suffix slots such as @code{description}. When a suffix command is invoked (i.e., in its @code{interactive} form and function body) then the variable @code{transient-current-prefix} has to be used instead. Two distinct variables are needed, because any prefix may itself be used as a suffix of another prefix, and such sub-prefixes have to be able to tell themselves apart from the prefix they were invoked from. Regular suffix commands, which are not prefixes, do not have to concern themselves with this distinction, so they can use this function instead. In the context of a plain suffix, it always returns the value of the appropriate variable. @end defun @defvar transient-current-prefix The transient from which this suffix command was invoked. The value is a @code{transient-prefix} object, which holds information associated with the transient prefix command. @end defvar @defvar transient-current-command The transient from which this suffix command was invoked. The value is a symbol, the transient prefix command. @end defvar @defun transient-active-prefix &optional prefixes This function returns the active transient object. It returns @code{nil} if there is no active transient, if the transient buffer isn't shown, and while the active transient is suspended (e.g., while the minibuffer is in use). Unlike @code{transient-current-prefix}, which is only ever non-@code{nil} in code that is run directly by a command that is invoked while a transient is current, this function is also suitable for use in asynchronous code, such as timers and callbacks (this function's main use-case). If optional PREFIXES is non-@code{nil}, it must be a prefix command symbol or a list of symbols, in which case the active transient object is only returned if it matches one of the PREFIXES@. @end defun @node Transient State @section Transient State @cindex transient state Invoking a transient prefix command ``activates'' the respective transient, i.e., it puts a transient keymap into effect, which binds the transient's infix and suffix commands. The default behavior while a transient is active is as follows: @itemize @item Invoking an infix command does not affect the transient state; the transient remains active. @item Invoking a (non-infix) suffix command ``deactivates'' the transient state by removing the transient keymap and performing some additional cleanup. @item Invoking a command that is bound in a keymap other than the transient keymap is disallowed and trying to do so results in a warning. This does not ``deactivate'' the transient. @end itemize The behavior can be changed for all suffixes of a particular prefix and/or for individual suffixes. The values should nearly always be booleans, but certain functions, called ``pre-commands'', can also be used. These functions are named @code{transient--do-VERB}, and the symbol @code{VERB} can be used as a shorthand. A boolean is interpreted as answering the question "does the transient stay active, when this command is invoked?" @code{t} means that the transient stays active, while @code{nil} means that invoking the command exits the transient. Note that when the suffix is a ``sub-prefix'', invoking that command always activates that sub-prefix, causing the outer prefix to no longer be active and displayed. Here @code{t} means that when you exit the inner prefix, then the outer prefix becomes active again, while @code{nil} means that all outer prefixes are exited at once. @itemize @item The behavior for non-suffixes can be set for a particular prefix, by the prefix's @code{transient-non-suffix} slot to a boolean, a suitable pre-command function, or a shorthand for such a function. See @ref{Pre-commands for Non-Suffixes}. @item The common behavior for the suffixes of a particular prefix can be set using the prefix's @code{transient-suffixes} slot. The value specified in this slot does @strong{not} affect infixes. Because it affects both regular suffixes as well as sub-prefixes, which have different needs, it is best to avoid explicitly specifying a function. @item The behavior of an individual suffix can be changed using its @code{transient} slot. While it is usually best to use a boolean, for this slot it can occasionally make sense to specify a function explicitly. Note that this slot can be set when defining a suffix command using @code{transient-define-suffix} and/or in the definition of the prefix. If set in both places, then the latter takes precedence, as usual. @end itemize The available pre-command functions are documented in the following sub-sections. They are called by @code{transient--pre-command}, a function on @code{pre-command-hook}, and the value that they return determines whether the transient is exited. To do so the value of one of the constants @code{transient--exit} or @code{transient--stay} is used (that way we don't have to remember if @code{t} means ``exit'' or ``stay''). Additionally, these functions may change the value of @code{this-command} (which explains why they have to be called using @code{pre-command-hook}), call @code{transient-export}, @code{transient--stack-zap} or @code{transient--stack-push}; and set the values of @code{transient--exitp}, @code{transient--helpp} or @code{transient--editp}. For completeness sake, some notes about complications: @itemize @item The transient-ness of certain built-in suffix commands is specified using @code{transient-predicate-map}. This is a special keymap, which binds commands to pre-commands (as opposed to keys to commands) and takes precedence over the prefix's @code{transient-suffix} slot, but not the suffix's @code{transient} slot. @item While a sub-prefix is active we nearly always want @kbd{C-g} to take the user back to the ``super-prefix'', even when the other suffixes don't do that. However, in rare cases this may not be desirable, in which case @code{replace} can be used as the value of the sub-prefix's @code{transient} slot. @end itemize @anchor{Pre-commands for Infixes} @subheading Pre-commands for Infixes The default for infixes is @code{transient--do-stay}. This is also the only function that makes sense for infixes, which is why this predicate is used even if the value of the prefix's @code{transient-suffix} slot is @code{t}. In extremely rare cases, one might want to use something else, which can be done by setting the infix's @code{transient} slot directly. @defun transient--do-stay Call the command without exporting variables and stay transient. @end defun @anchor{Pre-commands for Suffixes} @subheading Pre-commands for Suffixes By default, invoking a suffix causes the transient to be exited. The behavior for an individual suffix command can be changed by setting its @code{transient} slot to a boolean (which is highly recommended), or to one of the following pre-commands. @defun transient--do-exit Call the command after exporting variables and exit the transient. @end defun @defun transient--do-return Call the command after exporting variables and return to the parent prefix. If there is no parent prefix, then call @code{transient--do-exit}. @end defun @defun transient--do-call Call the command after exporting variables and stay transient. @end defun The following pre-commands are only suitable for sub-prefixes. It is not necessary to explicitly use these predicates because the correct predicate is automatically picked based on the value of the @code{transient} slot for the sub-prefix itself. @defun transient--do-recurse Call the transient prefix command, preparing for return to outer transient. Whether we actually return to the parent transient is ultimately under the control of each invoked suffix. The difference between this pre-command and @code{transient--do-stack} is that it changes the value of the @code{transient-suffix} slot to @code{t}. If there is no parent transient, then only call this command and skip the second step. @end defun @defun transient--do-stack Call the transient prefix command, stacking the active transient. Push the active transient to the transient stack. Unless @code{transient--do-recurse} is explicitly used, this pre-command is automatically used for suffixes that are prefixes themselves, i.e., for sub-prefixes. @end defun @defun transient--do-replace Call the transient prefix command, replacing the active transient. Do not push the active transient to the transient stack. Unless @code{transient--do-recurse} is explicitly used, this pre-command is automatically used for suffixes that are prefixes themselves, i.e., for sub-prefixes. @end defun @defun transient--do-suspend Suspend the active transient, saving the transient stack. This is used by the command @code{transient-suspend} and optionally also by ``external events'' such as @code{handle-switch-frame}. Such bindings should be added to @code{transient-predicate-map}. @end defun @anchor{Pre-commands for Non-Suffixes} @subheading Pre-commands for Non-Suffixes By default, non-suffixes (commands that are bound in other keymaps beside the transient keymap) cannot be invoked. Trying to invoke such a command results in a warning and the transient stays active. If you want a different behavior, then set the @code{transient-non-suffix} slot of the transient prefix command. The value should be a boolean, answering the question, "is it allowed to invoke non-suffix commands?, a pre-command function, or a shorthand for such a function. If the value is @code{t}, then non-suffixes can be invoked, when it is @code{nil} (the default) then they cannot be invoked. The only other recommended value is @code{leave}. If that is used, then non-suffixes can be invoked, but if one is invoked, then that exits the transient. @defun transient--do-warn Call @code{transient-undefined} and stay transient. @end defun @defun transient--do-stay Call the command without exporting variables and stay transient. @end defun @defun transient--do-leave Call the command without exporting variables and exit the transient. @end defun @anchor{Special Pre-Commands} @subheading Special Pre-Commands @defun transient--do-quit-one If active, quit help or edit mode, else exit the active transient. This is used when the user pressed @kbd{C-g}. @end defun @defun transient--do-quit-all Exit all transients without saving the transient stack. This is used when the user pressed @kbd{C-q}. @end defun @defun transient--do-suspend Suspend the active transient, saving the transient stack. This is used when the user pressed @kbd{C-z}. @end defun @node Classes and Methods @chapter Classes and Methods @cindex classes and methods Transient uses classes and generic functions to make it possible to define new types of suffix and prefix commands, which are similar to existing types, but behave differently in some respects. Every prefix, infix and suffix command is associated with an object, which holds information, which controls certain aspects of its behavior. This happens in two ways. @itemize @item Associating a command with a certain class gives the command a type. This makes it possible to use generic functions to do certain things that have to be done differently depending on what type of command it acts on. That in turn makes it possible for third-parties to add new types without having to convince the maintainer of Transient, that that new type is important enough to justify adding a special case to a dozen or so functions. @item Associating a command with an object makes it possible to easily store information that is specific to that particular command. Two commands may have the same type, but obviously their key bindings and descriptions still have to be different, for example. The values of some slots are functions. The @code{reader} slot for example holds a function that is used to read a new value for an infix command. The values of such slots are regular functions. Generic functions are used when a function should do something different based on the type of the command, i.e., when all commands of a certain type should behave the same way but different from the behavior for other types. Object slots that hold a regular function as value are used when the task that they perform is likely to differ even between different commands of the same type. @end itemize @menu * Group Classes:: * Group Methods:: * Prefix Classes:: * Suffix Classes:: * Prefix Methods:: * Suffix Methods:: * Prefix Slots:: * Suffix Slots:: * Predicate Slots:: @end menu @node Group Classes @section Group Classes The type of a group can be specified using the @code{:class} property at the beginning of the class specification, e.g., @code{[:class transient-columns ...]} in a call to @code{transient-define-prefix}. @itemize @item The abstract @code{transient-child} class is the base class of both @code{transient-group} (and therefore all groups) as well as of @code{transient-suffix} (and therefore all suffix and infix commands). This class exists because the elements (or ``children'') of certain groups can be other groups instead of suffix and infix commands. @item The abstract @code{transient-group} class is the superclass of all other group classes. @item The @code{transient-column} class is the simplest group. This is the default ``flat'' group. If the class is not specified explicitly and the first element is not a vector (i.e., not a group), then this class is used. This class displays each element on a separate line. @item The @code{transient-row} class displays all elements on a single line. @item The @code{transient-columns} class displays commands organized in columns. Direct elements have to be groups whose elements have to be commands or strings. Each subgroup represents a column. This class takes care of inserting the subgroups' elements. This is the default ``nested'' group. If the class is not specified explicitly and the first element is a vector (i.e., a group), then this class is used. @item The @code{transient-subgroups} class wraps other groups. Direct elements have to be groups whose elements have to be commands or strings. This group inserts an empty line between subgroups. The subgroups themselves are responsible for displaying their elements. @end itemize @node Group Methods @section Group Methods @defun transient-setup-children group children This generic function can be used to setup the children or a group. The default implementation usually just returns the children unchanged, but if the @code{setup-children} slot of @var{GROUP} is non-@code{nil}, then it calls that function with @var{CHILDREN} as the only argument and returns the value. The children are given as a (potentially empty) list consisting of either group or suffix specifications. These functions can make arbitrary changes to the children including constructing new children from scratch. @end defun @defun transient--insert-group group This generic function formats the group and its elements and inserts the result into the current buffer, which is a temporary buffer. The contents of that buffer are later inserted into the menu buffer. Functions that are called by this function may need to operate in the buffer from which the transient was called. To do so they can temporarily make the @code{transient--shadowed-buffer} the current buffer. @end defun @node Prefix Classes @section Prefix Classes Transient itself provides a single class for prefix commands, @code{transient-prefix}, but package authors may wish to define specialized classes. Doing so makes it possible to change the behavior of the set of prefix commands that use that class, by implementing specialized methods for certain generic functions (see @ref{Prefix Methods}). A transient prefix command's object is stored in the @code{transient--prefix} property of the command symbol. While a transient is active, a clone of that object is stored in the variable @code{transient--prefix}. A clone is used because some changes that are made to the active transient's object should not affect later invocations. @node Suffix Classes @section Suffix Classes @itemize @item All suffix and infix classes derive from @code{transient-suffix}, which in turn derives from @code{transient-child}, from which @code{transient-group} also derives (see @ref{Group Classes}). @item All infix classes derive from the abstract @code{transient-infix} class, which in turn derives from the @code{transient-suffix} class. Infixes are a special type of suffixes. The primary difference is that infixes always use the @code{transient--do-stay} pre-command, while non-infix suffixes use a variety of pre-commands (see @ref{Transient State}). Doing that is most easily achieved by using this class, though theoretically it would be possible to define an infix class that does not do so. If you do that then you get to implement many methods. Also, infixes and non-infix suffixes are usually defined using different macros (see @ref{Defining Suffix and Infix Commands}). @item Classes used for infix commands that represent arguments should be derived from the abstract @code{transient-argument} class. @item The @code{transient-switch} class (or a derived class) is used for infix arguments that represent command-line switches (arguments that do not take a value). @item The @code{transient-option} class (or a derived class) is used for infix arguments that represent command-line options (arguments that do take a value). @item The @code{transient-switches} class can be used for a set of mutually exclusive command-line switches. @item The @code{transient-files} class can be used for a @samp{--} argument that indicates that all remaining arguments are files. @item Classes used for infix commands that represent variables should derived from the abstract @code{transient-variable} class. @item The @code{transient-information} and @code{transient-information*} classes are special in that suffixes that use these class are not associated with a command and thus also not with any key binding. Such suffixes are only used to display arbitrary information, and that anywhere a suffix can appear. Display-only suffix specifications take these form: @lisp ([LEVEL] :info DESCRIPTION [KEYWORD VALUE]...) ([LEVEL] :info* DESCRIPTION [KEYWORD VALUE]...) @end lisp The @code{:info} and @code{:info*} keyword arguments replaces the @code{:description} keyword used for other suffix classes. Other keyword arguments that you might want to set, include @code{:face}, predicate keywords (such as @code{:if} and @code{:inapt-if}), and @code{:format}. By default the value of @code{:format} includes @code{%k}, which for this class is replaced with the empty string or spaces, if keys are being padded in the containing group. The only difference between these two classes is that @code{:info*} aligns its description with the descriptions of suffix commands, while for @code{:info} the description bleeds into the area where suffixes display their key bindings. @item The @code{transient-lisp-variable} class can be used to show and change the value of lisp variables. This class is not fully featured yet and it is somewhat likely that future improvements won't be fully backward compatible. @item The @code{transient-describe-target} class is used by the command @code{transient-describe}. @item The @code{transient-value-preset} class is used to implement the command @code{transient-preset}, which activates a value preset. @end itemize Magit defines additional classes, which can serve as examples for the fancy things you can do without modifying Transient. Some of these classes will likely get generalized and added to Transient. For now they are very much subject to change and not documented. @node Prefix Methods @section Prefix Methods To get information about the methods implementing these generic functions use @code{describe-function}. @defun transient-init-value obj This generic function sets the initial value of the object @var{OBJ}. Methods exist for both prefix and suffix objects. The default method for prefix objects sets the value of OBJ's @code{value} slot to the set, saved or default value. The value that is set for the current session is preferred over the saved value, which is preferred over the default value. The default value is determined using the generic function @code{transient-default-value}. If you need to change how the value for a prefix class is determined, its usually sufficient to implement a method for that function. @end defun @defun transient-default-value obj This generic function returns the default value of the object @var{OBJ}. Methods exist for both prefix and suffix objects. The default method for prefix objects returns the value of the @code{default-value} slot if that is bound and not a function. If it is a function, that is called to get the value. If the slot is unbound, @code{nil} is returned. @end defun @defun transient-prefix-value obj This generic function returns the value of the prefix object @var{OBJ}. The respective generic function for infix and suffix objects is named @code{transient-infix-value}. @end defun @defun transient-init-scope obj This generic function sets the scope of the object @var{OBJ}. Methods exist for both prefix and suffix objects. This function is called for all prefix and suffix commands, but unless a concrete method is implemented this falls through to the default implementation, which is a noop. @end defun @code{transient-set-value}, @code{transient-save-value}, @code{transient-reset-value}, @code{transient--history-key}, @code{transient--history-push} and @code{transient--history-init} are other generic functions dealing with the value of prefix objects. See their doc-strings for more information. @code{transient-show-help} is another generic function implemented for prefix commands. The default method effectively describes the command using @code{describe-function}. @node Suffix Methods @section Suffix Methods To get information about the methods implementing these generic functions use @code{describe-function}. @anchor{Suffix Value Methods} @subsection Suffix Value Methods @defun transient-init-value obj This generic function sets the initial value of the object @var{OBJ}. Methods exist for both prefix and suffix objects. For @code{transient-argument} objects this function handles setting the value by itself. For other @code{transient-suffix} objects (including @code{transient-infix} objects), this calls @code{transient-default-value} and uses the value returned by that, unless it is the special value @code{eieio--unbound}, which indicates that there is no default value. Since that is what the default method for @code{transient-suffix} objects does, both of these functions effectively are noops for these classes. If you implement a class that derives from @code{transient-infix} directly, then you must implement a dedicated method for this function and/or @code{transient-default-value}. @end defun @defun transient-default-value obj This generic function returns the default value of the object @var{OBJ}. Methods exist for both prefix and suffix objects. @end defun @defun transient-infix-read obj This generic function determines the new value of the infix object @var{OBJ}. This function merely determines the value; @code{transient-infix-set} is used to actually store the new value in the object. For most infix classes this is done by reading a value from the user using the reader specified by the @code{reader} slot (using the @code{transient-infix-value} method described below). For some infix classes the value is changed without reading anything in the minibuffer, i.e., the mere act of invoking the infix command determines what the new value should be, based on the previous value. @end defun @defun transient-prompt obj This generic function returns the prompt to be used to read infix object @var{OBJ}'s value. @end defun @defun transient-infix-set obj value This generic function sets the value of infix object @var{OBJ} to @var{VALUE}. @end defun @defun transient-infix-value obj This generic function returns the value of the suffix object @var{OBJ}. This function is called by @code{transient-args} (which see), meaning this function is how the value of a transient is determined so that the invoked suffix command can use it. Currently most values are strings, but that is not set in stone. @code{nil} is not a value, it means ``no value''. Usually only infixes have a value, but see the method for @code{transient-suffix}. @end defun @defun transient-init-scope obj This generic function sets the scope of the object @var{OBJ}. Methods exist for both prefix and suffix objects. The scope is actually a property of the transient prefix, not of individual suffixes. However it is possible to invoke a suffix command directly instead of from a transient. In that case, if the suffix expects a scope, then it has to determine that itself and store it in its @code{scope} slot. This function is called for all prefix and suffix commands, but unless a concrete method is implemented, this falls through to the default implementation, which is a noop. @end defun @anchor{Suffix Format Methods} @subsection Suffix Format Methods @defun transient-format obj This generic function formats and returns @var{OBJ} for display. When this function is called, then the current buffer is some temporary buffer. If you need the buffer from which the prefix command was invoked to be current, then do so by temporarily making @code{transient--source-buffer} current. @end defun @defun transient-format-key obj This generic function formats @var{OBJ}'s @code{key} for display and returns the result. @end defun @defun transient-format-description obj This generic function formats @var{OBJ}'s @code{description} for display and returns the result. @end defun @defun transient-format-value obj This generic function formats @var{OBJ}'s value for display and returns the result. @end defun @defun transient-show-help obj Show help for the prefix, infix or suffix command represented by @var{OBJ}. Regardless of OBJ's type, if its @code{show-help} slot is non-@code{nil}, that must be a function, which takes OBJ is its only argument. It must prepare, display and return a buffer, and select the window used to display it. The @code{transient-show-help-window} macro is intended for use in such functions. For prefixes, show the info manual, if that is specified using the @code{info-manual} slot. Otherwise, show the manpage if that is specified using the @code{man-page} slot. Otherwise, show the command's documentation string. For suffixes, show the command's documentation string. For infixes, show the manpage if that is specified. Otherwise show the command's documentation string. @end defun @defmac transient-with-help-window &rest body Evaluate BODY, send output to @code{*Help*} buffer, and display it in a window. Select the help window, and make the help buffer current and return it. @end defmac @defun transient-show-summary obj &optional return This generic function shows or, if optional RETURN is non-@code{nil}, returns a brief summary about the command at point or hovered with the mouse. This function is called when the mouse is moved over a command and (if the value of @code{transient-enable-popup-navigation} is @code{verbose}) when the user navigates to a command using the keyboard. If OBJ's @code{summary} slot is a string, that is used. If @code{summary} is a function, that is called with OBJ as the only argument and the returned string is used. If @code{summary} is or returns something other than a string or @code{nil}, no summary is shown. If @code{summary} is or returns @code{nil}, the first line of the documentation string is used, if any. If RETURN is non-@code{nil}, this function returns the summary instead of showing it. This is used when a tooltip is needed. @end defun @node Prefix Slots @section Prefix Slots @anchor{Value and Scope} @subheading Value and Scope @itemize @item @code{default-value} The default value of the prefix. Use the keyword argument @code{:value} (sic) to set this slot in the definition of a prefix. @item @code{init-value} A function that is responsible for setting the object's value. If bound, then this is called with the object as the only argument. Usually this is not bound, in which case the object's primary @code{transient-init-value} method is called instead. @item @code{history-key} If multiple prefix commands should share a single value, then this slot has to be set to the same value for all of them. You probably don't want that. @item @code{incompatible} A list of lists. Each sub-list specifies a set of mutually exclusive arguments. Enabling one of these arguments causes the others to be disabled. An argument may appear in multiple sub-lists. Arguments must me given in the same form as used in the @code{argument} or @code{argument-format} slot of the respective suffix objects, usually something like @code{--switch} or @code{--option=%s}. For options and @code{transient-switches} suffixes it is also possible to match against a specific value, as returned by @code{transient-infix-value}, for example, @code{--option=one}. @item @code{scope} For some transients it might be necessary to have a sort of secondary value, called a ``scope''. See @code{transient-define-prefix}. @end itemize @anchor{Behavior} @subheading Behavior @itemize @item @code{transient-suffix}, @code{transient-non-suffix} and @code{transient-switch-frame} play a part when determining whether the currently active transient prefix command remains active/transient when a suffix or arbitrary non-suffix command is invoked. See @ref{Transient State}. @item @code{refresh-suffixes} Normally suffix objects and keymaps are only setup once, when the prefix is invoked. Setting this to @code{t}, causes them to be recreated after every command. This is useful when using @code{:if...} predicates, and those need to be rerun for some reason. Doing this is somewhat costly, and there is a risk of losing state, so this is disabled by default and still considered experimental. @item @code{environment} A function used to establish an environment while initializing, refreshing or redisplaying a transient prefix menu. This is useful to establish a cache, in case multiple suffixes require the same expensive work. The provided function is called with at least one argument, the function for which it establishes the environment. It must @code{funcall} that function with no arguments. During initialization the second argument is the prefix object being initialized. This slot is still experimental. @end itemize @anchor{Appearance} @subheading Appearance @itemize @item @code{display-action} determines how this prefix is displayed, overriding @code{transient-display-buffer-action}. It should have the same type. @item @code{mode-line-format} is this prefix's mode line format, overriding @code{transient-mode-line-format}. It should have the same type. @item @code{column-widths} is only respected inside @code{transient-columns} groups and allows aligning columns across separate instances of that. A list of integers. @item @code{variable-pitch} controls whether alignment is done pixel-wise to account for use of variable-pitch characters, which is useful, e.g., when using emoji. @end itemize @anchor{Documentation} @subheading Documentation @itemize @item @code{show-help}, @code{man-page} or @code{info-manual} can be used to specify the documentation for the prefix and its suffixes. The command @code{transient-help} uses the function @code{transient-show-help} (which see) to lookup and use these values. @item @code{suffix-description} can be used to specify a function which provides fallback descriptions for suffixes that lack a description. This is intended to be temporarily used when implementing of a new prefix command, at which time @code{transient-command-summary-or-name} is a useful value. @end itemize @anchor{Internal} @subheading Internal These slots are mostly intended for internal use. They should not be set in calls to @code{transient-define-prefix}. @itemize @item @code{prototype} When a transient prefix command is invoked, then a clone of that object is stored in the global variable @code{transient--prefix} and the prototype is stored in the clone's @code{prototype} slot. @item @code{command} The command, a symbol. Each transient prefix command consists of a command, which is stored in a symbol's function slot and an object, which is stored in the @code{transient--prefix} property of the same symbol. @item @code{level} The level of the prefix commands. The suffix commands whose layer is equal or lower are displayed. See @ref{Enabling and Disabling Suffixes}. @item @code{value} The likely outdated value of the prefix. Instead of accessing this slot directly you should use the function @code{transient-get-value}, which is guaranteed to return the up-to-date value. @item @code{history} and @code{history-pos} are used to keep track of historic values. Unless you implement your own @code{transient-infix-read} method you should not have to deal with these slots. @item @code{unwind-suffix} is used internally to ensure transient state is properly exited, even in case of an error. @end itemize @node Suffix Slots @section Suffix Slots Here we document most of the slots that are only available for suffix objects. Some slots are shared by suffix and group objects, they are documented in @ref{Predicate Slots}. Also see @ref{Suffix Classes}. @anchor{Slots of @code{transient-child}} @subheading Slots of @code{transient-child} This is the abstract superclass of @code{transient-suffix} and @code{transient-group}. This is where the shared @code{if*} and @code{inapt-if*} slots (see @ref{Predicate Slots}), the @code{level} slot (see @ref{Enabling and Disabling Suffixes}), and the @code{advice} and @code{advice*} slots (see @ref{Slots of @code{transient-suffix}}) are defined. @itemize @item @code{parent} The object for the parent group. @end itemize @anchor{Slots of @code{transient-suffix}} @subheading Slots of @code{transient-suffix} @itemize @item @code{key} The key, a key vector or a key description string. @item @code{command} The command, a symbol. @item @code{transient} Whether to stay transient. See @ref{Transient State}. @item @code{format} The format used to display the suffix in the menu buffer. It must contain the following %-placeholders: @itemize @item @code{%k} For the key. @item @code{%d} For the description. @item @code{%v} For the infix value. Non-infix suffixes don't have a value. @end itemize @item @code{description} The description, either a string or a function, which is called with zero or one argument (the suffix object), and returns a string. @item @code{face} Face used for the description. In simple cases it is easier to use this instead of using a function as @code{description} and adding the styling there. @code{face} is appended using @code{add-face-text-property}. @item @code{show-help} A function used to display help for the suffix. If unspecified, the prefix controls how help is displayed for its suffixes. See also function @code{transient-show-help}. @item @code{summary} The summary displayed in the echo area, or as a tooltip. If this is @code{nil}, which it usually should be, the first line of the documentation string is used instead. See @code{transient-show-summary} for details. @item @code{definition} A command, which is used if the body is omitted when defining a command using @code{transient-define-suffix}. @end itemize The following two slots are experimental. They can also be set for a group, in which case they apply to all suffixes in that group, except for suffixes that set the same slot to a non-nil value. @itemize @item @code{advice} A function used to advise the command. The advise is called using @code{(apply advice command args)}, i.e., it behaves like an "around" advice. @item @code{advice*} A function used to advise the command. Unlike @code{advice}, this advises not only the command body but also its @code{interactive} spec. If both slots are non-nil, @code{advice} is used for the body and @code{advice*} is used for the @code{interactive} form. When advising the @code{interactive} spec, called using @code{(funcall advice #'advice-eval-interactive-spec spec)}. @end itemize @anchor{Slots of @code{transient-infix}} @subheading Slots of @code{transient-infix} Some of these slots are only meaningful for some of the subclasses. They are defined here anyway to allow sharing certain methods. @itemize @item @code{argument} The long argument, e.g., @code{--verbose}. @item @code{shortarg} The short argument, e.g., @code{-v}. @item @code{value} The value. Should not be accessed directly. @item @code{init-value} Function that is responsible for setting the object's value. If bound, then this is called with the object as the only argument. Usually this is not bound, in which case the object's primary @code{transient-init-value} method is called instead. @item @code{unsavable} Whether the value of the suffix is not saved as part of the prefixes. @item @code{multi-value} For options, whether the option can have multiple values. If this is non-@code{nil}, then the values are read using @code{completing-read-multiple} by default and if you specify your own reader, then it should read the values using that function or similar. Supported non-@code{nil} values are: @itemize @item Use @code{rest} for an option that can have multiple values. This is useful e.g., for an @code{--} argument that indicates that all remaining arguments are files (such as @code{git log -- file1 file2}). In the list returned by @code{transient-args} such an option and its values are represented by a single list of the form @code{(ARGUMENT . VALUES)}. @item Use @code{repeat} for an option that can be specified multiple times. In the list returned by @code{transient-args} each instance of the option and its value appears separately in the usual from, for example: @code{("--another-argument" "--option=first" "--option=second")}. @end itemize In both cases the option's values have to be specified in the default value of a prefix using the same format as returned by @code{transient-args}, e.g., @code{("--other" "--o=1" "--o=2" ("--" "f1" "f2"))}. @item @code{always-read} For options, whether to read a value on every invocation. If this is @code{nil}, then options that have a value are simply unset and have to be invoked a second time to set a new value. @item @code{allow-empty} For options, whether the empty string is a valid value. @item @code{history-key} The key used to store the history. This defaults to the command name. This is useful when multiple infixes should share the same history because their values are of the same kind. @item @code{reader} The function used to read the value of an infix. Not used for switches. The function takes three arguments, @var{PROMPT}, @var{INITIAL-INPUT} and @var{HISTORY}, and must return a string. @item @code{prompt} The prompt used when reading the value, either a string or a function that takes the object as the only argument and which returns a prompt string. @item @code{choices} A list of valid values, or a function that returns such a list. The latter is not implemented for @code{transient-switches}, because I couldn't think of a use-case. How exactly the choices are used varies depending on the class of the suffix. @end itemize @anchor{Slots of @code{transient-variable}} @subheading Slots of @code{transient-variable} @itemize @item @code{variable} The variable. @end itemize @anchor{Slots of @code{transient-switches}} @subheading Slots of @code{transient-switches} @itemize @item @code{argument-format} The display format. Must contain @code{%s}, one of the @code{choices} is substituted for that. E.g., @code{--%s-order}. @item @code{argument-regexp} The regexp used to match any one of the switches. E.g., @code{\\(--\\(topo\\|author-date\\|date\\)-order\\)}. @end itemize @node Predicate Slots @section Predicate Slots Suffix and group objects share two sets of predicate slots that control whether a group or suffix should be available depending on some state. Only one slot from each set can be used at the same time. It is undefined which slot is honored if you use more than one. Predicates from the first group control whether the suffix is present in the menu at all. @itemize @item @code{if} Enable if predicate returns non-@code{nil}. @item @code{if-not} Enable if predicate returns @code{nil}. @item @code{if-non-nil} Enable if variable's value is non-@code{nil}. @item @code{if-nil} Enable if variable's value is @code{nil}. @item @code{if-mode} Enable if major-mode matches value. @item @code{if-not-mode} Enable if major-mode does not match value. @item @code{if-derived} Enable if major-mode derives from value. @item @code{if-not-derived} Enable if major-mode does not derive from value. @end itemize Predicates from the second group control whether the suffix can be invoked. The suffix is shown in the menu regardless, but when it is considered "inapt", then it is grayed out to indicated that it currently cannot be invoked. @itemize @item @code{inapt-if} Inapt if predicate returns non-@code{nil}. @item @code{inapt-if-not} Inapt if predicate returns @code{nil}. @item @code{inapt-if-non-nil} Inapt if variable's value is non-@code{nil}. @item @code{inapt-if-nil} Inapt if variable's value is @code{nil}. @item @code{inapt-if-mode} Inapt if major-mode matches value. @item @code{inapt-if-not-mode} Inapt if major-mode does not match value. @item @code{inapt-if-derived} Inapt if major-mode derives from value. @item @code{inapt-if-not-derived} Inapt if major-mode does not derive from value. @end itemize By default these predicates run when the prefix command is invoked, but this can be changes, using the @code{refresh-suffixes} prefix slot. See @ref{Prefix Slots}. One more slot is shared between group and suffix classes, @code{level}. Like the slots documented above, it is a predicate, but it is used for a different purpose. The value has to be an integer between 1 and 7. @code{level} controls whether a suffix or a group should be available depending on user preference. See @ref{Enabling and Disabling Suffixes}. @node FAQ @appendix FAQ @anchor{Can I control how the menu buffer is displayed?} @appendixsec Can I control how the menu buffer is displayed? Yes, see @code{transient-display-buffer-action} in @ref{Configuration}. You can also control how the menu buffer is displayed on a case-by-case basis by passing @code{:display-action} to @code{transient-define-prefix}. @anchor{How can I copy text from the menu buffer?} @appendixsec How can I copy text from the menu buffer? To be able to mark text in Transient's menu buffer using the mouse, you have to add the below binding. Note that for technical reasons, the region won't be visualized, while doing so. After you have quit the transient menu, you will be able to yank it in another buffer. @lisp (keymap-set transient-predicate-map "" #'transient--do-stay) @end lisp @anchor{How can I autoload prefix and suffix commands?} @appendixsec How can I autoload prefix and suffix commands? If your package only supports Emacs 30, just prefix the definition with @code{;;;###autoload}. If your package supports released versions of Emacs, you unfortunately have to use a long form autoload comment as described in @ref{Autoload,,,elisp,}. @lisp ;;;###autoload (autoload 'magit-dispatch "magit" nil t) (transient-define-prefix magit-dispatch () ...) @end lisp @anchor{How does Transient compare to prefix keys and universal arguments?} @appendixsec How does Transient compare to prefix keys and universal arguments? See @uref{https://github.com/magit/transient/wiki/Comparison-with-prefix-keys-and-universal-arguments}. @anchor{How does Transient compare to Magit-Popup and Hydra?} @appendixsec How does Transient compare to Magit-Popup and Hydra? See @uref{https://github.com/magit/transient/wiki/Comparison-with-other-packages}. @anchor{Why does @kbd{q} not quit popups anymore?} @appendixsec Why does @kbd{q} not quit popups anymore? I agree that @kbd{q} is a good binding for commands that quit something. This includes quitting whatever transient is currently active, but it also includes quitting whatever it is that some specific transient is controlling. The transient @code{magit-blame} for example binds @kbd{q} to the command that turns @code{magit-blame-mode} off. So I had to decide if @kbd{q} should quit the active transient (like Magit-Popup used to) or whether @kbd{C-g} should do that instead, so that @kbd{q} could be bound in individual transient to whatever commands make sense for them. Because all other letters are already reserved for use by individual transients, I have decided to no longer make an exception for @kbd{q}. If you want to get @kbd{q}'s old binding back then you can do so. Doing that is a bit more complicated than changing a single key binding, so I have implemented a function, @code{transient-bind-q-to-quit} that makes the necessary changes. See its documentation string for more information. @node Keystroke Index @appendix Keystroke Index @printindex ky @node Command and Function Index @appendix Command and Function Index @printindex fn @node Variable Index @appendix Variable Index @printindex vr @node Concept Index @appendix Concept Index @printindex cp @node GNU General Public License @appendix GNU General Public License @include gpl.texi @bye transient-0.8.8/lisp/000077500000000000000000000000001500463237300145105ustar00rootroot00000000000000transient-0.8.8/lisp/Makefile000066400000000000000000000022161500463237300161510ustar00rootroot00000000000000-include ../config.mk include ../default.mk lisp: $(ELCS) loaddefs check-declare loaddefs: $(PKG)-autoloads.el %.elc: %.el @printf "Compiling $<\n" @$(EMACS) -Q --batch $(EMACS_ARGS) $(LOAD_PATH) -f batch-byte-compile $< check-declare: @printf " Checking function declarations\n" @$(EMACS) -Q --batch $(EMACS_ARGS) $(LOAD_PATH) \ --eval "(check-declare-directory default-directory)" CLEAN = $(ELCS) $(PKG)-autoloads.el clean: @printf " Cleaning lisp/*...\n" @rm -rf $(CLEAN) $(PKG)-autoloads.el: $(ELS) @printf " Creating $@\n" @$(EMACS) -Q --batch -l autoload -l cl-lib --eval "\ (let ((file (expand-file-name \"$@\"))\ (autoload-timestamps nil) \ (backup-inhibited t)\ (version-control 'never)\ (coding-system-for-write 'utf-8-emacs-unix))\ (write-region (autoload-rubric file \"package\" nil) nil file nil 'silent)\ (cl-letf (((symbol-function 'progress-reporter-do-update) (lambda (&rest _)))\ ((symbol-function 'progress-reporter-done) (lambda (_))))\ (let ((generated-autoload-file file))\ (update-directory-autoloads default-directory))))" \ 2>&1 | sed "/^Package autoload is deprecated$$/d" transient-0.8.8/lisp/transient.el000066400000000000000000006420541500463237300170540ustar00rootroot00000000000000;;; transient.el --- Transient commands -*- lexical-binding:t -*- ;; Copyright (C) 2018-2025 Free Software Foundation, Inc. ;; Author: Jonas Bernoulli ;; Homepage: https://github.com/magit/transient ;; Keywords: extensions ;; Package-Version: 0.8.8 ;; Package-Requires: ((emacs "26.1") (compat "30.1.0.0") (seq "2.24")) ;; SPDX-License-Identifier: GPL-3.0-or-later ;; This file is part of GNU Emacs. ;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published ;; by the Free Software Foundation, either version 3 of the License, ;; or (at your option) any later version. ;; ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . ;;; Commentary: ;; Transient is the library used to implement the keyboard-driven menus ;; in Magit. It is distributed as a separate package, so that it can be ;; used to implement similar menus in other packages. ;;; Code: (defconst transient-version "0.8.8") (require 'cl-lib) (require 'compat) (require 'eieio) (require 'edmacro) (require 'format-spec) (require 'pcase) (require 'pp) (eval-and-compile (when (and (featurep 'seq) (not (fboundp 'seq-keep))) (unload-feature 'seq 'force))) (require 'seq) (unless (fboundp 'seq-keep) (display-warning 'transient (substitute-command-keys "\ Transient requires `seq' >= 2.24, but due to bad defaults, Emacs's package manager, refuses to upgrade this and other built-in packages to higher releases from GNU Elpa, when a package specifies that this is needed. To fix this, you have to add this to your init file: (setq package-install-upgrade-built-in t) Then evaluate that expression by placing the cursor after it and typing \\[eval-last-sexp]. Once you have done that, you have to explicitly upgrade `seq': \\[package-upgrade] seq \\`RET' Then you also must make sure the updated version is loaded, by evaluating this form: (progn (unload-feature 'seq t) (require 'seq)) Until you do this, you will get random errors about `seq-keep' being undefined while using Transient. If you don't use the `package' package manager but still get this warning, then your chosen package manager likely has a similar defect.") :emergency)) (eval-when-compile (require 'subr-x)) (eval-and-compile (unless (boundp 'eieio--unbound) ; New name since Emacs 28.1. (defvaralias 'eieio--unbound 'eieio-unbound nil))) (declare-function info "info" (&optional file-or-node buffer)) (declare-function Man-find-section "man" (section)) (declare-function Man-next-section "man" (n)) (declare-function Man-getpage-in-background "man" (topic)) (defvar Man-notify-method) (defvar pp-default-function) ; since Emacs 29.1 (eval-and-compile (when (< emacs-major-version 28) (pcase-defmacro cl-type (type) "Pcase pattern that matches objects of TYPE. TYPE is a type descriptor as accepted by `cl-typep', which see." (static-if (< emacs-major-version 30) `(pred (pcase--flip cl-typep ',type)) `(pred (cl-typep _ ',type)))))) (make-obsolete-variable 'transient-hide-during-minibuffer-read 'transient-show-during-minibuffer-read "0.8.0") (defvar transient-common-command-prefix) (defmacro transient--with-emergency-exit (id &rest body) (declare (indent defun)) (unless (keywordp id) (setq body (cons id body)) (setq id nil)) `(condition-case err (let ((debugger #'transient--exit-and-debug)) ,(macroexp-progn body)) ((debug error) (transient--emergency-exit ,id) (signal (car err) (cdr err))))) (defun transient--exit-and-debug (&rest args) (transient--emergency-exit :debugger) (apply #'debug args)) ;;; Options (defgroup transient nil "Transient commands." :group 'extensions) (defcustom transient-show-popup t "Whether and when to show transient's menu in a buffer. \\ - If t, then show the buffer as soon as a transient prefix command is invoked. - If nil, then do not show the buffer unless the user explicitly requests it, by pressing \\[transient-show] or a prefix key. - If a number, then delay displaying the buffer and instead show a brief one-line summary. If zero or negative, then suppress even showing that summary and display the pressed key only. Show the buffer once the user explicitly requests it by pressing \\[transient-show] or a prefix key. Unless zero, then also show the buffer after that many seconds of inactivity (using the absolute value)." :package-version '(transient . "0.1.0") :group 'transient :type '(choice (const :tag "Instantly" t) (const :tag "On demand" nil) (const :tag "On demand (no summary)" 0) (number :tag "After delay" 1))) (defcustom transient-enable-popup-navigation 'verbose "Whether navigation commands are enabled in the menu buffer. If the value is `verbose', additionally show brief documentation about the command under point in the echo area. While a transient is active transient's menu buffer is not the current buffer, making it necessary to use dedicated commands to act on that buffer itself. If this is non-nil, then the following bindings are available: \\\ - \\[transient-backward-button] moves the cursor to the previous suffix. - \\[transient-forward-button] moves the cursor to the next suffix. - \\[transient-push-button] invokes the suffix the cursor is on. \\\ - \\`' and \\`' invoke the clicked on suffix. \\\ - \\[transient-isearch-backward]\ and \\[transient-isearch-forward] start isearch in the menu buffer. \\`' and \\`' are bound in `transient-push-button'. All other bindings are in `transient-popup-navigation-map'. By default \\`M-RET' is bound to `transient-push-button', instead of \\`RET', because if a transient allows the invocation of non-suffixes, then it is likely, that you would want \\`RET' to do what it would do if no transient were active." :package-version '(transient . "0.7.8") :group 'transient :type '(choice (const :tag "Enable navigation and echo summary" verbose) (const :tag "Enable navigation commands" t) (const :tag "Disable navigation commands" nil))) (defcustom transient-display-buffer-action '(display-buffer-in-side-window (side . bottom) (dedicated . t) (inhibit-same-window . t)) "The action used to display transient's menu buffer. The transient menu buffer is displayed in a window using (display-buffer BUFFER transient-display-buffer-action) The value of this option has the form (FUNCTION . ALIST), where FUNCTION is a function or a list of functions. Each such function should accept two arguments: a buffer to display and an alist of the same form as ALIST. See info node `(elisp)Choosing Window' for details. The default is: (display-buffer-in-side-window (side . bottom) (dedicated . t) (inhibit-same-window . t)) This displays the window at the bottom of the selected frame. For alternatives see info node `(elisp)Display Action Functions' and info node `(elisp)Buffer Display Action Alists'. When you switch to a different ACTION, you should keep the ALIST entries for `dedicated' and `inhibit-same-window' in most cases. Do not drop them because you are unsure whether they are needed; if you are unsure, then keep them. Note that the buffer that was current before the transient buffer is shown should remain the current buffer. Many suffix commands act on the thing at point, if appropriate, and if the transient buffer became the current buffer, then that would change what is at point. To that effect `inhibit-same-window' ensures that the selected window is not used to show the transient buffer. The use of a horizontal split to display the menu window can lead to incompatibilities and is thus discouraged. Transient tries to mitigate such issue but cannot proactively deal with all possible configurations and combinations of third-party packages. It may be possible to display the window in another frame, but whether that works in practice depends on the window-manager. If the window manager selects the new window (Emacs frame), then that unfortunately changes which buffer is current. If you change the value of this option, then you might also want to change the value of `transient-mode-line-format'." :package-version '(transient . "0.7.5") :group 'transient :type '(cons (choice function (repeat :tag "Functions" function)) alist)) (defcustom transient-minimal-frame-width 83 "Minimal width of dedicated frame used to display transient menu. This is only used if the transient menu is actually displayed in a dedicated frame (see `transient-display-buffer-action'). The value is in characters." :package-version '(transient . "0.8.1") :group 'transient :type 'natnum) (defcustom transient-mode-line-format 'line "The mode-line format for transient's menu buffer. If nil, then the buffer has no mode-line. If the buffer is not displayed right above the echo area, then this probably is not a good value. If `line' (the default) or a natural number, then the buffer has no mode-line, but a line is drawn in its place. If a number is used, that specifies the thickness of the line. On termcap frames we cannot draw lines, so there `line' and numbers are synonyms for nil. The color of the line is used to indicate if non-suffixes are allowed and whether they exit the transient. The foreground color of `transient-key-noop' (if non-suffixes are disallowed), `transient-key-stay' (if allowed and transient stays active), or `transient-key-exit' (if allowed and they exit the transient) is used to draw the line. Otherwise this can be any mode-line format. See `mode-line-format' for details." :package-version '(transient . "0.2.0") :group 'transient :type '(choice (const :tag "Hide mode-line" nil) (const :tag "Substitute thin line" line) (number :tag "Substitute line with thickness") (const :tag "Name of prefix command" ("%e" mode-line-front-space mode-line-buffer-identification)) (sexp :tag "Custom mode-line format"))) (defcustom transient-show-common-commands nil "Whether to permanently show common suffix commands in transient menus. By default these commands are only temporarily shown after typing their shared prefix key \ \\\\[transient-common-command-prefix], \ while a transient menu is active. When the value of this option is non-nil, then these commands are permanently shown. To toggle the value for the current Emacs session only type \ \\\\[transient-toggle-common] while any transient menu is active." :package-version '(transient . "0.1.0") :group 'transient :type 'boolean) (defcustom transient-show-during-minibuffer-read nil "Whether to show the transient menu while reading in the minibuffer. This is only relevant to commands that do not close the menu, such as commands that set infix arguments. If a command exits the menu, and uses the minibuffer, then the menu is always closed before the minibuffer is entered, irrespective of the value of this option. When nil (the default), hide the menu while the minibuffer is in use. When t, keep showing the menu, but allow for the menu window to be resized, to ensure that completion candidates can be displayed. When `fixed', keep showing the menu and prevent it from being resized, which may make it impossible to display the completion candidates. If that ever happens for you, consider using t or an integer, as described below. If the value is `fixed' and the menu window uses the full height of its frame, then the former is ignored and resizing is allowed anyway. This is necessary because individual menus may use unusual display actions different from what `transient-display-buffer-action' specifies (likely to display that menu in a side-window). When using a third-party mode, which automatically resizes windows \(e.g., by calling `balance-windows' on `post-command-hook'), then `fixed' (or nil) is likely a better choice than t. The value can also be an integer, in which case the behavior depends on whether at least that many lines are left to display windows other than the menu window. If that is the case, display the menu and preserve the size of that window. Otherwise, allow resizing the menu window if the number is positive, or hide the menu if it is negative." :package-version '(transient . "0.8.0") :group 'transient :type '(choice (const :tag "Hide menu" nil) (const :tag "Show menu and preserve size" fixed) (const :tag "Show menu and allow resizing" t) (natnum :tag "Show menu, allow resizing if less than N lines left" :format "\n %t: %v" :value 20) (integer :tag "Show menu, except if less than N lines left" :format "\n %t: %v" :value -20))) (defcustom transient-show-docstring-format "%s" "How to display suffix docstrings. The command `transient-toggle-docstrings' toggles between showing suffix descriptions as usual, and instead or additionally displaying the suffix docstrings. The format specified here controls how that is done. %c is the description and %s is the docstring. Use \"%-14c %s\" or similar to display both. This command is not bound by default, see its docstring for instructions." :package-version '(transient . "0.8.4") :group 'transient :type 'string) (defcustom transient-read-with-initial-input nil "Whether to use the last history element as initial minibuffer input." :package-version '(transient . "0.2.0") :group 'transient :type 'boolean) (defcustom transient-highlight-mismatched-keys nil "Whether to highlight keys that do not match their argument. This only affects infix arguments that represent command-line arguments. When this option is non-nil, then the key binding for infix argument are highlighted when only a long argument \(e.g., \"--verbose\") is specified but no shorthand (e.g., \"-v\"). In the rare case that a short-hand is specified but does not match the key binding, then it is highlighted differently. The highlighting is done using `transient-mismatched-key' and `transient-nonstandard-key'." :package-version '(transient . "0.1.0") :group 'transient :type 'boolean) (defcustom transient-highlight-higher-levels nil "Whether to highlight suffixes on higher levels. This is primarily intended for package authors. When non-nil then highlight the description of suffixes whose level is above 4, the default of `transient-default-level'. Assuming you have set that variable to 7, this highlights all suffixes that won't be available to users without them making the same customization." :package-version '(transient . "0.3.6") :group 'transient :type 'boolean) (defcustom transient-substitute-key-function nil "Function used to modify key bindings. This function is called with one argument, the prefix object, and must return a key binding description, either the existing key description it finds in the `key' slot, or a substitution. This is intended to let users replace certain prefix keys. It could also be used to make other substitutions, but that is discouraged. For example, \"=\" is hard to reach using my custom keyboard layout, so I substitute \"(\" for that, which is easy to reach using a layout optimized for Lisp. (setq transient-substitute-key-function (lambda (obj) (let ((key (oref obj key))) (if (string-match \"\\\\`\\\\(=\\\\)[a-zA-Z]\" key) (replace-match \"(\" t t key 1) key)))))" :package-version '(transient . "0.1.0") :group 'transient :type '(choice (const :tag "Transform no keys (nil)" nil) function)) (defcustom transient-semantic-coloring t "Whether to use colors to indicate transient behavior. If non-nil, then the key binding of each suffix is colorized to indicate whether it exits the transient state or not, and the line that is drawn below transient's menu buffer is used to indicate the behavior of non-suffix commands." :package-version '(transient . "0.5.0") :group 'transient :type 'boolean) (defcustom transient-detect-key-conflicts nil "Whether to detect key binding conflicts. Conflicts are detected when a transient prefix command is invoked and results in an error, which prevents the transient from being used." :package-version '(transient . "0.1.0") :group 'transient :type 'boolean) (defcustom transient-error-on-insert-failure nil "Whether to signal an error when failing to insert a suffix. When `transient-insert-suffix' and `transient-append-suffix' fail to insert a suffix into an existing prefix, they usually just show a warning. If this is non-nil, they signal an error instead." :package-version '(transient . "0.8.8") :group 'transient :type 'boolean) (defcustom transient-align-variable-pitch nil "Whether to align columns pixel-wise in the menu buffer. If this is non-nil, then columns are aligned pixel-wise to support variable-pitch fonts. Keys are not aligned, so you should use a fixed-pitch font for the `transient-key' face. Other key faces inherit from that face unless a theme is used that breaks that relationship. This option is intended for users who use a variable-pitch font for the `default' face. See also `transient-force-fixed-pitch'." :package-version '(transient . "0.4.0") :group 'transient :type 'boolean) (defcustom transient-force-fixed-pitch nil "Whether to force use of monospaced font in the menu buffer. Even if you use a proportional font for the `default' face, you might still want to use a monospaced font in transient's menu buffer. Setting this option to t causes `default' to be remapped to `fixed-pitch' in that buffer. See also `transient-align-variable-pitch'." :package-version '(transient . "0.2.0") :group 'transient :type 'boolean) (defcustom transient-force-single-column nil "Whether to force use of a single column to display suffixes. This might be useful for users with low vision who use large text and might otherwise have to scroll in two dimensions." :package-version '(transient . "0.3.6") :group 'transient :type 'boolean) (defconst transient--max-level 7) (defconst transient--default-child-level 1) (defconst transient--default-prefix-level 4) (defcustom transient-default-level transient--default-prefix-level "Control what suffix levels are made available by default. Each suffix command is placed on a level and each prefix command has a level, which controls which suffix commands are available. Integers between 1 and 7 (inclusive) are valid levels. The levels of individual transients and/or their individual suffixes can be changed individually, by invoking the prefix and then pressing \\\\[transient-set-level]. The default level for both transients and their suffixes is 4. This option only controls the default for transients. The default suffix level is always 4. The author of a transient should place certain suffixes on a higher level if they expect that it won't be of use to most users, and they should place very important suffixes on a lower level so that they remain available even if the user lowers the transient level. \(Magit currently places nearly all suffixes on level 4 and lower levels are not used at all yet. So for the time being you should not set a lower level here and using a higher level might not give you as many additional suffixes as you hoped.)" :package-version '(transient . "0.1.0") :group 'transient :type '(choice (const :tag "1 - fewest suffixes" 1) (const 2) (const 3) (const :tag "4 - default" 4) (const 5) (const 6) (const :tag "7 - most suffixes" 7))) (defcustom transient-levels-file (locate-user-emacs-file "transient/levels.el") "File used to save levels of transients and their suffixes." :package-version '(transient . "0.1.0") :group 'transient :type 'file) (defcustom transient-values-file (locate-user-emacs-file "transient/values.el") "File used to save values of transients." :package-version '(transient . "0.1.0") :group 'transient :type 'file) (defcustom transient-history-file (locate-user-emacs-file "transient/history.el") "File used to save history of transients and their infixes." :package-version '(transient . "0.1.0") :group 'transient :type 'file) (defcustom transient-history-limit 10 "Number of history elements to keep when saving to file." :package-version '(transient . "0.1.0") :group 'transient :type 'integer) (defcustom transient-save-history t "Whether to save history of transient commands when exiting Emacs." :package-version '(transient . "0.1.0") :group 'transient :type 'boolean) ;;; Faces (defgroup transient-faces nil "Faces used by Transient." :group 'transient) (defface transient-heading '((t :inherit font-lock-keyword-face)) "Face used for headings." :group 'transient-faces) (defface transient-argument '((t :inherit font-lock-string-face :weight bold)) "Face used for enabled arguments." :group 'transient-faces) (defface transient-inactive-argument '((t :inherit shadow)) "Face used for inactive arguments." :group 'transient-faces) (defface transient-value '((t :inherit font-lock-string-face :weight bold)) "Face used for values." :group 'transient-faces) (defface transient-inactive-value '((t :inherit shadow)) "Face used for inactive values." :group 'transient-faces) (defface transient-unreachable '((t :inherit shadow)) "Face used for suffixes unreachable from the current prefix sequence." :group 'transient-faces) (defface transient-inapt-suffix '((t :inherit shadow :slant italic)) "Face used for suffixes that are inapt at this time." :group 'transient-faces) (defface transient-active-infix '((t :inherit highlight)) "Face used for the infix for which the value is being read." :group 'transient-faces) (defface transient-enabled-suffix '((t :background "green" :foreground "black" :weight bold)) "Face used for enabled levels while editing suffix levels. See info node `(transient)Enabling and Disabling Suffixes'." :group 'transient-faces) (defface transient-disabled-suffix '((t :background "red" :foreground "black" :weight bold)) "Face used for disabled levels while editing suffix levels. See info node `(transient)Enabling and Disabling Suffixes'." :group 'transient-faces) (defface transient-higher-level `((t :box ( :line-width ,(if (>= emacs-major-version 28) (cons -1 -1) -1) :color ,(let ((color (face-attribute 'shadow :foreground t t))) (or (and (not (eq color 'unspecified)) color) "grey60"))))) "Face optionally used to highlight suffixes on higher levels. See also option `transient-highlight-higher-levels'." :group 'transient-faces) (defface transient-delimiter '((t :inherit shadow)) "Face used for delimiters and separators. This includes the parentheses around values and the pipe character used to separate possible values from each other." :group 'transient-faces) (defface transient-key '((t :inherit font-lock-builtin-face)) "Face used for keys." :group 'transient-faces) (defface transient-key-stay `((((class color) (background light)) :inherit transient-key :foreground "#22aa22") (((class color) (background dark)) :inherit transient-key :foreground "#ddffdd")) "Face used for keys of suffixes that don't exit the menu." :group 'transient-faces) (defface transient-key-noop `((((class color) (background light)) :inherit transient-key :foreground "grey80") (((class color) (background dark)) :inherit transient-key :foreground "grey30")) "Face used for keys of suffixes that currently cannot be invoked." :group 'transient-faces) (defface transient-key-return `((((class color) (background light)) :inherit transient-key :foreground "#aaaa11") (((class color) (background dark)) :inherit transient-key :foreground "#ffffcc")) "Face used for keys of suffixes that return to the parent menu." :group 'transient-faces) (defface transient-key-recurse `((((class color) (background light)) :inherit transient-key :foreground "#2266ff") (((class color) (background dark)) :inherit transient-key :foreground "#2299ff")) "Face used for keys of sub-menus whose suffixes return to the parent menu." :group 'transient-faces) (defface transient-key-stack `((((class color) (background light)) :inherit transient-key :foreground "#dd4488") (((class color) (background dark)) :inherit transient-key :foreground "#ff6699")) "Face used for keys of sub-menus that exit the parent menu." :group 'transient-faces) (defface transient-key-exit `((((class color) (background light)) :inherit transient-key :foreground "#aa2222") (((class color) (background dark)) :inherit transient-key :foreground "#ffdddd")) "Face used for keys of suffixes that exit the menu." :group 'transient-faces) (defface transient-unreachable-key '((t :inherit (shadow transient-key) :weight normal)) "Face used for keys unreachable from the current prefix sequence." :group 'transient-faces) (defface transient-nonstandard-key `((t :box ( :line-width ,(if (>= emacs-major-version 28) (cons -1 -1) -1) :color "cyan"))) "Face optionally used to highlight keys conflicting with short-argument. See also option `transient-highlight-mismatched-keys'." :group 'transient-faces) (defface transient-mismatched-key `((t :box ( :line-width ,(if (>= emacs-major-version 28) (cons -1 -1) -1) :color "magenta"))) "Face optionally used to highlight keys without a short-argument. See also option `transient-highlight-mismatched-keys'." :group 'transient-faces) ;;; Persistence (defun transient--read-file-contents (file) (with-demoted-errors "Transient error: %S" (and (file-exists-p file) (with-temp-buffer (insert-file-contents file) (read (current-buffer)))))) (defun transient--pp-to-file (list file) (make-directory (file-name-directory file) t) (setq list (cl-sort (copy-sequence list) #'string< :key #'car)) (with-temp-file file (let ((print-level nil) (print-length nil) (pp-default-function 'pp-28) (fill-column 999)) (pp list (current-buffer))))) (defvar transient-values (transient--read-file-contents transient-values-file) "Values of transient commands. The value of this variable persists between Emacs sessions and you usually should not change it manually.") (defun transient-save-values () (transient--pp-to-file transient-values transient-values-file)) (defvar transient-levels (transient--read-file-contents transient-levels-file) "Levels of transient commands. The value of this variable persists between Emacs sessions and you usually should not change it manually.") (defun transient-save-levels () (transient--pp-to-file transient-levels transient-levels-file)) (defvar transient-history (transient--read-file-contents transient-history-file) "History of transient commands and infix arguments. The value of this variable persists between Emacs sessions \(unless `transient-save-history' is nil) and you usually should not change it manually.") (defun transient-save-history () (setq transient-history (cl-sort (mapcar (pcase-lambda (`(,key . ,val)) (cons key (seq-take (delete-dups val) transient-history-limit))) transient-history) #'string< :key #'car)) (transient--pp-to-file transient-history transient-history-file)) (defun transient-maybe-save-history () "Save the value of `transient-history'. If `transient-save-history' is nil, then do nothing." (when transient-save-history (with-demoted-errors "Error saving transient history: %S" (transient-save-history)))) (unless noninteractive (add-hook 'kill-emacs-hook #'transient-maybe-save-history)) ;;; Classes ;;;; Prefix (defclass transient-prefix () ((prototype :initarg :prototype) (command :initarg :command) (level :initarg :level) (init-value :initarg :init-value) (value) (default-value :initarg :value) (return :initarg :return :initform nil) (scope :initarg :scope :initform nil) (history :initarg :history :initform nil) (history-pos :initarg :history-pos :initform 0) (history-key :initarg :history-key :initform nil) (show-help :initarg :show-help :initform nil) (info-manual :initarg :info-manual :initform nil) (man-page :initarg :man-page :initform nil) (transient-suffix :initarg :transient-suffix :initform nil) (transient-non-suffix :initarg :transient-non-suffix :initform nil) (transient-switch-frame :initarg :transient-switch-frame) (refresh-suffixes :initarg :refresh-suffixes :initform nil) (environment :initarg :environment :initform nil) (incompatible :initarg :incompatible :initform nil) (suffix-description :initarg :suffix-description) (display-action :initarg :display-action :initform nil) (mode-line-format :initarg :mode-line-format) (variable-pitch :initarg :variable-pitch :initform nil) (column-widths :initarg :column-widths :initform nil) (unwind-suffix :documentation "Internal use." :initform nil)) "Transient prefix command. Each transient prefix command consists of a command, which is stored in a symbol's function slot and an object, which is stored in the `transient--prefix' property of the same symbol. When a transient prefix command is invoked, then a clone of that object is stored in the global variable `transient--prefix' and the prototype is stored in the clone's `prototype' slot.") ;;;; Suffix (defclass transient-child () ((parent :initarg :parent :initform nil :documentation "The parent group object.") (level :initarg :level :initform nil :documentation "Enable if level of prefix is equal or greater.") (if :initarg :if :initform nil :documentation "Enable if predicate returns non-nil.") (if-not :initarg :if-not :initform nil :documentation "Enable if predicate returns nil.") (if-non-nil :initarg :if-non-nil :initform nil :documentation "Enable if variable's value is non-nil.") (if-nil :initarg :if-nil :initform nil :documentation "Enable if variable's value is nil.") (if-mode :initarg :if-mode :initform nil :documentation "Enable if major-mode matches value.") (if-not-mode :initarg :if-not-mode :initform nil :documentation "Enable if major-mode does not match value.") (if-derived :initarg :if-derived :initform nil :documentation "Enable if major-mode derives from value.") (if-not-derived :initarg :if-not-derived :initform nil :documentation "Enable if major-mode does not derive from value.") (inapt :initform nil) (inapt-face :initarg :inapt-face :initform 'transient-inapt-suffix) (inapt-if :initarg :inapt-if :initform nil :documentation "Inapt if predicate returns non-nil.") (inapt-if-not :initarg :inapt-if-not :initform nil :documentation "Inapt if predicate returns nil.") (inapt-if-non-nil :initarg :inapt-if-non-nil :initform nil :documentation "Inapt if variable's value is non-nil.") (inapt-if-nil :initarg :inapt-if-nil :initform nil :documentation "Inapt if variable's value is nil.") (inapt-if-mode :initarg :inapt-if-mode :initform nil :documentation "Inapt if major-mode matches value.") (inapt-if-not-mode :initarg :inapt-if-not-mode :initform nil :documentation "Inapt if major-mode does not match value.") (inapt-if-derived :initarg :inapt-if-derived :initform nil :documentation "Inapt if major-mode derives from value.") (inapt-if-not-derived :initarg :inapt-if-not-derived :initform nil :documentation "Inapt if major-mode does not derive from value.") (advice :initarg :advice :initform nil :documentation "Advise applied to the command body.") (advice* :initarg :advice* :initform nil :documentation "Advise applied to the command body and interactive spec.")) "Abstract superclass for group and suffix classes. It is undefined which predicates are used if more than one `if*' predicate slots or more than one `inapt-if*' slots are non-nil." :abstract t) (defclass transient-suffix (transient-child) ((definition :allocation :class :initform nil) (key :initarg :key) (command :initarg :command) (transient :initarg :transient) (format :initarg :format :initform " %k %d") (description :initarg :description :initform nil) (face :initarg :face :initform nil) (show-help :initarg :show-help :initform nil) (summary :initarg :summary :initform nil)) "Superclass for suffix command.") (defclass transient-information (transient-suffix) ((format :initform " %k %d") (key :initform " ")) "Display-only information, aligned with suffix keys. Technically a suffix object with no associated command.") (defclass transient-information* (transient-information) ((format :initform " %d")) "Display-only information, aligned with suffix descriptions. Technically a suffix object with no associated command.") (defclass transient-infix (transient-suffix) ((transient :initform t) (argument :initarg :argument) (shortarg :initarg :shortarg) (value :initform nil) (init-value :initarg :init-value) (unsavable :initarg :unsavable :initform nil) (multi-value :initarg :multi-value :initform nil) (always-read :initarg :always-read :initform nil) (allow-empty :initarg :allow-empty :initform nil) (history-key :initarg :history-key :initform nil) (reader :initarg :reader :initform nil) (prompt :initarg :prompt :initform nil) (choices :initarg :choices :initform nil) (format :initform " %k %d (%v)")) "Transient infix command." :abstract t) (defclass transient-argument (transient-infix) () "Abstract superclass for infix arguments." :abstract t) (defclass transient-switch (transient-argument) () "Class used for command-line argument that can be turned on and off.") (defclass transient-option (transient-argument) () "Class used for command-line argument that can take a value.") (defclass transient-variable (transient-infix) ((variable :initarg :variable) (format :initform " %k %d %v")) "Abstract superclass for infix commands that set a variable." :abstract t) (defclass transient-switches (transient-argument) ((argument-format :initarg :argument-format) (argument-regexp :initarg :argument-regexp)) "Class used for sets of mutually exclusive command-line switches.") (defclass transient-files (transient-option) () ((key :initform "--") (argument :initform "--") (multi-value :initform rest) (reader :initform transient-read-files)) "Class used for the \"--\" argument or similar. All remaining arguments are treated as files. They become the value of this argument.") (defclass transient-value-preset (transient-suffix) ((transient :initform t) (set :initarg := :initform nil)) "Class used by the `transient-preset' suffix command.") (defclass transient-describe-target (transient-suffix) ((transient :initform #'transient--do-suspend) (helper :initarg :helper :initform nil) (target :initarg := :initform nil)) "Class used by the `transient-describe' suffix command.") ;;;; Group (defclass transient-group (transient-child) ((suffixes :initarg :suffixes :initform nil) (hide :initarg :hide :initform nil) (description :initarg :description :initform nil) (pad-keys :initarg :pad-keys :initform nil) (info-format :initarg :info-format :initform nil) (setup-children :initarg :setup-children)) "Abstract superclass of all group classes." :abstract t) (defclass transient-column (transient-group) () "Group class that displays each element on a separate line.") (defclass transient-row (transient-group) () "Group class that displays all elements on a single line.") (defclass transient-columns (transient-group) () "Group class that displays elements organized in columns. Direct elements have to be groups whose elements have to be commands or strings. Each subgroup represents a column. This class takes care of inserting the subgroups' elements.") (defclass transient-subgroups (transient-group) () "Group class that wraps other groups. Direct elements have to be groups whose elements have to be commands or strings. This group inserts an empty line between subgroups. The subgroups are responsible for displaying their elements themselves.") ;;; Define (defmacro transient-define-prefix (name arglist &rest args) "Define NAME as a transient prefix command. ARGLIST are the arguments that command takes. DOCSTRING is the documentation string and is optional. These arguments can optionally be followed by key-value pairs. Each key has to be a keyword symbol, either `:class' or a keyword argument supported by the constructor of that class. The `transient-prefix' class is used if the class is not specified explicitly. GROUPs add key bindings for infix and suffix commands and specify how these bindings are presented in the menu buffer. At least one GROUP has to be specified. See info node `(transient)Binding Suffix and Infix Commands'. The BODY is optional. If it is omitted, then ARGLIST is also ignored and the function definition becomes: (lambda () (interactive) (transient-setup \\='NAME)) If BODY is specified, then it must begin with an `interactive' form that matches ARGLIST, and it must call `transient-setup'. It may however call that function only when some condition is satisfied; that is one of the reason why you might want to use an explicit BODY. All transients have a (possibly nil) value, which is exported when suffix commands are called, so that they can consume that value. For some transients it might be necessary to have a sort of secondary value, called a scope. Such a scope would usually be set in the commands `interactive' form and has to be passed to the setup function: (transient-setup \\='NAME nil nil :scope SCOPE) \(fn NAME ARGLIST [DOCSTRING] [KEYWORD VALUE]... GROUP... [BODY...])" (declare (debug ( &define name lambda-list [&optional lambda-doc] [&rest keywordp sexp] [&rest vectorp] [&optional ("interactive" interactive) def-body])) (indent defun) (doc-string 3)) (pcase-let ((`(,class ,slots ,suffixes ,docstr ,body ,interactive-only) (transient--expand-define-args args arglist 'transient-define-prefix))) `(progn (defalias ',name ,(if body `(lambda ,arglist ,@body) `(lambda () (interactive) (transient-setup ',name)))) (put ',name 'interactive-only ,interactive-only) (put ',name 'function-documentation ,docstr) (put ',name 'transient--prefix (,(or class 'transient-prefix) :command ',name ,@slots)) (put ',name 'transient--layout (list ,@(mapcan (lambda (s) (transient--parse-child name s)) suffixes)))))) (defmacro transient-define-suffix (name arglist &rest args) "Define NAME as a transient suffix command. ARGLIST are the arguments that the command takes. DOCSTRING is the documentation string and is optional. These arguments can optionally be followed by key-value pairs. Each key has to be a keyword symbol, either `:class' or a keyword argument supported by the constructor of that class. The `transient-suffix' class is used if the class is not specified explicitly. The BODY must begin with an `interactive' form that matches ARGLIST. The infix arguments are usually accessed by using `transient-args' inside `interactive'. \(fn NAME ARGLIST [DOCSTRING] [KEYWORD VALUE]... [BODY...])" (declare (debug ( &define name lambda-list [&optional lambda-doc] [&rest keywordp sexp] [&optional ("interactive" interactive) def-body])) (indent defun) (doc-string 3)) (pcase-let ((`(,class ,slots ,_ ,docstr ,body ,interactive-only) (transient--expand-define-args args arglist 'transient-define-suffix))) `(progn (defalias ',name ,(if (and (not body) class (oref-default class definition)) `(oref-default ',class definition) `(lambda ,arglist ,@body))) (put ',name 'interactive-only ,interactive-only) (put ',name 'function-documentation ,docstr) (put ',name 'transient--suffix (,(or class 'transient-suffix) :command ',name ,@slots))))) (defmacro transient-augment-suffix (name &rest args) "Augment existing command NAME with a new transient suffix object. Similar to `transient-define-suffix' but define a suffix object only. \n\(fn NAME [KEYWORD VALUE]...)" (declare (debug (&define name [&rest keywordp sexp])) (indent defun)) (pcase-let ((`(,class ,slots) (transient--expand-define-args args nil 'transient-augment-suffix t))) `(put ',name 'transient--suffix (,(or class 'transient-suffix) :command ',name ,@slots)))) (defmacro transient-define-infix (name arglist &rest args) "Define NAME as a transient infix command. ARGLIST is always ignored and reserved for future use. DOCSTRING is the documentation string and is optional. At least one key-value pair is required. All transient infix commands are equal to each other (but not eq). It is meaning- less to define an infix command, without providing at least one keyword argument (usually `:argument' or `:variable', depending on the class). The suffix class defaults to `transient-switch' and can be set using the `:class' keyword. The function definitions is always: (lambda () (interactive) (let ((obj (transient-suffix-object))) (transient-infix-set obj (transient-infix-read obj))) (transient--show)) `transient-infix-read' and `transient-infix-set' are generic functions. Different infix commands behave differently because the concrete methods are different for different infix command classes. In rare case the above command function might not be suitable, even if you define your own infix command class. In that case you have to use `transient-define-suffix' to define the infix command and use t as the value of the `:transient' keyword. \(fn NAME ARGLIST [DOCSTRING] KEYWORD VALUE [KEYWORD VALUE]...)" (declare (debug ( &define name lambda-list [&optional lambda-doc] keywordp sexp [&rest keywordp sexp])) (indent defun) (doc-string 3)) (pcase-let ((`(,class ,slots ,_ ,docstr ,_ ,interactive-only) (transient--expand-define-args args arglist 'transient-define-infix t))) `(progn (defalias ',name #'transient--default-infix-command) (put ',name 'interactive-only ,interactive-only) (put ',name 'completion-predicate #'transient--suffix-only) (put ',name 'function-documentation ,docstr) (put ',name 'transient--suffix (,(or class 'transient-switch) :command ',name ,@slots))))) (defalias 'transient-define-argument #'transient-define-infix "Define NAME as a transient infix command. Only use this alias to define an infix command that actually sets an infix argument. To define a infix command that, for example, sets a variable, use `transient-define-infix' instead. \(fn NAME ARGLIST [DOCSTRING] [KEYWORD VALUE]...)") (defun transient--default-infix-command () ;; Most infix commands are but an alias for this command. "Cannot show any documentation for this transient infix command. When you request help for an infix command using `transient-help', that usually shows the respective man-page and tries to jump to the location where the respective argument is being described. If no man-page is specified for the containing transient menu, then the docstring is displayed instead, if any. If the infix command doesn't have a docstring, as is the case here, then this docstring is displayed instead, because technically infix commands are aliases for `transient--default-infix-command'. `describe-function' also shows the docstring of the infix command, falling back to that of the same aliased command." (interactive) (let ((obj (transient-suffix-object))) (transient-infix-set obj (transient-infix-read obj))) (transient--show)) (put 'transient--default-infix-command 'interactive-only t) (put 'transient--default-infix-command 'completion-predicate #'transient--suffix-only) (define-advice find-function-advised-original (:around (fn func) transient-default-infix) "Return nil instead of `transient--default-infix-command'. When using `find-function' to jump to the definition of a transient infix command/argument, then we want to actually jump to that, not to the definition of `transient--default-infix-command', which all infix commands are aliases for." (let ((val (funcall fn func))) (and val (not (eq val 'transient--default-infix-command)) val))) (eval-and-compile ;transient--expand-define-args (defun transient--expand-define-args (args &optional arglist form nobody) ;; ARGLIST and FORM are only optional for backward compatibility. ;; This is necessary because "emoji.el" from Emacs 29 calls this ;; function directly, with just one argument. (declare (advertised-calling-convention (args arglist form &optional nobody) "0.7.1")) (unless (listp arglist) (error "Mandatory ARGLIST is missing")) (let (class keys suffixes docstr declare (interactive-only t)) (when (stringp (car args)) (setq docstr (pop args))) (while (keywordp (car args)) (let ((k (pop args)) (v (pop args))) (if (eq k :class) (setq class v) (push k keys) (push v keys)))) (while (let ((arg (car args))) (or (vectorp arg) (and arg (symbolp arg)))) (push (pop args) suffixes)) (when (eq (car-safe (car args)) 'declare) (setq declare (car args)) (setq args (cdr args)) (when-let ((int (assq 'interactive-only declare))) (setq interactive-only (cadr int)) (delq int declare)) (unless (cdr declare) (setq declare nil))) (cond ((not args)) (nobody (error "%s: No function body allowed" form)) ((not (eq (car-safe (nth (if declare 1 0) args)) 'interactive)) (error "%s: Interactive form missing" form))) (list (if (eq (car-safe class) 'quote) (cadr class) class) (nreverse keys) (nreverse suffixes) docstr (if declare (cons declare args) args) interactive-only)))) (defun transient--parse-child (prefix spec) (cl-typecase spec (null (error "Invalid transient--parse-child spec: %s" spec)) (symbol (let ((value (symbol-value spec))) (if (and (listp value) (or (listp (car value)) (vectorp (car value)))) (mapcan (lambda (s) (transient--parse-child prefix s)) value) (transient--parse-child prefix value)))) (vector (and-let* ((c (transient--parse-group prefix spec))) (list c))) (list (and-let* ((c (transient--parse-suffix prefix spec))) (list c))) (string (list spec)) (t (error "Invalid transient--parse-child spec: %s" spec)))) (defun transient--parse-group (prefix spec) (let ((spec (append spec nil)) level class args) (when (integerp (car spec)) (setq level (pop spec))) (when (stringp (car spec)) (setq args (plist-put args :description (pop spec)))) ;; Merge value of [... GROUP-VARIABLE], if any. (let ((spec* spec)) (while (keywordp (car spec*)) (setq spec* (cddr spec*))) (when (and (length= spec* 1) (symbolp (car spec*))) (let ((rest (append (symbol-value (car spec*)) nil)) (args nil)) (while (keywordp (car rest)) (setq args (nconc (list (pop rest) (pop rest)) args))) (setq spec (nconc args (butlast spec) rest))))) (while (keywordp (car spec)) (let* ((key (pop spec)) (val (if spec (pop spec) (error "No value for `%s'" key)))) (cond ((eq key :class) (setq class val)) ((or (symbolp val) (and (listp val) (not (memq (car val) (list 'lambda (intern "")))))) (setq args (plist-put args key (macroexp-quote val)))) ((setq args (plist-put args key val)))))) (unless (or spec class (not (plist-get args :setup-children))) (message "WARNING: %s: When %s is used, %s must also be specified" 'transient-define-prefix :setup-children :class)) (list 'vector level (list 'quote (cond (class) ((cl-typep (car spec) '(or vector (and symbol (not null)))) 'transient-columns) ('transient-column))) (and args (cons 'list args)) (cons 'list (mapcan (lambda (s) (transient--parse-child prefix s)) spec))))) (defun transient--parse-suffix (prefix spec) (let (level class args) (cl-flet ((use (prop value) (setq args (plist-put args prop value)))) (pcase (car spec) ((cl-type integer) (setq level (pop spec)))) (pcase (car spec) ((cl-type (or string vector)) (use :key (pop spec)))) (pcase (car spec) ((guard (or (stringp (car spec)) (and (eq (car-safe (car spec)) 'lambda) (not (commandp (car spec)))))) (use :description (pop spec))) ((and (cl-type (and symbol (not keyword) (not command))) (guard (commandp (cadr spec)))) (use :description (macroexp-quote (pop spec))))) (pcase (car spec) ((or :info :info*)) ((and (cl-type keyword) invalid) (error "Need command, argument, `:info' or `:info*'; got `%s'" invalid)) ((cl-type symbol) (use :command (macroexp-quote (pop spec)))) ;; During macro-expansion this is expected to be a `lambda' ;; expression (i.e., source code). When this is called from a ;; `:setup-children' function, it may also be a function object ;; (a.k.a a function value). However, we never treat a string ;; as a command, so we have to check for that explicitly. ((cl-type (and command (not string))) (let ((cmd (pop spec)) (sym (intern (format "transient:%s:%s:%d" prefix (replace-regexp-in-string (plist-get args :key) " " "") (prog1 gensym-counter (cl-incf gensym-counter)))))) (use :command `(prog1 ',sym (put ',sym 'interactive-only t) (put ',sym 'completion-predicate #'transient--suffix-only) (defalias ',sym ,cmd))))) ((cl-type (or string (and list (not null)))) (let ((arg (pop spec))) (cl-typecase arg (list (use :shortarg (car arg)) (use :argument (cadr arg)) (setq arg (cadr arg))) (string (when-let ((shortarg (transient--derive-shortarg arg))) (use :shortarg shortarg)) (use :argument arg))) (use :command (let ((sym (intern (format "transient:%s:%s" prefix arg)))) `(prog1 ',sym (put ',sym 'interactive-only t) (put ',sym 'completion-predicate #'transient--suffix-only) (defalias ',sym #'transient--default-infix-command)))) (pcase (car spec) ((cl-type (and (not null) (not keyword))) (setq class 'transient-option) (use :reader (macroexp-quote (pop spec)))) ((guard (string-suffix-p "=" arg)) (setq class 'transient-option)) (_ (setq class 'transient-switch))))) (invalid (error "Need command, argument, `:info' or `:info*'; got %s" invalid))) (while (keywordp (car spec)) (let* ((key (pop spec)) (val (if spec (pop spec) (error "No value for `%s'" key)))) (pcase key (:class (setq class val)) (:level (setq level val)) (:info (setq class 'transient-information) (use :description val)) (:info* (setq class 'transient-information*) (use :description val)) ((guard (eq (car-safe val) '\,)) (use key (cadr val))) ((guard (or (symbolp val) (and (listp val) (not (memq (car val) (list 'lambda (intern ""))))))) (use key (macroexp-quote val))) (_ (use key val))))) (when spec (error "Need keyword, got %S" (car spec))) (if-let ((key (plist-get args :key))) (when (string-match "\\`\\({p}\\)" key) (use :key (replace-match transient-common-command-prefix t t key 1))) (when-let ((shortarg (plist-get args :shortarg))) (use :key shortarg)))) (list 'list level (macroexp-quote (or class 'transient-suffix)) (cons 'list args)))) (defun transient--derive-shortarg (arg) (save-match-data (and (string-match "\\`\\(-[a-zA-Z]\\)\\(\\'\\|=\\)" arg) (match-string 1 arg)))) (defun transient-command-completion-not-suffix-only-p (symbol _buffer) "Say whether SYMBOL should be offered as a completion. If the value of SYMBOL's `completion-predicate' property is `transient--suffix-only', then return nil, otherwise return t. This is the case when a command should only ever be used as a suffix of a transient prefix command (as opposed to bindings in regular keymaps or by using `execute-extended-command')." (not (eq (get symbol 'completion-predicate) 'transient--suffix-only))) (defalias 'transient--suffix-only #'ignore "Ignore ARGUMENTS, do nothing, and return nil. See also `transient-command-completion-not-suffix-only-p'. Only use this alias as the value of the `completion-predicate' symbol property.") (when (and (boundp 'read-extended-command-predicate) ; since Emacs 28.1 (not read-extended-command-predicate)) (setq read-extended-command-predicate #'transient-command-completion-not-suffix-only-p)) (defun transient-parse-suffix (prefix suffix) "Parse SUFFIX, to be added to PREFIX. PREFIX is a prefix command, a symbol. SUFFIX is a suffix command or a group specification (of the same forms as expected by `transient-define-prefix'). Intended for use in a group's `:setup-children' function." (cl-assert (and prefix (symbolp prefix))) (eval (car (transient--parse-child prefix suffix)) t)) (defun transient-parse-suffixes (prefix suffixes) "Parse SUFFIXES, to be added to PREFIX. PREFIX is a prefix command, a symbol. SUFFIXES is a list of suffix command or a group specification (of the same forms as expected by `transient-define-prefix'). Intended for use in a group's `:setup-children' function." (cl-assert (and prefix (symbolp prefix))) (mapcar (apply-partially #'transient-parse-suffix prefix) suffixes)) ;;; Edit (defun transient--insert-suffix (prefix loc suffix action &optional keep-other) (let* ((suf (cl-etypecase suffix (vector (transient--parse-group prefix suffix)) (list (transient--parse-suffix prefix suffix)) (string suffix))) (mem (transient--layout-member loc prefix)) (elt (car mem))) (setq suf (eval suf t)) (cond ((not mem) (funcall (if transient-error-on-insert-failure #'error #'message) "Cannot insert %S into %s; %s not found" suffix prefix loc)) ((or (and (vectorp suffix) (not (vectorp elt))) (and (listp suffix) (vectorp elt)) (and (stringp suffix) (vectorp elt))) (funcall (if transient-error-on-insert-failure #'error #'message) "Cannot place %S into %s at %s; %s" suffix prefix loc "suffixes and groups cannot be siblings")) (t (when-let* (((not (eq keep-other 'always))) (bindingp (listp suf)) (key (transient--spec-key suf)) (conflict (car (transient--layout-member key prefix))) (conflictp (and (not (and (eq action 'replace) (eq conflict elt))) (or (not keep-other) (eq (plist-get (nth 2 suf) :command) (plist-get (nth 2 conflict) :command))) (equal (transient--suffix-predicate suf) (transient--suffix-predicate conflict))))) (transient-remove-suffix prefix key)) (pcase-exhaustive action ('insert (setcdr mem (cons elt (cdr mem))) (setcar mem suf)) ('append (setcdr mem (cons suf (cdr mem)))) ('replace (setcar mem suf))))))) ;;;###autoload (defun transient-insert-suffix (prefix loc suffix &optional keep-other) "Insert a SUFFIX into PREFIX before LOC. PREFIX is a prefix command, a symbol. SUFFIX is a suffix command or a group specification (of the same forms as expected by `transient-define-prefix'). LOC is a command, a key vector, a key description (a string as returned by `key-description'), or a coordination list (whose last element may also be a command or key). Remove a conflicting binding unless optional KEEP-OTHER is non-nil. When the conflict appears to be a false-positive, non-nil KEEP-OTHER may be ignored, which can be prevented by using `always'. See info node `(transient)Modifying Existing Transients'." (declare (indent defun)) (transient--insert-suffix prefix loc suffix 'insert keep-other)) ;;;###autoload (defun transient-append-suffix (prefix loc suffix &optional keep-other) "Insert a SUFFIX into PREFIX after LOC. PREFIX is a prefix command, a symbol. SUFFIX is a suffix command or a group specification (of the same forms as expected by `transient-define-prefix'). LOC is a command, a key vector, a key description (a string as returned by `key-description'), or a coordination list (whose last element may also be a command or key). Remove a conflicting binding unless optional KEEP-OTHER is non-nil. When the conflict appears to be a false-positive, non-nil KEEP-OTHER may be ignored, which can be prevented by using `always'. See info node `(transient)Modifying Existing Transients'." (declare (indent defun)) (transient--insert-suffix prefix loc suffix 'append keep-other)) ;;;###autoload (defun transient-replace-suffix (prefix loc suffix) "Replace the suffix at LOC in PREFIX with SUFFIX. PREFIX is a prefix command, a symbol. SUFFIX is a suffix command or a group specification (of the same forms as expected by `transient-define-prefix'). LOC is a command, a key vector, a key description (a string as returned by `key-description'), or a coordination list (whose last element may also be a command or key). See info node `(transient)Modifying Existing Transients'." (declare (indent defun)) (transient--insert-suffix prefix loc suffix 'replace)) ;;;###autoload (defun transient-remove-suffix (prefix loc) "Remove the suffix or group at LOC in PREFIX. PREFIX is a prefix command, a symbol. LOC is a command, a key vector, a key description (a string as returned by `key-description'), or a coordination list (whose last element may also be a command or key). See info node `(transient)Modifying Existing Transients'." (declare (indent defun)) (transient--layout-member loc prefix 'remove)) (defun transient-get-suffix (prefix loc) "Return the suffix or group at LOC in PREFIX. PREFIX is a prefix command, a symbol. LOC is a command, a key vector, a key description (a string as returned by `key-description'), or a coordination list (whose last element may also be a command or key). See info node `(transient)Modifying Existing Transients'." (if-let ((mem (transient--layout-member loc prefix))) (car mem) (error "%s not found in %s" loc prefix))) (defun transient-suffix-put (prefix loc prop value) "Edit the suffix at LOC in PREFIX, setting PROP to VALUE. PREFIX is a prefix command, a symbol. SUFFIX is a suffix command or a group specification (of the same forms as expected by `transient-define-prefix'). LOC is a command, a key vector, a key description (a string as returned by `key-description'), or a coordination list (whose last element may also be a command or key). See info node `(transient)Modifying Existing Transients'." (let ((suf (transient-get-suffix prefix loc))) (setf (elt suf 2) (plist-put (elt suf 2) prop value)))) (defun transient--layout-member (loc prefix &optional remove) (let ((val (or (get prefix 'transient--layout) (error "%s is not a transient command" prefix)))) (when (listp loc) (while (integerp (car loc)) (let* ((children (if (vectorp val) (aref val 3) val)) (mem (transient--nthcdr (pop loc) children))) (if (and remove (not loc)) (let ((rest (delq (car mem) children))) (if (vectorp val) (aset val 3 rest) (put prefix 'transient--layout rest)) (setq val nil)) (setq val (if loc (car mem) mem))))) (setq loc (car loc))) (if loc (transient--layout-member-1 (transient--kbd loc) val remove) val))) (defun transient--layout-member-1 (loc layout remove) (cond ((listp layout) (seq-some (lambda (elt) (transient--layout-member-1 loc elt remove)) layout)) ((vectorp (car (aref layout 3))) (seq-some (lambda (elt) (transient--layout-member-1 loc elt remove)) (aref layout 3))) (remove (aset layout 3 (delq (car (transient--group-member loc layout)) (aref layout 3))) nil) ((transient--group-member loc layout)))) (defun transient--group-member (loc group) (cl-member-if (lambda (suffix) (and (listp suffix) (let* ((def (nth 2 suffix)) (cmd (plist-get def :command))) (if (symbolp loc) (eq cmd loc) (equal (transient--kbd (or (plist-get def :key) (transient--command-key cmd))) loc))))) (aref group 3))) (defun transient--kbd (keys) (when (vectorp keys) (setq keys (key-description keys))) (when (stringp keys) (setq keys (kbd keys))) keys) (defun transient--spec-key (spec) (let ((plist (nth 2 spec))) (or (plist-get plist :key) (transient--command-key (plist-get plist :command))))) (defun transient--command-key (cmd) (and-let* ((obj (transient--suffix-prototype cmd))) (cond ((slot-boundp obj 'key) (oref obj key)) ((slot-exists-p obj 'shortarg) (if (slot-boundp obj 'shortarg) (oref obj shortarg) (transient--derive-shortarg (oref obj argument))))))) (defun transient--nthcdr (n list) (nthcdr (if (< n 0) (- (length list) (abs n)) n) list)) (defun transient-set-default-level (command level) "Set the default level of suffix COMMAND to LEVEL. The default level is shadowed if the binding of the suffix in a prefix menu specifies a level, and also if the user changes the level of such a binding. The default level can only be set for commands that were defined using `transient-define-suffix', `transient-define-infix' or `transient-define-argument'." (if-let ((proto (transient--suffix-prototype command))) (oset proto level level) (user-error "Cannot set level for `%s'; no prototype object exists" command))) ;;; Variables (defvar transient-current-prefix nil "The transient from which this suffix command was invoked. This is an object representing that transient, use `transient-current-command' to get the respective command.") (defvar transient-current-command nil "The transient from which this suffix command was invoked. This is a symbol representing that transient, use `transient-current-prefix' to get the respective object.") (defvar transient-current-suffixes nil "The suffixes of the transient from which this suffix command was invoked. This is a list of objects. Usually it is sufficient to instead use the function `transient-args', which returns a list of values. In complex cases it might be necessary to use this variable instead.") (defvar transient-exit-hook nil "Hook run after exiting a transient menu. Unlike `transient-post-exit-hook', this runs even if another transient menu becomes active at the same time. ") (defvar transient-post-exit-hook nil "Hook run after exiting all transient menus. Unlike `transient-exit-hook', this does not run if another transient menu becomes active at the same time.") (defvar transient-setup-buffer-hook nil "Hook run when setting up the transient buffer. That buffer is current and empty when this hook runs.") (defvar transient--prefix nil) (defvar transient--layout nil) (defvar transient--suffixes nil) (defconst transient--stay t "Do not exit the transient.") (defconst transient--exit nil "Do exit the transient.") (defvar transient--exitp nil "Whether to exit the transient.") (defvar transient--showp nil "Whether to show the transient menu buffer.") (defvar transient--helpp nil "Whether help-mode is active.") (defvar transient--docsp nil "Whether docstring-mode is active.") (defvar transient--editp nil "Whether edit-mode is active.") (defvar transient--refreshp nil "Whether to refresh the transient completely.") (defvar transient--all-levels-p nil "Whether temporary display of suffixes on all levels is active.") (defvar transient--timer nil) (defvar transient--stack nil) (defvar transient--minibuffer-depth 0) (defvar transient--buffer-name " *transient*" "Name of the transient buffer.") (defvar transient--buffer nil "The transient menu buffer.") (defvar transient--window nil "The window used to display transient's menu buffer.") (defvar transient--original-window nil "The window that was selected before the transient was invoked. Usually it remains selected while the transient is active.") (defvar transient--original-buffer nil "The buffer that was current before the transient was invoked. Usually it remains current while the transient is active.") (defvar transient--restore-winconf nil "Window configuration to restore after exiting help.") (defvar transient--shadowed-buffer nil "The buffer that is temporarily shadowed by the transient buffer. This is bound while the suffix predicate is being evaluated and while drawing in the transient buffer.") (defvar transient--pending-suffix nil "The suffix that is currently being processed. This is bound while the suffix predicate is being evaluated, and while functions that return faces are being evaluated.") (defvar transient--current-suffix nil "The suffix currently being invoked using a mouse event. Do not use this; instead use function `transient-suffix-object'.") (defvar transient--pending-group nil "The group that is currently being processed. This is bound while the suffixes are drawn in the transient buffer.") (defvar transient--debug nil "Whether to put debug information into *Messages*.") (defvar transient--history nil) (defvar transient--scroll-commands '(transient-scroll-up transient-scroll-down mwheel-scroll scroll-bar-toolkit-scroll)) ;;; Identities (defun transient-active-prefix (&optional prefixes) "Return the active transient object. Return nil if there is no active transient, if the transient buffer isn't shown, and while the active transient is suspended (e.g., while the minibuffer is in use). Unlike `transient-current-prefix', which is only ever non-nil in code that is run directly by a command that is invoked while a transient is current, this function is also suitable for use in asynchronous code, such as timers and callbacks (this function's main use-case). If optional PREFIXES is non-nil, it must be a prefix command symbol or a list of symbols, in which case the active transient object is only returned if it matches one of PREFIXES." (and transient--showp transient--prefix (or (not prefixes) (memq (oref transient--prefix command) (ensure-list prefixes))) (or (memq 'transient--pre-command pre-command-hook) (and (memq t pre-command-hook) (memq 'transient--pre-command (default-value 'pre-command-hook)))) transient--prefix)) (defun transient-prefix-object () "Return the current prefix as an object. While a transient is being setup or refreshed (which involves preparing its suffixes) the variable `transient--prefix' can be used to access the prefix object. Thus this is what has to be used in suffix methods such as `transient-format-description', and in object-specific functions that are stored in suffix slots such as `description'. When a suffix command is invoked (i.e., in its `interactive' form and function body) then the variable `transient-current-prefix' has to be used instead. Two distinct variables are needed, because any prefix may itself be used as a suffix of another prefix, and such sub-prefixes have to be able to tell themselves apart from the prefix they were invoked from. Regular suffix commands, which are not prefixes, do not have to concern themselves with this distinction, so they can use this function instead. In the context of a plain suffix, it always returns the value of the appropriate variable." (or transient--prefix transient-current-prefix)) (defun transient-suffix-object (&optional command) "Return the object associated with the current suffix command. Each suffix commands is associated with an object, which holds additional information about the suffix, such as its value (in the case of an infix command, which is a kind of suffix command). This function is intended to be called by infix commands, which are usually aliases of `transient--default-infix-command', which is defined like this: (defun transient--default-infix-command () (interactive) (let ((obj (transient-suffix-object))) (transient-infix-set obj (transient-infix-read obj))) (transient--show)) \(User input is read outside of `interactive' to prevent the command from being added to `command-history'. See #23.) Such commands need to be able to access their associated object to guide how `transient-infix-read' reads the new value and to store the read value. Other suffix commands (including non-infix commands) may also need the object to guide their behavior. This function attempts to return the object associated with the current suffix command even if the suffix command was not invoked from a transient. (For some suffix command that is a valid thing to do, for others it is not.) In that case nil may be returned, if the command was not defined using one of the macros intended to define such commands. The optional argument COMMAND is intended for internal use. If you are contemplating using it in your own code, then you should probably use this instead: (get COMMAND \\='transient--suffix)" (when command (cl-check-type command command)) (cond (transient--pending-suffix) (transient--current-suffix) ((or transient--prefix transient-current-prefix) (let ((suffixes (cl-remove-if-not (lambda (obj) (eq (oref obj command) (or command (if (eq this-command 'transient-set-level) ;; This is how it can look up for which ;; command it is setting the level. this-original-command this-command)))) (or transient--suffixes transient-current-suffixes)))) (cond ((length= suffixes 1) (car suffixes)) ((cl-find-if (lambda (obj) (equal (listify-key-sequence (transient--kbd (oref obj key))) (listify-key-sequence (this-command-keys)))) suffixes)) ;; COMMAND is only provided if `this-command' is meaningless, in ;; which case `this-command-keys' is also meaningless, making it ;; impossible to disambiguate bindings for the same command. (command (car suffixes)) ;; If COMMAND is nil, then failure to disambiguate likely means ;; that there is a bug somewhere. ((length> suffixes 1) (error "BUG: Cannot unambigiously determine suffix object")) ;; It is legimate to use this function as a predicate of sorts. ;; `transient--pre-command' and `transient-help' are examples. (t nil)))) ((and-let* ((obj (transient--suffix-prototype (or command this-command))) (obj (clone obj))) (progn (transient-init-scope obj) (transient-init-value obj) obj))))) (defun transient--suffix-prototype (command) (or (get command 'transient--suffix) (seq-some (lambda (cmd) (get cmd 'transient--suffix)) (function-alias-p command)))) ;;; Keymaps (defvar-keymap transient-base-map :doc "Parent of other keymaps used by Transient. This is the parent keymap of all the keymaps that are used in all transients: `transient-map' (which in turn is the parent of the transient-specific keymaps), `transient-edit-map' and `transient-sticky-map'. If you change a binding here, then you might also have to edit `transient-sticky-map' and `transient-common-commands'. While the latter isn't a proper transient prefix command, it can be edited using the same functions as used for transients. If you add a new command here, then you must also add a binding to `transient-predicate-map'." "ESC ESC ESC" #'transient-quit-all "C-g" #'transient-quit-one "C-q" #'transient-quit-all "C-z" #'transient-suspend "C-v" #'transient-scroll-up "C-M-v" #'transient-scroll-down "" #'transient-scroll-up "" #'transient-scroll-down) (defvar transient-map (let ((map (make-sparse-keymap))) (set-keymap-parent map transient-base-map) (keymap-set map "C-u" #'universal-argument) (keymap-set map "C--" #'negative-argument) (keymap-set map "C-t" #'transient-show) (keymap-set map "?" #'transient-help) (keymap-set map "C-h" #'transient-help) ;; Next two have additional bindings in transient-common-commands. (keymap-set map "C-M-p" #'transient-history-prev) (keymap-set map "C-M-n" #'transient-history-next) (when (fboundp 'other-frame-prefix) ;Emacs >= 28.1 (keymap-set map "C-x 5 5" 'other-frame-prefix) (keymap-set map "C-x 4 4" 'other-window-prefix)) map) "Top-level keymap used by all transients. If you add a new command here, then you must also add a binding to `transient-predicate-map'. See also `transient-base-map'.") (defvar-keymap transient-edit-map :doc "Keymap that is active while a transient in is in \"edit mode\"." :parent transient-base-map "?" #'transient-help "C-h" #'transient-help) (defvar-keymap transient-sticky-map :doc "Keymap that is active while an incomplete key sequence is active." :parent transient-base-map "C-g" #'transient-quit-seq) (defvar transient-common-commands [:hide (lambda () (defvar transient--redisplay-key) (and (not (equal (vconcat transient--redisplay-key) (read-kbd-macro transient-common-command-prefix))) (not transient-show-common-commands))) ["Value commands" ("{p} s " "Set" transient-set) ("{p} C-s" "Save" transient-save) ("{p} C-k" "Reset" transient-reset) ("{p} p " "Previous value" transient-history-prev) ("{p} n " "Next value" transient-history-next)] ["Sticky commands" ;; Like `transient-sticky-map' except that ;; "C-g" has to be bound to a different command. ("C-g" "Quit prefix or transient" transient-quit-one) ("C-q" "Quit transient stack" transient-quit-all) ("C-z" "Suspend transient stack" transient-suspend)] ["Customize" ("{p} t" transient-toggle-common) ("{p} l" "Show/hide suffixes" transient-set-level) ("{p} a" transient-toggle-level-limit)]] "Commands available in all transient menus. The same functions that are used to change bindings in transient prefix commands, can be used to modify these bindings as well, but note that customizing `transient-common-command-prefix' resets these bindings and that the special meaning of \"{p}\" does not apply when modifying these bindings.") (defun transient--init-common-commands () (put 'transient-common-commands 'transient--layout (list (eval (car (transient--parse-child 'transient-common-commands transient-common-commands)) t))) (defvar transient-common-command-prefix) (defvar transient--docstr-hint-1) (defvar transient--docstr-hint-2) (setq transient--docstr-hint-1 (define-keymap transient-common-command-prefix 'transient-common-command-prefix)) (setq transient--docstr-hint-2 (define-keymap (concat transient-common-command-prefix " t") 'transient-toggle-common))) (defcustom transient-common-command-prefix "C-x" "The prefix key used for most commands common to all menus. Some shared commands are available in all transient menus, most of which share a common prefix specified by this option. By default the bindings for these shared commands are only shown after pressing that prefix key and before following that up with a valid key binding. For historic reasons \\`C-x' is used by default, but users are encouraged to pick another key, preferably one that is not commonly used in Emacs but is still convenient to them. See info node `(transient) Common Suffix Commands'." :type 'key :initialize (lambda (symbol exp) (custom-initialize-default symbol exp) (transient--init-common-commands)) :set (lambda (symbol value) (set-default symbol value) (transient--init-common-commands))) (defvar-keymap transient-popup-navigation-map :doc "One of the keymaps used when menu navigation is enabled. See `transient-enable-popup-navigation'." "" #'transient-noop "" #'transient-backward-button "" #'transient-forward-button "C-r" #'transient-isearch-backward "C-s" #'transient-isearch-forward "M-RET" #'transient-push-button) (defvar-keymap transient-button-map :doc "One of the keymaps used when menu navigation is enabled. See `transient-enable-popup-navigation'." "" #'transient-push-button "" #'transient-push-button) (defvar-keymap transient-resume-mode-map :doc "Keymap for `transient-resume-mode'. This keymap remaps every command that would usually just quit the documentation buffer to `transient-resume', which additionally resumes the suspended transient." " " #'transient-resume " " #'transient-resume " " #'transient-resume) (defvar-keymap transient-predicate-map :doc "Base keymap used to map common commands to their transient behavior. The \"transient behavior\" of a command controls, among other things, whether invoking the command causes the transient to be exited or not, and whether infix arguments are exported before doing so. Each \"key\" is a command that is common to all transients and that is bound in `transient-map', `transient-edit-map', `transient-sticky-map' and/or `transient-common-command'. Each binding is a \"pre-command\", a function that controls the transient behavior of the respective command. For transient commands that are bound in individual transients, the transient behavior is specified using the `:transient' slot of the corresponding object." "" #'transient--do-suspend "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-minus "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-quit-all "" #'transient--do-quit-all "" #'transient--do-quit-one "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-call "" #'transient--do-exit "" #'transient--do-call "" #'transient--do-exit "" #'transient--do-call "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-stay "" #'transient--do-noop "" #'transient--do-move "" #'transient--do-push-button "" #'transient--do-move "" #'transient--do-move "" #'transient--do-move "" #'transient--do-move "" #'transient--do-stay "" #'transient--do-stay ;; If a valid but incomplete prefix sequence is followed by ;; an unbound key, then Emacs calls the `undefined' command ;; but does not set `this-command', `this-original-command' ;; or `real-this-command' accordingly. Instead they are nil. "" #'transient--do-warn ;; Bound to the `mouse-movement' event, this command is similar ;; to `ignore'. "" #'transient--do-noop) (defvar transient--transient-map nil) (defvar transient--predicate-map nil) (defvar transient--redisplay-map nil) (defvar transient--redisplay-key nil) (defun transient--push-keymap (var) (let ((map (symbol-value var))) (transient--debug " push %s%s" var (if map "" " VOID")) (when map (with-demoted-errors "transient--push-keymap: %S" (internal-push-keymap map 'overriding-terminal-local-map))))) (defun transient--pop-keymap (var) (let ((map (symbol-value var))) (when map (transient--debug " pop %s" var) (with-demoted-errors "transient--pop-keymap: %S" (internal-pop-keymap map 'overriding-terminal-local-map))))) (defun transient--make-transient-map () (let ((map (make-sparse-keymap))) (cond (transient--editp (keymap-set map (concat transient-common-command-prefix " l") #'transient-set-level) (set-keymap-parent map transient-edit-map)) ((set-keymap-parent map transient-map))) (dolist (obj transient--suffixes) (let ((key (oref obj key))) (when (vectorp key) (setq key (key-description key)) (oset obj key key)) (when transient-substitute-key-function (setq key (save-match-data (funcall transient-substitute-key-function obj))) (oset obj key key)) (let* ((kbd (kbd key)) (cmd (oref obj command)) (alt (transient--lookup-key map kbd))) (cond ((not alt) (define-key map kbd cmd)) ((eq alt cmd)) ((transient--inapt-suffix-p obj)) ((and-let* ((obj (transient-suffix-object alt))) (transient--inapt-suffix-p obj)) (define-key map kbd cmd)) (transient-detect-key-conflicts (error "Cannot bind %S to %s and also %s" (string-trim key) cmd alt)) ((define-key map kbd cmd)))))) (when-let ((b (keymap-lookup map "-"))) (keymap-set map "" b)) (when-let ((b (keymap-lookup map "="))) (keymap-set map "" b)) (when-let ((b (keymap-lookup map "+"))) (keymap-set map "" b)) (when transient-enable-popup-navigation ;; `transient--make-redisplay-map' maps only over bindings that are ;; directly in the base keymap, so that cannot be a composed keymap. (set-keymap-parent map (make-composed-keymap (keymap-parent map) transient-popup-navigation-map))) map)) (defun transient--make-predicate-map () (let* ((default (transient--resolve-pre-command (oref transient--prefix transient-suffix))) (return (and transient--stack (oref transient--prefix return))) (map (make-sparse-keymap))) (set-keymap-parent map transient-predicate-map) (when (or (and (slot-boundp transient--prefix 'transient-switch-frame) (transient--resolve-pre-command (not (oref transient--prefix transient-switch-frame)))) (memq (transient--resolve-pre-command (oref transient--prefix transient-non-suffix)) '(nil transient--do-warn transient--do-noop))) (define-key map [handle-switch-frame] #'transient--do-suspend)) (dolist (obj transient--suffixes) (let* ((cmd (oref obj command)) (id (vector cmd)) (kind (cond ((get cmd 'transient--prefix) 'prefix) ((cl-typep obj 'transient-infix) 'infix) (t 'suffix))) (pre (cond ((oref obj inapt) #'transient--do-warn-inapt) ((slot-boundp obj 'transient) (pcase (list kind (transient--resolve-pre-command (oref obj transient) nil t) return) (`(prefix t ,_) #'transient--do-recurse) (`(prefix nil ,_) #'transient--do-stack) (`(infix t ,_) #'transient--do-stay) (`(suffix t ,_) #'transient--do-call) ('(suffix nil t) #'transient--do-return) (`(,_ nil ,_) #'transient--do-exit) (`(,_ ,do ,_) do))) ((not (lookup-key transient-predicate-map id)) (pcase (list kind default return) (`(prefix ,(or 'transient--do-stay 'transient--do-call) ,_) #'transient--do-recurse) (`(prefix t ,_) #'transient--do-recurse) (`(prefix ,_ ,_) #'transient--do-stack) (`(infix ,_ ,_) #'transient--do-stay) (`(suffix t ,_) #'transient--do-call) ('(suffix nil t) #'transient--do-return) (`(suffix nil nil) #'transient--do-exit) (`(suffix ,do ,_) do)))))) (when pre (if-let ((alt (lookup-key map id))) (unless (eq alt pre) (define-key map (vconcat (oref obj key) id) pre)) (define-key map id pre))))) map)) (defun transient--make-redisplay-map () (setq transient--redisplay-key (pcase this-command ('transient-update (setq transient--showp t) (let ((keys (listify-key-sequence (this-single-command-raw-keys)))) (setq unread-command-events (mapcar (lambda (key) (cons t key)) keys)) keys)) ('transient-quit-seq (setq unread-command-events (butlast (listify-key-sequence (this-single-command-raw-keys)) 2)) (butlast transient--redisplay-key)) (_ nil))) (let ((topmap (make-sparse-keymap)) (submap (make-sparse-keymap))) (when transient--redisplay-key (define-key topmap (vconcat transient--redisplay-key) submap) (set-keymap-parent submap transient-sticky-map)) (map-keymap-internal (lambda (key def) (when (and (not (eq key ?\e)) (listp def) (keymapp def)) (define-key topmap (vconcat transient--redisplay-key (list key)) #'transient-update))) (if transient--redisplay-key (let ((key (vconcat transient--redisplay-key))) (or (lookup-key transient--transient-map key) (and-let* ((regular (lookup-key local-function-key-map key))) (lookup-key transient--transient-map (vconcat regular))))) transient--transient-map)) topmap)) ;;; Setup (defun transient-setup (&optional name layout edit &rest params) "Setup the transient specified by NAME. This function is called by transient prefix commands to setup the transient. In that case NAME is mandatory, LAYOUT and EDIT must be nil and PARAMS may be (but usually is not) used to set, e.g., the \"scope\" of the transient (see `transient-define-prefix'). This function is also called internally, in which case LAYOUT and EDIT may be non-nil." (transient--debug 'setup) (transient--with-emergency-exit :setup (cond ((not name) ;; Switching between regular and edit mode. (transient--pop-keymap 'transient--transient-map) (transient--pop-keymap 'transient--redisplay-map) (setq name (oref transient--prefix command)) (setq params (list :scope (oref transient--prefix scope)))) (transient--prefix ;; Invoked as a ":transient-non-suffix 'transient--do-{stay,call}" ;; of an outer prefix. Unlike the usual `transient--do-stack', ;; these predicates fail to clean up after the outer prefix. (transient--pop-keymap 'transient--transient-map) (transient--pop-keymap 'transient--redisplay-map)) ((not (or layout ; resuming parent/suspended prefix transient-current-command)) ; entering child prefix (transient--stack-zap)) ; replace suspended prefix, if any (edit ;; Returning from help to edit. (setq transient--editp t))) (transient--env-apply (lambda () (transient--init-transient name layout params) (transient--history-init transient--prefix) (setq transient--original-window (selected-window)) (setq transient--original-buffer (current-buffer)) (setq transient--minibuffer-depth (minibuffer-depth)) (transient--redisplay)) (get name 'transient--prefix)) (transient--suspend-text-conversion-style) (transient--setup-transient) (transient--suspend-which-key-mode))) (cl-defgeneric transient-setup-children (group children) "Setup the CHILDREN of GROUP. If the value of the `setup-children' slot is non-nil, then call that function with CHILDREN as the only argument and return the value. Otherwise return CHILDREN as is.") (cl-defmethod transient-setup-children ((group transient-group) children) (if (slot-boundp group 'setup-children) (funcall (oref group setup-children) children) children)) (defun transient--env-apply (fn &optional prefix) (if-let ((env (oref (or prefix transient--prefix) environment))) (funcall env fn) (funcall fn))) (defun transient--init-transient (&optional name layout params) (unless name ;; Re-init. (if (eq transient--refreshp 'updated-value) ;; Preserve the prefix value this once, because the ;; invoked suffix indicates that it has updated that. (setq transient--refreshp (oref transient--prefix refresh-suffixes)) ;; Otherwise update the prefix value from suffix values. (oset transient--prefix value (transient-get-value)))) (transient--init-objects name layout params) (transient--init-keymaps)) (defun transient--init-keymaps () (setq transient--predicate-map (transient--make-predicate-map)) (setq transient--transient-map (transient--make-transient-map)) (setq transient--redisplay-map (transient--make-redisplay-map))) (defun transient--init-objects (&optional name layout params) (if name (setq transient--prefix (transient--init-prefix name params)) (setq name (oref transient--prefix command))) (setq transient--refreshp (oref transient--prefix refresh-suffixes)) (setq transient--layout (or (and (not transient--refreshp) layout) (transient--init-suffixes name))) (setq transient--suffixes (transient--flatten-suffixes transient--layout))) (defun transient--init-prefix (name &optional params) (let ((obj (let ((proto (get name 'transient--prefix))) (apply #'clone proto :prototype proto :level (or (alist-get t (alist-get name transient-levels)) transient-default-level) params)))) (transient-init-value obj) (transient-init-return obj) (transient-init-scope obj) obj)) (defun transient--init-suffixes (name) (let ((levels (alist-get name transient-levels))) (mapcan (lambda (c) (transient--init-child levels c nil)) (append (get name 'transient--layout) (and (not transient--editp) (get 'transient-common-commands 'transient--layout)))))) (defun transient--flatten-suffixes (layout) (cl-labels ((s (def) (cond ((stringp def) nil) ((cl-typep def 'transient-information) nil) ((listp def) (mapcan #'s def)) ((cl-typep def 'transient-group) (mapcan #'s (oref def suffixes))) ((cl-typep def 'transient-suffix) (list def))))) (mapcan #'s layout))) (defun transient--init-child (levels spec parent) (cl-etypecase spec (vector (transient--init-group levels spec parent)) (list (transient--init-suffix levels spec parent)) (string (list spec)))) (defun transient--init-group (levels spec parent) (pcase-let* ((`(,level ,class ,args ,children) (append spec nil)) (level (or level transient--default-child-level))) (and-let* (((transient--use-level-p level)) (obj (apply class :parent parent :level level args)) ((transient--use-suffix-p obj)) ((prog1 t (when (transient--inapt-suffix-p obj) (oset obj inapt t)))) (suffixes (mapcan (lambda (c) (transient--init-child levels c obj)) (transient-setup-children obj children)))) (progn (oset obj suffixes suffixes) (list obj))))) (defun transient--init-suffix (levels spec parent) (pcase-let* ((`(,level ,class ,args) spec) (cmd (plist-get args :command)) (_ (transient--load-command-if-autoload cmd)) (key (transient--kbd (plist-get args :key))) (proto (and cmd (transient--suffix-prototype cmd))) (level (or (alist-get (cons cmd key) levels nil nil #'equal) (alist-get cmd levels) level (and proto (oref proto level)) transient--default-child-level))) (when (transient--use-level-p level) (let ((obj (if (child-of-class-p class 'transient-information) (apply class :parent parent :level level args) (unless (and cmd (symbolp cmd)) (error "BUG: Non-symbolic suffix command: %s" cmd)) (if proto (apply #'clone proto :parent parent :level level args) (apply class :command cmd :parent parent :level level args))))) (cond ((not cmd)) ((commandp cmd)) ((or (cl-typep obj 'transient-switch) (cl-typep obj 'transient-option)) ;; As a temporary special case, if the package was compiled ;; with an older version of Transient, then we must define ;; "anonymous" switch and option commands here. (defalias cmd #'transient--default-infix-command)) ((transient--use-suffix-p obj) (error "Suffix command %s is not defined or autoloaded" cmd))) (unless (cl-typep obj 'transient-information) (transient--init-suffix-key obj)) (when (transient--use-suffix-p obj) (if (transient--inapt-suffix-p obj) (oset obj inapt t) (transient-init-scope obj) (transient-init-value obj)) (list obj)))))) (cl-defmethod transient--init-suffix-key ((obj transient-suffix)) (unless (slot-boundp obj 'key) (error "No key for %s" (oref obj command)))) (cl-defmethod transient--init-suffix-key ((obj transient-argument)) (if (transient-switches--eieio-childp obj) (cl-call-next-method obj) (when-let* (((not (slot-boundp obj 'shortarg))) (shortarg (transient--derive-shortarg (oref obj argument)))) (oset obj shortarg shortarg)) (unless (slot-boundp obj 'key) (if (slot-boundp obj 'shortarg) (oset obj key (oref obj shortarg)) (error "No key for %s" (oref obj command)))))) (defun transient--use-level-p (level &optional edit) (or transient--all-levels-p (and transient--editp (not edit)) (and (>= level 1) (<= level (oref transient--prefix level))))) (defun transient--use-suffix-p (obj) (let ((transient--shadowed-buffer (current-buffer)) (transient--pending-suffix obj)) (transient--do-suffix-p (oref obj if) (oref obj if-not) (oref obj if-nil) (oref obj if-non-nil) (oref obj if-mode) (oref obj if-not-mode) (oref obj if-derived) (oref obj if-not-derived) t))) (defun transient--inapt-suffix-p (obj) (or (and-let* ((parent (oref obj parent))) (oref parent inapt)) (let ((transient--shadowed-buffer (current-buffer)) (transient--pending-suffix obj)) (transient--do-suffix-p (oref obj inapt-if) (oref obj inapt-if-not) (oref obj inapt-if-nil) (oref obj inapt-if-non-nil) (oref obj inapt-if-mode) (oref obj inapt-if-not-mode) (oref obj inapt-if-derived) (oref obj inapt-if-not-derived) nil)))) (defun transient--do-suffix-p (if if-not if-nil if-non-nil if-mode if-not-mode if-derived if-not-derived default) (cond (if (funcall if)) (if-not (not (funcall if-not))) (if-non-nil (symbol-value if-non-nil)) (if-nil (not (symbol-value if-nil))) (if-mode (if (atom if-mode) (eq major-mode if-mode) (memq major-mode if-mode))) (if-not-mode (not (if (atom if-not-mode) (eq major-mode if-not-mode) (memq major-mode if-not-mode)))) (if-derived (if (or (atom if-derived) (>= emacs-major-version 30)) (derived-mode-p if-derived) (apply #'derived-mode-p if-derived))) (if-not-derived (not (if (or (atom if-not-derived) (>= emacs-major-version 30)) (derived-mode-p if-not-derived) (apply #'derived-mode-p if-not-derived)))) (default))) (defun transient--suffix-predicate (spec) (let ((plist (nth 2 spec))) (seq-some (lambda (prop) (and-let* ((pred (plist-get plist prop))) (list prop pred))) '( :if :if-not :if-nil :if-non-nil :if-mode :if-not-mode :if-derived :if-not-derived :inapt-if :inapt-if-not :inapt-if-nil :inapt-if-non-nil :inapt-if-mode :inapt-if-not-mode :inapt-if-derived :inapt-if-not-derived)))) (defun transient--load-command-if-autoload (cmd) (when-let* (((symbolp cmd)) (fn (symbol-function cmd)) ((autoloadp fn))) (transient--debug " autoload %s" cmd) (autoload-do-load fn))) ;;; Flow-Control (defun transient--setup-transient () (transient--debug 'setup-transient) (transient--push-keymap 'transient--transient-map) (transient--push-keymap 'transient--redisplay-map) (add-hook 'pre-command-hook #'transient--pre-command 99) (add-hook 'post-command-hook #'transient--post-command) (advice-add 'recursive-edit :around #'transient--recursive-edit) (when transient--exitp ;; This prefix command was invoked as the suffix of another. ;; Prevent `transient--post-command' from removing the hooks ;; that we just added. (setq transient--exitp 'replace))) (defun transient--refresh-transient () (transient--debug 'refresh-transient) (transient--pop-keymap 'transient--predicate-map) (transient--pop-keymap 'transient--transient-map) (transient--pop-keymap 'transient--redisplay-map) (transient--init-transient) (transient--push-keymap 'transient--transient-map) (transient--push-keymap 'transient--redisplay-map) (transient--redisplay)) (defun transient--pre-command () (transient--debug 'pre-command) (transient--with-emergency-exit :pre-command ;; The use of `overriding-terminal-local-map' does not prevent the ;; lookup of command remappings in the overridden maps, which can ;; lead to a suffix being remapped to a non-suffix. We have to undo ;; the remapping in that case. However, remapping a non-suffix to ;; another should remain possible. (when (and (transient--get-pre-command this-original-command nil 'suffix) (not (transient--get-pre-command this-command nil 'suffix))) (setq this-command this-original-command)) (cond ((memq this-command '(transient-update transient-quit-seq)) (transient--pop-keymap 'transient--redisplay-map)) ((and transient--helpp (not (memq this-command '(transient-quit-one transient-quit-all)))) (cond ((transient-help) (transient--do-suspend) (setq this-command 'transient-suspend) (transient--pre-exit)) ((not (transient--edebug-command-p)) (setq this-command 'transient-undefined)))) ((and transient--editp (transient-suffix-object) (not (memq this-command '(transient-quit-one transient-quit-all transient-help)))) (setq this-command 'transient-set-level) (transient--wrap-command)) (t (setq transient--exitp nil) (let ((exitp (eq (transient--call-pre-command) transient--exit))) (transient--wrap-command) (when exitp (transient--pre-exit))))))) (defun transient--pre-exit () (transient--debug 'pre-exit) (transient--delete-window) (transient--timer-cancel) (transient--pop-keymap 'transient--transient-map) (transient--pop-keymap 'transient--redisplay-map) (unless transient--showp (let ((message-log-max nil)) (message ""))) (setq transient--transient-map nil) (setq transient--predicate-map nil) (setq transient--redisplay-map nil) (setq transient--redisplay-key nil) (setq transient--helpp nil) (unless (eq transient--docsp 'permanent) (setq transient--docsp nil)) (setq transient--editp nil) (setq transient--prefix nil) (setq transient--layout nil) (setq transient--suffixes nil) (setq transient--original-window nil) (setq transient--original-buffer nil) (setq transient--window nil)) (defun transient--export () (setq transient-current-prefix transient--prefix) (setq transient-current-command (oref transient--prefix command)) (setq transient-current-suffixes transient--suffixes) (transient--history-push transient--prefix)) (defun transient--suspend-override (&optional nohide) (transient--debug 'suspend-override) (transient--timer-cancel) (let ((show (transient--preserve-window-p nohide))) (cond ((not show) (transient--delete-window)) ((and transient--prefix transient--redisplay-key) (setq transient--redisplay-key nil) (when transient--showp (if-let ((win (minibuffer-selected-window))) (with-selected-window win (transient--show)) (transient--show))))) (when (and (window-live-p transient--window) (and show (or (not (eq show 'fixed)) (window-full-height-p transient--window)))) (set-window-parameter transient--window 'window-preserved-size (list (window-buffer transient--window) nil nil)))) (transient--pop-keymap 'transient--transient-map) (transient--pop-keymap 'transient--redisplay-map) (remove-hook 'pre-command-hook #'transient--pre-command) (remove-hook 'post-command-hook #'transient--post-command)) (defun transient--resume-override (&optional _ignore) (transient--debug 'resume-override) (cond ((and transient--showp (not (window-live-p transient--window))) (transient--show)) ((window-live-p transient--window) (transient--fit-window-to-buffer transient--window))) (transient--push-keymap 'transient--transient-map) (transient--push-keymap 'transient--redisplay-map) (add-hook 'pre-command-hook #'transient--pre-command) (add-hook 'post-command-hook #'transient--post-command)) (defun transient--recursive-edit (fn) (transient--debug 'recursive-edit) (if (not transient--prefix) (funcall fn) (transient--suspend-override (bound-and-true-p edebug-active)) (funcall fn) ; Already unwind protected. (cond ((memq this-command '(top-level abort-recursive-edit)) (setq transient--exitp t) (transient--post-exit this-command) (transient--delete-window)) (transient--prefix (transient--resume-override))))) (defmacro transient--with-suspended-override (&rest body) (let ((depth (make-symbol "depth")) (setup (make-symbol "setup")) (exit (make-symbol "exit"))) `(if (and transient--transient-map (memq transient--transient-map overriding-terminal-local-map)) (let ((,depth (1+ (minibuffer-depth))) ,setup ,exit) (setq ,setup (lambda () "@transient--with-suspended-override" (transient--debug 'minibuffer-setup) (remove-hook 'minibuffer-setup-hook ,setup) (transient--suspend-override))) (setq ,exit (lambda () "@transient--with-suspended-override" (transient--debug 'minibuffer-exit) (when (= (minibuffer-depth) ,depth) (transient--resume-override)))) (unwind-protect (progn (add-hook 'minibuffer-setup-hook ,setup) (add-hook 'minibuffer-exit-hook ,exit) ,@body) (remove-hook 'minibuffer-setup-hook ,setup) (remove-hook 'minibuffer-exit-hook ,exit))) ,@body))) (defun transient--wrap-command () (transient--load-command-if-autoload this-command) (static-if (>= emacs-major-version 30) (letrec ((command this-command) (suffix (transient-suffix-object this-command)) (prefix transient--prefix) (advice (lambda (fn &rest args) (interactive (lambda (spec) (let ((abort t)) (unwind-protect (prog1 (let ((debugger #'transient--exit-and-debug)) (if-let* ((obj suffix) (grp (oref obj parent)) (adv (or (oref obj advice*) (oref grp advice*)))) (funcall adv #'advice-eval-interactive-spec spec) (advice-eval-interactive-spec spec))) (setq abort nil)) (when abort (when-let ((unwind (oref prefix unwind-suffix))) (transient--debug 'unwind-interactive) (funcall unwind command)) (when (symbolp command) (remove-function (symbol-function command) advice)) (oset prefix unwind-suffix nil)))))) (unwind-protect (let ((debugger #'transient--exit-and-debug)) (if-let* ((obj suffix) (grp (oref obj parent)) (adv (or (oref obj advice) (oref obj advice*) (oref grp advice) (oref grp advice*)))) (apply adv fn args) (apply fn args))) (when-let ((unwind (oref prefix unwind-suffix))) (transient--debug 'unwind-command) (funcall unwind command)) (when (symbolp command) (remove-function (symbol-function command) advice)) (oset prefix unwind-suffix nil))))) (add-function :around (if (symbolp this-command) (symbol-function this-command) this-command) advice '((depth . -99))) (cl-assert (>= emacs-major-version 30) nil "Emacs was downgraded, making it necessary to recompile Transient")) ;; (< emacs-major-version 30) (let* ((command this-command) (suffix (transient-suffix-object this-command)) (prefix transient--prefix) (advice nil) (advice-interactive (lambda (spec) (let ((abort t)) (unwind-protect (prog1 (let ((debugger #'transient--exit-and-debug)) (if-let* ((obj suffix) (grp (oref obj parent)) (adv (or (oref obj advice*) (oref grp advice*)))) (funcall adv #'advice-eval-interactive-spec spec) (advice-eval-interactive-spec spec))) (setq abort nil)) (when abort (when-let ((unwind (oref prefix unwind-suffix))) (transient--debug 'unwind-interactive) (funcall unwind command)) (when (symbolp command) (remove-function (symbol-function command) advice)) (oset prefix unwind-suffix nil)))))) (advice-body (lambda (fn &rest args) (unwind-protect (let ((debugger #'transient--exit-and-debug)) (if-let* ((obj suffix) (grp (oref obj parent)) (adv (or (oref obj advice) (oref obj advice*) (oref grp advice) (oref grp advice*)))) (apply adv fn args) (apply fn args))) (when-let ((unwind (oref prefix unwind-suffix))) (transient--debug 'unwind-command) (funcall unwind command)) (when (symbolp command) (remove-function (symbol-function command) advice)) (oset prefix unwind-suffix nil))))) (setq advice `(lambda (fn &rest args) (interactive ,advice-interactive) (apply ',advice-body fn args))) (add-function :around (if (symbolp this-command) (symbol-function this-command) this-command) advice '((depth . -99)))))) (defun transient--premature-post-command () (and (equal (this-command-keys-vector) []) (= (minibuffer-depth) (1+ transient--minibuffer-depth)) (progn (transient--debug 'premature-post-command) (transient--suspend-override) (oset (or transient--prefix transient-current-prefix) unwind-suffix (if transient--exitp #'transient--post-exit #'transient--resume-override)) t))) (defun transient--post-command () (unless (transient--premature-post-command) (transient--debug 'post-command) (transient--with-emergency-exit :post-command (cond (transient--exitp (transient--post-exit)) ;; If `this-command' is the current transient prefix, then we ;; have already taken care of updating the transient buffer... ((and (eq this-command (oref transient--prefix command)) ;; ... but if `prefix-arg' is non-nil, then the values ;; of `this-command' and `real-this-command' are untrue ;; because `prefix-command-preserve-state' changes them. ;; We cannot use `current-prefix-arg' because it is set ;; too late (in `command-execute'), and if it were set ;; earlier, then we likely still would not be able to ;; rely on it, and `prefix-command-preserve-state-hook' ;; would have to be used to record that a universal ;; argument is in effect. (not prefix-arg))) (transient--refreshp (transient--env-apply #'transient--refresh-transient)) ((let ((old transient--redisplay-map) (new (transient--make-redisplay-map))) (unless (equal old new) (transient--pop-keymap 'transient--redisplay-map) (setq transient--redisplay-map new) (transient--push-keymap 'transient--redisplay-map)) (transient--env-apply #'transient--redisplay))))) (setq transient-current-prefix nil) (setq transient-current-command nil) (setq transient-current-suffixes nil) (setq transient--current-suffix nil))) (defun transient--post-exit (&optional command) (transient--debug 'post-exit) (unless (and (eq transient--exitp 'replace) (or transient--prefix ;; The current command could act as a prefix, ;; but decided not to call `transient-setup', ;; or it is prevented from doing so because it ;; uses the minibuffer and the user aborted ;; that. (prog1 nil (if (let ((obj (transient-suffix-object command))) (and (slot-boundp obj 'transient) (oref obj transient))) ;; This sub-prefix is a transient suffix; ;; go back to outer prefix, by calling ;; `transient--stack-pop' further down. (setq transient--exitp nil) (transient--stack-zap))))) (remove-hook 'pre-command-hook #'transient--pre-command) (remove-hook 'post-command-hook #'transient--post-command) (advice-remove 'recursive-edit #'transient--recursive-edit)) (let ((replace (eq transient--exitp 'replace)) (resume (and transient--stack (not (memq transient--exitp '(replace suspend)))))) (unless (or resume replace) (setq transient--showp nil)) (setq transient--exitp nil) (setq transient--helpp nil) (setq transient--editp nil) (setq transient--all-levels-p nil) (setq transient--minibuffer-depth 0) (run-hooks 'transient-exit-hook) (when command (setq transient-current-prefix nil) (setq transient-current-command nil) (setq transient-current-suffixes nil) (setq transient--current-suffix nil)) (cond (resume (transient--stack-pop)) ((not replace) (run-hooks 'transient-post-exit-hook))))) (defun transient--stack-push () (transient--debug 'stack-push) (push (list (oref transient--prefix command) transient--layout transient--editp :value (transient-get-value) :return (oref transient--prefix return) :scope (oref transient--prefix scope)) transient--stack)) (defun transient--stack-pop () (transient--debug 'stack-pop) (and transient--stack (prog1 t (apply #'transient-setup (pop transient--stack))))) (defun transient--stack-zap () (transient--debug 'stack-zap) (setq transient--stack nil)) (defun transient--redisplay () (if (or (eq transient-show-popup t) transient--showp) (unless (or (memq this-command transient--scroll-commands) (and (or (memq this-command '(mouse-drag-region mouse-set-region)) (equal (key-description (this-command-keys-vector)) "")) (and (eq (current-buffer) transient--buffer)))) (transient--show)) (when (and (numberp transient-show-popup) (not (zerop transient-show-popup)) (not transient--timer)) (transient--timer-start)) (transient--show-hint))) (defun transient--timer-start () (setq transient--timer (run-at-time (abs transient-show-popup) nil (lambda () (transient--timer-cancel) (transient--show) (let ((message-log-max nil)) (message "")))))) (defun transient--timer-cancel () (when transient--timer (cancel-timer transient--timer) (setq transient--timer nil))) (defun transient--debug (arg &rest args) (when transient--debug (let ((inhibit-message (not (eq transient--debug 'message)))) (if (symbolp arg) (message "-- %-22s (cmd: %s, event: %S, exit: %s%s)" arg (cond ((and (symbolp this-command) this-command)) ((fboundp 'help-fns-function-name) (help-fns-function-name this-command)) ((byte-code-function-p this-command) "#[...]") (this-command)) (key-description (this-command-keys-vector)) transient--exitp (cond ((keywordp (car args)) (format ", from: %s" (substring (symbol-name (car args)) 1))) ((stringp (car args)) (concat ", " (apply #'format args))) ((functionp (car args)) (concat ", " (apply (car args) (cdr args)))) (""))) (apply #'message arg args))))) (defun transient--emergency-exit (&optional id) "Exit the current transient command after an error occurred. When no transient is active (i.e., when `transient--prefix' is nil) then do nothing. Optional ID is a keyword identifying the exit." (transient--debug 'emergency-exit id) (when transient--prefix (setq transient--stack nil) (setq transient--exitp t) (transient--pre-exit) (transient--post-exit this-command))) ;;; Pre-Commands (defun transient--call-pre-command () (if-let ((fn (transient--get-pre-command this-command (this-command-keys-vector)))) (let ((action (funcall fn))) (when (eq action transient--exit) (setq transient--exitp (or transient--exitp t))) action) (if (let ((keys (this-command-keys-vector))) (eq (aref keys (1- (length keys))) ?\C-g)) (setq this-command 'transient-noop) (unless (transient--edebug-command-p) (setq this-command 'transient-undefined))) transient--stay)) (defun transient--get-pre-command (&optional cmd key enforce-type) (or (and (not (eq enforce-type 'non-suffix)) (symbolp cmd) (or (and key (let ((def (lookup-key transient--predicate-map (vconcat key (list cmd))))) (and (symbolp def) def))) (lookup-key transient--predicate-map (vector cmd)))) (and (not (eq enforce-type 'suffix)) (transient--resolve-pre-command (oref transient--prefix transient-non-suffix) t)))) (defun transient--resolve-pre-command (pre &optional resolve-boolean correct) (setq pre (cond ((booleanp pre) (if resolve-boolean (if pre #'transient--do-stay #'transient--do-warn) pre)) ((string-match-p "--do-" (symbol-name pre)) pre) ((let ((sym (intern (format "transient--do-%s" pre)))) (if (functionp sym) sym pre))))) (cond ((not correct) pre) ((and (eq pre 'transient--do-return) (not transient--stack)) 'transient--do-exit) (pre))) (defun transient--do-stay () "Call the command without exporting variables and stay transient." transient--stay) (defun transient--do-noop () "Call `transient-noop' and stay transient." (setq this-command 'transient-noop) transient--stay) (defun transient--do-warn () "Call `transient-undefined' and stay transient." (setq this-command 'transient-undefined) transient--stay) (defun transient--do-warn-inapt () "Call `transient-inapt' and stay transient." (setq this-command 'transient-inapt) transient--stay) (defun transient--do-call () "Call the command after exporting variables and stay transient." (transient--export) transient--stay) (defun transient--do-return () "Call the command after exporting variables and return to parent prefix. If there is no parent prefix, then behave like `transient--do-exit'." (if (not transient--stack) (transient--do-exit) (transient--export) transient--exit)) (defun transient--do-exit () "Call the command after exporting variables and exit the transient." (transient--export) (transient--stack-zap) transient--exit) (defun transient--do-leave () "Call the command without exporting variables and exit the transient." (transient--stack-zap) transient--exit) (defun transient--do-push-button () "Call the command represented by the activated button. Use that command's pre-command to determine transient behavior." (if (and (mouse-event-p last-command-event) (not (eq (posn-window (event-start last-command-event)) transient--window))) transient--stay (with-selected-window transient--window (let ((pos (if (mouse-event-p last-command-event) (posn-point (event-start last-command-event)) (point)))) (setq this-command (get-text-property pos 'command)) (setq transient--current-suffix (get-text-property pos 'suffix)))) (transient--call-pre-command))) (defun transient--do-recurse () "Call the transient prefix command, preparing for return to outer transient. If there is no parent prefix, then just call the command." (transient--do-stack)) (defun transient--do-stack () "Call the transient prefix command, stacking the active transient. Push the active transient to the transient stack." (transient--export) (transient--stack-push) (setq transient--exitp 'replace) transient--exit) (defun transient--do-replace () "Call the transient prefix command, replacing the active transient. Do not push the active transient to the transient stack." (transient--export) (setq transient--exitp 'replace) transient--exit) (defun transient--do-suspend () "Suspend the active transient, saving the transient stack." ;; Export so that `transient-describe' instances can use ;; `transient-suffix-object' to get their respective object. (transient--export) (transient--stack-push) (setq transient--exitp 'suspend) transient--exit) (defun transient--do-quit-one () "If active, quit help or edit mode, else exit the active transient." (cond (transient--helpp (setq transient--helpp nil) transient--stay) (transient--editp (setq transient--editp nil) (transient-setup) transient--stay) (prefix-arg transient--stay) (transient--exit))) (defun transient--do-quit-all () "Exit all transients without saving the transient stack." (transient--stack-zap) transient--exit) (defun transient--do-move () "Call the command if `transient-enable-popup-navigation' is non-nil. In that case behave like `transient--do-stay', otherwise similar to `transient--do-warn'." (unless transient-enable-popup-navigation (setq this-command 'transient-inhibit-move)) transient--stay) (defun transient--do-minus () "Call `negative-argument' or pivot to `transient-update'. If `negative-argument' is invoked using \"-\" then preserve the prefix argument and pivot to `transient-update'." (when (equal (this-command-keys) "-") (setq this-command 'transient-update)) transient--stay) (put 'transient--do-stay 'transient-face 'transient-key-stay) (put 'transient--do-noop 'transient-face 'transient-key-noop) (put 'transient--do-warn 'transient-face 'transient-key-noop) (put 'transient--do-warn-inapt 'transient-face 'transient-key-noop) (put 'transient--do-call 'transient-face 'transient-key-stay) (put 'transient--do-return 'transient-face 'transient-key-return) (put 'transient--do-exit 'transient-face 'transient-key-exit) (put 'transient--do-leave 'transient-face 'transient-key-exit) (put 'transient--do-recurse 'transient-face 'transient-key-recurse) (put 'transient--do-stack 'transient-face 'transient-key-stack) (put 'transient--do-replace 'transient-face 'transient-key-exit) (put 'transient--do-suspend 'transient-face 'transient-key-exit) (put 'transient--do-quit-one 'transient-face 'transient-key-return) (put 'transient--do-quit-all 'transient-face 'transient-key-exit) (put 'transient--do-move 'transient-face 'transient-key-stay) (put 'transient--do-minus 'transient-face 'transient-key-stay) ;;; Commands ;;;; Noop (defun transient-noop () "Do nothing at all." (interactive)) (defun transient-undefined () "Warn the user that the pressed key is not bound to any suffix." (interactive) (transient--invalid "Unbound suffix")) (defun transient-inapt () "Warn the user that the invoked command is inapt." (interactive) (transient--invalid "Inapt command")) (defun transient--invalid (msg) (ding) (message "%s: `%s' (Use `%s' to abort, `%s' for help)%s" msg (propertize (key-description (this-single-command-keys)) 'face 'font-lock-warning-face) (propertize "C-g" 'face 'transient-key) (propertize "?" 'face 'transient-key) ;; `this-command' is `transient-undefined' or `transient-inapt'. ;; Show the command (`this-original-command') the user actually ;; tried to invoke. (if-let ((cmd (or (ignore-errors (symbol-name this-original-command)) (ignore-errors (symbol-name this-command))))) (format " [%s]" (propertize cmd 'face 'font-lock-warning-face)) "")) (unless (and transient--transient-map (memq transient--transient-map overriding-terminal-local-map)) (let ((transient--prefix (or transient--prefix 'sic))) (transient--emergency-exit)) (view-lossage) (other-window 1) (display-warning 'transient "Inconsistent transient state detected. This should never happen. Please open an issue and post the shown command log." :error))) (defun transient-inhibit-move () "Warn the user that menu navigation is disabled." (interactive) (message "To enable use of `%s', please customize `%s'" this-original-command 'transient-enable-popup-navigation)) ;;;; Core (defun transient-quit-all () "Exit all transients without saving the transient stack." (interactive)) (defun transient-quit-one () "Exit the current transients, returning to outer transient, if any." (interactive)) (defun transient-quit-seq () "Abort the current incomplete key sequence." (interactive)) (defun transient-update () "Redraw the transient's state in the menu buffer." (interactive) (setq prefix-arg current-prefix-arg)) (defun transient-show () "Show the transient's state in the menu buffer." (interactive) (setq transient--showp t)) (defun transient-push-button () "Invoke the suffix command represented by this button." (interactive)) ;;;; Suspend (defun transient-suspend () "Suspend the current transient. It can later be resumed using `transient-resume', while no other transient is active." (interactive)) (define-minor-mode transient-resume-mode "Auxiliary minor-mode used to resume a transient after viewing help.") (defun transient-resume () "Resume a previously suspended stack of transients." (interactive) (cond (transient--stack (let ((winconf transient--restore-winconf)) (kill-local-variable 'transient--restore-winconf) (when transient-resume-mode (transient-resume-mode -1) (quit-window)) (when winconf (set-window-configuration winconf))) (transient--stack-pop)) (transient-resume-mode (kill-local-variable 'transient--restore-winconf) (transient-resume-mode -1) (quit-window)) (t (message "No suspended transient command")))) ;;;; Help (defun transient-help (&optional interactive) "Show help for the active transient or one of its suffixes. \n(fn)" (interactive (list t)) (if interactive (setq transient--helpp t) (with-demoted-errors "transient-help: %S" (when (lookup-key transient--transient-map (this-single-command-raw-keys)) (setq transient--helpp nil) (transient--display-help #'transient-show-help (if (eq this-original-command 'transient-help) transient--prefix (or (transient-suffix-object) this-original-command))))))) (transient-define-suffix transient-describe () "From a transient menu, describe something in another buffer. This command can be bound multiple times to describe different targets. Each binding must specify the thing it describes, be setting the value of its `target' slot, using the keyword argument `:='. The `helper' slot specifies the low-level function used to describe the target, and can be omitted, in which case `transient--describe-function' is used for a symbol, `transient--show-manual' is used for a string beginning with a parenthesis, and `transient--show-manpage' is used for any other string. For example: [(\"e\" \"about emacs\" transient-describe := \"(emacs)\") (\"g\" \"about git\" transient-describe := \"git\")]" :class 'transient-describe-target (interactive) (with-slots (helper target) (transient-suffix-object) (transient--display-help helper target))) ;;;; Level (defun transient-set-level (&optional command level) "Set the level of the transient or one of its suffix commands." (interactive (let ((command this-original-command) (prefix (oref transient--prefix command))) (and (or (not (eq command 'transient-set-level)) (and transient--editp (setq command prefix))) (list command (let ((keys (this-single-command-raw-keys))) (and (lookup-key transient--transient-map keys) (progn (transient--show) (string-to-number (transient--read-number-N (format "Set level for `%s': " command) nil nil (not (eq command prefix))))))))))) (cond ((not command) (setq transient--editp t) (transient-setup)) (level (let* ((prefix (oref transient--prefix command)) (alist (alist-get prefix transient-levels)) (akey command)) (cond ((eq command prefix) (oset transient--prefix level level) (setq akey t)) (t (oset (transient-suffix-object command) level level) (when (cdr (cl-remove-if-not (lambda (obj) (eq (oref obj command) command)) transient--suffixes)) (setq akey (cons command (this-command-keys)))))) (setf (alist-get akey alist) level) (setf (alist-get prefix transient-levels) alist)) (transient-save-levels) (transient--show)) (t (transient-undefined)))) (transient-define-suffix transient-toggle-level-limit () "Toggle whether to temporarily displayed suffixes on all levels." :description (lambda () (cond ((= transient-default-level transient--max-level) "Always displaying all levels") (transient--all-levels-p (format "Hide suffix %s" (propertize (format "levels > %s" (oref (transient-prefix-object) level)) 'face 'transient-higher-level))) ("Show all suffix levels"))) :inapt-if (lambda () (= transient-default-level transient--max-level)) :transient t (interactive) (setq transient--all-levels-p (not transient--all-levels-p)) (setq transient--refreshp t)) ;;;; Value (defun transient-set () "Set active transient's value for this Emacs session." (interactive) (transient-set-value (transient-prefix-object))) (defalias 'transient-set-and-exit #'transient-set "Set active transient's value for this Emacs session and exit.") (defun transient-save () "Save active transient's value for this and future Emacs sessions." (interactive) (transient-save-value (transient-prefix-object))) (defalias 'transient-save-and-exit #'transient-save "Save active transient's value for this and future Emacs sessions and exit.") (defun transient-reset () "Clear the set and saved values of the active transient." (interactive) (transient-reset-value (transient-prefix-object))) (defun transient-history-next () "Switch to the next value used for the active transient." (interactive) (let* ((obj transient--prefix) (pos (1- (oref obj history-pos))) (hst (oref obj history))) (if (< pos 0) (user-error "End of history") (oset obj history-pos pos) (oset obj value (nth pos hst)) (mapc #'transient-init-value transient--suffixes)))) (defun transient-history-prev () "Switch to the previous value used for the active transient." (interactive) (let* ((obj transient--prefix) (pos (1+ (oref obj history-pos))) (hst (oref obj history)) (len (length hst))) (if (> pos (1- len)) (user-error "End of history") (oset obj history-pos pos) (oset obj value (nth pos hst)) (mapc #'transient-init-value transient--suffixes)))) (transient-define-suffix transient-preset () "Put this preset into action." :class transient-value-preset (interactive) (transient-prefix-set (oref (transient-suffix-object) set))) ;;;; Auxiliary (transient-define-suffix transient-toggle-common () "Toggle whether common commands are permanently shown." :transient t :description (lambda () (if transient-show-common-commands "Hide common commands" "Show common permanently")) (interactive) (setq transient-show-common-commands (not transient-show-common-commands))) (transient-define-suffix transient-toggle-docstrings (&optional permanent) "Toggle whether to show docstrings instead of suffix descriptions. By default this is only enabled temporarily for the current transient menu invocation. With a prefix argument, enable this until explicitly disabled again. Infix arguments are not affected by this, because otherwise many menus would likely become unreadable. To make this command available in all menus, bind it in `transient-map'. `transient-show-docstring-format' controls how the docstrings are displayed and whether descriptions are also displayed." :transient t (interactive (list current-prefix-arg)) (setq transient--docsp (if permanent 'permanent (not transient--docsp)))) (defun transient-toggle-debug () "Toggle debugging statements for transient commands." (interactive) (setq transient--debug (not transient--debug)) (message "Debugging transient %s" (if transient--debug "enabled" "disabled"))) (defun transient-copy-menu-text () "Copy the contents of the menu buffer to the kill ring. To make this available in all menus, bind it in `transient-map'" (interactive) (transient--show) (with-current-buffer (get-buffer transient--buffer-name) (copy-region-as-kill (point-min) (point-max)))) (transient-define-suffix transient-echo-arguments (arguments) "Show the transient's active ARGUMENTS in the echo area. Intended for use in prefixes used for demonstration purposes, such as when suggesting a new feature or reporting an issue." :transient t :description "Echo arguments" :key "x" (interactive (list (transient-args transient-current-command))) (message "%s: %s" (key-description (this-command-keys)) (mapconcat (lambda (arg) (propertize (if (string-match-p " " arg) (format "%S" arg) arg) 'face 'transient-argument)) arguments " "))) ;;; Value ;;;; Init (cl-defgeneric transient-init-value (obj) "Set the initial value of the prefix or suffix object OBJ. This function is called for all prefix and suffix commands. Third-party subclasses of `transient-infix' must implement a primary method.") (cl-defmethod transient-init-value :around ((obj transient-prefix)) "If bound, use the value returned by OBJ' `init-value' function. If the value of OBJ's `init-value' is non-nil, call that function to determine the value. Otherwise call the primary method according to OBJ's class." (if (slot-boundp obj 'init-value) (funcall (oref obj init-value) obj) (cl-call-next-method obj))) (cl-defmethod transient-init-value :around ((obj transient-infix)) "If bound, use the value returned by OBJ's `init-value' function. If the value of OBJ's `init-value' is non-nil, call that function to determine the value. Otherwise call the primary method according to OBJ's class." (if (slot-boundp obj 'init-value) (funcall (oref obj init-value) obj) (cl-call-next-method obj))) (cl-defmethod transient-init-value ((obj transient-prefix)) "Set OBJ's initial value to the set, saved or default value. Use `transient-default-value' to determine the default value." (if (slot-boundp obj 'value) ;; Already set because the live object is cloned from ;; the prototype, were the set (if any) value is stored. (oref obj value) (oset obj value (if-let ((saved (assq (oref obj command) transient-values))) (cdr saved) (transient-default-value obj))))) (cl-defmethod transient-init-value ((obj transient-suffix)) "Non-infix suffixes usually don't have a value. Call `transient-default-value' but because that is a noop for `transient-suffix', this function is effectively also a noop." (let ((value (transient-default-value obj))) (unless (eq value eieio--unbound) (oset obj value value)))) (cl-defmethod transient-init-value ((obj transient-argument)) "Extract OBJ's value from the value of the prefix object." (oset obj value (let ((value (oref transient--prefix value)) (argument (and (slot-boundp obj 'argument) (oref obj argument))) (multi-value (oref obj multi-value)) (case-fold-search nil) (regexp (if (slot-exists-p obj 'argument-regexp) (oref obj argument-regexp) (format "\\`%s\\(.*\\)" (oref obj argument))))) (if (memq multi-value '(t rest)) (cdr (assoc argument value)) (let ((match (lambda (v) (and (stringp v) (string-match regexp v) (match-string 1 v))))) (if multi-value (delq nil (mapcar match value)) (cl-some match value))))))) (cl-defmethod transient-init-value ((obj transient-switch)) "Extract OBJ's value from the value of the prefix object." (oset obj value (car (member (oref obj argument) (oref transient--prefix value))))) ;;;; Default (cl-defgeneric transient-default-value (obj) "Return the default value.") (cl-defmethod transient-default-value ((obj transient-prefix)) "Return the default value as specified by the `default-value' slot. If the value of the `default-value' slot is a function, call it to determine the value. If the slot's value isn't a function, return that. If the slot is unbound, return nil." (if-let ((default (and (slot-boundp obj 'default-value) (oref obj default-value)))) (if (functionp default) (funcall default) default) nil)) (cl-defmethod transient-default-value ((_ transient-suffix)) "Return `eieio--unbound' to indicate that there is no default value. Doing so causes `transient-init-value' to skip setting the `value' slot." eieio--unbound) ;;;; Read (cl-defgeneric transient-infix-read (obj) "Determine the new value of the infix object OBJ. This function merely determines the value; `transient-infix-set' is used to actually store the new value in the object. For most infix classes this is done by reading a value from the user using the reader specified by the `reader' slot (using the method for `transient-infix', described below). For some infix classes the value is changed without reading anything in the minibuffer, i.e., the mere act of invoking the infix command determines what the new value should be, based on the previous value.") (cl-defmethod transient-infix-read :around ((obj transient-infix)) "Refresh the transient buffer and call the next method. Also wrap `cl-call-next-method' with two macros: - `transient--with-suspended-override' allows use of minibuffer. - `transient--with-emergency-exit' arranges for the transient to be exited in case of an error." (transient--show) (transient--with-emergency-exit :infix-read (transient--with-suspended-override (cl-call-next-method obj)))) (cl-defmethod transient-infix-read ((obj transient-infix)) "Read a value while taking care of history. This method is suitable for a wide variety of infix commands, including but not limited to inline arguments and variables. If you do not use this method for your own infix class, then you should likely replicate a lot of the behavior of this method. If you fail to do so, then users might not appreciate the lack of history, for example. Only for very simple classes that toggle or cycle through a very limited number of possible values should you replace this with a simple method that does not handle history. (E.g., for a command line switch the only possible values are \"use it\" and \"don't use it\", in which case it is pointless to preserve history.)" (with-slots (value multi-value always-read allow-empty choices) obj (if (and value (not multi-value) (not always-read) transient--prefix) (oset obj value nil) (let* ((enable-recursive-minibuffers t) (reader (oref obj reader)) (choices (if (functionp choices) (funcall choices) choices)) (prompt (transient-prompt obj)) (value (if multi-value (string-join value ",") value)) (history-key (or (oref obj history-key) (oref obj command))) (transient--history (alist-get history-key transient-history)) (transient--history (if (or (null value) (eq value (car transient--history))) transient--history (cons value transient--history))) (initial-input (and transient-read-with-initial-input (car transient--history))) (history (if initial-input (cons 'transient--history 1) 'transient--history)) (value (cond (reader (funcall reader prompt initial-input history)) (multi-value (completing-read-multiple prompt choices nil nil initial-input history)) (choices (completing-read prompt choices nil t initial-input history)) ((read-string prompt initial-input history))))) (cond ((and (equal value "") (not allow-empty)) (setq value nil)) ((and (equal value "\"\"") allow-empty) (setq value ""))) (when value (when (and (bound-and-true-p ivy-mode) (stringp (car transient--history))) (set-text-properties 0 (length (car transient--history)) nil (car transient--history))) (setf (alist-get history-key transient-history) (delete-dups transient--history))) value)))) (cl-defmethod transient-infix-read ((obj transient-switch)) "Toggle the switch on or off." (if (oref obj value) nil (oref obj argument))) (cl-defmethod transient-infix-read ((obj transient-switches)) "Cycle through the mutually exclusive switches. The last value is \"don't use any of these switches\"." (let ((choices (mapcar (apply-partially #'format (oref obj argument-format)) (oref obj choices)))) (if-let ((value (oref obj value))) (cadr (member value choices)) (car choices)))) (cl-defmethod transient-infix-read ((command symbol)) "Elsewhere use the reader of the infix command COMMAND. Use this if you want to share an infix's history with a regular stand-alone command." (if-let ((obj (transient--suffix-prototype command))) (cl-letf (((symbol-function #'transient--show) #'ignore)) (transient-infix-read obj)) (error "Not a suffix command: `%s'" command))) ;;;; Readers (defun transient-read-file (prompt _initial-input _history) "Read a file." (file-local-name (expand-file-name (read-file-name prompt)))) (defun transient-read-existing-file (prompt _initial-input _history) "Read an existing file." (file-local-name (expand-file-name (read-file-name prompt nil nil t)))) (defun transient-read-directory (prompt _initial-input _history) "Read a directory." (file-local-name (expand-file-name (read-directory-name prompt)))) (defun transient-read-existing-directory (prompt _initial-input _history) "Read an existing directory." (file-local-name (expand-file-name (read-directory-name prompt nil nil t)))) (defun transient-read-number-N0 (prompt initial-input history) "Read a natural number (including zero) and return it as a string." (transient--read-number-N prompt initial-input history t)) (defun transient-read-number-N+ (prompt initial-input history) "Read a natural number (excluding zero) and return it as a string." (transient--read-number-N prompt initial-input history nil)) (defun transient--read-number-N (prompt initial-input history include-zero) (save-match-data (cl-block nil (while t (let ((str (read-from-minibuffer prompt initial-input nil nil history))) (when (or (string-equal str "") (string-match-p (if include-zero "\\`\\(0\\|[1-9][0-9]*\\)\\'" "\\`[1-9][0-9]*\\'") str)) (cl-return str))) (message "Please enter a natural number (%s zero)." (if include-zero "including" "excluding")) (sit-for 1))))) (defun transient-read-date (prompt default-time _history) "Read a date using `org-read-date' (which see)." (require 'org) (when (fboundp 'org-read-date) (org-read-date 'with-time nil nil prompt default-time))) ;;;; Prompt (cl-defgeneric transient-prompt (obj) "Return the prompt to be used to read infix object OBJ's value.") (cl-defmethod transient-prompt ((obj transient-infix)) "Return the prompt to be used to read infix object OBJ's value. This implementation should be suitable for almost all infix commands. If the value of OBJ's `prompt' slot is non-nil, then it must be a string or a function. If it is a string, then use that. If it is a function, then call that with OBJ as the only argument. That function must return a string, which is then used as the prompt. Otherwise, if the value of either the `argument' or `variable' slot of OBJ is a string, then base the prompt on that (preferring the former), appending either \"=\" (if it appears to be a command-line option) or \": \". Finally fall through to using \"(BUG: no prompt): \" as the prompt." (if-let ((prompt (oref obj prompt))) (let ((prompt (if (functionp prompt) (funcall prompt obj) prompt))) (if (stringp prompt) prompt "(BUG: no prompt): ")) (or (and-let* ((arg (and (slot-boundp obj 'argument) (oref obj argument)))) (if (and (stringp arg) (string-suffix-p "=" arg)) arg (concat arg ": "))) (and-let* ((var (and (slot-boundp obj 'variable) (oref obj variable)))) (and (stringp var) (concat var ": "))) "(BUG: no prompt): "))) ;;;; Set (cl-defgeneric transient-infix-set (obj value) "Set the value of infix object OBJ to VALUE.") (cl-defmethod transient-infix-set ((obj transient-infix) value) "Set the value of infix object OBJ to VALUE." (oset obj value value)) (cl-defmethod transient-infix-set :after ((obj transient-argument) value) "Unset incompatible infix arguments." (when-let* ((value) (val (transient-infix-value obj)) (arg (if (slot-boundp obj 'argument) (oref obj argument) (oref obj argument-format))) (spec (oref transient--prefix incompatible)) (filter (lambda (x rule) (and (member x rule) (remove x rule)))) (incomp (nconc (mapcan (apply-partially filter arg) spec) (and (not (equal val arg)) (mapcan (apply-partially filter val) spec))))) (dolist (obj transient--suffixes) (when-let* (((cl-typep obj 'transient-argument)) (val (transient-infix-value obj)) (arg (if (slot-boundp obj 'argument) (oref obj argument) (oref obj argument-format))) ((if (equal val arg) (member arg incomp) (or (member val incomp) (member arg incomp))))) (transient-infix-set obj nil))))) (defun transient-prefix-set (value) "Set the value of the active transient prefix to VALUE. Intended for use by transient suffix commands." (oset transient--prefix value value) (setq transient--refreshp 'updated-value)) (cl-defgeneric transient-set-value (obj) "Persist the value of the transient prefix OBJ. Only intended for use by `transient-set'. See also `transient-prefix-set'.") (cl-defmethod transient-set-value ((obj transient-prefix)) (oset (oref obj prototype) value (transient-get-value)) (transient--history-push obj)) ;;;; Save (cl-defgeneric transient-save-value (obj) "Save the value of the transient prefix OBJ.") (cl-defmethod transient-save-value ((obj transient-prefix)) (let ((value (transient-get-value))) (oset (oref obj prototype) value value) (setf (alist-get (oref obj command) transient-values) value) (transient-save-values)) (transient--history-push obj)) ;;;; Reset (cl-defgeneric transient-reset-value (obj) "Clear the set and saved values of the transient prefix OBJ.") (cl-defmethod transient-reset-value ((obj transient-prefix)) (let ((value (transient-default-value obj))) (oset obj value value) (oset (oref obj prototype) value value) (setf (alist-get (oref obj command) transient-values nil 'remove) nil) (transient-save-values)) (transient--history-push obj) (mapc #'transient-init-value transient--suffixes)) ;;;; Get (defun transient-args (prefix) "Return the value of the transient prefix command PREFIX. If the current command was invoked from the transient prefix command PREFIX, then return the active infix arguments. If the current command was not invoked from PREFIX, then return the set, saved or default value for PREFIX. PREFIX may also be a list of prefixes. If no prefix is active, the fallback value of the first of these prefixes is used. The generic function `transient-prefix-value' is used to determine the returned value." (when (listp prefix) (setq prefix (car (or (memq transient-current-command prefix) prefix)))) (if-let ((obj (get prefix 'transient--prefix))) (transient-prefix-value obj) (error "Not a transient prefix: %s" prefix))) (cl-defgeneric transient-prefix-value (obj) "Return the value of the prefix object OBJ. This function is used by `transient-args'.") (cl-defmethod transient-prefix-value ((obj transient-prefix)) "Return a list of the values of the suffixes the prefix object OBJ. Use `transient-infix-value' to collect the values of individual suffix objects." (mapcan #'transient--get-wrapped-value (transient-suffixes (oref obj command)))) (defun transient-suffixes (prefix) "Return the suffix objects of the transient prefix command PREFIX. If PREFIX is not the current prefix, initialize the suffixes so that they can be returned. Doing so doesn't have any side-effects." (if (eq transient-current-command prefix) transient-current-suffixes (let ((transient--prefix (transient--init-prefix prefix))) (transient--flatten-suffixes (transient--init-suffixes prefix))))) (defun transient-get-value () "Return the value of the current prefix. This is mostly intended for internal use, but may also be of use in `transient-set-value' and `transient-save-value' methods. Unlike `transient-args', this does not include the values of suffixes whose `unsavable' slot is non-nil." (transient--with-emergency-exit :get-value (mapcan (lambda (obj) (and (or (not (slot-exists-p obj 'unsavable)) (not (oref obj unsavable))) (transient--get-wrapped-value obj))) (or transient--suffixes transient-current-suffixes)))) (defun transient--get-wrapped-value (obj) "Return a list of the value(s) of suffix object OBJ. Internally a suffix only ever has one value, stored in its `value' slot, but callers of `transient-args', wish to treat the values of certain suffixes as multiple values. That translation is handled here. The object's `multi-value' slot specifies whether and how to interpret the `value' as multiple values." (and-let* ((value (transient-infix-value obj))) (pcase-exhaustive (and (slot-exists-p obj 'multi-value) (oref obj multi-value)) ('nil (list value)) ((or 't 'rest) (list value)) ('repeat value)))) (cl-defgeneric transient-infix-value (obj) "Return the value of the suffix object OBJ. By default this function is involved when determining the prefix's overall value, returned by `transient-args' (which see), so that the invoked suffix command can use that. Currently most values are strings, but that is not set in stone. Nil is not a value, it means \"no value\". Usually only infixes have a value, but see the method for `transient-suffix'.") (cl-defmethod transient-infix-value ((_ transient-suffix)) "Return nil, which means \"no value\". Infix arguments contribute the transient's value while suffix commands consume it. This function is called for suffixes anyway because a command that both contributes to the transient's value and also consumes it is not completely unconceivable. If you define such a command, then you must define a derived class and implement this function because this default method does nothing." nil) (cl-defmethod transient-infix-value ((obj transient-infix)) "Return the value of OBJ's `value' slot." (oref obj value)) (cl-defmethod transient-infix-value ((obj transient-option)) "Return ARGUMENT and VALUE as a unit or nil if the latter is nil." (and-let* ((value (oref obj value))) (let ((arg (oref obj argument))) (pcase-exhaustive (oref obj multi-value) ('nil (concat arg value)) ((or 't 'rest) (cons arg value)) ('repeat (mapcar (lambda (v) (concat arg v)) value)))))) (cl-defmethod transient-infix-value ((_ transient-variable)) "Return nil, which means \"no value\". Setting the value of a variable is done by, well, setting the value of the variable. I.e., this is a side-effect and does not contribute to the value of the transient." nil) ;;;; Utilities (defun transient-arg-value (arg args) "Return the value of ARG as it appears in ARGS. For a switch return a boolean. For an option return the value as a string, using the empty string for the empty value, or nil if the option does not appear in ARGS. Append \"=\ to ARG to indicate that it is an option." (if (string-suffix-p "=" arg) (save-match-data (and-let* ((match (let ((case-fold-search nil) (re (format "\\`%s\\(?:=\\(.+\\)\\)?\\'" (substring arg 0 -1)))) (cl-find-if (lambda (a) (and (stringp a) (string-match re a))) args)))) (or (match-string 1 match) ""))) (and (member arg args) t))) ;;; Return (defun transient-init-return (obj) (when-let* ((transient--stack) (command (oref obj command)) (suffix-obj (transient-suffix-object command)) ((memq (if (slot-boundp suffix-obj 'transient) (oref suffix-obj transient) (oref transient-current-prefix transient-suffix)) (list t 'recurse #'transient--do-recurse)))) (oset obj return t))) ;;; Scope ;;;; Init (cl-defgeneric transient-init-scope (obj) "Set the scope of the prefix or suffix object OBJ. The scope is actually a property of the transient prefix, not of individual suffixes. However it is possible to invoke a suffix command directly instead of from a transient. In that case, if the suffix expects a scope, then it has to determine that itself and store it in its `scope' slot. This function is called for all prefix and suffix commands, but unless a concrete method is implemented, this falls through to a default implementation, which is a noop.") (cl-defmethod transient-init-scope ((_ transient-prefix)) "Noop." nil) (cl-defmethod transient-init-scope ((_ transient-suffix)) "Noop." nil) ;;;; Get (defun transient-scope (&optional prefixes classes) "Return the scope of the active or current transient prefix command. If optional PREFIXES and CLASSES are both nil, return the scope of the prefix currently being setup, making this variation useful, e.g., in `:if*' predicates. If no prefix is being setup, but the current command was invoked from some prefix, then return the scope of that. If PREFIXES is non-nil, it must be a prefix command or a list of such commands. If CLASSES is non-nil, it must be a prefix class or a list of such classes. When this function is called from the body or the `interactive' form of a suffix command, PREFIXES and/or CLASSES should be non-nil. If either is non-nil, try the following in order: - If the current suffix command was invoked from a prefix, which appears in PREFIXES, return the scope of that prefix. - If the current suffix command was invoked from a prefix, and its class derives from one of the CLASSES, return the scope of that prefix. - If a prefix is being setup and it appears in PREFIXES, return its scope. - If a prefix is being setup and its class derives from one of the CLASSES, return its scope. - Finally try to return the default scope of the first command in PREFIXES. This only works if that slot is set in the respective class definition or using its `transient-init-scope' method. If no prefix matches, return nil." (if (or prefixes classes) (let ((prefixes (ensure-list prefixes)) (type (if (symbolp classes) classes (cons 'or classes)))) (if-let ((obj (cl-flet ((match (obj) (and obj (or (memq (oref obj command) prefixes) (cl-typep obj type)) obj))) (or (match transient-current-prefix) (match transient--prefix))))) (oref obj scope) (and (get (car prefixes) 'transient--prefix) (oref (transient--init-prefix (car prefixes)) scope)))) (and-let* ((obj (transient-prefix-object))) (oref obj scope)))) ;;; History (cl-defgeneric transient--history-key (obj) "Return OBJ's history key.") (cl-defmethod transient--history-key ((obj transient-prefix)) "If the value of the `history-key' slot is non-nil, return that. Otherwise return the value of the `command' slot." (or (oref obj history-key) (oref obj command))) (cl-defgeneric transient--history-push (obj) "Push the current value of OBJ to its entry in `transient-history'.") (cl-defmethod transient--history-push ((obj transient-prefix)) (let ((key (transient--history-key obj))) (setf (alist-get key transient-history) (let ((args (transient-get-value))) (cons args (delete args (alist-get key transient-history))))))) (cl-defgeneric transient--history-init (obj) "Initialize OBJ's `history' slot. This is the transient-wide history; many individual infixes also have a history of their own.") (cl-defmethod transient--history-init ((obj transient-prefix)) "Initialize OBJ's `history' slot from the variable `transient-history'." (let ((val (oref obj value))) (oset obj history (cons val (delete val (alist-get (transient--history-key obj) transient-history)))))) ;;; Display (defun transient--show-hint () (let ((message-log-max nil)) (message "%s" (transient--format-hint)))) (defun transient--show () (transient--timer-cancel) (setq transient--showp t) (let ((transient--shadowed-buffer (current-buffer)) (setup (not (get-buffer transient--buffer-name))) (focus nil)) (setq transient--buffer (get-buffer-create transient--buffer-name)) (with-current-buffer transient--buffer (when transient-enable-popup-navigation (setq focus (or (button-get (point) 'command) (and (not (bobp)) (button-get (1- (point)) 'command)) (transient--heading-at-point)))) (erase-buffer) (transient--insert-menu setup)) (unless (window-live-p transient--window) (setq transient--window (display-buffer transient--buffer (transient--display-action))) (with-selected-window transient--window (set-window-parameter nil 'prev--no-other-window (window-parameter nil 'no-other-window)))) (when (window-live-p transient--window) (with-selected-window transient--window (set-window-parameter nil 'no-other-window t) (goto-char (point-min)) (when transient-enable-popup-navigation (transient--goto-button focus)) (transient--fit-window-to-buffer transient--window))))) (defun transient--display-action () (let ((action (cond ((oref transient--prefix display-action)) ((memq 'display-buffer-full-frame (ensure-list (car transient-display-buffer-action))) (user-error "%s disallowed in %s" 'display-buffer-full-frame 'transient-display-buffer-action)) (transient-display-buffer-action)))) (when (and (assq 'pop-up-frame-parameters (cdr action)) (fboundp 'buffer-line-statistics)) ; Emacs >= 28.1 (setq action (copy-tree action)) (pcase-let ((`(,height ,width) (buffer-line-statistics transient--buffer)) (params (assq 'pop-up-frame-parameters (cdr action)))) (setf (alist-get 'height params) height) (setf (alist-get 'width params) (max width (or transient-minimal-frame-width 0))))) action)) (defun transient--fit-window-to-buffer (window) (set-window-parameter window 'window-preserved-size nil) (let ((fit-window-to-buffer-horizontally t) (window-resize-pixelwise t) (window-size-fixed nil)) (cond ((not (window-parent window)) (fit-frame-to-buffer (window-frame window) nil nil nil transient-minimal-frame-width)) ((eq (car (window-parameter window 'quit-restore)) 'other) ;; Grow but never shrink window that previously displayed ;; another buffer and is going to display that again. (fit-window-to-buffer window nil (window-height window))) ((fit-window-to-buffer window nil 1)))) (set-window-parameter window 'window-preserved-size (list (window-buffer window) (window-body-width window t) (window-body-height window t)))) ;;; Delete (defun transient--delete-window () (when (window-live-p transient--window) (let ((win transient--window) (remain-in-minibuffer-window (and (minibuffer-selected-window) (selected-window)))) (cond ((eq (car (window-parameter win 'quit-restore)) 'other) ;; Window used to display another buffer. (set-window-parameter win 'no-other-window (window-parameter win 'prev--no-other-window)) (set-window-parameter win 'prev--no-other-window nil)) ((with-demoted-errors "Error while exiting transient: %S" (if (window-parent win) (delete-window win) (delete-frame (window-frame win) t))))) (when remain-in-minibuffer-window (select-window remain-in-minibuffer-window)))) (when (buffer-live-p transient--buffer) (kill-buffer transient--buffer)) (setq transient--buffer nil)) (defun transient--preserve-window-p (&optional nohide) (let ((show (if nohide 'fixed transient-show-during-minibuffer-read))) (when (and (integerp show) (window-live-p transient--window) (< (frame-height (window-frame transient--window)) (+ (abs show) (window-height transient--window)))) (setq show (natnump show))) show)) ;;; Format (defun transient--format-hint () (if (and transient-show-popup (<= transient-show-popup 0)) (format "%s-" (key-description (this-command-keys))) (format "%s- [%s] %s" (key-description (this-command-keys)) (oref transient--prefix command) (mapconcat #'identity (sort (mapcan (lambda (suffix) (let ((key (kbd (oref suffix key)))) ;; Don't list any common commands. (and (not (memq (oref suffix command) `(,(lookup-key transient-map key) ,(lookup-key transient-sticky-map key) ;; From transient-common-commands: transient-set transient-save transient-history-prev transient-history-next transient-quit-one transient-toggle-common transient-set-level))) (list (propertize (oref suffix key) 'face 'transient-key))))) transient--suffixes) #'string<) (propertize "|" 'face 'transient-delimiter))))) (defun transient--insert-menu (setup) (when setup (when transient-force-fixed-pitch (transient--force-fixed-pitch)) (when (bound-and-true-p tab-line-format) (setq tab-line-format nil)) (setq header-line-format nil) (setq mode-line-format (let ((format (transient--mode-line-format))) (if (or (natnump format) (eq format 'line)) nil format))) (setq mode-line-buffer-identification (symbol-name (oref transient--prefix command))) (if transient-enable-popup-navigation (setq-local cursor-in-non-selected-windows 'box) (setq cursor-type nil)) (setq display-line-numbers nil) (setq show-trailing-whitespace nil) (run-hooks 'transient-setup-buffer-hook)) (transient--insert-groups) (when (or transient--helpp transient--editp) (transient--insert-help)) (when-let ((line (transient--separator-line))) (insert line))) (defun transient--mode-line-format () (if (slot-boundp transient--prefix 'mode-line-format) (oref transient--prefix mode-line-format) transient-mode-line-format)) (defun transient--separator-line () (and-let* ((format (transient--mode-line-format)) (height (cond ((not window-system) nil) ((natnump format) format) ((eq format 'line) 1))) (face `(,@(and (>= emacs-major-version 27) '(:extend t)) :background ,(transient--prefix-color)))) (concat (propertize "__" 'face face 'display `(space :height (,height))) (propertize "\n" 'face face 'line-height t)))) (defun transient--prefix-color () (or (face-foreground (transient--key-face nil nil 'non-suffix) nil t) "#gray60")) (defmacro transient-with-shadowed-buffer (&rest body) "While in the transient buffer, temporarily make the shadowed buffer current." (declare (indent 0) (debug t)) `(with-current-buffer (or transient--shadowed-buffer (current-buffer)) ,@body)) (defun transient--insert-groups () (let ((groups (mapcan (lambda (group) (let ((hide (oref group hide))) (and (not (and (functionp hide) (transient-with-shadowed-buffer (funcall hide)))) (list group)))) transient--layout))) (while-let ((group (pop groups))) (transient--insert-group group) (when groups (insert ?\n))))) (defvar transient--max-group-level 1) (cl-defgeneric transient--insert-group (group) "Format GROUP and its elements and insert the result.") (cl-defmethod transient--insert-group :around ((group transient-group) &optional _) "Insert GROUP's description, if any." (when-let ((desc (transient-with-shadowed-buffer (transient-format-description group)))) (insert desc ?\n)) (let ((transient--max-group-level (max (oref group level) transient--max-group-level)) (transient--pending-group group)) (cl-call-next-method group))) (cl-defmethod transient--insert-group ((group transient-row)) (transient--maybe-pad-keys group) (dolist (suffix (oref group suffixes)) (insert (transient-with-shadowed-buffer (transient-format suffix))) (insert " ")) (insert ?\n)) (cl-defmethod transient--insert-group ((group transient-column) &optional skip-empty) (transient--maybe-pad-keys group) (dolist (suffix (oref group suffixes)) (let ((str (transient-with-shadowed-buffer (transient-format suffix)))) (unless (and (not skip-empty) (equal str "")) (insert str) (unless (string-match-p ".\n\\'" str) (insert ?\n)))))) (cl-defmethod transient--insert-group ((group transient-columns)) (if (or transient-force-single-column transient--docsp) (dolist (group (oref group suffixes)) (transient--insert-group group t)) (let* ((columns (mapcar (lambda (column) (transient--maybe-pad-keys column group) (transient-with-shadowed-buffer `(,@(and-let* ((desc (transient-format-description column))) (list desc)) ,@(let ((transient--pending-group column)) (mapcar #'transient-format (oref column suffixes)))))) (oref group suffixes))) (stops (transient--column-stops columns))) (dolist (row (apply #'transient--mapn #'list columns)) (let ((stops stops)) (dolist (cell row) (let ((stop (pop stops))) (when cell (transient--align-to stop) (insert cell))))) (insert ?\n))))) (cl-defmethod transient--insert-group ((group transient-subgroups)) (let ((subgroups (oref group suffixes))) (while-let ((subgroup (pop subgroups))) (transient--maybe-pad-keys subgroup group) (transient--insert-group subgroup) (when subgroups (insert ?\n))))) (cl-defgeneric transient-format (obj) "Format and return OBJ for display. When this function is called, then the current buffer is some temporary buffer. If you need the buffer from which the prefix command was invoked to be current, then do so by temporarily making `transient--original-buffer' current.") (cl-defmethod transient-format ((arg string)) "Return the string ARG after applying the `transient-heading' face." (propertize arg 'face 'transient-heading)) (cl-defmethod transient-format ((_ null)) "Return a string containing just the newline character." "\n") (cl-defmethod transient-format ((arg integer)) "Return a string containing just the ARG character." (char-to-string arg)) (cl-defmethod transient-format :around ((obj transient-suffix)) "Add additional formatting if appropriate. When reading user input for this infix, then highlight it. When edit-mode is enabled, then prepend the level information. When `transient-enable-popup-navigation' is non-nil then format as a button." (let ((str (cl-call-next-method obj))) (when (and (cl-typep obj 'transient-infix) (eq (oref obj command) this-original-command) (active-minibuffer-window)) (setq str (transient--add-face str 'transient-active-infix))) (when transient--editp (setq str (concat (let ((level (oref obj level))) (propertize (format " %s " level) 'face (if (transient--use-level-p level t) 'transient-enabled-suffix 'transient-disabled-suffix))) str))) (when (and transient-enable-popup-navigation (slot-boundp obj 'command)) (setq str (make-text-button str nil 'type 'transient 'suffix obj 'command (oref obj command)))) str)) (cl-defmethod transient-format ((obj transient-infix)) "Return a string generated using OBJ's `format'. %k is formatted using `transient-format-key'. %d is formatted using `transient-format-description'. %v is formatted using `transient-format-value'." (format-spec (oref obj format) `((?k . ,(transient-format-key obj)) (?d . ,(transient-format-description obj)) (?v . ,(transient-format-value obj))))) (cl-defmethod transient-format ((obj transient-suffix)) "Return a string generated using OBJ's `format'. %k is formatted using `transient-format-key'. %d is formatted using `transient-format-description'." (format-spec (oref obj format) `((?k . ,(transient-format-key obj)) (?d . ,(transient-format-description obj))))) (cl-defgeneric transient-format-key (obj) "Format OBJ's `key' for display and return the result.") (cl-defmethod transient-format-key ((obj transient-suffix)) "Format OBJ's `key' for display and return the result." (let ((key (if (slot-boundp obj 'key) (oref obj key) "")) (cmd (and (slot-boundp obj 'command) (oref obj command)))) (when-let ((width (oref transient--pending-group pad-keys))) (setq key (truncate-string-to-width key width nil ?\s))) (if transient--redisplay-key (let ((len (length transient--redisplay-key)) (seq (cl-coerce (edmacro-parse-keys key t) 'list))) (cond ((member (seq-take seq len) (list transient--redisplay-key (thread-last transient--redisplay-key (cl-substitute ?- 'kp-subtract) (cl-substitute ?= 'kp-equal) (cl-substitute ?+ 'kp-add)))) (let ((pre (key-description (vconcat (seq-take seq len)))) (suf (key-description (vconcat (seq-drop seq len))))) (setq pre (string-replace "RET" "C-m" pre)) (setq pre (string-replace "TAB" "C-i" pre)) (setq suf (string-replace "RET" "C-m" suf)) (setq suf (string-replace "TAB" "C-i" suf)) ;; We use e.g., "-k" instead of the more correct "- k", ;; because the former is prettier. If we did that in ;; the definition, then we want to drop the space that ;; is reinserted above. False-positives are possible ;; for silly bindings like "-C-c C-c". (unless (string-search " " key) (setq pre (string-replace " " "" pre)) (setq suf (string-replace " " "" suf))) (concat (propertize pre 'face 'transient-unreachable-key) (and (string-prefix-p (concat pre " ") key) " ") (propertize suf 'face (transient--key-face cmd key)) (save-excursion (and (string-match " +\\'" key) (propertize (match-string 0 key) 'face 'fixed-pitch)))))) ((transient--lookup-key transient-sticky-map (kbd key)) (propertize key 'face (transient--key-face cmd key))) (t (propertize key 'face 'transient-unreachable-key)))) (propertize key 'face (transient--key-face cmd key))))) (cl-defmethod transient-format-key :around ((obj transient-argument)) "Handle `transient-highlight-mismatched-keys'." (let ((key (cl-call-next-method obj))) (cond ((not transient-highlight-mismatched-keys) key) ((not (slot-boundp obj 'shortarg)) (transient--add-face key 'transient-nonstandard-key)) ((not (string-equal key (oref obj shortarg))) (transient--add-face key 'transient-mismatched-key)) (key)))) (cl-defgeneric transient-format-description (obj) "Format OBJ's `description' for display and return the result.") (cl-defmethod transient-format-description ((obj transient-suffix)) "The `description' slot may be a function, in which case that is called inside the correct buffer (see `transient--insert-group') and its value is returned to the caller." (transient--get-description obj)) (cl-defmethod transient-format-description ((obj transient-value-preset)) (pcase-let* (((eieio description key set) obj) ((eieio value) transient--prefix) (active (seq-set-equal-p set value))) (format "%s %s" (propertize (or description (format "Preset %s" key)) 'face (and active 'transient-argument)) (format (propertize "(%s)" 'face 'transient-delimiter) (mapconcat (lambda (arg) (propertize arg 'face (cond (active 'transient-argument) ((member arg value) '((:weight demibold) transient-inactive-argument)) ('transient-inactive-argument)))) set " "))))) (cl-defmethod transient-format-description ((obj transient-group)) "Format the description by calling the next method. If the result doesn't use the `face' property at all, then apply the face `transient-heading' to the complete string." (and-let* ((desc (transient--get-description obj))) (cond ((oref obj inapt) (propertize desc 'face 'transient-inapt-suffix)) ((text-property-not-all 0 (length desc) 'face nil desc) desc) ((propertize desc 'face 'transient-heading))))) (cl-defmethod transient-format-description :around ((obj transient-suffix)) "Format the description by calling the next method. If the result is nil, then use \"(BUG: no description)\" as the description. If the OBJ's `key' is currently unreachable, then apply the face `transient-unreachable' to the complete string." (let ((desc (or (cl-call-next-method obj) (and (slot-boundp transient--prefix 'suffix-description) (funcall (oref transient--prefix suffix-description) obj))))) (when-let* ((transient--docsp) ((slot-boundp obj 'command)) (cmd (oref obj command)) ((not (memq 'transient--default-infix-command (function-alias-p cmd)))) (docstr (ignore-errors (documentation cmd))) (docstr (string-trim (substring docstr 0 (string-match "\\.?\n" docstr)))) ((not (equal docstr "")))) (setq desc (format-spec transient-show-docstring-format `((?c . ,desc) (?s . ,docstr))))) (if desc (when-let ((face (transient--get-face obj 'face))) (setq desc (transient--add-face desc face t))) (setq desc (propertize "(BUG: no description)" 'face 'error))) (when (if transient--all-levels-p (> (oref obj level) transient--default-prefix-level) (and transient-highlight-higher-levels (> (max (oref obj level) transient--max-group-level) transient--default-prefix-level))) (setq desc (transient--add-face desc 'transient-higher-level))) (when-let ((inapt-face (and (oref obj inapt) (transient--get-face obj 'inapt-face)))) (setq desc (transient--add-face desc inapt-face))) (when (and (slot-boundp obj 'key) (transient--key-unreachable-p obj)) (setq desc (transient--add-face desc 'transient-unreachable))) desc)) (cl-defgeneric transient-format-value (obj) "Format OBJ's value for display and return the result.") (cl-defmethod transient-format-value ((obj transient-suffix)) (propertize (oref obj argument) 'face (if (oref obj value) 'transient-argument 'transient-inactive-argument))) (cl-defmethod transient-format-value ((obj transient-option)) (let ((argument (oref obj argument))) (if-let ((value (oref obj value))) (pcase-exhaustive (oref obj multi-value) ('nil (concat (propertize argument 'face 'transient-argument) (propertize value 'face 'transient-value))) ((or 't 'rest) (concat (propertize (if (string-suffix-p " " argument) argument (concat argument " ")) 'face 'transient-argument) (propertize (mapconcat #'prin1-to-string value " ") 'face 'transient-value))) ('repeat (mapconcat (lambda (value) (concat (propertize argument 'face 'transient-argument) (propertize value 'face 'transient-value))) value " "))) (propertize argument 'face 'transient-inactive-argument)))) (cl-defmethod transient-format-value ((obj transient-switches)) (with-slots (value argument-format choices) obj (format (propertize argument-format 'face (if value 'transient-argument 'transient-inactive-argument)) (format (propertize "[%s]" 'face 'transient-delimiter) (mapconcat (lambda (choice) (propertize choice 'face (if (equal (format argument-format choice) value) 'transient-value 'transient-inactive-value))) choices (propertize "|" 'face 'transient-delimiter)))))) (cl-defmethod transient--get-description ((obj transient-child)) (and-let* ((desc (oref obj description))) (if (functionp desc) (if (= (car (transient--func-arity desc)) 1) (funcall desc obj) (funcall desc)) desc))) (cl-defmethod transient--get-face ((obj transient-suffix) slot) (and-let* (((slot-boundp obj slot)) (face (slot-value obj slot))) (if (and (not (facep face)) (functionp face)) (let ((transient--pending-suffix obj)) (if (= (car (transient--func-arity face)) 1) (funcall face obj) (funcall face))) face))) (defun transient--add-face (string face &optional append beg end) (let ((str (copy-sequence string))) (add-face-text-property (or beg 0) (or end (length str)) face append str) str)) (defun transient--key-face (cmd key &optional enforce-type) (or (and transient-semantic-coloring (not transient--helpp) (not transient--editp) (get (transient--get-pre-command cmd key enforce-type) 'transient-face)) (if cmd 'transient-key 'transient-key-noop))) (defun transient--key-unreachable-p (obj) (and transient--redisplay-key (let ((key (oref obj key))) (not (or (equal (seq-take (cl-coerce (edmacro-parse-keys key t) 'list) (length transient--redisplay-key)) transient--redisplay-key) (transient--lookup-key transient-sticky-map (kbd key))))))) (defun transient--lookup-key (keymap key) (let ((val (lookup-key keymap key))) (and val (not (integerp val)) val))) (defun transient--maybe-pad-keys (group &optional parent) (when-let ((pad (or (oref group pad-keys) (and parent (oref parent pad-keys))))) (oset group pad-keys (apply #'max (if (integerp pad) pad 0) (seq-keep (lambda (suffix) (and (eieio-object-p suffix) (slot-boundp suffix 'key) (length (oref suffix key)))) (oref group suffixes)))))) (defun transient--pixel-width (string) (save-window-excursion (with-temp-buffer (insert string) (set-window-dedicated-p nil nil) (set-window-buffer nil (current-buffer)) (car (window-text-pixel-size nil (line-beginning-position) (point)))))) (defun transient--column-stops (columns) (let* ((var-pitch (or transient-align-variable-pitch (oref transient--prefix variable-pitch))) (char-width (and var-pitch (transient--pixel-width " ")))) (transient--seq-reductions-from (apply-partially #'+ (* 2 (if var-pitch char-width 1))) (transient--mapn (lambda (cells min) (apply #'max (if min (if var-pitch (* min char-width) min) 0) (mapcar (if var-pitch #'transient--pixel-width #'length) cells))) columns (oref transient--prefix column-widths)) 0))) (defun transient--align-to (stop) (unless (zerop stop) (insert (if (or transient-align-variable-pitch (oref transient--prefix variable-pitch)) (propertize " " 'display `(space :align-to (,stop))) (make-string (max 0 (- stop (current-column))) ?\s))))) (defun transient-command-summary-or-name (obj) "Return the summary or name of the command represented by OBJ. If the command has a doc-string, then return the first line of that, else its name. Intended to be temporarily used as the `:suffix-description' of a prefix command, while porting a regular keymap to a transient." (let ((command (oref obj command))) (if-let ((doc (documentation command))) (propertize (car (split-string doc "\n")) 'face 'font-lock-doc-face) (propertize (symbol-name command) 'face 'font-lock-function-name-face)))) ;;; Help (cl-defgeneric transient-show-help (obj) "Show documentation for the command represented by OBJ.") (cl-defmethod transient-show-help ((obj transient-prefix)) "Call `show-help' if non-nil, else show `info-manual', if non-nil, else show the `man-page' if non-nil, else use `describe-function'." (with-slots (show-help info-manual man-page command) obj (cond (show-help (funcall show-help obj)) (info-manual (transient--show-manual info-manual)) (man-page (transient--show-manpage man-page)) ((transient--describe-function command))))) (cl-defmethod transient-show-help ((obj transient-suffix)) "Call `show-help' if non-nil, else use `describe-function'. Also used to dispatch showing documentation for the current prefix. If the suffix is a sub-prefix, then also call the prefix method." (cond ((eq this-command 'transient-help) (transient-show-help transient--prefix)) ((let ((prefix (get (oref obj command) 'transient--prefix))) (and prefix (not (eq (oref transient--prefix command) this-command)) (prog1 t (transient-show-help prefix))))) ((if-let ((show-help (oref obj show-help))) (funcall show-help obj) (transient--describe-function this-command))))) (cl-defmethod transient-show-help ((obj transient-infix)) "Call `show-help' if non-nil, else show the `man-page' if non-nil, else use `describe-function'. When showing the manpage, then try to jump to the correct location." (if-let ((show-help (oref obj show-help))) (funcall show-help obj) (if-let ((man-page (oref transient--prefix man-page)) (argument (and (slot-boundp obj 'argument) (oref obj argument)))) (transient--show-manpage man-page argument) (transient--describe-function this-command)))) ;; `cl-generic-generalizers' doesn't support `command' et al. (cl-defmethod transient-show-help (cmd) "Show the command doc-string." (transient--describe-function cmd)) (defmacro transient-with-help-window (&rest body) "Evaluate BODY, send output to *Help* buffer, and display it in a window. Select the help window, and make the help buffer current and return it." (declare (indent 0)) `(let ((buffer nil) (help-window-select t)) (with-help-window (help-buffer) ,@body (setq buffer (current-buffer))) (set-buffer buffer))) (defun transient--display-help (helper target) (let ((winconf (current-window-configuration))) (funcall (cond (helper) ((symbolp target) #'transient--describe-function) ((stringp target) (if (string-prefix-p "(" target) #'transient--show-manual #'transient--show-manpage)) ((error "Unknown how to show help for %S" target))) target) (setq-local transient--restore-winconf winconf)) (fit-window-to-buffer nil (frame-height) (window-height)) (transient-resume-mode) (message (substitute-command-keys "Type \\`q' to resume transient command."))) (defun transient--describe-function (fn) (let* ((buffer nil) (help-window-select t) (temp-buffer-window-setup-hook (cons (lambda () (setq buffer (current-buffer))) temp-buffer-window-setup-hook))) (describe-function fn) (set-buffer buffer))) (defun transient--show-manual (manual) (info manual)) (defun transient--show-manpage (manpage &optional argument) (require 'man) (let* ((Man-notify-method 'meek) (buf (Man-getpage-in-background manpage)) (proc (get-buffer-process buf))) (while (and proc (eq (process-status proc) 'run)) (accept-process-output proc)) (switch-to-buffer buf) (when argument (transient--goto-argument-description argument)))) (defun transient--goto-argument-description (arg) (goto-char (point-min)) (let ((case-fold-search nil) ;; This matches preceding/proceeding options. Options ;; such as "-a", "-S[]", and "--grep=" ;; are matched by this regex without the shy group. ;; The ". " in the shy group is for options such as ;; "-m parent-number", and the "-[^[:space:]]+ " is ;; for options such as "--mainline parent-number" (others "-\\(?:. \\|-[^[:space:]]+ \\)?[^[:space:]]+")) (when (re-search-forward (if (equal arg "--") ;; Special case. "^[\t\s]+\\(--\\(?: \\|$\\)\\|\\[--\\]\\)" ;; Should start with whitespace and may have ;; any number of options before and/or after. (format "^[\t\s]+\\(?:%s, \\)*?\\(?1:%s\\)%s\\(?:, %s\\)*$" others ;; Options don't necessarily end in an "=" ;; (e.g., "--gpg-sign[=]") (string-remove-suffix "=" arg) ;; Simple options don't end in an "=". Splitting this ;; into 2 cases should make getting false positives ;; less likely. (if (string-suffix-p "=" arg) ;; "[^[:space:]]*[^.[:space:]]" matches the option ;; value, which is usually after the option name ;; and either '=' or '[='. The value can't end in ;; a period, as that means it's being used at the ;; end of a sentence. The space is for options ;; such as '--mainline parent-number'. "\\(?: \\|\\[?=\\)[^[:space:]]*[^.[:space:]]" ;; Either this doesn't match anything (e.g., "-a"), ;; or the option is followed by a value delimited ;; by a "[", "<", or ":". A space might appear ;; before this value, as in "-f ". The ;; space alternative is for options such as ;; "-m parent-number". "\\(?:\\(?: \\| ?[\\[<:]\\)[^[:space:]]*[^.[:space:]]\\)?") others)) nil t) (goto-char (match-beginning 1))))) (defun transient--insert-help () (unless (looking-back "\n\n" 2) (insert "\n")) (when transient--helpp (insert (format (propertize "\ Type a %s to show help for that suffix command, or %s to show manual. Type %s to exit help.\n" 'face 'transient-heading) (propertize "" 'face 'transient-key) (propertize "?" 'face 'transient-key) (propertize "C-g" 'face 'transient-key)))) (when transient--editp (unless transient--helpp (insert (format (propertize "\ Type %s and then %s to put the respective suffix command on level %s. Type %s and then %s to display suffixes up to level %s in this menu. Type %s and then %s to describe the respective suffix command.\n" 'face 'transient-heading) (propertize "" 'face 'transient-key) (propertize "" 'face 'transient-key) (propertize " N " 'face 'transient-enabled-suffix) (propertize (concat transient-common-command-prefix " l") 'face 'transient-key) (propertize "" 'face 'transient-key) (propertize " N " 'face 'transient-enabled-suffix) (propertize "C-h" 'face 'transient-key) (propertize "" 'face 'transient-key)))) (with-slots (level) transient--prefix (insert (format (propertize " The current level of this menu is %s, so commands on levels %s are displayed, and commands on levels %s and %s are not displayed.\n" 'face 'transient-heading) (propertize (format " %s " level) 'face 'transient-enabled-suffix) (propertize (format " 1..%s " level) 'face 'transient-enabled-suffix) (propertize (format " >= %s " (1+ level)) 'face 'transient-disabled-suffix) (propertize " 0 " 'face 'transient-disabled-suffix)))))) (cl-defgeneric transient-show-summary (obj &optional return) "Show brief summary about the command at point in the echo area. If OBJ's `summary' slot is a string, use that. If it is a function, call that with OBJ as the only argument and use the returned string. If `summary' is or returns something other than a string or nil, show no summary. If `summary' is or returns nil, use the first line of the documentation string, if any. If RETURN is non-nil, return the summary instead of showing it. This is used when a tooltip is needed.") (cl-defmethod transient-show-summary ((obj transient-suffix) &optional return) (with-slots (command summary) obj (when-let* ((doc (cond ((functionp summary) (funcall summary obj)) (summary) ((documentation command) (car (split-string (documentation command) "\n"))))) ((stringp doc)) ((not (equal doc (car (split-string (documentation 'transient--default-infix-command) "\n")))))) (when (string-suffix-p "." doc) (setq doc (substring doc 0 -1))) (if return doc (let ((message-log-max nil)) (message "%s" doc)))))) ;;; Menu Navigation (defun transient-scroll-up (&optional arg) "Scroll text of transient's menu window upward ARG lines. If ARG is nil scroll near full screen. This is a wrapper around `scroll-up-command' (which see)." (interactive "^P") (with-selected-window transient--window (scroll-up-command arg))) (defun transient-scroll-down (&optional arg) "Scroll text of transient's menu window down ARG lines. If ARG is nil scroll near full screen. This is a wrapper around `scroll-down-command' (which see)." (interactive "^P") (with-selected-window transient--window (scroll-down-command arg))) (defun transient-backward-button (n) "Move to the previous button in transient's menu buffer. See `backward-button' for information about N." (interactive "p") (with-selected-window transient--window (backward-button n t) (when (eq transient-enable-popup-navigation 'verbose) (transient-show-summary (get-text-property (point) 'suffix))))) (defun transient-forward-button (n) "Move to the next button in transient's menu buffer. See `forward-button' for information about N." (interactive "p") (with-selected-window transient--window (forward-button n t) (when (eq transient-enable-popup-navigation 'verbose) (transient-show-summary (get-text-property (point) 'suffix))))) (define-button-type 'transient 'face nil 'keymap transient-button-map 'help-echo (lambda (win buf pos) (with-selected-window win (with-current-buffer buf (transient-show-summary (get-text-property pos 'suffix) t))))) (defun transient--goto-button (command) (cond ((stringp command) (when (re-search-forward (concat "^" (regexp-quote command)) nil t) (goto-char (match-beginning 0)))) (command (cl-flet ((found () (eq (button-get (button-at (point)) 'command) command))) (while (and (ignore-errors (forward-button 1)) (not (found)))) (unless (found) (goto-char (point-min)) (ignore-errors (forward-button 1)) (unless (found) (goto-char (point-min)))))))) (defun transient--heading-at-point () (and (eq (get-text-property (point) 'face) 'transient-heading) (let ((beg (line-beginning-position))) (buffer-substring-no-properties beg (next-single-property-change beg 'face nil (line-end-position)))))) ;;; Compatibility ;;;; Menu Isearch (defvar-keymap transient--isearch-mode-map :parent isearch-mode-map " " #'transient-isearch-exit " " #'transient-isearch-cancel " " #'transient-isearch-abort) (defun transient-isearch-backward (&optional regexp-p) "Do incremental search backward. With a prefix argument, do an incremental regular expression search instead." (interactive "P") (transient--isearch-setup) (let ((isearch-mode-map transient--isearch-mode-map)) (isearch-mode nil regexp-p))) (defun transient-isearch-forward (&optional regexp-p) "Do incremental search forward. With a prefix argument, do an incremental regular expression search instead." (interactive "P") (transient--isearch-setup) (let ((isearch-mode-map transient--isearch-mode-map)) (isearch-mode t regexp-p))) (defun transient-isearch-exit () "Like `isearch-exit' but adapted for `transient'." (interactive) (isearch-exit) (transient--isearch-exit)) (defun transient-isearch-cancel () "Like `isearch-cancel' but adapted for `transient'." (interactive) (condition-case nil (isearch-cancel) (quit)) (transient--isearch-exit)) (defun transient-isearch-abort () "Like `isearch-abort' but adapted for `transient'." (interactive) (let ((around (lambda (fn) (condition-case nil (funcall fn) (quit)) (transient--isearch-exit)))) (advice-add 'isearch-cancel :around around) (unwind-protect (isearch-abort) (advice-remove 'isearch-cancel around)))) (defun transient--isearch-setup () (select-window transient--window) (transient--suspend-override t)) (defun transient--isearch-exit () (select-window transient--original-window) (transient--resume-override)) ;;;; Edebug (defun transient--edebug-command-p () (and (bound-and-true-p edebug-active) (or (memq this-command '(top-level abort-recursive-edit)) (string-prefix-p "edebug" (symbol-name this-command))))) ;;;; Miscellaneous (cl-pushnew (list nil (concat "^\\s-*(" (eval-when-compile (regexp-opt '("transient-define-prefix" "transient-define-suffix" "transient-define-infix" "transient-define-argument") t)) "\\s-+\\(" lisp-mode-symbol-regexp "\\)") 2) lisp-imenu-generic-expression :test #'equal) (defun transient--suspend-text-conversion-style () (static-if (boundp 'overriding-text-conversion-style) ; since Emasc 30.1 (when text-conversion-style (letrec ((suspended overriding-text-conversion-style) (fn (lambda () (setq overriding-text-conversion-style nil) (remove-hook 'transient-exit-hook fn)))) (setq overriding-text-conversion-style suspended) (add-hook 'transient-exit-hook fn))))) (declare-function which-key-mode "ext:which-key" (&optional arg)) (defun transient--suspend-which-key-mode () (when (bound-and-true-p which-key-mode) (which-key-mode -1) (add-hook 'transient-exit-hook #'transient--resume-which-key-mode))) (defun transient--resume-which-key-mode () (unless transient--prefix (which-key-mode 1) (remove-hook 'transient-exit-hook #'transient--resume-which-key-mode))) (defun transient-bind-q-to-quit () "Modify some keymaps to bind \\`q' to the appropriate quit command. \\`C-g' is the default binding for such commands now, but Transient's predecessor Magit-Popup used \\`q' instead. If you would like to get that binding back, then call this function in your init file like so: (with-eval-after-load \\='transient (transient-bind-q-to-quit)) Individual transients may already bind \\`q' to something else and such a binding would shadow the quit binding. If that is the case then \\`Q' is bound to whatever \\`q' would have been bound to by setting `transient-substitute-key-function' to a function that does that. Of course \\`Q' may already be bound to something else, so that function binds \\`M-q' to that command instead. Of course \\`M-q' may already be bound to something else, but we stop there." (keymap-set transient-base-map "q" #'transient-quit-one) (keymap-set transient-sticky-map "q" #'transient-quit-seq) (setq transient-substitute-key-function #'transient-rebind-quit-commands)) (defun transient-rebind-quit-commands (obj) "See `transient-bind-q-to-quit'." (let ((key (oref obj key))) (cond ((string-equal key "q") "Q") ((string-equal key "Q") "M-q") (key)))) (defun transient--force-fixed-pitch () (require 'face-remap) (face-remap-reset-base 'default) (face-remap-add-relative 'default 'fixed-pitch)) (defun transient--func-arity (fn) (func-arity (advice--cd*r (if (symbolp fn) (symbol-function fn) fn)))) (defun transient--seq-reductions-from (function sequence initial-value) (let ((acc (list initial-value))) (seq-doseq (elt sequence) (push (funcall function (car acc) elt) acc)) (nreverse acc))) (defun transient--mapn (function &rest lists) "Apply FUNCTION to elements of LISTS. Like `cl-mapcar' but while that stops when the shortest list is exhausted, continue until the longest list is, using nil as stand-in for elements of exhausted lists." (let (result) (while (catch 'more (mapc (lambda (l) (and l (throw 'more t))) lists) nil) (push (apply function (mapcar #'car-safe lists)) result) (setq lists (mapcar #'cdr lists))) (nreverse result))) ;;; Font-Lock (defconst transient-font-lock-keywords (eval-when-compile `((,(concat "(" (regexp-opt (list "transient-define-prefix" "transient-define-infix" "transient-define-argument" "transient-define-suffix") t) "\\_>[ \t'(]*" "\\(\\(?:\\sw\\|\\s_\\)+\\)?") (1 'font-lock-keyword-face) (2 'font-lock-function-name-face nil t))))) (font-lock-add-keywords 'emacs-lisp-mode transient-font-lock-keywords) ;;; Auxiliary Classes ;;;; `transient-lisp-variable' (defclass transient-lisp-variable (transient-variable) ((reader :initform #'transient-lisp-variable--reader) (always-read :initform t) (set-value :initarg :set-value :initform #'set)) "[Experimental] Class used for Lisp variables.") (cl-defmethod transient-init-value ((obj transient-lisp-variable)) (oset obj value (symbol-value (oref obj variable)))) (cl-defmethod transient-infix-set ((obj transient-lisp-variable) value) (funcall (oref obj set-value) (oref obj variable) (oset obj value value))) (cl-defmethod transient-format-description ((obj transient-lisp-variable)) (or (cl-call-next-method obj) (symbol-name (oref obj variable)))) (cl-defmethod transient-format-value ((obj transient-lisp-variable)) (propertize (prin1-to-string (oref obj value)) 'face 'transient-value)) (cl-defmethod transient-prompt ((obj transient-lisp-variable)) (if (and (slot-boundp obj 'prompt) (oref obj prompt)) (cl-call-next-method obj) (format "Set %s: " (oref obj variable)))) (defun transient-lisp-variable--reader (prompt initial-input _history) (read--expression prompt initial-input)) ;;; _ (provide 'transient) ;; Local Variables: ;; indent-tabs-mode: nil ;; checkdoc-symbol-words: ("command-line" "edit-mode" "help-mode") ;; End: ;;; transient.el ends here