├── .gitignore ├── LICENSE ├── README.md ├── org-recur-test.el ├── org-recur.el └── screenshot.png /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *.elc 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # org-recur 2 | 3 | [![Melpa](https://melpa.org/packages/org-recur-badge.svg)](https://melpa.org/#/org-recur) 4 | [![Issues](https://img.shields.io/github/issues-raw/mrcnski/org-recur.svg)](https://github.com/mrcnski/org-recur/issues) 5 | [![LoC](https://tokei.rs/b1/github/mrcnski/org-recur)](https://github.com/mrcnski/org-recur) 6 | [![License: GPL3](https://img.shields.io/badge/License-GPL3-yellow.svg)](https://opensource.org/licenses/GPL-3.0) 7 | 8 | Simple recurring org-mode tasks! 9 | 10 | ## Screenshot 11 | 12 | ![Screenshot](screenshot.png) 13 | 14 | ## About 15 | 16 | This package extends org-mode and org-agenda with support for defining recurring 17 | tasks and easily scheduling them. 18 | 19 | This package aims to be simple -- with the recommended configuration, you can 20 | just press `d` in the org-agenda to quickly reschedule a recurring chore. 21 | 22 | ### Testimonial 23 | 24 | > Org-recur is incredibly good. It is so much more intuitive than the standard 25 | > means to designate recurring tasks in org, and it easily integrated into my 26 | > current org setup. What I was not expecting from org-recur, is how it cleaned 27 | > up my org files, making them easier to manage and read. It placed all the 28 | > important information on one line together, and eliminated time spent 29 | > searching for deadlines. 30 | 31 | ~ [anoduck](https://github.com/anoduck/anoduck/discussions/3#discussioncomment-5434803) 32 | 33 | ## Usage 34 | 35 | By adding some simple syntax to anywhere in the task heading you can control how 36 | often the task should recur. 37 | 38 | **Examples:** 39 | 40 | + `|+2|`: Recur every other day. 41 | + `|+w|`: Recur every week. 42 | + `|1|`: Recur on the first of every month. 43 | + `|Thu|`: Recur every Thursday. 44 | + `|Sun,Sat|`: Recur every Sunday and Saturday.* 45 | + `|Wkdy|`: Recur every weekday.* 46 | 47 | [The syntax is mostly a superset of the syntax already accepted by 48 | `org-schedule`. Additional syntax, provided by org-recur, is marked by *.] 49 | 50 | You can use the provided command `org-recur-finish` to reschedule tasks based on 51 | their recurrence syntax. With the point over a task, in either org-mode or 52 | org-agenda, call `org-recur-finish` and it will handle the task. The recommended 53 | hotkey is `C-c d`, and also `d` in org-agenda. 54 | 55 | ### More usage 56 | 57 | If the task does not contain a recurrence syntax, the command will ignore it by 58 | default. You can customize this to mark the task as `DONE` and archive it. 59 | 60 | The provided command `org-recur-schedule-today` (recommended hotkey `C-c 0`) 61 | schedules any task to the current date. 62 | 63 | ## Installing 64 | 65 | Make sure you have set up [MELPA](http://melpa.milkbox.net/#/getting-started) and run: 66 | 67 | ``` 68 | M-x package-install RET org-recur RET 69 | ``` 70 | 71 | Or, if you have [use-package](https://github.com/jwiegley/use-package): 72 | 73 | ```elisp 74 | (use-package org-recur 75 | :demand t) 76 | ``` 77 | 78 | ## Recommended Configuration 79 | 80 | The following `use-package` configuration: 81 | 82 | + Enables `org-recur-mode` in org-mode files and `org-recur-agenda-mode` in org-agenda. 83 | + Sets the suggested keybindings (`C-c d`, as well as `d` in org-agenda). 84 | + Enables `org-recur-finish` acting on headings without recurrence syntax, marking them `DONE` and archiving them. 85 | 86 | ```elisp 87 | (use-package org-recur 88 | :hook ((org-mode . org-recur-mode) 89 | (org-agenda-mode . org-recur-agenda-mode)) 90 | :demand t 91 | :config 92 | (define-key org-recur-mode-map (kbd "C-c d") 'org-recur-finish) 93 | 94 | ;; Rebind the 'd' key in org-agenda (default: `org-agenda-day-view'). 95 | (define-key org-recur-agenda-mode-map (kbd "d") 'org-recur-finish) 96 | (define-key org-recur-agenda-mode-map (kbd "C-c d") 'org-recur-finish) 97 | 98 | (setq org-recur-finish-done t 99 | org-recur-finish-archive t)) 100 | ``` 101 | 102 | You can also check out [my configuration](https://github.com/mrcnski/init.el/blob/master/init.el) (search "org-recur") which provides additional hotkeys that I find useful (like `C-c 1` for scheduling to `+1`, tomorrow). 103 | 104 | ## Recommended org-mode settings 105 | 106 | Here are some org-mode settings that work well in conjunction with org-recur. 107 | 108 | Refresh the org-agenda whenever a task is rescheduled: 109 | 110 | ```elisp 111 | ;; Refresh org-agenda after rescheduling a task. 112 | (defun org-agenda-refresh () 113 | "Refresh all `org-agenda' buffers." 114 | (dolist (buffer (buffer-list)) 115 | (with-current-buffer buffer 116 | (when (derived-mode-p 'org-agenda-mode) 117 | (org-agenda-maybe-redo))))) 118 | 119 | (defadvice org-schedule (after refresh-agenda activate) 120 | "Refresh org-agenda." 121 | (org-agenda-refresh)) 122 | ``` 123 | 124 | Keep the task metadata clean: 125 | 126 | ```elisp 127 | ;; Log time a task was set to DONE. 128 | (setq org-log-done (quote time)) 129 | 130 | ;; Don't log the time a task was rescheduled or redeadlined. 131 | (setq org-log-redeadline nil) 132 | (setq org-log-reschedule nil) 133 | ``` 134 | 135 | Prefer rescheduling to future dates and times: 136 | 137 | ```elisp 138 | (setq org-read-date-prefer-future 'time) 139 | ``` 140 | 141 | ## Advanced Usage 142 | 143 | ### Time of day 144 | 145 | org-recur supports time of day. It looks something like this: `|1 10:00, 15 12:00| headline`. It's a bit verbose, but you can specify different times of day for each date. If you don't want the verbosity you can move the time of day outside of org-recur: `|1, 15| 10:00 headline` works just fine, and is what I have been doing. org-agenda will pick up the time in either scenario. 146 | 147 | ### Customizing weekdays 148 | 149 | You can customize the `org-recur-weekday-recurrence` variable to match your lifestyle. If a "weekday" (a day in which you work or study) for you includes Sunday, or excludes Wednesday, you can modify the variable accordingly. 150 | 151 | ### Todo states 152 | 153 | It is possible to have todo states in a heading -- they are compatible with 154 | `org-recur`, though they are not necessary to have. If you wish to include a 155 | todo state, it **must** appear **first** in the heading, or it will not be 156 | picked up by org-mode. So, the correct format would look like this: 157 | 158 | ```org 159 | ** TODO |wkdy| test 160 | ``` 161 | 162 | Note that `org-recur` does not have this limitation; the recurrence syntax 163 | (`|wkdy|`) can appear anywhere in the heading. 164 | 165 | `org-recur` does not touch todo states, except when completing a one-off task 166 | (when enabled). Apart from that, they need to be managed manually. i.e. 167 | `org-recur` does not try to guess how a todo state should change for recurring 168 | tasks. This keeps the package simple and unopinionated. 169 | 170 | ### "First X of the month" 171 | 172 | org-recur doesn't allow for something like "first Wednesday of the month". It only supports `org-schedule` syntax (which is its backend) as well as the ability to pick the *soonest* of several options. These unfortunately can't be combined for some more complicated recurrences. 173 | 174 | For a possible alternative which allows for this, please see "Sexp diary entries" below and [here](https://stackoverflow.com/q/16946220/6085242) for an example. 175 | 176 | ## Alternatives 177 | 178 | ### Repeated tasks 179 | 180 | org-mode already supports ["repeated tasks"](https://orgmode.org/manual/Repeated-tasks.html), but it has some shortcomings: 181 | 182 | + Tasks need to have a TODO status set. I have a *lot* of recurring tasks and I don't want them all to be TODO. 183 | + You can't see how often a task recurs from the org-agenda view, you only see the task's headline and not its `SCHEDULED`/`DEADLINE` timestamps. 184 | + Repeated tasks require the `.+` syntax to shift the date based on today, which is what I almost always want. If I want to schedule a `+2` task to tomorrow I can do that manually, but I still want it to be clear that the task should recur every two days. 185 | 186 | org-recur is also simpler. I want to think as little as possible when I organize my time, helping keep my personal time management frictionless. 187 | 188 | ### org-habit 189 | 190 | [org-habit](https://orgmode.org/manual/Tracking-your-habits.html) is similar to org-recur and has some interesting, albeit unnecessary features. The same drawbacks apply as above; in addition, org-recur is much simpler. 191 | 192 | ### Sexp diary entries 193 | 194 | You can also get some features of org-recur using [Diary-style sexp entries](https://orgmode.org/guide/Timestamps.html). For example, you can get the `|1,15|` recurrence with `SCHEDULED: <%%(diary-date t '(1 15) 2019)>` (see `C-h f diary-date`). 195 | 196 | The biggest shortcoming of this approach, it seems to me, is the complexity of it. You also can't see the timestamp from the org-agenda view. 197 | -------------------------------------------------------------------------------- /org-recur-test.el: -------------------------------------------------------------------------------- 1 | ;;; org-recur-test.el --- Tests for org-recur. 2 | ;; 3 | ;;; Commentary: 4 | ;; 5 | ;; Unit tests for the package `org-recur'. 6 | ;; 7 | ;; How to run: 8 | ;; 9 | ;; 10 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 11 | ;; 12 | ;; This program is free software; you can redistribute it and/or 13 | ;; modify it under the terms of the GNU General Public License as 14 | ;; published by the Free Software Foundation; either version 3, or 15 | ;; (at your option) any later version. 16 | ;; 17 | ;; This program is distributed in the hope that it will be useful, 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20 | ;; General Public License for more details. 21 | ;; 22 | ;; You should have received a copy of the GNU General Public License 23 | ;; along with this program; see the file COPYING. If not, write to 24 | ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth 25 | ;; Floor, Boston, MA 02110-1301, USA. 26 | ;; 27 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 28 | ;; 29 | ;;; Code: 30 | 31 | ;; Requirements 32 | 33 | (require 'org-recur) 34 | 35 | ;; Tests 36 | 37 | (ert-deftest recurrence-to-options-test () 38 | (should (equal (org-recur--recurrence-to-options 39 | "Tue") 40 | '("Tue"))) 41 | (should (equal (org-recur--recurrence-to-options 42 | "Tue,Wed") 43 | '("Tue" "Wed"))) 44 | (should (equal (org-recur--recurrence-to-options 45 | "14:00 Tue,Wed 15:00") 46 | '("14:00 Tue" "Wed 15:00"))) 47 | (should (equal (org-recur--recurrence-to-options 48 | "Tue 14:00,15:00 Wed") 49 | '("Tue 14:00" "15:00 Wed"))) 50 | (should (equal (org-recur--recurrence-to-options 51 | "Sun,Wkdy") 52 | '("Sun" "mon" "tue" "wed" "thu" "fri"))) 53 | (should (equal (org-recur--recurrence-to-options 54 | "13:00 Sun,10:00 Wkdy") 55 | '("13:00 Sun" "10:00 mon" "10:00 tue" "10:00 wed" "10:00 thu" "10:00 fri"))) 56 | (should (equal (org-recur--recurrence-to-options 57 | "Wkdy 10:00,Sat 13:00") 58 | '("mon 10:00" "tue 10:00" "wed 10:00" "thu 10:00" "fri 10:00" "Sat 13:00"))) 59 | (should (equal (org-recur--recurrence-to-options 60 | "10:00 Wkdy,Wkdy 12:00") 61 | '("10:00 mon" "10:00 tue" "10:00 wed" "10:00 thu" "10:00 fri" "mon 12:00" "tue 12:00" "wed 12:00" "thu 12:00" "fri 12:00"))) 62 | ) 63 | 64 | (provide 'org-recur-test) 65 | ;;; org-recur-test.el ends here 66 | -------------------------------------------------------------------------------- /org-recur.el: -------------------------------------------------------------------------------- 1 | ;;; org-recur.el --- Recurring org-mode tasks -*- lexical-binding: t; -*- 2 | ;; 3 | ;; Filename: org-recur.el 4 | ;; Description: Recurring org-mode tasks. 5 | ;; Author: Marcin Swieczkowski 6 | ;; Created: Fri Feb 15 2019 7 | ;; Version: 1.3.3 8 | ;; Package-Requires: ((emacs "24.1") (org "9.0") (dash "2.7.0")) 9 | ;; URL: https://github.com/mrcnski/org-recur 10 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 11 | ;; 12 | ;;; Commentary: 13 | ;; 14 | ;; This package extends org-mode and org-agenda with support for defining 15 | ;; recurring tasks and easily scheduling them. 16 | ;; 17 | ;; By adding some simple syntax to a task heading you can control how often the 18 | ;; task should recur. Examples: 19 | ;; 20 | ;; + |+2|: Recur every other day. 21 | ;; + |+w|: Recur every week. 22 | ;; + |1|: Recur on the first of every month. 23 | ;; + |Thu|: Recur every Thursday. 24 | ;; + *|Sun,Sat|: Recur every Sunday and Saturday. 25 | ;; + *|Wkdy|: Recur every weekday. 26 | ;; 27 | ;; The syntax is almost identical to the one used by `org-schedule', with 28 | ;; examples of additional syntax, provided by org-recur, marked by *. 29 | ;; 30 | ;; You can use the provided command `org-recur-finish' to reschedule tasks based 31 | ;; on their recurrence syntax. With the point over a task, in either org-mode or 32 | ;; org-agenda, call `org-recur-finish' and it will handle the task 33 | ;; intelligently. If the task does not contain a recurrence syntax, the command 34 | ;; will ignore it by default, though this is customizable. 35 | ;; 36 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 37 | ;; 38 | ;; This program is free software; you can redistribute it and/or 39 | ;; modify it under the terms of the GNU General Public License as 40 | ;; published by the Free Software Foundation; either version 3, or 41 | ;; (at your option) any later version. 42 | ;; 43 | ;; This program is distributed in the hope that it will be useful, 44 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 45 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 46 | ;; General Public License for more details. 47 | ;; 48 | ;; You should have received a copy of the GNU General Public License 49 | ;; along with this program; see the file COPYING. If not, write to 50 | ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth 51 | ;; Floor, Boston, MA 02110-1301, USA. 52 | ;; 53 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 54 | ;; 55 | ;;; Code: 56 | 57 | ;; Requirements 58 | 59 | (require 'org) 60 | (require 'org-agenda) 61 | (require 'dash) 62 | 63 | ;; Customize group 64 | 65 | (defgroup org-recur nil 66 | "Recurring `org-mode' tasks." 67 | :group 'org) 68 | 69 | (defface org-recur 70 | '((t :inherit org-tag)) 71 | "Face to highlight org-recur dates." 72 | :group 'org-recur) 73 | 74 | (defcustom org-recur-finish-archive nil 75 | "Calling `org-recur-finish' on a task without org-recur syntax archives it. 76 | 77 | Note that this variable has no effect when `org-log-done' is t, 78 | in which case automatic archiving is disabled." 79 | :type 'boolean 80 | :group 'org-recur) 81 | 82 | (defcustom org-recur-finish-done nil 83 | "Calling `org-recur-finish' on a task without org-recur syntax marks it as DONE." 84 | :type 'boolean 85 | :group 'org-recur) 86 | 87 | (defcustom org-recur-weekday "wkdy" 88 | "Date string for org-recur that indicates the next weekday. 89 | This is similar to how e.g. 'fri' indicates the next Friday. Non 90 | case-sensitive. What is considered a weekday can be customized -- 91 | see `org-recur-weekday-recurrence'." 92 | :type 'string 93 | :group 'org-recur) 94 | 95 | (defcustom org-recur-weekday-recurrence "mon,tue,wed,thu,fri" 96 | "The recurrence string that `org-recur-weekday' expands to. 97 | `org-recur-finish' will pick the soonest of any of the dates 98 | between commas." 99 | :type 'string 100 | :group 'org-recur) 101 | 102 | ;; Internals 103 | 104 | ;; Simple regexp for extracting the date string from headings, and highlighting 105 | ;; in org-agenda. 106 | (defconst org-recur--regexp "|\\([^|]*\\)|") 107 | ;; More complex regexp for highlighting in org-mode, without also highlighting 108 | ;; tables. 109 | (defconst org-recur--regexp-full "^\\*+ +[^|\n]*\\(|[^|]*|\\)") 110 | 111 | (defconst org-recur--full-keywords `((,org-recur--regexp-full 1 'org-recur t))) 112 | 113 | (defconst org-recur--warning-archiving-disabled "Warning: automatic archiving is disabled when org-log-done is t. Set org-recur-finish-archive to nil to disable this message.") 114 | 115 | (defvar org-recur--buffer-keywords nil) 116 | 117 | (defun org-recur--date-string-to-time (org-date-string) 118 | "Convert ORG-DATE-STRING to a time value." 119 | (let* ((time (org-read-date-analyze org-date-string nil (decode-time))) 120 | (sec (nth 0 time)) 121 | (min (nth 1 time)) 122 | (hour (nth 2 time))) 123 | (encode-time (if sec sec 0) (if min min 0) (if hour hour 0) 124 | (nth 3 time) (nth 4 time) (nth 5 time)))) 125 | (defun org-recur--date-less-p (D1 D2) 126 | "Return non-nil if date string D1 is earlier than date string D2. 127 | A nil value is always considered greater than any date string. 128 | See ‘org-read-date’ for the various forms of a date string." 129 | (if (or (not D2) (string= "" D2)) 130 | t 131 | (unless (or (not D1) (string= "" D1)) 132 | (time-less-p (org-recur--date-string-to-time D1) 133 | (org-recur--date-string-to-time D2))))) 134 | 135 | (defun org-recur--get-next-date (heading) 136 | "Return the next date to reschedule to based on HEADING. 137 | Return nil if no recurrence found." 138 | (when (string-match org-recur--regexp heading) 139 | (let ((options (org-recur--recurrence-to-options (match-string 1 heading))) 140 | (value)) 141 | ;; Get the earliest option. 142 | (dolist (elt options value) 143 | (setq value (if (org-recur--date-less-p elt value) elt value))) 144 | value))) 145 | 146 | (defun org-recur--recurrence-to-options (recurrence) 147 | "Convert the RECURRENCE string to a list of options." 148 | (let ( 149 | ;; Split `recurrence' as it may contain multiple options. 150 | (options (split-string recurrence ","))) 151 | ;; Replace any occurrence of "wkdy" (case-insensitive). 152 | ;; Take care to apply the timestamp, if present, to all days. 153 | (-flatten 154 | (-map 155 | (lambda (option) 156 | (if (string-match-p org-recur-weekday option) 157 | ;; Split on weekday string and get anything before and after it. 158 | (let* ((splits (split-string option org-recur-weekday)) 159 | (before (car splits)) 160 | (after (car (cdr splits)))) 161 | (-map 162 | ;; Add `before' and `after' to each weekday. 163 | (lambda (day) 164 | (concat before day after)) 165 | (split-string org-recur-weekday-recurrence ","))) 166 | option)) 167 | options)))) 168 | 169 | (defun org-recur--org-schedule (date finish) 170 | "Schedule a task in `org-mode' according to the org-recur syntax in DATE. 171 | When FINISH is t, optionally completes and archives the task, based on the 172 | values of `org-recur-finish-done' and `org-recur-finish-archive'." 173 | (let ((next-date (org-recur--get-next-date date))) 174 | (cond (next-date 175 | (org-schedule nil next-date)) 176 | (finish 177 | (when org-recur-finish-done 178 | (org-todo 'done)) 179 | (when org-recur-finish-archive 180 | (if (eq 'note org-log-done) 181 | (message org-recur--warning-archiving-disabled) 182 | (org-archive-subtree))))))) 183 | (defun org-recur--org-agenda-schedule (date finish) 184 | "Schedule a task in `org-mode-agenda' according to org-recur syntax in DATE. 185 | When FINISH is t, optionally completes and archives the task, based on the 186 | values of `org-recur-finish-done' and `org-recur-finish-archive'." 187 | (let ((next-date (org-recur--get-next-date date))) 188 | (cond (next-date 189 | (org-agenda-schedule nil next-date)) 190 | (finish 191 | (when org-recur-finish-done 192 | (org-agenda-todo 'done)) 193 | (when org-recur-finish-archive 194 | (if (eq 'note org-log-done) 195 | (message org-recur--warning-archiving-disabled) 196 | (org-agenda-archive))))))) 197 | (defun org-recur--org-finish () 198 | "Handle a task in `org-mode' according to its recurrence string. 199 | Will reschedule, or optionally complete and archive, the task" 200 | (let ((heading (substring-no-properties (org-get-heading)))) 201 | (org-recur--org-schedule heading t))) 202 | (defun org-recur--org-agenda-finish () 203 | "Handle a task in `org-mode-agenda' according to its recurrence string. 204 | Will reschedule, or optionally complete and archive, the task." 205 | (let ((heading 206 | ;; FIXME: Find a more robust way of getting the header 207 | ;; from org-agenda view? This approach seems sufficient so 208 | ;; far though. 209 | (buffer-substring-no-properties 210 | (line-beginning-position) (line-end-position)))) 211 | (org-recur--org-agenda-schedule heading t))) 212 | 213 | (defun org-recur--highlight-agenda () 214 | "Highlight org-recur syntax in `org-agenda'." 215 | (highlight-regexp org-recur--regexp 'org-recur)) 216 | 217 | (defun org-recur--turn-on () 218 | "Turn on font-locking." 219 | (let ((keywords org-recur--full-keywords)) 220 | (set (make-local-variable 'org-recur--buffer-keywords) keywords) 221 | (font-lock-add-keywords nil keywords t))) 222 | (defun org-recur--turn-off () 223 | "Remove font-locking." 224 | (when org-recur--buffer-keywords 225 | (font-lock-remove-keywords nil org-recur--buffer-keywords) 226 | (kill-local-variable 'org-recur--buffer-keywords))) 227 | 228 | (defun org-recur-agenda--turn-on () 229 | "Highlight regexp in agenda." 230 | (org-recur--highlight-agenda) 231 | (add-hook 'org-agenda-finalize-hook #'org-recur--highlight-agenda) 232 | (add-hook 'org-agenda-mode-hook #'org-recur-agenda-mode)) 233 | (defun org-recur-agenda--turn-off () 234 | "Unhighlight regexp in agenda." 235 | (unhighlight-regexp org-recur--regexp) 236 | (remove-hook 'org-agenda-finalize-hook #'org-recur--highlight-agenda) 237 | (remove-hook 'org-agenda-mode-hook #'org-recur-agenda-mode)) 238 | 239 | ;; Autoloads 240 | 241 | ;;;###autoload 242 | (defun org-recur-finish () 243 | "Reschedule an `org-mode' task according to its org-recur date string. 244 | The org-recur syntax is '|DATE|', where DATE can be either an 245 | absolute date or more commonly a delta, e.g. a task heading 246 | containing '|+2|' indicates to `org-recur-finish' to reschedule 247 | the task to two days from now. 248 | 249 | All date strings supported by `org-read-date' are available. Also 250 | available is 'wkdy' (customizable with `org-recur-weekday') which 251 | schedules the task to the next weekday (customizable with 252 | `org-recur-weekday-recurrence'). Also possible is the 'N1,N2,...' 253 | syntax, wherein the earliest date string among the set of N is 254 | selected. For example, '|Mon,Fri|' indicates that the task should 255 | recur every Monday and Friday, and the soonest among them is 256 | chosen when calling `org-recur-finish'. 257 | 258 | If the task does not contain org-recur syntax, then depending on 259 | the values of `org-recur-finish-done' and 260 | `org-recur-finish-archive' change the task status to DONE and/or 261 | archive it, respectively" 262 | (interactive) 263 | (if (derived-mode-p 'org-agenda-mode) 264 | (org-recur--org-agenda-finish) 265 | (org-recur--org-finish))) 266 | 267 | ;;;###autoload 268 | (defun org-recur-schedule-date (date) 269 | "Schedule an `org-mode' task according to the org-recur syntax string in DATE. 270 | See `org-recur-finish' for the syntax. 271 | If no org-recur syntax is found, nothing happens. 272 | 273 | To schedule a task to tomorrow: 274 | 275 | #+BEGIN_SRC elisp 276 | \(org-recur-schedule-date \"|+1|\") 277 | #+END_SRC" 278 | (interactive) 279 | (if (derived-mode-p 'org-agenda-mode) 280 | (org-recur--org-agenda-schedule date nil) 281 | (org-recur--org-schedule date nil))) 282 | 283 | ;;;###autoload 284 | (defun org-recur-schedule-today () 285 | "Schedule an `org-mode' task to the current date." 286 | (interactive) 287 | (org-recur-schedule-date "|+0|")) 288 | 289 | (defvar org-recur-mode-map (make-sparse-keymap) 290 | "Keymap for org recur mode.") 291 | (defvar org-recur-agenda-mode-map (make-sparse-keymap) 292 | "Keymap for org recur agenda mode.") 293 | 294 | ;;;###autoload 295 | (define-minor-mode org-recur-mode 296 | "Highlight org-recur dates in `org-mode'. 297 | 298 | With a prefix argument ARG, enable org-recur mode if ARG is 299 | positive, and disable it otherwise. If called from Lisp, enable 300 | the mode if ARG is omitted or nil, and toggle it if ARG is 301 | `toggle'." 302 | :init-value nil 303 | :lighter "" 304 | :keymap org-recur-mode-map 305 | :group 'org-recur 306 | (if org-recur-mode 307 | (org-recur--turn-on) 308 | (org-recur--turn-off)) 309 | (when font-lock-mode 310 | (if (fboundp 'font-lock-flush) 311 | (font-lock-flush) 312 | (with-no-warnings (font-lock-fontify-buffer))))) 313 | 314 | ;;;###autoload 315 | (define-minor-mode org-recur-agenda-mode 316 | "Highlight org-recur dates in `org-agenda'. 317 | 318 | With a prefix argument ARG, enable org-recur-agenda mode if ARG 319 | is positive, and disable it otherwise. If called from Lisp, 320 | enable the mode if ARG is omitted or nil, and toggle it if ARG is 321 | `toggle'." 322 | :lighter "" 323 | :keymap org-recur-agenda-mode-map 324 | :group 'org-recur 325 | (if org-recur-agenda-mode 326 | (org-recur-agenda--turn-on) 327 | (org-recur-agenda--turn-off))) 328 | 329 | (provide 'org-recur) 330 | ;;; org-recur.el ends here 331 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mrcnski/org-recur/ffcabeff7db829d7b9682128f95990c13e70c055/screenshot.png --------------------------------------------------------------------------------