├── .gitignore ├── LICENSE ├── README.org ├── extradoc.py └── poporg.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 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: poporg — Editing program comments or strings with Org mode or other text modes 2 | #+OPTIONS: H:2 3 | 4 | ** Introduction 5 | 6 | *poporg* is a small Emacs Lisp project to help editing program strings and 7 | comments using Org mode (or any other major mode). This can be useful as it is 8 | often more convenient to edit large pieces of text, like Emacs Lisp or Python 9 | docstrings, in an org-mode buffer instead of in a comment or a string. 10 | 11 | Emacs does not easily handle multiple major modes in a single buffer. So far 12 | many solutions have been implemented, with varying degrees of success, but none 13 | is perfect. The *poporg* approach avoids the problem by extracting the text from 14 | the comment or the string from a buffer using a major programming mode, into a 15 | separate buffer to be edited in a text mode, but containing only that comment or 16 | that string. Once the edit is completed, the modified comment or string gets 17 | re-integrated in the buffer containing the program, replacing the original 18 | contents. 19 | 20 | The main utility of this package is its ability to handle prefixes 21 | automatically. For comments, it finds all contiguous nonempty comments on their 22 | own line, and strips the common prefix before inserting into the editing buffer 23 | (see =poporg-comment-skip-regexp=). For strings, it checks if there is consistent 24 | indentation for the whole string (the opening delimiter of the string can only 25 | have whitespace before it), and uses that as the common prefix. For regions, it 26 | just uses a naive common prefix. When placing the edited text back in context, 27 | it adds the common prefix again, potentially stripping any trailing whitespace 28 | (see =poporg-delete-trailing-whitespace=). It can even adjust the fill column in 29 | the editing buffer to account for indentation (see =poporg-adjust-fill-column=). 30 | 31 | ** Installation 32 | 33 | To install *poporg*, move file =poporg.el= to a place where Emacs will find it. You 34 | might byte-compile the file if you want. There are also [[https://github.com/dimitri/el-get][El-Get]] and [[http://melpa.milkbox.net/][MELPA]] 35 | recipes. 36 | 37 | To use *poporg*, you need to pick some unused keybinding and add a few lines to 38 | your =~/.emacs= file, such as: 39 | 40 | #+BEGIN_SRC emacs-lisp 41 | (autoload 'poporg-dwim "poporg" nil t) 42 | (global-set-key (kbd "C-c \"") 'poporg-dwim) 43 | #+END_SRC 44 | 45 | It is important that this be a global keybinding, or at least that the command 46 | =poporg-dwim= be available from both the programming and the text editing buffers. 47 | 48 | ** Usage 49 | 50 | The command =poporg-dwim= searches for a nearby comment or string (see 51 | =poporg-find-string-or-comment=) and, upon finding one, it opens an empty buffer 52 | in a new window with its contents available for editing. If the region is 53 | active then =poporg-dwim= inserts the region into the buffer instead. The 54 | original text is grayed out and set read-only to prevent editing in two places 55 | at once. After editing, running =poporg-dwim= again from the editing buffer kills 56 | the editing buffer and inserts the edited text back into its original context. 57 | 58 | Hopefully =poporg-dwim= will do what you expect in most situations. It uses the 59 | buffer's syntax table for parsing, so it should adapt well to most modes 60 | (including sextuple-quoted strings in Python). If you run =poporg-dwim= in the 61 | vicinity of a grayed-out region that you are editing in another buffer, it pops 62 | to that buffer. It has the following limitations: 63 | 64 | 1. It does not understand empty strings. 65 | 2. It cannot deal very well with comments with ending delimiters. 66 | 67 | For example, in c-mode, comments start with =/*= and end with =*/=. This is a 68 | problem because poporg needs a common prefix for all lines. In order to make 69 | poporg understand these comments, write them on separate lines like this: 70 | 71 | #+BEGIN_SRC c 72 | /* 73 | * Comments go here. Not on a line with the opening delimiter or the 74 | * closing delimiter. 75 | */ 76 | #+END_SRC 77 | 78 | In this situation poporg will ignore the first and last lines because they are 79 | empty except for comment delimiters, and detect the common prefix =__= or =__*_= for 80 | the middle lines, depending on whether the =*= character is matched by 81 | =poporg-comment-skip-regexp=. 82 | 83 | You will probably want to customize =poporg-edit-hook=, since that is where the 84 | major mode of the edit buffer is set. The minor mode =poporg-mode= is activated 85 | in the edit buffer. It contains the following keybindings by default: 86 | 87 | | Command | Keybinding | Description | 88 | |------------------------+------------+-----------------------------------| 89 | | *poporg-edit-exit* | =C-x C-s= | Save edit and kill poporg buffer | 90 | | *poporg-update* | =C-c C-c= | Save edit and keep poporg buffer | 91 | | *poporg-update-and-save* | =C-c C-s= | Save edit and keep poporg buffer; then save the original buffer | 92 | |------------------------+------------+-----------------------------------| 93 | 94 | You can add additional keybindings to =poporg-mode-map=. To abort the edit simply 95 | kill the buffer. 96 | 97 | ** History 98 | 99 | *poporg* was originally written and maintained by François Pinard, who had 100 | incorporated ideas into it from previous Emacs projects of his. Joe Rabinoff 101 | refactored the package to use the buffer's syntax table for parsing, and 102 | subsequently took over maintainership. 103 | 104 | ** Other tools 105 | 106 | Major programming modes show comments and strings in full, and when these 107 | comments or strings are written using Org, with all parts of a link visible, it 108 | may be disruptive to those sensible to line width limits. The nice 109 | [[https://github.com/seanohalpin/org-link-minor-mode][org-link-minor-mode]] tool takes good care of this, by hiding the usually 110 | invisible parts of an Org link in other modes. 111 | 112 | Org comes with many tools for spreading Org over other major modes, including 113 | the following minor modes which may be /added/ to other major modes: 114 | 115 | | Command | 116 | |------------------| 117 | | *orgstruct-mode* | 118 | | *orgstruct++-mode* | 119 | | *orgtbl-mode* | 120 | 121 | Org also has the following globally available commands: 122 | 123 | | Command | Usual keybinding | 124 | |--------------------------+------------------| 125 | | *org-store-link* | =C-c l= | 126 | | *org-insert-link-global* | =C-c L= | 127 | | *org open-at-point-global* | =C-c O= | 128 | |--------------------------+------------------| 129 | 130 | *** Extractor for Python 131 | The =extradoc.py= tool in this *poporg* project has the purpose of extracting and 132 | processing the Org contents of a set of Python sources. I used the =.py= suffix 133 | just in case there could be other =extradoc.LANG= tools for similarly handling 134 | sources in other languages. This =extradoc.py= tool presumes that all Org text is 135 | made up by concatenating the content of all sextuple-quoted strings (I mean 136 | triple double-quoted strings). Moreover, prefixed strings are not recognized. 137 | -------------------------------------------------------------------------------- /extradoc.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | """\ 4 | Extract documentation from one or more Python sources. 5 | Documentation lies in all unprefixed, sextuple-quoted strings. 6 | 7 | Usage: extradoc.py [OPTION]... [SOURCE]... 8 | 9 | Options: 10 | -c PREFIX Common prefix for all output files. 11 | -s Split output in directory PREFIX, obey #+FILE directives. 12 | -h Produce an HTML file, either PREFIX.html or PREFIX/NAME.html. 13 | -o Produce an Org file, either PREFIX.org or PREFIX/NAME.org. 14 | -p Produce a PDF file, either PREFIX.pdf or PREFIX/NAME.pdf. 15 | -t Produce a translation file, name will be PREFIX.pot. 16 | -v Be verbose and repeat all of Emacs output. 17 | -D SYM Define SYMbol as being True 18 | -D SYM=EXPR Define SYMbol with the value of EXPR. 19 | -I TAGS Only include sections having one of TAGS in their header. 20 | -X TAGS Exclude sections having one of TAGS in their header. 21 | 22 | If no SOURCE are given, the program reads and process standard input. 23 | Option -c is mandatory. If -h or -p are used and -o is not, file PREFIX.org 24 | should not pre-exist, as the program internally writes it and then deletes it. 25 | 26 | Some non-standard Org directives are recognized: 27 | #+FILE: NAME.org Switch output to NAME.org, also requires -s. 28 | #+IF EXPR Produce following lines only if EXPR is true, else skip. 29 | #+ELIF EXPR Expected meaning within an #+IF block. 30 | #+ELSE Expected meaning within an #+IF block. 31 | #+ENDIF Expected meaning to end an #+IF block. 32 | 33 | EXPRs above are Python expressions, eval context comes from -D options. 34 | TAGS represents a comma-separated list of Org tags. To get through, a line 35 | should go through the #+IF system, not be within an excluded section, and if 36 | any included sections is specified, then either be part of one of them or 37 | within the introduction (that is, before the first header). 38 | """ 39 | 40 | import codecs 41 | import os 42 | import polib 43 | import re 44 | import sys 45 | import tokenize 46 | 47 | encoding = 'UTF-8' 48 | 49 | # Within an #+IF [#+ELIF]... [#+ELSE] #+ENDIF structure, the state may 50 | # vary between FALSE, TRUE and SKIP. The state before the structure is 51 | # saved on entry, and restored on exit. The state is TRUE at the 52 | # beginning of a file. If the state before stacking was TRUE, it starts 53 | # as FALSE within the structure; otherwise, the state starts as SKIP. 54 | # States may only go from FALSE to any other state; or else, necessarily 55 | # to SKIP. Within a structure, the state can be TRUE at most once, 56 | # indicating that the tested condition was true. It can be FALSE 57 | # earlier in the structure, and may only be SKIP after the TRUE segment. 58 | FALSE, TRUE, SKIP = range(3) 59 | 60 | 61 | class Main: 62 | prefix = None 63 | html = False 64 | org = False 65 | pdf = False 66 | pot = False 67 | split = False 68 | verbose = False 69 | included = set() 70 | excluded = set() 71 | 72 | def main(self, *arguments): 73 | 74 | # Decode options. 75 | self.context = Context() 76 | import getopt 77 | options, arguments = getopt.getopt(arguments, 'D:I:X:c:hopstv') 78 | for option, value in options: 79 | if option == '-D': 80 | if '=' in value: 81 | sym, expr = value.split('=', 1) 82 | self.context[sym.strip()] = eval(value, None, self.context) 83 | else: 84 | self.context[value.strip()] = True 85 | elif option == '-I': 86 | self.included = set(tag.strip() for tag in value.split(',')) 87 | elif option == '-X': 88 | self.excluded = set(tag.strip() for tag in value.split(',')) 89 | elif option == '-c': 90 | self.prefix = value 91 | elif option == '-d': 92 | self.split = True 93 | elif option == '-h': 94 | self.html = True 95 | elif option == '-o': 96 | self.org = True 97 | elif option == '-p': 98 | self.pdf = True 99 | elif option == '-s': 100 | self.split = True 101 | elif option == '-t': 102 | self.pot = True 103 | elif option == '-v': 104 | self.verbose = True 105 | if not self.prefix: 106 | sys.exit("Option -c is mandatory.") 107 | if ((self.html or self.pdf) and not self.org 108 | and os.path.exists(self.prefix + '.org')): 109 | sys.exit("File %s.org exists and -o not specified." % self.prefix) 110 | 111 | # Prepare the work. 112 | if not self.split and (self.html or self.org or self.pdf): 113 | self.org_file = codecs.open(self.prefix + '.org', 'w', encoding) 114 | else: 115 | self.org_file = None 116 | if self.pot: 117 | self.po = polib.POFile() 118 | self.po.metadata = { 119 | 'Project-Id-Version': '1.0', 120 | 'Report-Msgid-Bugs-To': 'you@example.com', 121 | 'POT-Creation-Date': '2007-10-18 14:00+0100', 122 | 'PO-Revision-Date': '2007-10-18 14:00+0100', 123 | 'Last-Translator': 'you ', 124 | 'Language-Team': 'English ', 125 | 'MIME-Version': '1.0', 126 | 'Content-Type': 'text/plain; charset=%s' % encoding, 127 | 'Content-Transfer-Encoding': '8bit', 128 | } 129 | 130 | # Process all source files. 131 | if arguments: 132 | for argument in arguments: 133 | self.extract_org_fragments( 134 | codecs.open(argument, 'r', encoding), 135 | argument) 136 | else: 137 | self.extract_org_fragments(sys.stdin, '') 138 | 139 | # Complete the work. 140 | if self.pot: 141 | self.po.save(self.prefix + '.pot') 142 | if self.org_file is not None: 143 | self.org_file.close() 144 | if not self.split: 145 | if self.html: 146 | self.launch_emacs([ 147 | self.prefix + '.org', 148 | '--eval', '(setq org-export-allow-BIND t)', 149 | '--eval', '(org-export-as-html nil)']) 150 | if self.pdf: 151 | self.launch_emacs([ 152 | self.prefix + '.org', 153 | '--eval', '(setq org-export-allow-BIND t)', 154 | '--eval', '(org-export-as-pdf nil)']) 155 | if (self.html or self.pdf) and not self.org: 156 | os.remove(self.prefix + '.org') 157 | 158 | def extract_org_fragments(self, file, name): 159 | # LEVEL not None means inhibit copy from that header level on. 160 | level = None 161 | for line in self.each_org_line(file, name): 162 | if line.startswith('#+FILE:'): 163 | if self.split: 164 | if self.html or self.org or self.pdf: 165 | name = line[7:].strip() 166 | self.org_file = codecs.open( 167 | '%s/%s' % (self.prefix, name), 'w', encoding) 168 | level = None 169 | continue 170 | if line.startswith('*'): 171 | match = re.match('^(\\*+).*?((:[a-z]+)+:)?$', line) 172 | if match: 173 | here_level = len(match.group(1)) 174 | if level is None or here_level <= level: 175 | if match.group(2): 176 | tags = set(match.group(2).strip(':').split(':')) 177 | else: 178 | tags = set() 179 | if tags & self.excluded: 180 | level = here_level 181 | elif self.included and not (tags & self.included): 182 | level = here_level 183 | else: 184 | level = None 185 | if level is None and self.org_file is not None: 186 | self.org_file.write(line + '\n') 187 | 188 | def each_org_line(self, file, name): 189 | 190 | def if_bool(value): 191 | return (FALSE, TRUE)[bool(value)] 192 | 193 | def warn(diagnostic): 194 | sys.stderr.write('%s:%s %s\n' % (name, line_no, diagnostic)) 195 | 196 | self.stack = [] 197 | self.state = TRUE 198 | for (code, text, (line_no, _), _, _ 199 | ) in tokenize.generate_tokens(file.readline): 200 | if code == tokenize.STRING: 201 | if text.startswith('"""'): 202 | text = text[3:-3].replace('\\\n', '') 203 | if self.pot: 204 | self.po.append(polib.POEntry( 205 | msgid=text, 206 | occurrences=[(name, str(line_no))])) 207 | for line in text.splitlines(): 208 | if line.startswith('#+IF '): 209 | self.stack.append(self.state) 210 | if self.state == TRUE: 211 | value = eval(line[5:], self.context) 212 | self.state = if_bool(value) 213 | else: 214 | self.state = SKIP 215 | elif line.startswith('#+ELIF '): 216 | if self.state == FALSE: 217 | value = eval(line[7:], self.context) 218 | self.state = if_bool(value) 219 | else: 220 | self.state = SKIP 221 | elif line == '#+ELSE': 222 | if self.state == FALSE: 223 | self.state = TRUE 224 | else: 225 | self.state = SKIP 226 | elif line == '#+ENDIF': 227 | if self.stack: 228 | self.state = self.stack.pop() 229 | else: 230 | warn("Spurious #+ENDIF line.") 231 | elif self.state == TRUE: 232 | if line.startswith('#+FILE:') and not self.split: 233 | warn("#+FILE directive, and not -s.") 234 | yield line 235 | if self.stack: 236 | sys.stderr.write("%s: Some #+ENDIF might be missing.\n" % name) 237 | 238 | def launch_emacs(self, args): 239 | import subprocess 240 | for raw in subprocess.Popen( 241 | ['emacs', '--batch'] + args, 242 | stdout=subprocess.PIPE, 243 | stderr=subprocess.STDOUT).stdout: 244 | try: 245 | line = raw.decode(encoding) 246 | except UnicodeDecodeError: 247 | line = raw.decode('ISO-8859-1') 248 | if not self.verbose: 249 | match = re.match('^Loading .*/([^/]+)\\.cache\\.\\.\\.$', 250 | line) 251 | if match: 252 | sys.stderr.write("%s\n" % match.group(1)) 253 | continue 254 | if line.startswith(( 255 | # Common 256 | 'Loading ', 257 | 'OVERVIEW', 258 | 'Saving file ', 259 | 'Wrote ', 260 | # PDF 261 | 'Exporting to ', 262 | 'LaTeX export done, ', 263 | 'Processing LaTeX file ', 264 | # Web 265 | '(No changes need to be saved)', 266 | '(Shell command succeeded ', 267 | 'Exporting...', 268 | 'HTML export done, ', 269 | 'Publishing file ', 270 | 'Resetting org-publish-cache', 271 | 'Skipping unmodified file ')): 272 | continue 273 | sys.stderr.write(line) 274 | 275 | 276 | class Context(dict): 277 | "dict type which defaults to either builtin objects or False." 278 | 279 | def __getitem__(self, key): 280 | try: 281 | return dict.__getitem__(self, key) 282 | except KeyError: 283 | try: 284 | return getattr(__builtins__, key) 285 | except AttributeError: 286 | return False 287 | 288 | 289 | run = Main() 290 | main = run.main 291 | 292 | if __name__ == '__main__': 293 | main(*sys.argv[1:]) 294 | -------------------------------------------------------------------------------- /poporg.el: -------------------------------------------------------------------------------- 1 | ;;; poporg.el --- Pop a comment or string to an empty buffer for text editing 2 | 3 | ;; Copyright © 2014 Joseph Rabinoff. 4 | ;; Copyright © 2013 Ubity inc. 5 | 6 | ;; Author: François Pinard 7 | ;; Joseph Rabinoff 8 | ;; Maintainer: Joseph Rabinoff 9 | ;; Keywords: outlines, tools 10 | ;; URL: https://github.com/QBobWatson/poporg 11 | 12 | ;; This program is free software: you can redistribute it and/or modify it under 13 | ;; the terms of the GNU General Public License as published by the Free Software 14 | ;; Foundation, either version 3 of the License, or (at your option) any later 15 | ;; version. 16 | 17 | ;; This program is distributed in the hope that it will be useful, but WITHOUT 18 | ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 19 | ;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 20 | ;; details. 21 | 22 | ;; You should have received a copy of the GNU General Public License along with 23 | ;; this program. If not, see . 24 | 25 | ;;; Commentary: 26 | 27 | ;; poporg is a small Emacs Lisp project to help editing program strings and 28 | ;; comments using Org mode (or any other major mode). This can be useful as it 29 | ;; is often more convenient to edit large pieces of text, like Emacs Lisp or 30 | ;; Python docstrings, in an org-mode buffer instead of in a comment or a string. 31 | 32 | ;; See the README.org file located at https://github.com/QBobWatson/poporg for 33 | ;; detailed usage information. 34 | 35 | ;;; Code: 36 | 37 | (eval-when-compile 38 | (require 'cl)) 39 | 40 | ;; * Customs 41 | ;; ** Group 42 | 43 | (defgroup poporg nil 44 | "Edit strings and comments in text buffers." 45 | :prefix "poporg-" 46 | :group 'lisp) 47 | 48 | ;; ** defcustom's 49 | 50 | (defcustom poporg-adjust-fill-column t 51 | "Whether to adjust the fill column in the edit buffer. 52 | 53 | If non-nil, in the edit buffer decrement `fill-column' by the prefix length." 54 | :group 'poporg 55 | :type 'boolean) 56 | 57 | (defcustom poporg-delete-trailing-whitespace t 58 | "Whether to delete trailing whitespace from the prefix. 59 | 60 | If t, when inserting a blank line from the edit buffer back into the source 61 | buffer, remove trailing whitespace from the prefix. This is very useful when 62 | editing docstrings in python, for instance. If equal to the symbol 'all, don't 63 | insert the prefix at all for blank lines." 64 | :group 'poporg 65 | :type '(choice 66 | (const :tag "Do not delete trailing whitespace" nil) 67 | (const :tag "Delete trailing whitespace" t) 68 | (const :tag "Delete the entire prefix" all))) 69 | 70 | (defcustom poporg-buffer-name "*poporg: %s*" 71 | "Template for poporg buffer names. 72 | 73 | The tag %s is replaced by the original buffer name." 74 | :group 'poporg 75 | :type 'string) 76 | 77 | (defcustom poporg-comment-skip-regexp "[[:space:]*]*" 78 | "Ignore these additional characters at the beginning of a commented line. 79 | 80 | Characters not matched by this regexp will not be included in the common prefix 81 | for comments. This is matched after `comment-start'. By default this matches 82 | whitespace and the * character; the latter is useful in C-style comments. This 83 | should not match newlines." 84 | :group 'poporg 85 | :type 'regexp) 86 | 87 | (defcustom poporg-edit-hook '(org-mode) 88 | "List of hooks to run once a new editing buffer has been filled. 89 | 90 | In the absence of any hooks here, the poporg editing buffer is in 91 | `fundamental-mode', so you should probably use this hook to set the major mode. 92 | By default this hook enables `org-mode'." 93 | :group 'poporg 94 | :type 'hook) 95 | 96 | (defcustom poporg-edit-exit-hook nil 97 | "List of hooks to run prior to moving back an editing buffer." 98 | :group 'poporg 99 | :type 'hook) 100 | 101 | (defvar poporg-mode-map 102 | (let ((map (make-sparse-keymap))) 103 | (define-key map [remap save-buffer] 'poporg-edit-exit) 104 | (define-key map (kbd "C-c C-c") 'poporg-update) 105 | (define-key map (kbd "C-c C-s") 'poporg-update-and-save) 106 | map) 107 | "Keys used in `poporg-mode' buffers.") 108 | 109 | ;; ** Face 110 | 111 | (defface poporg-edited-face 112 | '((((class color) (background light)) 113 | (:foreground "gray")) 114 | (((class color) (background dark)) 115 | (:foreground "gray"))) 116 | "Face for a region while it is being edited." 117 | :group 'poporg) 118 | 119 | ;; * Internal variables 120 | 121 | (defvar poporg-data nil 122 | "List of (BUFFER OVERLAY PREFIX TYPE) lists. 123 | 124 | For each edit BUFFER, there is an OVERLAY graying out the edited block comment 125 | or string in the original buffer, and a PREFIX that was removed from all lines 126 | in the edit buffer and which is going to be prepended to these lines before 127 | returning them the original buffer. TYPE is either 'string, 'comment, or 128 | 'region.") 129 | 130 | (defvar poporg-orig-point nil 131 | "Keeps track of the value of point in the calling buffer. 132 | Dynamically bound variable.") 133 | 134 | (defvar poporg-new-point nil 135 | "Keeps track of the value of point in the new buffer. 136 | Dynamically bound variable.") 137 | 138 | (defvar poporg-pre-window-configuration nil 139 | "Variable to store the original window configuration.") 140 | 141 | ;; * Functions 142 | 143 | ;; ** utility 144 | 145 | (defun poporg-chomp (str) 146 | "Chomp leading and trailing whitespace from STR." 147 | (while (string-match 148 | "\\`\n+\\|^\\s-+\\|\\s-+$\\|\n+\\'" 149 | str) 150 | (setq str (replace-match "" t t str))) 151 | str) 152 | 153 | (defun poporg-chomp-end (str) 154 | "Chomp trailing whitespace from STR." 155 | (while (string-match "\\s-+$\\|\n+\\'" str) 156 | (setq str (replace-match "" t t str))) 157 | str) 158 | 159 | (defun poporg-check-already-edited (beg end) 160 | "Check if there is an already edited region overlapping BEG to END. 161 | If yes, pop the editing buffer for the first one and return t." 162 | (let ((overlays (overlays-in beg end))) 163 | (catch 'found 164 | (while overlays 165 | (let ((entry (overlay-get (pop overlays) 'poporg-overlay))) 166 | (when entry 167 | (pop-to-buffer (car entry)) 168 | (throw 'found entry)))) 169 | nil))) 170 | 171 | (defun poporg-make-buffer () 172 | "Make a poporg buffer." 173 | (generate-new-buffer (format poporg-buffer-name (buffer-name)))) 174 | 175 | (defun poporg-fc (arg) 176 | "Like `forward-char' on ARG but won't throw an error." 177 | (condition-case nil (forward-char arg) (error nil))) 178 | 179 | (defun poporg-orig-buffer () 180 | "If this is an edit buffer, find the originating buffer." 181 | (let* ((entry (assq (current-buffer) poporg-data)) 182 | (overlay (cadr entry))) 183 | (when overlay (overlay-buffer overlay)))) 184 | 185 | ;; *** skip past comments 186 | 187 | (defun poporg-skip-past-comment-start () 188 | "Skip whitespace, `comment-start', and comment syntax chars." 189 | (skip-syntax-forward " ") 190 | (let ((com-start (if comment-start (poporg-chomp comment-start) ""))) 191 | (when (looking-at (regexp-quote com-start)) 192 | (goto-char (match-end 0)))) 193 | (skip-syntax-forward "<")) 194 | 195 | (defun poporg-skip-past-comment-end () 196 | "Skip whitespace and `comment-end'." 197 | (skip-syntax-forward " ") 198 | (let ((com-end (if comment-end (poporg-chomp comment-end) ""))) 199 | (when (looking-at (regexp-quote com-end)) 200 | (goto-char (match-end 0))))) 201 | 202 | ;; *** check whitespace 203 | 204 | (defun poporg-whitespace-before-p (pos) 205 | "Return t if there is only whitespace before POS on its line." 206 | (save-excursion 207 | (goto-char pos) 208 | (forward-line 0) 209 | (skip-syntax-forward " ") 210 | (equal pos (if (markerp pos) (point-marker) (point))))) 211 | 212 | (defun poporg-whitespace-after-p (pos) 213 | "Return t if there is only whitespace after POS on its line." 214 | (save-excursion 215 | (goto-char pos) 216 | (skip-syntax-forward " ") 217 | (eolp))) 218 | 219 | ;; ** find and insert 220 | 221 | ;; *** insert into other buffer 222 | 223 | (defun poporg-insert-substring (buf start end) 224 | "Call `insert-buffer-substring-no-properties' on BUF START END. 225 | 226 | Keep track of where the point is using `poporg-orig-point' 227 | and `poporg-new-point'." 228 | (let ((starting (point))) 229 | (insert-buffer-substring-no-properties buf start end) 230 | (cond 231 | ((>= poporg-orig-point end) 232 | (setq poporg-new-point (point))) 233 | ((>= poporg-orig-point start) 234 | (setq poporg-new-point (+ starting (- poporg-orig-point start))))))) 235 | 236 | (defun poporg-insert-without-prefix (buf prefix start end) 237 | "Insert lines into BUF after removing PREFIX. 238 | 239 | Start at START in current buffer and end at END. On lines that do not start 240 | with prefix, or contain only whitespace after the prefix, just insert a 241 | newline. Respects the value of `poporg-delete-trailing-whitespace'." 242 | (let ((prefix-re (regexp-quote prefix)) 243 | (cur-buf (current-buffer))) 244 | (save-excursion 245 | (goto-char start) 246 | (while (< (point) end) 247 | (if (looking-at prefix-re) 248 | (progn 249 | (goto-char (match-end 0)) 250 | (if (and poporg-delete-trailing-whitespace 251 | (poporg-whitespace-after-p (point))) 252 | (with-current-buffer buf (insert "\n")) ; uninteresting 253 | ;; interesting 254 | (let ((s (point)) 255 | (e (save-excursion (forward-line 1) (point)))) 256 | (with-current-buffer buf 257 | (poporg-insert-substring cur-buf s e))))) 258 | ;; uninteresting 259 | (with-current-buffer buf (insert "\n"))) 260 | (forward-line 1))))) 261 | 262 | (defun poporg-insert-with-prefix (buf start end prefix &optional no-first) 263 | "Use the contents of BUF to replace the region from START to END. 264 | 265 | Prepend PREFIX onto each line. If NO-FIRST is non-nil, do not prepend PREFIX 266 | onto the first line. Delete trailing whitespace from blank lines if 267 | `poporg-delete-trailing-whitespace' is set." 268 | (delete-region start end) 269 | (goto-char start) 270 | (let ((cur-buf (current-buffer)) 271 | (prefix-no-ws (poporg-chomp-end prefix))) 272 | (with-current-buffer buf 273 | (save-excursion 274 | (goto-char (point-min)) 275 | (while (not (eobp)) 276 | (let* ((s (point)) 277 | (char-at (char-after s)) 278 | e) 279 | (forward-line 1) 280 | (setq e (point)) 281 | (with-current-buffer cur-buf 282 | (if no-first 283 | (setq no-first nil) 284 | (if (and poporg-delete-trailing-whitespace 285 | (or (null char-at) (= char-at ?\n))) 286 | ;; strip whitespace from prefix for blank lines 287 | (unless (eq poporg-delete-trailing-whitespace 'all) 288 | (insert prefix-no-ws)) 289 | (insert prefix))) 290 | (poporg-insert-substring buf s e)))))))) 291 | 292 | ;; *** find string or comment 293 | 294 | (defun poporg-find-string-or-comment () 295 | "Return the start and end positions of the nearest string or comment. 296 | 297 | If the point is in a string or comment, this returns the extents of the current 298 | string or comment. If the point is immediately before (resp. after) a string 299 | or comment, returns the extents of the following (resp. preceding) string or 300 | comment. This function uses the current buffer's syntax tables for its 301 | searches. 302 | 303 | If a string or comment was found, return a list 304 | 305 | (TYPE START END) 306 | 307 | where TYPE is either 'string or 'comment and START and END are markers. The 308 | enclosed region includes the delimiters. 309 | 310 | If a comment was found, the region between START and END is a number of complete 311 | lines (including trailing newlines) containing only comments. This means that 312 | comments not on their own line are ignored. There may also be blank lines in 313 | this region. 314 | 315 | If a string was found, the region from START to END bounds the string with its 316 | delimiters. There will only be whitespace before the start of the string. This 317 | means that a string with non-whitespace before it is ignored. 318 | 319 | If no string or comment was found satisfying the above criteria, return nil." 320 | (save-excursion 321 | (let ((ppss (syntax-ppss)) 322 | (search-start (point))) 323 | (unless (nth 8 ppss) 324 | ;; We're not in a string or comment. Skip past whitespace and search 325 | ;; one character at a time until we are. Sometimes stupidest algorithm 326 | ;; is the most reliable. First search forward. 327 | (skip-syntax-forward " >") 328 | (catch 'foundit 329 | (dotimes (i 10) 330 | (setq ppss (syntax-ppss)) 331 | (when (nth 8 ppss) 332 | (throw 'foundit nil)) 333 | (poporg-fc 1)) 334 | ;; now search backward 335 | (goto-char search-start) 336 | (skip-syntax-backward " >") 337 | (dotimes (i 10) 338 | (setq ppss (syntax-ppss)) 339 | (when (nth 8 ppss) 340 | (throw 'foundit nil)) 341 | (poporg-fc -1)))) 342 | ;; done searching 343 | (let ((in-string (nth 3 ppss)) 344 | (in-comment (nth 4 ppss)) 345 | (start-pos (nth 8 ppss)) 346 | start end) 347 | (when start-pos 348 | ;; in string or comment 349 | (if in-string 350 | (progn 351 | (setq start (set-marker (make-marker) start-pos)) 352 | ;; find end of string 353 | (parse-partial-sexp (point) (buffer-size) 354 | nil nil ppss 'syntax-table) 355 | (setq end (point-marker)) 356 | (when (poporg-whitespace-before-p start) 357 | (list 'string start end))) 358 | (when in-comment ; should be true at this point 359 | (goto-char start-pos) 360 | ;; skip backward over comments and whitespace 361 | (forward-comment (- (buffer-size))) 362 | ;; skip forward to beginning of first comment 363 | (skip-syntax-forward " >") 364 | (if (not (poporg-whitespace-before-p (point))) 365 | (forward-line 1) ; it's not on its own line 366 | (forward-line 0)) 367 | ;; beginning of line of first comment 368 | (setq start (point-marker)) 369 | ;; skip forward over comments and whitespace 370 | (forward-comment (buffer-size)) 371 | ;; skip back to end of last comment 372 | (skip-syntax-backward " >") 373 | (save-excursion (forward-line 1) 374 | (setq end (point-marker))) 375 | (when (and (> end start) 376 | (poporg-whitespace-after-p (point))) 377 | (list 'comment start end))))))))) 378 | 379 | ;; *** insert from comment 380 | 381 | (defun poporg-get-comment-lines (buf start end) 382 | "Parse a comment and insert it, with common prefix removed, into BUF. 383 | 384 | START and END are positions as returned by `poporg-find-string-or-comment'. 385 | 386 | At the beginning of every line, ignore whitespace, `comment-end', 387 | `comment-start', comment syntax characters, and `poporg-comment-skip-regexp', in 388 | that order. This is what is used to calculate the common prefix. If there is 389 | anything left, that line is considered interesting. This skips over 390 | uninteresting lines in the beginning and end. For instance, in the C-style 391 | comment: 392 | 393 | /* 394 | * Only this line will be extracted, not the lines above and below. 395 | */ 396 | 397 | The prefix will be \" \" or \" * \", depending on whether 398 | `poporg-comment-skip-regexp' matches the star character. If there are no 399 | interesting lines, extract the second comment line, if there is one; otherwise 400 | use the unique comment line. 401 | 402 | Return a list (START END PREFIX), where START is the beginning of the first 403 | interesting line, END is the end of the last interesting line (including the 404 | newline), and PREFIX is the common prefix of all interesting lines. START and 405 | END are markers." 406 | (let (start2 end2 line-start line-end prefix) 407 | (save-excursion 408 | (goto-char start) 409 | (forward-line 0) 410 | ;; make a list of interesting lines 411 | (while (< (point) end) 412 | (setq line-start (point)) 413 | (poporg-skip-past-comment-end) 414 | (poporg-skip-past-comment-start) 415 | (when (looking-at poporg-comment-skip-regexp) 416 | (goto-char (match-end 0))) 417 | (when (not (eolp)) 418 | ;; this is an interesting line 419 | (setq line-end (save-excursion (forward-line 1) (point))) 420 | ;; update prefix 421 | (let ((beg (buffer-substring-no-properties line-start (point)))) 422 | (if prefix 423 | (setq prefix (or (fill-common-string-prefix beg prefix) "")) 424 | (setq prefix beg))) 425 | (unless start2 (setq start2 line-start)) 426 | (setq end2 line-end)) 427 | (forward-line 1))) 428 | (if prefix 429 | ;; insert interesting lines into buf 430 | (poporg-insert-without-prefix buf prefix start2 end2) 431 | ;; Make a blank buffer; insert over second comment line, or first if there 432 | ;; is none. This way one can compose blank comments. 433 | (save-excursion 434 | (goto-char start) 435 | (forward-line 0) 436 | (setq start2 (point)) 437 | (forward-line 1) 438 | (if (< (point) end) 439 | ;; use the second line 440 | (setq start2 (point)) 441 | (goto-char start2)) 442 | (skip-syntax-forward "^>") 443 | (setq prefix (buffer-substring-no-properties 444 | start2 (point))) 445 | (forward-line 1) 446 | (setq end2 (point)) 447 | (with-current-buffer buf (insert "\n")))) 448 | (list (set-marker (make-marker) start2) 449 | (set-marker (make-marker) end2) 450 | prefix))) 451 | 452 | (defun poporg-insert-comment-lines (buf start end prefix overlay) 453 | "Insert the contents of BUF as comments in the current buffer. 454 | 455 | Replace the region from START to END and prepend PREFIX onto each line. Append 456 | a trailing newline if necessary. Uses `poporg-insert-with-prefix' to do the 457 | work. Move OVERLAY to the newly-inserted region." 458 | (poporg-insert-with-prefix buf start end prefix) 459 | ;; For our purposes, comments always comprise entire lines, so insert a 460 | ;; trailing newline if necessary. 461 | (when (with-current-buffer buf 462 | (save-excursion 463 | (goto-char (point-max)) 464 | (and (char-before) (not (= (char-before) ?\n))))) 465 | (insert "\n")) 466 | (move-overlay overlay start (point))) 467 | 468 | ;; *** insert from string 469 | 470 | (defun poporg-get-string-lines (buf start end) 471 | "Parse a string and insert it, with common indentation removed, into BUF. 472 | 473 | START and END are positions as returned by `poporg-find-string-or-comment'. 474 | 475 | This function does not insert the start and end string delimiters. Lines that 476 | are not composed entirely of whitespace count toward determining the 477 | indentation. The indentation of the first line is the indentation before the 478 | opening string delimiter. 479 | 480 | This function refuses to edit empty strings, since there is no reliable way to 481 | decide which are the starting and ending delimiters if there is nothing between 482 | them. 483 | 484 | Return (START END PREFIX) as in `poporg-get-comment-lines'. The returned values 485 | of START and END agree with the passed arguments. (They are included so that 486 | this function has the same usage as `poporg-get-comment-lines')." 487 | (let* ((beg-last-line (save-excursion 488 | (goto-char end) (forward-line 0) (point))) 489 | (end-last-line (save-excursion 490 | (goto-char end) (skip-syntax-backward "\"|") (point))) 491 | (one-line-p (<= beg-last-line start)) 492 | (cur-buf (current-buffer)) 493 | prefix line-start start2) 494 | (when (<= end-last-line start) 495 | (user-error "Refusing to edit empty string")) 496 | (save-excursion 497 | (goto-char start) 498 | ;; starting prefix is whitespace before opening delimiter 499 | (setq prefix (buffer-substring-no-properties 500 | (save-excursion (forward-line 0) (point)) start)) 501 | (forward-line 1) 502 | ;; loop over lines with no delimiters 503 | (while (< (point) beg-last-line) 504 | (setq line-start (point)) 505 | (skip-syntax-forward " ") 506 | (unless (eolp) 507 | (setq prefix (or (fill-common-string-prefix 508 | (buffer-substring-no-properties 509 | line-start (point)) 510 | prefix) 511 | ""))) 512 | (forward-line 1)) 513 | (unless one-line-p 514 | ;; handle last line 515 | (setq line-start (point)) 516 | (skip-syntax-forward " ") 517 | (setq prefix (or (fill-common-string-prefix 518 | (buffer-substring-no-properties 519 | line-start (point)) 520 | prefix) "")))) 521 | ;; insert into buf 522 | (save-excursion 523 | (goto-char start) 524 | (skip-syntax-forward "\"|") 525 | (setq start2 (point)) 526 | (if one-line-p 527 | (with-current-buffer buf 528 | (poporg-insert-substring cur-buf start2 end-last-line)) 529 | (forward-line 1) 530 | (let ((end2 (point))) 531 | (with-current-buffer buf 532 | (poporg-insert-substring cur-buf start2 end2))) 533 | (poporg-insert-without-prefix buf prefix (point) beg-last-line) 534 | (goto-char beg-last-line) 535 | ;; the last line by definition starts with prefix 536 | (forward-char (length prefix)) 537 | (setq start2 (point)) 538 | (with-current-buffer buf 539 | (poporg-insert-substring cur-buf start2 end-last-line)))) 540 | (list (set-marker (make-marker) start) 541 | (set-marker (make-marker) end) 542 | prefix))) 543 | 544 | (defun poporg-insert-string-lines (buf start end prefix overlay) 545 | "Insert the contents of BUF into a string in the current buffer. 546 | 547 | Replace the string between START and END and prepend PREFIX onto each interior 548 | line. Skip delimiters on both sides. Uses `poporg-insert-with-prefix' to do 549 | the work. Move OVERLAY to the newly-inserted region." 550 | (let ((start-mark (set-marker (make-marker) start)) 551 | (end-mark (set-marker (make-marker) end))) 552 | (save-excursion 553 | (goto-char start) 554 | (skip-syntax-forward "\"|") 555 | (setq start (point))) 556 | (save-excursion 557 | (goto-char end) 558 | (skip-syntax-backward "\"|") 559 | (setq end (point))) 560 | (poporg-insert-with-prefix buf start end prefix 'no-first-line) 561 | ;; if the buffer is terminated by a newline, need to prepend the prefix before 562 | ;; the closing delimiter 563 | (when (with-current-buffer buf 564 | (save-excursion 565 | (goto-char (point-max)) 566 | (= (char-before) ?\n))) 567 | (insert prefix)) 568 | (move-overlay overlay 569 | (marker-position start-mark) 570 | (marker-position end-mark)))) 571 | 572 | ;; *** insert from region 573 | 574 | (defun poporg-get-region-lines (buf start end) 575 | "Insert lines into BUF between START and END with common prefix removed. 576 | 577 | This narrows the buffer before doing any parsing. The common prefix is 578 | calculated naively, as the literal common prefixes of all lines in the region 579 | \(after narrowing). 580 | 581 | Return (START END PREFIX) as in `poporg-get-comment-lines'. The returned START 582 | and END are the same as the passed arguments." 583 | (save-restriction 584 | (narrow-to-region start end) 585 | (save-excursion 586 | (goto-char (point-min)) 587 | (let (line-start prefix) 588 | (while (< (point) (point-max)) 589 | (setq line-start (point)) 590 | (skip-syntax-forward " ") 591 | (unless (eolp) 592 | ;; use the whole line to determine prefix 593 | (let ((line (buffer-substring-no-properties 594 | line-start 595 | (save-excursion (skip-chars-forward "^\n") 596 | (point))))) 597 | (if prefix 598 | (setq prefix (or (fill-common-string-prefix line prefix) 599 | "")) 600 | (setq prefix line)))) 601 | (forward-line 1)) 602 | (unless prefix (setq prefix "")) 603 | (poporg-insert-without-prefix buf prefix (point-min) (point-max)) 604 | (list (set-marker (make-marker) start) 605 | (set-marker (make-marker) end) 606 | prefix))))) 607 | 608 | (defun poporg-insert-region-lines (buf start end prefix overlay) 609 | "Insert the contents of BUF into the current buffer. 610 | 611 | Replace the region between START and END and prepend PREFIX onto each line. 612 | This simply runs `poporg-insert-with-prefix'. Move OVERLAY to the 613 | newly-inserted region." 614 | ;; don't have to do anything special 615 | (poporg-insert-with-prefix buf start end prefix) 616 | (move-overlay overlay start (point))) 617 | 618 | ;; ** make text mode buffer 619 | 620 | (defun poporg-edit-thing (start end type) 621 | "Edit the region from START to END in an empty buffer. 622 | 623 | Use the function `poporg-get-TYPE-lines' associated to TYPE to extract the 624 | region. Install the protection overlay on the extracted region. If there is an 625 | active editing overlay overlapping the region from START to END, pop to its edit 626 | buffer instead." 627 | (unless (poporg-check-already-edited start end) 628 | (let* ((edit-buffer (poporg-make-buffer)) 629 | (f-c fill-column) 630 | (poporg-orig-point (point)) 631 | (poporg-new-point 1) 632 | (inserter (intern (concat "poporg-get-" (symbol-name type) "-lines"))) 633 | (reg (funcall inserter edit-buffer start end)) 634 | (start (nth 0 reg)) 635 | (end (nth 1 reg)) 636 | (prefix (nth 2 reg)) 637 | (overlay (make-overlay start end))) 638 | (setq poporg-pre-window-configuration (current-window-configuration)) 639 | ;; Dim and protect the original text. 640 | (overlay-put overlay 'face 'poporg-edited-face) 641 | (overlay-put overlay 'intangible t) 642 | (overlay-put overlay 'read-only t) 643 | ;; Initialize a popup edit buffer. 644 | (pop-to-buffer edit-buffer) 645 | (goto-char poporg-new-point) 646 | ;; Don't allow undoing the initial buffer insertions. 647 | (buffer-disable-undo) 648 | (buffer-enable-undo) 649 | ;; Save buffer contents to a temporary file so the undo command knows 650 | ;; whether the contents have modified or not. This could potentially have 651 | ;; other uses later on. 652 | (let ((buf-name (buffer-name))) 653 | (set-visited-file-name (make-temp-file "poporg-")) 654 | (rename-buffer buf-name t)) 655 | (let ((require-final-newline nil)) (save-buffer)) 656 | ;; This is mainly to hide the `save-buffer' message 657 | (message 658 | (substitute-command-keys 659 | "poporg: type \\\\[poporg-edit-exit] when done")) 660 | ;;(set-buffer-modified-p nil) 661 | ;; Save data and possibly activate hooks. 662 | (unless poporg-data 663 | (push 'poporg-kill-buffer-query kill-buffer-query-functions) 664 | (add-hook 'kill-buffer-hook 'poporg-kill-buffer-routine)) 665 | (push (list edit-buffer overlay prefix type) poporg-data) 666 | (overlay-put overlay 'poporg-overlay (car poporg-data)) 667 | ;; All set up for editing. 668 | (with-demoted-errors "Edit hook error: %S" (run-hooks 'poporg-edit-hook)) 669 | (poporg-mode +1) 670 | ;; Adjust fill column after running the hooks and setting the mode since 671 | ;; org-mode sets the fill column. 672 | (when poporg-adjust-fill-column 673 | (setq fill-column (max 0 (- f-c (length prefix)))))))) 674 | 675 | ;; ** buffer kill hook functions 676 | 677 | (defun poporg-kill-buffer-query () 678 | "Warn when killing an edit buffer or a source buffer with active edit buffers." 679 | (let ((entry (assq (current-buffer) poporg-data))) 680 | (if entry 681 | (or (not (buffer-modified-p)) 682 | (yes-or-no-p "Really abandon this edit? ")) 683 | (let ((data poporg-data) 684 | (value t)) 685 | (while data 686 | (let ((buffer (overlay-buffer (cadar data)))) 687 | (if (not (eq buffer (current-buffer))) 688 | (setq data (cdr data)) 689 | (pop-to-buffer (caar data)) 690 | (message "First, either complete or kill this edit.") 691 | (setq data nil 692 | value nil)))) 693 | value)))) 694 | 695 | (defun poporg-kill-buffer-routine () 696 | "Cleanup an edit buffer whenever killed." 697 | ;; Delete the temporary file 698 | (let ((entry (assq (current-buffer) poporg-data))) 699 | (when entry 700 | (let* ((overlay (cadr entry)) 701 | (buffer (overlay-buffer overlay))) 702 | (when buffer 703 | (ignore-errors (set-buffer-modified-p nil) 704 | (delete-file (buffer-file-name))) 705 | (delete-overlay overlay) 706 | (setq poporg-data (delq entry poporg-data)) 707 | (unless poporg-data 708 | (setq kill-buffer-query-functions 709 | (delq 'poporg-kill-buffer-query kill-buffer-query-functions)) 710 | (remove-hook 'kill-buffer-hook 'poporg-kill-buffer-routine)) 711 | ;; switch back if we're killing the buffer in the selected window 712 | (when (equal (current-buffer) (window-buffer)) 713 | (unless (one-window-p) (delete-window)) 714 | (switch-to-buffer buffer))))))) 715 | 716 | ;; * Commands 717 | 718 | ;;;###autoload 719 | (defun poporg-dwim () 720 | "Single overall command for poporg (a single keybinding may do it all). 721 | 722 | If the current buffer is an edit buffer, run `poporg-edit-exit'. 723 | 724 | If the region is active, edit it in an empty buffer. Otherwise, find a nearby 725 | string or comment using `poporg-find-string-or-comment' and edit that in an 726 | empty buffer. If there is an active edit nearby, pop to its other buffer and 727 | edit that instead." 728 | (interactive) 729 | (let ((inhibit-point-motion-hooks t)) 730 | (cond 731 | ((assq (current-buffer) poporg-data) (poporg-edit-exit)) 732 | ((use-region-p) 733 | (poporg-edit-thing (region-beginning) (region-end) 'region)) 734 | (t 735 | (let ((reg (poporg-find-string-or-comment))) 736 | (cond 737 | ((eq (car reg) 'string) 738 | (poporg-edit-thing (nth 1 reg) (nth 2 reg) 'string)) 739 | ((eq (car reg) 'comment) 740 | (poporg-edit-thing (nth 1 reg) (nth 2 reg) 'comment)) 741 | (t 742 | (user-error "Nothing to edit!")))))))) 743 | 744 | ;;;###autoload 745 | (defun poporg-update (with-save) 746 | "Update the contents of the original buffer. 747 | 748 | If prefix argument WITH-SAVE is non-nil, save the original buffer too. 749 | 750 | Also update the overlay." 751 | (interactive "P") 752 | (let* ((edit-buffer (current-buffer)) 753 | (entry (assq edit-buffer poporg-data)) 754 | (overlay (cadr entry)) 755 | (buffer (when overlay (overlay-buffer overlay))) 756 | (prefix (caddr entry)) 757 | (type (nth 3 entry)) 758 | (poporg-orig-point (point)) 759 | (inserter (intern (concat "poporg-insert-" 760 | (symbol-name type) "-lines")))) 761 | (unless buffer 762 | (error "Not an edit buffer or original buffer vanished")) 763 | (when (buffer-modified-p) 764 | ;; Move everything back in place. 765 | ;; Allow the inserter to edit the region. 766 | (overlay-put overlay 'intangible nil) 767 | (overlay-put overlay 'read-only nil) 768 | (let* ((start (overlay-start overlay)) 769 | (end (overlay-end overlay))) 770 | (with-current-buffer buffer 771 | ;; This updates the overlay 772 | (funcall inserter edit-buffer start end prefix overlay)) 773 | ;; This is only used to mark the buffer as saved at this tamestamp, so 774 | ;; undo knows at what stage the buffer is unmodified 775 | (let ((require-final-newline nil)) (save-buffer)) 776 | ;; This is manily to hide the `save-buffer' message 777 | (message "poporg: original buffer updated")) 778 | (overlay-put overlay 'intangible t) 779 | (overlay-put overlay 'read-only t)) 780 | (with-current-buffer buffer (undo-boundary)) 781 | (when with-save (with-current-buffer buffer (save-buffer))))) 782 | 783 | ;;;###autoload 784 | (defun poporg-update-and-save () 785 | "Update and save the original buffer; update the region." 786 | (interactive) 787 | (poporg-update t)) 788 | 789 | ;;;###autoload 790 | (defun poporg-edit-exit () 791 | "Exit the edit buffer, replacing the original region." 792 | (interactive) 793 | (let* ((edit-buffer (current-buffer)) 794 | (entry (assq edit-buffer poporg-data)) 795 | (overlay (cadr entry)) 796 | (buffer (when overlay (overlay-buffer overlay))) 797 | poporg-new-point) 798 | (unless buffer 799 | (error "Not an edit buffer or original buffer vanished")) 800 | (poporg-update nil) 801 | (with-demoted-errors "Edit hook error: %S" 802 | (run-hooks 'poporg-edit-exit-hook)) 803 | ;; Killing the buffer triggers a cleanup through the kill hook. 804 | (kill-buffer edit-buffer) 805 | (set-window-configuration poporg-pre-window-configuration) 806 | (with-current-buffer buffer 807 | (let ((inhibit-point-motion-hooks t)) 808 | (when poporg-new-point ; unset if unmodified or aborted 809 | (goto-char poporg-new-point)))))) 810 | 811 | ;; ** mode 812 | 813 | (define-minor-mode poporg-mode 814 | "Install keybindings for a poporg edit buffer." 815 | nil " pop" poporg-mode-map) 816 | 817 | 818 | (provide 'poporg) 819 | 820 | ;; Local Variables: 821 | ;; coding: utf-8 822 | ;; End: 823 | 824 | ;;; poporg.el ends here 825 | --------------------------------------------------------------------------------