├── .gitignore ├── LICENSE ├── README.md └── makey.el /.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.md: -------------------------------------------------------------------------------- 1 | makey 2 | ===== 3 | 4 | This library is a standalone version of the popup system that (used!) to power older versions of Magit. It still works fine, but there are two excellent libraries you may wish to use instead: 5 | 6 | Magit-Popup: 7 | https://github.com/magit/magit-popup 8 | 9 | Transient: 10 | https://github.com/magit/transient 11 | 12 | -------------------------------------------------------------------------------- /makey.el: -------------------------------------------------------------------------------- 1 | ;;; makey.el --- interactive commandline mode 2 | 3 | ;; Copyright (C) 2010-2013 The Magit Project Developers. 4 | ;; Copyright (C) 2013 Mickey Petersen 5 | 6 | ;; Author: Mickey Petersen 7 | ;; Keywords: 8 | ;; Version: 0.3 9 | ;; Package-Requires: ((cl-lib "0.2")) 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; 27 | 28 | ;;; Code: 29 | 30 | (eval-when-compile (require 'cl-lib)) 31 | 32 | (defvar makey-key-mode-keymaps) 33 | (defvar makey-key-mode-last-buffer) 34 | (defvar makey-pre-key-mode-window-conf) 35 | 36 | ;;; Options 37 | 38 | (defcustom makey-key-mode-show-usage t 39 | "Whether to show usage information when entering a popup." 40 | :group 'makey 41 | :type 'boolean) 42 | 43 | ;;; Faces 44 | 45 | (defface makey-key-mode-header-face 46 | '((t :inherit font-lock-keyword-face)) 47 | "Face for key mode header lines." 48 | :group 'makey-faces) 49 | 50 | (defface makey-key-mode-button-face 51 | '((t :inherit font-lock-builtin-face)) 52 | "Face for key mode buttons." 53 | :group 'makey-faces) 54 | 55 | (defface makey-key-mode-switch-face 56 | '((t :inherit font-lock-warning-face)) 57 | "Face for key mode switches." 58 | :group 'makey-faces) 59 | 60 | (defface makey-key-mode-args-face 61 | '((t :inherit widget-field)) 62 | "Face for key mode switch arguments." 63 | :group 'makey-faces) 64 | 65 | (defun makey-key-mode-delete-group (group master-group) 66 | "Delete a group from MASTER-GROUP" 67 | (let ((items (assoc group master-group))) 68 | (when items 69 | ;; reset the cache 70 | (setq makey-key-mode-keymaps nil) 71 | ;; delete the whole group 72 | (setq master-group 73 | (delq items master-group)) 74 | ;; unbind the defun 75 | (makey-key-mode-de-generate group)) 76 | master-group)) 77 | 78 | (defun makey-key-mode-add-group (group master-group) 79 | "Add a new group to MASTER-GROUP 80 | If there already is a group of that name then this will 81 | completely remove it and put in its place an empty one of the 82 | same name." 83 | (when (assoc group master-group) 84 | (makey-key-mode-delete-group group master-group)) 85 | (setq master-group 86 | (cons (list group (list 'actions) (list 'switches)) 87 | master-group))) 88 | 89 | (defun makey-key-mode-key-defined-p (for-group key) 90 | "Return t if KEY is defined as any option within FOR-GROUP 91 | The option may be a switch, argument or action." 92 | (catch 'result 93 | (let ((options (makey-key-mode-options-for-group for-group))) 94 | (dolist (type '(actions switches arguments)) 95 | (when (assoc key (if (eq type 'actions) 96 | (makey-get-actions options) 97 | (assoc type options))) 98 | (throw 'result t)))))) 99 | 100 | (defun makey-key-mode-update-group (for-group thing &rest args) 101 | "Abstraction for setting values in `makey-key-mode-keymaps'." 102 | (let* ((options (makey-key-mode-options-for-group for-group)) 103 | (things (assoc thing options)) 104 | (key (car args))) 105 | (if (cdr things) 106 | (if (makey-key-mode-key-defined-p for-group key) 107 | (error "%s is already defined in the %s group." key for-group) 108 | (setcdr (cdr things) (cons args (cddr things)))) 109 | (setcdr things (list args))) 110 | (setq makey-key-mode-keymaps nil) 111 | things)) 112 | 113 | (defun makey-key-mode-insert-argument (for-group key desc arg read-func) 114 | "Add a new binding KEY in FOR-GROUP which will use READ-FUNC 115 | to receive input to apply to argument ARG is run. DESC should 116 | be a brief description of the binding." 117 | (makey-key-mode-update-group for-group 'arguments key desc arg read-func)) 118 | 119 | (defun makey-key-mode-insert-switch (for-group key desc switch) 120 | "Add a new binding KEY in FOR-GROUP which will add SWITCH to the 121 | command line when it runs. DESC should be a brief description of 122 | the binding." 123 | (makey-key-mode-update-group for-group 'switches key desc switch)) 124 | 125 | (defun makey-key-mode-insert-action (for-group key desc func) 126 | "Add a new binding KEY in FOR-GROUP which will run command FUNC. 127 | DESC should be a brief description of the binding." 128 | (makey-key-mode-update-group for-group 'actions key desc func)) 129 | 130 | (defun makey-key-mode-options-for-group (for-group) 131 | "Retrieve the options for the group FOR-GROUP. 132 | This includes switches, commands and arguments." 133 | (funcall (intern (concat "makey-key-mode-options-for-" (symbol-name for-group))))) 134 | 135 | (defun makey-key-mode-help (for-group) 136 | "Provide help for a key within FOR-GROUP 137 | The user is prompted for the key." 138 | (let* ((opts (makey-key-mode-options-for-group for-group)) 139 | (man-page (cadr (assoc 'man-page opts))) 140 | (seq (read-key-sequence 141 | (format "Enter command prefix%s: " 142 | (if man-page 143 | (format ", `?' for man `%s'" man-page) 144 | "")))) 145 | (actions (makey-get-actions 146 | (makey-key-mode-options-for-group for-group)))) 147 | (cond 148 | ;; if it is an action popup the help for the to-be-run function 149 | ((assoc seq actions) (describe-function (nth 2 (assoc seq actions)))) 150 | ;; if there is "?" show a man page if there is one 151 | ((equal seq "?") 152 | (if man-page 153 | (man man-page) 154 | (error "No man page associated with `%s'" for-group))) 155 | (t (error "No help associated with `%s'" seq))))) 156 | 157 | (defun makey-key-mode-exec-at-point () 158 | "Run action/args/option at point." 159 | (interactive) 160 | (let ((key (or (get-text-property (point) 'key-group-executor) 161 | (error "Nothing at point to do.")))) 162 | (call-interactively (lookup-key (current-local-map) key)))) 163 | 164 | (defun makey-key-mode-jump-to-next-exec () 165 | "Jump to the next action/args/option point." 166 | (interactive) 167 | (let* ((oldp (point)) 168 | (old (get-text-property oldp 'key-group-executor)) 169 | (p (if (= oldp (point-max)) (point-min) (1+ oldp)))) 170 | (while (let ((new (get-text-property p 'key-group-executor))) 171 | (and (not (= p oldp)) (or (not new) (eq new old)))) 172 | (setq p (if (= p (point-max)) (point-min) (1+ p)))) 173 | (goto-char p) 174 | (skip-chars-forward " "))) 175 | 176 | ;;; Keymaps 177 | 178 | (defvar makey-key-mode-keymaps nil 179 | "This will be filled lazily with proper keymaps. 180 | These keymaps are created using `define-key' as they're requested.") 181 | 182 | (defun makey-key-mode-build-keymap (for-group) 183 | "Construct a normal looking keymap for the key mode to use. 184 | Put it in `makey-key-mode-keymaps' for fast lookup." 185 | (let* ((options (makey-key-mode-options-for-group for-group)) 186 | (actions (makey-get-actions options)) 187 | (switches (cdr (assoc 'switches options))) 188 | (lisp-switches (cdr (assoc 'lisp-switches options))) 189 | (arguments (cdr (assoc 'arguments options))) 190 | (lisp-arguments (cdr (assoc 'lisp-arguments options))) 191 | (map (make-sparse-keymap))) 192 | (suppress-keymap map 'nodigits) 193 | ;; ret dwim 194 | ;; (define-key map (kbd "RET") 'makey-key-mode-exec-at-point) 195 | ;; tab jumps to the next "button" 196 | ;; (define-key map (kbd "TAB") 'makey-key-mode-jump-to-next-exec) 197 | 198 | ;; all maps should `quit' with `C-g' or `q' 199 | (define-key map (kbd "C-g") `(lambda () 200 | (interactive) 201 | (makey-key-mode-command nil))) 202 | (define-key map (kbd "q") `(lambda () 203 | (interactive) 204 | (makey-key-mode-command nil))) 205 | ;; run help 206 | (define-key map (kbd "?") `(lambda () 207 | (interactive) 208 | (makey-key-mode-help ',for-group))) 209 | 210 | (let ((defkey (lambda (k action) 211 | ;; (when (and (lookup-key map (car k)) 212 | ;; (not (numberp (lookup-key map (car k))))) 213 | ;; (message "Warning: overriding binding for `%s' in %S" 214 | ;; (car k) for-group) 215 | ;; (ding) 216 | ;; (sit-for 2)) 217 | (define-key map (kbd (car k)) 218 | `(lambda () (interactive) ,action))))) 219 | (dolist (k lisp-switches) 220 | (funcall defkey k `(makey-key-mode-toggle-lisp-option 221 | ',for-group 222 | ;; name on-value off-value 223 | ',(nth 2 k) ',(nth 3 k) ',(nth 4 k)))) 224 | (dolist (k actions) 225 | (funcall defkey k `(makey-key-mode-command ',(nth 2 k)))) 226 | (dolist (k switches) 227 | (funcall defkey k `(makey-key-mode-toggle-option ',for-group ,(nth 2 k)))) 228 | 229 | (dolist (k lisp-arguments) 230 | (funcall defkey k `(makey-key-mode-add-lisp-variable 231 | ',for-group ,(nth 2 k) ',(nth 3 k)))) 232 | (dolist (k arguments) 233 | (funcall defkey k `(makey-key-mode-add-argument 234 | ',for-group ,(nth 2 k) ',(nth 3 k))))) 235 | 236 | (push (cons for-group map) makey-key-mode-keymaps) 237 | map)) 238 | 239 | ;;; Toggling and Running 240 | 241 | (defvar makey-key-mode-prefix nil 242 | "Prefix argument to the command that brought up the key-mode window. 243 | For internal use. Used by the command that's eventually invoked.") 244 | 245 | (defvar makey-key-mode-current-args nil 246 | "A hash-table of current argument set.") 247 | 248 | (defvar makey-key-mode-current-lisp-arguments nil 249 | "A hash-table of current lisp variables set. 250 | These will get let-bound when an action is called") 251 | 252 | (defvar makey-key-mode-current-lisp-options nil 253 | "Current lisp option set.") 254 | 255 | (defvar makey-key-mode-current-options nil 256 | "Current option set.") 257 | 258 | (defvar makey-custom-options nil 259 | "List of custom options to pass to the command line. 260 | Do not customize this (used in the `makey-key-mode' implementation).") 261 | 262 | (defun makey-key-mode-command (func) 263 | (let ((current-prefix-arg (or current-prefix-arg makey-key-mode-prefix)) 264 | (makey-custom-options makey-key-mode-current-options)) 265 | (maphash (lambda (k v) 266 | (push (concat k v) makey-custom-options)) 267 | makey-key-mode-current-args) 268 | (let ((local-let-cells '()) 269 | (current-variables (copy-hash-table makey-key-mode-current-lisp-arguments)) 270 | (current-lisp-switches (copy-alist makey-key-mode-current-lisp-options))) 271 | (set-window-configuration makey-pre-key-mode-window-conf) 272 | (kill-buffer makey-key-mode-last-buffer) 273 | (maphash (lambda (k v) 274 | (add-to-list 'local-let-cells 275 | (list (intern k) v))) 276 | current-variables) 277 | (dolist (lisp-option current-lisp-switches) 278 | (add-to-list 'local-let-cells (list (car lisp-option) 279 | (cdr lisp-option)))) 280 | (eval `(let* ,local-let-cells 281 | (when func 282 | (if (stringp func) 283 | ;; this adds keymap-style support for 284 | ;; self-inserted strings. 285 | (call-interactively 'self-insert-command nil [func]) 286 | (call-interactively func)))))))) 287 | 288 | 289 | (defun makey-key-mode-add-lisp-variable (for-group lisp-variable-name input-func) 290 | (let ((input (funcall input-func (concat lisp-variable-name ": ")))) 291 | (puthash lisp-variable-name input makey-key-mode-current-lisp-arguments) 292 | (makey-key-mode-redraw for-group))) 293 | 294 | (defun makey-key-mode-add-argument (for-group arg-name input-func) 295 | (let ((input (funcall input-func (concat arg-name ": ")))) 296 | (puthash arg-name input makey-key-mode-current-args) 297 | (makey-key-mode-redraw for-group))) 298 | 299 | (defun makey-key-mode-toggle-option (for-group option-name) 300 | "Toggles the appearance of OPTION-NAME in `makey-key-mode-current-options'." 301 | (if (member option-name makey-key-mode-current-options) 302 | (setq makey-key-mode-current-options 303 | (delete option-name makey-key-mode-current-options)) 304 | (add-to-list 'makey-key-mode-current-options option-name)) 305 | (makey-key-mode-redraw for-group)) 306 | 307 | 308 | (defun makey-key-mode-toggle-lisp-option (for-group option-name option-value-on option-value-off) 309 | "Toggles the appearance of OPTION-NAME in `makey-key-mode-current-lisp-options'. 310 | 311 | Toggles between OPTION-VALUE-ON and OPTION-VALUE-OFF" 312 | (if (cdr (assoc option-name makey-key-mode-current-lisp-options)) 313 | (progn 314 | (setq makey-key-mode-current-lisp-options 315 | (assq-delete-all option-name makey-key-mode-current-lisp-options)) 316 | (add-to-list 'makey-key-mode-current-lisp-options (cons option-name option-value-off))) 317 | (add-to-list 'makey-key-mode-current-lisp-options (cons option-name option-value-on))) 318 | (makey-key-mode-redraw for-group)) 319 | 320 | ;;; Mode 321 | 322 | (defvar makey-key-mode-buf-name "*makey-key: %s*" 323 | "Format string to create the name of the makey-key buffer.") 324 | 325 | (defvar makey-key-mode-last-buffer nil 326 | "Store the last makey-key buffer used.") 327 | 328 | (defvar makey-pre-key-mode-window-conf nil 329 | "Will hold the pre-menu configuration of makey.") 330 | 331 | (defun makey-key-mode (for-group &optional original-opts) 332 | "Mode for makey key selection. 333 | All commands, switches and options can be toggled/actioned with 334 | the key combination highlighted before the description." 335 | (interactive) 336 | ;; save the window config to restore it as was (no need to make this 337 | ;; buffer local) 338 | (setq makey-pre-key-mode-window-conf 339 | (current-window-configuration)) 340 | ;; setup the mode, draw the buffer 341 | (let ((buf (get-buffer-create (format makey-key-mode-buf-name 342 | (symbol-name for-group))))) 343 | (setq makey-key-mode-last-buffer buf) 344 | (split-window-vertically) 345 | (other-window 1) 346 | (switch-to-buffer buf) 347 | (kill-all-local-variables) 348 | (set (make-local-variable 'scroll-margin) 0) 349 | (set (make-local-variable 350 | 'makey-key-mode-current-options) 351 | original-opts) 352 | (set (make-local-variable 353 | 'makey-key-mode-current-lisp-options) 354 | original-opts) 355 | (set (make-local-variable 356 | 'makey-key-mode-current-args) 357 | (make-hash-table)) 358 | (set (make-local-variable 359 | 'makey-key-mode-current-lisp-arguments) 360 | (make-hash-table)) 361 | (set (make-local-variable 'makey-key-mode-prefix) current-prefix-arg) 362 | (makey-key-mode-redraw for-group)) 363 | (when makey-key-mode-show-usage 364 | (message (concat "Type a prefix key to toggle it. " 365 | "Run 'actions' with their prefixes. " 366 | "'?' for more help.")))) 367 | 368 | (defun makey-key-mode-get-key-map (for-group) 369 | "Get or build the keymap for FOR-GROUP." 370 | (or (cdr (assoc for-group makey-key-mode-keymaps)) 371 | (makey-key-mode-build-keymap for-group))) 372 | 373 | (defun makey-key-mode-redraw (for-group) 374 | "(re)draw the makey key buffer." 375 | (let ((buffer-read-only nil) 376 | (current-exec (get-text-property (point) 'key-group-executor)) 377 | (new-exec-pos) 378 | (old-point (point)) 379 | (is-first (zerop (buffer-size))) 380 | (actions-p nil)) 381 | (erase-buffer) 382 | (make-local-variable 'font-lock-defaults) 383 | (use-local-map (makey-key-mode-get-key-map for-group)) 384 | (setq actions-p (makey-key-mode-draw for-group)) 385 | (delete-trailing-whitespace) 386 | (setq mode-name "makey-key-mode" major-mode 'makey-key-mode) 387 | (when current-exec 388 | (setq new-exec-pos 389 | (cdr (assoc current-exec 390 | (makey-key-mode-build-exec-point-alist))))) 391 | (cond ((and is-first actions-p) 392 | (goto-char actions-p) 393 | (makey-key-mode-jump-to-next-exec)) 394 | (new-exec-pos 395 | (goto-char new-exec-pos) 396 | (skip-chars-forward " ")) 397 | (t 398 | (goto-char old-point)))) 399 | (setq buffer-read-only t) 400 | (fit-window-to-buffer)) 401 | 402 | (defun makey-key-mode-build-exec-point-alist () 403 | (save-excursion 404 | (goto-char (point-min)) 405 | (let* ((exec (get-text-property (point) 'key-group-executor)) 406 | (exec-alist (and exec `((,exec . ,(point)))))) 407 | (cl-do nil ((eobp) (nreverse exec-alist)) 408 | (when (not (eq exec (get-text-property (point) 'key-group-executor))) 409 | (setq exec (get-text-property (point) 'key-group-executor)) 410 | (when exec (push (cons exec (point)) exec-alist))) 411 | (forward-char))))) 412 | 413 | ;;; Draw Buffer 414 | 415 | (defun makey-key-mode-draw-header (header) 416 | "Draw a header with the correct face." 417 | (insert (propertize header 'face 'makey-key-mode-header-face) "\n")) 418 | 419 | (defvar makey-key-mode-args-in-cols nil 420 | "When true, draw arguments in columns as with switches and options.") 421 | 422 | (defun makey-key-mode-draw-args (args hash-table) 423 | "Draw the args part of the menu." 424 | (makey-key-mode-draw-buttons 425 | "Args" 426 | args 427 | (lambda (x) 428 | (let* ((arg (nth 2 x)) 429 | (value (gethash arg hash-table ""))) 430 | (format "(%s) %s" arg 431 | (propertize (if (numberp value) (int-to-string value) value) 432 | 'face 'makey-key-mode-args-face)))) 433 | (not makey-key-mode-args-in-cols))) 434 | 435 | (defun makey-key-mode-draw-switches (switches switch-variable) 436 | "Draw the switches part of the menu." 437 | (makey-key-mode-draw-buttons 438 | "Switches" 439 | switches 440 | (lambda (x) 441 | (format "(%s)" (let* ((sym (nth 2 x)) 442 | (s (if (symbolp sym) (symbol-name sym) sym))) 443 | (if (cdr (assoc sym switch-variable)) 444 | (propertize s 'face 'makey-key-mode-switch-face) 445 | s)))))) 446 | 447 | (defun makey-key-mode-draw-actions (header actions) 448 | "Draw the actions part of the menu." 449 | (makey-key-mode-draw-buttons (format "%s Actions" header) actions nil)) 450 | 451 | (defun makey-key-mode-draw-buttons (section xs maker 452 | &optional one-col-each) 453 | (when xs 454 | (makey-key-mode-draw-header section) 455 | (makey-key-mode-draw-in-cols 456 | (mapcar (lambda (x) 457 | (let* ((head (propertize (car x) 'face 'makey-key-mode-button-face)) 458 | (desc (nth 1 x)) 459 | (more (and maker (funcall maker x))) 460 | (text (format " %s: %s%s%s" 461 | head desc (if more " " "") (or more "")))) 462 | (propertize text 'key-group-executor (car x)))) 463 | xs) 464 | one-col-each))) 465 | 466 | (defun makey-key-mode-draw-in-cols (strings one-col-each) 467 | "Given a list of strings, print in columns (using `insert'). 468 | If ONE-COL-EACH is true then don't columify, but rather, draw 469 | each item on one line." 470 | (let ((longest-act (apply 'max (mapcar 'length strings)))) 471 | (while strings 472 | (let ((str (car strings))) 473 | (let ((padding (make-string (- (+ longest-act 3) (length str)) ? ))) 474 | (insert str) 475 | (if (or one-col-each 476 | (and (> (+ (length padding) ; 477 | (current-column) 478 | longest-act) 479 | (window-width)) 480 | (cdr strings))) 481 | (insert "\n") 482 | (insert padding)))) 483 | (setq strings (cdr strings)))) 484 | (insert "\n")) 485 | 486 | (defun makey-get-actions (for-group) 487 | "Returns a list of actions in FOR-GROUP" 488 | (cl-loop 489 | for sub-group in (cdr (assoc 'actions for-group)) 490 | append (cdr sub-group) into action-items finally return action-items)) 491 | 492 | (defun makey-key-mode-draw (for-group) 493 | "Draw actions, switches and parameters. 494 | Return the point before the actions part, if any, nil otherwise." 495 | (let* ((options (makey-key-mode-options-for-group for-group)) 496 | (switches (cdr (assoc 'switches options))) 497 | (lisp-switches (cdr (assoc 'lisp-switches options))) 498 | (arguments (cdr (assoc 'arguments options))) 499 | (lisp-arguments (cdr (assoc 'lisp-arguments options))) 500 | (description (cdr (assoc 'description options))) 501 | (actions (cdr (assoc 'actions options))) 502 | (p nil)) 503 | (makey-key-mode-draw-switches switches makey-key-mode-current-options) 504 | (makey-key-mode-draw-switches lisp-switches makey-key-mode-current-lisp-options) 505 | 506 | (makey-key-mode-draw-args arguments makey-key-mode-current-args) 507 | (makey-key-mode-draw-args lisp-arguments makey-key-mode-current-lisp-arguments) 508 | (when actions (setq p (point-marker))) 509 | (dolist (action actions) 510 | (makey-key-mode-draw-actions (car action) (cdr action))) 511 | (setq header-line-format description) 512 | (insert "\n") 513 | p)) 514 | 515 | ;;; Generate Groups 516 | 517 | (defun makey-key-mode-de-generate (group) 518 | "Unbind the function for GROUP." 519 | (fmakunbound 520 | (intern (concat "makey-key-mode-popup-" (symbol-name group))))) 521 | 522 | (defun makey-key-mode-generate (group-name group-details) 523 | "Generate the key-group-name menu for GROUP." 524 | (let* ((opts group-details) 525 | (lisp-variable-alist)) 526 | (list (dolist (switch (cdr (assoc 'lisp-switches group-details))) 527 | (add-to-list 'lisp-variable-alist 528 | (cons (nth 2 switch) (symbol-value (nth 2 switch)))))) 529 | (eval 530 | `(defun ,(intern (concat "makey-key-mode-options-for-" (symbol-name group-name))) nil 531 | ,(concat "Options menu helper function for " (symbol-name group-name)) 532 | ',group-details)) 533 | (eval 534 | `(defun ,(intern (concat "makey-key-mode-popup-" (symbol-name group-name))) nil 535 | ,(concat "Key menu for " (symbol-name group-name)) 536 | (interactive) 537 | (makey-key-mode 538 | (quote ,group-name) 539 | ',lisp-variable-alist))))) 540 | 541 | ;;;###autoload 542 | (defun makey-initialize-key-groups (key-group) 543 | "Initializes KEY-GROUP and creates all the relevant interactive commands." 544 | (setq makey-key-mode-keymaps nil) 545 | (mapc (lambda (g) 546 | (makey-key-mode-generate (car g) (cdr g))) 547 | key-group)) 548 | 549 | ;;;;###autoload (mapc (lambda (g) (eval `(autoload ',(intern (concat "makey-key-mode-popup-" (symbol-name (car g)))) "makey-key-mode" ,(concat "Key menu for " (symbol-name (car g))) t))) makey-key-mode-groups) 550 | 551 | (provide 'makey) 552 | ;; Local Variables: 553 | ;; indent-tabs-mode: nil 554 | ;; End: 555 | ;;; makey.el ends here 556 | --------------------------------------------------------------------------------