├── .gitignore ├── LICENSE ├── Makefile ├── README.org ├── makem.sh └── org-auto-expand.el /.gitignore: -------------------------------------------------------------------------------- 1 | /.sandbox/ 2 | *.elc 3 | org-src-*.txt 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 | # * makem.sh/Makefile --- Script to aid building and testing Emacs Lisp packages 2 | 3 | # URL: https://github.com/alphapapa/makem.sh 4 | # Version: 0.5 5 | 6 | # * Arguments 7 | 8 | # For consistency, we use only var=val options, not hyphen-prefixed options. 9 | 10 | # NOTE: I don't like duplicating the arguments here and in makem.sh, 11 | # but I haven't been able to find a way to pass arguments which 12 | # conflict with Make's own arguments through Make to the script. 13 | # Using -- doesn't seem to do it. 14 | 15 | ifdef install-deps 16 | INSTALL_DEPS = "--install-deps" 17 | endif 18 | ifdef install-linters 19 | INSTALL_LINTERS = "--install-linters" 20 | endif 21 | 22 | ifdef sandbox 23 | ifeq ($(sandbox), t) 24 | SANDBOX = --sandbox 25 | else 26 | SANDBOX = --sandbox=$(sandbox) 27 | endif 28 | endif 29 | 30 | ifdef debug 31 | DEBUG = "--debug" 32 | endif 33 | 34 | # ** Verbosity 35 | 36 | # Since the "-v" in "make -v" gets intercepted by Make itself, we have 37 | # to use a variable. 38 | 39 | verbose = $(v) 40 | 41 | ifneq (,$(findstring vvv,$(verbose))) 42 | VERBOSE = "-vvv" 43 | else ifneq (,$(findstring vv,$(verbose))) 44 | VERBOSE = "-vv" 45 | else ifneq (,$(findstring v,$(verbose))) 46 | VERBOSE = "-v" 47 | endif 48 | 49 | # * Rules 50 | 51 | # TODO: Handle cases in which "test" or "tests" are called and a 52 | # directory by that name exists, which can confuse Make. 53 | 54 | %: 55 | @./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(INSTALL_DEPS) $(INSTALL_LINTERS) $(@) 56 | 57 | .DEFAULT: init 58 | init: 59 | @./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(INSTALL_DEPS) $(INSTALL_LINTERS) 60 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: org-auto-expand 2 | 3 | #+PROPERTY: LOGGING nil 4 | 5 | # Note: This readme works with the org-make-toc package, which automatically updates the table of contents. 6 | 7 | # [[https://melpa.org/#/org-auto-expand][file:https://melpa.org/packages/org-auto-expand-badge.svg]] [[https://stable.melpa.org/#/org-auto-expand][file:https://stable.melpa.org/packages/org-auto-expand-badge.svg]] 8 | 9 | [[https://melpa.org/#/org-auto-expand][file:https://melpa.org/packages/org-auto-expand-badge.svg]] [[https://stable.melpa.org/#/org-auto-expand][file:https://stable.melpa.org/packages/org-auto-expand-badge.svg]] 10 | 11 | This package automatically expands certain headings in an Org file depending on properties set, making it easy to always get the same initial view when finding a file. 12 | 13 | * Installation 14 | :PROPERTIES: 15 | :TOC: 0 16 | :END: 17 | 18 | ** MELPA 19 | 20 | If you installed from [[https://melpa.org/#/org-auto-expand][MELPA]], you're already done! 21 | 22 | ** Quelpa 23 | 24 | Installing with [[https://framagit.org/steckerhalter/quelpa][Quelpa]] is easy: 25 | 26 | 1. Install [[https://framagit.org/steckerhalter/quelpa-use-package#installation][quelpa-use-package]] (which can be installed directly from MELPA). 27 | 2. Add this form to your init file: 28 | 29 | #+BEGIN_SRC elisp 30 | (use-package org-auto-expand 31 | :quelpa (org-auto-expand :fetcher github :repo "alphapapa/org-auto-expand")) 32 | #+END_SRC 33 | 34 | ** Manual 35 | 36 | Put =org-auto-expand.el= in your ~load-path~, and put this in your init file: 37 | 38 | #+BEGIN_SRC elisp 39 | (require 'org-auto-expand) 40 | #+END_SRC 41 | 42 | * Usage 43 | :PROPERTIES: 44 | :TOC: 0 45 | :END: 46 | 47 | 1. Define auto-expansion settings in an Org file (see below). 48 | 2. Run ~org-auto-expand~ to set visibility accordingly. You may do this automatically in a file with a file- or dir-local variable. See examples. 49 | 50 | + The global minor mode ~org-auto-expand-mode~ automatically applies expansion settings when visiting Org files. 51 | + To start with all entries folded, set the variable ~org-startup-folded~ as desired, or use the ~#+STARTUP~ keyword (see Org manual). 52 | 53 | ** Auto-expansion Settings 54 | 55 | Auto-expansion settings may be set in two ways: with Org properties on headings, and with the file- or dir-local variable ~org-auto-expand-nodes~. 56 | 57 | *** Properties 58 | 59 | Set the =auto-expand= property on a node to a list of one or more of these values: 60 | 61 | - =heading=: Show just the heading. 62 | - =body=: Show the heading and its body, but not its children. 63 | - =children=: Show the heading's children, but not its body. 64 | - A number =N=: Show child headings =N= levels deep. 65 | - A symbol that =org-show-context= accepts as an argument. 66 | 67 | For example, in this Org file: 68 | 69 | #+BEGIN_SRC org 70 | ,* Daily tasks 71 | :PROPERTIES: 72 | :auto-expand: body 1 73 | :END: 74 | 75 | Things to do every day. 76 | 77 | ,** Check email 78 | ,** Walk dog 79 | 80 | ,* Weekly tasks 81 | 82 | Things to do every week. 83 | 84 | ,** Check tire pressure 85 | ,** Attempt to walk cat 86 | #+END_SRC 87 | 88 | After running ~org-auto-expand~, you would see: 89 | 90 | #+BEGIN_EXAMPLE 91 | ,* Daily tasks 92 | :PROPERTIES:... 93 | 94 | Things to do every day. 95 | 96 | ,** Check email 97 | ,** Walk dog 98 | 99 | ,* Weekly tasks... 100 | #+END_EXAMPLE 101 | 102 | *** Variable =org-auto-expand-nodes= 103 | 104 | The variable =org-auto-expand-nodes= may be set as file-local or dir-local (e.g. using command ~add-file-local-variable~). It should be an alist, the key of which should be an Org outline path (a list of heading strings corresponding to a node's hierarchy), and the value of which should be one of the values accepted by the =auto-expand= property. The corresponding example, which also calls ~org-auto-expand~ automatically: 105 | 106 | #+BEGIN_SRC org 107 | # Local Variables: 108 | # org-auto-expand-nodes: ((("Daily tasks") body 1)) 109 | # eval: (org-auto-expand) 110 | # End: 111 | #+END_SRC 112 | 113 | * Changelog 114 | :PROPERTIES: 115 | :TOC: 0 116 | :END: 117 | 118 | ** 0.2-pre 119 | 120 | Org version 9.6 or later is now required. 121 | 122 | *Fixes* 123 | 124 | + Mode ~org-auto-expand-mode~ adds ~org-auto-expand~ to ~org-mode-hook~. 125 | + Call ~org-back-to-heading~ with ~INVISIBLE-OK~ argument. (Necessary with some newer Org versions.) 126 | 127 | ** 0.1 128 | 129 | Initial release. 130 | 131 | * Development 132 | :PROPERTIES: 133 | :TOC: ignore 134 | :END: 135 | 136 | Bug reports, feature requests, suggestions — /oh my/! 137 | 138 | * License 139 | :PROPERTIES: 140 | :TOC: ignore 141 | :END: 142 | 143 | GPLv3 144 | 145 | # Local Variables: 146 | # eval: (require 'org-make-toc) 147 | # before-save-hook: org-make-toc 148 | # org-export-with-properties: () 149 | # org-export-with-title: t 150 | # End: 151 | 152 | -------------------------------------------------------------------------------- /makem.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # * makem.sh --- Script to aid building and testing Emacs Lisp packages 4 | 5 | # URL: https://github.com/alphapapa/makem.sh 6 | # Version: 0.6-pre 7 | 8 | # * Commentary: 9 | 10 | # makem.sh is a script that helps to build, lint, and test Emacs Lisp 11 | # packages. It aims to make linting and testing as simple as possible 12 | # without requiring per-package configuration. 13 | 14 | # It works similarly to a Makefile in that "rules" are called to 15 | # perform actions such as byte-compiling, linting, testing, etc. 16 | 17 | # Source and test files are discovered automatically from the 18 | # project's Git repo, and package dependencies within them are parsed 19 | # automatically. 20 | 21 | # Output is simple: by default, there is no output unless errors 22 | # occur. With increasing verbosity levels, more detail gives positive 23 | # feedback. Output is colored by default to make reading easy. 24 | 25 | # The script can run Emacs with the developer's local Emacs 26 | # configuration, or with a clean, "sandbox" configuration that can be 27 | # optionally removed afterward. This is especially helpful when 28 | # upstream dependencies may have released new versions that differ 29 | # from those installed in the developer's personal configuration. 30 | 31 | # * License: 32 | 33 | # This program is free software; you can redistribute it and/or modify 34 | # it under the terms of the GNU General Public License as published by 35 | # the Free Software Foundation, either version 3 of the License, or 36 | # (at your option) any later version. 37 | 38 | # This program is distributed in the hope that it will be useful, 39 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 40 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 41 | # GNU General Public License for more details. 42 | 43 | # You should have received a copy of the GNU General Public License 44 | # along with this program. If not, see . 45 | 46 | # * Functions 47 | 48 | function usage { 49 | cat <$file <$file <$file <"$file" <$file <"$file" <$file <&1) 316 | 317 | # Set output file. 318 | output_file=$(mktemp) || die "Unable to make output file." 319 | paths_temp+=("$output_file") 320 | 321 | # Run Emacs. 322 | debug "run_emacs: ${emacs_command[@]} $@ &>\"$output_file\"" 323 | "${emacs_command[@]}" "$@" &>"$output_file" 324 | 325 | # Check exit code and output. 326 | exit=$? 327 | [[ $exit != 0 ]] \ 328 | && debug "Emacs exited non-zero: $exit" 329 | 330 | [[ $verbose -gt 1 || $exit != 0 ]] \ 331 | && cat $output_file 332 | 333 | return $exit 334 | } 335 | 336 | # ** Compilation 337 | 338 | function batch-byte-compile { 339 | debug "batch-byte-compile: ERROR-ON-WARN:$compile_error_on_warn" 340 | 341 | [[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)") 342 | 343 | run_emacs \ 344 | --load "$(elisp-byte-compile-file)" \ 345 | "${error_on_warn[@]}" \ 346 | --eval "(unless (makem-batch-byte-compile) (kill-emacs 1))" \ 347 | "$@" 348 | } 349 | 350 | function byte-compile-file { 351 | debug "byte-compile: ERROR-ON-WARN:$compile_error_on_warn" 352 | local file="$1" 353 | 354 | [[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)") 355 | 356 | # FIXME: Why is the line starting with "&& verbose 3" not indented properly? Emacs insists on indenting it back a level. 357 | run_emacs \ 358 | --load "$(elisp-byte-compile-file)" \ 359 | "${error_on_warn[@]}" \ 360 | --eval "(unless (makem-byte-compile-file \"$file\") (kill-emacs 1))" \ 361 | && verbose 3 "Compiling $file finished without errors." \ 362 | || { verbose 3 "Compiling file failed: $file"; return 1; } 363 | } 364 | 365 | # ** Files 366 | 367 | function dirs-project { 368 | # Echo list of directories to be used in load path. 369 | files-project-feature | dirnames 370 | files-project-test | dirnames 371 | } 372 | 373 | function files-project-elisp { 374 | # Echo list of Elisp files in project. 375 | git ls-files 2>/dev/null \ 376 | | egrep "\.el$" \ 377 | | filter-files-exclude-default \ 378 | | filter-files-exclude-args 379 | } 380 | 381 | function files-project-feature { 382 | # Echo list of Elisp files that are not tests and provide a feature. 383 | files-project-elisp \ 384 | | egrep -v "$test_files_regexp" \ 385 | | filter-files-feature 386 | } 387 | 388 | function files-project-test { 389 | # Echo list of Elisp test files. 390 | files-project-elisp | egrep "$test_files_regexp" 391 | } 392 | 393 | function dirnames { 394 | # Echo directory names for files on STDIN. 395 | while read file 396 | do 397 | dirname "$file" 398 | done 399 | } 400 | 401 | function filter-files-exclude-default { 402 | # Filter out paths (STDIN) which should be excluded by default. 403 | egrep -v "(/\.cask/|-autoloads.el|.dir-locals)" 404 | } 405 | 406 | function filter-files-exclude-args { 407 | # Filter out paths (STDIN) which are excluded with --exclude. 408 | if [[ ${files_exclude[@]} ]] 409 | then 410 | ( 411 | # We use a subshell to set IFS temporarily so we can send 412 | # the list of files to grep -F. This is ugly but more 413 | # correct than replacing spaces with line breaks. Note 414 | # that, for some reason, using IFS="\n" or IFS='\n' doesn't 415 | # work, and a literal line break seems to be required. 416 | IFS=" 417 | " 418 | grep -Fv "${files_exclude[*]}" 419 | ) 420 | else 421 | cat 422 | fi 423 | } 424 | 425 | function filter-files-feature { 426 | # Read paths on STDIN and echo ones that (provide 'a-feature). 427 | while read path 428 | do 429 | egrep "^\\(provide '" "$path" &>/dev/null \ 430 | && echo "$path" 431 | done 432 | } 433 | 434 | function args-load-files { 435 | # For file in $@, echo "--load $file". 436 | for file in "$@" 437 | do 438 | sans_extension=${file%%.el} 439 | printf -- '--load %q ' "$sans_extension" 440 | done 441 | } 442 | 443 | function args-load-path { 444 | # Echo load-path arguments. 445 | for path in $(dirs-project | sort -u) 446 | do 447 | printf -- '-L %q ' "$path" 448 | done 449 | } 450 | 451 | function test-files-p { 452 | # Return 0 if $files_project_test is non-empty. 453 | [[ "${files_project_test[@]}" ]] 454 | } 455 | 456 | function buttercup-tests-p { 457 | # Return 0 if Buttercup tests are found. 458 | test-files-p || die "No tests found." 459 | debug "Checking for Buttercup tests..." 460 | 461 | grep "(require 'buttercup)" "${files_project_test[@]}" &>/dev/null 462 | } 463 | 464 | function ert-tests-p { 465 | # Return 0 if ERT tests are found. 466 | test-files-p || die "No tests found." 467 | debug "Checking for ERT tests..." 468 | 469 | # We check for this rather than "(require 'ert)", because ERT may 470 | # already be loaded in Emacs and might not be loaded with 471 | # "require" in a test file. 472 | grep "(ert-deftest" "${files_project_test[@]}" &>/dev/null 473 | } 474 | 475 | function package-main-file { 476 | # Echo the package's main file. 477 | file_pkg=$(git ls-files ./*-pkg.el 2>/dev/null) 478 | 479 | if [[ $file_pkg ]] 480 | then 481 | # Use *-pkg.el file if it exists. 482 | echo "$file_pkg" 483 | else 484 | # Use shortest filename (a sloppy heuristic that will do for now). 485 | for file in "${files_project_feature[@]}" 486 | do 487 | echo ${#file} "$file" 488 | done \ 489 | | sort -h \ 490 | | head -n1 \ 491 | | sed -r 's/^[[:digit:]]+ //' 492 | fi 493 | } 494 | 495 | function dependencies { 496 | # Echo list of package dependencies. 497 | 498 | # Search package headers. Use -a so grep won't think that an Elisp file containing 499 | # control characters (rare, but sometimes necessary) is binary and refuse to search it. 500 | egrep -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \ 501 | | egrep -o '\([^([:space:]][^)]*\)' \ 502 | | egrep -o '^[^[:space:])]+' \ 503 | | sed -r 's/\(//g' \ 504 | | egrep -v '^emacs$' # Ignore Emacs version requirement. 505 | 506 | # Search Cask file. 507 | if [[ -r Cask ]] 508 | then 509 | egrep '\(depends-on "[^"]+"' Cask \ 510 | | sed -r -e 's/\(depends-on "([^"]+)".*/\1/g' 511 | fi 512 | 513 | # Search -pkg.el file. 514 | if [[ $(git ls-files ./*-pkg.el 2>/dev/null) ]] 515 | then 516 | sed -nr 's/.*\(([-[:alnum:]]+)[[:blank:]]+"[.[:digit:]]+"\).*/\1/p' $(git ls-files ./*-pkg.el 2>/dev/null) 517 | fi 518 | } 519 | 520 | # ** Sandbox 521 | 522 | function sandbox { 523 | verbose 2 "Initializing sandbox..." 524 | 525 | # *** Sandbox arguments 526 | 527 | # MAYBE: Optionally use branch-specific sandbox? 528 | 529 | # Check or make user-emacs-directory. 530 | if [[ $sandbox_dir ]] 531 | then 532 | # Directory given as argument: ensure it exists. 533 | if ! [[ -d $sandbox_dir ]] 534 | then 535 | debug "Making sandbox directory: $sandbox_dir" 536 | mkdir -p "$sandbox_dir" || die "Unable to make sandbox dir." 537 | fi 538 | 539 | # Add Emacs version-specific subdirectory, creating if necessary. 540 | sandbox_dir="$sandbox_dir/$(emacs-version)" 541 | if ! [[ -d $sandbox_dir ]] 542 | then 543 | mkdir "$sandbox_dir" || die "Unable to make sandbox subdir: $sandbox_dir" 544 | fi 545 | else 546 | # Not given: make temp directory, and delete it on exit. 547 | local sandbox_dir=$(mktemp -d) || die "Unable to make sandbox dir." 548 | paths_temp+=("$sandbox_dir") 549 | fi 550 | 551 | # Make argument to load init file if it exists. 552 | init_file="$sandbox_dir/init.el" 553 | 554 | # Set sandbox args. This is a global variable used by the run_emacs function. 555 | args_sandbox=( 556 | --title "makem.sh: $(basename $(pwd)) (sandbox: $sandbox_dir)" 557 | --eval "(setq user-emacs-directory (file-truename \"$sandbox_dir\"))" 558 | --eval "(setq user-init-file (file-truename \"$init_file\"))" 559 | ) 560 | 561 | # Add package-install arguments for dependencies. 562 | if [[ $install_deps ]] 563 | then 564 | local deps=($(dependencies)) 565 | debug "Installing dependencies: ${deps[@]}" 566 | 567 | for package in "${deps[@]}" 568 | do 569 | args_sandbox_package_install+=(--eval "(package-install '$package)") 570 | done 571 | fi 572 | 573 | # Add package-install arguments for linters. 574 | if [[ $install_linters ]] 575 | then 576 | debug "Installing linters: package-lint relint" 577 | 578 | args_sandbox_package_install+=( 579 | --eval "(package-install 'elsa)" 580 | --eval "(package-install 'package-lint)" 581 | --eval "(package-install 'relint)") 582 | fi 583 | 584 | # *** Install packages into sandbox 585 | 586 | if [[ ${args_sandbox_package_install[@]} ]] 587 | then 588 | # Initialize the sandbox (installs packages once rather than for every rule). 589 | verbose 1 "Installing packages into sandbox..." 590 | 591 | run_emacs \ 592 | --eval "(package-refresh-contents)" \ 593 | "${args_sandbox_package_install[@]}" \ 594 | && success "Packages installed." \ 595 | || die "Unable to initialize sandbox." 596 | fi 597 | 598 | verbose 2 "Sandbox initialized." 599 | } 600 | 601 | # ** Utility 602 | 603 | function cleanup { 604 | # Remove temporary paths (${paths_temp[@]}). 605 | 606 | for path in "${paths_temp[@]}" 607 | do 608 | if [[ $debug ]] 609 | then 610 | debug "Debugging enabled: not deleting temporary path: $path" 611 | elif [[ -r $path ]] 612 | then 613 | rm -rf "$path" 614 | else 615 | debug "Temporary path doesn't exist, not deleting: $path" 616 | fi 617 | done 618 | } 619 | 620 | function echo-unset-p { 621 | # Echo 0 if $1 is set, otherwise 1. IOW, this returns the exit 622 | # code of [[ $1 ]] as STDOUT. 623 | [[ $1 ]] 624 | echo $? 625 | } 626 | 627 | function ensure-package-available { 628 | # If package $1 is available, return 0. Otherwise, return 1, and 629 | # if $2 is set, give error otherwise verbose. Outputting messages 630 | # here avoids repetition in callers. 631 | local package=$1 632 | local direct_p=$2 633 | 634 | if ! run_emacs --load $package &>/dev/null 635 | then 636 | if [[ $direct_p ]] 637 | then 638 | error "$package not available." 639 | else 640 | verbose 2 "$package not available." 641 | fi 642 | return 1 643 | fi 644 | } 645 | 646 | function ensure-tests-available { 647 | # If tests of type $1 (like "ERT") are available, return 0. Otherwise, if 648 | # $2 is set, give an error and return 1; otherwise give verbose message. $1 649 | # should have a corresponding predicate command, like ert-tests-p for ERT. 650 | local test_name=$1 651 | local test_command="${test_name,,}-tests-p" # Converts name to lowercase. 652 | local direct_p=$2 653 | 654 | if ! $test_command 655 | then 656 | if [[ $direct_p ]] 657 | then 658 | error "$test_name tests not found." 659 | else 660 | verbose 2 "$test_name tests not found." 661 | fi 662 | return 1 663 | fi 664 | } 665 | 666 | function echo_color { 667 | # This allows bold, italic, etc. without needing a function for 668 | # each variation. 669 | local color_code="COLOR_$1" 670 | shift 671 | 672 | if [[ $color ]] 673 | then 674 | echo -e "${!color_code}${@}${COLOR_off}" 675 | else 676 | echo "$@" 677 | fi 678 | } 679 | function debug { 680 | if [[ $debug ]] 681 | then 682 | function debug { 683 | echo_color yellow "DEBUG ($(ts)): $@" >&2 684 | } 685 | debug "$@" 686 | else 687 | function debug { 688 | true 689 | } 690 | fi 691 | } 692 | function error { 693 | echo_color red "ERROR ($(ts)): $@" >&2 694 | ((errors++)) 695 | return 1 696 | } 697 | function die { 698 | [[ $@ ]] && error "$@" 699 | exit $errors 700 | } 701 | function log { 702 | echo "LOG ($(ts)): $@" >&2 703 | } 704 | function log_color { 705 | local color_name=$1 706 | shift 707 | echo_color $color_name "LOG ($(ts)): $@" >&2 708 | } 709 | function success { 710 | if [[ $verbose -ge 2 ]] 711 | then 712 | log_color green "$@" >&2 713 | fi 714 | } 715 | function verbose { 716 | # $1 is the verbosity level, rest are echoed when appropriate. 717 | if [[ $verbose -ge $1 ]] 718 | then 719 | [[ $1 -eq 1 ]] && local color_name=blue 720 | [[ $1 -eq 2 ]] && local color_name=cyan 721 | [[ $1 -ge 3 ]] && local color_name=white 722 | 723 | shift 724 | log_color $color_name "$@" >&2 725 | fi 726 | } 727 | 728 | function ts { 729 | date "+%Y-%m-%d %H:%M:%S" 730 | } 731 | 732 | function emacs-version { 733 | # Echo Emacs version number. 734 | 735 | # Don't use run_emacs function, which does more than we need. 736 | "${emacs_command[@]}" -Q --batch --eval "(princ emacs-version)" \ 737 | || die "Unable to get Emacs version." 738 | } 739 | 740 | function rule-p { 741 | # Return 0 if $1 is a rule. 742 | [[ $1 =~ ^(lint-?|tests?)$ ]] \ 743 | || [[ $1 =~ ^(batch|interactive)$ ]] \ 744 | || [[ $(type -t "$2" 2>/dev/null) =~ function ]] 745 | } 746 | 747 | # * Rules 748 | 749 | # These functions are intended to be called as rules, like a Makefile. 750 | # Some rules test $1 to determine whether the rule is being called 751 | # directly or from a meta-rule; if directly, an error is given if the 752 | # rule can't be run, otherwise it's skipped. 753 | 754 | function all { 755 | verbose 1 "Running all rules..." 756 | 757 | lint 758 | tests 759 | } 760 | 761 | function compile-batch { 762 | [[ $compile ]] || return 0 763 | unset compile # Only compile once. 764 | 765 | verbose 1 "Compiling..." 766 | verbose 2 "Batch-compiling files..." 767 | debug "Byte-compile files: ${files_project_byte_compile[@]}" 768 | 769 | batch-byte-compile "${files_project_byte_compile[@]}" 770 | } 771 | 772 | function compile-each { 773 | [[ $compile ]] || return 0 774 | unset compile # Only compile once. 775 | 776 | verbose 1 "Compiling..." 777 | debug "Byte-compile files: ${files_project_byte_compile[@]}" 778 | 779 | local compile_errors 780 | for file in "${files_project_byte_compile[@]}" 781 | do 782 | verbose 2 "Compiling file: $file..." 783 | byte-compile-file "$file" \ 784 | || compile_errors=t 785 | done 786 | 787 | [[ ! $compile_errors ]] 788 | } 789 | 790 | function compile { 791 | if [[ $compile = batch ]] 792 | then 793 | compile-batch "$@" 794 | else 795 | compile-each "$@" 796 | fi 797 | local status=$? 798 | 799 | if [[ $compile_error_on_warn ]] 800 | then 801 | # Linting: just return status code, because lint rule will print messages. 802 | [[ $status = 0 ]] 803 | else 804 | # Not linting: print messages here. 805 | [[ $status = 0 ]] \ 806 | && success "Compiling finished without errors." \ 807 | || error "Compiling failed." 808 | fi 809 | } 810 | 811 | function batch { 812 | # Run Emacs in batch mode with ${args_batch_interactive[@]} and 813 | # with project source and test files loaded. 814 | verbose 1 "Executing Emacs with arguments: ${args_batch_interactive[@]}" 815 | 816 | run_emacs \ 817 | $(args-load-files "${files_project_feature[@]}" "${files_project_test[@]}") \ 818 | "${args_batch_interactive[@]}" 819 | } 820 | 821 | function interactive { 822 | # Run Emacs interactively. Most useful with --sandbox and --install-deps. 823 | local load_file_args=$(args-load-files "${files_project_feature[@]}" "${files_project_test[@]}") 824 | verbose 1 "Running Emacs interactively..." 825 | verbose 2 "Loading files: ${load_file_args//--load /}" 826 | 827 | [[ $compile ]] && compile 828 | 829 | unset arg_batch 830 | run_emacs \ 831 | $load_file_args \ 832 | --eval "(load user-init-file)" \ 833 | "${args_batch_interactive[@]}" 834 | arg_batch="--batch" 835 | } 836 | 837 | function lint { 838 | verbose 1 "Linting..." 839 | 840 | lint-checkdoc 841 | lint-compile 842 | lint-declare 843 | # NOTE: Elint doesn't seem very useful at the moment. See comment 844 | # in lint-elint function. 845 | # lint-elint 846 | lint-indent 847 | lint-package 848 | lint-regexps 849 | } 850 | 851 | function lint-checkdoc { 852 | verbose 1 "Linting checkdoc..." 853 | 854 | local checkdoc_file="$(elisp-checkdoc-file)" 855 | paths_temp+=("$checkdoc_file") 856 | 857 | run_emacs \ 858 | --load="$checkdoc_file" \ 859 | "${files_project_feature[@]}" \ 860 | && success "Linting checkdoc finished without errors." \ 861 | || error "Linting checkdoc failed." 862 | } 863 | 864 | function lint-compile { 865 | verbose 1 "Linting compilation..." 866 | 867 | compile_error_on_warn=true 868 | compile "${files_project_byte_compile[@]}" \ 869 | && success "Linting compilation finished without errors." \ 870 | || error "Linting compilation failed." 871 | unset compile_error_on_warn 872 | } 873 | 874 | function lint-declare { 875 | verbose 1 "Linting declarations..." 876 | 877 | local check_declare_file="$(elisp-check-declare-file)" 878 | paths_temp+=("$check_declare_file") 879 | 880 | run_emacs \ 881 | --load "$check_declare_file" \ 882 | -f makem-check-declare-files-and-exit \ 883 | "${files_project_feature[@]}" \ 884 | && success "Linting declarations finished without errors." \ 885 | || error "Linting declarations failed." 886 | } 887 | 888 | function lint-elsa { 889 | verbose 1 "Linting with Elsa..." 890 | 891 | # MAYBE: Install Elsa here rather than in sandbox init, to avoid installing 892 | # it when not needed. However, we should be careful to be clear about when 893 | # packages are installed, because installing them does execute code. 894 | run_emacs \ 895 | --load elsa \ 896 | -f elsa-run-files-and-exit \ 897 | "${files_project_feature[@]}" \ 898 | && success "Linting with Elsa finished without errors." \ 899 | || error "Linting with Elsa failed." 900 | } 901 | 902 | function lint-elint { 903 | # NOTE: Elint gives a lot of spurious warnings, apparently because it doesn't load files 904 | # that are `require'd, so its output isn't very useful. But in case it's improved in 905 | # the future, and since this wrapper code already works, we might as well leave it in. 906 | verbose 1 "Linting with Elint..." 907 | 908 | local errors=0 909 | for file in "${files_project_feature[@]}" 910 | do 911 | verbose 2 "Linting with Elint: $file..." 912 | run_emacs \ 913 | --load "$(elisp-elint-file)" \ 914 | --eval "(makem-elint-file \"$file\")" \ 915 | && verbose 3 "Linting with Elint found no errors." \ 916 | || { error "Linting with Elint failed: $file"; ((errors++)) ; } 917 | done 918 | 919 | [[ $errors = 0 ]] \ 920 | && success "Linting with Elint finished without errors." \ 921 | || error "Linting with Elint failed." 922 | } 923 | 924 | function lint-indent { 925 | verbose 1 "Linting indentation..." 926 | 927 | # We load project source files as well, because they may contain 928 | # macros with (declare (indent)) rules which must be loaded to set 929 | # indentation. 930 | 931 | run_emacs \ 932 | --load "$(elisp-lint-indent-file)" \ 933 | $(args-load-files "${files_project_feature[@]}" "${files_project_test[@]}") \ 934 | --funcall makem-lint-indent-batch-and-exit \ 935 | "${files_project_feature[@]}" "${files_project_test[@]}" \ 936 | && success "Linting indentation finished without errors." \ 937 | || error "Linting indentation failed." 938 | } 939 | 940 | function lint-package { 941 | ensure-package-available package-lint $1 || return $(echo-unset-p $1) 942 | 943 | verbose 1 "Linting package..." 944 | 945 | run_emacs \ 946 | --load package-lint \ 947 | --eval "(setq package-lint-main-file \"$(package-main-file)\")" \ 948 | --funcall package-lint-batch-and-exit \ 949 | "${files_project_feature[@]}" \ 950 | && success "Linting package finished without errors." \ 951 | || error "Linting package failed." 952 | } 953 | 954 | function lint-regexps { 955 | ensure-package-available relint $1 || return $(echo-unset-p $1) 956 | 957 | verbose 1 "Linting regexps..." 958 | 959 | run_emacs \ 960 | --load relint \ 961 | --funcall relint-batch \ 962 | "${files_project_source[@]}" \ 963 | && success "Linting regexps finished without errors." \ 964 | || error "Linting regexps failed." 965 | } 966 | 967 | function tests { 968 | verbose 1 "Running all tests..." 969 | 970 | test-ert 971 | test-buttercup 972 | } 973 | 974 | function test-ert-interactive { 975 | verbose 1 "Running ERT tests interactively..." 976 | 977 | unset arg_batch 978 | run_emacs \ 979 | $(args-load-files "${files_project_test[@]}") \ 980 | --eval "(ert-run-tests-interactively t)" 981 | arg_batch="--batch" 982 | } 983 | 984 | function test-buttercup { 985 | ensure-tests-available Buttercup $1 || return $(echo-unset-p $1) 986 | compile || die 987 | 988 | verbose 1 "Running Buttercup tests..." 989 | 990 | local buttercup_file="$(elisp-buttercup-file)" 991 | paths_temp+=("$buttercup_file") 992 | 993 | run_emacs \ 994 | $(args-load-files "${files_project_test[@]}") \ 995 | -f buttercup-run \ 996 | && success "Buttercup tests finished without errors." \ 997 | || error "Buttercup tests failed." 998 | } 999 | 1000 | function test-ert { 1001 | ensure-tests-available ERT $1 || return $(echo-unset-p $1) 1002 | compile || die 1003 | 1004 | verbose 1 "Running ERT tests..." 1005 | debug "Test files: ${files_project_test[@]}" 1006 | 1007 | run_emacs \ 1008 | $(args-load-files "${files_project_test[@]}") \ 1009 | -f ert-run-tests-batch-and-exit \ 1010 | && success "ERT tests finished without errors." \ 1011 | || error "ERT tests failed." 1012 | } 1013 | 1014 | # * Defaults 1015 | 1016 | test_files_regexp='^((tests?|t)/)|-tests?.el$|^test-' 1017 | 1018 | emacs_command=("emacs") 1019 | errors=0 1020 | verbose=0 1021 | compile=true 1022 | arg_batch="--batch" 1023 | compile=each 1024 | 1025 | # MAYBE: Disable color if not outputting to a terminal. (OTOH, the 1026 | # colorized output is helpful in CI logs, and I don't know if, 1027 | # e.g. GitHub Actions logging pretends to be a terminal.) 1028 | color=true 1029 | 1030 | # TODO: Using the current directory (i.e. a package's repo root directory) in 1031 | # load-path can cause weird errors in case of--you guessed it--stale .ELC files, 1032 | # the zombie problem that just won't die. It's incredible how many different ways 1033 | # this problem presents itself. In this latest example, an old .ELC file, for a 1034 | # .EL file that had since been renamed, was present on my local system, which meant 1035 | # that an example .EL file that hadn't been updated was able to "require" that .ELC 1036 | # file's feature without error. But on another system (in this case, trying to 1037 | # setup CI using GitHub Actions), the old .ELC was not present, so the example .EL 1038 | # file was not able to load the feature, which caused a byte-compilation error. 1039 | 1040 | # In this case, I will prevent such example files from being compiled. But in 1041 | # general, this can cause weird problems that are tedious to debug. I guess 1042 | # the best way to fix it would be to actually install the repo's code as a 1043 | # package into the sandbox, but doing that would require additional tooling, 1044 | # pulling in something like Quelpa or package-build--and if the default recipe 1045 | # weren't being used, the actual recipe would have to be fetched off MELPA or 1046 | # something, which seems like getting too smart for our own good. 1047 | 1048 | # TODO: Emit a warning if .ELC files that don't match any .EL files are detected. 1049 | 1050 | # ** Colors 1051 | 1052 | COLOR_off='\e[0m' 1053 | COLOR_black='\e[0;30m' 1054 | COLOR_red='\e[0;31m' 1055 | COLOR_green='\e[0;32m' 1056 | COLOR_yellow='\e[0;33m' 1057 | COLOR_blue='\e[0;34m' 1058 | COLOR_purple='\e[0;35m' 1059 | COLOR_cyan='\e[0;36m' 1060 | COLOR_white='\e[0;37m' 1061 | 1062 | # ** Package system args 1063 | 1064 | args_package_archives=( 1065 | --eval "(add-to-list 'package-archives '(\"gnu\" . \"https://elpa.gnu.org/packages/\") t)" 1066 | --eval "(add-to-list 'package-archives '(\"melpa\" . \"https://melpa.org/packages/\") t)" 1067 | ) 1068 | 1069 | args_org_package_archives=( 1070 | --eval "(add-to-list 'package-archives '(\"org\" . \"https://orgmode.org/elpa/\") t)" 1071 | ) 1072 | 1073 | args_package_init=( 1074 | --eval "(package-initialize)" 1075 | ) 1076 | 1077 | elisp_org_package_archive="(add-to-list 'package-archives '(\"org\" . \"https://orgmode.org/elpa/\") t)" 1078 | 1079 | # * Args 1080 | 1081 | args=$(getopt -n "$0" \ 1082 | -o dhce:E:i:s::vf:CO \ 1083 | -l compile-batch,exclude:,emacs:,install-deps,install-linters,debug,debug-load-path,help,install:,verbose,file:,no-color,no-compile,no-org-repo,sandbox:: \ 1084 | -- "$@") \ 1085 | || { usage; exit 1; } 1086 | eval set -- "$args" 1087 | 1088 | while true 1089 | do 1090 | case "$1" in 1091 | --install-deps) 1092 | install_deps=true 1093 | ;; 1094 | --install-linters) 1095 | install_linters=true 1096 | ;; 1097 | -d|--debug) 1098 | debug=true 1099 | verbose=2 1100 | args_debug=(--eval "(setq init-file-debug t)" 1101 | --eval "(setq debug-on-error t)") 1102 | ;; 1103 | --debug-load-path) 1104 | debug_load_path=true 1105 | ;; 1106 | -h|--help) 1107 | usage 1108 | exit 1109 | ;; 1110 | -c|--compile-batch) 1111 | debug "Compiling files in batch mode" 1112 | compile=batch 1113 | ;; 1114 | -E|--emacs) 1115 | shift 1116 | emacs_command=($1) 1117 | ;; 1118 | -i|--install) 1119 | shift 1120 | args_sandbox_package_install+=(--eval "(package-install '$1)") 1121 | ;; 1122 | -s|--sandbox) 1123 | sandbox=true 1124 | shift 1125 | sandbox_dir="$1" 1126 | 1127 | if ! [[ $sandbox_dir ]] 1128 | then 1129 | debug "No sandbox dir: installing dependencies." 1130 | install_deps=true 1131 | else 1132 | debug "Sandbox dir: $1" 1133 | fi 1134 | ;; 1135 | -v|--verbose) 1136 | ((verbose++)) 1137 | ;; 1138 | -e|--exclude) 1139 | shift 1140 | debug "Excluding file: $1" 1141 | files_exclude+=("$1") 1142 | ;; 1143 | -f|--file) 1144 | shift 1145 | args_files+=("$1") 1146 | ;; 1147 | -O|--no-org-repo) 1148 | unset elisp_org_package_archive 1149 | ;; 1150 | --no-color) 1151 | unset color 1152 | ;; 1153 | -C|--no-compile) 1154 | unset compile 1155 | ;; 1156 | --) 1157 | # Remaining args (required; do not remove) 1158 | shift 1159 | rest=("$@") 1160 | break 1161 | ;; 1162 | esac 1163 | 1164 | shift 1165 | done 1166 | 1167 | debug "ARGS: $args" 1168 | debug "Remaining args: ${rest[@]}" 1169 | 1170 | # Set package elisp (which depends on --no-org-repo arg). 1171 | package_initialize_file="$(elisp-package-initialize-file)" 1172 | paths_temp+=("$package_initialize_file") 1173 | 1174 | # * Main 1175 | 1176 | trap cleanup EXIT INT TERM 1177 | 1178 | # Discover project files. 1179 | files_project_feature=($(files-project-feature)) 1180 | files_project_test=($(files-project-test)) 1181 | files_project_byte_compile=("${files_project_feature[@]}" "${files_project_test[@]}") 1182 | 1183 | if [[ ${args_files[@]} ]] 1184 | then 1185 | # Add specified files. 1186 | files_project_feature+=("${args_files[@]}") 1187 | files_project_byte_compile+=("${args_files[@]}") 1188 | fi 1189 | 1190 | debug "EXCLUDING FILES: ${files_exclude[@]}" 1191 | debug "FEATURE FILES: ${files_project_feature[@]}" 1192 | debug "TEST FILES: ${files_project_test[@]}" 1193 | debug "BYTE-COMPILE FILES: ${files_project_byte_compile[@]}" 1194 | debug "PACKAGE-MAIN-FILE: $(package-main-file)" 1195 | 1196 | if ! [[ ${files_project_feature[@]} ]] 1197 | then 1198 | error "No files specified and not in a git repo." 1199 | exit 1 1200 | fi 1201 | 1202 | # Set load path. 1203 | args_load_paths=($(args-load-path)) 1204 | debug "LOAD PATH ARGS: ${args_load_paths[@]}" 1205 | 1206 | # If rules include linters and sandbox-dir is unspecified, install 1207 | # linters automatically. 1208 | if [[ $sandbox && ! $sandbox_dir ]] && [[ "${rest[@]}" =~ lint ]] 1209 | then 1210 | debug "Installing linters automatically." 1211 | install_linters=true 1212 | fi 1213 | 1214 | # Initialize sandbox. 1215 | [[ $sandbox ]] && sandbox 1216 | 1217 | # Run rules. 1218 | for rule in "${rest[@]}" 1219 | do 1220 | if [[ $batch || $interactive ]] 1221 | then 1222 | debug "Adding batch/interactive argument: $rule" 1223 | args_batch_interactive+=("$rule") 1224 | 1225 | elif [[ $rule = batch ]] 1226 | then 1227 | # Remaining arguments are passed to Emacs. 1228 | batch=true 1229 | elif [[ $rule = interactive ]] 1230 | then 1231 | # Remaining arguments are passed to Emacs. 1232 | interactive=true 1233 | 1234 | elif type -t "$rule" 2>/dev/null | grep function &>/dev/null 1235 | then 1236 | # Pass called-directly as $1 to indicate that the rule is 1237 | # being called directly rather than from a meta-rule. 1238 | $rule called-directly 1239 | elif [[ $rule = test ]] 1240 | then 1241 | # Allow the "tests" rule to be called as "test". Since "test" 1242 | # is a shell builtin, this workaround is required. 1243 | tests 1244 | else 1245 | error "Invalid rule: $rule" 1246 | fi 1247 | done 1248 | 1249 | # Batch/interactive rules. 1250 | [[ $batch ]] && batch 1251 | [[ $interactive ]] && interactive 1252 | 1253 | if [[ $errors -gt 0 ]] 1254 | then 1255 | log_color red "Finished with $errors errors." 1256 | else 1257 | success "Finished without errors." 1258 | fi 1259 | 1260 | exit $errors 1261 | -------------------------------------------------------------------------------- /org-auto-expand.el: -------------------------------------------------------------------------------- 1 | ;;; org-auto-expand.el --- Automatically expand certain headings -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019-2023 Adam Porter 4 | 5 | ;; Author: Adam Porter 6 | ;; URL: https://github.com/alphapapa/org-auto-expand 7 | ;; Version: 0.2-pre 8 | ;; Package-Requires: ((emacs "26.1") (org "9.6")) 9 | ;; Keywords: convenience, outlines, org 10 | 11 | ;;; License: 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 | ;; This package automatically expands certain headings in an Org file 29 | ;; depending on properties set, making it easy to always get the same 30 | ;; initial view when finding a file. 31 | 32 | ;;; Code: 33 | 34 | ;;;; Requirements 35 | 36 | (require 'cl-lib) 37 | (require 'org) 38 | (require 'subr-x) 39 | 40 | ;;;; Customization 41 | 42 | (defgroup org-auto-expand nil 43 | "Automatically expand certain nodes upon finding an Org file." 44 | :group 'org 45 | :link '(url-link "https://github.com/alphapapa/org-auto-expand")) 46 | 47 | (defcustom org-auto-expand-property "auto-expand" 48 | "Name of property holding auto-expand setting." 49 | :type 'string) 50 | 51 | (defvar-local org-auto-expand-nodes nil 52 | "List defining how to expand outline nodes. 53 | Should be set in a file- or dir-local variable. 54 | 55 | Each element should be an alist, the key of which should be an 56 | outline-path string, and the value of which corresponds to the 57 | WHAT argument to the function `org-auto-expand-node'.") 58 | 59 | ;;;; Mode 60 | 61 | ;; We use a variable watcher to work around the fact that file-local variables 62 | ;; are not yet bound until after all of the local variables have been processed, 63 | ;; because that prevents them from being available in functions called by `eval' 64 | ;; lines, like `org-auto-expand'. This seems both messy and elegant. 65 | 66 | ;; TODO: Figure out if there's an alternative to a variable watcher (or just remove this and use the properties). 67 | 68 | ;;;###autoload 69 | (define-minor-mode org-auto-expand-mode 70 | "Automatically expand certain headings when `org-mode' is activated." 71 | :global t 72 | (if org-auto-expand-mode 73 | (progn 74 | (add-hook 'org-mode-hook #'org-auto-expand) 75 | (add-variable-watcher 'org-auto-expand-nodes #'org-auto-expand-watcher)) 76 | (remove-hook 'org-mode-hook #'org-auto-expand) 77 | (remove-variable-watcher 'org-auto-expand-nodes #'org-auto-expand-watcher))) 78 | 79 | (defun org-auto-expand-watcher (_symbol newval operation where) 80 | "Call `org-auto-expand'. 81 | When OPERATION is `set', call `org-auto-expand' in buffer WHERE 82 | with `org-auto-expand-nodes' bound to NEWVAL." 83 | (when (and newval where (eq operation 'set)) 84 | (with-current-buffer where 85 | (let ((org-auto-expand-nodes newval)) 86 | (org-auto-expand))))) 87 | 88 | ;;;; Commands 89 | 90 | ;;;###autoload 91 | (defun org-auto-expand () 92 | "Set current buffer's outline visibility accordingly. 93 | If `org-startup-folded' is non-nil, call 94 | `org-set-startup-visibility' first." 95 | (interactive) 96 | (unless (derived-mode-p 'org-mode) 97 | (user-error "Not an Org buffer: %s" (current-buffer))) 98 | (let ((re (org-re-property org-auto-expand-property))) 99 | ;; Do nothing unless we're going to do something. 100 | (when (or org-auto-expand-nodes 101 | (org-with-wide-buffer 102 | (goto-char (point-min)) 103 | (re-search-forward re nil t))) 104 | (when org-startup-folded 105 | (org-cycle-set-startup-visibility)) 106 | (when org-auto-expand-nodes 107 | (cl-loop for (olp . how) in org-auto-expand-nodes 108 | do (when-let ((pos (org-find-olp olp 'this-buffer))) 109 | (org-with-point-at pos 110 | (org-auto-expand-node how))))) 111 | (org-with-wide-buffer 112 | (goto-char (point-min)) 113 | (while (re-search-forward re nil t) 114 | (save-excursion 115 | (org-back-to-heading 'invisible-ok) 116 | (org-auto-expand-node))))))) 117 | 118 | ;;;; Functions 119 | 120 | (cl-defun org-auto-expand-node (&optional (what (org-entry-get (point) org-auto-expand-property))) 121 | "Set current node's what according to WHAT. 122 | If WHAT is nil, use value of `org-auto-expand-property' at node. 123 | 124 | WHAT may be a string, or it may be a list of the following, 125 | meaning to: 126 | 127 | - `heading': Show just the heading. 128 | - `body': Show the heading and its body, but not its children. 129 | - `children': Show the heading's children, but not its body. 130 | - A number N: Show child headings N levels deep. 131 | - A symbol that `org-show-context' accepts as an argument. 132 | 133 | If WHAT is a string, it is split on spaces and should be a list 134 | of the choices above." 135 | (setf what (cl-typecase what 136 | (string (cl-loop for it in (split-string what nil 'omit-nulls (rx (1+ space))) 137 | collect (if (> (string-to-number it) 0) 138 | (string-to-number it) 139 | (intern it)))) 140 | (list what) 141 | (number (list what)) 142 | (symbol (list what)))) 143 | (dolist (thing what) 144 | (pcase thing 145 | ('heading (org-fold-show-context 'minimal)) 146 | ((or 'body) 147 | (org-fold-show-context 'minimal) 148 | (org-cycle)) 149 | ('children (org-fold-show-children 1)) 150 | ((pred numberp) (org-fold-show-children thing)) 151 | (else (org-fold-show-context else))))) 152 | 153 | ;;;; Footer 154 | 155 | (provide 'org-auto-expand) 156 | 157 | ;;; org-auto-expand.el ends here 158 | --------------------------------------------------------------------------------