├── .gitignore ├── LICENSE ├── README.org ├── images └── describe-variable.png └── live-completions.el /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | *-autoloads.el 3 | *-pkg.el 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * Overview 2 | :PROPERTIES: 3 | :TOC: :include all :ignore this 4 | :END: 5 | 6 | This packages provides a minibuffer completion UI. It pops up the 7 | traditional =*Completions*= buffer and keeps it updated as you type in 8 | the minibuffer. Besides the traditional multicolumn view of the 9 | completions, this package offers a single column view ---in case the 10 | changing number of columns of the traditional view proves too 11 | dizzying. 12 | 13 | :CONTENTS: 14 | - [[#why-write-a-new-completion-ui][Why write a new completion UI?]] 15 | - [[#screenshot][Screenshot]] 16 | - [[#sort-orders-for-candidates][Sort orders for candidates]] 17 | - [[#setting-a-maximum-height-for-the-completions-buffer][Setting a maximum height for the completions buffer]] 18 | - [[#defining-your-own-commands-with-live-completion][Defining your own commands with live completion]] 19 | :END: 20 | 21 | * Why write a new completion UI? 22 | 23 | There are many excellent minibuffer completion UIs for Emacs: the 24 | built-in packages Icomplete, and Ido; and external packages such as 25 | [[https://github.com/abo-abo/swiper][Ivy]], [[https://github.com/emacs-helm/helm][Helm]] and [[https://github.com/raxod502/selectrum][Selectrum]]. What distinguishes this one? 26 | 27 | - This package puts the completions in a buffer. This is like Helm, 28 | but unlike Icomplete, Ido, Ivy and Selectrum. (While Ivy doesn't use 29 | a buffer by default, it has the =ivy-occur= command which produces a 30 | neat buffer.) Buffers are great! You can easily navigate around 31 | them, copy text from them, save their contents in a file, etc. All 32 | of that is sometimes desirable for completions and is awkward to do 33 | when the completions reside in the minibuffer. 34 | 35 | If you want to define your own actions for the candidate at point in 36 | the =*Completions*= buffer, Emacs already has a convenient 37 | =completion-list-mode-map= keymap where you can bind them. 38 | 39 | - It has both the traditional compact view of completions, in several 40 | columns, and a single column view, with an easy toggle between 41 | them. Helm, Ivy and Selectrum only present single column views; 42 | Icomplete and Ido are horizontal by default, but can be configured 43 | to give single-column vertical views (see [[https://github.com/oantolin/icomplete-vertical][icomplete-vertical]] and 44 | [[https://github.com/creichert/ido-vertical-mode.el][ido-vertical]]). 45 | 46 | I'd say those are arguably pros. Now some things which are arguably 47 | cons: 48 | 49 | - It is very modest in scope: like Icomplete it is /only/ a minibuffer 50 | completion UI, and it relies on Emacs' completion styles to supply 51 | the actual completions. In fact, it's pretty much the same as 52 | cosntantly hitting the =?= key to pop up the =*Completions*= buffer. 53 | 54 | Selectrum is almost as modest in scope: it also mostly focuses on 55 | selecting items from lists but instead of using the standard 56 | completion machinery, it has it's own API and a few extra 57 | convenience commands. Ivy and Helm of course have tons of extra 58 | functionality beyond selecting items from lists. Ido is a weird mix: 59 | it doesn't take over all completion (well, not by default, see 60 | [[https://github.com/DarwinAwardWinner/ido-completing-read-plus][ido-completing-read+]]), but offers some extra functionality where it 61 | does take over completion. 62 | 63 | - It isn't very pretty. It just looks like the =*Completions*= buffer, 64 | you've seen it before. The traditional multicolumn view sometimes 65 | even gets misaligned! This package does however highlight the 66 | completion that would be entered into the minibuffer by 67 | =minibuffer-force-complete=, so at least that's a small splash of 68 | color. 69 | 70 | * Screenshot 71 | 72 | [[./images/describe-variable.png]] 73 | 74 | (Did you spot the misalignment? :P) 75 | 76 | * Sort orders for candidates 77 | 78 | The variable =live-completions-sort-order= controls the sorting of 79 | completion candidates. You can customize this variable. It can take 80 | three values: 81 | 82 | - =display=: this is the order of the classic =*Completions*= buffer, it 83 | is the default. 84 | - =cycle=: this is the order that tab cycling in the default 85 | minibuffer tab completion uses, and is also the order Icomplete uses. 86 | - =nil=: no sorting, even if the completion source specifies a sort 87 | function. 88 | 89 | The =cycle= and =nil= options put the candidate that force completion 90 | would select at the top of the list. The classic =display= oder does 91 | not, but it should be easy to spot this candidate because is is 92 | higlighted. 93 | 94 | * Setting a maximum height for the completions buffer 95 | 96 | You can use the built-in =temp-buffer-resize-mode= to limit the height 97 | of the completions buffer. Set the variable =temp-buffer-max-height= 98 | to either an integer, the maximum height in lines, or to a function 99 | that computes the maximum height. 100 | 101 | To set a maximum height of 10 lines for all temporary buffers (not 102 | just the completions buffer): 103 | 104 | #+begin_src emacs-lisp 105 | (setq temp-buffer-max-height 10) 106 | (temp-buffer-resize-mode) 107 | #+end_src 108 | 109 | To set the maximum height only for the completions buffer and keep 110 | the default (which is half the frame height) for all other temporary 111 | buffers: 112 | 113 | #+begin_src emacs-lisp 114 | (defvar old-max-height-function temp-buffer-max-height) 115 | 116 | (defun max-completions-height (buffer) 117 | (if (string= (buffer-name buffer) "*Completions*") 118 | 10 119 | (funcall old-max-height-function temp-buffer-max-height))) 120 | 121 | (setq temp-buffer-max-height #'max-completions-height) 122 | (temp-buffer-resize-mode) 123 | #+end_src 124 | 125 | #+RESULTS: 126 | : t 127 | 128 | If you use a function rather than a number, you can also make the 129 | maximum height depend on current circumstances. For example you use 130 | =(/ (frame-height) 3)= to make the maximum height a third of the 131 | height of the frame. 132 | 133 | * Defining your own commands with live completion 134 | 135 | If you don't want to use =live-completions-mode= all the time but you 136 | want to define a few commands that provide live completion, use the 137 | =live-completions-do= macro. You can ask it to start in signle-column 138 | mode, which is useful for lists with naturally long candidates, such 139 | as filesystem paths or kill-ring entries. 140 | 141 | For example, let's implement a command to yank from the kill-ring 142 | using completion. Often the kills are multiline, so for improved 143 | usability we'll need (1) the completion to start in single column 144 | mode, (2) the number of lines used to display entries to be relatively 145 | large, and (3) the separator to be, say, a red dotted line: 146 | 147 | #+begin_src emacs-lisp 148 | (defun insert-kill-ring-item () 149 | "Insert item from kill-ring, selected with completion." 150 | (interactive) 151 | (live-completions-do 152 | (:columns 'single 153 | :separator (propertize "\n··········\n" 'face '(:foreground "red")) 154 | :height 30) 155 | (insert (completing-read "Yank: " kill-ring nil t)))) 156 | #+end_src 157 | 158 | Note that the completion merely /starts out/ in single column mode: 159 | nothing keeps you from toggling between single and multiple columns 160 | while =insert-kill-ring-item= is active. Once the command finishes 161 | running, your previous column completion configuration will be 162 | restored. 163 | 164 | All of the options, =:columns=, =:separator=, =:height= and =:sort= (not shown 165 | in the example), are optional. The =:separator= is only used in 166 | single-column mode and defaults to 167 | =live-completions-horizontal-separator=. If you don't include a =:height= 168 | the default is to follow =temp-buffer-resize-mode= if you have it active 169 | and to use =fit-window-to-buffer= otherwise (this lets the completions 170 | buffer take up most of the frame). If you omit all four parts you 171 | still need to include the empty parenthesis: =(live-completions-do () 172 | ...)=!. 173 | 174 | This package contains the =live-completions-do= macro for you to 175 | implement your own commands. It does not define any commands that use 176 | the macro. 177 | -------------------------------------------------------------------------------- /images/describe-variable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oantolin/live-completions/10290d19bfa5d03c72b1e9790e75f9699475ef38/images/describe-variable.png -------------------------------------------------------------------------------- /live-completions.el: -------------------------------------------------------------------------------- 1 | ;;; live-completions.el --- Live updating of the *Completions* buffer -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2020 Omar Antolín Camarena 4 | 5 | ;; Author: Omar Antolín Camarena 6 | ;; Keywords: convenience 7 | ;; Package-Requires: ((emacs "24.4")) 8 | ;; Version: 0.3 9 | ;; Homepage: https://github.com/oantolin/live-completions 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; This packages provides a minibuffer completion UI. It pops up the 27 | ;; traditional *Completions* buffer and keeps it updated as you type 28 | ;; in the minibuffer. Besides the traditional multicolumn view of the 29 | ;; completions, this package offers a single column view ---in case 30 | ;; the changing number of columns of the traditional view proves too 31 | ;; dizzying. 32 | 33 | ;;; Code: 34 | 35 | (eval-when-compile (require 'subr-x)) 36 | 37 | (defgroup live-completions nil 38 | "Live updating of the *Completions* buffer." 39 | :group 'completion) 40 | 41 | (defcustom live-completions-horizontal-separator "\n" 42 | "Candidate separator for live-completions in single-column mode. 43 | The separator should contain at least one newline." 44 | :type 'string 45 | :group 'live-completions) 46 | 47 | (defcustom live-completions-columns 'multiple 48 | "How many columns of candidates live-completions displays. 49 | 50 | There is also a command `live-completions-set-columns' that you 51 | might want to bind to a key in `minibuffer-local-completion-map' 52 | to toggle between single and multiple column views." 53 | :type '(choice 54 | (const :tag "Single column" single) 55 | (const :tag "Multiple columns" multiple)) 56 | :group 'live-completions) 57 | 58 | (defface live-completions-forceable-candidate 59 | '((default :weight bold) 60 | (((class color) (min-colors 88) (background dark)) :background "#010a5f") 61 | (((class color) (min-colors 88) (background light)) :background "#c4ffe0") 62 | (t :foreground "blue")) 63 | "Face for the candidate that force-completion would select." 64 | :group 'live-completions) 65 | 66 | (defcustom live-completions-sort-order 'display 67 | "Sort order for completion candidates. 68 | The valid choices are: 69 | 70 | - `display': what the completions buffer traditionally uses. 71 | This order uses the `display-sort-function' key of the 72 | completion metadata and absent that, alphabetical order. 73 | 74 | - `cycle': the order `minibuffer-force-complete' (\"tab 75 | cycling\") and icomplete use. This order uses the 76 | `cycle-sort-function' key of the completion metadata and absent 77 | that it uses an order that puts the default first, recently 78 | used items close to the top of the list, and shorter 79 | candidates before longer ones. 80 | 81 | - nil: this disables all sorting, even if the metadata specifies 82 | a `display-sort-function' or `cycle-sort-function'." 83 | :type '(choice (const :tag "Classic *Completions*" display) 84 | (const :tag "Tab cycling or Icomplete order" cycle) 85 | (const :tag "No sorting" nil)) 86 | :group 'live-completions) 87 | 88 | ;;;###autoload 89 | (defun live-completions-set-columns (columns) 90 | "Set how many COLUMNS of completion candidates are displayed. 91 | 92 | Called from Lisp code COLUMNS should be one of the symbols 93 | `single', `multiple' or `toggle'. 94 | 95 | When called interactively without prefix argument, toggle between 96 | single and multiple columns. Called with a numerical prefix of 1, 97 | set single column mode, any other prefix argument sets multiple 98 | columns." 99 | (interactive 100 | (list (pcase current-prefix-arg 101 | ('nil 'toggle) 102 | (1 'single) 103 | (_ 'multiple)))) 104 | (when (eq columns 'toggle) 105 | (setq columns 106 | (if (eq live-completions-columns 'single) 'multiple 'single))) 107 | (when (eq columns 'single) 108 | ;; enable standalone use, without live-completions-mode 109 | (advice-add 'completion--insert-strings :around 110 | #'live-completions--single-column '((depth . 1)))) 111 | (let ((changep (not (eq columns live-completions-columns)))) 112 | (setq live-completions-columns columns) 113 | (when (and changep (bound-and-true-p live-completions-mode)) 114 | (live-completions--update)))) 115 | 116 | (defun live-completions--unsorted-table () 117 | "Return completion table with no sorting." 118 | (let* ((mbc (minibuffer-contents)) 119 | (mct minibuffer-completion-table) 120 | (mcp minibuffer-completion-predicate) 121 | (metadata (cdr (completion-metadata mbc mct mcp)))) 122 | (lambda (string pred action) 123 | (if (eq action 'metadata) 124 | (append 125 | '(metadata 126 | (display-sort-function . identity) 127 | ( cycle-sort-function . identity)) 128 | metadata) 129 | (complete-with-action action mct string pred))))) 130 | 131 | (defun live-completions--cycle-order-table () 132 | "Return completion table for `cycle' sort order." 133 | (let* ((mbc (minibuffer-contents)) 134 | (mct minibuffer-completion-table) 135 | (mcp minibuffer-completion-predicate) 136 | (metadata (cdr (completion-metadata mbc mct mcp))) 137 | (first-pass 138 | (or 139 | (completion-metadata-get metadata 'cycle-sort-function) 140 | (lambda (all) 141 | (sort all (lambda (c1 c2) (< (length c1) (length c2))))))) 142 | (sorter 143 | (let ((hist (if (version< emacs-version "27") 144 | (symbol-value minibuffer-history-variable) 145 | (minibuffer-history-value)))) 146 | (lambda (all) 147 | (setq all (funcall first-pass all)) 148 | (sort all (lambda (c1 c2) 149 | (> (length (member c1 hist)) 150 | (length (member c2 hist))))))))) 151 | (lambda (string pred action) 152 | (if (eq action 'metadata) 153 | (append 154 | `(metadata 155 | (display-sort-function . ,sorter) 156 | ( cycle-sort-function . ,sorter)) 157 | metadata) 158 | (complete-with-action action mct string pred))))) 159 | 160 | (defun live-completions--sort-order-table () 161 | "Return completion table for current sort order." 162 | (pcase live-completions-sort-order 163 | ('display minibuffer-completion-table) 164 | ('cycle (live-completions--cycle-order-table)) 165 | ('nil (live-completions--unsorted-table)) 166 | (_ (user-error "Unknown live-completions-sort-order")))) 167 | 168 | (defun live-completions--update (&rest _) 169 | "Update the *Completions* buffer. 170 | Meant to be added to `after-change-functions'." 171 | (when (minibufferp) ; skip if we've exited already 172 | (let ((while-no-input-ignore-events '(selection-request))) 173 | (while-no-input 174 | (condition-case nil 175 | (save-match-data 176 | (save-excursion 177 | (goto-char (point-max)) 178 | (let ((inhibit-message t) 179 | ;; don't ring the bell in `minibuffer-completion-help' 180 | ;; when <= 1 completion exists. 181 | (ring-bell-function #'ignore) 182 | (minibuffer-completion-table 183 | (live-completions--sort-order-table))) 184 | (minibuffer-completion-help) 185 | (run-at-time 0 nil #'live-completions--highlight-forceable)))) 186 | (quit (abort-recursive-edit))))))) 187 | 188 | (defun live-completions--highlight-forceable () 189 | "Highlight the completion that `minibuffer-force-complete' would insert." 190 | (ignore-errors ;; this can fail harmlessly if the user types fast 191 | (with-current-buffer "*Completions*" 192 | (goto-char (point-min)) 193 | (let* (beg end 194 | (advance 195 | (lambda () 196 | (next-completion 1) 197 | (setq beg (point) 198 | end (next-single-property-change beg 'mouse-face)) 199 | (unless end (setq end (point-max)))))) 200 | (funcall advance) 201 | (when (eq live-completions-sort-order 'display) 202 | (let ((forced (with-current-buffer completion-reference-buffer 203 | (car (completion-all-sorted-completions))))) 204 | (while (not (or (eobp) (string= (buffer-substring beg end) forced))) 205 | (funcall advance)))) 206 | (let ((inhibit-read-only t)) 207 | (font-lock-prepend-text-property 208 | beg end 209 | 'face 'live-completions-forceable-candidate)))))) 210 | 211 | (defun live-completions--honor-inhibit-message (fn &rest args) 212 | "Skip applying FN to ARGS if inhibit-message is t. 213 | Meant as `:around' advice for `minibuffer-message', which does 214 | not honor minibuffer message." 215 | (unless inhibit-message 216 | (apply fn args))) 217 | 218 | (defun live-completions--setup () 219 | "Setup live updating for the *Completions* buffer. 220 | Meant to be added to `minibuffer-setup-hook'." 221 | (remove-hook 'minibuffer-setup-hook #'live-completions--setup) 222 | (setq-local completion-show-inline-help nil) 223 | (add-hook 'after-change-functions #'live-completions--update nil t) 224 | (run-with-idle-timer 0.01 nil #'live-completions--update)) 225 | 226 | (defun live-completions--first-completion () 227 | "When at the start of the completions buffer go to first completion." 228 | (when (bobp) (next-completion 1))) 229 | 230 | (defun live-completions--hide-help () 231 | "Make help message in *Completions* buffer invisible. 232 | Meant to be add to `completion-setup-hook'." 233 | (with-current-buffer standard-output 234 | (goto-char (point-min)) 235 | (next-completion 1) 236 | (put-text-property (point-min) (point) 'invisible t) 237 | (add-hook 'pre-command-hook #'live-completions--first-completion 5 t))) 238 | 239 | (defun live-completions--single-column (oldfun strings &rest args) 240 | "Insert completion candidate STRINGS in a single column." 241 | (if (eq live-completions-columns 'multiple) 242 | (apply oldfun strings args) 243 | (dolist (str strings) 244 | (if (not (consp str)) 245 | (put-text-property (point) (progn (insert str) (point)) 246 | 'mouse-face 'highlight) 247 | (put-text-property (point) (progn (insert (car str)) (point)) 248 | 'mouse-face 'highlight) 249 | (let ((beg (point)) 250 | (end (progn (insert (cadr str)) (point)))) 251 | (put-text-property beg end 'mouse-face nil) 252 | (font-lock-prepend-text-property beg end 'face 253 | 'completions-annotations))) 254 | (insert live-completions-horizontal-separator)) 255 | (delete-region (- (point) (length live-completions-horizontal-separator)) 256 | (point)) 257 | (insert "\n"))) 258 | 259 | (defun live-completions-read 260 | (prompt collection &optional predicate 261 | require-match initial-input hist def inherit-input-method) 262 | "Read with live updating of the completions buffer. 263 | To be used as a `completing-read-function'. For the meanings of 264 | PROMPT, COLLECTION, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, 265 | HIST, DEF, and INHERIT-INPUT-METHOD, see `completing-read'." 266 | (condition-case err 267 | (progn 268 | (add-hook 'minibuffer-setup-hook #'live-completions--setup) 269 | (completing-read-default ; not live-completions--old-crf! 270 | prompt collection predicate 271 | require-match initial-input hist def inherit-input-method)) 272 | (t (signal (car err) (cdr err))))) 273 | 274 | (defvar live-completions--old-crf nil 275 | "Store previous value of `completing-read-function'") 276 | 277 | ;;;###autoload 278 | (define-minor-mode live-completions-mode 279 | "Live updating of the *Completions* buffer." 280 | :global t 281 | (let ((advice-list 282 | '((completion--insert-strings 283 | :around live-completions--single-column) 284 | (minibuffer-message 285 | :around live-completions--honor-inhibit-message) 286 | (completion--flush-all-sorted-completions 287 | :after live-completions--update)))) 288 | (if live-completions-mode 289 | (progn 290 | (setq live-completions--old-crf completing-read-function 291 | completing-read-function #'live-completions-read) 292 | (add-hook 'completion-setup-hook #'live-completions--hide-help 1) 293 | (dolist (spec advice-list) (apply #'advice-add spec))) 294 | (when live-completions--old-crf 295 | (setq completing-read-function live-completions--old-crf 296 | live-completions--old-crf nil)) 297 | (remove-hook 'completion-setup-hook #'live-completions--hide-help) 298 | (dolist (spec advice-list) (advice-remove (car spec) (caddr spec)))))) 299 | 300 | (defmacro live-completions-do (config &rest body) 301 | "Evaluate BODY with single column live completion. 302 | The CONFIG argument should be a plist with allowed keys 303 | `:columns', `:separator', `:height' and `:sort'. 304 | 305 | The `:columns' key should map to either the symbol `single' or 306 | `multiple'. It defaults to `live-completions-columns'. 307 | 308 | The separator should be a string containing at least one 309 | newline (and can have text properties to control it's display). 310 | It defaults to `live-completions-horizontal-separator'. 311 | 312 | The height controls the maximum height of the completions buffer, 313 | it can be either an integer (number of lines) or a function, 314 | called with the completions buffer as argument, that computes the 315 | maximum height. 316 | 317 | The `:sort' key controls the sort order. It defaults to 318 | `live-completions-sort-order'; see the documentation of that 319 | variable for the possible values associated to this key." 320 | (declare (indent 1)) 321 | (let ((livep (make-symbol "livep")) 322 | (icompletep (make-symbol "icompletep")) 323 | (resizep (make-symbol "resizep")) 324 | (completions-height (make-symbol "completions-height")) 325 | (other-temp-height (make-symbol "other-temp-height")) 326 | (cfg (lambda (key var) 327 | (let ((val (plist-get config key))) 328 | (when val `((,var ,val)))))) 329 | (height (plist-get config :height))) 330 | (when height 331 | (setf config 332 | (plist-put 333 | config :height-fn ; affect only *Completions* 334 | (let ((buf (make-symbol "buf")) 335 | (ht (make-symbol "ht"))) 336 | `(lambda (,buf) 337 | (let ((,ht (if (string= (buffer-name ,buf) "*Completions*") 338 | ,completions-height 339 | ,other-temp-height))) 340 | (if (functionp ,ht) (funcall ,ht ,buf) ,ht))))))) 341 | `(let ((,livep live-completions-mode) 342 | (,icompletep (bound-and-true-p icomplete-mode)) 343 | (,resizep temp-buffer-resize-mode) 344 | ,@(when height 345 | `((,completions-height ,height) ; evaluate height only once 346 | (,other-temp-height temp-buffer-max-height)))) 347 | (unwind-protect 348 | (progn 349 | (when ,icompletep (icomplete-mode -1)) 350 | (unless ,livep (live-completions-mode)) 351 | ,@(when height `((unless ,resizep (temp-buffer-resize-mode)))) 352 | (let (,@(funcall cfg :columns 'live-completions-columns) 353 | ,@(funcall cfg :separator 354 | 'live-completions-horizontal-separator) 355 | ,@(funcall cfg :sort 'live-completions-sort-order) 356 | ,@(funcall cfg :height-fn 'temp-buffer-max-height)) 357 | ,@body)) 358 | (unless ,livep (live-completions-mode -1)) 359 | ,@(when height `((unless ,resizep (temp-buffer-resize-mode -1)))) 360 | (when ,icompletep (icomplete-mode)))))) 361 | 362 | (provide 'live-completions) 363 | ;;; live-completions.el ends here 364 | --------------------------------------------------------------------------------