├── .elpaignore ├── .gitignore ├── LICENSE ├── README.org ├── images ├── popper-cycle.gif ├── popper-demote.gif ├── popper-toggle-all.gif ├── popper-toggle-all.png └── popper-toggle-latest.gif ├── popper-echo.el └── popper.el /.elpaignore: -------------------------------------------------------------------------------- 1 | images -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | #+title: Popper: Popup Buffers for Emacs 2 | 3 | #+html: GNU ELPA 4 | #+html: GNU-devel ELPA 5 | #+html: MELPA 6 | #+html: MELPA Stable 7 | 8 | Popper is a minor-mode to tame the flood of ephemeral windows Emacs produces, 9 | while still keeping them within arm's reach. 10 | 11 | Designate any buffer to "popup" status, and it will stay out of your way. 12 | Disimss or summon it easily with one key. Cycle through all your "popups" or 13 | just the ones relevant to your current buffer. Group popups automatically so 14 | you're presented with the most relevant ones. Useful for many things, including 15 | toggling display of REPLs, documentation, compilation or shell output: any 16 | buffer you need instant access to but want kept out of your way! 17 | 18 | There is a [[https://www.youtube.com/watch?v=E-xUNlZi3rI][detailed demo of Popper here]]. [Note (10/2021): This demo is quite out 19 | of date at this point but covers the basics.] 20 | 21 | You can pre-designate any buffer (by name or major-mode) as a popup, and the 22 | status will be automatically applied when Emacs creates it. 23 | 24 | By default, your popups are displayed in a non-obtrusive way, but Popper 25 | respects window rules for buffers that you might have in =display-buffer-alist= 26 | or created using a window management package like =shackle.el=. Popper summons 27 | windows defined by the user as "popups" by simply calling =display-buffer=. 28 | 29 | *** Toggle a popup: 30 | # #+ATTR_ORG: :width 500 31 | # #+ATTR_HTML: :width 500px 32 | # [[file:images/popper-toggle-latest.gif]] 33 | Here I toggle a REPL for quick access. 34 | 35 | https://user-images.githubusercontent.com/8607532/135746327-c400aaf9-4aa1-4b6e-8b0a-0dd58c2690bb.mp4 36 | 37 | *** Cycle through all your popups: 38 | # #+ATTR_ORG: :width 500 39 | # #+ATTR_HTML: :width 500px 40 | # [[file:images/popper-cycle.gif]] 41 | Here I cycle through all "popup buffers" in quick succession. My popup buffers are the usual suspects: help buffers, REPLs, grep and occur buffers, shell and compilation output, log buffers etc. 42 | 43 | https://user-images.githubusercontent.com/8607532/135746363-aa3c3a25-cc9d-4907-a85f-07ea0d764238.mp4 44 | 45 | Note that popup buffers are indicated here by the marker "POP" in their modelines. 46 | *** Or jump to them instantly with hinting 47 | You can see your popups in the echo area and jump to them with a key. 48 | 49 | https://user-images.githubusercontent.com/8607532/135746395-dfe3b3e8-9d5a-4309-b521-9555a34bb73d.mp4 50 | *** Group your popups according to context 51 | With grouping turned on, I'm only shown the popups relevant to the current context (in this case the Popper project). 52 | 53 | https://user-images.githubusercontent.com/8607532/135746404-d8673390-d220-46fe-9b57-9dc81458cecd.mp4 54 | 55 | The context can be anything, see below. Projectile, Perspective and Project.el are supported out of the box. 56 | *** Turn a regular window into a popup: 57 | # #+ATTR_ORG: :width 500 58 | # #+ATTR_HTML: :width 500px 59 | # [[file:images/popper-demote.gif]] 60 | 61 | https://user-images.githubusercontent.com/8607532/135746418-21d32c74-e1f1-48f3-ba19-792c7cb2a51a.mp4 62 | 63 | Or promote a popup to regular window status. 64 | *** Popper respects your display buffer settings 65 | 66 | https://user-images.githubusercontent.com/8607532/135746477-93f8fc3d-4806-4901-beae-904059584e72.mp4 67 | 68 | And windows open the way you have specified them to: in reused windows, side windows, new or child frames, etc. All display-buffer actions are supported except for displaying in popups in new frames and in atomic windows. 69 | *** ... you can toggle all your popups at once: 70 | #+ATTR_ORG: :width 500 71 | #+ATTR_HTML: :width 500px 72 | [[file:images/popper-toggle-all.png]] 73 | # [[file:images/popper-toggle-all.gif]] 74 | * Usage 75 | Turn on =popper-mode=. 76 | 77 | - Turn any buffer into a popup (or vice-versa) with =popper-toggle-type=. 78 | 79 | There are two commands for displaying popups, you can bind them as 80 | convenient: 81 | 82 | - =popper-toggle=: Show/hide the latest popup. Does more with prefix args. 83 | - =popper-cycle=: Cycle through your popups in sequence. 84 | 85 | To automatically designate buffers as popups, see the customization section. Additionally, you can kill an open popup buffer with =popper-kill-latest-popup=. 86 | 87 | If you want the echo-area hints, turn on =popper-echo-mode=. 88 | 89 | * Setup 90 | =popper= is available on GNU ELPA, so you can install it with =M-x package-install RET popper RET=. 91 | 92 | ** With =use-package= 93 | #+BEGIN_SRC emacs-lisp 94 | (use-package popper 95 | :ensure t ; or :straight t 96 | :bind (("C-`" . popper-toggle) 97 | ("M-`" . popper-cycle) 98 | ("C-M-`" . popper-toggle-type)) 99 | :init 100 | (setq popper-reference-buffers 101 | '("\\*Messages\\*" 102 | "Output\\*$" 103 | "\\*Async Shell Command\\*" 104 | help-mode 105 | compilation-mode)) 106 | (popper-mode +1) 107 | (popper-echo-mode +1)) ; For echo area hints 108 | #+END_SRC 109 | See the Customization section for details on specifying buffer types as popups. 110 | 111 | ** Without =use-package= 112 | #+BEGIN_SRC emacs-lisp 113 | (require 'popper) 114 | (setq popper-reference-buffers 115 | '("\\*Messages\\*" 116 | "Output\\*$" 117 | "\\*Async Shell Command\\*" 118 | help-mode 119 | compilation-mode)) 120 | (global-set-key (kbd "C-`") 'popper-toggle) 121 | (global-set-key (kbd "M-`") 'popper-cycle) 122 | (global-set-key (kbd "C-M-`") 'popper-toggle-type) 123 | (popper-mode +1) 124 | 125 | ;; For echo-area hints 126 | (require 'popper-echo) 127 | (popper-echo-mode +1) 128 | #+END_SRC 129 | See the Customization section for details on specifying buffer types as popups. 130 | 131 | * Customization 132 | :PROPERTIES: 133 | :ID: ce27af55-91a5-4549-97ac-d7f2c0aa9019 134 | :END: 135 | To get started, customize this variable: 136 | 137 | - =popper-reference-buffers=: List of buffers to treat as popups. Each entry in the list can be a regexp (string) to match buffer names against or a major-mode (symbol) to match buffer major-modes against. 138 | 139 | Example: 140 | 141 | #+BEGIN_SRC emacs-lisp 142 | (setq popper-reference-buffers 143 | '("\\*Messages\\*" 144 | "Output\\*$" 145 | help-mode 146 | compilation-mode)) 147 | #+END_SRC 148 | 149 | Will treat the following as popups: The Messages buffer, any buffer ending in "Output*", and all help and compilation buffers. 150 | 151 | *Note: Because of how some shell buffers are initialized in Emacs, you may need to supply both the name and major mode to match them consistently*. Take your pick: 152 | 153 | #+BEGIN_SRC emacs-lisp 154 | ;; Match eshell, shell, term and/or vterm buffers 155 | (setq popper-reference-buffers 156 | (append popper-reference-buffers 157 | '("^\\*eshell.*\\*$" eshell-mode ;eshell as a popup 158 | "^\\*shell.*\\*$" shell-mode ;shell as a popup 159 | "^\\*term.*\\*$" term-mode ;term as a popup 160 | "^\\*vterm.*\\*$" vterm-mode ;vterm as a popup 161 | ))) 162 | #+END_SRC 163 | 164 | As of v0.40, Popper also supports classifying a buffer as a popup based on any user supplied predicate. This predicate (function) is called with the buffer as argument and returns =t= if it should be considered a popup. Here is an example with a predicate: 165 | 166 | #+BEGIN_SRC emacs-lisp 167 | (setq popper-reference-buffers 168 | '("\\*Messages\\*" 169 | help-mode 170 | (lambda (buf) (with-current-buffer buf 171 | (and (derived-mode-p 'fundamental-mode) 172 | (< (count-lines (point-min) (point-max)) 173 | 10))))))) 174 | #+END_SRC 175 | 176 | This list includes the the Messages and =help-mode= buffers from before, along with a predicate: any buffer derived from the major mode =fundamental-mode= that has fewer than 10 lines will be considered a popup. 177 | 178 | Note that for performance reasons, predicates that classify a buffer as a popup are /only run when the buffer is created/. Thus dynamically changing a buffer's popup status based on its changing state is not possible (yet). 179 | 180 | There are other customization options, check the =popper= group. 181 | 182 | Here is an example of how I use Popper: 183 | 184 | https://user-images.githubusercontent.com/8607532/135748097-268f5aae-ad42-44fa-9435-b63b960d45cf.mp4 185 | 186 | In this example: 187 | - Popup buffers have no modelines. 188 | - My popups are grouped by project, so I only see popups relevant to the current one. 189 | - I use the echo-area hints to select popups with the number keys. 190 | - These hints have their buffer names truncated so they're easier to read. 191 | - My popups show up in different ways on screen depending on my display-buffer settings: Help windows on the right, REPLs and command output at the bottom, grep buffers at the top etc. 192 | 193 | This section details these (and other) customization options. 194 | 195 | ** Grouping popups by context 196 | Popper can group popups by "context", so that the popups available for display are limited to those that are relevant to the context in which =popper-toggle= or =popper-cycle= is called. For example, when cycling popups from a project buffer, you may only want to see the popups (REPLs, help buffers and compilation output, say) that were spawned from buffers in that project. This is intended to approximate DWIM behavior, so that the most relevant popup in any context is never more than one command away. 197 | 198 | Built in contexts include projects as defined in Emacs' built in =project.el= and =projectile=, using =perspective= names (from =persp.el=), as well as the default directory of a buffer. To set this, customize =popper-group-function= or use one of 199 | 200 | #+BEGIN_SRC emacs-lisp 201 | (setq popper-group-function #'popper-group-by-project) ; project.el projects 202 | 203 | (setq popper-group-function #'popper-group-by-projectile) ; projectile projects 204 | 205 | (setq popper-group-function #'popper-group-by-directory) ; group by project.el 206 | ; project root, with 207 | ; fall back to 208 | ; default-directory 209 | (setq popper-group-function #'popper-group-by-perspective) ; group by perspective 210 | #+END_SRC 211 | 212 | You can also provide a custom function that takes no arguments, is executed in the context of a popup buffer and returns a string or symbol that represents the group/context it belongs to. This function will group all popups under the symbol =my-popup-group=: 213 | 214 | #+BEGIN_SRC emacs-lisp 215 | (defun popper-group-by-my-rule () 216 | "This function should return a string or symbol that is the 217 | name of the group this buffer belongs to. It is called with each 218 | popup buffer as current, so you can use buffer-local variables." 219 | 220 | 'my-popup-group) 221 | 222 | (setq popper-group-function #'popper-group-by-my-rule) 223 | #+END_SRC 224 | 225 | ** Managing popup placement 226 | In keeping with the principle of least surprise, all popups are shown in the same location: At the bottom of the frame. You can customize =popper-display-function= to change how popups are displayed. 227 | 228 | However this means you can't have more than one popup open at a time. You may also want more control over where individual popups appear. For example, you may want an IDE-like set-up, with all help windows open on the right, REPLs on top and compilation windows at the bottom. This is best done by customizing Emacs' =display-buffer-alist=. Since this is a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/The-Zen-of-Buffer-Display.html#The-Zen-of-Buffer-Display][singularly confusing task]], I recommend using =popper= with a package that locks window placements, /e.g./ [[https://depp.brause.cc/shackle/][Shackle]]. 229 | 230 | *** Default popup placement: 231 | #+begin_src emacs-lisp 232 | (setq popper-display-control t) ;This is the DEFAULT behavior 233 | #+end_src 234 | You can customize =popper-display-function= to show popups any way you'd like. 235 | Any =display-buffer= [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Buffer-Display-Action-Functions.html][action function]] can work, or you can write your own. For 236 | example, setting it as 237 | #+BEGIN_SRC emacs-lisp 238 | (setq popper-display-function #'display-buffer-in-child-frame) 239 | #+END_SRC 240 | will cause popups to be displayed in a child frame. 241 | 242 | *** Popup placement controlled using =display-buffer-alist= or =shackle.el=: 243 | If you already have rules in place for how various buffers should be displayed, such as by customizing =display-buffer-alist= or with =shackle.el=, popper will respect them once you set =popper-display-control= to nil: 244 | 245 | #+begin_src emacs-lisp 246 | (use-package shackle 247 | ;; -- shackle rules here -- 248 | ) 249 | 250 | (use-package popper 251 | ;; -- popper customizations here-- 252 | 253 | :config 254 | (setq popper-display-control nil)) 255 | #+end_src 256 | 257 | ** Suppressing popups 258 | Popper can suppress popups when they are first created. The buffer will be registered in the list of popups but will not show up on your screen. Instead, a message ("Popup suppressed: $buffer-name") will be printed to the echo area. You can then raise it using =popper-toggle= or =popper-cycle= at your convenience. It behaves as a regular popup from that point on: 259 | 260 | [[https://user-images.githubusercontent.com/8607532/132929265-37eee976-131f-4631-9bad-73090bf17231.mp4]] 261 | # [[file:images/popper-hide-popup.gif]] 262 | 263 | This is generally useful to keep buffers that are created as a side effect from interrupting your work. 264 | 265 | To specify popups to auto-hide, use a cons cell with the =hide= symbol when specifying =popup-reference-buffers=: 266 | 267 | #+begin_src emacs-lisp 268 | (setq popper-reference-buffers 269 | '(("Output\\*$" . hide) 270 | (completion-list-mode . hide) 271 | occur-mode 272 | "\\*Messages\\*")) 273 | #+end_src 274 | 275 | This assignment will suppress all buffers ending in =Output*= and the Completions buffer. The other entries are treated as normal popups. 276 | 277 | You can combine the hiding feature with predicates for classifying buffers as popups: 278 | 279 | #+BEGIN_SRC emacs-lisp 280 | (defun popper-shell-output-empty-p (buf) 281 | (and (string-match-p "\\*Async Shell Command\\*" (buffer-name buf)) 282 | (= (buffer-size buf) 0))) 283 | 284 | (add-to-list 'popper-reference-buffers 285 | '(popper-shell-output-empty-p . hide)) 286 | #+END_SRC 287 | 288 | This assignment will suppress display of the async shell command output buffer, but only when there is no output (stdout). Once it is hidden it will be treated as a popup on par with other entries in =popper-reference-buffers=. 289 | 290 | ** Mode line and Echo area customization 291 | - To change the modeline string used by Popper (the default is "POP"), customize =popper-mode-line=. You can disable the modeline entirely by setting it to nil. 292 | - You can change the keys used to access popups when using =popper-echo-mode= by customizing the =popper-echo-dispatch-keys= variable. To retain the display while removing the keymap, set this variable to =nil=. 293 | - You can change the number of minibuffer lines used for display by =popper-echo-mode= by customizing =popper-echo-lines=. 294 | - If you want to change the buffer names displayed in the echo area in some way (such as to color them by mode or truncate long names), you can customize the variable =popper-echo-transform-function=. 295 | 296 | * Alternatives 297 | Packages like [[https://github.com/amno1/emacs-term-toggle][Term Toggle]] and [[https://github.com/4DA/eshell-toggle][eshell toggle]] give you an easy way to access a "dropdown" terminal. Popper can be used for this almost trivially, but it's a much more general solution for buffer management and access. 298 | 299 | Packages like [[https://depp.brause.cc/shackle/][Shackle]] help with specifying how certain buffers should be displayed, but don't give you an easy way to access them beyond calling display-buffer. Popper is mainly concerned with the latter and is thus more or less orthogonal to Shackle. Moreover, most window management packages for Emacs are opinionated in how windows should be displayed, or provide an additional API to customize this (e.g. [[https://github.com/emacsorphanage/popwin][Popwin]]). While Popper defaults to displaying popups a certain way, it tries to stay out of the business of display rules and focuses on providing one-key access to the buffers you're most likely to need next. 300 | * Technical notes 301 | =popper= uses a buffer local variable (=popper-popup-status=) to identify if a given buffer should be treated as a popup. Matching is always by buffer and not window, so having two windows of a buffer, one treated as a popup and one as a regular window, isn't possible (although you can do this with indirect clones). In addition, it maintains an alist of popup windows/buffers for cycling through. 302 | 303 | By default, it installs a single rule in =display-buffer-alist= to handle displaying popups. If =popper-display-control= is set to =nil=, this rule is ignored. You can change how the popups are shown by customizing =popper-display-function=, the function used by =display-buffer= to display popups, although you are better off customizing =display-buffer-alist= directly or using Shackle. 304 | 305 | -------------------------------------------------------------------------------- /images/popper-cycle.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/karthink/popper/49f4904480cf4ca5c6db83fcfa9e6ea8d4567d96/images/popper-cycle.gif -------------------------------------------------------------------------------- /images/popper-demote.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/karthink/popper/49f4904480cf4ca5c6db83fcfa9e6ea8d4567d96/images/popper-demote.gif -------------------------------------------------------------------------------- /images/popper-toggle-all.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/karthink/popper/49f4904480cf4ca5c6db83fcfa9e6ea8d4567d96/images/popper-toggle-all.gif -------------------------------------------------------------------------------- /images/popper-toggle-all.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/karthink/popper/49f4904480cf4ca5c6db83fcfa9e6ea8d4567d96/images/popper-toggle-all.png -------------------------------------------------------------------------------- /images/popper-toggle-latest.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/karthink/popper/49f4904480cf4ca5c6db83fcfa9e6ea8d4567d96/images/popper-toggle-latest.gif -------------------------------------------------------------------------------- /popper-echo.el: -------------------------------------------------------------------------------- 1 | ;;; popper-echo.el --- Show a popup list in the echo area when cycling them -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2023 Free Software Foundation, Inc. 4 | 5 | ;; Author: Karthik Chikmagalur 6 | ;; Version: 0.4.8 7 | ;; Package-Requires: ((emacs "26.1")) 8 | ;; Keywords: convenience 9 | ;; URL: https://github.com/karthink/popper 10 | 11 | ;; This file is NOT part of GNU Emacs. 12 | 13 | ;; This file is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation; either version 3, or (at your option) 16 | ;; any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; For a full copy of the GNU General Public License 24 | ;; see . 25 | 26 | ;;; Commentary: 27 | 28 | ;; This library provides two minor-modes to preview the list of relevant popup 29 | ;; names when toggling or cycling popups. These popups can be accessed directly 30 | ;; using dispatch keybinds. See Popper for how to classify a buffer as a popup. 31 | ;; 32 | ;; `popper-echo-mode' displays the list of popups in the echo area when toggling 33 | ;; or cycling popups. 34 | ;; 35 | ;; `popper-tab-line-mode' displays the list of popups in the tab-line of the 36 | ;; active popup when toggling or cycling them. NOTE: This feature is 37 | ;; experimental. 38 | 39 | ;; CUSTOMIZATION: 40 | 41 | ;; `popper-echo-lines': The number of echo area/minibuffer lines to use when 42 | ;; showing a list of popups 43 | ;; 44 | ;; `popper-echo-dispatch-keys': A list of strings or characters representing the 45 | ;; keybindings to access popups shown in the echo area or tab-line. 46 | ;; 47 | ;; `popper-echo-dispatch-persist': A boolean to control whether the dispatch 48 | ;; keymap stays active after using a dispatch key. 49 | ;; 50 | ;; `popper-echo-transform-function': A function to transform the display of 51 | ;; these popups, such as by truncating buffer names, etc. 52 | 53 | ;;; Code: 54 | 55 | (require 'popper) 56 | 57 | (defcustom popper-echo-transform-function nil 58 | "Function to transform buffer names. 59 | 60 | This is called on buffer-names displayed by `popper-echo'. 61 | 62 | This function should accept a string (the buffer name) and return 63 | a transformed string." 64 | :type '(choice (const :tag "Don't transform buffer-names" nil) 65 | function) 66 | :group 'popper) 67 | 68 | (defcustom popper-echo-lines 2 69 | "Number of minibuffer lines used to show popup buffer names by `popper-echo'. 70 | 71 | This has no effect when popper-echo-mode is turned off." 72 | :type 'integer 73 | :group 'popper) 74 | 75 | (defcustom popper-echo-dispatch-persist t 76 | "Controls whether the `popper-echo' dispatch menu is persistent." 77 | :type 'boolean 78 | :group 'popper) 79 | 80 | (defcustom popper-echo-dispatch-actions nil 81 | "Controls whether `popper-echo' dispatch actions are bound. 82 | 83 | When true, you can 84 | - Kill popup buffers with k 85 | - Raise popup buffers with ^ 86 | 87 | when using the dispatch menu by prefixing the dispatch keys with them. 88 | 89 | NOTE: This feature is experimental." 90 | :type 'boolean 91 | :group 'popper) 92 | 93 | (defcustom popper-echo-dispatch-keys '("M-0" "M-1" "M-2" "M-3" "M-4" 94 | "M-5" "M-6" "M-7" "M-8" "M-9") 95 | "List of keys used for dispatching to popup buffers. 96 | 97 | The first element is bound to the currently open popup. 98 | 99 | Each entry in the list can be a character or a string suitable 100 | for the kbd macro. These keys are available when using 101 | popper-echo-mode. 102 | 103 | Examples: 104 | \\='(?q ?w ?e ?r ?t ?y ?u ?i ?o ?p) 105 | \\='(\"M-1\" \"M-2\" \"M-3\" \"M-4\" \"M-5\") 106 | 107 | This variable has no effect when popper-echo-mode is turned 108 | off." 109 | :type '(repeat (choice character string)) 110 | :group 'popper) 111 | 112 | 113 | (defface popper-echo-area-buried 114 | '((t :inherit shadow)) 115 | "Echo area face for buried popups." 116 | :group 'popper) 117 | 118 | (defface popper-echo-area 119 | '((t :inverse-video t 120 | :weight bold)) 121 | "Echo area face for opened popup." 122 | :group 'popper) 123 | 124 | (defface popper-echo-dispatch-hint 125 | '((t :inherit bold)) 126 | "Echo area face for popper dispatch key hints." 127 | :group 'popper) 128 | 129 | ;;; Utility functions 130 | 131 | (defun popper-echo--dispatch-toggle (i buf-list repeat) 132 | "Return a function to switch to buffer I in list BUF-LIST. 133 | 134 | This is used to create functions for switching between popups 135 | quickly." 136 | (lambda (&optional arg) 137 | (interactive "P") 138 | (when-let* ((buf (nth i buf-list))) 139 | (unless arg (popper-close-latest)) 140 | (display-buffer buf) 141 | (popper--update-popups) 142 | (when popper-echo-dispatch-persist 143 | (with-current-buffer buf (funcall repeat)))))) 144 | 145 | (defun popper-echo--dispatch-kill (i buf-list repeat) 146 | "Return a function to Kill buffer I in list BUF-LIST." 147 | (lambda () 148 | (interactive) 149 | (let* ((buf (nth i buf-list)) 150 | (win (get-buffer-window buf))) 151 | (kill-buffer buf) 152 | (popper--delete-popup win)) 153 | (popper--update-popups) 154 | (when (and popper-echo-dispatch-persist 155 | popper-open-popup-alist) 156 | (with-current-buffer (cdar popper-open-popup-alist) 157 | (funcall repeat))))) 158 | 159 | (defun popper-echo--dispatch-raise (i buf-list repeat) 160 | "Return a function to raise buffer I in list BUF-LIST. 161 | 162 | Raising converts if from a popup to a regular buffer." 163 | (lambda () 164 | (interactive) 165 | (let* ((buf (nth i buf-list))) 166 | (popper-toggle-type buf)) 167 | (popper--update-popups) 168 | (when (and popper-echo-dispatch-persist 169 | popper-open-popup-alist) 170 | (with-current-buffer (cdar popper-open-popup-alist) 171 | (funcall repeat))))) 172 | 173 | (defun popper-echo--popup-info () 174 | "Return the popper group and list of buried popup buffers." 175 | (let ((grp-symb (when popper-group-function 176 | (funcall popper-group-function)))) 177 | (cons grp-symb 178 | (thread-last (alist-get grp-symb popper-buried-popup-alist nil nil 'equal) 179 | (mapcar #'cdr) 180 | (cl-remove-if-not #'buffer-live-p) 181 | (delete-dups))))) 182 | 183 | (defun popper-echo--activate-keymap (buffers repeat) 184 | "Activate a transient keymap to switch to or manipulate BUFFERS. 185 | 186 | Each command in the keymap calls the function REPEAT afterwards." 187 | (set-transient-map 188 | (cl-loop with map = (make-sparse-keymap) 189 | for i upto 9 190 | for keybind in popper-echo-dispatch-keys 191 | for rawkey = (cond ((characterp keybind) (char-to-string keybind)) 192 | (t keybind)) 193 | do 194 | (define-key map (kbd rawkey) (popper-echo--dispatch-toggle i buffers repeat)) 195 | (when popper-echo-dispatch-actions 196 | (define-key map (kbd (concat "k " rawkey)) 197 | (popper-echo--dispatch-kill i buffers repeat)) 198 | (define-key map (kbd (concat "^ " rawkey)) 199 | (popper-echo--dispatch-raise i buffers repeat))) 200 | finally return map))) 201 | 202 | ;;; Notify in echo area: 203 | (defun popper-echo () 204 | "Show popup list in the echo area when cycling popups." 205 | (pcase-let* 206 | ((message-log-max nil) 207 | (`(,grp-symb . ,buried-popups) (popper-echo--popup-info)) 208 | (buried-popups (mapcar #'buffer-name buried-popups)) 209 | (group (and grp-symb 210 | (concat "Group (" (truncate-string-to-width (format "%S" grp-symb) 20 nil nil t) "): "))) 211 | (open-popup (buffer-name)) 212 | (dispatch-keys-extended 213 | (append (cdr popper-echo-dispatch-keys) 214 | (make-list (max 0 (- (length buried-popups) 215 | (1- (length popper-echo-dispatch-keys)))) 216 | nil))) 217 | (popup-strings 218 | (apply #'concat 219 | (cons 220 | (if-let* ((transform popper-echo-transform-function)) 221 | (funcall transform open-popup) 222 | (propertize open-popup 'face 'popper-echo-area)) 223 | (cl-mapcar (lambda (key buf) 224 | (concat 225 | (propertize ", " 'face 'popper-echo-area-buried) 226 | (propertize "[" 'face 'popper-echo-area-buried) 227 | (and key 228 | (concat 229 | (propertize (if (characterp key) 230 | (char-to-string key) 231 | key) 232 | 'face 'popper-echo-dispatch-hint) 233 | (propertize ":" 'face 'popper-echo-area-buried))) 234 | (if-let* ((transform popper-echo-transform-function)) 235 | (funcall transform buf) 236 | (concat 237 | (propertize buf 'face 'popper-echo-area-buried))) 238 | (propertize "]" 'face 'popper-echo-area-buried))) 239 | dispatch-keys-extended 240 | buried-popups))))) 241 | (let* ((max-width (- (* popper-echo-lines (frame-width)) (if group (length group) 11))) 242 | (plen (length popup-strings)) 243 | (space-p (> max-width plen))) 244 | (message "%s" 245 | (concat 246 | (or group "Popups: ") 247 | (substring popup-strings 0 (if space-p plen max-width)) 248 | (unless space-p 249 | (propertize "..." 'face 'popper-echo-area-buried))))) 250 | (popper-echo--activate-keymap (cons open-popup buried-popups) #'popper-echo))) 251 | 252 | (defvar popper-tab-line-mode "popper-echo") 253 | 254 | ;;;###autoload 255 | (define-minor-mode popper-echo-mode 256 | "Toggle Popper Echo mode. 257 | Show popup names in cycling order in the echo area when 258 | performing an action that involves showing a popup. These popups 259 | can be accessed directly or acted upon by using quick keys (see 260 | `popper-echo-dispatch-keys'). 261 | 262 | To define buffers as popups and customize popup display, see 263 | `popper-mode'." 264 | :global t 265 | :lighter "" 266 | :group 'popper 267 | (if popper-echo-mode 268 | (progn 269 | (when popper-tab-line-mode 270 | (message "`popper-echo-mode'. is incompatible with `popper-tab-line-mode' Disabling `popper-tab-line-mode'.") 271 | (popper-tab-line-mode -1)) 272 | (add-hook 'popper-open-popup-hook 'popper-echo) 273 | (unless popper-mode (popper-mode 1))) 274 | (remove-hook 'popper-open-popup-hook 'popper-echo))) 275 | 276 | ;;; Notify using tab-line 277 | (declare-function tab-line-mode "tab-line") 278 | (declare-function tab-line-tab-name-format-default "tab-line") 279 | (defvar tab-line-tab-name-format-function) 280 | (defvar tab-line-tabs-function) 281 | (defvar tab-line-mode) 282 | 283 | (defun popper-tab-line--format (tab tabs) 284 | (let ((name (tab-line-tab-name-format-default tab tabs)) 285 | (idx (cl-position tab tabs))) 286 | (concat 287 | (propertize 288 | (char-to-string (+ idx #x2460)) ;; #x2776 289 | 'face (if (eq tab (current-buffer)) 290 | (if (mode-line-window-selected-p) 291 | 'tab-line-tab-current 'tab-line-tab) 292 | 'tab-line-tab-inactive)) 293 | name))) 294 | 295 | (defun popper-tab-line--ensure () 296 | (pcase-let ((`(_ . ,buried-popups) (popper-echo--popup-info))) 297 | (if (not buried-popups) 298 | (tab-line-mode -1) 299 | (unless tab-line-mode 300 | (setq-local 301 | tab-line-tabs-function 302 | (lambda () (cl-sort (cons (current-buffer) (cdr (popper-echo--popup-info))) 303 | #'string< :key #'buffer-name)) 304 | tab-line-tab-name-format-function #'popper-tab-line--format) 305 | (when popper-echo-transform-function 306 | (setq-local tab-line-tab-name-function 307 | (lambda (buf _) (funcall popper-echo-transform-function 308 | (buffer-name buf))))) 309 | (tab-line-mode 1))) 310 | (popper-echo--activate-keymap 311 | (cl-sort (cons (current-buffer) buried-popups) #'string< :key #'buffer-name) 312 | #'popper-tab-line--ensure))) 313 | 314 | ;;;###autoload 315 | (define-minor-mode popper-tab-line-mode 316 | "Toggle Popper Tab Line Mode. 317 | Show popup names in cycling order in the tab-line of the popup 318 | window when performing an action that involves showing a popup. 319 | These popups can be accessed directly or acted upon by using 320 | quick keys (see `popper-echo-dispatch-keys'). 321 | 322 | To define buffers as popups and customize popup display, see 323 | `popper-mode'." 324 | :global t 325 | :lighter "" 326 | :group 'popper 327 | (if popper-tab-line-mode 328 | (progn 329 | (require 'tab-line) 330 | (when popper-echo-mode 331 | (message "`popper-tab-line-mode' is incompatible with `popper-echo-mode'. Disabling `popper-echo-mode'.") 332 | (popper-echo-mode -1)) 333 | (add-hook 'popper-open-popup-hook #'popper-tab-line--ensure) 334 | (unless popper-mode (popper-mode 1))) 335 | (remove-hook 'popper-open-popup-hook #'popper-tab-line--ensure) 336 | ;; Clear tab-lines 337 | (mapc 338 | (pcase-lambda (`(_ . ,buf)) 339 | (when (buffer-live-p buf) 340 | (with-current-buffer buf 341 | (kill-local-variable 'tab-line-tabs-function) 342 | (kill-local-variable 'tab-line-tab-name-format-function) 343 | (unless global-tab-line-mode (tab-line-mode -1))))) 344 | (mapcan #'cdr (cons (cons nil popper-open-popup-alist) 345 | popper-buried-popup-alist))) 346 | (force-mode-line-update))) 347 | 348 | (provide 'popper-echo) 349 | ;;; popper-echo.el ends here 350 | -------------------------------------------------------------------------------- /popper.el: -------------------------------------------------------------------------------- 1 | ;;; popper.el --- Summon and dismiss buffers as popups -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2023 Free Software Foundation, Inc. 4 | 5 | ;; Author: Karthik Chikmagalur 6 | ;; Version: 0.4.8 7 | ;; Package-Requires: ((emacs "26.1")) 8 | ;; Keywords: convenience 9 | ;; URL: https://github.com/karthink/popper 10 | 11 | ;; This file is NOT part of GNU Emacs. 12 | 13 | ;; This file is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation; either version 3, or (at your option) 16 | ;; any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; For a full copy of the GNU General Public License 24 | ;; see . 25 | ;; 26 | ;;; Commentary: 27 | 28 | ;; Popper is a minor-mode to tame the flood of ephemeral windows Emacs 29 | ;; produces, while still keeping them within arm's reach. Designate any 30 | ;; buffer to "popup" status, and it will stay out of your way. Disimss 31 | ;; or summon it easily with one key. Cycle through all your "popups" or 32 | ;; just the ones relevant to your current buffer. Useful for many 33 | ;; things, including toggling display of REPLs, documentation, 34 | ;; compilation or shell output, etc. 35 | ;; 36 | ;; For a demo describing usage and customization see 37 | ;; https://www.youtube.com/watch?v=E-xUNlZi3rI 38 | 39 | ;;;; Commands: 40 | 41 | ;; `popper-mode': Turn on popup management 42 | ;; `popper-toggle': Toggle latest popup 43 | ;; `popper-cycle': Cycle through all popups, or close all open popups 44 | ;; `popper-toggle-type': Turn a regular window into a popup or vice-versa 45 | ;; `popper-kill-latest-popup': Kill latest open popup 46 | 47 | ;;;; Customization: 48 | 49 | ;; `popper-reference-buffers': A list of major modes or regexps whose 50 | ;; corresponding buffer major-modes or regexps (respectively) should be 51 | ;; treated as popups. 52 | ;; 53 | ;; `popper-mode-line': String or sexp to show in the mode-line of 54 | ;; popper. Setting this to nil removes the mode-line entirely from 55 | ;; popup buffers. 56 | ;; 57 | ;; `popper-group-function': Function that returns the context a popup 58 | ;; should be shown in. The context is a string or symbol used to group 59 | ;; together a set of buffers and their associated popups, such as the 60 | ;; project root. Customize for available options. 61 | ;; 62 | ;; `popper-display-control': This package summons windows defined by the 63 | ;; user as popups by simply calling `display-buffer'. By default, 64 | ;; it will display your popups in a non-obtrusive way. If you want 65 | ;; Popper to display popups according to window rules you specify in 66 | ;; `display-buffer-alist' (or through a package like Shackle), set this 67 | ;; variable to nil. 68 | ;; 69 | ;; There are other customization options, such as the ability to suppress 70 | ;; certain popups and keep them from showing. Please customize the popper group 71 | ;; for details. 72 | 73 | ;;; Code: 74 | 75 | (eval-when-compile 76 | (require 'subr-x)) 77 | (require 'cl-lib) 78 | (require 'seq) 79 | 80 | (declare-function project-root "project") 81 | (declare-function project-current "project") 82 | (declare-function projectile-project-root "projectile") 83 | (declare-function persp-current-name "perspective") 84 | 85 | (defvar popper-mode) 86 | 87 | (defgroup popper nil 88 | "Provide functions for easy access to popup windows." 89 | :group 'convenience) 90 | 91 | ;; If you are interested in depending on Compat, you could use 92 | ;; `buffer-match-p' here. 93 | (defcustom popper-reference-buffers '("\\*Messages\\*$") 94 | "List of buffers to treat as popups. 95 | Each entry in the list can be a regexp (string) to match buffer 96 | names against, or a `major-mode' (symbol) to match buffer 97 | major-modes against, or a predicate of one argument (a buffer). 98 | 99 | Examples: 100 | 101 | \\='(\"\\*Messages\\*\" 102 | \"Output\\*$\" 103 | help-mode 104 | compilation-mode) 105 | 106 | Will match against the Messages buffer, any buffer ending in 107 | Output*, and all help and compilation buffers. 108 | 109 | \\='(\"\\*Messages\\*\" 110 | help-mode 111 | (lambda (buf) (with-current-buffer buf 112 | (and (derived-mode-p \\='fundamental-mode) 113 | (< (count-lines (point-min) (point-max)) 114 | 10))))) 115 | 116 | will match against the Messages buffer, all help buffers and any 117 | buffer with major-mode derived from fundamental mode that has 118 | fewer than 10 lines at time of creation. 119 | 120 | It can also be a cons cell whose car is any of the above and 121 | whose cdr is the symbol `hide', in which case matching popup 122 | buffers will be suppressed when they are first created." 123 | :type '(repeat 124 | (choice (string :tag "Buffer name regexp") 125 | (symbol :tag "Major mode") 126 | (function :tag "Predicate Function") 127 | (cons (choice (regexp :tag "Buffer name regexp") 128 | (symbol :tag "Major mode") 129 | (function :tag "Predicate function")) 130 | (const :tag "Hide" hide))))) 131 | 132 | (defcustom popper-mode-line '(:eval (propertize " POP" 'face 'mode-line-emphasis)) 133 | "String or sexp to show in the mode-line of popper. 134 | 135 | Can be a quoted list or function. Setting this to nil removes 136 | the mode-line entirely from popup buffers." 137 | :type '(choice (const :tag "Off" nil) 138 | (string :tag "Literal text") 139 | (sexp :tag "General `mode-line-format' entry"))) 140 | 141 | (defcustom popper-mode-line-position 0 142 | "Position in mode-line to place `popper-mode-line'." 143 | :type 'integer) 144 | 145 | (defcustom popper-display-control t 146 | "Whether popper should control the placement of popup windows. 147 | Choices are: 148 | \\='user: The default. Only control placement of explicitly marked popups. 149 | nil : Do not control popup placement. 150 | t : Control placement of all popups." 151 | :type '(choice (const :tag "Explicitly set popups only" user) 152 | (const :tag "All popups" t) 153 | (const :tag "Never" nil))) 154 | 155 | (defcustom popper-display-function #'popper-select-popup-at-bottom 156 | "Function to use to display popper. 157 | 158 | Note that this is only invoked when 159 | `popper-display-control' is non-nil. 160 | 161 | This function accepts two arguments, a buffer and (optional) an 162 | action alist and displays the buffer. See (info \"(elisp) Buffer 163 | Display Action Alists\") for details on the alist." 164 | :type 'function) 165 | 166 | (defcustom popper-group-function nil 167 | "Function that returns a popup context. 168 | 169 | When set to nil popups are not grouped by context. 170 | 171 | This function is called with no arguments and should return a 172 | string or symbol identifying a popup buffer's group. This 173 | identifier is used to associate popups with regular buffers (such 174 | as by project, directory, or `major-mode') so that popup-cycling 175 | from a regular buffer is restricted to its associated group. 176 | 177 | Built-in choices include 178 | 179 | `popper-group-by-directory': Return project root or default directory. 180 | `popper-group-by-project': Return project root using project.el. 181 | `popper-group-by-projectile': Return project root using projectile. 182 | `popper-group-by-perspective': Return perspective name." 183 | :type '(choice 184 | (const :tag "Don't group popups" nil) 185 | (const :tag "Group by project (project.el)" popper-group-by-project) 186 | (const :tag "Group by project (projectile)" popper-group-by-projectile) 187 | (const :tag "Group by perspective" popper-group-by-perspective) 188 | (const :tag "Group by directory" popper-group-by-directory) 189 | (function :tag "Custom function"))) 190 | 191 | (defcustom popper-window-height #'popper--fit-window-height 192 | "Specify the height of the popup window. 193 | 194 | This can be a number representing the height in chars or a 195 | function that optionally takes one argument (the popup window) 196 | and returns the height in chars. This option is ignored when 197 | `popper-display-control' is set to nil. 198 | 199 | Examples: 200 | 201 | ;; Popup windows are always 20 chars tall 202 | 20 203 | 204 | ;; The default, scale window height with buffer size up to 33% of 205 | the frame height. 206 | (lambda (win) 207 | (fit-window-to-buffer 208 | win 209 | (floor (frame-height) 3)))" 210 | :type '(choice (integer :tag "Height in chars") 211 | (function :tag "Height function"))) 212 | 213 | (defcustom popper-open-popup-hook nil 214 | "Hook run when a popup is opened. 215 | 216 | Each function in the hook is called with the opened popup-buffer 217 | as current." 218 | :type 'hook) 219 | 220 | (defvar popper--reference-names nil 221 | "List of buffer names whose windows are treated as popups.") 222 | 223 | (defvar popper--reference-modes nil 224 | "List of buffer major-modes whose buffers are treated as popups.") 225 | 226 | (defvar popper--reference-predicates nil 227 | "List of predicates to test if a buffer is treated as a popup. 228 | 229 | Each predicate takes a buffer as an argument and returns t if it 230 | should be considered a popup") 231 | 232 | (defvar popper--suppressed-names nil 233 | "Buffer name list matching suppressed popup buffers.") 234 | 235 | (defvar popper--suppressed-modes nil 236 | "Major mode list matching suppressed popup buffers.") 237 | 238 | (defvar popper--suppressed-predicates nil 239 | "Predicate list matching suppressed popup buffers.") 240 | 241 | (defvar popper-open-popup-alist nil 242 | "Alist of currently live (window . buffer)s that are treated as popups.") 243 | 244 | (defvar popper-buried-popup-alist nil 245 | "Alist of currently buried (window . buffer)s that are treated as popups. 246 | 247 | If `popper-group-function' is non-nil, these are 248 | grouped by the predicate `popper-group-function'.") 249 | 250 | (defvar-local popper-popup-status nil 251 | "Identifies a buffer as a popup by its buffer-local value. 252 | Valid values are \\='popup, \\='raised, \\='user-popup or nil. 253 | 254 | \\='popup : This is a popup buffer specified in `popper-reference-buffers'. 255 | \\='raised : This is a POPUP buffer raised to regular status by the user. 256 | \\='user-popup: This is a regular buffer lowered to popup status by the user.") 257 | 258 | (defun popper--fit-window-height (win) 259 | "Determine the height of popup window WIN by fitting it to the buffer's content." 260 | (fit-window-to-buffer 261 | win 262 | (floor (frame-height) 3) 263 | (floor (frame-height) 6))) 264 | 265 | (defun popper-select-popup-at-bottom (buffer &optional alist) 266 | "Display and switch to popup-buffer BUFFER at the bottom of the screen. 267 | ALIST is an association list of action symbols and values. See 268 | Info node `(elisp) Buffer Display Action Alists' for details of 269 | such alists." 270 | (let ((window (popper-display-popup-at-bottom buffer alist))) 271 | (select-window window))) 272 | 273 | (defun popper-display-popup-at-bottom (buffer &optional alist) 274 | "Display popup-buffer BUFFER at the bottom of the screen. 275 | ALIST is an association list of action symbols and values. See 276 | Info node `(elisp) Buffer Display Action Alists' for details of 277 | such alists." 278 | (display-buffer-in-side-window 279 | buffer 280 | (append alist 281 | `((window-height . ,popper-window-height) 282 | (side . bottom) 283 | (slot . 0))))) 284 | 285 | (defun popper-popup-p (buf) 286 | "Predicate to test if buffer BUF qualifies for popper handling. 287 | Criteria are listed in `popper-reference-buffers'." 288 | (or (seq-some (lambda (buf-regexp) 289 | (string-match-p buf-regexp (buffer-name buf))) 290 | popper--reference-names) 291 | (member (buffer-local-value 'major-mode buf) popper--reference-modes) 292 | (seq-some (lambda (pred) (funcall pred buf)) popper--reference-predicates))) 293 | 294 | (defun popper-display-control-p (buf &optional _act) 295 | "Predicate to test if display of buffer BUF needs to be handled by popper. 296 | 297 | This is intended to be used in `display-buffer-alist'." 298 | (let ((buffer (if (bufferp buf) buf (get-buffer buf)))) 299 | (pcase popper-display-control 300 | ('user 301 | (with-current-buffer buffer 302 | (eq popper-popup-status 'user-popup))) 303 | ('t (with-current-buffer buffer 304 | (or (memq popper-popup-status '(popup user-popup)) 305 | (unless (eq popper-popup-status 'raised) 306 | (popper-popup-p buffer)))))))) 307 | 308 | (defun popper-group-by-directory () 309 | "Return an identifier (default directory) to group popups. 310 | 311 | The project root is used if found by project, with the default 312 | directory as a fall back." 313 | (or (and (fboundp 'project-root) 314 | (when-let* ((project (project-current))) 315 | (project-root project))) 316 | (expand-file-name default-directory))) 317 | 318 | (defun popper-group-by-project () 319 | "Return an identifier (project root) to group popups." 320 | (unless (fboundp 'project-root) 321 | (user-error "Cannot find project directory to group popups. \ 322 | Please install `project' or customize \ 323 | `popper-group-function'")) 324 | (when-let* ((project (project-current))) 325 | (project-root project))) 326 | 327 | (defun popper-group-by-projectile () 328 | "Return an identifier to group popups. 329 | 330 | This returns the project root found using the projectile package." 331 | (unless (fboundp 'projectile-project-root) 332 | (user-error "Cannot find project directory to group popups. \ 333 | Please install `projectile' or customize 334 | `popper-group-function'")) 335 | (projectile-project-root)) 336 | 337 | (defun popper-group-by-perspective () 338 | "Return an identifier to group popups. 339 | 340 | This returns the name of the perspective." 341 | (unless (fboundp 'persp-current-name) 342 | (user-error "Cannot find perspective name to group popups. \ 343 | Please install `perspective' or customize \ 344 | `popper-group-function'")) 345 | (persp-current-name)) 346 | 347 | (defun popper--find-popups (test-buffer-list) 348 | "Return an alist corresponding to popups in TEST-BUFFER-LIST. 349 | 350 | Each element of the alist is a cons cell of the form (window . buffer)." 351 | (let* (open-popups) 352 | (dolist (b test-buffer-list open-popups) 353 | (let ((popup-status (buffer-local-value 'popper-popup-status b))) 354 | (when (and (not (minibufferp b)) 355 | (not (eq popup-status 'raised)) 356 | (or (member popup-status '(popup user-popup)) 357 | (popper-popup-p b))) 358 | (with-current-buffer b 359 | (setq popper-popup-status (or popup-status 360 | (if (popper--suppress-p b) 361 | 'suppressed 362 | 'popup)))) 363 | (push (cons (get-buffer-window b) b) 364 | open-popups)))) 365 | (cl-sort open-popups 366 | (lambda (a b) (time-less-p b a)) 367 | :key (lambda (p) 368 | (buffer-local-value 'buffer-display-time 369 | (cdr p)))))) 370 | 371 | (defun popper--update-popups () 372 | "Update the list of currently open popups. 373 | 374 | Intended to be added to `window-configuration-change-hook'." 375 | (unless (frame-parent) 376 | (let* ((open-buffers (mapcar #'window-buffer (window-list nil 'no-mini))) 377 | (open-popups (popper--find-popups open-buffers)) 378 | (closed-popups (cl-remove-if-not 379 | (lambda (win-buf) 380 | (memq (buffer-local-value 'popper-popup-status (cdr win-buf)) 381 | '(popup user-popup))) 382 | (cl-set-difference popper-open-popup-alist open-popups :key #'cdr)))) 383 | (setq popper-open-popup-alist open-popups) 384 | ;; First remove all open popups that have been opened 385 | (cl-loop for (_ . buf) in open-popups do 386 | (let* ((group-name (when popper-group-function 387 | (with-current-buffer buf (funcall popper-group-function)))) 388 | (group-popups (cdr (assoc group-name popper-buried-popup-alist 'equal)))) 389 | (setf (alist-get group-name popper-buried-popup-alist 390 | nil nil 'equal) 391 | (cl-remove buf group-popups :key #'cdr)))) 392 | ;; Then add all popups that have been closed 393 | (cl-loop for (win . buf) in closed-popups do 394 | (let* ((group-name (when popper-group-function 395 | (with-current-buffer buf (funcall popper-group-function)))) 396 | (group-popups (cdr (assoc group-name popper-buried-popup-alist 'equal))) 397 | (newpop (cons win buf))) 398 | (setf (alist-get group-name popper-buried-popup-alist 399 | nil nil 'equal) 400 | (append (list newpop) 401 | (cl-remove newpop group-popups :key 'cdr)))))) 402 | ;; Mode line update 403 | (cl-loop for (_ . buf) in popper-open-popup-alist do 404 | (with-current-buffer buf 405 | (setq mode-line-format (popper--modified-mode-line)))))) 406 | 407 | (defun popper--find-buried-popups () 408 | "Update the list of currently buried popups. 409 | 410 | Meant to be run when starting command `popper-mode'." 411 | (let ((buried-popups (popper--find-popups 412 | (cl-set-difference 413 | (buffer-list) 414 | (mapcar #'window-buffer 415 | (window-list)))))) 416 | (if popper-group-function 417 | (cl-loop for (win . buf) in buried-popups do 418 | (push (cons win buf) 419 | (alist-get 420 | (with-current-buffer buf 421 | (funcall popper-group-function)) 422 | popper-buried-popup-alist 423 | nil nil 'equal))) 424 | (setq popper-buried-popup-alist 425 | (list (cons nil buried-popups)))))) 426 | 427 | (defun popper-close-latest () 428 | "Close the last opened popup." 429 | (unless popper-mode (user-error "Popper-mode not active!")) 430 | (if (null popper-open-popup-alist) 431 | (message "No open popups!") 432 | (cl-destructuring-bind ((win . buf) . rest) popper-open-popup-alist 433 | (let ((group (when popper-group-function 434 | (with-current-buffer buf 435 | (funcall popper-group-function))))) 436 | (unless (cl-member buf 437 | (cdr (assoc group popper-buried-popup-alist)) 438 | :key 'cdr) 439 | ;; buffer doesn't already exist in the buried popup list 440 | (push (cons nil buf) (alist-get group 441 | popper-buried-popup-alist 442 | nil nil 'equal)))) 443 | (pop popper-open-popup-alist) 444 | (with-selected-window win 445 | ;; (bury-buffer) ;; Unnecessary when using quit-window 446 | ;;only close window when window has a parent or in a child frame: 447 | (popper--delete-popup win))))) 448 | 449 | (defun popper-open-latest (&optional group) 450 | "Open the last closed popup. 451 | 452 | Optional argument GROUP is called with no arguments to select 453 | a popup buffer to open." 454 | (unless popper-mode (user-error "Popper-mode not active!")) 455 | (let* ((identifier (when popper-group-function group)) 456 | (no-popup-msg (format "No buried popups for group %s" 457 | (if (symbolp identifier) 458 | (symbol-name identifier) 459 | identifier)))) 460 | (if (null (alist-get identifier popper-buried-popup-alist 461 | nil 'remove 'equal)) 462 | (message (if identifier no-popup-msg "No buried popups")) 463 | (if-let* ((new-popup (pop (alist-get identifier popper-buried-popup-alist 464 | nil 'remove 'equal))) 465 | (buf (cdr new-popup))) 466 | (if (not (buffer-live-p buf)) 467 | (popper-open-latest group) 468 | (display-buffer buf) 469 | (with-current-buffer buf 470 | (run-hooks 'popper-open-popup-hook))) 471 | (message no-popup-msg))))) 472 | 473 | (defun popper--delete-popup (win) 474 | "Delete popup window WIN in a manner appropriate to its type." 475 | (when (window-valid-p win) 476 | (cond 477 | ((window-parent win) 478 | ;; FIXME Possibly a bad idea to mess with atomic windows 479 | (when (window-parameter win 'window-atom) 480 | (set-window-parameter win 'window-atom nil)) 481 | ;; Kludge. Side windows and regular windows are handled differently. The 482 | ;; latter is still somewhat broken. This is a bad idea. 483 | (if (window-parameter win 'window-side) 484 | (delete-window win) 485 | (quit-window nil win))) 486 | ((frame-parent) (delete-frame)) 487 | (t (quit-window nil win))))) 488 | 489 | (defun popper--modified-mode-line () 490 | "Return modified mode-line string." 491 | (when popper-mode-line 492 | (if (consp mode-line-format) 493 | (if (member popper-mode-line mode-line-format) 494 | mode-line-format 495 | (append (cl-subseq (default-value 'mode-line-format) 0 popper-mode-line-position) 496 | (list popper-mode-line 497 | (nthcdr popper-mode-line-position 498 | (default-value 'mode-line-format))))) 499 | mode-line-format))) 500 | 501 | (defun popper--restore-mode-lines (win-buf-alist) 502 | "Restore the default value of `mode-line-format'. 503 | 504 | This applies to popup-buffers in the list WIN-BUF-ALIST." 505 | (dolist (buf (mapcar 'cdr win-buf-alist)) 506 | (when (buffer-live-p buf) 507 | (with-current-buffer buf 508 | (setq mode-line-format (default-value 'mode-line-format)) 509 | (force-mode-line-update))))) 510 | 511 | (defun popper--bury-all () 512 | "Bury all open popups." 513 | (while popper-open-popup-alist 514 | (popper-close-latest))) 515 | 516 | (defun popper--open-all () 517 | "Open all popups. 518 | 519 | Note that buffers that are displayed in the same position on 520 | the screen by `display-buffer' will not all be displayed." 521 | (let ((group (when popper-group-function 522 | (funcall popper-group-function)))) 523 | (while (alist-get group popper-buried-popup-alist nil nil 'equal) 524 | (popper-open-latest group)))) 525 | 526 | (defun popper-toggle (&optional arg) 527 | "Toggle visibility of the last opened popup window. 528 | 529 | With prefix ARG \\[universal-argument], toggle visibility of the 530 | next popup windows while keeping the current one (FIXME: This 531 | behavior can be inconsistent.) 532 | 533 | With a double prefix ARG \\[universal-argument] 534 | \\[universal-argument], toggle all popup-windows. Note that only 535 | one buffer can be show in one slot, so it will display as many 536 | windows as it can." 537 | (interactive "p") 538 | (let ((group (when popper-group-function 539 | (funcall popper-group-function)))) 540 | (if popper-open-popup-alist 541 | (pcase arg 542 | (4 (popper-open-latest group)) 543 | (16 (popper--bury-all)) 544 | (_ (popper-close-latest))) 545 | (if (equal arg 16) 546 | (popper--open-all) 547 | (popper-open-latest group))))) 548 | 549 | (define-obsolete-function-alias 550 | 'popper-toggle-latest #'popper-toggle "0.4.6") 551 | 552 | (defun popper-cycle (&optional num) 553 | "Cycle visibility of popup windows one at a time. 554 | 555 | If numeric prefix argument NUM is negative, cycle backwards. 556 | 557 | If NUM is 0, cycle through popups belonging to the default 558 | group." 559 | (interactive "p") 560 | (let* ((group (when (and popper-group-function 561 | (not (equal num 0))) 562 | (funcall popper-group-function)))) 563 | (if (null popper-open-popup-alist) 564 | (popper-open-latest group) 565 | (if (null (alist-get group popper-buried-popup-alist nil nil 'equal)) 566 | (popper--bury-all) ; starting new cycle, so bury everything first. 567 | ;; cycle through buffers 568 | (popper-close-latest) 569 | (let ((bufs (cdr (assoc group popper-buried-popup-alist)))) 570 | (setf (alist-get group popper-buried-popup-alist nil nil 'equal) 571 | (if (> num 0) 572 | (append (cdr bufs) (cons (car bufs) nil)) 573 | (append (last bufs) (butlast bufs))))) 574 | (popper-open-latest group))))) 575 | 576 | (defun popper-cycle-backwards (&optional num) 577 | "Cycle visibility of popup windows backwards, one at a time. 578 | 579 | See `popper-cycle' for NUM and details." 580 | (interactive "p") 581 | (popper-cycle (- num))) 582 | 583 | (defun popper-raise-popup (&optional buffer) 584 | "Raise a popup to regular status. 585 | If BUFFER is not specified,raise the current buffer." 586 | (when-let* ((buf (get-buffer (or buffer (current-buffer))))) 587 | (with-current-buffer buf 588 | (if (popper-popup-p buf) 589 | (setq popper-popup-status 'raised) 590 | (setq popper-popup-status nil)) 591 | (setq mode-line-format (default-value 'mode-line-format))) 592 | (quit-window nil (get-buffer-window buf)) 593 | (pop-to-buffer buf))) 594 | 595 | (defun popper-lower-to-popup (&optional buffer) 596 | "Turn a regular buffer BUFFER into a popup. 597 | 598 | If BUFFER is not specified act on the current buffer instead." 599 | (let ((buf (get-buffer (or buffer (current-buffer))))) 600 | (with-current-buffer buf 601 | (setq popper-popup-status (if (popper-popup-p buf) 602 | 'popup 603 | 'user-popup)) 604 | (quit-window nil (get-buffer-window buf t)) 605 | (pop-to-buffer buf)) 606 | (popper--update-popups))) 607 | 608 | (defun popper-toggle-type (&optional buffer) 609 | "Turn a popup buffer BUFFER into a regular window or vice-versa. 610 | 611 | If BUFFER is not specified act on the current buffer instead." 612 | (interactive) 613 | (let* ((buf (get-buffer (or buffer (current-buffer)))) 614 | (popup-status (buffer-local-value 'popper-popup-status buf))) 615 | (pcase popup-status 616 | ((or 'popup 'user-popup) (popper-raise-popup buf)) 617 | (_ (popper-lower-to-popup buf))))) 618 | 619 | (defun popper-kill-latest-popup () 620 | "Kill the latest popup-buffer and delete its window." 621 | (interactive) 622 | (pcase (pop popper-open-popup-alist) 623 | (`(,win . ,buf) 624 | (popper--delete-popup win) 625 | (kill-buffer buf)) 626 | (_ 627 | (message "No open popups!")))) 628 | 629 | (defun popper--suppress-p (buf) 630 | "Predicate to check if popup-buffer BUF needs to be suppressed." 631 | (or (seq-some (lambda (buf-regexp) 632 | (string-match-p buf-regexp (buffer-name buf))) 633 | popper--suppressed-names) 634 | (member (buffer-local-value 'major-mode buf) popper--suppressed-modes) 635 | (seq-some (lambda (pred) (funcall pred buf)) popper--suppressed-predicates))) 636 | 637 | (defun popper--suppress-popups () 638 | "Suppress open popups in the user-defined `popper-suppress-buffers' list. 639 | This should run after `popper--update-popups' in 640 | `window-configuration-change-hook'." 641 | ;; Check if popup-status for any open popup is 'suppressed. If yes, change 642 | ;; its popup-status to 'popup and hide it. 643 | (let ((configuration-changed-p)) 644 | (cl-loop for (win . buf) in popper-open-popup-alist do 645 | (when (eq (buffer-local-value 'popper-popup-status buf) 'suppressed) 646 | (setq configuration-changed-p t) 647 | (with-selected-window win 648 | (setq-local popper-popup-status 'popup) 649 | ;; If window was previously showing a different buffer, switch to it 650 | (if-let* ((wpb (window-prev-buffers win)) 651 | (switch-to-buffer-preserve-window-point t)) 652 | (switch-to-buffer (caar wpb)) 653 | ;; otherwise kill this window/frame 654 | (popper--delete-popup win)) 655 | (message (format "Popup suppressed: %s" (buffer-name buf)))))) 656 | (when configuration-changed-p 657 | (popper--update-popups)))) 658 | 659 | (defun popper--set-reference-vars () 660 | "Unpack `popper-reference-buffers' to set popper--reference- variables." 661 | (cl-labels ((popper--classify-type 662 | (elm) (pcase-exhaustive elm 663 | ((pred stringp) 'name) 664 | ((and (pred symbolp) 665 | (guard (or (memq 'derived-mode-parent (symbol-plist elm)) 666 | (memq 'mode-class (symbol-plist elm)) 667 | (string= "-mode" (substring (symbol-name elm) -5))))) 668 | 'mode) 669 | ((pred functionp) 'pred) 670 | ((pred consp) 'cons))) 671 | (popper--insert-type 672 | (elm) (pcase-exhaustive (popper--classify-type elm) 673 | ('name (cl-pushnew elm popper--reference-names)) 674 | ('mode (cl-pushnew elm popper--reference-modes)) 675 | ('pred (cl-pushnew elm popper--reference-predicates)) 676 | ('cons (when (eq (cdr elm) 'hide) 677 | (pcase-exhaustive (popper--classify-type (car elm)) 678 | ('name (cl-pushnew (car elm) popper--suppressed-names)) 679 | ('mode (cl-pushnew (car elm) popper--suppressed-modes)) 680 | ('pred (cl-pushnew (car elm) popper--suppressed-predicates)))) 681 | (popper--insert-type (car elm)))))) 682 | (dolist (entry popper-reference-buffers nil) 683 | (popper--insert-type entry)))) 684 | 685 | ;;;###autoload 686 | (define-minor-mode popper-mode 687 | "Toggle Popper mode. 688 | When enabled, treat certain buffer windows as popups, a class of 689 | window that can be summoned or dismissed with a command. See the 690 | customization options for details on how to designate buffer 691 | types as popups." 692 | :global t 693 | :version "0.4.5" 694 | :lighter "" 695 | :group 'popper 696 | :keymap (let ((map (make-sparse-keymap))) map) 697 | (if popper-mode 698 | ;; Turning the mode ON 699 | (progn 700 | (popper--set-reference-vars) 701 | (popper--find-buried-popups) 702 | (popper--update-popups) 703 | ;; popper--suppress-popups should run after popper--update-popups, so it's 704 | ;; added first. 705 | (add-hook 'window-configuration-change-hook #'popper--suppress-popups) 706 | (add-hook 'window-configuration-change-hook #'popper--update-popups) 707 | (add-hook 'select-frame-hook #'popper--update-popups) 708 | (add-to-list 'display-buffer-alist 709 | `(popper-display-control-p 710 | (,popper-display-function)))) 711 | ;; Turning the mode OFF 712 | (remove-hook 'window-configuration-change-hook #'popper--update-popups) 713 | (remove-hook 'window-configuration-change-hook #'popper--suppress-popups) 714 | (remove-hook 'select-frame-hook #'popper--update-popups) 715 | (cl-loop for (_ . win-buf-alist) in popper-buried-popup-alist do 716 | (popper--restore-mode-lines win-buf-alist)) 717 | (popper--restore-mode-lines popper-open-popup-alist) 718 | ;; TODO: Clean this up 719 | (setq popper-buried-popup-alist nil 720 | popper-open-popup-alist nil 721 | popper--reference-names nil 722 | popper--reference-modes nil 723 | popper--reference-predicates nil 724 | popper--suppressed-names nil 725 | popper--suppressed-modes nil 726 | popper--suppressed-predicates nil) 727 | (setq display-buffer-alist 728 | (cl-remove 'popper-display-control-p 729 | display-buffer-alist 730 | :key 'car)))) 731 | 732 | (provide 'popper) 733 | ;;; popper.el ends here 734 | --------------------------------------------------------------------------------