├── COPYING ├── helm-sly.el └── readme.org /COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /helm-sly.el: -------------------------------------------------------------------------------- 1 | ;;; helm-sly.el --- Helm sources and some utilities for SLY. -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2019, 2020, 2021 Pierre Neidhardt 4 | ;; 5 | ;; Author: Pierre Neidhardt 6 | ;; URL: https://github.com/emacs-helm/helm-sly 7 | ;; Version: 0.7.2 8 | ;; Keywords: convenience, helm, sly, lisp 9 | ;; Package-Requires: ((emacs "25.1") (helm "3.2") (cl-lib "0.5") (sly "0.0")) 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, or (at your option) 14 | ;; any later version. 15 | 16 | ;; This file 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 GNU Emacs; see the file COPYING. If not, write to 23 | ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 24 | ;; Boston, MA 02110-1301, USA. 25 | 26 | ;;; Commentary: 27 | ;; 28 | ;; A Helm for using SLY. 29 | ;; 30 | ;; The complete command list: 31 | ;; 32 | ;; `helm-sly-list-connections' 33 | ;; Yet another Lisp connection list with `helm'. 34 | ;; `helm-sly-apropos' 35 | ;; Yet another `apropos' with `helm'. 36 | ;; `helm-sly-mini' 37 | ;; Like ~helm-sly-list-connections~, but include an extra source of 38 | ;; Lisp-related buffers, like the events buffer or the scratch buffer. 39 | 40 | ;;; Installation: 41 | ;; 42 | ;; Add helm-sly.el to your load-path. 43 | ;; Set up SLY properly. 44 | ;; 45 | ;; To use Helm instead of the Xref buffer, enable `global-helm-sly-mode'. 46 | ;; 47 | ;; To enable Helm for completion, two options: 48 | ;; 49 | ;; - Without company: 50 | ;; 51 | ;; (add-hook 'sly-mrepl-hook #'helm-sly-disable-internal-completion) 52 | ;; 53 | ;; If you want fuzzy-matching: 54 | ;; 55 | ;; (setq helm-completion-in-region-fuzzy-match t) 56 | ;; 57 | ;; 58 | ;; - With company, install helm-company 59 | ;; (https://github.com/Sodel-the-Vociferous/helm-company), then: 60 | ;; 61 | ;; (add-hook 'sly-mrepl-hook #'company-mode) 62 | ;; (require 'helm-company) 63 | ;; (define-key sly-mrepl-mode-map (kbd "") 'helm-company) 64 | 65 | ;;; Code: 66 | 67 | (require 'helm) 68 | (require 'helm-buffers) 69 | (require 'sly) 70 | (require 'cl-lib) 71 | 72 | (declare-function sly-mrepl--find-buffer "sly-mrepl.el") 73 | (declare-function sly-mrepl-new "sly-mrepl.el") 74 | (declare-function sly-scratch "sly-scratch.el") 75 | 76 | (defun helm-sly-disable-internal-completion () 77 | "Disable SLY own's completion system, e.g. to use Helm instead. 78 | This is mostly useful when added to `sly-mrepl-hook'." 79 | (sly-symbol-completion-mode -1)) 80 | 81 | (defgroup helm-sly nil 82 | "Helm sources and some utilities for SLY." 83 | :prefix "helm-sly-" 84 | :group 'helm 85 | :link '(url-link :tag "GitHub" "https://github.com/emacs-helm/helm-sly")) 86 | 87 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 88 | 89 | 90 | (defvar helm-sly-connections-map 91 | (let ((map (make-sparse-keymap))) 92 | (set-keymap-parent map helm-buffer-map) 93 | (define-key map (kbd "C-c o") 'helm-sly-run-go-to-repl-other-window) 94 | (define-key map (kbd "M-D") 'helm-sly-run-delete-buffers) 95 | (define-key map (kbd "M-R") 'helm-sly-run-rename-connection-buffer) 96 | map) 97 | "Keymap for Lisp connection source in Helm.") 98 | 99 | (defun helm-sly-output-buffer (&optional connection) 100 | "Generic wrapper for CONNECTION output buffer." 101 | (sly-mrepl--find-buffer (or connection (sly-current-connection)))) 102 | 103 | (defun helm-sly-go-to-repl (_candidate &optional other-window-p) 104 | "Switched to marked REPL(s)." 105 | (helm-window-show-buffers 106 | (mapcar (lambda (candidate) 107 | (let ((buffer (nth 1 candidate)) 108 | (connection (nth 0 candidate))) 109 | (or buffer 110 | (and (process-live-p connection) 111 | ;; WARNING: Current buffer might be another mrepl, in 112 | ;; which case we must locally nullify 113 | ;; `sly-buffer-connection' and 114 | ;; `sly-dispatching-connection' as per 115 | ;; `sly-mrepl--find-buffer'. 116 | (let ((sly-buffer-connection nil) 117 | (sly-dispatching-connection nil)) 118 | (sly-mrepl-new connection))) 119 | (sly)))) 120 | (helm-marked-candidates)) 121 | other-window-p)) 122 | (put 'helm-sly-go-to-repl 'helm-only t) 123 | 124 | (defun helm-sly-go-to-repl-other-window (_candidate) 125 | "Switched to marked REPL(s)." 126 | (helm-sly-go-to-repl nil :other-window-p)) 127 | (put 'helm-sly-go-to-repl-other-window 'helm-only t) 128 | 129 | (defun helm-sly-process (connection) 130 | "Generic wrapper for CONNECTION process." 131 | (sly-process connection)) 132 | 133 | (defun helm-sly-connection-number (connection) 134 | "Generic wrapper for CONNECTION number." 135 | (sly-connection-number connection)) 136 | 137 | (defun helm-sly-connection-name (connection) 138 | "Generic wrapper for CONNECTION name." 139 | (sly-connection-name connection)) 140 | 141 | (defun helm-sly-pid (connection) 142 | "Generic wrapper for CONNECTION pid." 143 | (sly-pid connection)) 144 | 145 | (defun helm-sly-implementation-type (connection) 146 | "Generic wrapper for CONNECTION implementation type." 147 | (sly-lisp-implementation-type connection)) 148 | 149 | (defun helm-sly-debug-buffers (connection) 150 | "Generic wrapper for CONNECTION debug buffers." 151 | (sly-db-buffers connection)) 152 | 153 | (defun helm-sly-buffer-connection (buffer) 154 | "Generic wrapper for BUFFER's connection." 155 | (when (bufferp buffer) 156 | (with-current-buffer buffer 157 | sly-buffer-connection))) 158 | 159 | (defun helm-sly-go-to-inferior (_candidate) 160 | "Switched to inferior Lisps associated with the marked connections." 161 | (helm-window-show-buffers 162 | (cl-loop for c in (helm-marked-candidates) 163 | collect (process-buffer (helm-sly-process 164 | (helm-sly-buffer-connection c)))))) 165 | (put 'helm-sly-go-to-inferior 'helm-only t) 166 | 167 | (defun helm-sly-go-to-debug (_candidate) 168 | "Switched to debug buffers associated with the marked connections." 169 | (let ((db-buffers (mapcan (lambda (candidate) 170 | (helm-sly-debug-buffers (car candidate))) 171 | (helm-marked-candidates)))) 172 | (if db-buffers 173 | (helm-window-show-buffers db-buffers) 174 | (message "No debug buffers")))) 175 | (put 'helm-sly-go-to-debug 'helm-only t) 176 | 177 | (defun helm-sly-run-go-to-repl-other-window () 178 | "Run `helm-sly-go-to-repl-other-window' action from `helm-sly--c-source-connection'." 179 | (interactive) 180 | (with-helm-alive-p 181 | (helm-exit-and-execute-action 'helm-sly-go-to-repl-other-window))) 182 | (put 'helm-sly-run-go-to-repl-other-window 'helm-only t) 183 | 184 | (defun helm-sly-run-delete-buffers () 185 | "Run `helm-sly-delete-buffers' action from `helm-sly--c-source-connection'." 186 | (interactive) 187 | (with-helm-alive-p 188 | (helm-exit-and-execute-action 'helm-sly-delete-buffers))) 189 | (put 'helm-sly-run-delete-buffers 'helm-only t) 190 | 191 | (defun helm-sly-set-default-connection (candidate) 192 | "Set connection to use by default to that of CANDIDATE buffer." 193 | (let ((connection (car candidate))) 194 | (sly-select-connection connection))) 195 | (put 'helm-sly-rename-connection-buffer 'helm-only t) 196 | 197 | (defun helm-sly--net-processes () 198 | "Generic wrapper around connection processes." 199 | sly-net-processes) 200 | 201 | (defun helm-sly-delete-buffers (&optional _candidate) 202 | "Kill marked REPL(s). 203 | Kill their inferior Lisps as well if they are the last buffer 204 | connected to it." 205 | (dolist (c (helm-marked-candidates)) 206 | (let ((last-connection? 207 | (not (memq (car c) 208 | (mapcar #'helm-sly-buffer-connection 209 | (delete (cadr c) 210 | (helm-sly--repl-buffers))))))) 211 | (when last-connection? 212 | (let ((sly-dispatching-connection (car c))) 213 | (ignore-errors (sly-quit-lisp t)))) 214 | (kill-buffer (cadr c))))) 215 | (put 'helm-sly-delete-buffers 'helm-only t) 216 | 217 | (defun helm-sly-restart-connections (_candidate) 218 | "Restart marked REPLs' inferior Lisps." 219 | (dolist (c (helm-marked-candidates)) 220 | (sly-restart-connection-at-point (helm-sly-buffer-connection c)))) 221 | (put 'helm-sly-restart-connections 'helm-only t) 222 | 223 | (defun helm-sly-run-rename-connection-buffer () 224 | "Run `helm-sly-rename-connection-buffer' action from `helm-sly--c-source-connection'." 225 | (interactive) 226 | (with-helm-alive-p 227 | (helm-exit-and-execute-action 'helm-sly-rename-connection-buffer))) 228 | (put 'helm-sly-run-rename-connection 'helm-only t) 229 | 230 | (defun helm-sly-rename-connection-buffer (candidate) 231 | "Rename REPL buffer for CANDIDATE." 232 | (let* ((sly-dispatching-connection (car candidate))) 233 | (when (cadr candidate) 234 | (with-current-buffer (cadr candidate) 235 | (rename-buffer (helm-read-string "New name: " (buffer-name))))))) 236 | (put 'helm-sly-rename-connection-buffer 'helm-only t) 237 | 238 | (defcustom helm-sly-connection-actions 239 | `(("Go to REPL" . helm-sly-go-to-repl) 240 | (,(substitute-command-keys "Go to REPL in other window \\`\\[helm-sly-run-go-to-repl-other-window]'") 241 | . helm-sly-go-to-repl-other-window) 242 | ("Set default" . helm-sly-set-default-connection) 243 | ("Restart" . helm-sly-restart-connections) 244 | (,(substitute-command-keys "Rename REPL buffer \\`\\[helm-sly-run-rename-connection-buffer]'") 245 | . helm-sly-rename-connection-buffer) 246 | (,(substitute-command-keys "Quit \\`\\[helm-sly-run-delete-buffers]'") 247 | . helm-sly-delete-buffers) 248 | ("Go to inferior Lisp" . helm-sly-go-to-inferior) 249 | ("Go to debug buffers" . helm-sly-go-to-debug)) 250 | "Actions for `helm-sly-list-connections`." 251 | :group 'helm-sly 252 | :type '(alist :key-type string :value-type function)) 253 | 254 | (defun helm-sly-format-connection (connection buffer) 255 | (let ((fstring "%s%2s %-16s %-17s %-7s %-s %s")) 256 | (format fstring 257 | (if (eq sly-default-connection connection) 258 | "*" 259 | " ") 260 | (helm-sly-connection-number connection) 261 | (helm-sly-connection-name connection) 262 | (or (process-id connection) (process-contact connection)) 263 | (helm-sly-pid connection) 264 | (helm-sly-implementation-type connection) 265 | buffer))) 266 | 267 | (defcustom helm-sly-connection-formatter #'helm-sly-format-connection 268 | "Function that takes a connection and return the Helm display string. 269 | This can be used to customize the formatting of the buffer/connection sources." 270 | :group 'helm-sly 271 | :type 'function) 272 | 273 | (defun helm-sly--connection-candidates (p &optional buffer) 274 | "Return (DISPLAY-VALUE . REAL-VALUE) for connection P. 275 | The REAL-VALUE is (P BUFFER). 276 | If BUFFER is nil, the inferior Lisp buffer is used in the display function." 277 | (setq buffer (or buffer 278 | (helm-sly-output-buffer p))) 279 | (cons 280 | (funcall helm-sly-connection-formatter p (or buffer 281 | (sly-inferior-lisp-buffer p))) 282 | (list p buffer))) 283 | 284 | (defun helm-sly--repl-buffers (&optional connection thread) 285 | "Return the list of buffers association to CONNECTION and/or THREAD. 286 | Inspired by `sly-mrepl--find-buffer'." 287 | (cl-remove-if-not 288 | (lambda (x) 289 | (with-current-buffer x 290 | (and (eq major-mode 'sly-mrepl-mode) 291 | (or (not connection) 292 | (eq sly-buffer-connection 293 | connection)) 294 | (or (not thread) 295 | (eq thread sly-current-thread))))) 296 | (buffer-list))) 297 | 298 | (cl-defun helm-sly--repl-buffer-candidates (&optional connection predicate) 299 | "Return buffer/connection candidates. 300 | It returns all REPL buffer candidates matching CONNECTION. 301 | Further filter the candidates with PREDICATE. 302 | Without CONNECTION or PREDICATE, return all REPL buffer candidates and all 303 | buffer-less connections (both matching PREDICATE). 304 | Current buffer is listed last." 305 | (let* ((repl-buffers (helm-sly--repl-buffers connection)) 306 | (repl-buffers (if predicate 307 | (cl-remove-if-not predicate repl-buffers) 308 | repl-buffers)) 309 | (buffer-connections (cl-delete-duplicates 310 | (mapcar #'helm-sly-buffer-connection 311 | repl-buffers)))) 312 | (let* ((result 313 | (append (mapcar (lambda (b) 314 | (helm-sly--connection-candidates 315 | (helm-sly-buffer-connection b) 316 | b)) 317 | repl-buffers) 318 | (unless (or connection predicate) 319 | (mapcar #'helm-sly--connection-candidates 320 | (cl-set-difference 321 | (reverse (helm-sly--net-processes)) 322 | buffer-connections))))) 323 | (current-buffer-candidate 324 | (cl-find (current-buffer) 325 | result 326 | :key #'cl-third))) 327 | (append (cl-delete current-buffer-candidate result) 328 | (and current-buffer-candidate 329 | (list current-buffer-candidate)))))) 330 | 331 | (cl-defun helm-sly--c-source-connection (&optional (candidates 332 | (helm-sly--repl-buffer-candidates)) 333 | (name "Lisp connections")) 334 | "Build Helm source of Lisp connections. 335 | You can easily customize the candidates by, for instance, calling 336 | `helm-sly--repl-buffer-candidates' over a specific connection." 337 | (helm-build-sync-source name 338 | :candidates candidates 339 | :action helm-sly-connection-actions 340 | :keymap helm-sly-connections-map)) 341 | 342 | ;;;###autoload 343 | (defun helm-sly-list-connections () 344 | "List Lisp connections with Helm." 345 | (interactive) 346 | (helm :sources (list (helm-sly--c-source-connection)) 347 | :buffer "*helm-sly-list-connections*")) 348 | 349 | (defun helm-sly--buffer-candidates () 350 | "Collect Lisp-related buffers, like the `events' buffer. 351 | If the buffer does not exist, we use the associated function to generate it. 352 | 353 | The list is in the (DISPLAY . REAL) form. 354 | REAL is either a buffer or a function returning a buffer." 355 | (append 356 | `(,(cons (sly-buffer-name :events :connection (sly-current-connection)) 357 | #'sly-pop-to-events-buffer) 358 | ,(cons (sly-buffer-name :threads :connection (sly-current-connection)) 359 | #'sly-list-threads) 360 | ,(cons (sly-buffer-name :inferior :connection (sly-current-connection)) 361 | #'sly-inferior-lisp-buffer)) 362 | (when (sly-db-buffers (sly-current-connection)) 363 | (list 364 | (cons (sly-buffer-name :db :connection (sly-current-connection)) 365 | #'sly-db-pop-to-debugger))) 366 | (list (cons (sly-buffer-name :scratch) 367 | #'sly-scratch)) 368 | (delq nil (mapcar (lambda (name) 369 | (let ((buffer (get-buffer name))) 370 | (when buffer 371 | (cons name buffer)))) 372 | '("*sly-description*" "*sly-compilation*"))))) 373 | 374 | 375 | (defun helm-sly-switch-buffers (_candidate) 376 | "Switch to buffer candidates and replace current buffer. 377 | 378 | If more than one buffer marked switch to these buffers in separate windows. 379 | If a prefix arg is given split windows vertically." 380 | (helm-window-show-buffers 381 | (cl-loop for b in (helm-marked-candidates) 382 | collect (if (functionp b) 383 | (call-interactively b) 384 | b)))) 385 | (put 'helm-sly-switch-buffers 'helm-only t) 386 | 387 | (defun helm-sly-build-buffers-source () 388 | "Build Helm source of Lisp buffers." 389 | (helm-build-sync-source "Build buffers" 390 | :candidates (helm-sly--buffer-candidates) 391 | :action `(("Switch to buffer(s)" . helm-sly-switch-buffers)))) 392 | 393 | (defun helm-sly-new-repl (name) 394 | "Spawn new SLY REPL with name NAME." 395 | (or (ignore-errors 396 | (sly-mrepl-new (sly-connection) name)) 397 | (sly))) 398 | 399 | (defun helm-sly-new-repl-choose-lisp (&optional _name) 400 | "Spawn new SLY REPL on a new connection." 401 | ;; TODO: Name is ignored for now. Is there a way to pass the buffer name? 402 | ;; Advising or using cl-letf on sly-mrepl-new does not seem to work. 403 | (let ((current-prefix-arg '-)) 404 | (call-interactively #'sly))) 405 | 406 | (defvar helm-sly-new 407 | (helm-build-dummy-source "Open new REPL" 408 | :action (helm-make-actions 409 | "Open new REPL" 'helm-sly-new-repl 410 | "Open new REPL with chosen Lisp" 'helm-sly-new-repl-choose-lisp)) 411 | "Helm source to make new REPLs.") 412 | 413 | (defun helm-sly-lisp-buffer-p (buffer) 414 | "Return non-nil if BUFFER is derived from `lisp-mode'." 415 | (with-current-buffer buffer 416 | (derived-mode-p 'lisp-mode))) 417 | 418 | (cl-defun helm-sly-lisp-buffer-source (&key (name "Lisp buffers") 419 | (predicate #'helm-sly-lisp-buffer-p)) 420 | (helm-make-source name 'helm-source-buffers 421 | :buffer-list (lambda () 422 | (mapcar #'buffer-name 423 | (cl-remove-if-not predicate 424 | (buffer-list)))))) 425 | 426 | (defun helm-sly-mini () 427 | "Helm for Lisp connections and buffers." 428 | (interactive) 429 | (helm :sources (list (helm-sly--c-source-connection) 430 | helm-sly-new 431 | (helm-sly-lisp-buffer-source) 432 | (helm-sly-build-buffers-source)) 433 | :buffer "*helm-sly-mini*")) 434 | 435 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 436 | 437 | 438 | (defun helm-sly--format-apropos-entry (entry) 439 | "Generic wrapper around apropos' entries. 440 | ENTRY is in the following form: 441 | 442 | \(:designator (\"FORMAT-SYMBOL\" \"ALEXANDRIA\" t) 443 | :function \"Constructs a string by applying ARGUMENTS to string designator CONTROL as\" 444 | :arglist \"(PACKAGE CONTROL &REST ARGUMENTS)\" 445 | :bounds ((11 17)))" 446 | (let* ((designator (plist-get entry :designator)) 447 | (type (nth 2 entry)) 448 | (synopsis (plist-get entry type)) 449 | (arglist (plist-get entry :arglist))) 450 | (let ((real-value (downcase (sly-apropos-designator-string designator)))) 451 | (cons 452 | (format "%s [%s%s]%s" 453 | (propertize real-value 454 | 'face 'sly-apropos-symbol) 455 | (propertize (upcase-initials 456 | (replace-regexp-in-string 457 | "-" " " (substring (symbol-name type) 1))) 458 | 'face 'italic) 459 | (if (cl-find type '(:function :generic-function :macro)) 460 | (downcase (format " %s" arglist)) 461 | "") 462 | (if (eq synopsis :not-documented) 463 | "" 464 | (concat "\n" synopsis))) 465 | real-value)))) 466 | 467 | (defun helm-sly-apropos-inspect (name) 468 | (sly-inspect (format "(quote %s)" name))) 469 | 470 | (defun helm-sly-apropos-describe-other-window (name) 471 | ;; Warning: Both Helm and `sly-describe-symbol' have their own 472 | ;; buffer-switching logic. 473 | ;; To ensure `sly-describe-symbol' does not replace the current Helm buffer, 474 | ;; we switch to it now. 475 | (switch-to-buffer (sly-buffer-name :description)) 476 | (sly-describe-symbol name)) 477 | 478 | (defcustom helm-sly-apropos-actions 479 | `(("Describe" . sly-describe-symbol) 480 | ("Go to source" . sly-edit-definition) 481 | ("Inspect definition" . helm-sly-apropos-inspect) 482 | ;; `sly-edit-uses' combines `sly-who-calls', `sly-who-references', and 483 | ;; `sly-who-macroexpands'. 484 | ("Find all the references to this symbol" . sly-edit-uses) 485 | ;; `sly-calls-who' seems to only work on LispWorks, while `sly-list-callees' 486 | ;; works everywhere. 487 | ("Show all known callees" . sly-list-callees) 488 | ("Show bindings of a global variable" . sly-who-binds) 489 | ("Show assignments to a global variable" . sly-who-sets) 490 | ("Show all known methods specialized on a class" . sly-who-specializes)) 491 | "Actions for `helm-sly--apropos-source'. 492 | This is similar to the `sly-apropos-symbol' button type." 493 | :group 'helm-sly 494 | :type '(alist :key-type string :value-type function)) 495 | 496 | (defun helm-sly--apropos-source (name external-only case-sensitive current-package) 497 | "Build source that provides Helm completion against `apropos'. 498 | - NAME: name of the source. 499 | - EXTERNAL-ONLY: only search external symbols. 500 | - CASE-SENSITIVE: match case in apropos search. 501 | - CURRENT-PACKAGE: only search symbols in current package." 502 | (helm-build-sync-source name 503 | :candidates 504 | `(lambda () 505 | (with-current-buffer helm-current-buffer 506 | (cl-loop for entry in (sly-eval 507 | (list 'slynk-apropos:apropos-list-for-emacs 508 | ;; Warning: Properties crash Slynk! 509 | ;; See https://github.com/joaotavora/sly/issues/370. 510 | (regexp-quote (substring-no-properties helm-pattern)) 511 | ,(not (null external-only)) 512 | ,(not (null case-sensitive)) 513 | (when ,current-package 514 | (helm-sly-current-package)))) 515 | collect (helm-sly--format-apropos-entry entry)))) 516 | :requires-pattern 2 517 | :fuzzy-match t 518 | :multiline t 519 | :persistent-help "Describe" 520 | :action helm-sly-apropos-actions 521 | :persistent-action #'helm-sly-apropos-describe-other-window)) 522 | 523 | (defun helm-sly-current-package () 524 | "Return the Common Lisp package in the current context." 525 | (or sly-buffer-package 526 | (sly-current-package))) 527 | 528 | (defvar helm-sly--c-source-apropos-symbol-current-package 529 | (helm-sly--apropos-source 530 | "Apropos (current package)" 531 | nil 532 | nil 533 | (helm-sly-current-package))) 534 | 535 | (defvar helm-sly--c-source-apropos-symbol-current-external-package 536 | (helm-sly--apropos-source 537 | "Apropos (current external package)" 538 | 'external-only 539 | nil 540 | (helm-sly-current-package))) 541 | 542 | (defvar helm-sly--c-source-apropos-symbol-all-external-package 543 | (helm-sly--apropos-source 544 | "Apropos (all external packages)" 545 | 'external-only 546 | nil 547 | nil)) 548 | 549 | (defvar helm-sly--c-source-apropos-symbol-all-package 550 | (helm-sly--apropos-source 551 | "Apropos (all packages)" 552 | nil 553 | nil 554 | nil)) 555 | 556 | (defvar helm-sly-apropos-sources 557 | '(helm-sly--c-source-apropos-symbol-current-package 558 | helm-sly--c-source-apropos-symbol-current-external-package 559 | helm-sly--c-source-apropos-symbol-all-external-package 560 | helm-sly--c-source-apropos-symbol-all-package) 561 | "List of Helm sources for `helm-sly-apropos'.") 562 | 563 | ;;;###autoload 564 | (defun helm-sly-apropos () 565 | "Yet another Apropos with `helm'. 566 | It won't display before you start entering a pattern." 567 | (interactive) 568 | (helm :sources helm-sly-apropos-sources 569 | :buffer "*helm lisp apropos*")) 570 | 571 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 572 | 573 | 574 | (defun helm-sly-normalize-xrefs (xref-alist) 575 | "Like `sly-insert-xrefs' but return a formatted list of strings instead. 576 | XREF-ALIST is as per `sly-insert-xrefs'. 577 | The strings are formatted as \"GROUP: LABEL\"." 578 | (cl-loop for (group . refs) in xref-alist 579 | append 580 | (cl-loop for (label location) in refs 581 | collect 582 | (list group label location)))) 583 | 584 | (defun helm-sly-xref-lineno (location) 585 | "Return line number of xref's LOCATION. 586 | Return 0 if location does not refer to a proper file." 587 | (or 588 | (ignore-errors 589 | (save-window-excursion 590 | (sly--pop-to-source-location location 591 | 'sly-xref) 592 | (line-number-at-pos 593 | (car (alist-get :position (cdr location)))))) 594 | 0)) 595 | 596 | (defun helm-sly-xref-transformer (candidates) 597 | "Transform CANDIDATES to \"GROUP: LABEL\". 598 | CANDIDATES is a list of (GROUP LABEL LOCATION) as per 599 | `helm-sly-normalize-xrefs'." 600 | (cl-loop for (group label location) in candidates 601 | collect (cons (concat (propertize (abbreviate-file-name group) 602 | 'face 'helm-grep-file) 603 | ":" 604 | (propertize 605 | (number-to-string (helm-sly-xref-lineno location)) 606 | 'face 'helm-grep-lineno) 607 | ":" 608 | (sly-one-line-ify label)) 609 | (list group label location)))) 610 | 611 | (defun helm-sly-xref-goto (candidate) 612 | "Go to CANDIDATE xref location." 613 | (let ((location (nth 2 candidate))) 614 | (switch-to-buffer 615 | (save-window-excursion 616 | (sly--pop-to-source-location location 'sly-xref))))) 617 | 618 | (defun helm-sly-xref-recompile (_candidate &optional policy) 619 | "Recompile selected candidates. 620 | POLICY is as per `sly-compile-defun'. 621 | The POLICY of NIL defaults to `sly-compilation-policy'." 622 | (let ((sly-compilation-policy (sly-compute-policy policy))) 623 | (let ((labels '()) 624 | (locations '())) 625 | (dolist (candidate (helm-marked-candidates)) 626 | (push (nth 1 candidate) labels) 627 | (push (nth 2 candidate) locations)) 628 | (sly-recompile-locations 629 | locations 630 | (lambda (results) 631 | (message "Recompilation results: %s" 632 | (mapconcat (lambda (result) 633 | (concat (pop labels) " " 634 | (if (sly-compilation-result.successp result) 635 | "OK" 636 | "fail"))) 637 | results 638 | ", "))))))) 639 | 640 | (defun helm-sly-xref-recompile-debug1 (_candidate) 641 | "Recompile selected candidates with debug level 1." 642 | (helm-sly-xref-recompile nil 1)) 643 | 644 | (defun helm-sly-xref-recompile-debug2 (_candidate) 645 | "Recompile selected candidates with debug level 2." 646 | (helm-sly-xref-recompile nil 2)) 647 | 648 | (defun helm-sly-xref-recompile-debug3 (_candidate) 649 | "Recompile selected candidates with debug level 3." 650 | (helm-sly-xref-recompile nil 3)) 651 | 652 | (defun helm-sly-xref-recompile-speed1 (_candidate) 653 | "Recompile selected candidates with speed level 1." 654 | (helm-sly-xref-recompile nil -1)) 655 | 656 | (defun helm-sly-xref-recompile-speed2 (_candidate) 657 | "Recompile selected candidates with speed level 2." 658 | (helm-sly-xref-recompile nil -2)) 659 | 660 | (defun helm-sly-xref-recompile-speed3 (_candidate) 661 | "Recompile selected candidates with speed level 3." 662 | (helm-sly-xref-recompile nil -3)) 663 | 664 | (defun helm-sly-build-xref-source (xrefs) 665 | "Return a Helm source of XREFS." 666 | (helm-build-sync-source "Lisp xrefs" 667 | :candidates (helm-sly-normalize-xrefs xrefs) 668 | :candidate-transformer 'helm-sly-xref-transformer 669 | :action `(("Switch to buffer(s)" . helm-sly-xref-goto) 670 | ("Recompile" . helm-sly-xref-recompile) 671 | ("Recompile (debug 1)" . helm-sly-xref-recompile-debug1) 672 | ("Recompile (debug 2)" . helm-sly-xref-recompile-debug2) 673 | ("Recompile (debug 3)" . helm-sly-xref-recompile-debug3) 674 | ("Recompile (speed 1)" . helm-sly-xref-recompile-speed1) 675 | ("Recompile (speed 2)" . helm-sly-xref-recompile-speed2) 676 | ("Recompile (speed 3)" . helm-sly-xref-recompile-speed3)))) 677 | 678 | (defun helm-sly-show-xref-buffer (xrefs _type _symbol _package &optional _method) 679 | "Show XREFS. 680 | See `sly-xref--show-results'." 681 | (helm :sources (list (helm-sly-build-xref-source xrefs)) 682 | :buffer "*helm-sly-xref*")) 683 | 684 | ;;;###autoload 685 | (define-minor-mode helm-sly-mode 686 | "Use Helm for Lisp xref selections. 687 | Note that the local minor mode has a global effect, thus making 688 | `global-helm-sly-mode' and `helm-sly-mode' equivalent." 689 | ;; TODO: Is it possible to disable the local minor mode? 690 | :init-value nil 691 | (let ((target 'sly-xref--show-results)) 692 | ;; TODO: Weirdly enough, the advice seems to be ignored once in a while. 693 | ;; See https://github.com/joaotavora/sly/issues/408. 694 | (if (advice-member-p #'helm-sly-show-xref-buffer target) 695 | (advice-remove target #'helm-sly-show-xref-buffer) 696 | (advice-add target :override #'helm-sly-show-xref-buffer)))) 697 | 698 | ;;;###autoload 699 | (define-globalized-minor-mode global-helm-sly-mode 700 | helm-sly-mode 701 | helm-sly-mode 702 | :require 'helm-sly) 703 | 704 | (provide 'helm-sly) 705 | ;;; helm-sly.el ends here 706 | -------------------------------------------------------------------------------- /readme.org: -------------------------------------------------------------------------------- 1 | #+TITLE: Helm-SLY 2 | 3 | Helm for [[https://github.com/joaotavora/sly][SLY]], a Common Lisp interaction mode for Emacs. 4 | 5 | * Installation 6 | 7 | Add =helm-sly.el= to your load-path. 8 | Set up SLY properly. 9 | 10 | To use Helm instead of the Xref buffer, enable ~global-helm-sly-mode~. 11 | 12 | To enable Helm for completion, two options: 13 | 14 | - Without company: 15 | 16 | #+begin_src lisp 17 | (add-hook 'sly-mrepl-hook #'helm-sly-disable-internal-completion) 18 | ;; If you want fuzzy-matching: 19 | (setq helm-completion-in-region-fuzzy-match t) 20 | #+end_src 21 | 22 | - With company, install [[https://github.com/Sodel-the-Vociferous/helm-company][helm-company]], then: 23 | 24 | #+begin_src lisp 25 | (add-hook 'sly-mrepl-hook #'company-mode) 26 | (require 'helm-company) 27 | (define-key sly-mrepl-mode-map (kbd "") 'helm-company) 28 | #+end_src 29 | 30 | * Usage 31 | 32 | Helm-SLY defines a few new commands: 33 | 34 | - helm-sly-list-connections :: Yet another Lisp connection list with `helm'. 35 | 36 | - helm-sly-apropos :: Yet another ~apropos~ with Helm. 37 | 38 | - helm-sly-mini :: Like ~helm-sly-list-connections~, but include an extra source 39 | of Lisp-related buffers, like the events buffer or the 40 | scratch buffer. 41 | 42 | * Change Log 43 | 44 | ** 0.7.2 45 | 46 | - Add "recompile" actions to Xref source. 47 | 48 | ** 0.7.1 49 | 50 | - Fix =predicate= argument in =helm-sly-lisp-buffer-source=. 51 | - Fix buffer-less connection switching. 52 | - Rename =helm-sly-build-buffers-source= source name to "Build buffers", to 53 | avoid conflict with Lisp buffers. This fixes completion against buffers. 54 | 55 | ** 0.7 56 | 57 | - Add source listing all Lisp buffers. 58 | - Make helm-sly--c-source-connection more customizable. 59 | - Include inferior Lisp buffer to the "Lisp buffers" source. 60 | It was already accessible via the action menu. 61 | - Dynamically list the debug buffer in the "Lisp buffers" source, when present. 62 | It was already accessible via the action menu. 63 | - Dynamically list sly-description and sly-compilation when present. 64 | - Fix sly-scratch and sly-db buffer switching. 65 | 66 | ** 0.6 67 | 68 | - New action to go to REPL in other window. 69 | - List current connection buffer candidate last. 70 | - Make connection candidates customizable. 71 | See =helm-sly--c-source-connection=. 72 | - Make connection candidate display customizable. 73 | See =helm-sly-connection-formatter=. 74 | --------------------------------------------------------------------------------