pax_global_header00006660000000000000000000000064150576037600014523gustar00rootroot0000000000000052 comment=cb3a69c039cf3b4ab007a72f802fc5f4699e8120 marginalia-2.3/000077500000000000000000000000001505760376000134735ustar00rootroot00000000000000marginalia-2.3/.elpaignore000066400000000000000000000000331505760376000156150ustar00rootroot00000000000000LICENSE .elpaignore .githubmarginalia-2.3/.github/000077500000000000000000000000001505760376000150335ustar00rootroot00000000000000marginalia-2.3/.github/FUNDING.yml000066400000000000000000000000321505760376000166430ustar00rootroot00000000000000github: [minad, oantolin] marginalia-2.3/.github/ISSUE_TEMPLATE/000077500000000000000000000000001505760376000172165ustar00rootroot00000000000000marginalia-2.3/.github/ISSUE_TEMPLATE/bug_report.md000066400000000000000000000015261505760376000217140ustar00rootroot00000000000000--- title: name: 🐞 Bug report about: Report a bug. Do not use this for questions, support or feature requests. --- Thank you for reporting a bug. Please use the latest stable release of Emacs 30.1 and start with `emacs -Q` or `package-isolate` in order to only load a minimal set of packages. This way your Emacs configuration is not loaded. Make sure that you install the newest versions of the involved packages. Please also reinstall and recompile the involved packages, ideally remove all and reinstall all packages, to exclude compilation issues due to outdated dependencies. Please provide precise information, stack traces and the exact steps to reproduce the issue. This is important to ensure that your problem can be reproduced on a different machine. If you are not really sure if your issue is a bug, please open a discussion instead. marginalia-2.3/.github/ISSUE_TEMPLATE/config.yml000066400000000000000000000026661505760376000212200ustar00rootroot00000000000000blank_issues_enabled: false contact_links: - name: "🙏 Please support @minad" url: https://github.com/sponsors/oantolin about: See https://github.com/sponsors/minad for sponsoring information. - name: "🙏 Please support @oantolin" url: https://github.com/sponsors/oantolin about: See https://github.com/sponsors/oantolin for sponsoring information. - name: "💡 Suggest a feature ➞ Please create a discussion" url: https://github.com/minad/marginalia/discussions/categories/ideas about: Start a new discussion suggesting an improvement or a feature. - name: "🧑‍🤝‍🧑 Ask the community for support" url: https://www.reddit.com/r/emacs about: Please be kind and support others. - name: "🤓 Ask the maintainer for support ➞ Please create a discussion" url: https://github.com/minad/marginalia/discussions/categories/q-a about: Please keep in mind that our bandwidth is limited. - name: "🔍 Search through old issues or discussions" url: https://github.com/search?q=repo%3Aminad%2Fmarginalia&type=issues about: The same question may have been asked before. # - name: "📝 Marginalia wiki" # url: https://github.com/minad/marginalia/wiki # about: Additional configuration tips are covered there. Feel free to edit! - name: "📖 Marginalia manual" url: https://github.com/minad/marginalia/blob/main/README.org about: The manual covers the basic setup and workflow. marginalia-2.3/.gitignore000066400000000000000000000001021505760376000154540ustar00rootroot00000000000000*-autoloads.el *-pkg.el *.elc *.info *.texi *~ \#*\# /README-elpa marginalia-2.3/CHANGELOG.org000066400000000000000000000052761505760376000155050ustar00rootroot00000000000000#+title: marginalia.el - Changelog #+author: Omar Antolín Camarena, Daniel Mendler #+language: en * Version 2.3 (2025-09-08) - Support new ~project-buffer~ category. - Improve remote file detection to avoid calling Tramp. * Version 2.2 (2025-07-28) - Support ~uniquify-get-unique-names~ used by ~project-switch-to-buffer~ in Emacs 31. * Version 2.1 (2025-06-04) - Rename =marginalia-annotator-registry= to =marginalia-annotators= for consistency with =marginalia-classifiers=. - Add context menu in minibuffer. Enable =context-menu-mode= to try. * Version 2.0 (2025-03-17) - =marginalia--variable-value=: Add tool tip for integers with hexadecimal, octal and character representation. * Version 1.8 (2024-12-22) - Require Emacs 28.1. - Add G symbol class for customization groups. * Version 1.7 (2024-07-26) - Bump Compat dependency to Compat 30. - Advise both ~completion-metadata-get~ and ~(compat-function completion-metadata-get)~ in order to provide completion categories and annotation functions. * Version 1.6 (2024-04-04) - ~marginalia-annotate-buffer~: Handle dead buffers, which can occur when annotating the candidates of ~consult-buffer~, which maintains the actual buffer objects during completion. * Version 1.5 (2023-12-27) - ~marginalia-annotate-bookmark~: Show location and more context. - ~marginalia-annotate-tab~: Show tab index starting from one. * Version 1.4 (2023-12-01) - =marginalia-annotate-theme=: New annotator based on =marginalia-annotate-library=. - =marginalia-remote-file-regexps=: New customization variable set to a list of regexps matching remote paths, which should be excluded from file annotations. * Version 1.3 (2023-07-02) - =marginalia-classify-by-prompt=: Use case-insensitive matching. - =marginalia-annotate-symbol=: Additional symbol classes. Use =M= for module functions, =P= for primitives and =S= for special forms. - =marginalia-annotate-symbol=: Add =symbol-file= column. - =marginalia-cycle=: Add =completion-predicate= to display command only in recursive minibuffers. * Version 1.2 (2023-04-17) - =marginalia-classify-by-command-name=: Resolve function aliases and use the name of the original command to determine the completion category. * Version 1.1 (2023-02-17) - Require the =compat= library. - Fix =marginalia-classify-by-prompt= such that it handles multiple brackets in the prompt gracefully. - Add =help-echo= properties to truncated annotations. The full string is shown on mouse hover. - Add =help-echo= to the symbol classes of =marginalia-annotate-symbol=. - Add =help-echo= to file sizes showing the exact size in bytes. - Add =help-echo= to file dates showing the exact date. * Version 1.0 (2022-12-22) - Start of changelog. marginalia-2.3/LICENSE000066400000000000000000001045151505760376000145060ustar00rootroot00000000000000 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 . marginalia-2.3/README.org000066400000000000000000000240571505760376000151510ustar00rootroot00000000000000#+title: marginalia.el - Marginalia in the minibuffer #+author: Omar Antolín Camarena, Daniel Mendler #+language: en #+export_file_name: marginalia.texi #+texinfo_dir_category: Emacs misc features #+texinfo_dir_title: Marginalia: (marginalia). #+texinfo_dir_desc: Marginalia in the minibuffer #+html: GNU Emacs #+html: GNU ELPA #+html: GNU-devel ELPA #+html: MELPA #+html: MELPA Stable #+html: This package provides =marginalia-mode= which adds marginalia to the minibuffer completions. [[https://en.wikipedia.org/wiki/Marginalia][Marginalia]] are marks or annotations placed at the margin of the page of a book or in this case helpful colorful annotations placed at the margin of the minibuffer for your completion candidates. Marginalia can only add annotations to the completion candidates. It cannot modify the appearance of the candidates themselves, which are shown unaltered as supplied by the original command. The annotations are added based on the completion category. For example =find-file= reports the =file= category and =M-x= reports the =command= category. You can cycle between more or less detailed annotators or even disable the annotator with command =marginalia-cycle=. #+html: #+toc: headlines 8 * Configuration It is recommended to use Marginalia together with either the [[https://github.com/minad/vertico][Vertico]], [[https://github.com/protesilaos/mct][Mct]], [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Icomplete.html][Icomplete]] or the default completion UI. Furthermore Marginalia can be combined with [[https://github.com/oantolin/embark][Embark]] for action support and [[https://github.com/minad/consult][Consult]], which provides many useful commands. #+begin_src emacs-lisp ;; Enable rich annotations using the Marginalia package (use-package marginalia ;; Bind `marginalia-cycle' locally in the minibuffer. To make the binding ;; available in the *Completions* buffer, add it to the ;; `completion-list-mode-map'. :bind (:map minibuffer-local-map ("M-A" . marginalia-cycle)) ;; The :init section is always executed. :init ;; Marginalia must be activated in the :init section of use-package such that ;; the mode gets enabled right away. Note that this forces loading the ;; package. (marginalia-mode)) #+end_src * Information shown by the annotators In general, to learn more about what different annotations mean, a good starting point is to look at ~marginalia-annotators~, and follow up to the annotation function of the category you are interested in. For example the annotations for Elisp symbols include their symbol class - =v= for variable, =f= for function, =c= for command, etc. For more information on what the different classifications mean, see the docstring of ~marginalia--symbol-class~. * Adding custom annotators or classifiers *IMPORTANT NOTICE FOR PACKAGE AUTHORS*: The intention of the Marginalia package is to give the user means to overwrite completion categories and to add custom annotators for existing commands in their user configuration. *Marginalia is a user facing package and is not intended to be used as a library*. Therefore Marginalia does not expose library functions as part of its public API. If you add your own completion commands to your package we recommend to specify an =annotation-function= or an =affixation-function=, avoiding the Marginalia dependency this way. The =annotation-function= and =affixation-function= are documented in the [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion.html][Elisp manual]]. If you use =consult--read=, you can specify an =:annotate= keyword argument. There is an exception to our recommendation: If you want to implement annotations for an existing package =hypothetic.el=, which does not have annotations and where annotations cannot be added, then the creation of a =marginalia-hypothetic.el= package is a good idea, since Marginalia provides the facilities to enhance existing commands from the outside. Commands that support minibuffer completion use a completion table of all the available candidates. Candidates are associated with a *category* such as =command=, =file=, =face=, or =variable= depending on what the candidates are. Based on the category of the candidates, Marginalia selects an *annotator* to generate annotations for display for each candidate. Unfortunately, not all commands (including Emacs' builtin ones) specify the category of their candidates. To compensate for this shortcoming, Marginalia hooks into the Emacs completion framework and runs the *classifiers* listed in the variable =marginalia-classifiers=, which use the command's prompt or other properties of the candidates to specify the completion category. For example, the =marginalia-classify-by-prompt= classifier checks the minibuffer prompt against regexps listed in the =marginalia-prompt-categories= alist to determine a category. The following is already included but would be a way to assign the category =face= to all candidates from commands with prompts that include the word "face". #+begin_src emacs-lisp (add-to-list 'marginalia-prompt-categories '("\\" . face)) #+end_src The =marginalia-classify-by-command-name= classifier uses the alist =marginalia-command-categories= to specify the completion category based on the command name. This is particularly useful if the prompt classifier yields a false positive. Completion categories are also important for [[https://github.com/oantolin/embark][Embark]], which associates actions based on the completion category and benefits from Marginalia's classifiers. Once the category of the candidates is known, Marginalia looks in the =marginalia-annotators= to find the associated annotator to use. An annotator is a function that takes a completion candidate string as an argument and returns an annotation string to be displayed after the candidate in the minibuffer. More than one annotator can be assigned to each each category, displaying more, less or different information. Use the =marginalia-cycle= command to cycle between the annotations of different annotators defined for the current category. Here's an example of a basic face annotator: #+begin_src emacs-lisp (defun my-face-annotator (cand) (when-let (sym (intern-soft cand)) (concat (propertize " " 'display '(space :align-to center)) (propertize "The quick brown fox jumps over the lazy dog" 'face sym)))) #+end_src After defining a new annotator, associate it with a category in the annotator registry as follows: #+begin_src emacs-lisp (add-to-list 'marginalia-annotators '(face my-face-annotator marginalia-annotate-face builtin none)) #+end_src This makes the =my-face-annotator= the first of four annotators for the face category. The others are the annotator provided by Marginalia (=marginalia-annotate-face=), the =builtin= annotator as defined by Emacs and the =none= annotator, which disables the annotations. With this setting, after invoking =M-x describe-face RET= you can cycle between all of these annotators using =marginalia-cycle=. * Disabling annotators, builtin or lightweight annotators Marginalia activates rich annotators by default. Depending on your preference you may want to use the builtin annotators or even no annotators by default and only activate the annotators on demand by invoking ~marginalia-cycle~. In order to disable an annotator permanently, the ~marginalia-annotators~ can be modified. For example if you prefer to never see file annotations, you can delete all file annotators from the registry. #+begin_src emacs-lisp (setq marginalia-annotators (assq-delete-all 'file marginalia-annotators)) #+end_src To use the builtin annotators by default, you can run the following code. Replace =builtin= by =none= to disable annotators by default. #+begin_src emacs-lisp (mapc (lambda (x) (setcdr x (cons 'builtin (remq 'builtin (cdr x))))) marginalia-annotators) #+end_src As an alternative to ~marginalia-cycle~, if a completion category supports two annotators, you can toggle between them using the following command. #+begin_src emacs-lisp (defun marginalia-toggle () (interactive) (mapc (lambda (x) (setcdr x (append (reverse (remq 'none (remq 'builtin (cdr x)))) '(builtin none)))) marginalia-annotators)) #+end_src After cycling the annotators you may want to automatically save the configuration. This can be achieved using an advice which calls ~customize-save-variable~. #+begin_src emacs-lisp (advice-add #'marginalia-cycle :after (lambda () (let ((inhibit-message t)) (customize-save-variable 'marginalia-annotators marginalia-annotators)))) #+end_src * Icons in the minibuffer Marginalia focuses on text annotations. The [[https://github.com/rainstormstudio/nerd-icons-completion][nerd-icons-completion]] package is compatible with Marginalia and uses the special NerdFonts to add icons in front of minibuffer completion candidates. There exist related packages to enhance Dired, Ibuffer, Corfu and other modes with icons consistently. * Contributions Since this package is part of [[https://elpa.gnu.org/packages/marginalia.html][GNU ELPA]] contributions require a copyright assignment to the FSF. marginalia-2.3/marginalia.el000066400000000000000000001666301505760376000161350ustar00rootroot00000000000000;;; marginalia.el --- Enrich existing commands with completion annotations -*- lexical-binding: t -*- ;; Copyright (C) 2021-2025 Free Software Foundation, Inc. ;; Author: Omar Antolín Camarena , Daniel Mendler ;; Maintainer: Omar Antolín Camarena , Daniel Mendler ;; Created: 2020 ;; Version: 2.3 ;; Package-Requires: ((emacs "28.1") (compat "30")) ;; URL: https://github.com/minad/marginalia ;; Keywords: docs, help, matching, completion ;; This file is part of GNU Emacs. ;; 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 . ;;; Commentary: ;; Enrich existing commands with completion annotations ;;; Code: (require 'compat) (eval-when-compile (require 'subr-x) (require 'cl-lib)) ;;;; Customization (defgroup marginalia nil "Enrich existing commands with completion annotations." :link '(info-link :tag "Info Manual" "(marginalia)") :link '(url-link :tag "Website" "https://github.com/minad/marginalia") :link '(emacs-library-link :tag "Library Source" "marginalia.el") :group 'help :group 'docs :group 'minibuffer :prefix "marginalia-") (defcustom marginalia-field-width 80 "Maximum truncation width of annotation fields. This value is adjusted depending on the `window-width'." :type 'natnum) (defcustom marginalia-separator " " "Annotation field separator." :type 'string) (defcustom marginalia-align 'left "Alignment of the annotations." :type '(choice (const :tag "Left" left) (const :tag "Center" center) (const :tag "Right" right))) (defcustom marginalia-align-offset 0 "Additional offset added to the alignment." :type 'natnum) (defcustom marginalia-max-relative-age (* 60 60 24 14) "Maximum relative age in seconds displayed by the file annotator. Set to `most-positive-fixnum' to always use a relative age, or 0 to never show a relative age." :type 'natnum) (defcustom marginalia-remote-file-regexps '("\\`/\\([^/|:]+\\):") ;; Tramp path "List of remote file regexps where the files should not be annotated. The first match group is displayed instead of the detailed file attribute information. For Tramp paths, the protocol is displayed instead." :type '(repeat regexp)) (define-obsolete-variable-alias 'marginalia-annotator-registry 'marginalia-annotators "2.0") (defcustom marginalia-annotators (mapcar (lambda (x) (append x (list 'builtin 'none))) `((command ,#'marginalia-annotate-command ,#'marginalia-annotate-binding) (embark-keybinding ,#'marginalia-annotate-embark-keybinding) (customize-group ,#'marginalia-annotate-customize-group) (variable ,#'marginalia-annotate-variable) (function ,#'marginalia-annotate-function) (face ,#'marginalia-annotate-face) (color ,#'marginalia-annotate-color) (unicode-name ,#'marginalia-annotate-char) (minor-mode ,#'marginalia-annotate-minor-mode) (symbol ,#'marginalia-annotate-symbol) (environment-variable ,#'marginalia-annotate-environment-variable) (input-method ,#'marginalia-annotate-input-method) (coding-system ,#'marginalia-annotate-coding-system) (charset ,#'marginalia-annotate-charset) (package ,#'marginalia-annotate-package) (imenu ,#'marginalia-annotate-imenu) (bookmark ,#'marginalia-annotate-bookmark) (file ,#'marginalia-annotate-file) (project-file ,#'marginalia-annotate-project-file) (project-buffer ,#'marginalia-annotate-buffer) (buffer ,#'marginalia-annotate-buffer) (library ,#'marginalia-annotate-library) (theme ,#'marginalia-annotate-theme) (tab ,#'marginalia-annotate-tab) (multi-category ,#'marginalia-annotate-multi-category))) "Annotator function registry. Associates completion categories with annotation functions. Each annotation function must return a string, which is appended to the completion candidate." :type '(alist :key-type symbol :value-type (repeat symbol))) (defcustom marginalia-classifiers (list #'marginalia-classify-by-command-name #'marginalia-classify-original-category #'marginalia-classify-by-prompt #'marginalia-classify-symbol) "List of functions to determine current completion category. Each function should take no arguments and return a symbol indicating the category, or nil to indicate it could not determine it." :type 'hook) (defcustom marginalia-prompt-categories '(("\\" . customize-group) ("\\" . command) ("\\" . package) ("\\" . bookmark) ("\\" . color) ("\\" . face) ("\\" . environment-variable) ("\\" . function) ("\\" . variable) ("\\" . input-method) ("\\" . charset) ("\\" . coding-system) ("\\" . minor-mode) ("\\" . kill-ring) ("\\" . tab) ("\\" . library) ("\\" . theme)) "Associates regexps to match against minibuffer prompts with categories. The prompts are matched case-insensitively." :type '(alist :key-type regexp :value-type symbol)) (defcustom marginalia-censor-variables '("pass\\|auth-source-netrc-cache\\|auth-source-.*-nonce\\|api-?key") "The value of variables matching any of these regular expressions is not shown. This configuration variable is useful to hide variables which may hold sensitive data, e.g., passwords. The variable names are matched case-sensitively." :type '(repeat (choice symbol regexp))) (defcustom marginalia-command-categories `((,#'imenu . imenu) (,'recentf-open . file) ;; Available only on Emacs 29. (,#'where-is . command)) "Associate commands with a completion category. The value of `this-command' is used as key for the lookup." :type '(alist :key-type symbol :value-type symbol)) (defgroup marginalia-faces nil "Faces used by `marginalia-mode'." :group 'marginalia :group 'faces) (defface marginalia-key '((t :inherit font-lock-keyword-face)) "Face used to highlight keys.") (defface marginalia-type '((t :inherit marginalia-key)) "Face used to highlight types.") (defface marginalia-char '((t :inherit marginalia-key)) "Face used to highlight character annotations.") (defface marginalia-lighter '((t :inherit marginalia-size)) "Face used to highlight minor mode lighters.") (defface marginalia-on '((t :inherit success)) "Face used to signal enabled modes.") (defface marginalia-off '((t :inherit error)) "Face used to signal disabled modes.") (defface marginalia-documentation '((t :inherit completions-annotations)) "Face used to highlight documentation strings.") (defface marginalia-value '((t :inherit marginalia-key)) "Face used to highlight general variable values.") (defface marginalia-null '((t :inherit font-lock-comment-face)) "Face used to highlight null or unbound variable values.") (defface marginalia-true '((t :inherit font-lock-builtin-face)) "Face used to highlight true variable values.") (defface marginalia-function '((t :inherit font-lock-function-name-face)) "Face used to highlight function symbols.") (defface marginalia-symbol '((t :inherit font-lock-type-face)) "Face used to highlight general symbols.") (defface marginalia-list '((t :inherit font-lock-constant-face)) "Face used to highlight list expressions.") (defface marginalia-mode '((t :inherit marginalia-key)) "Face used to highlight buffer major modes.") (defface marginalia-date '((t :inherit marginalia-key)) "Face used to highlight dates.") (defface marginalia-version '((t :inherit marginalia-number)) "Face used to highlight package versions.") (defface marginalia-archive '((t :inherit warning)) "Face used to highlight package archives.") (defface marginalia-installed '((t :inherit success)) "Face used to highlight the status of packages.") (defface marginalia-size '((t :inherit marginalia-number)) "Face used to highlight sizes.") (defface marginalia-number '((t :inherit font-lock-constant-face)) "Face used to highlight numeric values.") (defface marginalia-string '((t :inherit font-lock-string-face)) "Face used to highlight string values.") (defface marginalia-modified '((t :inherit font-lock-negation-char-face)) "Face used to highlight buffer modification indicators.") (defface marginalia-file-name '((t :inherit marginalia-documentation)) "Face used to highlight file names.") (defface marginalia-file-owner '((t :inherit font-lock-preprocessor-face)) "Face used to highlight file owner and group names.") (defface marginalia-file-priv-no '((t :inherit shadow)) "Face used to highlight the no file privilege attribute.") (defface marginalia-file-priv-dir '((t :inherit font-lock-keyword-face)) "Face used to highlight the dir file privilege attribute.") (defface marginalia-file-priv-link '((t :inherit font-lock-keyword-face)) "Face used to highlight the link file privilege attribute.") (defface marginalia-file-priv-read '((t :inherit font-lock-type-face)) "Face used to highlight the read file privilege attribute.") (defface marginalia-file-priv-write '((t :inherit font-lock-builtin-face)) "Face used to highlight the write file privilege attribute.") (defface marginalia-file-priv-exec '((t :inherit font-lock-function-name-face)) "Face used to highlight the exec file privilege attribute.") (defface marginalia-file-priv-other '((t :inherit font-lock-constant-face)) "Face used to highlight some other file privilege attribute.") (defface marginalia-file-priv-rare '((t :inherit font-lock-variable-name-face)) "Face used to highlight a rare file privilege attribute.") ;;;; Pre-declarations for external packages (declare-function bookmark-prop-get "bookmark") (declare-function project-current "project") (declare-function project-root "project") (defvar package--builtins) (defvar package-archive-contents) (declare-function package--from-builtin "package") (declare-function package-desc-archive "package") (declare-function package-desc-status "package") (declare-function package-desc-summary "package") (declare-function package-desc-version "package") (declare-function package-version-join "package") (declare-function color-rgb-to-hex "color") (declare-function color-rgb-to-hsl "color") (declare-function color-hsl-to-rgb "color") ;;;; Marginalia mode (defalias 'marginalia--orig-completion-metadata-get (symbol-function (if (fboundp 'marginalia--orig-completion-metadata-get) 'marginalia--orig-completion-metadata-get (compat-function completion-metadata-get))) "Original `completion-metadata-get' function.") (defvar marginalia--pangram "Cwm fjord bank glyphs vext quiz.") (defvar marginalia--bookmark-type-transforms (let ((words (regexp-opt '("handle" "handler" "jump" "bookmark")))) `((,(format "-+%s-+" words) . "-") (,(format "\\`%s-+" words) . "") (,(format "-%s\\'" words) . "") ("\\`default\\'" . "File") (".*" . ,#'capitalize))) "List of bookmark type transformers. Relying on this mechanism is discouraged in favor of the `bookmark-handler-type' property. The function names are matched case-sensitively.") (defvar marginalia--cand-width-step 10 "Round candidate width.") (defvar-local marginalia--cand-width-max 20 "Maximum width of candidates.") (defvar marginalia--fontified-file-modes nil "List of fontified file modes.") (defvar-local marginalia--cache nil "The cache, pair of list and hashtable.") (defvar marginalia--cache-size 100 "Size of the cache, set to 0 to disable the cache. Disabling the cache is useful on non-incremental UIs like default completion or for performance profiling of the annotators.") (defvar-local marginalia--command nil "Last command symbol saved in order to allow annotations.") (defvar-local marginalia--base-position 0 "Last completion base position saved to get full file paths.") (defvar marginalia--metadata nil "Completion metadata from the current completion.") (defvar marginalia--ellipsis nil) (defun marginalia--ellipsis () "Return ellipsis." (with-memoization marginalia--ellipsis (cond ((bound-and-true-p truncate-string-ellipsis)) ((char-displayable-p ?…) "…") ("...")))) (defun marginalia--truncate (str width) "Truncate string STR to WIDTH." (when (floatp width) (setq width (round (* width marginalia-field-width)))) (when-let (pos (string-search "\n" str)) (setq str (substring str 0 pos))) (let* ((face (and (not (equal str "")) (get-text-property (1- (length str)) 'face str))) (ell (if face (propertize (marginalia--ellipsis) 'face face) (marginalia--ellipsis))) (trunc (if (< width 0) (nreverse (truncate-string-to-width (reverse str) (- width) 0 ?\s ell)) (truncate-string-to-width str width 0 ?\s ell)))) (unless (string-prefix-p str trunc) (put-text-property 0 (length trunc) 'help-echo str trunc)) trunc)) (cl-defmacro marginalia--field (field &key truncate face width format) "Format FIELD as a string according to some options. TRUNCATE is the truncation width. WIDTH is the field width. FORMAT is a format string. FACE is the name of the face, with which the field should be propertized." (setq field (if format `(format ,format ,field) `(or ,field ""))) (when width (setq field `(format ,(format "%%%ds" (- width)) ,field))) (when truncate (setq field `(marginalia--truncate ,field ,truncate))) (when face (setq field (if (or format width truncate) (cl-with-gensyms (f) `(let ((,f ,field)) (put-text-property 0 (length ,f) 'face ,face ,f) ,f)) `(propertize ,field 'face ,face)))) field) (defmacro marginalia--fields (&rest fields) "Format annotation FIELDS as a string with separators in between." (let ((left t)) (cons 'concat (mapcan (lambda (field) (if (not (eq (car field) :left)) `(,@(when left (setq left nil) `(#(" " 0 1 (marginalia--align t)))) marginalia-separator (marginalia--field ,@field)) (unless left (error "Left fields must come first")) `((marginalia--field ,@(cdr field))))) fields)))) (defmacro marginalia--in-minibuffer (&rest body) "Run BODY inside minibuffer if minibuffer is active. Otherwise stay within current buffer." (declare (indent 0)) `(with-current-buffer (if-let (win (active-minibuffer-window)) (window-buffer win) (current-buffer)) ,@body)) (defun marginalia--documentation (str) "Format documentation string STR." (when str (marginalia--fields (str :truncate 1.0 :face 'marginalia-documentation)))) (defun marginalia-annotate-binding (cand) "Annotate command CAND with keybinding." (when-let ((sym (intern-soft cand)) (key (and (commandp sym) (where-is-internal sym nil 'first-only)))) (format #(" (%s)" 1 5 (face marginalia-key)) (key-description key)))) (defun marginalia--annotator (cat) "Return annotation function for category CAT." (pcase (car (alist-get cat marginalia-annotators)) ('none #'ignore) ('builtin nil) (fun fun))) (defun marginalia-annotate-multi-category (cand) "Annotate multi-category CAND, dispatching to the appropriate annotator." (if-let ((multi (get-text-property 0 'multi-category cand)) (annotate (marginalia--annotator (car multi)))) ;; Use the Marginalia annotator corresponding to the multi category. (funcall annotate (cdr multi)) ;; Apply the original annotation function on the original candidate. Bypass ;; our `marginalia--completion-metadata-get' advice. (when-let (annotate (marginalia--orig-completion-metadata-get marginalia--metadata 'annotation-function)) (funcall annotate cand)))) (defconst marginalia--advice-regexp (rx bos (1+ (seq (? "This function has ") (or ":before" ":after" ":around" ":override" ":before-while" ":before-until" ":after-while" ":after-until" ":filter-args" ":filter-return") " advice: " (0+ nonl) "\n")) "\n") "Regexp to match lines about advice in function documentation strings.") ;; Taken from advice--make-docstring, is this robust? (defun marginalia--advised (fun) "Return t if function FUN is advised." (let ((flist (indirect-function fun))) (advice--p (if (eq 'macro (car-safe flist)) (cdr flist) flist)))) (defun marginalia--symbol-class (s) "Return symbol class characters for symbol S. This function is an extension of `help--symbol-class'. It returns more fine-grained and more detailed symbol information. Function: f function c command C interactive-only command m macro F special-form M module function P primitive g cl-generic p pure s side-effect-free @ autoloaded ! advised - obsolete & alias Variable: u custom (U modified compared to global value) v variable l local (L modified compared to default value) - obsolete & alias Other: G custom group a face t cl-type" (let ((class (append (when (fboundp s) (list (cond ((get s 'pure) '("p" . "pure")) ((get s 'side-effect-free) '("s" . "side-effect-free"))) (cond ((commandp s) (if (get s 'interactive-only) '("C" . "interactive-only command") '("c" . "command"))) ((cl-generic-p s) '("g" . "cl-generic")) ((macrop (symbol-function s)) '("m" . "macro")) ((special-form-p (symbol-function s)) '("F" . "special-form")) ((subr-primitive-p (symbol-function s)) '("P" . "primitive")) ((module-function-p (symbol-function s)) '("M" . "module function")) (t '("f" . "function"))) (and (autoloadp (symbol-function s)) '("@" . "autoload")) (and (marginalia--advised s) '("!" . "advised")) (and (symbolp (symbol-function s)) (cons "&" (format "alias for `%s'" (symbol-function s)))) (and (get s 'byte-obsolete-info) '("-" . "obsolete")))) (when (boundp s) (list (when (local-variable-if-set-p s) (if (ignore-errors (not (equal (symbol-value s) (default-value s)))) '("L" . "local, modified from global") '("l" . "local, unmodified"))) (if (get s 'standard-value) (if (ignore-errors (not (equal (symbol-value s) (eval (car (get s 'standard-value)))))) '("U" . "custom, modified from standard") '("u" . "custom, unmodified")) '("v" . "variable")) (and (not (eq (ignore-errors (indirect-variable s)) s)) (cons "&" (format "alias for `%s'" (ignore-errors (indirect-variable s))))) (and (get s 'byte-obsolete-variable) '("-" . "obsolete")))) (list (and (get s 'group-documentation) '("G" . "custom group")) (and (facep s) '("a" . "face")) (and (get s 'cl--class) '("t" . "cl-type")))))) ;; cl-find-class, cl--find-class (setq class (delq nil class)) (propertize (format " %-6s" (mapconcat #'car class "")) 'help-echo (mapconcat (pcase-lambda (`(,x . ,y)) (concat x " " y)) class "\n")))) (defun marginalia--function-doc (sym) "Documentation string of function SYM." (when-let (str (ignore-errors (documentation sym))) (save-match-data (if (string-match marginalia--advice-regexp str) (substring str (match-end 0)) str)))) ;; Derived from elisp-get-fnsym-args-string (defun marginalia--function-args (sym) "Return function arguments for SYM." (let (tmp) (elisp-function-argstring (cond ((listp (setq tmp (gethash (indirect-function sym) advertised-signature-table t))) tmp) ((setq tmp (help-split-fundoc (ignore-errors (documentation sym t)) sym)) (car tmp)) ((setq tmp (help-function-arglist sym)) (if (and (stringp tmp) (string-search "not available" tmp)) ;; A shorter text fits better into the limited Marginalia space. "[autoload]" tmp)))))) (defun marginalia-annotate-symbol (cand) "Annotate symbol CAND with its documentation string." (when-let (sym (intern-soft cand)) (marginalia--fields (:left (marginalia-annotate-binding cand)) ((marginalia--symbol-class sym) :face 'marginalia-type) ((if (fboundp sym) (marginalia--function-doc sym) (cl-loop for doc in '(variable-documentation face-documentation group-documentation) thereis (ignore-errors (documentation-property sym doc)))) :truncate 1.0 :face 'marginalia-documentation) ((abbreviate-file-name (or (symbol-file sym) "")) :truncate -0.5 :face 'marginalia-file-name)))) (defun marginalia-annotate-command (cand) "Annotate command CAND with its documentation string. Similar to `marginalia-annotate-symbol', but does not show symbol class." (when-let (sym (intern-soft cand)) (concat (marginalia-annotate-binding cand) (marginalia--documentation (marginalia--function-doc sym))))) (defun marginalia-annotate-embark-keybinding (cand) "Annotate Embark keybinding CAND with its documentation string. Similar to `marginalia-annotate-command', but does not show the keybinding since CAND includes it." (when-let (cmd (get-text-property 0 'embark-command cand)) (marginalia--documentation (marginalia--function-doc cmd)))) (defun marginalia-annotate-imenu (cand) "Annotate imenu CAND with its documentation string." (when (derived-mode-p 'emacs-lisp-mode) ;; Strip until the last whitespace in order to support flat imenu (marginalia-annotate-symbol (replace-regexp-in-string "\\`.* " "" cand)))) (defun marginalia-annotate-function (cand) "Annotate function CAND with its documentation string." (when-let (sym (intern-soft cand)) (when (fboundp sym) (marginalia--fields (:left (marginalia-annotate-binding cand)) ((marginalia--symbol-class sym) :face 'marginalia-type) ((marginalia--function-args sym) :face 'marginalia-value :truncate 0.5) ((marginalia--function-doc sym) :truncate 1.0 :face 'marginalia-documentation))))) (defun marginalia--variable-value (sym) "Return the variable value of SYM as string." (cond ((not (boundp sym)) (propertize "#" 'face 'marginalia-null)) ((and marginalia-censor-variables (let ((name (symbol-name sym)) case-fold-search) (cl-loop for r in marginalia-censor-variables thereis (if (symbolp r) (eq r sym) (string-match-p r name))))) (propertize "*****" 'face 'marginalia-null 'help-echo "Hidden due to `marginalia-censor-variables'")) (t (let ((val (symbol-value sym))) (pcase val ('nil (propertize "nil" 'face 'marginalia-null)) ('t (propertize "t" 'face 'marginalia-true)) ((pred keymapp) (propertize "#" 'face 'marginalia-value)) ((pred bool-vector-p) (propertize "#" 'face 'marginalia-value)) ((pred hash-table-p) (propertize "#" 'face 'marginalia-value)) ((pred syntax-table-p) (propertize "#" 'face 'marginalia-value)) ;; Emacs bug#53988: abbrev-table-p throws an error ((guard (static-if (< emacs-major-version 30) (and (vectorp val) (ignore-errors (abbrev-table-p val))) (abbrev-table-p val))) (propertize "#" 'face 'marginalia-value)) ((pred char-table-p) (propertize "#" 'face 'marginalia-value)) ;; Emacs 29 comes with callable objects or object closures (OClosures) ((guard (and (fboundp 'oclosure-type) (oclosure-type val))) (format (propertize "#" 'face 'marginalia-function) (and (fboundp 'oclosure-type) (oclosure-type val)))) ((pred byte-code-function-p) (propertize "#" 'face 'marginalia-function)) ((and (pred functionp) (pred symbolp)) ;; We are not consistent here, values are generally printed ;; unquoted. But we make an exception for function symbols to visually ;; distinguish them from symbols. I am not entirely happy with this, ;; but we should not add quotation to every type. (format (propertize "#'%s" 'face 'marginalia-function) val)) ((pred recordp) (format (propertize "#" 'face 'marginalia-value) (type-of val))) ((pred symbolp) (propertize (symbol-name val) 'face 'marginalia-symbol)) ((pred numberp) (propertize (number-to-string val) 'face 'marginalia-number 'help-echo (and (integerp val) (format "%d, #o%o, #x%x%s" val val val (if (characterp val) (format ", ?%c" val) ""))))) (_ (let ((print-escape-newlines t) (print-escape-control-characters t) ;;(print-escape-multibyte t) (print-level 3) (print-length marginalia-field-width)) (propertize (replace-regexp-in-string ;; `print-escape-control-characters' does not escape Unicode control characters. "[\x0-\x1F\x7f-\x9f\x061c\x200e\x200f\x202a-\x202e\x2066-\x2069]" (lambda (x) (format "\\x%x" (string-to-char x))) (prin1-to-string (if (stringp val) ;; Get rid of string properties to save some of the precious space (substring-no-properties val 0 (min (length val) marginalia-field-width)) val)) 'fixedcase 'literal) 'face (cond ((listp val) 'marginalia-list) ((stringp val) 'marginalia-string) (t 'marginalia-value)))))))))) (defun marginalia-annotate-variable (cand) "Annotate variable CAND with its documentation string." (when-let (sym (intern-soft cand)) (marginalia--fields ((marginalia--symbol-class sym) :face 'marginalia-type) ((marginalia--variable-value sym) :truncate 0.5) ((documentation-property sym 'variable-documentation) :truncate 1.0 :face 'marginalia-documentation)))) (defun marginalia-annotate-environment-variable (cand) "Annotate environment variable CAND with its current value." (when-let (val (getenv cand)) (marginalia--fields (val :truncate 1.0 :face 'marginalia-value)))) (defun marginalia-annotate-face (cand) "Annotate face CAND with its documentation string and face example." (when-let (sym (intern-soft cand)) (marginalia--fields ;; HACK: Manual alignment to fix misalignment due to face ((concat marginalia--pangram #(" " 0 1 (display (space :align-to center)))) :face sym) ((documentation-property sym 'face-documentation) :truncate 1.0 :face 'marginalia-documentation)))) (defun marginalia-annotate-color (cand) "Annotate face CAND with its documentation string and face example." (when-let (rgb (color-name-to-rgb cand)) (pcase-let* ((`(,r ,g ,b) rgb) (`(,h ,s ,l) (apply #'color-rgb-to-hsl rgb)) (cr (color-rgb-to-hex r 0 0)) (cg (color-rgb-to-hex 0 g 0)) (cb (color-rgb-to-hex 0 0 b)) (ch (apply #'color-rgb-to-hex (color-hsl-to-rgb h 1 0.5))) (cs (apply #'color-rgb-to-hex (color-hsl-to-rgb h s 0.5))) (cl (apply #'color-rgb-to-hex (color-hsl-to-rgb 0 0 l)))) (marginalia--fields (" " :face `(:background ,(apply #'color-rgb-to-hex rgb))) ((format "%s%s%s %s" (propertize "r" 'face `(:background ,cr :foreground ,(readable-foreground-color cr))) (propertize "g" 'face `(:background ,cg :foreground ,(readable-foreground-color cg))) (propertize "b" 'face `(:background ,cb :foreground ,(readable-foreground-color cb))) (color-rgb-to-hex r g b 2))) ((format "%s%s%s %3s° %3s%% %3s%%" (propertize "h" 'face `(:background ,ch :foreground ,(readable-foreground-color ch))) (propertize "s" 'face `(:background ,cs :foreground ,(readable-foreground-color cs))) (propertize "l" 'face `(:background ,cl :foreground ,(readable-foreground-color cl))) (round (* 360 h)) (round (* 100 s)) (round (* 100 l)))))))) (defun marginalia-annotate-char (cand) "Annotate character CAND with its general character category and character code." (when-let (char (char-from-name cand t)) (marginalia--fields (:left char :format" (%c)" :face 'marginalia-char) (char :format "%06X" :face 'marginalia-number) ((char-code-property-description 'general-category (get-char-code-property char 'general-category)) :width 30 :face 'marginalia-documentation)))) (defun marginalia-annotate-minor-mode (cand) "Annotate minor-mode CAND with status and documentation string." (let* ((sym (intern-soft cand)) (message-log-max nil) (mode (if (and sym (boundp sym)) sym (lookup-minor-mode-from-indicator cand))) (lighter (cdr (assq mode minor-mode-alist))) (lighter-str (and lighter (string-trim (format-mode-line (cons t lighter)))))) (marginalia--fields ((if (and (boundp mode) (symbol-value mode)) (propertize "On" 'face 'marginalia-on) (propertize "Off" 'face 'marginalia-off)) :width 3) ((if (local-variable-if-set-p mode) "Local" "Global") :width 6 :face 'marginalia-type) (lighter-str :width 20 :face 'marginalia-lighter) ((marginalia--function-doc mode) :truncate 1.0 :face 'marginalia-documentation)))) (defun marginalia-annotate-package (cand) "Annotate package CAND with its description summary." (when-let ((pkg-alist (bound-and-true-p package-alist)) (name (replace-regexp-in-string "-[0-9\\.-]+\\'" "" cand)) (pkg (intern-soft name)) (desc (or (unless (equal name cand) (cl-loop with version = (substring cand (1+ (length name))) for d in (alist-get pkg pkg-alist) if (equal (package-version-join (package-desc-version d)) version) return d)) ;; taken from `describe-package-1' (car (alist-get pkg pkg-alist)) (if-let (built-in (assq pkg package--builtins)) (package--from-builtin built-in) (car (alist-get pkg package-archive-contents)))))) (marginalia--fields ((package-version-join (package-desc-version desc)) :truncate 16 :face 'marginalia-version) ((cond ((package-desc-archive desc) (propertize (package-desc-archive desc) 'face 'marginalia-archive)) (t (propertize (or (package-desc-status desc) "orphan") 'face 'marginalia-installed))) :truncate 12) ((package-desc-summary desc) :truncate 1.0 :face 'marginalia-documentation)))) (defun marginalia--bookmark-type (bm) "Return bookmark type string of BM. The string is transformed according to `marginalia--bookmark-type-transforms'." (let ((handler (or (bookmark-prop-get bm 'handler) 'bookmark-default-handler))) (and ;; Some libraries use lambda handlers instead of symbols. For ;; example the function `xwidget-webkit-bookmark-make-record' is ;; affected. I consider this bad style since then the lambda is ;; persisted. (symbolp handler) (or (get handler 'bookmark-handler-type) (let ((str (symbol-name handler)) case-fold-search) (dolist (transformer marginalia--bookmark-type-transforms str) (when (string-match-p (car transformer) str) (setq str (if (stringp (cdr transformer)) (replace-regexp-in-string (car transformer) (cdr transformer) str) (funcall (cdr transformer) str)))))))))) (defun marginalia-annotate-bookmark (cand) "Annotate bookmark CAND with its file name and front context string." (when-let ((bm (assoc cand (bound-and-true-p bookmark-alist)))) (marginalia--fields ((marginalia--bookmark-type bm) :width 10 :face 'marginalia-type) ((or (bookmark-prop-get bm 'filename) (bookmark-prop-get bm 'location)) :truncate (if (bookmark-prop-get bm 'filename) -0.5 0.5) :face 'marginalia-file-name) ((let ((front (or (bookmark-prop-get bm 'front-context-string) "")) (rear (or (bookmark-prop-get bm 'rear-context-string) ""))) (unless (and (string-blank-p front) (string-blank-p rear)) (string-clean-whitespace (concat front (marginalia--ellipsis) rear)))) :truncate 0.5 :face 'marginalia-documentation)))) (defun marginalia-annotate-customize-group (cand) "Annotate customization group CAND with its documentation string." (marginalia--documentation (documentation-property (intern cand) 'group-documentation))) (defun marginalia-annotate-input-method (cand) "Annotate input method CAND with its description." (marginalia--documentation (nth 4 (assoc cand input-method-alist)))) (defun marginalia-annotate-charset (cand) "Annotate charset CAND with its description." (marginalia--documentation (charset-description (intern cand)))) (defun marginalia-annotate-coding-system (cand) "Annotate coding system CAND with its description." (marginalia--documentation (coding-system-doc-string (intern cand)))) (defun marginalia--buffer-status (buffer) "Return the status of BUFFER as a string." (format-mode-line '((:propertize "%1*%1+%1@" face marginalia-modified) marginalia-separator (7 (:propertize "%I" face marginalia-size)) marginalia-separator ;; InactiveMinibuffer has 18 letters, but there are longer names. ;; For example Org-Agenda produces very long mode names. ;; Therefore we have to truncate. (20 (-20 (:propertize mode-name face marginalia-mode)))) nil nil buffer)) (defun marginalia--buffer-file (buffer) "Return the file or process name of BUFFER." (if-let (proc (get-buffer-process buffer)) (format "(%s %s) %s" proc (process-status proc) (abbreviate-file-name (buffer-local-value 'default-directory buffer))) (abbreviate-file-name (or (cond ;; see ibuffer-buffer-file-name ((buffer-file-name buffer)) ((when-let (dir (and (local-variable-p 'dired-directory buffer) (buffer-local-value 'dired-directory buffer))) (expand-file-name (if (stringp dir) dir (car dir)) (buffer-local-value 'default-directory buffer)))) ((local-variable-p 'list-buffers-directory buffer) (buffer-local-value 'list-buffers-directory buffer))) "")))) (defun marginalia-annotate-buffer (cand) "Annotate buffer CAND with modification status, file name and major mode." ;; Emacs 31: `project--read-project-buffer' uses `uniquify-get-unique-names' (when-let ((buffer (or (and (stringp cand) (get-text-property 0 'uniquify-orig-buffer cand)) (get-buffer cand)))) (if (buffer-live-p buffer) (marginalia--fields ((marginalia--buffer-status buffer)) ((marginalia--buffer-file buffer) :truncate -0.5 :face 'marginalia-file-name)) (marginalia--fields ("(dead buffer)" :face 'error))))) (defun marginalia--full-candidate (cand) "Return completion candidate CAND in full. For some completion tables, the completion candidates offered are meant to be only a part of the full minibuffer contents. For example, during file name completion the candidates are one path component of a full file path." (if-let (win (active-minibuffer-window)) (with-current-buffer (window-buffer win) (concat (let ((end (minibuffer-prompt-end))) (buffer-substring-no-properties end (+ end marginalia--base-position))) cand)) ;; no minibuffer is active, trust that cand already conveys all ;; necessary information (there's not much else we can do) cand)) (defun marginalia--remote-file-p (file) "Return non-nil if FILE is remote. The return value is a string describing the remote location, e.g., the protocol." (save-match-data (setq file (let (file-name-handler-alist) (substitute-in-file-name file))) (cl-loop for r in marginalia-remote-file-regexps if (string-match r file) return (or (match-string 1 file) "remote")))) (defun marginalia--annotate-local-file (cand) "Annotate local file CAND." (marginalia--in-minibuffer (when-let (attrs (ignore-errors ;; may throw permission denied errors (file-attributes (substitute-in-file-name (marginalia--full-candidate cand)) 'integer))) ;; HACK: Format differently accordingly to alignment, since the file owner ;; is usually not displayed. Otherwise we will see an excessive amount of ;; whitespace in front of the file permissions. Furthermore the alignment ;; in `consult-buffer' will look ugly. Find a better solution! (if (eq marginalia-align 'right) (marginalia--fields ;; File owner at the left ((marginalia--file-owner attrs) :face 'marginalia-file-owner) ((marginalia--file-modes attrs)) ((marginalia--file-size attrs) :face 'marginalia-size :width -7) ((marginalia--time (file-attribute-modification-time attrs)) :face 'marginalia-date :width -12)) (marginalia--fields ((marginalia--file-modes attrs)) ((marginalia--file-size attrs) :face 'marginalia-size :width -7) ((marginalia--time (file-attribute-modification-time attrs)) :face 'marginalia-date :width -12) ;; File owner at the right ((marginalia--file-owner attrs) :face 'marginalia-file-owner)))))) (defun marginalia-annotate-file (cand) "Annotate file CAND with its size, modification time and other attributes. These annotations are skipped for remote paths." (if-let (remote (or (marginalia--remote-file-p cand) (when-let (win (active-minibuffer-window)) (with-current-buffer (window-buffer win) (marginalia--remote-file-p (minibuffer-contents-no-properties)))))) (marginalia--fields (remote :format "*%s*" :face 'marginalia-documentation)) (marginalia--annotate-local-file cand))) (defun marginalia--file-owner (attrs) "Return file owner given ATTRS." (let ((uid (file-attribute-user-id attrs)) (gid (file-attribute-group-id attrs))) (when (or (/= (user-uid) uid) (/= (group-gid) gid)) (format "%s:%s" (or (user-login-name uid) uid) (or (group-name gid) gid))))) (defun marginalia--file-size (attrs) "Return formatted file size given ATTRS." (propertize (file-size-human-readable (file-attribute-size attrs)) 'help-echo (number-to-string (file-attribute-size attrs)))) (defun marginalia--file-modes (attrs) "Return fontified file modes given the ATTRS." ;; Without caching this can a be significant portion of the time ;; `marginalia-annotate-file' takes to execute. Caching improves performance ;; by about a factor of 20. (setq attrs (file-attribute-modes attrs)) (or (car (member attrs marginalia--fontified-file-modes)) (progn (setq attrs (substring attrs)) ;; copy because attrs is about to be modified (dotimes (i (length attrs)) (put-text-property i (1+ i) 'face (pcase (aref attrs i) (?- 'marginalia-file-priv-no) (?d 'marginalia-file-priv-dir) (?l 'marginalia-file-priv-link) (?r 'marginalia-file-priv-read) (?w 'marginalia-file-priv-write) (?x 'marginalia-file-priv-exec) ((or ?s ?S ?t ?T) 'marginalia-file-priv-other) (_ 'marginalia-file-priv-rare)) attrs)) (push attrs marginalia--fontified-file-modes) attrs))) (defconst marginalia--time-relative `((100 "sec" 1) (,(* 60 100) "min" 60.0) (,(* 3600 30) "hour" 3600.0) (,(* 3600 24 400) "day" ,(* 3600.0 24.0)) (nil "year" ,(* 365.25 24 3600))) "Formatting used by the function `marginalia--time-relative'.") ;; Taken from `seconds-to-string'. (defun marginalia--time-relative (time) "Format TIME as a relative age." (setq time (max 0 (float-time (time-since time)))) (let ((sts marginalia--time-relative) here) (while (and (car (setq here (pop sts))) (<= (car here) time))) (setq time (round time (caddr here))) (format "%s %s%s ago" time (cadr here) (if (= time 1) "" "s")))) (defun marginalia--time-absolute (time) "Format TIME as an absolute age." (let ((system-time-locale "C")) (format-time-string (if (> (decoded-time-year (decode-time (current-time))) (decoded-time-year (decode-time time))) " %Y %b %d" "%b %d %H:%M") time))) (defun marginalia--time (time) "Format file age TIME, suitably for use in annotations." (propertize (if (< (float-time (time-since time)) marginalia-max-relative-age) (marginalia--time-relative time) (marginalia--time-absolute time)) 'help-echo (format-time-string "%Y-%m-%d %T" time))) (defvar-local marginalia--project-root 'unset) (defun marginalia--project-root () "Return project root." (marginalia--in-minibuffer (when (eq marginalia--project-root 'unset) (setq marginalia--project-root (or (let ((prompt (minibuffer-prompt)) case-fold-search) (and (string-match "\\`\\(?:Dired\\|Find file\\) in \\(.*\\): \\'" prompt) (match-string 1 prompt))) (when-let (proj (project-current)) (project-root proj))))) marginalia--project-root)) (defun marginalia-annotate-project-file (cand) "Annotate file CAND with its size, modification time and other attributes." ;; Absolute project directories also report project-file category (if (file-name-absolute-p cand) (marginalia-annotate-file cand) (when-let (root (marginalia--project-root)) (marginalia-annotate-file (expand-file-name cand root))))) (defvar-local marginalia--library-cache nil) (defun marginalia--library-cache () "Return hash table from library name to library file." (marginalia--in-minibuffer ;; `locate-file' and `locate-library' are bottlenecks for the ;; annotator. Therefore we compute all the library paths first. (unless marginalia--library-cache (setq marginalia--library-cache (make-hash-table :test #'equal)) (dolist (dir (delete-dups (reverse ;; Reverse because of shadowing (append load-path (custom-theme--load-path))))) ;; Include themes (dolist (file (ignore-errors (directory-files dir 'full "\\.el\\(?:\\.gz\\)?\\'"))) (puthash (marginalia--library-name file) file marginalia--library-cache)))) marginalia--library-cache)) (defun marginalia--library-name (file) "Get name of library FILE." (replace-regexp-in-string "\\(\\.gz\\|\\.elc?\\)+\\'" "" (file-name-nondirectory file))) (defun marginalia--library-doc (file) "Return library documentation string for FILE." (let ((doc (get-text-property 0 'marginalia--library-doc file))) (unless doc ;; Extract documentation string. We cannot use `lm-summary' here, ;; since it decompresses the whole file, which is slower. (setq doc (or (ignore-errors (let ((shell-file-name "sh") (shell-command-switch "-c")) (shell-command-to-string (format (if (string-suffix-p ".gz" file) "gzip -c -q -d %s | head -n1" "head -n1 %s") (shell-quote-argument file))))) "")) (cond ((string-match "\\`(define-package\\s-+\"\\([^\"]+\\)\"" doc) (setq doc (format "Generated package description from %s.el" (match-string 1 doc)))) ((string-match "\\`;+\\s-*" doc) (setq doc (substring doc (match-end 0))) (when (string-match "\\`[^ \t]+\\s-+-+\\s-+" doc) (setq doc (substring doc (match-end 0)))) (when (string-match "\\s-*-\\*-" doc) (setq doc (substring doc 0 (match-beginning 0))))) (t (setq doc ""))) ;; Add the documentation string to the cache (put-text-property 0 1 'marginalia--library-doc doc file)) doc)) (defun marginalia-annotate-theme (cand) "Annotate theme CAND with documentation and path." (marginalia-annotate-library (concat cand "-theme"))) (defun marginalia-annotate-library (cand) "Annotate library CAND with documentation and path." (setq cand (marginalia--library-name cand)) (when-let (file (gethash cand (marginalia--library-cache))) (marginalia--fields ;; Display if the corresponding feature is loaded. ;; feature/=library file, but better than nothing. ((when-let (sym (intern-soft cand)) (when (memq sym features) (propertize "Loaded" 'face 'marginalia-on))) :width 8) ((marginalia--library-doc file) :truncate 1.0 :face 'marginalia-documentation) ((abbreviate-file-name (file-name-directory file)) :truncate -0.5 :face 'marginalia-file-name)))) (defun marginalia-annotate-tab (cand) "Annotate named tab CAND with tab index, window and buffer information." (when-let ((tabs (funcall tab-bar-tabs-function)) (index (seq-position tabs nil (lambda (tab _) (equal (alist-get 'name tab) cand))))) (let* ((tab (nth index tabs)) (ws (alist-get 'ws tab)) (bufs (window-state-buffers ws))) ;; When the buffer key is present in the window state it is added in front ;; of the window buffer list and gets duplicated. (when (cadr (assq 'buffer ws)) (pop bufs)) (marginalia--fields (:left (1+ index) :format " (%s)" :face 'marginalia-key) ((if (eq (car tab) 'current-tab) (length (window-list nil 'no-minibuf)) (length bufs)) :format "win:%s" :face 'marginalia-size) ((or (alist-get 'group tab) 'none) :format "group:%s" :face 'marginalia-type :truncate 20) ((if (eq (car tab) 'current-tab) "(current tab)" (string-join bufs " ")) :face 'marginalia-documentation))))) (defun marginalia-classify-by-command-name () "Lookup category for current command." (and marginalia--command (or (alist-get marginalia--command marginalia-command-categories) ;; The command can be an alias, e.g., `recentf' -> `recentf-open'. (when-let ((chain (function-alias-p marginalia--command))) (alist-get (car (last chain)) marginalia-command-categories))))) (defun marginalia-classify-original-category () "Return original category reported by completion metadata." ;; Bypass our `marginalia--completion-metadata-get' advice. (when-let (cat (marginalia--orig-completion-metadata-get marginalia--metadata 'category)) ;; Ignore `symbol-help' category in order to ensure that the categories are ;; refined to our categories function and variable. (and (not (eq cat 'symbol-help)) cat))) (defun marginalia-classify-symbol () "Determine if currently completing symbols." (when-let (mct minibuffer-completion-table) (when (or (eq mct 'help--symbol-completion-table) (obarrayp mct) (and (not (functionp mct)) (consp mct) (symbolp (car mct)))) ; assume list of symbols 'symbol))) (defun marginalia-classify-by-prompt () "Determine category by matching regexps against the minibuffer prompt. This runs through the `marginalia-prompt-categories' alist looking for a regexp that matches the prompt." (when-let (prompt (minibuffer-prompt)) (setq prompt (replace-regexp-in-string "(.*?default.*?)\\|\\[.*?\\]" "" prompt)) (cl-loop with case-fold-search = t for (regexp . category) in marginalia-prompt-categories when (string-match-p regexp prompt) return category))) (defun marginalia--cache-reset (&rest _) "Reset the cache." (setq marginalia--cache (and marginalia--cache (> marginalia--cache-size 0) (cons nil (make-hash-table :test #'equal :size marginalia--cache-size))))) (defun marginalia--cached (cache fun key) "Cached application of function FUN with KEY. The CACHE keeps around the last `marginalia--cache-size' computed annotations. The cache is mainly useful when scrolling in completion UIs like Vertico or Icomplete." (if cache (let ((ht (cdr cache))) (or (gethash key ht) (let ((val (funcall fun key))) (push key (car cache)) (puthash key val ht) (when (>= (hash-table-count ht) marginalia--cache-size) (let ((end (last (car cache) 2))) (remhash (cadr end) ht) (setcdr end nil))) val))) (funcall fun key))) (defun marginalia--align (cands) "Align annotations of CANDS according to `marginalia-align'." (cl-loop for (cand . ann) in cands do (when-let (align (text-property-any 0 (length ann) 'marginalia--align t ann)) (setq marginalia--cand-width-max (max marginalia--cand-width-max (* (ceiling (+ (string-width cand) (string-width ann 0 align)) marginalia--cand-width-step) marginalia--cand-width-step))))) (cl-loop for (cand . ann) in cands collect (progn (when-let (align (text-property-any 0 (length ann) 'marginalia--align t ann)) (put-text-property align (1+ align) 'display `(space :align-to ,(pcase-exhaustive marginalia-align ('center `(+ center ,marginalia-align-offset)) ('left `(+ left ,(+ marginalia-align-offset marginalia--cand-width-max))) ('right `(+ right ,(+ marginalia-align-offset 1 (- (string-width ann 0 align) (string-width ann))))))) ann)) (list cand "" ann)))) (defun marginalia--affixate (metadata annotator cands) "Affixate CANDS given METADATA and Marginalia ANNOTATOR." ;; Compute minimum width of windows, which display the minibuffer, including ;; the miniwindow. In general the computed width corresponds to the full ;; frame width, since the miniwindow spans the full frame. For example ;; `vertico-buffer' displays the minibuffer in a separate window. Similarly, ;; we could detect other types of completion buffers, e.g., Embark Collect or ;; the default completion buffer, and compute smaller widths. (let* ((width (cl-loop for win in (get-buffer-window-list) minimize (window-width win))) (marginalia-field-width (min (/ width 2) marginalia-field-width)) (marginalia--metadata metadata) (cache marginalia--cache)) (marginalia--align ;; Run the annotators in the original window. `with-selected-window' ;; is necessary because of `lookup-minor-mode-from-indicator'. ;; Otherwise it would suffice to only change the current buffer. We ;; need the `selected-window' fallback for Embark Occur. (with-selected-window (or (minibuffer-selected-window) (selected-window)) (cl-loop for cand in cands collect (let ((ann (or (marginalia--cached cache annotator cand) ""))) (cons cand (if (string-blank-p ann) "" ann)))))))) (defun marginalia--completion-metadata-get (metadata prop) "Meant as :before-until advice for `completion-metadata-get'. METADATA is the metadata. PROP is the property which is looked up." (pcase prop ('annotation-function ;; We do want the advice triggered for `completion-metadata-get'. (when-let ((cat (completion-metadata-get metadata 'category)) (annotator (marginalia--annotator cat))) (lambda (cand) (let ((ann (caddar (marginalia--affixate metadata annotator (list cand))))) (and (not (equal ann "")) ann))))) ('affixation-function ;; We do want the advice triggered for `completion-metadata-get'. (when-let ((cat (completion-metadata-get metadata 'category)) (annotator (marginalia--annotator cat))) (apply-partially #'marginalia--affixate metadata annotator))) ('category ;; Find the completion category by trying each of our classifiers. ;; Store the metadata for `marginalia-classify-original-category'. (let ((marginalia--metadata metadata)) (run-hook-with-args-until-success 'marginalia-classifiers))))) (defun marginalia--minibuffer-setup () "Setup the minibuffer for Marginalia. Remember `this-command' for `marginalia-classify-by-command-name'." (setq marginalia--cache t marginalia--command this-command) ;; Reset cache if window size changes, recompute alignment (add-hook 'window-state-change-hook #'marginalia--cache-reset nil 'local) (add-hook 'context-menu-functions #'marginalia--context-menu nil t) (marginalia--cache-reset)) (defun marginalia--base-position (completions) "Record the base position of COMPLETIONS." ;; As a small optimization we track the base position only for file ;; completions, since `marginalia--full-candidate' is currently used only by ;; the file annotation function. ;; bug#75910: category instead of `minibuffer-completing-file-name' (when minibuffer-completing-file-name (let ((base (or (cdr (last completions)) 0))) (unless (= marginalia--base-position base) (marginalia--cache-reset) (setq marginalia--base-position base marginalia--cand-width-max (default-value 'marginalia--cand-width-max))))) completions) ;;;###autoload (define-minor-mode marginalia-mode "Annotate completion candidates with richer information." :global t :group 'marginalia (if marginalia-mode (progn ;; Remember `this-command' in order to select the annotation function. (add-hook 'minibuffer-setup-hook #'marginalia--minibuffer-setup) ;; Replace the metadata function. (advice-add (compat-function completion-metadata-get) :before-until #'marginalia--completion-metadata-get) (advice-add #'completion-metadata-get :before-until #'marginalia--completion-metadata-get) ;; Record completion base position, for `marginalia--full-candidate' (advice-add #'completion-all-completions :filter-return #'marginalia--base-position)) (advice-remove #'completion-all-completions #'marginalia--base-position) (advice-remove (compat-function completion-metadata-get) #'marginalia--completion-metadata-get) (advice-remove #'completion-metadata-get #'marginalia--completion-metadata-get) (remove-hook 'minibuffer-setup-hook #'marginalia--minibuffer-setup))) (defun marginalia--completion-metadata () "Get completion metadata." (let* ((end (minibuffer-prompt-end)) (pt (max 0 (- (point) end)))) (completion-metadata (buffer-substring-no-properties end (+ end pt)) minibuffer-completion-table minibuffer-completion-predicate))) (defun marginalia--builtin-annotator-p (md) "Builtin annotator available in metadata MD?" (or (marginalia--orig-completion-metadata-get md 'annotation-function) (marginalia--orig-completion-metadata-get md 'affixation-function))) ;;;###autoload (defun marginalia-cycle () "Cycle between annotators in `marginalia-annotators'." ;; Only show `marginalia-cycle' in M-x in recursive minibuffers (declare (completion (lambda (&rest _) (> (minibuffer-depth) 1)))) (interactive) (with-current-buffer (window-buffer (or (active-minibuffer-window) (user-error "Marginalia: No active minibuffer"))) (let* ((md (marginalia--completion-metadata)) (cat (or (completion-metadata-get md 'category) (user-error "Marginalia: Unknown completion category"))) (ann (or (assq cat marginalia-annotators) (user-error "Marginalia: No annotators found for category `%s'" cat)))) (setcdr ann (append (cddr ann) (list (cadr ann)))) ;; When the builtin annotator is selected and no builtin function is ;; available, skip to the next annotator. Bypass the ;; `marginalia--completion-metadata-get' advice. (when (and (eq (cadr ann) 'builtin) (not (marginalia--builtin-annotator-p md))) (setcdr ann (append (cddr ann) (list (cadr ann))))) (marginalia--cache-reset) (message "Marginalia: Use annotator `%s' for category `%s'" (cadr ann) cat)))) (defun marginalia--context-menu (menu _event) "Add Marginalia commands to context MENU." (when-let ((md (marginalia--completion-metadata)) (cat (completion-metadata-get md 'category)) (ann (assq cat marginalia-annotators)) (items (cl-loop for fun in (cdr ann) for i from 0 if (or (not (eq fun 'builtin)) (marginalia--builtin-annotator-p md)) collect (vector (thread-last (symbol-name fun) (replace-regexp-in-string ".*?-+annotate-+" "") (replace-regexp-in-string "-+" " ") capitalize) (let ((i i)) (lambda () (interactive) (setcdr ann (append (drop i (cdr ann)) (take i (cdr ann)))) (marginalia--cache-reset) (message "Marginalia: Use annotator `%s' for category `%s'" (cadr ann) cat))) :style 'radio :selected (eq fun (cadr ann)))))) (define-key menu [marginalia] `("Marginalia" . ,(easy-menu-create-menu "" `(["Cycle" marginalia-cycle] "---" ,@items))))) menu) (provide 'marginalia) ;;; marginalia.el ends here