├── LICENSE ├── README.org ├── query-replace-parallel-tests.el └── query-replace-parallel.el /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * =query-replace-parallel= 2 | 3 | A parallel variant of Emacs' built-in =query-replace= and 4 | =query-replace-regexp=. 5 | 6 | The package is not yet published on an Elisp package archive, so for now, clone 7 | the repository (or download the main =query-replace-parallel.el= Elisp file) and 8 | load it manually. 9 | 10 | For example, if you've downloaded the main Elisp file to the directory 11 | =~/query-replace-parallel=, you can use =use-package= like so: 12 | 13 | #+BEGIN_SRC emacs-lisp 14 | (use-package query-replace-parallel 15 | :load-path "~/query-replace-parallel" 16 | :commands (query-replace-parallel query-replace-parallel-regexp)) 17 | #+END_SRC 18 | 19 | See our [[https://emacsconf.org/2023/talks/parallel/][EmacsConf 2023 talk]] for more information. 20 | 21 | * FAQ 22 | 23 | ** Replacing =query-replace= 24 | 25 | =query-replace-parallel= can be used as a drop-in replacement for the standard 26 | =query-replace=. An easy way to do this is to remap =query-replace=: 27 | 28 | #+BEGIN_SRC emacs-lisp 29 | (global-set-key [remap query-replace] #'query-replace-parallel) 30 | (global-set-key [remap query-replace-regexp] #'query-replace-parallel-regexp) 31 | #+END_SRC 32 | 33 | ** Prefix Argument For Number of Pairs 34 | 35 | The prefix argument to =query-replace-parallel= is treated just as in 36 | =query-replace=, i.e. it determines whether to perform whole-world and/or 37 | backward replacements. 38 | 39 | If this is something you rarely use, [[https://github.com/hokomo/query-replace-parallel/pull/2][you might like]] to instead repurpose the 40 | prefix argument to explicitly specify the number of replacement pairs to input, 41 | and to default to just a single pair without a prefix argument. This removes 42 | having to press enter one final time to terminate the usual prompt. 43 | 44 | You can use the following advice to achieve this: 45 | 46 | #+BEGIN_SRC emacs-lisp 47 | (define-advice query-replace-parallel--prompt 48 | (:override (regexp-flag n) hok/count-arg) 49 | (concat "Query replace parallel" 50 | (and regexp-flag " regexp") 51 | (and (use-region-p) " in region") 52 | (and n (format " (%d)" n)))) 53 | 54 | (define-advice query-replace-parallel--read-args 55 | (:override (regexp-flag) hok/count-arg) 56 | (let ((n (prefix-numeric-value current-prefix-arg))) 57 | (cl-loop for i from n downto 1 58 | for (from to delim backward) 59 | = (let ((current-prefix-arg nil)) 60 | (query-replace-read-args 61 | (query-replace-parallel--prompt regexp-flag (and (> n 1) i)) 62 | regexp-flag)) 63 | for pair = (cons from to) 64 | collect pair into pairs 65 | finally (cl-return (list pairs delim backward))))) 66 | #+END_SRC 67 | -------------------------------------------------------------------------------- /query-replace-parallel-tests.el: -------------------------------------------------------------------------------- 1 | ;;; query-replace-parallel.el --- Tests for query-replace-parallel -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2023 hokomo 4 | ;; Copyright (C) 2023 Valentino Picotti 5 | 6 | ;; Author: hokomo 7 | ;; Valentino Picotti 8 | ;; Version: 0.1-pre 9 | 10 | ;; This file is not part of GNU Emacs. 11 | 12 | ;; This program is free software; you can redistribute it and/or modify 13 | ;; it under the terms of the GNU General Public License as published by 14 | ;; the Free Software Foundation, either version 3 of the License, or 15 | ;; (at your option) any later version. 16 | 17 | ;; This program is distributed in the hope that it will be useful, 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | ;; GNU General Public License for more details. 21 | 22 | ;; You should have received a copy of the GNU General Public License 23 | ;; along with this program. If not, see . 24 | 25 | ;;; Code: 26 | 27 | (require 'query-replace-parallel) 28 | 29 | (require 'cl-lib) 30 | (require 'ert) 31 | (require 'rx) 32 | 33 | (cl-defun query-replace-parallel--test (pairs text newtext &key (regexp-flag t)) 34 | (let* ((table (query-replace-parallel--table pairs regexp-flag)) 35 | (regexp (query-replace-parallel--matcher (mapcar #'cadddr table))) 36 | (replacer (query-replace-parallel--replacer table regexp-flag)) 37 | ;; NOTE: Since we're testing the internals, we must also set up this 38 | ;; variable the way our replacer expects. We might want to think about 39 | ;; refactoring the implementation to get rid of this, but it's not that 40 | ;; big of a deal. 41 | (query-replace-parallel--state (list (cons nil nil)))) 42 | (message "Pairs: %S" pairs) 43 | (message "Matcher: %s" regexp) 44 | (message "Table: %S" table) 45 | (message "Text: %S" text) 46 | (with-temp-buffer 47 | (insert text) 48 | (goto-char (point-min)) 49 | (cl-loop for i from 1 50 | while (re-search-forward regexp nil t) 51 | for rep = (funcall replacer nil (1- i)) 52 | do (message "Occurrence %d: replacing %S with %S" 53 | i (match-string 0) rep) 54 | (replace-match rep t)) 55 | (should (string= newtext (buffer-string)))))) 56 | 57 | (ert-deftest query-replace-parallel--swap () 58 | "Swap two strings with each other." 59 | (query-replace-parallel--test 60 | '(("foo" . "bar") 61 | ("bar" . "foo")) 62 | "foo goes to bar, bar goes to foo" 63 | "bar goes to foo, foo goes to bar")) 64 | 65 | (ert-deftest query-replace-parallel--cycle () 66 | "Swap multiple strings in a cycle." 67 | (query-replace-parallel--test 68 | '(("foo" . "bar") 69 | ("bar" . "baz") 70 | ("baz" . "quux") 71 | ("quux" . "foo")) 72 | "foo goes to bar goes to baz goes to quux goes to foo" 73 | "bar goes to baz goes to quux goes to foo goes to bar")) 74 | 75 | (ert-deftest query-replace-parallel--prefix-1 () 76 | "Swap two strings where the former is a prefix of the latter." 77 | (query-replace-parallel--test 78 | '(("foo" . "baz") 79 | ("foobar" . "quux")) 80 | "foo goes to baz, foobar goes to quux" 81 | "baz goes to baz, bazbar goes to quux")) 82 | 83 | (ert-deftest query-replace-parallel--prefix-2 () 84 | "Swap two strings where the latter is a prefix of the former." 85 | (query-replace-parallel--test 86 | '(("foobar" . "quux") 87 | ("foo" . "baz")) 88 | "foobar goes to quux, foo goes to baz" 89 | "quux goes to quux, baz goes to baz")) 90 | 91 | (ert-deftest query-replace-parallel--suffix-1 () 92 | "Swap two strings where the former is a suffix of the latter." 93 | (query-replace-parallel--test 94 | '(("watch" . "wristwatch") 95 | ("stopwatch" . "timer")) 96 | "watch goes to wristwatch, stopwatch goes to timer" 97 | "wristwatch goes to wristwristwatch, timer goes to timer")) 98 | 99 | (ert-deftest query-replace-parallel--suffix-2 () 100 | "Swap two strings where the latter is a suffix of the former." 101 | (query-replace-parallel--test 102 | '(("stopwatch" . "timer") 103 | ("watch" . "wristwatch")) 104 | "stopwatch goes to timer, watch goes to wristwatch" 105 | "timer goes to timer, wristwatch goes to wristwristwatch")) 106 | 107 | (ert-deftest query-replace-parallel--isolated () 108 | "Use groups with the same number in multiple replacements." 109 | (query-replace-parallel--test 110 | `((,(rx "a" (group digit) (group digit)) . "a\\1\\2") 111 | (,(rx "b" (group digit) (group digit)) . "b\\2\\1")) 112 | "a12 b21 a12 b21 b21 a12" 113 | "a12 b12 a12 b12 b12 a12")) 114 | 115 | (ert-deftest query-replace-parallel--numbered () 116 | "Use explicitly numbered groups." 117 | (query-replace-parallel--test 118 | `((,(rx "a" (group-n 4 digit) (group-n 6 digit)) . "a\\6\\4") 119 | (,(rx "b" (group-n 6 digit) (group-n 4 digit)) . "b\\4\\6")) 120 | "a12 b21 a12 b21 b21 a12" 121 | "a21 b12 a21 b12 b12 a21")) 122 | 123 | (ert-deftest query-replace-parallel--numbered-duplicate () 124 | "Use explicitly numbered groups with duplicate numbers." 125 | (query-replace-parallel--test 126 | `((,(rx "a" (group-n 4 digit) (group-n 4 digit)) . "a\\4") 127 | (,(rx "b" (group-n 3 digit) (group-n 4 (group-n 3 digit))) . "b\\3")) 128 | "a12 b21 a12 b21 b21 a12" 129 | "a2 b1 a2 b1 b1 a2")) 130 | 131 | (ert-deftest query-replace-parallel--numbered-overlapped-duplicate () 132 | "Use an explicitly numbered group whose number is a duplicate of 133 | its parent group. 134 | 135 | The Emacs regexp engine will normally treat such a regexp as 136 | invalid, but our implementation actually fixes the issue. See the 137 | implementation notes in the commentary." 138 | (query-replace-parallel--test 139 | `((,(rx "a" (group digit (group-n 1 digit))) . "a\\1") 140 | (,(rx "b" (group (group-n 4 digit (group-n 4 digit)))) . "b\\4")) 141 | "a12 b21 a12 b21 b21 a12" 142 | "a2 b1 a2 b1 b1 a2")) 143 | 144 | (ert-deftest query-replace-parallel--expr () 145 | "Use a Lisp expression in the replacement." 146 | (query-replace-parallel--test 147 | `(,(cons (rx "1" (group (+ alnum))) 148 | (query-replace-compile-replacement "\\,(downcase \\1)" :regexp)) 149 | ,(cons (rx "2" (group (+ alnum))) 150 | (query-replace-compile-replacement "\\,(upcase \\1)" :regexp))) 151 | "1foo 2bar 1baz 2quux 2bar 2foo 1baz 1quux" 152 | "foo BAR baz QUUX BAR FOO baz quux")) 153 | 154 | (ert-deftest query-replace-parallel--func () 155 | "Use a function that constructs the replacement." 156 | (query-replace-parallel--test 157 | `(,(cons (rx "1" (group (+ (not blank)))) 158 | (cons (lambda (_arg _count) (match-string 1)) nil)) 159 | ,(cons (rx "2" (group (+ (not blank)))) 160 | (cons (lambda (_arg _count) (replace-quote (match-string 1))) nil)) 161 | ,(cons (rx "3" (group (+ (not blank)))) 162 | (cons (lambda (_arg _count) "\\1") nil)) 163 | ,(cons (rx "4" (group (+ (not blank)))) 164 | (cons (lambda (_arg _count) (replace-quote "\\1")) nil))) 165 | "1foo 2bar 4baz 3foo 2quux 4bar 3baz 2bar\\1 1foo\\1 4quux 3quux" 166 | "foo bar \\1 foo quux \\1 baz bar\\1 foofoo\\1 \\1 quux")) 167 | 168 | (provide 'query-replace-parallel-tests) 169 | ;;; query-replace-parallel-tests.el ends here 170 | -------------------------------------------------------------------------------- /query-replace-parallel.el: -------------------------------------------------------------------------------- 1 | ;;; query-replace-parallel.el --- Parallel replacements for query-replace -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2023 hokomo 4 | ;; Copyright (C) 2023 Valentino Picotti 5 | 6 | ;; Author: hokomo 7 | ;; Valentino Picotti 8 | ;; Version: 0.1-pre 9 | ;; Package-Requires: ((emacs "25.2") (pcre2el "20161120.2103")) 10 | ;; Keywords: tools, convenience 11 | 12 | ;; This file is not part of GNU Emacs. 13 | 14 | ;; This program is free software; you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | 29 | ;; * About 30 | ;; 31 | ;; This package provides a "parallel" version of `query-replace', capable of 32 | ;; performing multiple different replacements with just a single pass, while 33 | ;; eliminating the possibility of erroneously replacing a previous replacement. 34 | ;; E.g. one can safely replace "foo" with "bar" and "bar" with "foo" at the same 35 | ;; time. 36 | ;; 37 | ;; We provide the full functionality of `query-replace', including regexps, 38 | ;; capture references (`\N', `\&'), Lisp expressions (`\,') and query edits 39 | ;; (`\?'). See `query-replace-regexp' for the details. 40 | 41 | ;; * Usage 42 | ;; 43 | ;; Use `query-replace-parallel' if you want to replace literal strings. This is 44 | ;; the parallel counterpart to `query-replace'. 45 | ;; 46 | ;; Use `query-replace-parallel-regexp' if you want to replace regexps and use 47 | ;; the various regexp replacement features. This is the parallel counterpart to 48 | ;; `query-replace-regexp'. 49 | 50 | ;; * Implementation 51 | ;; 52 | ;; The core of the package is `query-replace-parallel-perform-replace', 53 | ;; implemented on top of the existing interactive replacement machinery, namely, 54 | ;; `perform-replace'. Figuring out a way to do all of the replacements in a 55 | ;; single pass while preserving all of its sophisticated functionality is 56 | ;; tricky, but can be done. Just like Olin Shivers, we attempt a 100% solution 57 | ;; (https://www.ccs.neu.edu/home/shivers/papers/sre.txt). :-) 58 | ;; 59 | ;; We describe the most general case of performing a series of regexp 60 | ;; replacements, as the literal case can be implemented trivially on top. 61 | ;; 62 | ;; First, the user provides a series of replacement pairs (FROM . TO). FROM is a 63 | ;; regexp, while TO can be a replacement string or a cons specifying the 64 | ;; function to invoke to retrieve the replacement string (just like in 65 | ;; `perform-replace'). 66 | ;; 67 | ;; We invoke `perform-replace' once, with a "matcher regexp" that we construct 68 | ;; by putting all of the FROM regexps into one big alternative construct, while 69 | ;; wrapping each alternative in a separate capture group: 70 | ;; 71 | ;; \(FROM-1\)\|...\|\(FROM-N\) 72 | ;; 73 | ;; This regexp allows us to match any of the given replacement pairs (those 74 | ;; appearing earlier in the list have priority in case multiple match at the 75 | ;; same position), while also being able to tell which particular pair matched. 76 | ;; However, any of the FROM regexps might contain their own capture groups, so 77 | ;; we can't immediately tell what are the indices of our top-level groups. 78 | ;; 79 | ;; More generally, we want the user to be able to treat each replacement in 80 | ;; isolation and use advanced features such as explicitly numbered groups 81 | ;; without having to manually adjust the replacement by, e.g., shifting group 82 | ;; numbers around. Similarly, if TO is a function, we want it to have available 83 | ;; the match data from the perspective of just the one particular FROM regexp 84 | ;; that matched. 85 | ;; 86 | ;; To solve this properly, we preprocess each FROM regexp into a list (FLAT 87 | ;; GROUPS). FLAT is the "flattened" version of FROM where any explicitly 88 | ;; numbered groups have been replaced with implicit ones. GROUPS is a list of 89 | ;; indices, each related to an implicit group in FLAT, in order from left to 90 | ;; right. The index is the number of the corresponding group in FROM, which 91 | ;; gives us a 1-to-1 mapping between the groups of FROM and FLAT and allows us 92 | ;; to reconstruct the "local" information from our "global" matcher information. 93 | ;; The matcher actually becomes: 94 | ;; 95 | ;; \(FLAT-1\)\|...\|\(FLAT-N\) 96 | ;; 97 | ;; The replacement function we use in our call to `perform-replace' must then 98 | ;; determine which of the pairs matched and activate the appropriate match data. 99 | ;; For this purpose, we construct a "replacement table", which is an alist where 100 | ;; each pair has a corresponding entry (BASE . (FROM TO FLAT GROUPS)). 101 | ;; 102 | ;; The key BASE is the index of the group wrapped around the alternative for the 103 | ;; particular pair in the matcher regexp. Because the matcher regexp consists 104 | ;; only of implicit groups, we can be sure that zero or more successive groups 105 | ;; starting at BASE + 1 in the matcher regexp all correspond to the groups 106 | ;; specified by the user for that pair. The match data is then constructed by 107 | ;; mapping each such successive group to the corresponding group in the original 108 | ;; FROM regexp, given by GROUPS. If GROUPS contains duplicates, the rightmost 109 | ;; mapping wins. 110 | ;; 111 | ;; Whenever called, our replacement function can scan the table to determine 112 | ;; which of the pairs matched, use BASE and GROUPS to construct the match data 113 | ;; appropriate for the pair and then perform the replacement. The order of the 114 | ;; entries in the table is significant and matches the order of the given 115 | ;; replacement pairs. 116 | 117 | ;; * Explicitly Numbered Groups 118 | ;; 119 | ;; Even though the Emacs manual claims "There is no particular restriction on 120 | ;; the numbering" in the paragraph on explicitly numbered groups, the regexp 121 | ;; engine doesn't allow them to use the same index as any of their enclosing 122 | ;; (parent) groups. E.g. the following is invalid: 123 | ;; 124 | ;; \(hello \(?1:there\)\) 125 | ;; 126 | ;; Our approach actually ends up fixing this limitation for any regexp specified 127 | ;; by the user, while following the same rightmost-match-wins semantics. 128 | ;; 129 | ;; See (elisp) Regexp Backslash in the Emacs Lisp manual and 130 | ;; https://lists.gnu.org/archive/html/help-gnu-emacs/2012-01/msg00283.html for a 131 | ;; discussion on the Emacs mailing list. 132 | 133 | ;; * `noedit' Flag 134 | ;; 135 | ;; The `replace-match-maybe-edit' function is in charge of processing the query 136 | ;; edit (`\?') feature in the replacement. It is given a `noedit' parameter 137 | ;; maintained by the body of `perform-replace', which is used as a flag to tell 138 | ;; whether the replacement contains a query edit or not. If it doesn't, no query 139 | ;; edit processing is done. 140 | ;; 141 | ;; From the looks of it, this is supposed to be an optimization. However, until 142 | ;; the flag becomes non-nil, it is set every time again and again upon each 143 | ;; replacement. Once it becomes non-nil, `perform-replace' stops processing 144 | ;; query edits in replacements. 145 | ;; 146 | ;; While this is fine for replacements that are constant, it cannot work for 147 | ;; cases where the replacement string is dynamically constructed by a function. 148 | ;; In those cases, query edits will work until a replacement with no query edit 149 | ;; is encountered, after which they stop working. 150 | ;; 151 | ;; This actually uncovered a bug in `map-query-replace-regexp' which ends up 152 | ;; making use of the replacement function feature. Using "hello\? there world\?" 153 | ;; as the replacement string showcases the bug. 154 | ;; 155 | ;; To fix this, we advise `replace-match-maybe-edit' to always treat `noedit' 156 | ;; as nil. 157 | 158 | ;; * Messages 159 | ;; 160 | ;; We advise a few functions in order to provide the user with nice messages 161 | ;; during a replacement session, instead of the big and ugly matcher regexp. 162 | ;; 163 | ;; Luckily we are able to make the advice quite specific with the use of a 164 | ;; string property (`query-replace-parallel--tag') to detect when to fire. See 165 | ;; also the description of `query-replace-parallel--state'. 166 | 167 | ;; * Related Work 168 | ;; 169 | ;; There have been multiple previous attempts in solving the same problem, which 170 | ;; we take some inspiration from. However, they all stop short of a full 171 | ;; solution in one form or another: 172 | ;; 173 | ;; (1) They only work with literals instead of arbitrary regexps. Even if they 174 | ;; do mention the necessary `query-replace-regexp' workflow to achieve a 175 | ;; parallel replace, they don't attempt to generalize and automate it, which 176 | ;; requires the user to effectively construct the matcher regexp and detect 177 | ;; the matched pairs by hand. 178 | ;; 179 | ;; (2) They don't integrate with `query-replace'. This loses the commonly useful 180 | ;; interactive features such as skipping matches, going backward, undoing, 181 | ;; etc., but also the more advanced ones such as performing a recursive 182 | ;; edit, or using Lisp expressions (`\,') and query edits (`\?') in 183 | ;; replacements. 184 | ;; 185 | ;; (3) They don't provide a reusable programmatic interface for the implemented 186 | ;; functionality. 187 | ;; 188 | ;; See e.g.: 189 | ;; 190 | ;; - https://www.emacswiki.org/emacs/SwappingText 191 | ;; - https://stackoverflow.com/questions/2588277/how-can-i-swap-or-replace-multiple-strings-in-code-at-the-same-time/2592685#2592685 192 | ;; - https://www.masteringemacs.org/article/evaluating-lisp-forms-regular-expressions 193 | ;; - https://tony-zorman.com/posts/query-replace-many.html 194 | 195 | ;; * TODO 196 | ;; 197 | ;; - Report the mentioned `map-query-replace-regexp' `noedit' bug. 198 | ;; 199 | ;; - Add assumption checks/assertions/warnings for our advice, since we're 200 | ;; meddling with the internals of `replace.el'. Luckily this is all purely 201 | ;; aesthetical, but it would be nice to get a warning if anything ever changes 202 | ;; unexpectedly. 203 | 204 | ;;; Code: 205 | 206 | (require 'cl-lib) 207 | (require 'pcre2el) 208 | (require 'rx) 209 | (eval-when-compile (require 'subr-x)) 210 | 211 | (defun query-replace-parallel--prompt (regexp-flag) 212 | (concat "Query replace parallel" 213 | (and current-prefix-arg 214 | (if (eq current-prefix-arg '-) " backward" " word")) 215 | (and regexp-flag " regexp") 216 | (and (use-region-p) " in region"))) 217 | 218 | (defun query-replace-parallel--read-args (regexp-flag) 219 | "Interactively read replacement pairs for a parallel query 220 | replace by invoking `query-replace-read-args' multiple times. 221 | 222 | Reading stops when a replacement pair is repeated. Return the 223 | list (PAIRS DELIM BACKWARD). 224 | 225 | PAIRS is a list of conses (FROM . TO). FROM is the source string 226 | read from the user. If REGEXP-FLAG is nil, TO is the replacement 227 | string read from the user. Otherwise, TO can also be a cons 228 | depending on whether the read replacement string uses the Lisp 229 | expression `\\,' feature or not. 230 | 231 | DELIM and BACKWARD are taken from the return value of the last 232 | call to `query-replace-read-args' and should be forwarded as the 233 | arguments to the query replacement functions." 234 | (cl-loop for (from to delim backward) 235 | = (query-replace-read-args 236 | (query-replace-parallel--prompt regexp-flag) regexp-flag) 237 | for pair = (cons from to) 238 | ;; NOTE: `query-replace-read-args' will return the last pair from 239 | ;; history in case of empty input. That's our signal to stop reading. 240 | until (member pair pairs) 241 | collect pair into pairs 242 | finally (cl-return (list pairs delim backward)))) 243 | 244 | (defun query-replace-parallel--matcher (regexps) 245 | "Given a list of regexps, return a regexp that matches either of 246 | them (in order), but with a capture group wrapped around each 247 | one." 248 | (rx-to-string `(or ,@(mapcar (lambda (r) `(group (regexp ,r))) regexps)))) 249 | 250 | (defun query-replace-parallel--flatten (regexp) 251 | "Given a regexp, return the list (FLAT GROUPS). 252 | 253 | FLAT is the \"flattened\" version of REGEXP, where each 254 | explicitly numbered group is replaced with an implicit one. 255 | 256 | GROUPS is a list of indices, each related to an implicit group in 257 | FLAT, in order from left to right. The index is the number of the 258 | corresponding group in REGEXP, which gives us a 1-to-1 mapping 259 | between the groups of REGEXP and FLAT." 260 | (let ((i 1) 261 | (groups '())) 262 | (cl-labels ((walk (root) 263 | (if (atom root) 264 | root 265 | (pcase root 266 | (`(submatch . ,rest) 267 | (push i groups) 268 | (cl-incf i) 269 | `(submatch ,@(walk rest))) 270 | (`(submatch-n ,n . ,rest) 271 | (push n groups) 272 | (setf i (max i (1+ n))) 273 | `(submatch ,@(walk rest))) 274 | (_ 275 | (mapcar #'walk root)))))) 276 | (let ((form (walk (rxt-elisp-to-rx regexp)))) 277 | (list (rx-to-string form) (nreverse groups)))))) 278 | 279 | (defun query-replace-parallel--table (pairs regexp-flag) 280 | "Given the list of replacement pairs, construct the replacement 281 | table. 282 | 283 | Each pair is of the form (FROM . TO) and has a corresponding 284 | entry in the replacement table, which is an alist containing 285 | entries of the form (BASE . (FROM TO FLAT GROUPS)). 286 | 287 | The key BASE is the index of the group wrapped around the 288 | alternative for the particular pair in the matcher regexp. If 289 | REGEXP-FLAG is non-nil, FLAT and GROUPS are the result of 290 | flattening FROM. Otherwise, FLAT is a regexp-quoted version of 291 | FROM and GROUPS is an empty list." 292 | (cl-loop with i = 1 293 | for (from . to) in pairs 294 | for (flat groups) = (if regexp-flag 295 | (query-replace-parallel--flatten from) 296 | (list (regexp-quote from) '())) 297 | collect (cons i (list from to flat groups)) 298 | do (cl-incf i (1+ (length groups))))) 299 | 300 | (defun query-replace-parallel--match-data (base groups) 301 | "With the match data of the matcher regexp active, return the 302 | match data for the specific alternative corresponding to BASE. 303 | 304 | BASE is the index of the group wrapped around the alternative in 305 | the matcher regexp. GROUPS is a list of indices mapping the 306 | successive groups (starting at BASE + 1) of the matcher regexp to 307 | the respective groups in the original non-flat regexp of the 308 | alternative." 309 | (let* ((n (if groups (apply #'max groups) 0)) 310 | (data (make-vector (* 2 (1+ n)) nil))) 311 | (setf (aref data 0) (match-beginning base) 312 | (aref data 1) (match-end base)) 313 | (cl-loop for i from 1 314 | for j in groups 315 | when (match-beginning (+ base i)) 316 | do (setf (aref data (* 2 j)) (match-beginning (+ base i)) 317 | (aref data (1+ (* 2 j))) (match-end (+ base i)))) 318 | (cl-coerce data 'list))) 319 | 320 | (defun query-replace-parallel--quote (string) 321 | "Return STRING but with each backslash sequence except for `\\?' 322 | escaped." 323 | (string-replace "\\\\?" "\\?" (string-replace "\\" "\\\\" string))) 324 | 325 | (defvar query-replace-parallel--state '() 326 | "A list of cons cells of the form (DESC . REGEXP-FLAG), 327 | used by our advice in order to patch the messages displayed by 328 | `perform-replace'. 329 | 330 | We use a list in order to support multiple reentrant invocations 331 | of `query-replace-parallel-perform-replace', e.g. as a result of 332 | a recursive edit initiated by the user. Each invocation binds the 333 | variable and adds a new cons to the front. 334 | 335 | DESC is initially nil but is mutated by each subsequent 336 | invocation of our replacement function to be the original FROM 337 | string provided by the user. 338 | 339 | REGEXP-FLAG is the value of the flag passed to the invocation of 340 | `query-replace-parallel-perform-replace'.") 341 | 342 | (defun query-replace-parallel--replacer (table regexp-flag) 343 | "Construct a replacement function suitable for a call to 344 | `perform-replace', which returns the replacement according to the 345 | given replacement table. 346 | 347 | If REGEXP-FLAG is nil, the replacement is taken literally. 348 | Otherwise, the replacement can use all of the features of 349 | `perform-replace' replacement. 350 | 351 | The produced replacement function preserves the match data." 352 | (lambda (_arg count) 353 | (cl-destructuring-bind (base . (from to _flat groups)) 354 | (cl-find-if #'match-beginning table :key #'car) 355 | (setf (caar query-replace-parallel--state) from) 356 | ;; TO can either be a string or a cons. We handle the case where it's a 357 | ;; literal string specially to avoid computing and setting the match data. 358 | (if (and (stringp to) (not regexp-flag)) 359 | ;; Escape TO so that the calling `perform-replace' takes it literally. 360 | (replace-quote to) 361 | (let ((original (match-data))) 362 | (set-match-data (query-replace-parallel--match-data base groups)) 363 | (unwind-protect 364 | (let ((rep (cl-etypecase to 365 | (string to) 366 | (cons (funcall (car to) (cdr to) count))))) 367 | ;; We first do what `perform-replace' would normally do, i.e. 368 | ;; substitute any references to captured groups, but while our 369 | ;; custom match data is active. Then, we escape all of the 370 | ;; backslash sequences so that they don't get interpreted again 371 | ;; by the calling `perform-replace', except for `\\?' which we 372 | ;; leave for it to handle. 373 | (query-replace-parallel--quote 374 | (match-substitute-replacement 375 | rep (not (and case-replace case-fold-search))))) 376 | (set-match-data original))))))) 377 | 378 | (defun query-replace-parallel--patch-noedit (args) 379 | (cl-destructuring-bind (newtext fixedcase literal _noedit match-data 380 | &optional backward) 381 | args 382 | (list newtext fixedcase literal nil match-data backward))) 383 | 384 | (defun query-replace-parallel--patch-description (oldfun string) 385 | ;; Detect and forward along our special `query-replace-parallel--tag' property 386 | ;; that we can detect in a call to `message'. 387 | (let ((res (funcall oldfun string))) 388 | (if (get-text-property 0 'query-replace-parallel--tag string) 389 | (propertize res 'query-replace-parallel--tag t) 390 | res))) 391 | 392 | (defconst query-replace-parallel--message-regexp 393 | (rx "Query replacing" (group (+ nonl)) "regexp %s")) 394 | 395 | (defun query-replace-parallel--patch-message (args) 396 | (cl-destructuring-bind (format &optional arg &rest rest) args 397 | (if-let ((pos (and (stringp arg) 398 | (get-text-property 0 'query-replace-parallel--tag arg) 399 | (string-match query-replace-parallel--message-regexp 400 | format)))) 401 | (let ((rep (concat "Query replacing parallel\\1" 402 | (and (cdar query-replace-parallel--state) "regexp ") 403 | "%s"))) 404 | (cl-list* (replace-match 405 | (apply #'propertize rep (text-properties-at pos format)) 406 | t nil format) 407 | (caar query-replace-parallel--state) 408 | rest)) 409 | args))) 410 | 411 | (defconst query-replace-parallel--help-regexp 412 | (rx "Query replacing" (group (+ nonl)) "regexp " (+ nonl) " with")) 413 | 414 | (defun query-replace-parallel--patch-help () 415 | (save-excursion 416 | (goto-char (point-min)) 417 | (when-let ((pos (re-search-forward query-replace-parallel--help-regexp 418 | nil t))) 419 | (let ((inhibit-read-only t) 420 | (rep (concat "Query replacing parallel\\1" 421 | (and (cdar query-replace-parallel--state) "regexp ") 422 | (caar query-replace-parallel--state) 423 | " with"))) 424 | (replace-match (apply #'propertize rep (text-properties-at pos)) 425 | t nil))))) 426 | 427 | (defun query-replace-parallel-perform-replace 428 | (pairs query-flag regexp-flag delimited 429 | &optional map start end backward region-noncontiguous-p) 430 | "Perform multiple replacements given by PAIRS as if by 431 | `perform-replace', except in parallel. That is, the replacements 432 | are performed in a single pass and cannot erroneously replace a 433 | previous replacement. 434 | 435 | PAIRS is a list of conses of the form (FROM . TO) and specifies 436 | that occurrences of the regexp FROM should be replaced with the 437 | string TO. TO can either be a string or a cons, which have the 438 | same meaning as in `perform-replace'. Unlike `perform-replace' 439 | however, it cannot be a list of strings. 440 | 441 | Matches are always processed earliest first, regardless of the 442 | length of the match or the order of the replacement pairs. If two 443 | matches occur at the same position, then the order of the pairs 444 | is significant and the one earlier in the list wins. 445 | 446 | Arguments QUERY-FLAG, REGEXP-FLAG, DELIMITED, MAP, START, END, 447 | BACKWARD AND REGION-NONCONTIGUOUS-P are as in `perform-replace', 448 | which see. The REPEAT-COUNT argument is not supported." 449 | (let* ((table (query-replace-parallel--table pairs regexp-flag)) 450 | (regexp (query-replace-parallel--matcher (mapcar #'cadddr table))) 451 | (query-replace-parallel--state (cons (cons nil regexp-flag) 452 | query-replace-parallel--state))) 453 | (unwind-protect 454 | (let ((temp-buffer-show-hook (cons #'query-replace-parallel--patch-help 455 | temp-buffer-show-hook))) 456 | (advice-add #'replace-match-maybe-edit :filter-args 457 | #'query-replace-parallel--patch-noedit) 458 | (advice-add #'query-replace-descr :around 459 | #'query-replace-parallel--patch-description) 460 | (advice-add #'message :filter-args 461 | #'query-replace-parallel--patch-message) 462 | (perform-replace 463 | (propertize regexp 'query-replace-parallel--tag t) 464 | (cons (query-replace-parallel--replacer table regexp-flag) nil) 465 | query-flag :regexp delimited nil map start end backward 466 | region-noncontiguous-p)) 467 | (advice-remove #'replace-match-maybe-edit 468 | #'query-replace-parallel--patch-noedit) 469 | (advice-remove #'query-replace-descr 470 | #'query-replace-parallel--patch-description) 471 | (advice-remove #'message 472 | #'query-replace-parallel--patch-message)))) 473 | 474 | (defun query-replace-parallel--args (regexp-flag) 475 | (cl-destructuring-bind (pairs delimited backward) 476 | (query-replace-parallel--read-args regexp-flag) 477 | (list pairs 478 | delimited 479 | (and (use-region-p) (region-beginning)) 480 | (and (use-region-p) (region-end)) 481 | backward 482 | (and (use-region-p) (region-noncontiguous-p))))) 483 | 484 | ;;;###autoload 485 | (defun query-replace-parallel (pairs &optional delimited start end 486 | backward region-noncontiguous-p) 487 | "Perform multiple replacements given by PAIRS as if by 488 | `query-replace', except in parallel. That is, the replacements 489 | are performed in a single pass and cannot erroneously replace a 490 | previous replacement. 491 | 492 | PAIRS is a list of conses of the form (FROM . TO) and specifies 493 | that occurrences of the string FROM should be replaced with the 494 | string TO. TO can either be a string or a cons, which have the 495 | same meaning as in `perform-replace'. 496 | 497 | Matches are always processed earliest first, regardless of the 498 | length of the match or the order of the replacement pairs. If two 499 | matches occur at the same position, then the order of the pairs 500 | is significant and the one earlier in the list wins. 501 | 502 | Arguments DELIMITED, START, END, BACKWARD and 503 | REGION-NONCONTIGUOUS-P are passed to 504 | `query-replace-parallel-perform-replace' (which see)." 505 | (interactive (query-replace-parallel--args nil)) 506 | (query-replace-parallel-perform-replace 507 | pairs :query nil delimited nil start end backward 508 | region-noncontiguous-p)) 509 | 510 | ;;;###autoload 511 | (defun query-replace-parallel-regexp (pairs &optional delimited start end 512 | backward region-noncontiguous-p) 513 | "Perform multiple replacements given by PAIRS as if by 514 | `query-replace-regexp', except in parallel. That is, the 515 | replacements are performed in a single pass and cannot 516 | erroneously replace a previous replacement. 517 | 518 | PAIRS is a list of conses of the form (FROM . TO) and specifies 519 | that occurrences of the regexp FROM should be replaced with the 520 | string TO. TO can either be a string or a cons, which have the 521 | same meaning as in `perform-replace'. The final string is 522 | interpreted the same as the replacement string in 523 | `query-replace-regexp'. 524 | 525 | In interactive calls, the replacement string entered at the 526 | prompt can contain `\\,' followed by a Lisp expression, just as in 527 | `query-replace-regexp'. 528 | 529 | Matches are always processed earliest first, regardless of the 530 | length of the match or the order of the replacement pairs. If two 531 | matches occur at the same position, then the order of the pairs 532 | is significant and the one earlier in the list wins. 533 | 534 | Arguments DELIMITED, START, END, BACKWARD and 535 | REGION-NONCONTIGUOUS-P are passed to 536 | `query-replace-parallel-perform-replace' (which see)." 537 | (interactive (query-replace-parallel--args :regexp)) 538 | (query-replace-parallel-perform-replace 539 | pairs :query :regexp delimited nil start end backward 540 | region-noncontiguous-p)) 541 | 542 | (provide 'query-replace-parallel) 543 | ;;; query-replace-parallel.el ends here 544 | --------------------------------------------------------------------------------