├── .github └── workflows │ └── test.yml ├── LICENSE.md ├── README.md ├── snap-indent-tests.el └── snap-indent.el /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | # ERT tests 2 | 3 | name: ert 4 | on: [push, pull_request] 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Check out code 11 | uses: actions/checkout@v2 12 | 13 | - name: Install Emacs 14 | run: sudo apt-get update && sudo apt-get install -y emacs && emacs --version 15 | 16 | - name: Run tests 17 | run: emacs -batch -l ert -l snap-indent.el -l snap-indent-tests.el -f ert-run-tests-batch-and-exit 18 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 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 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | 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 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because 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 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 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 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | 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 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Snap-indent 2 | 3 | [![Build Status](https://github.com/jeffvalk/snap-indent/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/jeffvalk/snap-indent/actions) 4 | [![MELPA](https://melpa.org/packages/snap-indent-badge.svg)](https://melpa.org/#/snap-indent) 5 | [![License GPL 3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.txt) 6 | 7 | ## Synopsis 8 | 9 | Snap-indent provides simple automatic indentation (and optional formatting) when yanking/pasting text. It was inspired by [auto-indent-mode](https://github.com/mattfidler/auto-indent-mode.el), and is designed for improved simplicity, flexibility, and interoperability. 10 | 11 | `snap-indent-mode` is an Emacs minor mode that enables the following features: 12 | 13 | - Indent inserted text according to major mode on yank/paste 14 | - Indent buffer text according to major mode on save (optional) 15 | - When indenting, additionally format text, e.g. tabify, untabify, remove trailing whitespace, etc (optional) 16 | - Prevent minor mode activation in certain major modes (optional) 17 | - Skip indentation systematically by maximum text length or according to any user-defined predicate (optional) 18 | - Skip indentation for a single operation using an argument prefix (optional) 19 | 20 | Snap-indent's additional formatting behavior is very flexible. Any function that operates on a region may be used, and multiple functions may be specified. 21 | 22 | Snap-indent can be configured to skip indentation with equal flexibility. Any predicate function can be set control this behavior systematically, and indentation may be suppressed for a single operation with key input. 23 | 24 | ## Related packages 25 | 26 | ### Complement to electric-indent-mode 27 | 28 | `electric-indent-mode` indents while typing. Snap-indent indents on yank/paste and optionally on save. These do not overlap, and work well together. 29 | 30 | ### Successor to auto-indent-mode 31 | 32 | Snap-indent was originally created as a minimalist replacement for `auto-indent-mode`. That package was widely used and appreciated, but also quite complex, which led to interoperability bugs with other common packages. In contrast, snap-indent, while quite flexible, is designed for simplicity and hygiene. It's lightweight and should play well with other packages. 33 | 34 | As of 2023-06-23, `auto-indent-mode` was retired by its author, who [recommended](https://github.com/mattfidler/auto-indent-mode.el/commit/2dab3cb2229687b16c8a3aca3f8063df2275b8ea) snap-indent as a successor. 35 | 36 | ## Installation 37 | 38 | Snap-indent is available from [MELPA](https://melpa.org/). 39 | 40 | ## Usage 41 | 42 | Execute `M-x snap-indent-mode` to enable in any buffer, or add a hook to enable for a specific mode: 43 | 44 | ```elisp 45 | (add-hook 'prog-mode-hook #'snap-indent-mode) 46 | ``` 47 | 48 | To configure via `use-package`, adapt the following example as desired: 49 | 50 | ```elisp 51 | (use-package snap-indent 52 | :hook (prog-mode . snap-indent-mode) 53 | :custom ((snap-indent-format 'untabify) 54 | (snap-indent-on-save t))) 55 | ``` 56 | 57 | ### Customization 58 | 59 | The following customization variables are available: 60 | 61 | | Variable | Type | Default | Description | 62 | |:---------------------------------|:-----------------|:------------------|:-----------------------------------------------------------| 63 | | `snap-indent-excluded-modes` | symbol list | [See list][modes] | Major modes in which to ignore activation | 64 | | `snap-indent-format` | function or list | `nil` | Additional formatting to apply when indenting | 65 | | `snap-indent-on-save` | boolean | `nil` | Whether to indent the entire buffer on save | 66 | | `snap-indent-length-limit` | integer | `nil` | Maximum text length to indent | 67 | | `snap-indent-skip-on-prefix-arg` | boolean | `nil` | Whether a prefix argument causes indentation to be skipped | 68 | | `snap-indent-skip-on-condition` | function | `nil` | Predicate function to cause indentation to be skipped | 69 | 70 | [modes]: snap-indent.el#L59-L76 71 | 72 | ### Additional formatting 73 | 74 | Snap-indent can optionally apply additional formatting when indenting. This is highly customizable and controlled by the variable `snap-indent-format`. When non-nil, this variable may be either a single function or a list of functions to apply sequentially: 75 | 76 | ```elisp 77 | (setq snap-indent-format 'untabify) ; single function 78 | (setq snap-indent-format '(untabify delete-trailing-whitespace ...)) ; list of functions 79 | ``` 80 | 81 | Each function must accept two arguments: the beginning and end positions of the region on which to operate. Functions may be specified as symbols or lambda forms. Useful built-in functions include `tabify` and `untabify` for tab/space conversion and `delete-trailing-whitespace`. 82 | 83 | ### Controlling activation 84 | 85 | - **Prevention by major mode**. To prevent enabling of `snap-indent-mode` in certain major modes, include these in the `snap-indent-excluded-modes` list. This permits activation for `prog-mode` while excluding certain modes derived from `prog-mode`, for example. 86 | 87 | - **Skipping individual operations**. 88 | When `snap-indent-mode` is enabled, its indentation behavior may still be skipped for an individual operation. 89 | 90 | - To skip indentation on large blocks for text (for performance reasons), set `snap-indent-length-limit`. 91 | - To skip indentation manually for a single command, set `snap-indent-skip-on-prefix-arg` to `t`, then use a prefix argument (e.g. `C-u`) when invoking the command. 92 | - To skip indentation systematically according to any user-specified logic, set `snap-indent-skip-on-condition` to a predicate function. The function must accept two arguments, which specify the start and end positions of the region on which to (potentially) operate. The function should return non-nil to skip indentation, and nil otherwise. 93 | 94 | ## License 95 | 96 | Copyright © 2023 Jeff Valk 97 | 98 | Distributed under the GNU General Public License, version 3 99 | -------------------------------------------------------------------------------- /snap-indent-tests.el: -------------------------------------------------------------------------------- 1 | ;;; snap-indent-tests.el --- Snap-indent tests -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2023 Jeff Valk 4 | 5 | ;; Author: Jeff Valk 6 | 7 | ;; This file is NOT part of GNU Emacs. 8 | 9 | ;; This program is free software; you can redistribute it and/or modify 10 | ;; it under the terms of the GNU General Public License as published by 11 | ;; the Free Software Foundation, either version 3 of the License, or 12 | ;; (at your option) any later version. 13 | ;; 14 | ;; This program is distributed in the hope that it will be useful, 15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | ;; GNU General Public License for more details. 18 | ;; 19 | ;; You should have received a copy of the GNU General Public License 20 | ;; along with this program. If not, see . 21 | 22 | ;;; Commentary: 23 | 24 | ;; Tests for snap-indent 25 | 26 | ;;; Code: 27 | 28 | (require 'ert) 29 | (require 'cl-lib) 30 | (require 'snap-indent) 31 | 32 | (ert-deftest snap-indent-as-list-test () 33 | "Test function list wrapping, particularly with lambdas." 34 | (let* ((lam1 (lambda () 'dummy-value)) 35 | (lam2 (function (lambda () 'dummy-value))) 36 | (sym1 'tabify) 37 | (syms1 '(tabify untabify delete-trailing-whitespace)) 38 | (list1 (cons lam1 syms1)) 39 | (list2 (append syms1 (list lam1 lam2 (lambda () 'dummy-value))))) 40 | (should (equal (snap-indent-as-list lam1) (list lam1))) 41 | (should (equal (snap-indent-as-list lam2) (list lam2))) 42 | (should (equal (snap-indent-as-list sym1) (list sym1))) 43 | (should (equal (snap-indent-as-list syms1) syms1)) 44 | (should (equal (snap-indent-as-list list1) list1)) 45 | (should (equal (snap-indent-as-list list2) list2)) 46 | (should (cl-every #'functionp (snap-indent-as-list list1))) 47 | (should (cl-every #'functionp (snap-indent-as-list list2))))) 48 | 49 | (ert-deftest snap-indent-indent-test () 50 | "Test indentation and formatting." 51 | ;; The tests below rely on equivalence of indentation behavior between elisp 52 | ;; major mode formatting and pretty printing. If these ever break suddenly, 53 | ;; check this assumption. 54 | (let* ((inhibit-message t) ; run tests quietly 55 | (forms '(lorem ipsum dolor 56 | (sit amet consectetur (adipiscing elit)) 57 | (sed () do eiusmod 58 | (tempor incididunt) (ut (labore (et (dolore ()))))) 59 | (magna aliqua ut) 60 | (((enim)) ad (minim) veniam) 61 | (quis nostrud exercitation ullamco laboris nisi))) 62 | (pp-text (pp-to-string forms)) 63 | (unindented-text (replace-regexp-in-string "^ *" "" pp-text)) 64 | (trailing-ws-text (replace-regexp-in-string "\n" " \n" unindented-text))) 65 | ;; Indentation only, no formatting 66 | (with-temp-buffer 67 | (emacs-lisp-mode) 68 | (snap-indent-mode) 69 | (let ((snap-indent-format nil)) 70 | (insert unindented-text) 71 | (snap-indent-indent (point-min) (point-max)) 72 | (should (string-equal (buffer-string) pp-text)))) 73 | ;; Indentation with one formatting function 74 | (with-temp-buffer 75 | (emacs-lisp-mode) 76 | (snap-indent-mode) 77 | (let ((snap-indent-format 'delete-trailing-whitespace)) 78 | (insert trailing-ws-text) 79 | (snap-indent-indent (point-min) (point-max)) 80 | (should (string-equal (buffer-string) pp-text)))) 81 | ;; Indentation with multiple formatting functions 82 | (with-temp-buffer 83 | (emacs-lisp-mode) 84 | (snap-indent-mode) 85 | (let ((snap-indent-format '(delete-trailing-whitespace upcase-region))) 86 | (insert trailing-ws-text) 87 | (snap-indent-indent (point-min) (point-max)) 88 | (should (string-equal (buffer-string) (upcase pp-text))))) 89 | ;; Ensure effects are confined to region 90 | (with-temp-buffer 91 | (emacs-lisp-mode) 92 | (snap-indent-mode) 93 | (let* ((snap-indent-format nil) 94 | (beg (length unindented-text)) 95 | (end (* beg 2))) 96 | (insert unindented-text 97 | unindented-text 98 | unindented-text) 99 | (snap-indent-indent beg end) ; format only second text region 100 | (should (string-equal (buffer-string) 101 | (concat unindented-text 102 | pp-text 103 | unindented-text))))))) 104 | 105 | (ert-deftest snap-indent-maybe-indent-test () 106 | "Test conditional indentation." 107 | ;; The tests below rely on equivalence of indentation behavior between elisp 108 | ;; major mode formatting and pretty printing. If these ever break suddenly, 109 | ;; check this assumption. 110 | (let* ((inhibit-message t) ; run tests quietly 111 | (forms '(lorem ipsum dolor 112 | (sit amet consectetur (adipiscing elit)) 113 | (sed () do eiusmod 114 | (tempor incididunt) (ut (labore (et (dolore ()))))) 115 | (magna aliqua ut) 116 | (((enim)) ad (minim) veniam) 117 | (quis nostrud exercitation ullamco laboris nisi))) 118 | (pp-text (pp-to-string forms)) 119 | (unindented-text (replace-regexp-in-string "^ *" "" pp-text))) 120 | ;; Skip when exceeding length limit 121 | (with-temp-buffer 122 | (emacs-lisp-mode) 123 | (snap-indent-mode) 124 | (insert unindented-text) 125 | (let ((snap-indent-length-limit 10)) ; over limit 126 | (snap-indent-maybe-indent (point-min) (point-max)) 127 | (should (string-equal (buffer-string) unindented-text))) 128 | (let ((snap-indent-length-limit 10000)) ; under limit 129 | (snap-indent-maybe-indent (point-min) (point-max)) 130 | (should (string-equal (buffer-string) pp-text)))) 131 | ;; Skip when prefix arg is specified 132 | (with-temp-buffer 133 | (emacs-lisp-mode) 134 | (snap-indent-mode) 135 | (insert unindented-text) 136 | (let ((snap-indent-skip-on-prefix-arg t) 137 | (current-prefix-arg '(4))) ; prefixed 138 | (snap-indent-maybe-indent (point-min) (point-max)) 139 | (should (string-equal (buffer-string) unindented-text))) 140 | (let ((snap-indent-skip-on-prefix-arg t) 141 | (current-prefix-arg nil)) ; not prefixed 142 | (snap-indent-maybe-indent (point-min) (point-max)) 143 | (should (string-equal (buffer-string) pp-text)))) 144 | ;; Skip according to user-defined predicate 145 | (with-temp-buffer 146 | (emacs-lisp-mode) 147 | (snap-indent-mode) 148 | (insert unindented-text) 149 | (let ((snap-indent-skip-on-condition (lambda (_ _) t))) ; pred: t 150 | (snap-indent-maybe-indent (point-min) (point-max)) 151 | (should (string-equal (buffer-string) unindented-text))) 152 | (let ((snap-indent-skip-on-condition (lambda (_ _) nil))) ; pred: nil 153 | (snap-indent-maybe-indent (point-min) (point-max)) 154 | (should (string-equal (buffer-string) pp-text)))))) 155 | 156 | (provide 'snap-indent-tests) 157 | 158 | ;;; snap-indent-tests.el ends here 159 | -------------------------------------------------------------------------------- /snap-indent.el: -------------------------------------------------------------------------------- 1 | ;;; snap-indent.el --- Simple automatic indentation -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2023 Jeff Valk 4 | 5 | ;; Author: Jeff Valk 6 | ;; URL: https://github.com/jeffvalk/snap-indent 7 | ;; Keywords: indent tools convenience 8 | ;; Version: 1.1 9 | ;; Package-Requires: ((emacs "24.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 | ;; Snap-indent provides simple automatic indentation (and optional formatting) 29 | ;; when yanking/pasting text. It was inspired by `auto-indent-mode', and is 30 | ;; designed for improved simplicity, flexibility, and interoperability. 31 | ;; 32 | ;; `snap-indent-mode' is an Emacs minor mode that enables the following 33 | ;; features: 34 | ;; 35 | ;; - Indent inserted text according to major mode on yank/paste 36 | ;; - Indent buffer text according to major mode on save (optional) 37 | ;; - When indenting, additionally format text, e.g. tabify, untabify, remove 38 | ;; trailing whitespace, etc (optional) 39 | ;; - Prevent minor mode activation in certain major modes (optional) 40 | ;; - Skip indentation systematically by maximum text length or according to any 41 | ;; user-defined predicate (optional) 42 | ;; - Skip indentation for a single operation using an argument prefix (optional) 43 | ;; 44 | ;; Snap-indent's additional formatting behavior is very flexible. Any function 45 | ;; that operates on a region may be used, and multiple functions may be 46 | ;; specified. 47 | ;; 48 | ;; Snap-indent can be configured to skip indentation with equal flexibility. 49 | ;; Any predicate function can be set control this behavior systematically, and 50 | ;; indentation may be suppressed for a single operation with key input. 51 | 52 | ;;; Code: 53 | 54 | (defgroup snap-indent nil 55 | "Customization group for snap-indent." 56 | :prefix "snap-indent-" 57 | :group 'indent) 58 | 59 | (defcustom snap-indent-excluded-modes '(cmake-ts-mode 60 | coffee-mode 61 | conf-mode 62 | elm-mode 63 | haml-mode 64 | haskell-mode 65 | makefile-automake-mode 66 | makefile-bsdmake-mode 67 | makefile-gmake-mode 68 | makefile-imake-mode 69 | makefile-makepp-mode 70 | makefile-mode 71 | occam-mode 72 | python-mode 73 | python-ts-mode 74 | slim-mode 75 | yaml-mode 76 | yaml-ts-mode) 77 | "Modes in which `snap-indent-mode' should not be activated. 78 | This permits activation for `prog-mode' while excluding certain modes derived 79 | from `prog-mode', for example." 80 | :type '(repeat symbol) 81 | :group 'snap-indent) 82 | 83 | (defcustom snap-indent-on-save nil 84 | "Whether to indent the entire buffer on save." 85 | :type 'boolean 86 | :group 'snap-indent) 87 | 88 | (defcustom snap-indent-format nil 89 | "Additional formatting function(s) to apply when indenting. 90 | This may be a single function, a list of functions, or nil. The function(s) must 91 | accept two arguments, which specify the start and end positions of the region on 92 | which to operate. Useful built-in functions include `tabify' and `untabify' for 93 | tab/space conversion and `delete-trailing-whitespace'." 94 | :type '(choice 95 | (function :tag "Single function") 96 | (repeat :tag "List of functions" function)) 97 | :group 'snap-indent) 98 | 99 | (defcustom snap-indent-length-limit nil 100 | "Maximum text length to indent. 101 | Set this to prevent any performance issues with large blocks of text. 102 | When nil, no limit is applied." 103 | :type 'integer 104 | :group 'snap-indent) 105 | 106 | (defcustom snap-indent-skip-on-prefix-arg nil 107 | "Whether a prefix command argument causes indentation to be skipped. 108 | When non-nil, this lets you skip indentation for a single operation without 109 | disabling `snap-indent-mode'." 110 | :type 'boolean 111 | :group 'snap-indent) 112 | 113 | (defcustom snap-indent-skip-on-condition nil 114 | "Predicate function to cause indentation to be skipped. 115 | When specified, this lets you skip indentation for a single operation without 116 | disabling `snap-indent-mode' according to any logic you choose. 117 | 118 | The function must accept two arguments, which specify the start and end 119 | positions of the region on which to (potentially) operate. The function should 120 | return non-nil to skip indentation, and nil otherwise." 121 | :type 'function 122 | :group 'snap-indent) 123 | 124 | ;; To make user configuration more expressive and less error-prone, 125 | ;; `snap-indent-format' may be either a function or a list of functions; if the 126 | ;; former, we'll wrap it in a list. Caveat when checking for this: lambdas are 127 | ;; both functions and lists. (The lambda form is self-quoting; evaluating it 128 | ;; returns the form itself.) Hence, to distinguish what should be wrapped, we 129 | ;; must test the value's function-ness not just its list-ness. 130 | 131 | (defun snap-indent-as-list (function-or-list) 132 | "Return FUNCTION-OR-LIST as a list, treating lambda forms as atoms." 133 | (if (or (not (listp function-or-list)) (functionp function-or-list)) 134 | (list function-or-list) 135 | function-or-list)) 136 | 137 | (defun snap-indent-indent (beg end) 138 | "Indent and optionally format the text between BEG and END." 139 | (let ((transient-mark-mode nil) 140 | (orig-max (point-max))) 141 | (indent-region beg end) 142 | (dolist (format (snap-indent-as-list snap-indent-format)) 143 | (let ((end* (+ end (- (point-max) orig-max)))) ; account for prior changes 144 | (funcall format beg end*))))) 145 | 146 | (defun snap-indent-maybe-indent (beg end) 147 | "If the region between BEG and END should be indented, dispatch that action." 148 | (unless (or (and snap-indent-length-limit 149 | (> (- end beg) snap-indent-length-limit)) 150 | (and snap-indent-skip-on-prefix-arg 151 | current-prefix-arg) 152 | (and snap-indent-skip-on-condition 153 | (funcall snap-indent-skip-on-condition beg end))) 154 | (snap-indent-indent beg end))) 155 | 156 | (defun snap-indent-save-handler () 157 | "Indent buffer text on save as specified." 158 | (when snap-indent-on-save 159 | (snap-indent-maybe-indent (point-min) (point-max)))) 160 | 161 | (defun snap-indent-command-handler () 162 | "Indent region text on yank." 163 | (when (memq this-command '(yank yank-pop)) 164 | (snap-indent-maybe-indent (region-beginning) (region-end)))) 165 | 166 | ;;;###autoload 167 | (define-minor-mode snap-indent-mode 168 | "Toggle snap-indent mode on or off. 169 | Turn snap-indent on if ARG is positive, or off otherwise." 170 | :init-value nil 171 | :global nil 172 | :lighter " Snap" 173 | (if (and snap-indent-mode 174 | (not (memq major-mode snap-indent-excluded-modes))) 175 | (progn 176 | (add-hook 'before-save-hook #'snap-indent-save-handler nil 'local) 177 | (add-hook 'post-command-hook #'snap-indent-command-handler nil 'local)) 178 | (progn 179 | (remove-hook 'before-save-hook #'snap-indent-save-handler 'local) 180 | (remove-hook 'post-command-hook #'snap-indent-command-handler 'local)))) 181 | 182 | (provide 'snap-indent) 183 | 184 | ;;; snap-indent.el ends here 185 | --------------------------------------------------------------------------------