├── .dir-locals.el ├── .github └── workflows │ └── compile.yml ├── .gitignore ├── LICENSE ├── Makefile ├── README.org └── hl-todo.el /.dir-locals.el: -------------------------------------------------------------------------------- 1 | ((nil 2 | (indent-tabs-mode . nil)) 3 | (makefile-mode 4 | (indent-tabs-mode . t)) 5 | (git-commit-mode 6 | (git-commit-major-mode . git-commit-elisp-text-mode))) 7 | -------------------------------------------------------------------------------- /.github/workflows/compile.yml: -------------------------------------------------------------------------------- 1 | name: Compile 2 | on: [push, pull_request] 3 | jobs: 4 | compile: 5 | name: Compile 6 | uses: emacscollective/workflows/.github/workflows/compile.yml@main 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /*.elc 2 | /*-autoloads.el 3 | /.config.mk 4 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | -include .config.mk 2 | 3 | PKG = hl-todo 4 | 5 | ELS = $(PKG).el 6 | ELCS = $(ELS:.el=.elc) 7 | 8 | DEPS = compat 9 | 10 | EMACS ?= emacs 11 | EMACS_ARGS ?= 12 | 13 | LOAD_PATH ?= $(addprefix -L ../,$(DEPS)) 14 | LOAD_PATH += -L . 15 | 16 | all: lisp 17 | 18 | help: 19 | $(info make all - generate byte-code and autoloads) 20 | $(info make lisp - generate byte-code and autoloads) 21 | $(info make redo - re-generate byte-code and autoloads) 22 | $(info make clean - remove generated files) 23 | @printf "\n" 24 | 25 | redo: clean lisp 26 | 27 | lisp: $(ELCS) loaddefs check-declare 28 | 29 | loaddefs: $(PKG)-autoloads.el 30 | 31 | %.elc: %.el 32 | @printf "Compiling $<\n" 33 | @$(EMACS) -Q --batch $(EMACS_ARGS) $(LOAD_PATH) -f batch-byte-compile $< 34 | 35 | check-declare: 36 | @printf " Checking function declarations\n" 37 | @$(EMACS) -Q --batch $(EMACS_ARGS) $(LOAD_PATH) \ 38 | --eval "(check-declare-directory default-directory)" 39 | 40 | CLEAN = $(ELCS) $(PKG)-autoloads.el 41 | 42 | clean: 43 | @printf " Cleaning...\n" 44 | @rm -rf $(CLEAN) 45 | 46 | $(PKG)-autoloads.el: $(ELS) 47 | @printf " Creating $@\n" 48 | @$(EMACS) -Q --batch -l autoload -l cl-lib --eval "\ 49 | (let ((file (expand-file-name \"$@\"))\ 50 | (autoload-timestamps nil) \ 51 | (backup-inhibited t)\ 52 | (version-control 'never)\ 53 | (coding-system-for-write 'utf-8-emacs-unix))\ 54 | (write-region (autoload-rubric file \"package\" nil) nil file nil 'silent)\ 55 | (cl-letf (((symbol-function 'progress-reporter-do-update) (lambda (&rest _)))\ 56 | ((symbol-function 'progress-reporter-done) (lambda (_))))\ 57 | (let ((generated-autoload-file file))\ 58 | (update-directory-autoloads default-directory))))" \ 59 | 2>&1 | sed "/^Package autoload is deprecated$$/d" 60 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | ** Highlight TODO and similar keywords in comments and strings 2 | 3 | To highlight keywords turn on ~hl-todo-mode~ in individual buffers 4 | or use the global variant ~global-hl-todo-mode~. 5 | 6 | You can customize the keywords that are recognized by customizing 7 | ~hl-todo-keyword-faces~ either through the customization interface 8 | or by setting the variable directly in your init file, for example: 9 | 10 | #+begin_src emacs-lisp 11 | (setq hl-todo-keyword-faces 12 | '(("TODO" . "#FF0000") 13 | ("FIXME" . "#FF0000") 14 | ("DEBUG" . "#A020F0") 15 | ("GOTCHA" . "#FF4500") 16 | ("STUB" . "#1E90FF"))) 17 | #+end_src 18 | 19 | This package also provides commands for moving to the next or 20 | previous keyword, to invoke ~occur~ with a regexp that matches all 21 | known keywords, and to insert a keyword. If you want to use these 22 | commands, then you should bind them in ~hl-todo-mode-map~, e.g.: 23 | 24 | #+begin_src emacs-lisp 25 | (keymap-set hl-todo-mode-map "C-c p" #'hl-todo-previous) 26 | (keymap-set hl-todo-mode-map "C-c n" #'hl-todo-next) 27 | (keymap-set hl-todo-mode-map "C-c o" #'hl-todo-occur) 28 | (keymap-set hl-todo-mode-map "C-c i" #'hl-todo-insert) 29 | #+end_src 30 | 31 | *** FAQ and Common Issues 32 | 33 | See [[https://github.com/tarsius/hl-todo/wiki][FAQ and Common Issues]] if something isn't working as expected. 34 | 35 | *** Integrations 36 | 37 | - Command ~hl-todo-occur~ uses ~occur~ to list TODO keywords. 38 | - Command ~hl-todo-rgrep~ uses ~rgrep~ to list TODO keywords. 39 | - Function ~hl-todo-flymake~ teaches [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Flymake.html][flymake]] about TODO keywords. 40 | - Package [[https://github.com/alvarogonzalezsotillo/flycheck-hl-todo][flycheck-hl-todo]] adds TODO keywords to [[https://github.com/flycheck/flycheck][flycheck]]. 41 | - Package [[https://github.com/alphapapa/magit-todos][magit-todos]] displays TODO keyboards in [[https://github.com/magit/magit][magit]]'s status buffer. 42 | - Package [[https://github.com/liuyinz/consult-todo][consult-todo]] supports searching and jumping to TODO keywords 43 | using [[https://github.com/minad/consult][consult]]. 44 | - To highlight TODO keywords in Magit use: 45 | #+begin_src emacs-lisp 46 | (with-eval-after-load 'magit 47 | (add-hook 'magit-log-wash-summary-hook 48 | #'hl-todo-search-and-highlight t) 49 | (add-hook 'magit-revision-wash-message-hook 50 | #'hl-todo-search-and-highlight t)) 51 | #+end_src 52 | 53 | 54 | #+html:

55 | #+html: Compile 56 | #+html: MELPA Stable 57 | #+html: MELPA 58 | -------------------------------------------------------------------------------- /hl-todo.el: -------------------------------------------------------------------------------- 1 | ;;; hl-todo.el --- Highlight TODO and similar keywords -*- lexical-binding:t -*- 2 | 3 | ;; Copyright (C) 2013-2025 Jonas Bernoulli 4 | 5 | ;; Author: Jonas Bernoulli 6 | ;; Homepage: https://github.com/tarsius/hl-todo 7 | ;; Keywords: convenience 8 | 9 | ;; Package-Version: 3.8.4 10 | ;; Package-Requires: ((emacs "26.1") (compat "30.1")) 11 | 12 | ;; SPDX-License-Identifier: GPL-3.0-or-later 13 | 14 | ;; This file is free software: you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published 16 | ;; by the Free Software Foundation, either version 3 of the License, 17 | ;; or (at your option) any later version. 18 | ;; 19 | ;; This file 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 file. If not, see . 26 | 27 | ;;; Commentary: 28 | 29 | ;; Highlight TODO and similar keywords in comments and strings. 30 | 31 | ;; You can either explicitly turn on `hl-todo-mode' in certain buffers 32 | ;; or use the global variant `global-hl-todo-mode', which enables 33 | ;; the local mode based on each buffer's major-mode and the options 34 | ;; `hl-todo-include-modes' and `hl-todo-exclude-modes'. By default 35 | ;; `hl-todo-mode' is enabled for all buffers whose major-mode derive 36 | ;; from either `prog-mode' or `text-mode', except `org-mode'. 37 | 38 | ;; This package also provides commands for moving to the next or 39 | ;; previous keyword, to invoke `occur' with a regexp that matches all 40 | ;; known keywords, and to insert a keyword. If you want to use these 41 | ;; commands, then you should bind them in `hl-todo-mode-map', e.g.: 42 | ;; 43 | ;; (keymap-set hl-todo-mode-map "C-c p" #'hl-todo-previous) 44 | ;; (keymap-set hl-todo-mode-map "C-c n" #'hl-todo-next) 45 | ;; (keymap-set hl-todo-mode-map "C-c o" #'hl-todo-occur) 46 | ;; (keymap-set hl-todo-mode-map "C-c i" #'hl-todo-insert) 47 | 48 | ;;; Code: 49 | 50 | (require 'compat) 51 | (eval-when-compile (require 'subr-x)) 52 | (eval-when-compile (require 'cl-lib)) 53 | 54 | (defvar grep-find-template) 55 | (declare-function grep-read-files "grep" (regexp)) 56 | (declare-function flymake-make-diagnostic "flymake") 57 | 58 | (defgroup hl-todo nil 59 | "Highlight TODO and similar keywords in comments and strings." 60 | :group 'font-lock-extra-types) 61 | 62 | (defface hl-todo 63 | '((t (:bold t :foreground "#cc9393"))) 64 | "Base face used to highlight TODO and similar keywords. 65 | The faces used to highlight certain keywords are, by default, 66 | created by inheriting this face and using the appropriate 67 | color specified using the option `hl-todo-keyword-faces' as 68 | foreground color." 69 | :group 'hl-todo) 70 | 71 | (defcustom hl-todo-include-modes '(prog-mode text-mode conf-mode) 72 | "Major-modes in which `hl-todo-mode' is activated. 73 | 74 | This is used by `global-hl-todo-mode', which activates the local 75 | `hl-todo-mode' in all buffers whose major-mode derive from one 76 | of the modes listed here, but not from one of the modes listed 77 | in `hl-todo-exclude-modes'." 78 | :package-version '(hl-todo . "3.7.0") 79 | :group 'hl-todo 80 | :type '(repeat function)) 81 | 82 | (defcustom hl-todo-exclude-modes '(org-mode) 83 | "Major-modes in which `hl-todo-mode' is not activated. 84 | 85 | This is used by `global-hl-todo-mode', which activates the local 86 | `hl-todo-mode' in all buffers whose major-mode derived from one 87 | of the modes listed in `hl-todo-include-modes', but not from one 88 | of the modes listed here." 89 | :package-version '(hl-todo . "3.1.0") 90 | :group 'hl-todo 91 | :type '(repeat function)) 92 | 93 | (defcustom hl-todo-text-modes '(text-mode) 94 | "Major-modes that are considered text-modes. 95 | 96 | In buffers whose major-mode derives from one of the modes listed 97 | here TODO keywords are always highlighted even if they are not 98 | located inside a string." 99 | :package-version '(hl-todo . "2.1.0") 100 | :group 'hl-todo 101 | :type '(repeat function)) 102 | 103 | (defcustom hl-todo-keyword-faces 104 | '(("HOLD" . "#d0bf8f") 105 | ("TODO" . "#cc9393") 106 | ("NEXT" . "#dca3a3") 107 | ("THEM" . "#dc8cc3") 108 | ("PROG" . "#7cb8bb") 109 | ("OKAY" . "#7cb8bb") 110 | ("DONT" . "#5f7f5f") 111 | ("FAIL" . "#8c5353") 112 | ("DONE" . "#afd8af") 113 | ("NOTE" . "#d0bf8f") 114 | ("MAYBE" . "#d0bf8f") 115 | ("KLUDGE" . "#d0bf8f") 116 | ("HACK" . "#d0bf8f") 117 | ("TEMP" . "#d0bf8f") 118 | ("FIXME" . "#cc9393") 119 | ("XXXX*" . "#cc9393")) 120 | "An alist mapping keywords to colors/faces used to display them. 121 | 122 | Each entry has the form (KEYWORD . COLOR). KEYWORD is used as 123 | part of a regular expression. If (regexp-quote KEYWORD) is not 124 | equal to KEYWORD, then it is ignored by `hl-todo-insert-keyword'. 125 | Instead of a color (a string), each COLOR may alternatively be a 126 | face. 127 | 128 | The syntax class of the characters at either end has to be `w' 129 | \(which means word) in `hl-todo--syntax-table' (which derives 130 | from `text-mode-syntax-table'). 131 | 132 | This package, like most of Emacs, does not use POSIX regexp 133 | backtracking. See info node `(elisp)POSIX Regexp' for why that 134 | matters. If you have two keywords \"TODO-NOW\" and \"TODO\", then 135 | they must be specified in that order. Alternatively you could 136 | use \"TODO\\(-NOW\\)?\". 137 | 138 | If you use the command `hl-todo-rgrep', rewrite KEYWORDs to 139 | use \"*\" instead of \"+\" and generally make sure they are valid 140 | as Emacs regexps and as basic regular expressions as understood 141 | by Grep. If you customize variables in the `grep' group, or use 142 | a Grep implementation other than GNU's, then that may break 143 | `hl-todo-rgrep'." 144 | :package-version '(hl-todo . "3.5.0") 145 | :group 'hl-todo 146 | :type '(repeat (cons (string :tag "Keyword") 147 | (choice :tag "Face " 148 | (string :tag "Color") 149 | (sexp :tag "Face")))) 150 | :set (lambda (symbol value) 151 | (set-default-toplevel-value symbol value) 152 | (dolist (buf (buffer-list)) 153 | (with-current-buffer buf 154 | (when (and (bound-and-true-p hl-todo-mode) 155 | (boundp 'hl-todo--regexp)) 156 | (setq hl-todo--regexp nil) 157 | (hl-todo-mode -1) 158 | (hl-todo-mode 1)))))) 159 | 160 | (defface hl-todo-flymake-type '((t :inherit font-lock-keyword-face)) 161 | "Face used for the Flymake diagnostics type `hl-todo-flymake'. 162 | This is used for the word \"todo\" appearing in the \"Type\" column 163 | of buffers created by `flymake-show-buffer-diagnostics' and similar." 164 | :group 'hl-todo) 165 | 166 | (defcustom hl-todo-color-background nil 167 | "Whether to emphasize keywords using the background color. 168 | 169 | If an entry in `hl-todo-keyword-faces' specifies a face, then the 170 | respective keyword is displayed using exactly that face. In that 171 | case this option is irrelevant. 172 | 173 | Otherwise, if an entry specifies only a color, then the `hl-todo' 174 | face controls the appearance of the respective keyword, except 175 | for either the foreground or the background color. This option 176 | controls which of the two it is." 177 | :package-version '(hl-todo . "3.1.0") 178 | :group 'hl-todo 179 | :type 'boolean) 180 | 181 | (defcustom hl-todo-wrap-movement nil 182 | "Whether movement commands wrap around when there are no more matches." 183 | :package-version '(hl-todo . "3.4.0") 184 | :group 'hl-todo 185 | :type 'boolean) 186 | 187 | (defcustom hl-todo-highlight-punctuation "" 188 | "String of characters to highlight after keywords. 189 | 190 | Each of the characters appearing in this string is highlighted 191 | using the same face as the preceding keyword when it directly 192 | follows the keyword. 193 | 194 | Characters whose syntax class is `w' (which means word), 195 | including alphanumeric characters, cannot be used here." 196 | :package-version '(hl-todo . "2.0.0") 197 | :group 'hl-todo 198 | :type 'string) 199 | 200 | (defcustom hl-todo-require-punctuation nil 201 | "Whether to require punctuation after keywords." 202 | :package-version '(hl-todo . "3.3.0") 203 | :group 'hl-todo 204 | :type 'boolean) 205 | 206 | (defvar hl-todo--keywords 207 | `((,(lambda (bound) (hl-todo--search nil bound)) 208 | (1 (hl-todo--get-face) prepend t)))) 209 | 210 | (defvar-local hl-todo--regexp nil) 211 | 212 | (defsubst hl-todo--regexp () 213 | "Return regular expression matching TODO or similar keyword." 214 | (or hl-todo--regexp (hl-todo--setup-regexp))) 215 | 216 | (defun hl-todo--setup-regexp () 217 | "Setup keyword regular expression. 218 | See the function `hl-todo--regexp'." 219 | (when-let ((bomb (assoc "???" hl-todo-keyword-faces))) 220 | ;; If the user customized this variable before we started to 221 | ;; treat the strings as regexps, then the string "???" might 222 | ;; still be present. We have to remove it because it results 223 | ;; in the regexp search taking forever. 224 | (setq hl-todo-keyword-faces (delete bomb hl-todo-keyword-faces))) 225 | (setq hl-todo--regexp 226 | (concat "\\(\\<" 227 | "\\(" (mapconcat #'car hl-todo-keyword-faces "\\|") "\\)" 228 | "\\>" 229 | (and (not (equal hl-todo-highlight-punctuation "")) 230 | (concat "[" hl-todo-highlight-punctuation "]" 231 | (if hl-todo-require-punctuation "+" "*"))) 232 | "\\)"))) 233 | 234 | (defvar hl-todo--syntax-table (copy-syntax-table text-mode-syntax-table)) 235 | 236 | (defun hl-todo--search (&optional regexp bound backward) 237 | "Search for keyword REGEXP, optionally up to BOUND and BACKWARD. 238 | If REGEXP is not given, it defaults to the return value of the 239 | function `hl-todo--regexp'." 240 | (unless regexp 241 | (setq regexp (hl-todo--regexp))) 242 | (cl-block nil 243 | (while (let ((case-fold-search nil) 244 | (syntax-ppss-table (syntax-table))) 245 | (with-syntax-table hl-todo--syntax-table 246 | (funcall (if backward #'re-search-backward #'re-search-forward) 247 | regexp bound t))) 248 | (cond ((or (apply #'derived-mode-p hl-todo-text-modes) 249 | (hl-todo--inside-comment-or-string-p)) 250 | (cl-return t)) 251 | ((and bound (funcall (if backward #'<= #'>=) (point) bound)) 252 | (cl-return nil)))))) 253 | 254 | (defun hl-todo--inside-comment-or-string-p () 255 | "Check syntax state if point is located inside comment or string literal." 256 | (nth 8 (syntax-ppss))) 257 | 258 | (defun hl-todo--get-face () 259 | "Return face for current keyword during font locking." 260 | (let ((keyword (match-string 2))) 261 | (hl-todo--combine-face 262 | (cdr (or 263 | ;; Fast allocation free lookup for literal keywords. 264 | (assoc keyword hl-todo-keyword-faces) 265 | ;; Slower regexp lookup. 266 | (compat-call assoc keyword hl-todo-keyword-faces 267 | (lambda (a b) 268 | (string-match-p (format "\\`%s\\'" a) b)))))))) 269 | 270 | (defun hl-todo--combine-face (color) 271 | "Combine COLOR string with `hl-todo' default face. 272 | If COLOR is a face symbol, do not combine, return COLOR instead." 273 | (if (stringp color) 274 | `((,(if hl-todo-color-background :background :foreground) 275 | ,color) 276 | hl-todo) 277 | color)) 278 | 279 | (defvar-keymap hl-todo-mode-map 280 | :doc "Keymap for `hl-todo-mode'.") 281 | 282 | ;;;###autoload 283 | (define-minor-mode hl-todo-mode 284 | "Highlight TODO and similar keywords in comments and strings." 285 | :lighter "" 286 | :keymap hl-todo-mode-map 287 | :group 'hl-todo 288 | (if hl-todo-mode 289 | (font-lock-add-keywords nil hl-todo--keywords t) 290 | (font-lock-remove-keywords nil hl-todo--keywords)) 291 | (when font-lock-mode 292 | (jit-lock-mode 1))) 293 | 294 | ;;;###autoload 295 | (define-globalized-minor-mode global-hl-todo-mode 296 | hl-todo-mode hl-todo--turn-on-mode-if-desired) 297 | 298 | (defun hl-todo--turn-on-mode-if-desired () 299 | "Enable local minor mode `hl-todo-mode' if test succeeds. 300 | Depends on `hl-todo-include-modes' and `hl-todo-exclude-modes'." 301 | (when (and (apply #'derived-mode-p hl-todo-include-modes) 302 | (not (apply #'derived-mode-p hl-todo-exclude-modes)) 303 | (not (bound-and-true-p enriched-mode)) 304 | (not (string-prefix-p " *temp*" (buffer-name)))) 305 | (hl-todo-mode 1))) 306 | 307 | ;;;###autoload 308 | (defun hl-todo-next (arg) 309 | "Jump to the next TODO or similar keyword. 310 | The prefix argument ARG specifies how many keywords to move. 311 | A negative argument means move backward that many keywords." 312 | (interactive "p") 313 | (if (< arg 0) 314 | (hl-todo-previous (- arg)) 315 | (while (and (> arg 0) 316 | (not (eobp)) 317 | (progn 318 | (when (let ((case-fold-search nil)) 319 | (looking-at (hl-todo--regexp))) 320 | (goto-char (match-end 0))) 321 | (or (hl-todo--search) 322 | (if hl-todo-wrap-movement 323 | nil 324 | (user-error "No more matches"))))) 325 | (cl-decf arg)) 326 | (when (> arg 0) 327 | (let ((pos (save-excursion 328 | (goto-char (point-min)) 329 | (let ((hl-todo-wrap-movement nil)) 330 | (hl-todo-next arg)) 331 | (point)))) 332 | (goto-char pos))))) 333 | 334 | ;;;###autoload 335 | (defun hl-todo-previous (arg) 336 | "Jump to the previous TODO or similar keyword. 337 | The prefix argument ARG specifies how many keywords to move. 338 | A negative argument means move forward that many keywords." 339 | (interactive "p") 340 | (if (< arg 0) 341 | (hl-todo-next (- arg)) 342 | (while (and (> arg 0) 343 | (not (bobp)) 344 | (let ((start (point))) 345 | (hl-todo--search (concat (hl-todo--regexp) "\\=") nil t) 346 | (or (hl-todo--search nil nil t) 347 | (progn (goto-char start) 348 | (if hl-todo-wrap-movement 349 | nil 350 | (user-error "No more matches")))))) 351 | (goto-char (match-end 0)) 352 | (cl-decf arg)) 353 | (when (> arg 0) 354 | (let ((pos (save-excursion 355 | (goto-char (point-max)) 356 | (let ((hl-todo-wrap-movement nil)) 357 | (hl-todo-previous arg)) 358 | (point)))) 359 | (goto-char pos))))) 360 | 361 | ;;;###autoload 362 | (defun hl-todo-occur () 363 | "Use `occur' to find all TODO or similar keywords. 364 | This actually finds a superset of the highlighted keywords, 365 | because it uses a regexp instead of a more sophisticated 366 | matcher. It also finds occurrences that are not within a 367 | string or comment." 368 | (interactive) 369 | (with-syntax-table hl-todo--syntax-table 370 | (occur (hl-todo--regexp)))) 371 | 372 | ;;;###autoload 373 | (defun hl-todo-rgrep (regexp &optional files dir confirm) 374 | "Use `rgrep' to find all TODO or similar keywords. 375 | This actually finds a superset of the highlighted keywords, 376 | because it uses a regexp instead of a more sophisticated 377 | matcher. It also finds occurrences that are not within a 378 | string or comment. See `rgrep' for the meaning of REGEXP, 379 | FILES, DIR and CONFIRM, except that the type of prefix 380 | argument does not matter; with any prefix you can edit the 381 | constructed shell command line before it is executed. 382 | Also see option `hl-todo-keyword-faces'." 383 | (interactive 384 | (progn 385 | (require 'grep) 386 | (grep-compute-defaults) 387 | (unless grep-find-template 388 | (error "grep.el: No `grep-find-template' available")) 389 | (let ((regexp (with-temp-buffer (hl-todo--regexp)))) 390 | (list regexp 391 | (grep-read-files regexp) 392 | (read-directory-name "Base directory: " nil default-directory t) 393 | current-prefix-arg)))) 394 | (rgrep regexp files dir confirm)) 395 | 396 | ;;;###autoload 397 | (defun hl-todo-flymake (report-fn &rest _plist) 398 | "Flymake backend for `hl-todo-mode'. 399 | Diagnostics are reported to REPORT-FN. Use `add-hook' to 400 | register this function in `flymake-diagnostic-functions' before 401 | enabling `flymake-mode'." 402 | (let ((diags nil) 403 | (buf (current-buffer)) 404 | (comment (concat (regexp-quote comment-start) "\\s-+"))) 405 | (when hl-todo-mode 406 | (save-excursion 407 | (save-restriction 408 | (save-match-data 409 | (goto-char (point-min)) 410 | (while (hl-todo--search) 411 | (let ((keyword (match-string 1)) 412 | (beg (match-beginning 0)) 413 | (end (pos-eol)) 414 | (bol (pos-bol))) 415 | ;; Take whole line when keyword is not at the start of comment. 416 | (save-excursion 417 | (goto-char beg) 418 | (unless (looking-back comment bol) 419 | (goto-char bol) 420 | ;; Skip whitespace at the beginning of line. 421 | (when (and (not (looking-at-p "\\S-")) 422 | (re-search-forward "\\S-" beg t)) 423 | (forward-char -1)) 424 | ;; Skip comment. 425 | (re-search-forward comment beg t) 426 | (setq beg (point)))) 427 | (push (hl-todo-make-flymake-diagnostic 428 | buf beg end (buffer-substring-no-properties beg end) 429 | keyword) 430 | diags))))))) 431 | (funcall report-fn (nreverse diags)))) 432 | 433 | ;; Advise this function if you want multiple keyword types. 434 | (defun hl-todo-make-flymake-diagnostic (locus beg end text _keyword) 435 | (flymake-make-diagnostic locus beg end 'hl-todo-flymake text)) 436 | (put 'hl-todo-flymake 'flymake-category 'flymake-note) 437 | (put 'hl-todo-flymake 'flymake-type-name "todo") 438 | ;; Do not underline lines containing TODO keyword. 439 | (put 'hl-todo-flymake 'face nil) 440 | ;; As of Emacs 30.0.50, we have to set this property to control 441 | ;; the face that is used *inside* the list buffer. This face 442 | ;; is *not* used in the mode-line (where the respective face of 443 | ;; the `flymake-note' category is used instead). 444 | (put 'hl-todo-flymake 'mode-line-face 'hl-todo-flymake-type) 445 | 446 | ;;;###autoload 447 | (defun hl-todo-insert (keyword) 448 | "Read a TODO or similar keyword and insert it at point. 449 | 450 | If point is not inside a string or comment, then insert a new 451 | comment. If point is at the end of the line, then insert the 452 | comment there, otherwise insert it as a new line before the 453 | current line. When called interactively the KEYWORD is read 454 | via `completing-read'. 455 | 456 | If `hl-todo-require-punctuation' is non-nil and 457 | `hl-todo-highlight-punctuation' contains a single character, 458 | then append that character to the inserted string." 459 | (interactive 460 | (list (completing-read 461 | "Insert keyword: " 462 | (mapcan (pcase-lambda (`(,keyword . ,face)) 463 | (and (equal (regexp-quote keyword) keyword) 464 | (list (propertize keyword 'face 465 | (hl-todo--combine-face face))))) 466 | hl-todo-keyword-faces)))) 467 | (let ((keyword (if (and hl-todo-require-punctuation 468 | (length= hl-todo-highlight-punctuation 1)) 469 | (concat keyword hl-todo-highlight-punctuation) 470 | keyword))) 471 | (cond 472 | ((hl-todo--inside-comment-or-string-p) 473 | (insert (concat (and (not (memq (char-before) '(?\s ?\t))) " ") 474 | keyword 475 | (and (not (memq (char-after) '(?\s ?\t ?\n))) " ")))) 476 | ((and (eolp) 477 | (not (looking-back "^[\s\t]*" (line-beginning-position) t))) 478 | (insert (concat (and (not (memq (char-before) '(?\s ?\t))) " ") 479 | (format "%s %s " comment-start keyword)))) 480 | (t 481 | (goto-char (line-beginning-position)) 482 | (insert (cond ((derived-mode-p 'lisp-mode 'emacs-lisp-mode) 483 | (format "%s%s %s" comment-start comment-start keyword)) 484 | ((string-suffix-p " " comment-start) 485 | (format "%s%s" comment-start keyword)) 486 | (t 487 | (format "%s %s" comment-start keyword)))) 488 | (unless (looking-at "[\s\t]*$") 489 | (save-excursion (insert "\n"))) 490 | (indent-region (line-beginning-position) (line-end-position)))))) 491 | 492 | ;;;###autoload 493 | (defun hl-todo-search-and-highlight () 494 | "Highlight TODO and similar keywords starting at point. 495 | Intended to be added to `magit-revision-wash-message-hook' and 496 | `magit-log-wash-summary-hook', but might be useful elsewhere too." 497 | (let ((case-fold-search nil) 498 | (regexp (hl-todo--regexp))) 499 | (while (re-search-forward regexp nil t) 500 | (put-text-property (match-beginning 1) 501 | (match-end 1) 502 | 'font-lock-face (hl-todo--get-face))))) 503 | 504 | ;;; _ 505 | (provide 'hl-todo) 506 | ;; Local Variables: 507 | ;; indent-tabs-mode: nil 508 | ;; End: 509 | ;;; hl-todo.el ends here 510 | --------------------------------------------------------------------------------