├── .gitignore ├── COPYING ├── README.md ├── README.org ├── doclicense.texi └── substitute.el /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | *-autoloads.el 3 | *-pkg.el 4 | substitute.info 5 | substitute.texi 6 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 2023 Protesilaos Stavrou 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) 2023 Free Software Foundation, Inc. 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 | # Substitute (substitute.el) for GNU Emacs 2 | 3 | Efficiently replace targets in the buffer or context. 4 | 5 | Substitute is a set of commands that perform text replacement (i) 6 | throughout the buffer, (ii) limited to the current definition (per 7 | `narrow-to-defun`), (iii) from point to the end of the buffer, and 8 | (iv) from point to the beginning of the buffer. 9 | 10 | These substitutions are meant to be as quick as possible and, as such, 11 | differ from the standard `query-replace` (which I still use). The 12 | provided commands prompt for substitute text and perform the 13 | substitution outright. 14 | 15 | **Video demo:** 16 | 17 | + Package name (GNU ELPA): `substitute` 18 | + Official manual: 19 | + Git repositories: 20 | + GitHub: 21 | + GitLab: 22 | + Video demo: 23 | + Backronym: Some Utilities Built to Substitute Targets Independent of 24 | Their Utterances, Thoroughly and Easily. 25 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+title: substitute: Efficiently replace targets in the buffer or context 2 | #+author: Protesilaos Stavrou 3 | #+email: info@protesilaos.com 4 | #+language: en 5 | #+options: ':t toc:nil author:t email:t num:t 6 | #+startup: content 7 | #+macro: stable-version 0.3.0 8 | #+macro: release-date 2024-05-20 9 | #+macro: development-version 0.4.0-dev 10 | #+export_file_name: substitute.texi 11 | #+texinfo_filename: substitute.info 12 | #+texinfo_dir_category: Emacs misc features 13 | #+texinfo_dir_title: Substitute: (substitute) 14 | #+texinfo_dir_desc: Efficiently replace targets in the buffer or context 15 | #+texinfo_header: @set MAINTAINERSITE @uref{https://protesilaos.com,maintainer webpage} 16 | #+texinfo_header: @set MAINTAINER Protesilaos Stavrou 17 | #+texinfo_header: @set MAINTAINEREMAIL @email{info@protesilaos.com} 18 | #+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:info@protesilaos.com,contact the maintainer} 19 | 20 | #+texinfo: @insertcopying 21 | 22 | This manual, written by Protesilaos Stavrou, describes the 23 | customization options for the Emacs package called ~substitute~ (or 24 | ~substitute.el~), and provides every other piece of information 25 | pertinent to it. 26 | 27 | The documentation furnished herein corresponds to stable version 28 | {{{stable-version}}}, released on {{{release-date}}}. Any reference to 29 | a newer feature which does not yet form part of the latest tagged 30 | commit, is explicitly marked as such. 31 | 32 | Current development target is {{{development-version}}}. 33 | 34 | + Package name (GNU ELPA): ~substitute~ 35 | + Official manual: 36 | + Git repositories: 37 | + GitHub: 38 | + GitLab: 39 | + Video demo: 40 | + Backronym: Some Utilities Built to Substitute Targets Independent of 41 | Their Utterances, Thoroughly and Easily. 42 | 43 | If you are viewing the README.org version of this file, please note that 44 | the GNU ELPA machinery automatically generates an Info manual out of it. 45 | 46 | #+toc: headlines 8 insert TOC here, with eight headline levels 47 | 48 | * Overview 49 | :PROPERTIES: 50 | :CUSTOM_ID: h:beae1a59-81ae-41ad-803b-f08caa03732b 51 | :END: 52 | 53 | Substitute is a set of commands that perform text replacement (i) 54 | throughout the buffer, (ii) limited to the current definition (per 55 | ~narrow-to-defun~), (iii) from point to the end of the buffer, and 56 | (iv) from point to the beginning of the buffer. 57 | 58 | These substitutions are meant to be as quick as possible and, as such, 59 | differ from the standard ~query-replace~ (which I still use). The 60 | provided commands prompt for substitute text and perform the 61 | substitution outright. 62 | 63 | The substitution prompt mentions the target-to-be-substituted. It is 64 | possible to use the "future history" at this prompt (by typing ~M-n~ 65 | with the default key bindings for the ~next-history-element~ command). 66 | This populates the prompt with the text of the target. As such, if we 67 | want to operate on =FOO= to make it =FOO-BAR=, we use ~M-n~ and then 68 | append =-BAR=. 69 | 70 | #+vindex: substitute-highlight 71 | By default, the substitution prompt informs the user about the target 72 | and highlights matches in the given scope (what the current command 73 | will substitute). Highlights can be disabled by setting the user 74 | option ~substitute-highlight~ to nil. 75 | 76 | The substitution commands behave the same way except for their scope 77 | of application. What they have in common is how they identify the 78 | target of the substitution: it is either the symbol at point or the 79 | text within the boundaries of the active region. The differences in 80 | scope are as follows: 81 | 82 | #+findex: substitute-target-in-buffer 83 | 1. ~substitute-target-in-buffer~: Substitute the target across the 84 | entire buffer. 85 | 86 | #+findex: substitute-target-in-defun 87 | 2. ~substitute-target-in-defun~: Substitute the target only in the 88 | current definition (per ~narrow-to-defun~). 89 | 90 | #+findex: substitute-target-below-point 91 | #+findex: substitute-target-to-end-of-buffer 92 | 3. ~substitute-target-below-point~: Substitute the target from point 93 | to the end of the buffer (alias ~substitute-target-to-end-of-buffer~). 94 | 95 | #+findex: substitute-target-above-point 96 | #+findex:~substitute-target-to-beginning-of-buffer 97 | 4. ~substitute-target-above-point~: Substitute the target from point 98 | to the beginning of the buffer (alias ~substitute-target-to-beginning-of-buffer~). 99 | 100 | #+vindex: substitute-fixed-letter-case 101 | All of the aforementioned commands accept an optional prefix argument 102 | (=C-u= with the default key bindings). This passes the =FIXED-CASE= 103 | argument, which means that the substitution will not try to preserve 104 | the letter casing of the target text. Concretely, targeting =test= 105 | and =TEST= with a substitute of =test-new= will make both of those 106 | lower case. Whereas without the prefix argument the result would be 107 | =test-new= and =TEST-NEW=. In many cases this is the desired effect. 108 | To always have fixed letter casing, set the user option 109 | ~substitute-fixed-letter-case~ to a non-nil value. Doing so is the 110 | same as always calling the aforementioned commands with a prefix 111 | argument. 112 | 113 | #+vindex: substitute-post-replace-functions 114 | #+findex: substitute-report-operation 115 | Every substitution triggers the ~substitute-post-replace-functions~. 116 | This special hook runs any function assigned to it with four 117 | arguments: =TARGET=, =SUB=, =COUNT=, and =SCOPE=. For a reference 118 | function, see ~substitute-report-operation~. This hook can be 119 | leveraged by the user to produce a report on what just happened by 120 | printing a message to the echo area. Custom functions that accept 121 | those arguments are to the discretion of the user. By default, the 122 | hook is empty and no post-substitution action is performed (e.g. the 123 | ~substitute-report-operation~). 124 | 125 | #+findex: substitute-prefix-map 126 | The command ~substitute-prefix-map~ can be assigned to a key to make 127 | it work as a prefix. This way, all Substitute commands are readily 128 | available. For example: 129 | 130 | #+begin_src emacs-lisp 131 | (define-key global-map (kbd "C-c s") #'substitute-prefix-map) 132 | #+end_src 133 | 134 | After evaluating that, type =C-c s C-h= to learn about all the key 135 | bindings. To change those, use something like this: 136 | 137 | #+begin_src emacs-lisp 138 | (define-key substitute-prefix-map (kbd "b") #'substitute-target-in-buffer) 139 | (define-key substitute-prefix-map (kbd "d") #'substitute-target-in-defun) 140 | (define-key substitute-prefix-map (kbd "r") #'substitute-target-above-point) 141 | (define-key substitute-prefix-map (kbd "s") #'substitute-target-below-point) 142 | #+end_src 143 | 144 | * Installation 145 | :PROPERTIES: 146 | :CUSTOM_ID: h:4943ebc8-45e5-4352-8d51-9a09efa16b74 147 | :END: 148 | #+cindex: Installation instructions 149 | 150 | ** GNU ELPA package 151 | :PROPERTIES: 152 | :CUSTOM_ID: h:ab97c462-01cc-408a-adf2-aadd87a22e90 153 | :END: 154 | 155 | The package is available as ~substitute~. Simply do: 156 | 157 | : M-x package-refresh-contents 158 | : M-x package-install 159 | 160 | And search for it. 161 | 162 | GNU ELPA provides the latest stable release. Those who prefer to follow 163 | the development process in order to report bugs or suggest changes, can 164 | use the version of the package from the GNU-devel ELPA archive. Read: 165 | https://protesilaos.com/codelog/2022-05-13-emacs-elpa-devel/. 166 | 167 | ** Manual installation 168 | :PROPERTIES: 169 | :CUSTOM_ID: h:7fbd9efd-284a-41fb-bbfa-8e28f102e78e 170 | :END: 171 | 172 | Assuming your Emacs files are found in =~/.emacs.d/=, execute the 173 | following commands in a shell prompt: 174 | 175 | #+begin_src sh 176 | cd ~/.emacs.d 177 | 178 | # Create a directory for manually-installed packages 179 | mkdir manual-packages 180 | 181 | # Go to the new directory 182 | cd manual-packages 183 | 184 | # Clone this repo, naming it "substitute" 185 | git clone https://github.com/protesilaos/substitute substitute 186 | #+end_src 187 | 188 | Finally, in your =init.el= (or equivalent) evaluate this: 189 | 190 | #+begin_src emacs-lisp 191 | ;; Make Elisp files in that directory available to the user. 192 | (add-to-list 'load-path "~/.emacs.d/manual-packages/substitute") 193 | #+end_src 194 | 195 | Everything is in place to set up the package. 196 | 197 | * Sample configuration 198 | :PROPERTIES: 199 | :CUSTOM_ID: h:e8691728-79b2-4b37-b6ce-e29a4cd9114f 200 | :END: 201 | 202 | #+begin_src emacs-lisp 203 | (require 'substitute) 204 | 205 | ;; Set this to nil if you do not like visual feedback on the matching 206 | ;; target. Default is t. 207 | (setq substitute-highlight nil) 208 | 209 | ;; Set this to t if you want to always treat the letter casing 210 | ;; literally. Otherwise each command accepts a `C-u' prefix 211 | ;; argument to do this on-demand. 212 | (setq substitute-fixed-letter-case t) 213 | 214 | ;; If you want a message reporting the matches that changed in the 215 | ;; given context. We don't do it by default. 216 | (add-hook 'substitute-post-replace-functions #'substitute-report-operation) 217 | 218 | ;; Use C-c s as a prefix for all Substitute commands. 219 | (define-key global-map (kbd "C-c s") #'substitute-prefix-map) 220 | #+end_src 221 | 222 | * Acknowledgements 223 | :PROPERTIES: 224 | :CUSTOM_ID: h:532c5398-9510-47d4-a718-a5dfa8f86a3f 225 | :END: 226 | #+cindex: Contributors 227 | 228 | ~substitute~ is meant to be a collective effort. Every bit of help 229 | matters. 230 | 231 | + Author/maintainer :: Protesilaos Stavrou. 232 | 233 | + Contributions to code or the manual :: Ed Tavinor, Kostas Andreadis, 234 | Wang Chunye. 235 | 236 | + Ideas and/or user feedback :: Tomasz Hołubowicz, ersi-dnd, revrari. 237 | 238 | * COPYING 239 | :PROPERTIES: 240 | :CUSTOM_ID: h:055d634a-cd8a-49e8-86f6-0027325e752c 241 | :COPYING: t 242 | :END: 243 | 244 | Copyright (C) 2023-2025 Free Software Foundation, Inc. 245 | 246 | #+begin_quote 247 | Permission is granted to copy, distribute and/or modify this document 248 | under the terms of the GNU Free Documentation License, Version 1.3 or 249 | any later version published by the Free Software Foundation; with no 250 | Invariant Sections, with the Front-Cover Texts being “A GNU Manual,” and 251 | with the Back-Cover Texts as in (a) below. A copy of the license is 252 | included in the section entitled “GNU Free Documentation License.” 253 | 254 | (a) The FSF’s Back-Cover Text is: “You have the freedom to copy and 255 | modify this GNU manual.” 256 | #+end_quote 257 | 258 | * GNU Free Documentation License 259 | :PROPERTIES: 260 | :CUSTOM_ID: h:11e2447a-6f5d-42c3-b444-746a478a14a0 261 | :END: 262 | 263 | #+texinfo: @include doclicense.texi 264 | 265 | #+begin_export html 266 | 
267 | 
268 |                 GNU Free Documentation License
269 |                  Version 1.3, 3 November 2008
270 | 
271 | 
272 |  Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
273 |      
274 |  Everyone is permitted to copy and distribute verbatim copies
275 |  of this license document, but changing it is not allowed.
276 | 
277 | 0. PREAMBLE
278 | 
279 | The purpose of this License is to make a manual, textbook, or other
280 | functional and useful document "free" in the sense of freedom: to
281 | assure everyone the effective freedom to copy and redistribute it,
282 | with or without modifying it, either commercially or noncommercially.
283 | Secondarily, this License preserves for the author and publisher a way
284 | to get credit for their work, while not being considered responsible
285 | for modifications made by others.
286 | 
287 | This License is a kind of "copyleft", which means that derivative
288 | works of the document must themselves be free in the same sense.  It
289 | complements the GNU General Public License, which is a copyleft
290 | license designed for free software.
291 | 
292 | We have designed this License in order to use it for manuals for free
293 | software, because free software needs free documentation: a free
294 | program should come with manuals providing the same freedoms that the
295 | software does.  But this License is not limited to software manuals;
296 | it can be used for any textual work, regardless of subject matter or
297 | whether it is published as a printed book.  We recommend this License
298 | principally for works whose purpose is instruction or reference.
299 | 
300 | 
301 | 1. APPLICABILITY AND DEFINITIONS
302 | 
303 | This License applies to any manual or other work, in any medium, that
304 | contains a notice placed by the copyright holder saying it can be
305 | distributed under the terms of this License.  Such a notice grants a
306 | world-wide, royalty-free license, unlimited in duration, to use that
307 | work under the conditions stated herein.  The "Document", below,
308 | refers to any such manual or work.  Any member of the public is a
309 | licensee, and is addressed as "you".  You accept the license if you
310 | copy, modify or distribute the work in a way requiring permission
311 | under copyright law.
312 | 
313 | A "Modified Version" of the Document means any work containing the
314 | Document or a portion of it, either copied verbatim, or with
315 | modifications and/or translated into another language.
316 | 
317 | A "Secondary Section" is a named appendix or a front-matter section of
318 | the Document that deals exclusively with the relationship of the
319 | publishers or authors of the Document to the Document's overall
320 | subject (or to related matters) and contains nothing that could fall
321 | directly within that overall subject.  (Thus, if the Document is in
322 | part a textbook of mathematics, a Secondary Section may not explain
323 | any mathematics.)  The relationship could be a matter of historical
324 | connection with the subject or with related matters, or of legal,
325 | commercial, philosophical, ethical or political position regarding
326 | them.
327 | 
328 | The "Invariant Sections" are certain Secondary Sections whose titles
329 | are designated, as being those of Invariant Sections, in the notice
330 | that says that the Document is released under this License.  If a
331 | section does not fit the above definition of Secondary then it is not
332 | allowed to be designated as Invariant.  The Document may contain zero
333 | Invariant Sections.  If the Document does not identify any Invariant
334 | Sections then there are none.
335 | 
336 | The "Cover Texts" are certain short passages of text that are listed,
337 | as Front-Cover Texts or Back-Cover Texts, in the notice that says that
338 | the Document is released under this License.  A Front-Cover Text may
339 | be at most 5 words, and a Back-Cover Text may be at most 25 words.
340 | 
341 | A "Transparent" copy of the Document means a machine-readable copy,
342 | represented in a format whose specification is available to the
343 | general public, that is suitable for revising the document
344 | straightforwardly with generic text editors or (for images composed of
345 | pixels) generic paint programs or (for drawings) some widely available
346 | drawing editor, and that is suitable for input to text formatters or
347 | for automatic translation to a variety of formats suitable for input
348 | to text formatters.  A copy made in an otherwise Transparent file
349 | format whose markup, or absence of markup, has been arranged to thwart
350 | or discourage subsequent modification by readers is not Transparent.
351 | An image format is not Transparent if used for any substantial amount
352 | of text.  A copy that is not "Transparent" is called "Opaque".
353 | 
354 | Examples of suitable formats for Transparent copies include plain
355 | ASCII without markup, Texinfo input format, LaTeX input format, SGML
356 | or XML using a publicly available DTD, and standard-conforming simple
357 | HTML, PostScript or PDF designed for human modification.  Examples of
358 | transparent image formats include PNG, XCF and JPG.  Opaque formats
359 | include proprietary formats that can be read and edited only by
360 | proprietary word processors, SGML or XML for which the DTD and/or
361 | processing tools are not generally available, and the
362 | machine-generated HTML, PostScript or PDF produced by some word
363 | processors for output purposes only.
364 | 
365 | The "Title Page" means, for a printed book, the title page itself,
366 | plus such following pages as are needed to hold, legibly, the material
367 | this License requires to appear in the title page.  For works in
368 | formats which do not have any title page as such, "Title Page" means
369 | the text near the most prominent appearance of the work's title,
370 | preceding the beginning of the body of the text.
371 | 
372 | The "publisher" means any person or entity that distributes copies of
373 | the Document to the public.
374 | 
375 | A section "Entitled XYZ" means a named subunit of the Document whose
376 | title either is precisely XYZ or contains XYZ in parentheses following
377 | text that translates XYZ in another language.  (Here XYZ stands for a
378 | specific section name mentioned below, such as "Acknowledgements",
379 | "Dedications", "Endorsements", or "History".)  To "Preserve the Title"
380 | of such a section when you modify the Document means that it remains a
381 | section "Entitled XYZ" according to this definition.
382 | 
383 | The Document may include Warranty Disclaimers next to the notice which
384 | states that this License applies to the Document.  These Warranty
385 | Disclaimers are considered to be included by reference in this
386 | License, but only as regards disclaiming warranties: any other
387 | implication that these Warranty Disclaimers may have is void and has
388 | no effect on the meaning of this License.
389 | 
390 | 2. VERBATIM COPYING
391 | 
392 | You may copy and distribute the Document in any medium, either
393 | commercially or noncommercially, provided that this License, the
394 | copyright notices, and the license notice saying this License applies
395 | to the Document are reproduced in all copies, and that you add no
396 | other conditions whatsoever to those of this License.  You may not use
397 | technical measures to obstruct or control the reading or further
398 | copying of the copies you make or distribute.  However, you may accept
399 | compensation in exchange for copies.  If you distribute a large enough
400 | number of copies you must also follow the conditions in section 3.
401 | 
402 | You may also lend copies, under the same conditions stated above, and
403 | you may publicly display copies.
404 | 
405 | 
406 | 3. COPYING IN QUANTITY
407 | 
408 | If you publish printed copies (or copies in media that commonly have
409 | printed covers) of the Document, numbering more than 100, and the
410 | Document's license notice requires Cover Texts, you must enclose the
411 | copies in covers that carry, clearly and legibly, all these Cover
412 | Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
413 | the back cover.  Both covers must also clearly and legibly identify
414 | you as the publisher of these copies.  The front cover must present
415 | the full title with all words of the title equally prominent and
416 | visible.  You may add other material on the covers in addition.
417 | Copying with changes limited to the covers, as long as they preserve
418 | the title of the Document and satisfy these conditions, can be treated
419 | as verbatim copying in other respects.
420 | 
421 | If the required texts for either cover are too voluminous to fit
422 | legibly, you should put the first ones listed (as many as fit
423 | reasonably) on the actual cover, and continue the rest onto adjacent
424 | pages.
425 | 
426 | If you publish or distribute Opaque copies of the Document numbering
427 | more than 100, you must either include a machine-readable Transparent
428 | copy along with each Opaque copy, or state in or with each Opaque copy
429 | a computer-network location from which the general network-using
430 | public has access to download using public-standard network protocols
431 | a complete Transparent copy of the Document, free of added material.
432 | If you use the latter option, you must take reasonably prudent steps,
433 | when you begin distribution of Opaque copies in quantity, to ensure
434 | that this Transparent copy will remain thus accessible at the stated
435 | location until at least one year after the last time you distribute an
436 | Opaque copy (directly or through your agents or retailers) of that
437 | edition to the public.
438 | 
439 | It is requested, but not required, that you contact the authors of the
440 | Document well before redistributing any large number of copies, to
441 | give them a chance to provide you with an updated version of the
442 | Document.
443 | 
444 | 
445 | 4. MODIFICATIONS
446 | 
447 | You may copy and distribute a Modified Version of the Document under
448 | the conditions of sections 2 and 3 above, provided that you release
449 | the Modified Version under precisely this License, with the Modified
450 | Version filling the role of the Document, thus licensing distribution
451 | and modification of the Modified Version to whoever possesses a copy
452 | of it.  In addition, you must do these things in the Modified Version:
453 | 
454 | A. Use in the Title Page (and on the covers, if any) a title distinct
455 |    from that of the Document, and from those of previous versions
456 |    (which should, if there were any, be listed in the History section
457 |    of the Document).  You may use the same title as a previous version
458 |    if the original publisher of that version gives permission.
459 | B. List on the Title Page, as authors, one or more persons or entities
460 |    responsible for authorship of the modifications in the Modified
461 |    Version, together with at least five of the principal authors of the
462 |    Document (all of its principal authors, if it has fewer than five),
463 |    unless they release you from this requirement.
464 | C. State on the Title page the name of the publisher of the
465 |    Modified Version, as the publisher.
466 | D. Preserve all the copyright notices of the Document.
467 | E. Add an appropriate copyright notice for your modifications
468 |    adjacent to the other copyright notices.
469 | F. Include, immediately after the copyright notices, a license notice
470 |    giving the public permission to use the Modified Version under the
471 |    terms of this License, in the form shown in the Addendum below.
472 | G. Preserve in that license notice the full lists of Invariant Sections
473 |    and required Cover Texts given in the Document's license notice.
474 | H. Include an unaltered copy of this License.
475 | I. Preserve the section Entitled "History", Preserve its Title, and add
476 |    to it an item stating at least the title, year, new authors, and
477 |    publisher of the Modified Version as given on the Title Page.  If
478 |    there is no section Entitled "History" in the Document, create one
479 |    stating the title, year, authors, and publisher of the Document as
480 |    given on its Title Page, then add an item describing the Modified
481 |    Version as stated in the previous sentence.
482 | J. Preserve the network location, if any, given in the Document for
483 |    public access to a Transparent copy of the Document, and likewise
484 |    the network locations given in the Document for previous versions
485 |    it was based on.  These may be placed in the "History" section.
486 |    You may omit a network location for a work that was published at
487 |    least four years before the Document itself, or if the original
488 |    publisher of the version it refers to gives permission.
489 | K. For any section Entitled "Acknowledgements" or "Dedications",
490 |    Preserve the Title of the section, and preserve in the section all
491 |    the substance and tone of each of the contributor acknowledgements
492 |    and/or dedications given therein.
493 | L. Preserve all the Invariant Sections of the Document,
494 |    unaltered in their text and in their titles.  Section numbers
495 |    or the equivalent are not considered part of the section titles.
496 | M. Delete any section Entitled "Endorsements".  Such a section
497 |    may not be included in the Modified Version.
498 | N. Do not retitle any existing section to be Entitled "Endorsements"
499 |    or to conflict in title with any Invariant Section.
500 | O. Preserve any Warranty Disclaimers.
501 | 
502 | If the Modified Version includes new front-matter sections or
503 | appendices that qualify as Secondary Sections and contain no material
504 | copied from the Document, you may at your option designate some or all
505 | of these sections as invariant.  To do this, add their titles to the
506 | list of Invariant Sections in the Modified Version's license notice.
507 | These titles must be distinct from any other section titles.
508 | 
509 | You may add a section Entitled "Endorsements", provided it contains
510 | nothing but endorsements of your Modified Version by various
511 | parties--for example, statements of peer review or that the text has
512 | been approved by an organization as the authoritative definition of a
513 | standard.
514 | 
515 | You may add a passage of up to five words as a Front-Cover Text, and a
516 | passage of up to 25 words as a Back-Cover Text, to the end of the list
517 | of Cover Texts in the Modified Version.  Only one passage of
518 | Front-Cover Text and one of Back-Cover Text may be added by (or
519 | through arrangements made by) any one entity.  If the Document already
520 | includes a cover text for the same cover, previously added by you or
521 | by arrangement made by the same entity you are acting on behalf of,
522 | you may not add another; but you may replace the old one, on explicit
523 | permission from the previous publisher that added the old one.
524 | 
525 | The author(s) and publisher(s) of the Document do not by this License
526 | give permission to use their names for publicity for or to assert or
527 | imply endorsement of any Modified Version.
528 | 
529 | 
530 | 5. COMBINING DOCUMENTS
531 | 
532 | You may combine the Document with other documents released under this
533 | License, under the terms defined in section 4 above for modified
534 | versions, provided that you include in the combination all of the
535 | Invariant Sections of all of the original documents, unmodified, and
536 | list them all as Invariant Sections of your combined work in its
537 | license notice, and that you preserve all their Warranty Disclaimers.
538 | 
539 | The combined work need only contain one copy of this License, and
540 | multiple identical Invariant Sections may be replaced with a single
541 | copy.  If there are multiple Invariant Sections with the same name but
542 | different contents, make the title of each such section unique by
543 | adding at the end of it, in parentheses, the name of the original
544 | author or publisher of that section if known, or else a unique number.
545 | Make the same adjustment to the section titles in the list of
546 | Invariant Sections in the license notice of the combined work.
547 | 
548 | In the combination, you must combine any sections Entitled "History"
549 | in the various original documents, forming one section Entitled
550 | "History"; likewise combine any sections Entitled "Acknowledgements",
551 | and any sections Entitled "Dedications".  You must delete all sections
552 | Entitled "Endorsements".
553 | 
554 | 
555 | 6. COLLECTIONS OF DOCUMENTS
556 | 
557 | You may make a collection consisting of the Document and other
558 | documents released under this License, and replace the individual
559 | copies of this License in the various documents with a single copy
560 | that is included in the collection, provided that you follow the rules
561 | of this License for verbatim copying of each of the documents in all
562 | other respects.
563 | 
564 | You may extract a single document from such a collection, and
565 | distribute it individually under this License, provided you insert a
566 | copy of this License into the extracted document, and follow this
567 | License in all other respects regarding verbatim copying of that
568 | document.
569 | 
570 | 
571 | 7. AGGREGATION WITH INDEPENDENT WORKS
572 | 
573 | A compilation of the Document or its derivatives with other separate
574 | and independent documents or works, in or on a volume of a storage or
575 | distribution medium, is called an "aggregate" if the copyright
576 | resulting from the compilation is not used to limit the legal rights
577 | of the compilation's users beyond what the individual works permit.
578 | When the Document is included in an aggregate, this License does not
579 | apply to the other works in the aggregate which are not themselves
580 | derivative works of the Document.
581 | 
582 | If the Cover Text requirement of section 3 is applicable to these
583 | copies of the Document, then if the Document is less than one half of
584 | the entire aggregate, the Document's Cover Texts may be placed on
585 | covers that bracket the Document within the aggregate, or the
586 | electronic equivalent of covers if the Document is in electronic form.
587 | Otherwise they must appear on printed covers that bracket the whole
588 | aggregate.
589 | 
590 | 
591 | 8. TRANSLATION
592 | 
593 | Translation is considered a kind of modification, so you may
594 | distribute translations of the Document under the terms of section 4.
595 | Replacing Invariant Sections with translations requires special
596 | permission from their copyright holders, but you may include
597 | translations of some or all Invariant Sections in addition to the
598 | original versions of these Invariant Sections.  You may include a
599 | translation of this License, and all the license notices in the
600 | Document, and any Warranty Disclaimers, provided that you also include
601 | the original English version of this License and the original versions
602 | of those notices and disclaimers.  In case of a disagreement between
603 | the translation and the original version of this License or a notice
604 | or disclaimer, the original version will prevail.
605 | 
606 | If a section in the Document is Entitled "Acknowledgements",
607 | "Dedications", or "History", the requirement (section 4) to Preserve
608 | its Title (section 1) will typically require changing the actual
609 | title.
610 | 
611 | 
612 | 9. TERMINATION
613 | 
614 | You may not copy, modify, sublicense, or distribute the Document
615 | except as expressly provided under this License.  Any attempt
616 | otherwise to copy, modify, sublicense, or distribute it is void, and
617 | will automatically terminate your rights under this License.
618 | 
619 | However, if you cease all violation of this License, then your license
620 | from a particular copyright holder is reinstated (a) provisionally,
621 | unless and until the copyright holder explicitly and finally
622 | terminates your license, and (b) permanently, if the copyright holder
623 | fails to notify you of the violation by some reasonable means prior to
624 | 60 days after the cessation.
625 | 
626 | Moreover, your license from a particular copyright holder is
627 | reinstated permanently if the copyright holder notifies you of the
628 | violation by some reasonable means, this is the first time you have
629 | received notice of violation of this License (for any work) from that
630 | copyright holder, and you cure the violation prior to 30 days after
631 | your receipt of the notice.
632 | 
633 | Termination of your rights under this section does not terminate the
634 | licenses of parties who have received copies or rights from you under
635 | this License.  If your rights have been terminated and not permanently
636 | reinstated, receipt of a copy of some or all of the same material does
637 | not give you any rights to use it.
638 | 
639 | 
640 | 10. FUTURE REVISIONS OF THIS LICENSE
641 | 
642 | The Free Software Foundation may publish new, revised versions of the
643 | GNU Free Documentation License from time to time.  Such new versions
644 | will be similar in spirit to the present version, but may differ in
645 | detail to address new problems or concerns.  See
646 | https://www.gnu.org/licenses/.
647 | 
648 | Each version of the License is given a distinguishing version number.
649 | If the Document specifies that a particular numbered version of this
650 | License "or any later version" applies to it, you have the option of
651 | following the terms and conditions either of that specified version or
652 | of any later version that has been published (not as a draft) by the
653 | Free Software Foundation.  If the Document does not specify a version
654 | number of this License, you may choose any version ever published (not
655 | as a draft) by the Free Software Foundation.  If the Document
656 | specifies that a proxy can decide which future versions of this
657 | License can be used, that proxy's public statement of acceptance of a
658 | version permanently authorizes you to choose that version for the
659 | Document.
660 | 
661 | 11. RELICENSING
662 | 
663 | "Massive Multiauthor Collaboration Site" (or "MMC Site") means any
664 | World Wide Web server that publishes copyrightable works and also
665 | provides prominent facilities for anybody to edit those works.  A
666 | public wiki that anybody can edit is an example of such a server.  A
667 | "Massive Multiauthor Collaboration" (or "MMC") contained in the site
668 | means any set of copyrightable works thus published on the MMC site.
669 | 
670 | "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
671 | license published by Creative Commons Corporation, a not-for-profit
672 | corporation with a principal place of business in San Francisco,
673 | California, as well as future copyleft versions of that license
674 | published by that same organization.
675 | 
676 | "Incorporate" means to publish or republish a Document, in whole or in
677 | part, as part of another Document.
678 | 
679 | An MMC is "eligible for relicensing" if it is licensed under this
680 | License, and if all works that were first published under this License
681 | somewhere other than this MMC, and subsequently incorporated in whole or
682 | in part into the MMC, (1) had no cover texts or invariant sections, and
683 | (2) were thus incorporated prior to November 1, 2008.
684 | 
685 | The operator of an MMC Site may republish an MMC contained in the site
686 | under CC-BY-SA on the same site at any time before August 1, 2009,
687 | provided the MMC is eligible for relicensing.
688 | 
689 | 
690 | ADDENDUM: How to use this License for your documents
691 | 
692 | To use this License in a document you have written, include a copy of
693 | the License in the document and put the following copyright and
694 | license notices just after the title page:
695 | 
696 |     Copyright (c)  YEAR  YOUR NAME.
697 |     Permission is granted to copy, distribute and/or modify this document
698 |     under the terms of the GNU Free Documentation License, Version 1.3
699 |     or any later version published by the Free Software Foundation;
700 |     with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
701 |     A copy of the license is included in the section entitled "GNU
702 |     Free Documentation License".
703 | 
704 | If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
705 | replace the "with...Texts." line with this:
706 | 
707 |     with the Invariant Sections being LIST THEIR TITLES, with the
708 |     Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
709 | 
710 | If you have Invariant Sections without Cover Texts, or some other
711 | combination of the three, merge those two alternatives to suit the
712 | situation.
713 | 
714 | If your document contains nontrivial examples of program code, we
715 | recommend releasing these examples in parallel under your choice of
716 | free software license, such as the GNU General Public License,
717 | to permit their use in free software.
718 |
719 | #+end_export 720 | 721 | #+html: 747 | -------------------------------------------------------------------------------- /doclicense.texi: -------------------------------------------------------------------------------- 1 | @c The GNU Free Documentation License. 2 | @center Version 1.3, 3 November 2008 3 | 4 | @c This file is intended to be included within another document, 5 | @c hence no sectioning command or @node. 6 | 7 | @display 8 | Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. 9 | @uref{https://fsf.org/} 10 | 11 | Everyone is permitted to copy and distribute verbatim copies 12 | of this license document, but changing it is not allowed. 13 | @end display 14 | 15 | @enumerate 0 16 | @item 17 | PREAMBLE 18 | 19 | The purpose of this License is to make a manual, textbook, or other 20 | functional and useful document @dfn{free} in the sense of freedom: to 21 | assure everyone the effective freedom to copy and redistribute it, 22 | with or without modifying it, either commercially or noncommercially. 23 | Secondarily, this License preserves for the author and publisher a way 24 | to get credit for their work, while not being considered responsible 25 | for modifications made by others. 26 | 27 | This License is a kind of ``copyleft'', which means that derivative 28 | works of the document must themselves be free in the same sense. It 29 | complements the GNU General Public License, which is a copyleft 30 | license designed for free software. 31 | 32 | We have designed this License in order to use it for manuals for free 33 | software, because free software needs free documentation: a free 34 | program should come with manuals providing the same freedoms that the 35 | software does. But this License is not limited to software manuals; 36 | it can be used for any textual work, regardless of subject matter or 37 | whether it is published as a printed book. We recommend this License 38 | principally for works whose purpose is instruction or reference. 39 | 40 | @item 41 | APPLICABILITY AND DEFINITIONS 42 | 43 | This License applies to any manual or other work, in any medium, that 44 | contains a notice placed by the copyright holder saying it can be 45 | distributed under the terms of this License. Such a notice grants a 46 | world-wide, royalty-free license, unlimited in duration, to use that 47 | work under the conditions stated herein. The ``Document'', below, 48 | refers to any such manual or work. Any member of the public is a 49 | licensee, and is addressed as ``you''. You accept the license if you 50 | copy, modify or distribute the work in a way requiring permission 51 | under copyright law. 52 | 53 | A ``Modified Version'' of the Document means any work containing the 54 | Document or a portion of it, either copied verbatim, or with 55 | modifications and/or translated into another language. 56 | 57 | A ``Secondary Section'' is a named appendix or a front-matter section 58 | of the Document that deals exclusively with the relationship of the 59 | publishers or authors of the Document to the Document's overall 60 | subject (or to related matters) and contains nothing that could fall 61 | directly within that overall subject. (Thus, if the Document is in 62 | part a textbook of mathematics, a Secondary Section may not explain 63 | any mathematics.) The relationship could be a matter of historical 64 | connection with the subject or with related matters, or of legal, 65 | commercial, philosophical, ethical or political position regarding 66 | them. 67 | 68 | The ``Invariant Sections'' are certain Secondary Sections whose titles 69 | are designated, as being those of Invariant Sections, in the notice 70 | that says that the Document is released under this License. If a 71 | section does not fit the above definition of Secondary then it is not 72 | allowed to be designated as Invariant. The Document may contain zero 73 | Invariant Sections. If the Document does not identify any Invariant 74 | Sections then there are none. 75 | 76 | The ``Cover Texts'' are certain short passages of text that are listed, 77 | as Front-Cover Texts or Back-Cover Texts, in the notice that says that 78 | the Document is released under this License. A Front-Cover Text may 79 | be at most 5 words, and a Back-Cover Text may be at most 25 words. 80 | 81 | A ``Transparent'' copy of the Document means a machine-readable copy, 82 | represented in a format whose specification is available to the 83 | general public, that is suitable for revising the document 84 | straightforwardly with generic text editors or (for images composed of 85 | pixels) generic paint programs or (for drawings) some widely available 86 | drawing editor, and that is suitable for input to text formatters or 87 | for automatic translation to a variety of formats suitable for input 88 | to text formatters. A copy made in an otherwise Transparent file 89 | format whose markup, or absence of markup, has been arranged to thwart 90 | or discourage subsequent modification by readers is not Transparent. 91 | An image format is not Transparent if used for any substantial amount 92 | of text. A copy that is not ``Transparent'' is called ``Opaque''. 93 | 94 | Examples of suitable formats for Transparent copies include plain 95 | ASCII without markup, Texinfo input format, La@TeX{} input 96 | format, SGML or XML using a publicly available 97 | DTD, and standard-conforming simple HTML, 98 | PostScript or PDF designed for human modification. Examples 99 | of transparent image formats include PNG, XCF and 100 | JPG@. Opaque formats include proprietary formats that can be 101 | read and edited only by proprietary word processors, SGML or 102 | XML for which the DTD and/or processing tools are 103 | not generally available, and the machine-generated HTML, 104 | PostScript or PDF produced by some word processors for 105 | output purposes only. 106 | 107 | The ``Title Page'' means, for a printed book, the title page itself, 108 | plus such following pages as are needed to hold, legibly, the material 109 | this License requires to appear in the title page. For works in 110 | formats which do not have any title page as such, ``Title Page'' means 111 | the text near the most prominent appearance of the work's title, 112 | preceding the beginning of the body of the text. 113 | 114 | The ``publisher'' means any person or entity that distributes copies 115 | of the Document to the public. 116 | 117 | A section ``Entitled XYZ'' means a named subunit of the Document whose 118 | title either is precisely XYZ or contains XYZ in parentheses following 119 | text that translates XYZ in another language. (Here XYZ stands for a 120 | specific section name mentioned below, such as ``Acknowledgements'', 121 | ``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' 122 | of such a section when you modify the Document means that it remains a 123 | section ``Entitled XYZ'' according to this definition. 124 | 125 | The Document may include Warranty Disclaimers next to the notice which 126 | states that this License applies to the Document. These Warranty 127 | Disclaimers are considered to be included by reference in this 128 | License, but only as regards disclaiming warranties: any other 129 | implication that these Warranty Disclaimers may have is void and has 130 | no effect on the meaning of this License. 131 | 132 | @item 133 | VERBATIM COPYING 134 | 135 | You may copy and distribute the Document in any medium, either 136 | commercially or noncommercially, provided that this License, the 137 | copyright notices, and the license notice saying this License applies 138 | to the Document are reproduced in all copies, and that you add no other 139 | conditions whatsoever to those of this License. You may not use 140 | technical measures to obstruct or control the reading or further 141 | copying of the copies you make or distribute. However, you may accept 142 | compensation in exchange for copies. If you distribute a large enough 143 | number of copies you must also follow the conditions in section 3. 144 | 145 | You may also lend copies, under the same conditions stated above, and 146 | you may publicly display copies. 147 | 148 | @item 149 | COPYING IN QUANTITY 150 | 151 | If you publish printed copies (or copies in media that commonly have 152 | printed covers) of the Document, numbering more than 100, and the 153 | Document's license notice requires Cover Texts, you must enclose the 154 | copies in covers that carry, clearly and legibly, all these Cover 155 | Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on 156 | the back cover. Both covers must also clearly and legibly identify 157 | you as the publisher of these copies. The front cover must present 158 | the full title with all words of the title equally prominent and 159 | visible. You may add other material on the covers in addition. 160 | Copying with changes limited to the covers, as long as they preserve 161 | the title of the Document and satisfy these conditions, can be treated 162 | as verbatim copying in other respects. 163 | 164 | If the required texts for either cover are too voluminous to fit 165 | legibly, you should put the first ones listed (as many as fit 166 | reasonably) on the actual cover, and continue the rest onto adjacent 167 | pages. 168 | 169 | If you publish or distribute Opaque copies of the Document numbering 170 | more than 100, you must either include a machine-readable Transparent 171 | copy along with each Opaque copy, or state in or with each Opaque copy 172 | a computer-network location from which the general network-using 173 | public has access to download using public-standard network protocols 174 | a complete Transparent copy of the Document, free of added material. 175 | If you use the latter option, you must take reasonably prudent steps, 176 | when you begin distribution of Opaque copies in quantity, to ensure 177 | that this Transparent copy will remain thus accessible at the stated 178 | location until at least one year after the last time you distribute an 179 | Opaque copy (directly or through your agents or retailers) of that 180 | edition to the public. 181 | 182 | It is requested, but not required, that you contact the authors of the 183 | Document well before redistributing any large number of copies, to give 184 | them a chance to provide you with an updated version of the Document. 185 | 186 | @item 187 | MODIFICATIONS 188 | 189 | You may copy and distribute a Modified Version of the Document under 190 | the conditions of sections 2 and 3 above, provided that you release 191 | the Modified Version under precisely this License, with the Modified 192 | Version filling the role of the Document, thus licensing distribution 193 | and modification of the Modified Version to whoever possesses a copy 194 | of it. In addition, you must do these things in the Modified Version: 195 | 196 | @enumerate A 197 | @item 198 | Use in the Title Page (and on the covers, if any) a title distinct 199 | from that of the Document, and from those of previous versions 200 | (which should, if there were any, be listed in the History section 201 | of the Document). You may use the same title as a previous version 202 | if the original publisher of that version gives permission. 203 | 204 | @item 205 | List on the Title Page, as authors, one or more persons or entities 206 | responsible for authorship of the modifications in the Modified 207 | Version, together with at least five of the principal authors of the 208 | Document (all of its principal authors, if it has fewer than five), 209 | unless they release you from this requirement. 210 | 211 | @item 212 | State on the Title page the name of the publisher of the 213 | Modified Version, as the publisher. 214 | 215 | @item 216 | Preserve all the copyright notices of the Document. 217 | 218 | @item 219 | Add an appropriate copyright notice for your modifications 220 | adjacent to the other copyright notices. 221 | 222 | @item 223 | Include, immediately after the copyright notices, a license notice 224 | giving the public permission to use the Modified Version under the 225 | terms of this License, in the form shown in the Addendum below. 226 | 227 | @item 228 | Preserve in that license notice the full lists of Invariant Sections 229 | and required Cover Texts given in the Document's license notice. 230 | 231 | @item 232 | Include an unaltered copy of this License. 233 | 234 | @item 235 | Preserve the section Entitled ``History'', Preserve its Title, and add 236 | to it an item stating at least the title, year, new authors, and 237 | publisher of the Modified Version as given on the Title Page. If 238 | there is no section Entitled ``History'' in the Document, create one 239 | stating the title, year, authors, and publisher of the Document as 240 | given on its Title Page, then add an item describing the Modified 241 | Version as stated in the previous sentence. 242 | 243 | @item 244 | Preserve the network location, if any, given in the Document for 245 | public access to a Transparent copy of the Document, and likewise 246 | the network locations given in the Document for previous versions 247 | it was based on. These may be placed in the ``History'' section. 248 | You may omit a network location for a work that was published at 249 | least four years before the Document itself, or if the original 250 | publisher of the version it refers to gives permission. 251 | 252 | @item 253 | For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve 254 | the Title of the section, and preserve in the section all the 255 | substance and tone of each of the contributor acknowledgements and/or 256 | dedications given therein. 257 | 258 | @item 259 | Preserve all the Invariant Sections of the Document, 260 | unaltered in their text and in their titles. Section numbers 261 | or the equivalent are not considered part of the section titles. 262 | 263 | @item 264 | Delete any section Entitled ``Endorsements''. Such a section 265 | may not be included in the Modified Version. 266 | 267 | @item 268 | Do not retitle any existing section to be Entitled ``Endorsements'' or 269 | to conflict in title with any Invariant Section. 270 | 271 | @item 272 | Preserve any Warranty Disclaimers. 273 | @end enumerate 274 | 275 | If the Modified Version includes new front-matter sections or 276 | appendices that qualify as Secondary Sections and contain no material 277 | copied from the Document, you may at your option designate some or all 278 | of these sections as invariant. To do this, add their titles to the 279 | list of Invariant Sections in the Modified Version's license notice. 280 | These titles must be distinct from any other section titles. 281 | 282 | You may add a section Entitled ``Endorsements'', provided it contains 283 | nothing but endorsements of your Modified Version by various 284 | parties---for example, statements of peer review or that the text has 285 | been approved by an organization as the authoritative definition of a 286 | standard. 287 | 288 | You may add a passage of up to five words as a Front-Cover Text, and a 289 | passage of up to 25 words as a Back-Cover Text, to the end of the list 290 | of Cover Texts in the Modified Version. Only one passage of 291 | Front-Cover Text and one of Back-Cover Text may be added by (or 292 | through arrangements made by) any one entity. If the Document already 293 | includes a cover text for the same cover, previously added by you or 294 | by arrangement made by the same entity you are acting on behalf of, 295 | you may not add another; but you may replace the old one, on explicit 296 | permission from the previous publisher that added the old one. 297 | 298 | The author(s) and publisher(s) of the Document do not by this License 299 | give permission to use their names for publicity for or to assert or 300 | imply endorsement of any Modified Version. 301 | 302 | @item 303 | COMBINING DOCUMENTS 304 | 305 | You may combine the Document with other documents released under this 306 | License, under the terms defined in section 4 above for modified 307 | versions, provided that you include in the combination all of the 308 | Invariant Sections of all of the original documents, unmodified, and 309 | list them all as Invariant Sections of your combined work in its 310 | license notice, and that you preserve all their Warranty Disclaimers. 311 | 312 | The combined work need only contain one copy of this License, and 313 | multiple identical Invariant Sections may be replaced with a single 314 | copy. If there are multiple Invariant Sections with the same name but 315 | different contents, make the title of each such section unique by 316 | adding at the end of it, in parentheses, the name of the original 317 | author or publisher of that section if known, or else a unique number. 318 | Make the same adjustment to the section titles in the list of 319 | Invariant Sections in the license notice of the combined work. 320 | 321 | In the combination, you must combine any sections Entitled ``History'' 322 | in the various original documents, forming one section Entitled 323 | ``History''; likewise combine any sections Entitled ``Acknowledgements'', 324 | and any sections Entitled ``Dedications''. You must delete all 325 | sections Entitled ``Endorsements.'' 326 | 327 | @item 328 | COLLECTIONS OF DOCUMENTS 329 | 330 | You may make a collection consisting of the Document and other documents 331 | released under this License, and replace the individual copies of this 332 | License in the various documents with a single copy that is included in 333 | the collection, provided that you follow the rules of this License for 334 | verbatim copying of each of the documents in all other respects. 335 | 336 | You may extract a single document from such a collection, and distribute 337 | it individually under this License, provided you insert a copy of this 338 | License into the extracted document, and follow this License in all 339 | other respects regarding verbatim copying of that document. 340 | 341 | @item 342 | AGGREGATION WITH INDEPENDENT WORKS 343 | 344 | A compilation of the Document or its derivatives with other separate 345 | and independent documents or works, in or on a volume of a storage or 346 | distribution medium, is called an ``aggregate'' if the copyright 347 | resulting from the compilation is not used to limit the legal rights 348 | of the compilation's users beyond what the individual works permit. 349 | When the Document is included in an aggregate, this License does not 350 | apply to the other works in the aggregate which are not themselves 351 | derivative works of the Document. 352 | 353 | If the Cover Text requirement of section 3 is applicable to these 354 | copies of the Document, then if the Document is less than one half of 355 | the entire aggregate, the Document's Cover Texts may be placed on 356 | covers that bracket the Document within the aggregate, or the 357 | electronic equivalent of covers if the Document is in electronic form. 358 | Otherwise they must appear on printed covers that bracket the whole 359 | aggregate. 360 | 361 | @item 362 | TRANSLATION 363 | 364 | Translation is considered a kind of modification, so you may 365 | distribute translations of the Document under the terms of section 4. 366 | Replacing Invariant Sections with translations requires special 367 | permission from their copyright holders, but you may include 368 | translations of some or all Invariant Sections in addition to the 369 | original versions of these Invariant Sections. You may include a 370 | translation of this License, and all the license notices in the 371 | Document, and any Warranty Disclaimers, provided that you also include 372 | the original English version of this License and the original versions 373 | of those notices and disclaimers. In case of a disagreement between 374 | the translation and the original version of this License or a notice 375 | or disclaimer, the original version will prevail. 376 | 377 | If a section in the Document is Entitled ``Acknowledgements'', 378 | ``Dedications'', or ``History'', the requirement (section 4) to Preserve 379 | its Title (section 1) will typically require changing the actual 380 | title. 381 | 382 | @item 383 | TERMINATION 384 | 385 | You may not copy, modify, sublicense, or distribute the Document 386 | except as expressly provided under this License. Any attempt 387 | otherwise to copy, modify, sublicense, or distribute it is void, and 388 | will automatically terminate your rights under this License. 389 | 390 | However, if you cease all violation of this License, then your license 391 | from a particular copyright holder is reinstated (a) provisionally, 392 | unless and until the copyright holder explicitly and finally 393 | terminates your license, and (b) permanently, if the copyright holder 394 | fails to notify you of the violation by some reasonable means prior to 395 | 60 days after the cessation. 396 | 397 | Moreover, your license from a particular copyright holder is 398 | reinstated permanently if the copyright holder notifies you of the 399 | violation by some reasonable means, this is the first time you have 400 | received notice of violation of this License (for any work) from that 401 | copyright holder, and you cure the violation prior to 30 days after 402 | your receipt of the notice. 403 | 404 | Termination of your rights under this section does not terminate the 405 | licenses of parties who have received copies or rights from you under 406 | this License. If your rights have been terminated and not permanently 407 | reinstated, receipt of a copy of some or all of the same material does 408 | not give you any rights to use it. 409 | 410 | @item 411 | FUTURE REVISIONS OF THIS LICENSE 412 | 413 | The Free Software Foundation may publish new, revised versions 414 | of the GNU Free Documentation License from time to time. Such new 415 | versions will be similar in spirit to the present version, but may 416 | differ in detail to address new problems or concerns. See 417 | @uref{https://www.gnu.org/licenses/}. 418 | 419 | Each version of the License is given a distinguishing version number. 420 | If the Document specifies that a particular numbered version of this 421 | License ``or any later version'' applies to it, you have the option of 422 | following the terms and conditions either of that specified version or 423 | of any later version that has been published (not as a draft) by the 424 | Free Software Foundation. If the Document does not specify a version 425 | number of this License, you may choose any version ever published (not 426 | as a draft) by the Free Software Foundation. If the Document 427 | specifies that a proxy can decide which future versions of this 428 | License can be used, that proxy's public statement of acceptance of a 429 | version permanently authorizes you to choose that version for the 430 | Document. 431 | 432 | @item 433 | RELICENSING 434 | 435 | ``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any 436 | World Wide Web server that publishes copyrightable works and also 437 | provides prominent facilities for anybody to edit those works. A 438 | public wiki that anybody can edit is an example of such a server. A 439 | ``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the 440 | site means any set of copyrightable works thus published on the MMC 441 | site. 442 | 443 | ``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 444 | license published by Creative Commons Corporation, a not-for-profit 445 | corporation with a principal place of business in San Francisco, 446 | California, as well as future copyleft versions of that license 447 | published by that same organization. 448 | 449 | ``Incorporate'' means to publish or republish a Document, in whole or 450 | in part, as part of another Document. 451 | 452 | An MMC is ``eligible for relicensing'' if it is licensed under this 453 | License, and if all works that were first published under this License 454 | somewhere other than this MMC, and subsequently incorporated in whole 455 | or in part into the MMC, (1) had no cover texts or invariant sections, 456 | and (2) were thus incorporated prior to November 1, 2008. 457 | 458 | The operator of an MMC Site may republish an MMC contained in the site 459 | under CC-BY-SA on the same site at any time before August 1, 2009, 460 | provided the MMC is eligible for relicensing. 461 | 462 | @end enumerate 463 | 464 | @page 465 | @heading ADDENDUM: How to use this License for your documents 466 | 467 | To use this License in a document you have written, include a copy of 468 | the License in the document and put the following copyright and 469 | license notices just after the title page: 470 | 471 | @smallexample 472 | @group 473 | Copyright (C) @var{year} @var{your name}. 474 | Permission is granted to copy, distribute and/or modify this document 475 | under the terms of the GNU Free Documentation License, Version 1.3 476 | or any later version published by the Free Software Foundation; 477 | with no Invariant Sections, no Front-Cover Texts, and no Back-Cover 478 | Texts. A copy of the license is included in the section entitled ``GNU 479 | Free Documentation License''. 480 | @end group 481 | @end smallexample 482 | 483 | If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, 484 | replace the ``with@dots{}Texts.''@: line with this: 485 | 486 | @smallexample 487 | @group 488 | with the Invariant Sections being @var{list their titles}, with 489 | the Front-Cover Texts being @var{list}, and with the Back-Cover Texts 490 | being @var{list}. 491 | @end group 492 | @end smallexample 493 | 494 | If you have Invariant Sections without Cover Texts, or some other 495 | combination of the three, merge those two alternatives to suit the 496 | situation. 497 | 498 | If your document contains nontrivial examples of program code, we 499 | recommend releasing these examples in parallel under your choice of 500 | free software license, such as the GNU General Public License, 501 | to permit their use in free software. 502 | 503 | @c Local Variables: 504 | @c ispell-local-pdict: "ispell-dict" 505 | @c End: 506 | -------------------------------------------------------------------------------- /substitute.el: -------------------------------------------------------------------------------- 1 | ;;; substitute.el --- Efficiently replace targets in the buffer or context -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2023-2025 Free Software Foundation, Inc. 4 | 5 | ;; Author: Protesilaos Stavrou 6 | ;; Maintainer: Protesilaos Stavrou 7 | ;; URL: https://github.com/protesilaos/substitute 8 | ;; Version: 0.3.1 9 | ;; Package-Requires: ((emacs "27.1")) 10 | 11 | ;; This file is NOT part of GNU Emacs. 12 | 13 | ;; This program is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation, either version 3 of the License, or 16 | ;; (at your option) any later version. 17 | ;; 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | ;; 23 | ;; You should have received a copy of the GNU General Public License 24 | ;; along with this program. If not, see . 25 | 26 | ;;; Commentary: 27 | ;; 28 | ;; Read: . 29 | ;; 30 | ;; Some Utilities Built to Substitute Targets Independent of Their 31 | ;; Utterances, Thoroughly and Easily. 32 | 33 | ;;; Code: 34 | 35 | (require 'thingatpt) 36 | (eval-when-compile (require 'subr-x)) 37 | 38 | (defgroup substitute nil 39 | "Efficiently replace targets in the buffer or context." 40 | :group 'editing) 41 | 42 | (defcustom substitute-highlight t 43 | "If non-nil, highlight target during prompt for its substitute. 44 | 45 | If nil, do not highlight anything: just prompt for a substitute. 46 | 47 | At any rate, always specify at the minibuffer prompt the target 48 | of the substitution." 49 | :package-version '(substitute . "0.2.0") 50 | :group 'substitute 51 | :type 'boolean) 52 | 53 | (defcustom substitute-fixed-letter-case nil 54 | "If non-nil, do not alter the letter case of the substituted text. 55 | Otherwise try to perform capitalization or upcasing based on the 56 | target text (per `replace-match'). 57 | 58 | Instead of setting this user option, users can invoke the 59 | substitution commands, such as `substitute-target-in-buffer', 60 | with a universal prefix argument." 61 | :package-version '(substitute . "0.2.0") 62 | :group 'substitute 63 | :type 'boolean) 64 | 65 | (define-obsolete-variable-alias 66 | 'substitute-post-replace-hook 67 | 'substitute-post-replace-functions 68 | "0.2.0") 69 | 70 | (defcustom substitute-post-replace-functions nil 71 | "Special hook to run after a substitution command. 72 | Every function is called with four arguments: TARGET, SUB, COUNT, 73 | and SCOPE. 74 | 75 | For a reference function, see `substitute-report-operation'." 76 | :package-version '(substitute . "0.2.0") 77 | :group 'substitute 78 | :type 'hook) 79 | 80 | (defface substitute-match 81 | `((t :inherit ,(if-let* ((face 'lazy-highlight) 82 | ((facep face))) 83 | face 84 | 'secondary-selection))) 85 | "Face to highlight matches of the given target." 86 | :group 'substitute) 87 | 88 | (defvar substitute--history '() 89 | "Minibuffer history for substitution commands.") 90 | 91 | (defun substitute--scope-description (scope) 92 | "Return string that describes SCOPE in plain terms. 93 | 94 | Possible meaningful values for SCOPE are: 95 | 96 | - `below' :: from point to the end of the buffer. 97 | - `above' :: from point to the beginning of the buffer. 98 | - `defun' :: limit to the current defun per `narrow-to-defun'. 99 | - nil :: across the whole buffer." 100 | (pcase scope 101 | ('below "from point to the END of the buffer") 102 | ('above "from point to the BEGINNING of the buffer") 103 | ('defun "in the current DEFUN") 104 | (_ "across the BUFFER"))) 105 | 106 | (defun substitute--prettify-target-description (target) 107 | "Remove regexp delimiters from TARGET. 108 | Use this to produce a more readable version of TARGET for prompts 109 | and related." 110 | (replace-regexp-in-string "\\\\_<\\(?1:.*?\\)\\\\_>" "\\1" target)) 111 | 112 | (defun substitute--remove-highlights () 113 | "Remove `substitute-match' overlays." 114 | (remove-overlays nil nil 'face 'substitute-match)) 115 | 116 | (defun substitute--add-highlight (beg end) 117 | "Add overlay of `substitute-match' between BEG and END positions." 118 | (goto-char beg) 119 | (let ((highlight (make-overlay beg end))) 120 | (overlay-put highlight 'priority 100) 121 | (overlay-put highlight 'face 'substitute-match))) 122 | 123 | (defun substitute--prompt-without-highlight (target scope) 124 | "Prompt for string while referencing TARGET and SCOPE." 125 | (let ((pretty-target (substitute--prettify-target-description target))) 126 | (substitute--collect-targets target scope) 127 | (read-from-minibuffer 128 | (format "Substitute `%s' %s with: " 129 | (propertize pretty-target 'face 'error) 130 | (substitute--scope-description scope)) 131 | nil nil nil 132 | 'substitute--history 133 | pretty-target))) 134 | 135 | (defun substitute--prompt-with-highlight (target scope) 136 | "Prompt for string while referencing TARGET and SCOPE. 137 | Highlight the TARGET's matching occurences per the user option 138 | `substitute-highlight'." 139 | (let ((pretty-target (substitute--prettify-target-description target))) 140 | (unwind-protect 141 | (progn 142 | (substitute--collect-targets target scope) 143 | (substitute--highlight-targets) 144 | (substitute--prompt-without-highlight pretty-target scope)) 145 | (substitute--remove-highlights) 146 | (setq-local substitute--last-matches nil)))) 147 | 148 | (defun substitute--prompt (target scope) 149 | "Return appropriate prompt based on `substitute-highlight'. 150 | Pass to it the TARGET and SCOPE arguments." 151 | (barf-if-buffer-read-only) 152 | (funcall 153 | (if substitute-highlight 154 | 'substitute--prompt-with-highlight 155 | 'substitute--prompt-without-highlight) 156 | target 157 | scope)) 158 | 159 | (defun substitute--scope-current-and-below (target) 160 | "Position point to match current TARGET and below." 161 | (widen) 162 | (if-let* (((region-active-p)) 163 | (bounds (region-bounds))) 164 | (goto-char (caar bounds)) 165 | (thing-at-point-looking-at target) 166 | (goto-char (match-beginning 0)))) 167 | 168 | (defun substitute--scope-current-and-above (target) 169 | "Position point to match current TARGET and above." 170 | (widen) 171 | (if-let* (((region-active-p)) 172 | (bounds (region-bounds))) 173 | (goto-char (cdar bounds)) 174 | (thing-at-point-looking-at target) 175 | (goto-char (match-end 0)))) 176 | 177 | (defun substitute--scope-current-defun () 178 | "Position point to the top after `narrow-to-defun'." 179 | (narrow-to-defun) 180 | (goto-char (point-min))) 181 | 182 | (defun substitute--scope-top-of-buffer () 183 | "Position point to the top of the buffer." 184 | (widen) 185 | (goto-char (point-min))) 186 | 187 | (defun substitute--setup-scope (target scope) 188 | "Derive SCOPE for TARGET." 189 | (pcase scope 190 | ('below (substitute--scope-current-and-below target)) 191 | ('above (substitute--scope-current-and-above target)) 192 | ('defun (substitute--scope-current-defun)) 193 | (_ (substitute--scope-top-of-buffer)))) 194 | 195 | (defvar-local substitute--last-matches nil 196 | "Alist of the last matching substitution targets. 197 | Each entry is a list of the form (STRING BEG END), where STRING is the 198 | text to be replaced, while BEG and END are buffer positions.") 199 | 200 | (defun substitute--collect-targets (target scope) 201 | "Store occurrences of TARGET in SCOPE in `substitute--last-matches'." 202 | (let ((search-fn (if (eq scope 'above) 're-search-backward 're-search-forward))) 203 | (setq-local substitute--last-matches nil) 204 | (save-excursion 205 | (save-restriction 206 | (substitute--setup-scope target scope) 207 | (while (funcall search-fn target nil t) 208 | (push (list (regexp-quote (match-string-no-properties 0)) 209 | (match-beginning 0) 210 | (match-end 0)) 211 | substitute--last-matches)))) 212 | substitute--last-matches)) 213 | 214 | (defun substitute--highlight-targets () 215 | "Highlight `substitute--last-matches'." 216 | (when-let* ((targets substitute--last-matches)) 217 | (save-excursion 218 | (save-restriction 219 | (mapcar 220 | (lambda (target) 221 | (pcase-let ((`(,_ ,beg ,end) target)) 222 | (substitute--add-highlight beg end))) 223 | targets))))) 224 | 225 | (defun substitute--replace-targets (sub &optional scope fixed) 226 | "Replace `substitute--last-matches' target with SUB. 227 | If optional SCOPE is equal to `above', then adjust for a reverse 228 | motion. 229 | 230 | With optional FIXED as a non-nil value, do not alter the case of 231 | the substituted text. Otherwise perform capitalization or 232 | upcasing based on the target text. See the documenation of 233 | `replace-match' for how this works." 234 | (when-let* ((targets substitute--last-matches)) 235 | (save-excursion 236 | (when (listp buffer-undo-list) 237 | (push (point) buffer-undo-list)) 238 | (save-restriction 239 | (mapcar 240 | (lambda (target) 241 | (pcase-let* ((`(,string ,beg ,end) target) 242 | (`(,pos ,fn) (if (eq scope 'above) 243 | (list (max beg end) 're-search-backward) 244 | (list (min beg end) 're-search-forward)))) 245 | (goto-char pos) 246 | (funcall fn string) 247 | (replace-match sub (or fixed substitute-fixed-letter-case)))) 248 | targets))))) 249 | 250 | (defun substitute--operate (target sub &optional scope fixed) 251 | "Operate on TARGET with SUB in SCOPE. 252 | Optional FIXED does not alter the letter casing of substituted 253 | text (also see `substitute-fixed-letter-case')." 254 | (let* ((targets (or substitute--last-matches 255 | (substitute--collect-targets target scope))) 256 | (count (length targets))) 257 | (substitute--replace-targets sub scope fixed) 258 | (setq-local substitute--last-matches nil) 259 | (run-hook-with-args 'substitute-post-replace-hook 260 | target sub count 261 | (substitute--scope-description scope)))) 262 | 263 | (defun substitute--determine-target () 264 | "Return target or report an error. 265 | If the region is active, the target of the substitute is the text 266 | within the region's boundaries. Otherwise the target is the 267 | target at point. 268 | 269 | Report a `user-error' if no target is found." 270 | (cond 271 | ((region-active-p) 272 | (regexp-quote (buffer-substring-no-properties (region-beginning) (region-end)))) 273 | (t 274 | (if-let* ((thing (thing-at-point 'symbol t))) 275 | (format "\\_<%s\\_>" thing) 276 | (user-error "No substitution target at point"))))) 277 | 278 | (defmacro substitute-define-substitute-command (fn doc &optional scope) 279 | "Produce substitute command using FN, DOC, and SCOPE." 280 | `(defun ,fn (target sub &optional fixed-case) 281 | ,(format 282 | "Substitute TARGET with SUB %s. 283 | 284 | When called interactively, TARGET is the symbol at point and SUB 285 | is a string that is provided at the minibuffer prompt. 286 | 287 | If the region is active, TARGET is the text within the region's 288 | boundaries. 289 | 290 | With optional FIXED-CASE as a prefix argument, do not try to 291 | preserve the letter casing of the target text: the substitution 292 | is literal. Otherwise try to preserve the case (per 293 | `replace-match'). 294 | 295 | Instead of the optional FIXED-CASE argument, the user can set the 296 | option `substitute-fixed-letter-case' to non-nil. That is the 297 | same as always calling this command with FIXED-CASE." doc) 298 | (interactive 299 | (let ((target (substitute--determine-target))) 300 | (list target 301 | (substitute--prompt target ,scope) 302 | current-prefix-arg))) 303 | (substitute--operate target sub ,scope fixed-case))) 304 | 305 | ;;;###autoload (autoload 'substitute-target-in-buffer "substitute") 306 | (substitute-define-substitute-command 307 | substitute-target-in-buffer 308 | "throughout the buffer") 309 | 310 | ;;;###autoload (autoload 'substitute-target-in-defun "substitute") 311 | (substitute-define-substitute-command 312 | substitute-target-in-defun 313 | "in the defun (per `narrow-to-defun')" 314 | 'defun) 315 | 316 | ;;;###autoload (autoload 'substitute-target-below-point "substitute") 317 | (substitute-define-substitute-command 318 | substitute-target-below-point 319 | "to the end of the buffer" 320 | 'below) 321 | 322 | (defalias 'substitute-target-to-end-of-buffer 323 | 'substitute-target-below-point) 324 | 325 | ;;;###autoload (autoload 'substitute-target-above-point "substitute") 326 | (substitute-define-substitute-command 327 | substitute-target-above-point 328 | "to the beginning of the buffer" 329 | 'above) 330 | 331 | (defalias 'substitute-target-to-beginning-of-buffer 332 | 'substitute-target-above-point) 333 | 334 | (defun substitute-report-operation (target sub count scope) 335 | "Print message of substitution. 336 | Report COUNTth substitutions of TARGET with SUB in SCOPE." 337 | (message "Substituted `%s' with `%s' %d times %s" 338 | (propertize (substitute--prettify-target-description target) 'face 'error) 339 | (propertize sub 'face 'success) 340 | count 341 | (propertize scope 'face 'warning))) 342 | 343 | (defvar substitute-prefix-map (make-sparse-keymap) 344 | "Keymap with Substitute commands. 345 | Meant to be assigned to a prefix key, like this: 346 | 347 | (define-key global-map (kbd \"C-c s\") \=#'substitute-prefix-map)") 348 | 349 | ;;;###autoload (autoload 'substitute-prefix-map "substitute") 350 | (define-prefix-command 'substitute-prefix-map) 351 | 352 | (define-key substitute-prefix-map (kbd "b") #'substitute-target-in-buffer) 353 | (define-key substitute-prefix-map (kbd "d") #'substitute-target-in-defun) 354 | (define-key substitute-prefix-map (kbd "r") #'substitute-target-above-point) 355 | (define-key substitute-prefix-map (kbd "s") #'substitute-target-below-point) 356 | 357 | (provide 'substitute) 358 | ;;; substitute.el ends here 359 | --------------------------------------------------------------------------------