├── LICENSE ├── README.org └── org-window-habit.el /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * org-window-habit README 2 | ** Overview 3 | org-window-habit is an Emacs package that replaces Org Mode's habit-tracking 4 | functionality. It allows for more complex habit assessment and rescheduling 5 | logic, defined in terms of one or more windows in which a specific number of 6 | repetitions should be completed. Instead of relying on a simple schedule (i.e. 7 | org repeaters), org-window-habit uses a sophisticated and very customizable 8 | method to evaluate habit compliance and decide on rescheduling. 9 | ** Quick Start 10 | *** Sample Configuration 11 | org-window-habit is not yet on melpa and so must be installed from git. With 12 | straight.el, the following should work: 13 | #+begin_src emacs-lisp 14 | (use-package org-window-habit 15 | :demand t 16 | :straight 17 | (org-window-habit 18 | :repo "colonelpanic8/org-window-habit" 19 | :host github 20 | :files ("org-window-habit.el")) 21 | :config 22 | (progn 23 | (org-window-habit-mode +1))) 24 | #+end_src 25 | 26 | *** Habit Tracking 27 | Define a org heading with a TODO state and a SCHEDULED or DEADLINE with any 28 | repeater. The actual length of the repeater does not matter, since a different 29 | mechanism will be used to assign new due dates, but it is important (for the 30 | time being) that some type of repeater is present. You also need to add :STYLE: 31 | habit under :PROPERTIES: to signal that this is a habit entry. 32 | #+begin_src org 33 | **** TODO [#C] Weights 34 | SCHEDULED: <2023-09-12 Tue 16:30> DEADLINE: <2023-09-12 Tue .+2d> 35 | :PROPERTIES: 36 | :STYLE: habit 37 | :END: 38 | #+end_src 39 | *** Using Simple Repetitions Requirements 40 | If you only want to define a single window over which the habit will be 41 | evaluated you can use =:WINDOW_DURATION:= =:REPETITIONS_REQUIRED:= and 42 | =:OKAY_REPETITIONS_REQUIRED:= to set simple conditions for habit assessment. 43 | #+begin_src org 44 | :WINDOW_DURATION: 1w 45 | :REPETITIONS_REQUIRED: 4 46 | :OKAY_REPETITIONS_REQUIRED: 3 47 | #+end_src 48 | 49 | *** Advanced Habit Specification 50 | Alternatively, you can use the =:WINDOW_SPECS:= property to define multiple assessment windows for your habit. 51 | #+begin_src org 52 | :WINDOW_SPECS: ((:duration (:days 4) :repetitions 1) (:duration (:days 6) :repetitions 2)) 53 | :ASSESMENT_INTERVAL: (:days 1) 54 | :RESCHEDULE_INTERVAL: 2 55 | #+end_src 56 | 57 | *** Assesment interval 58 | The =:ASSESMENT_INTERVAL:= parameter defaults to a period of 1 day when not specified. 59 | It controls how much the rolling window for =:WINDOW_DURATION= is 60 | advanced for each evaluation of the habit. In other words, it determines the 61 | step size by which the rolling window moves forward in time for each habit 62 | assessment. 63 | 64 | *** Reschedule interval 65 | The =:RESCHEDULE_INTERVAL:= parameter defaults to a period of 1 day when not 66 | specified. It controls the minimum amount of time that must pass after a 67 | completion before a habit can be rescheduled. 68 | -------------------------------------------------------------------------------- /org-window-habit.el: -------------------------------------------------------------------------------- 1 | ;;; org-window-habit.el --- Time window based habits -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2023 Ivan Malison 4 | 5 | ;; Author: Ivan Malison 6 | ;; Keywords: calendar org-mode habit interval window 7 | ;; URL: https://github.com/colonelpanic8/org-window-habit 8 | ;; Version: 0.1.0 9 | ;; Package-Requires: ((emacs "29.1") (org "9.0.0") (dash "2.10.0")) 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; The `org-habit-window` package extends the capabilities of org-habit to 27 | ;; include habits that are not strictly daily. It allows users to define 28 | ;; habits that need to be completed a certain number of times within a 29 | ;; given time window, for example, 5 times every 7 days. 30 | 31 | ;;; Code: 32 | 33 | (require 'eieio) 34 | (require 'calendar) 35 | (require 'org) 36 | (require 'org-habit) 37 | (require 'org-agenda) 38 | (require 'cl-lib) 39 | 40 | (defgroup org-window-habit nil 41 | "Customization options for `org-window-habit'." 42 | :group 'org-habit) 43 | 44 | (defcustom org-window-habit-property-prefix "OWH" 45 | "The prefix that will be used when finding org properties for `org-window-habit'." 46 | :group 'org-window-habit 47 | :type 'string) 48 | 49 | (defcustom org-window-habit-conforming-color "#4d7085" 50 | "Color to indicate conformity in habit tracking." 51 | :group 'org-window-habit 52 | :type 'string) 53 | 54 | (defcustom org-window-habit-not-conforming-color "#d40d0d" 55 | "Color to indicate non-conformity in habit tracking." 56 | :group 'org-window-habit 57 | :type 'string) 58 | 59 | (defcustom org-window-habit-required-completion-foreground-color "#000000" 60 | "Foreground color for indicating required completions." 61 | :group 'org-window-habit 62 | :type 'string) 63 | 64 | (defcustom org-window-habit-non-required-completion-foreground-color "#FFFFFF" 65 | "Foreground color for indicating non-required completions." 66 | :group 'org-window-habit 67 | :type 'string) 68 | 69 | (defcustom org-window-habit-required-completion-today-foreground-color "#00FF00" 70 | "Foreground color for indicating required completions for today." 71 | :group 'org-window-habit 72 | :type 'string) 73 | 74 | (defcustom org-window-habit-non-conforming-scale 1.0 75 | "Scale factor for rescaling non-conforming assessment values." 76 | :group 'org-window-habit 77 | :type 'float) 78 | 79 | (defcustom org-window-habit-completion-needed-today-glyph ?☐ 80 | "Glyph character used to show intervals in which a completion is expected." 81 | :group 'org-window-habit 82 | :type 'character) 83 | 84 | (defcustom org-window-habit-completed-glyph ?✓ 85 | "Glyph character used for the current interval when the habit has been completed." 86 | :group 'org-window-habit 87 | :type 'character) 88 | 89 | (define-minor-mode org-window-habit-mode 90 | "Minor mode that replaces the normal org-habit functionality." 91 | :lighter nil 92 | :global t 93 | :group 'org-window-habit 94 | :require 'org-window-habit 95 | (if org-window-habit-mode 96 | (progn 97 | (advice-add #'org-habit-parse-todo 98 | :around #'org-window-habit-parse-todo-advice) 99 | (advice-add #'org-habit-get-urgency 100 | :around #'org-window-habit-get-urgency-advice) 101 | (advice-add #'org-auto-repeat-maybe 102 | :around 'org-window-habit-auto-repeat-maybe-advice) 103 | (advice-add #'org-add-log-note 104 | :around 'org-window-habit-auto-repeat-maybe-advice) 105 | (advice-add #'org-habit-insert-consistency-graphs 106 | :around 'org-window-habit-insert-consistency-graphs-advice)))) 107 | 108 | (defcustom org-window-habit-graph-assessment-fn 109 | 'org-window-habit-default-graph-assessment-fn 110 | "Function to assess habit graph metrics. It should return color and glyph data." 111 | :group 'org-window-habit 112 | :type 'function) 113 | 114 | (defcustom org-window-habit-preceding-intervals 21 115 | "Number of days before today to appear in consistency graphs." 116 | :group 'org-window-habit 117 | :type 'integer) 118 | 119 | (defcustom org-window-habit-following-days 4 120 | "Number of days after today to appear in consistency graphs." 121 | :group 'org-window-habit 122 | :type 'integer) 123 | 124 | (defcustom org-window-habit-repeat-to-deadline t 125 | "Reassign the deadline of habits on repeat." 126 | :group 'org-window-habit 127 | :type 'boolean) 128 | 129 | (defcustom org-window-habit-repeat-to-scheduled nil 130 | "Reassign the scheduled field of habits on repeat." 131 | :group 'org-window-habit 132 | :type 'boolean) 133 | 134 | 135 | ;; Utility functions 136 | 137 | (defun org-window-habit-property (name) 138 | (if org-window-habit-property-prefix 139 | (format "%s_%s" org-window-habit-property-prefix name) 140 | name)) 141 | 142 | (defun org-window-habit-time-to-string (time) 143 | (format-time-string 144 | "%F %R" 145 | time)) 146 | 147 | (defun org-window-habit-time-max (&rest args) 148 | "Return the maximum time value from ARGS." 149 | (let ((max-time (car args))) 150 | (dolist (time (cdr args)) 151 | (when (time-less-p max-time time) 152 | (setq max-time time))) 153 | max-time)) 154 | 155 | (defun org-window-habit-negate-plist (plist) 156 | (org-window-habit-multiply-plist plist -1)) 157 | 158 | (defun org-window-habit-multiply-plist (plist factor) 159 | (cl-loop for v in plist 160 | for index from 0 161 | collect (if (eq (mod index 2) 1) 162 | (* factor v) 163 | v))) 164 | 165 | (defun org-window-habit-duration-proportion (start-time end-time between-time) 166 | (let* ((full-interval (float-time (time-subtract end-time start-time))) 167 | (partial-interval (float-time (time-subtract end-time between-time)))) 168 | (/ partial-interval full-interval))) 169 | 170 | (cl-defun org-window-habit-keyed-duration-add 171 | (&key (base-time (current-time)) 172 | (days 0) (months 0) (years 0) 173 | (hours 0) (minutes 0) (seconds 0)) 174 | (let* ((decoded-base (decode-time base-time)) 175 | (base-year (nth 5 decoded-base)) 176 | (base-month (nth 4 decoded-base)) 177 | (base-day (nth 3 decoded-base)) 178 | (base-absolute (calendar-absolute-from-gregorian (list base-month base-day base-year))) 179 | (new-absolute (+ base-absolute days)) 180 | (gregorian-result (calendar-gregorian-from-absolute new-absolute)) 181 | (result-year (+ (caddr gregorian-result) years)) 182 | (result-month (+ (car gregorian-result) months))) 183 | 184 | ;; Handle month overflows and underflows 185 | (while (> result-month 12) 186 | (setq result-month (- result-month 12) 187 | result-year (+ result-year 1))) 188 | 189 | (while (< result-month 1) 190 | (setq result-month (+ result-month 12) 191 | result-year (- result-year 1))) 192 | 193 | (encode-time (+ seconds (nth 0 decoded-base)) 194 | (+ minutes (nth 1 decoded-base)) 195 | (+ hours (nth 2 decoded-base)) 196 | (cadr gregorian-result) 197 | result-month 198 | result-year))) 199 | 200 | (defun org-window-habit-keyed-duration-add-plist (base-time plist) 201 | (apply #'org-window-habit-keyed-duration-add :base-time base-time plist)) 202 | 203 | (cl-defun org-window-habit-string-duration-to-plist 204 | (string-value &key (default nil)) 205 | (if (null string-value) 206 | default 207 | (let ((read-value (read string-value))) 208 | (cond 209 | ((plistp read-value) read-value) 210 | ((string-match "\\([0-9]+\\)[Yy]" string-value) 211 | (list :years (string-to-number (match-string 1 string-value)))) 212 | 213 | ;; Month pattern 214 | ((string-match "\\([0-9]+\\)[Mm]" string-value) 215 | (list :months (string-to-number (match-string 1 string-value)))) 216 | 217 | ;; Week pattern 218 | ((string-match "\\([0-9]+\\)[Ww]" string-value) 219 | (list :days (* 7 (string-to-number (match-string 1 string-value))))) 220 | 221 | ;; Day pattern 222 | ((string-match "\\([0-9]+\\)[Dd]" string-value) 223 | (list :days (string-to-number (match-string 1 string-value)))) 224 | 225 | ;; Hour pattern 226 | ((string-match "\\([0-9]+\\)[Hh]" string-value) 227 | (list :hours (string-to-number (match-string 1 string-value)))) 228 | (t (list :days read-value)))))) 229 | 230 | (defun org-window-habit-normalize-time-to-duration 231 | (time-value duration-plist) 232 | (let* ((alignment-decoded (decode-time time-value)) 233 | (year (nth 5 alignment-decoded)) 234 | (month (nth 4 alignment-decoded)) 235 | (day (nth 3 alignment-decoded)) 236 | (hour (nth 2 alignment-decoded)) 237 | (minute (nth 1 alignment-decoded)) 238 | (second (nth 0 alignment-decoded)) 239 | (smallest-duration-type (car (last duration-plist 2))) 240 | (smallest-duration-value (cadr (last duration-plist 2)))) 241 | 242 | ;; Align time based on the smallest duration type and its value 243 | (cond 244 | ((eq smallest-duration-type :seconds) 245 | (encode-time 246 | (* smallest-duration-value (floor second smallest-duration-value)) minute 247 | hour day month year)) 248 | 249 | ((eq smallest-duration-type :minutes) 250 | (encode-time 251 | 0 (* smallest-duration-value 252 | (floor minute smallest-duration-value)) hour day month year)) 253 | 254 | ((eq smallest-duration-type :hours) 255 | (encode-time 256 | 0 0 (* smallest-duration-value (floor hour smallest-duration-value)) 257 | day month year)) 258 | 259 | ((eq smallest-duration-type :days) 260 | (let* ((aligned-day (- day (1- smallest-duration-value)))) 261 | (encode-time 0 0 0 aligned-day month year))) 262 | 263 | ((eq smallest-duration-type :months) 264 | (encode-time 0 0 0 1 265 | (* smallest-duration-value (floor month smallest-duration-value)) 266 | year)) 267 | 268 | ((eq smallest-duration-type :years) 269 | (let* ((aligned-year (- year (1- smallest-duration-value)))) 270 | (encode-time 0 0 0 1 1 aligned-year))) 271 | 272 | (t time-value)))) 273 | 274 | (defun org-window-habit-find-aligned-bounding-time (time-value duration-plist aligned-time) 275 | (let (new-time) 276 | (while (time-less-p time-value aligned-time) 277 | (setq new-time 278 | (org-window-habit-keyed-duration-add-plist aligned-time duration-plist)) 279 | (when (not (time-less-p new-time aligned-time)) 280 | (error "Time did not decrease in alignment attempt")) 281 | (setq aligned-time new-time))) 282 | aligned-time) 283 | 284 | (defun org-window-habit-logbook-drawer-bounds () 285 | (when (re-search-forward org-logbook-drawer-re nil t) 286 | (list (match-beginning 0) (match-end 0)))) 287 | 288 | (defun org-window-habit-parse-logbook () 289 | (let ((bounds (org-window-habit-logbook-drawer-bounds))) 290 | (when bounds 291 | (cl-destructuring-bind (start end) bounds 292 | (goto-char start) 293 | (let ((re (org-window-habit-get-logbook-entry-re))) 294 | (cl-loop while (re-search-forward re end t) 295 | collect (list 296 | (match-string-no-properties 1) 297 | (match-string-no-properties 2) 298 | (org-time-string-to-time (match-string-no-properties 3))))))))) 299 | 300 | (defun org-window-habit-get-logbook-entry-re (&optional state-regexp) 301 | (unless state-regexp 302 | (setq state-regexp (rx alphanumeric))) 303 | (rx 304 | (: line-start (* space) "-" (* space)) 305 | "State" (* space) (? "\"") (group (* alphanumeric)) (? "\"") 306 | (* space) (? (: "from" (* space) (? "\"") (group (* alphanumeric)) (? "\""))) 307 | (* space) 308 | (regexp org-ts-regexp-inactive))) 309 | 310 | (defun org-window-habit-time-less-or-equal-p (time1 time2) 311 | (or (time-less-p time1 time2) 312 | (time-equal-p time1 time2))) 313 | 314 | (defun org-window-habit-time-greater-p (time1 time2) 315 | (time-less-p time2 time1)) 316 | 317 | (defun org-window-habit-time-greater-or-equal-p (time1 time2) 318 | (org-window-habit-time-less-or-equal-p time2 time1)) 319 | 320 | (defun org-window-habit-maybe-make-list-of-lists (value) 321 | (if (and (listp value) (listp (car value))) 322 | value 323 | (list value))) 324 | 325 | (defun org-window-habit-default-aggregation-fn (collection) 326 | (cl-loop for el in collection minimize (car el))) 327 | 328 | 329 | ;; Data types 330 | 331 | (defclass org-window-habit () 332 | ((window-specs :initarg :window-specs :initform nil) 333 | (assessment-interval :initarg :assessment-interval :initform '(:days 1)) 334 | (reschedule-interval :initarg :reschedule-interval :initform '(:days 1)) 335 | (reschedule-threshold :initarg :reschedule-threshold :initform 1.0) 336 | (done-times :initarg :done-times :initform nil) 337 | (assessment-decrement-plist :initarg :assessment-decrement-plist :initform nil) 338 | (max-repetitions-per-interval :initarg :max-repetitions-per-interval :initform 1) 339 | (aggregation-fn :initarg :aggregation-fn :initform 'org-window-habit-default-aggregation-fn) 340 | (graph-assessment-fn :initarg :graph-assessment-fn :initform nil) 341 | (start-time :initarg :start-time))) 342 | 343 | (cl-defmethod initialize-instance :after ((habit org-window-habit) &rest _args) 344 | (when (null (oref habit assessment-interval)) 345 | (error "Habits must have the %s property set when org-window-habit is enabled" 346 | (org-window-habit-property "ASSESSMENT_INTERVAL"))) 347 | (when (null (oref habit window-specs)) 348 | (error "Habits must define at least one window when org-window-habit is enabled")) 349 | (when (null (oref habit reschedule-interval)) 350 | (oset habit reschedule-interval (oref habit assessment-interval))) 351 | (when (null (oref habit assessment-decrement-plist)) 352 | (oset habit assessment-decrement-plist 353 | (org-window-habit-negate-plist (oref habit assessment-interval)))) 354 | (when (null (oref habit start-time)) 355 | (oset habit start-time 356 | (org-window-habit-normalize-time-to-duration 357 | (or (org-window-habit-earliest-completion habit) (current-time)) 358 | (oref habit assessment-interval)))) 359 | (cl-loop for window-spec in (oref habit window-specs) 360 | do (oset window-spec habit habit))) 361 | 362 | (defclass org-window-habit-window-spec () 363 | ((duration-plist :initarg :duration :initform '(:days 1)) 364 | (target-repetitions :initarg :repetitions :initform 1) 365 | (conforming-value :initarg :value :initform nil) 366 | (find-window :initarg :find-window :initform nil) 367 | (habit :initarg :habit))) 368 | 369 | (defclass org-window-habit-assessment-window () 370 | ((assessment-start-time :initarg :assessment-start-time) 371 | (assessment-end-time :initarg :assessment-end-time) 372 | (start-time :initarg :start-time) 373 | (end-time :initarg :end-time))) 374 | 375 | (cl-defmethod org-window-habit-time-falls-in-assessment-interval 376 | ((window org-window-habit-assessment-window) time) 377 | (and 378 | (time-less-p 379 | time 380 | (oref window assessment-end-time)) 381 | (org-window-habit-time-less-or-equal-p 382 | (oref window assessment-start-time) time))) 383 | 384 | (cl-defmethod org-window-habit-assesment-window-string 385 | ((window org-window-habit-assessment-window)) 386 | (with-slots (assessment-start-time assessment-end-time start-time end-time) window 387 | (format 388 | "%s %s %s %s" 389 | (format "assessment-start-time: %s" (org-window-habit-time-to-string assessment-start-time)) 390 | (format "assessment-end-time: %s" (org-window-habit-time-to-string assessment-end-time)) 391 | (format "start-time: %s" (org-window-habit-time-to-string start-time)) 392 | (format "end-time: %s" (org-window-habit-time-to-string end-time))))) 393 | 394 | (defun org-window-habit-create-instance-from-heading-at-point () 395 | "Construct an `org-window-habit' instance from the current org entry." 396 | (save-excursion 397 | (let* ((done-times 398 | (cl-loop for state-change-info in (org-window-habit-parse-logbook) 399 | if (member (nth 0 state-change-info) org-done-keywords) 400 | collect (nth 2 state-change-info))) 401 | (done-times-vector (vconcat done-times)) 402 | (assessment-interval 403 | (org-window-habit-string-duration-to-plist 404 | (org-entry-get 405 | nil (org-window-habit-property "ASSESSMENT_INTERVAL")) :default '(:days 1))) 406 | (reschedule-interval 407 | (org-window-habit-string-duration-to-plist 408 | (org-entry-get nil (org-window-habit-property "RESCHEDULE_INTERVAL")))) 409 | (max-repetitions-per-interval 410 | (string-to-number 411 | (or (org-entry-get 412 | nil (org-window-habit-property "MAX_REPETITIONS_PER_INTERVAL") t) "1")))) 413 | (make-instance 'org-window-habit 414 | :start-time nil 415 | :window-specs (or 416 | (org-window-habit-create-specs) 417 | (org-window-habit-create-specs-from-perfect-okay)) 418 | :assessment-interval assessment-interval 419 | :reschedule-interval reschedule-interval 420 | :done-times done-times-vector 421 | :max-repetitions-per-interval max-repetitions-per-interval)))) 422 | 423 | (defun org-window-habit-create-specs () 424 | (let ((spec-text (org-entry-get nil (org-window-habit-property "WINDOW_SPECS") t))) 425 | (when spec-text 426 | (cl-loop for args in (car (read-from-string spec-text)) 427 | collect (apply #'make-instance 'org-window-habit-window-spec args))))) 428 | 429 | (defun org-window-habit-create-specs-from-perfect-okay () 430 | (let* 431 | ((window-length 432 | (org-window-habit-string-duration-to-plist 433 | (org-entry-get nil (org-window-habit-property "WINDOW_DURATION") 434 | "1d") :default '(:days 1))) 435 | (repetitions-required 436 | (string-to-number 437 | (or (org-entry-get nil 438 | (org-window-habit-property "REPETITIONS_REQUIRED") 439 | t) "1")))) 440 | (list 441 | (make-instance 442 | 'org-window-habit-window-spec 443 | :duration window-length 444 | :repetitions repetitions-required 445 | :value 1.0)))) 446 | 447 | 448 | ;; Iterator 449 | 450 | (defclass org-window-habit-iterator () 451 | ((window-spec :initarg :window-spec) 452 | (window :initarg :window) 453 | (start-index :initarg :start-index) 454 | (end-index :initarg :end-index))) 455 | 456 | (cl-defun org-window-habit-iterator-from-time (window-spec &optional time) 457 | (setq time (or time (current-time))) 458 | (let* ((iterator 459 | (make-instance 'org-window-habit-iterator 460 | :window-spec window-spec 461 | :window (org-window-habit-get-assessment-window window-spec time) 462 | :start-index 0 463 | :end-index 0))) 464 | (org-window-habit-adjust-iterator-indices iterator) 465 | iterator)) 466 | 467 | (cl-defmethod org-window-habit-advance 468 | ((iterator org-window-habit-iterator) &key (amount nil)) 469 | (with-slots (window window-spec) iterator 470 | (unless amount 471 | (setq amount (oref (oref window-spec habit) assessment-interval))) 472 | (let* 473 | ((new-start-time (org-window-habit-keyed-duration-add-plist 474 | (oref window assessment-start-time) 475 | amount)) 476 | (window-moved-backward 477 | (time-less-p new-start-time (oref window assessment-start-time))) 478 | (new-window (org-window-habit-get-assessment-window window-spec new-start-time))) 479 | (oset iterator window new-window) 480 | (org-window-habit-adjust-iterator-indices 481 | iterator (not window-moved-backward))))) 482 | 483 | (cl-defmethod org-window-habit-adjust-iterator-indices 484 | ((iterator org-window-habit-iterator) 485 | &optional window-moved-forward) 486 | (with-slots (window start-index end-index window-spec) iterator 487 | (cl-destructuring-bind (new-start-index new-end-index) 488 | (org-window-habit-get-completion-window-indices 489 | (oref window-spec habit) 490 | (oref window start-time) (oref window end-time) 491 | :start-index start-index 492 | :end-index end-index 493 | :reverse window-moved-forward) 494 | (oset iterator start-index new-start-index) 495 | (oset iterator end-index new-end-index)))) 496 | 497 | (cl-defmethod org-window-habit-conforming-ratio 498 | ((iterator org-window-habit-iterator) &rest args) 499 | (with-slots (window-spec window start-index) iterator 500 | (min 501 | 1.0 502 | (/ 503 | (apply #'org-window-habit-get-completion-count 504 | (oref window-spec habit) 505 | (oref window start-time) 506 | (oref window end-time) 507 | :start-index start-index 508 | args) 509 | (* (org-window-habit-actual-window-scale iterator) 510 | (oref window-spec target-repetitions)))))) 511 | 512 | (cl-defmethod org-window-habit-actual-window-scale 513 | ((iterator org-window-habit-iterator)) 514 | (with-slots (window) iterator 515 | (org-window-habit-duration-proportion 516 | (oref window start-time) (oref window end-time) 517 | (org-window-habit-effective-start iterator)))) 518 | 519 | (cl-defmethod org-window-habit-get-conforming-value 520 | ((iterator org-window-habit-iterator) &rest args) 521 | (with-slots (window-spec window) iterator 522 | (list (apply #'org-window-habit-conforming-ratio iterator args) 523 | (or (oref window-spec conforming-value) 524 | (oref window-spec duration-plist)) 525 | window))) 526 | 527 | 528 | ;; Default versions of customizable functions 529 | 530 | (defun org-window-habit-get-window-where-time-in-last-assessment (spec time) 531 | (let* ((habit (oref spec habit)) 532 | (assessment-plist 533 | (oref habit assessment-interval)) 534 | (assessment-start 535 | (org-window-habit-normalize-time-to-duration 536 | time assessment-plist)) 537 | (assessment-end 538 | (org-window-habit-keyed-duration-add-plist 539 | assessment-start 540 | assessment-plist)) 541 | (window-start 542 | (org-window-habit-keyed-duration-add-plist 543 | assessment-end 544 | (org-window-habit-negate-plist (oref spec duration-plist))))) 545 | (make-instance 546 | 'org-window-habit-assessment-window 547 | :assessment-start-time assessment-start 548 | :assessment-end-time assessment-end 549 | :start-time window-start 550 | :end-time assessment-end))) 551 | 552 | 553 | ;; Datatype utility 554 | 555 | (cl-defmethod org-window-habit-get-assessment-window 556 | ((spec org-window-habit-window-spec) time) 557 | (funcall (or (oref spec find-window) 558 | 'org-window-habit-get-window-where-time-in-last-assessment) 559 | spec time)) 560 | 561 | (cl-defmethod org-window-habit-earliest-completion ((habit org-window-habit)) 562 | (with-slots (done-times) habit 563 | (let ((done-times-count (length done-times))) 564 | (when (> done-times-count 0) 565 | (aref done-times (- done-times-count 1)))))) 566 | 567 | (cl-defmethod org-window-habit-effective-start ((iterator org-window-habit-iterator)) 568 | (org-window-habit-time-max (oref (oref iterator window) start-time) 569 | (oref (oref (oref iterator window-spec) habit) start-time))) 570 | 571 | 572 | ;; Scanning done times 573 | 574 | (cl-defun org-window-habit-find-array-forward 575 | (array time &key (start-index nil) (comparison '<)) 576 | (setq start-index (or start-index 0)) 577 | (cl-loop for index from start-index to (length array) 578 | while (and (< index (length array)) 579 | (funcall comparison time (aref array index))) 580 | finally return index)) 581 | 582 | (cl-defun org-window-habit-find-array-backward 583 | (array time &key (start-index nil) (comparison '<)) 584 | (setq start-index (or start-index (length array))) 585 | (cl-loop for index downfrom start-index to 1 586 | for testing-value = (aref array (- index 1)) 587 | while (funcall comparison time testing-value) 588 | finally return index)) 589 | 590 | (cl-defmethod org-window-habit-get-completion-window-indices 591 | ((habit org-window-habit) start-time end-time 592 | &key (start-index nil) (end-index nil) (reverse nil)) 593 | (with-slots (done-times) habit 594 | (if (not reverse) 595 | (list 596 | ;; We use end-time and not start time because the array is in descending 597 | ;; order 598 | (org-window-habit-find-array-forward 599 | done-times end-time 600 | :comparison 'org-window-habit-time-less-or-equal-p 601 | :start-index start-index) 602 | ;; We use start-time to compute the end index because the list is in 603 | ;; descending order 604 | (org-window-habit-find-array-forward 605 | done-times start-time 606 | :comparison 'org-window-habit-time-less-or-equal-p 607 | :start-index end-index)) 608 | (list 609 | ;; We use end-time and not start time because the array is in descending 610 | ;; order 611 | (org-window-habit-find-array-backward 612 | done-times end-time 613 | :comparison 'org-window-habit-time-greater-p 614 | :start-index start-index) 615 | ;; We use start-time to compute the end index because the list is in 616 | ;; descending order 617 | (org-window-habit-find-array-backward 618 | done-times start-time 619 | :comparison 'org-window-habit-time-greater-p 620 | :start-index end-index))))) 621 | 622 | 623 | ;; Compute completions and required 624 | 625 | (cl-defmethod org-window-habit-get-completion-count 626 | ((habit org-window-habit) start-time end-time &key (start-index 0) 627 | (fill-completions-fn (lambda (_time actual-completions) actual-completions))) 628 | (cl-loop 629 | with next-start-index = start-index 630 | with interval-end-time = end-time 631 | for interval-start-time = 632 | ;; This is just a sanity check for the case where the interval does not 633 | ;; evenly divide the window. But you shouldn't do that anyway. 634 | (org-window-habit-time-max 635 | start-time 636 | (org-window-habit-keyed-duration-add-plist 637 | interval-end-time (oref habit assessment-decrement-plist))) 638 | for (start-index end-index) = 639 | (org-window-habit-get-completion-window-indices 640 | habit interval-start-time interval-end-time 641 | :start-index next-start-index 642 | :end-index next-start-index) 643 | for completions-within-interval = 644 | (min (oref habit max-repetitions-per-interval) 645 | (funcall 646 | fill-completions-fn 647 | interval-start-time 648 | (- end-index start-index))) 649 | sum completions-within-interval 650 | do (setq next-start-index end-index 651 | interval-end-time interval-start-time) 652 | while (time-less-p start-time interval-start-time))) 653 | 654 | (cl-defmethod org-window-habit-get-next-required-interval 655 | ((habit org-window-habit) &optional now) (setq now (or now (current-time))) 656 | (with-slots 657 | (window-specs reschedule-interval reschedule-threshold assessment-interval 658 | aggregation-fn done-times) 659 | habit 660 | (if (org-window-habit-has-any-done-times habit) 661 | (cl-loop 662 | with start-time = 663 | (org-window-habit-normalize-time-to-duration 664 | (org-window-habit-time-max 665 | now 666 | (org-window-habit-keyed-duration-add-plist (aref done-times 0) 667 | reschedule-interval)) 668 | assessment-interval) 669 | with iterators = 670 | (cl-loop for window-spec in window-specs 671 | collect 672 | (org-window-habit-iterator-from-time window-spec start-time)) 673 | for current-assessment-start = (oref (oref (car iterators) window) assessment-start-time) 674 | for conforming-values = 675 | (cl-loop for iterator in iterators 676 | collect (org-window-habit-get-conforming-value iterator)) 677 | for assessment-value = (funcall aggregation-fn conforming-values) 678 | until (< assessment-value reschedule-threshold) 679 | do 680 | (cl-loop for iterator in iterators 681 | do (org-window-habit-advance iterator)) 682 | finally return current-assessment-start) 683 | (org-window-habit-normalize-time-to-duration 684 | now assessment-interval)))) 685 | 686 | (cl-defmethod org-window-habit-assess-interval 687 | ((habit org-window-habit) iterators &rest args) 688 | (let* ((conforming-values 689 | (cl-loop for iterator in iterators 690 | collect (apply #'org-window-habit-get-conforming-value iterator args)))) 691 | (or (funcall (oref habit aggregation-fn) conforming-values) 0.0))) 692 | 693 | (cl-defmethod org-window-habit-assess-interval-with-and-without-completions 694 | ((habit org-window-habit) iterators modify-completions-fn) 695 | (let* ((current-assessment-start 696 | (oref (oref (car iterators) window) assessment-start-time)) 697 | (current-assessment-end 698 | (oref (oref (car iterators) window) assessment-end-time)) 699 | (no-completions 700 | (org-window-habit-assess-interval 701 | habit iterators 702 | :fill-completions-fn 703 | (lambda (time actual-completions) 704 | (if (time-equal-p current-assessment-start time) 705 | 0 706 | actual-completions)))) 707 | (with-completions 708 | (org-window-habit-assess-interval 709 | habit iterators 710 | :fill-completions-fn 711 | (lambda (time actual-completions) 712 | (if (time-equal-p current-assessment-start time) 713 | (funcall modify-completions-fn actual-completions) 714 | actual-completions)))) 715 | (count (org-window-habit-get-completion-count 716 | habit current-assessment-start current-assessment-end))) 717 | (list current-assessment-start 718 | current-assessment-end 719 | no-completions 720 | with-completions 721 | count))) 722 | 723 | 724 | ;; Graph functions 725 | 726 | (cl-defmethod org-window-habit-has-any-done-times ((habit org-window-habit)) 727 | (> (length (oref habit done-times)) 0)) 728 | 729 | (cl-defmethod org-window-habit-build-graph ((habit org-window-habit) &optional now) 730 | (setq now (or now (current-time))) 731 | (with-slots 732 | (assessment-decrement-plist window-specs reschedule-interval 733 | max-repetitions-per-interval start-time aggregation-fn 734 | assessment-interval graph-assessment-fn) 735 | habit 736 | (unless graph-assessment-fn 737 | (setq graph-assessment-fn 738 | org-window-habit-graph-assessment-fn)) 739 | (cl-destructuring-bind (actual-intervals actual-start-time) 740 | ;; Find the start time by going back by the assessment interval 741 | ;; `org-window-habit-preceding-intervals' times, or hitting the habits 742 | ;; absolute start. 743 | (cl-loop 744 | with target-start-time = (org-window-habit-normalize-time-to-duration 745 | now assessment-interval) 746 | for i from 0 to org-window-habit-preceding-intervals 747 | while (time-less-p start-time target-start-time) 748 | do 749 | (setq target-start-time 750 | (org-window-habit-keyed-duration-add-plist 751 | target-start-time 752 | assessment-decrement-plist)) 753 | finally return (list i target-start-time)) 754 | (nconc 755 | ;; Add filler if we don't have enough data to fill `org-window-habit-preceding-intervals'. 756 | (cl-loop for i from 0 to (- org-window-habit-preceding-intervals actual-intervals) 757 | collect (list ?\s 'default)) 758 | (cl-loop 759 | with iterators = 760 | (cl-loop for window-spec in window-specs 761 | collect 762 | (org-window-habit-iterator-from-time 763 | window-spec actual-start-time)) 764 | while (time-less-p (oref (oref (car iterators) window) assessment-end-time) now) 765 | for 766 | (_current-assessment-start 767 | _current-assessment-end 768 | no-completions-assessment 769 | with-completions-assessment 770 | completion-in-interval-count) = 771 | (org-window-habit-assess-interval-with-and-without-completions 772 | habit iterators (lambda (x) x)) 773 | collect 774 | (funcall 775 | graph-assessment-fn 776 | no-completions-assessment 777 | with-completions-assessment 778 | completion-in-interval-count 779 | 'past 780 | habit 781 | (oref (car iterators) window)) 782 | into past-assessments 783 | do 784 | (cl-loop for iterator in iterators 785 | do (org-window-habit-advance iterator)) 786 | finally 787 | return 788 | (cl-destructuring-bind 789 | (_current-assessment-start 790 | _current-assessment-end 791 | no-completions-assessment 792 | with-completions-assessment 793 | completion-in-interval-count) 794 | (org-window-habit-assess-interval-with-and-without-completions 795 | habit iterators (lambda (_x) max-repetitions-per-interval)) 796 | (nconc past-assessments 797 | ;; This is a hack to allow multi character stuff for the current day 798 | (org-window-habit-maybe-make-list-of-lists 799 | (funcall graph-assessment-fn no-completions-assessment 800 | with-completions-assessment 801 | completion-in-interval-count 'present habit 802 | (oref (car iterators) window))) 803 | (cl-loop 804 | for i from 1 to org-window-habit-following-days 805 | do 806 | (cl-loop for iterator in iterators 807 | do (org-window-habit-advance iterator)) 808 | for 809 | (_current-assessment-start 810 | _current-assessment-end 811 | no-completions-assessment 812 | with-completions-assessment 813 | completion-in-interval-count) = 814 | (org-window-habit-assess-interval-with-and-without-completions 815 | habit iterators (lambda (_x) 0)) 816 | collect 817 | (funcall 818 | graph-assessment-fn 819 | no-completions-assessment 820 | with-completions-assessment 821 | completion-in-interval-count 822 | 'future 823 | habit 824 | (oref (car iterators) window)))))))))) 825 | 826 | (defun org-window-habit-make-graph-string (graph-info) 827 | (let ((graph (make-string (length graph-info) ?\s))) 828 | (cl-loop for (character face) in graph-info 829 | for index from 0 830 | do 831 | (progn 832 | (aset graph index character) 833 | (put-text-property index (1+ index) 'face face graph))) 834 | graph)) 835 | 836 | (defun org-window-habit-insert-consistency-graphs (&optional line) 837 | "Insert consistency graph for any habitual tasks. 838 | If LINE is provided, insert graphs at beggining of line" 839 | (let ((inhibit-read-only t) 840 | (buffer-invisibility-spec '(org-link))) 841 | (save-excursion 842 | (goto-char (if line (line-beginning-position) (point-min))) 843 | (while (not (eobp)) 844 | (let ((habit (get-text-property (point) 'org-habit-p)) 845 | (_invisible-prop (get-text-property (point) 'invisible))) 846 | (when (and habit 847 | (or (org-window-habit-has-any-done-times habit) 848 | (progn (message "Skipping habit with no done times") nil))) 849 | (move-to-column org-habit-graph-column t) 850 | (delete-char (min (+ 1 org-habit-preceding-days 851 | org-habit-following-days) 852 | (- (line-end-position) (point)))) 853 | (insert-before-markers 854 | (org-window-habit-make-graph-string 855 | (org-window-habit-build-graph habit)))) 856 | ;; TODO: this should be reintroduced 857 | ;; Inherit invisible state of hidden entries. 858 | ;; (when invisible-prop 859 | ;; (put-text-property 860 | ;; (- (point) org-habit-graph-column) (point) 861 | ;; 'invisible invisible-prop)))) 862 | (forward-line)))))) 863 | 864 | 865 | ;; Advice 866 | 867 | (defun org-window-habit-parse-todo-advice (orig &rest args) 868 | (if org-window-habit-mode 869 | (org-window-habit-create-instance-from-heading-at-point) 870 | (apply orig args))) 871 | 872 | 873 | 874 | (defun org-window-habit-insert-consistency-graphs-advice (orig &rest args) 875 | (if org-window-habit-mode 876 | (org-window-habit-insert-consistency-graphs) 877 | (apply orig args))) 878 | 879 | (defun org-window-habit-get-urgency-advice (orig &rest args) 880 | (if org-window-habit-mode 881 | org-default-priority ;TODO fix this 882 | (apply orig args))) 883 | 884 | (defun org-window-habit-auto-repeat (&rest _args) 885 | "Reassign the date of the habit to the next day at which it is required." 886 | (interactive) 887 | (let* ((required-interval-start 888 | (org-window-habit-get-next-required-interval 889 | (org-window-habit-create-instance-from-heading-at-point))) 890 | (repeat (org-get-repeat)) 891 | (target-time-string 892 | (format-time-string (car org-time-stamp-formats) 893 | required-interval-start))) 894 | (when org-window-habit-repeat-to-deadline 895 | (org-deadline nil target-time-string) 896 | (when (null repeat) 897 | (org-window-habit-add-repeater ".+1d"))) 898 | (when org-window-habit-repeat-to-scheduled 899 | (org-schedule nil target-time-string) 900 | (when (null repeat) 901 | (org-window-habit-add-repeater ".+1d"))))) 902 | 903 | (defun org-window-habit-add-repeater (repeater) 904 | (save-excursion 905 | (org-back-to-heading t) 906 | (when (re-search-forward 907 | (concat org-last-inserted-timestamp) 908 | (line-end-position 2) 909 | t) 910 | (goto-char (1- (match-end 0))) 911 | (insert-and-inherit " " repeater) 912 | (setq org-last-inserted-timestamp 913 | (concat (substring org-last-inserted-timestamp 0 -1) 914 | " " repeater 915 | (substring org-last-inserted-timestamp -1)))))) 916 | 917 | (defun org-window-habit-auto-repeat-maybe-advice (orig &rest args) 918 | (let ((res (apply orig args))) 919 | (when (and org-window-habit-mode (org-is-habit-p)) 920 | (apply #'org-window-habit-auto-repeat args)) 921 | res)) 922 | 923 | 924 | ;; Default graph display functions 925 | 926 | (defun org-window-habit-create-face (bg-color foreground-color) 927 | (let* ((bg-name (replace-regexp-in-string "#" "" bg-color)) 928 | (fg-name (replace-regexp-in-string "#" "" foreground-color)) 929 | (face-name (intern (format "org-window-habit-face-bg-%s-fg-%s" bg-name fg-name)))) 930 | (if (facep face-name) 931 | face-name 932 | (progn 933 | (make-face face-name) 934 | (set-face-attribute face-name nil :background bg-color :foreground foreground-color) 935 | face-name)))) 936 | 937 | (defun org-window-habit-rescale-assessment-value (value) 938 | (if (>= value 1.0) value 939 | (* org-window-habit-non-conforming-scale value))) 940 | 941 | (defun org-window-habit-lerp-color (color1 color2 proportion) 942 | (let ((r1 (string-to-number (substring color1 1 3) 16)) 943 | (g1 (string-to-number (substring color1 3 5) 16)) 944 | (b1 (string-to-number (substring color1 5 7) 16)) 945 | (r2 (string-to-number (substring color2 1 3) 16)) 946 | (g2 (string-to-number (substring color2 3 5) 16)) 947 | (b2 (string-to-number (substring color2 5 7) 16))) 948 | (format "#%02x%02x%02x" 949 | (round (+ (* (- r2 r1) proportion) r1)) 950 | (round (+ (* (- g2 g1) proportion) g1)) 951 | (round (+ (* (- b2 b1) proportion) b1))))) 952 | 953 | (cl-defun org-window-habit-default-graph-assessment-fn 954 | (without-completion-assessment-value 955 | with-completion-assessment-value 956 | completions-in-interval 957 | current-interval-time-type 958 | habit 959 | window) 960 | (let* ((with-completion-color 961 | (org-window-habit-lerp-color 962 | org-window-habit-not-conforming-color 963 | org-window-habit-conforming-color 964 | (org-window-habit-rescale-assessment-value 965 | with-completion-assessment-value))) 966 | (without-completion-color 967 | (org-window-habit-lerp-color 968 | org-window-habit-not-conforming-color 969 | org-window-habit-conforming-color 970 | (org-window-habit-rescale-assessment-value 971 | without-completion-assessment-value))) 972 | (completion-today-matters 973 | (< without-completion-assessment-value with-completion-assessment-value)) 974 | (next-required-interval (org-window-habit-get-next-required-interval habit)) 975 | (completion-expected-today 976 | (org-window-habit-time-falls-in-assessment-interval 977 | window 978 | next-required-interval)) 979 | (interval-has-completion (> completions-in-interval 0))) 980 | (pcase current-interval-time-type 981 | ('present 982 | (let* ((character 983 | (cond 984 | (interval-has-completion org-window-habit-completed-glyph) 985 | (completion-expected-today 986 | org-window-habit-completion-needed-today-glyph) 987 | (t ?-))) 988 | (completion-face 989 | (org-window-habit-create-face with-completion-color "#000000")) 990 | (sample-face 991 | (if interval-has-completion 992 | completion-face 993 | (org-window-habit-create-face without-completion-color "#000000")))) 994 | (list 995 | (list ?| completion-face) 996 | (list character completion-face) 997 | (list ?\s sample-face) 998 | (list ?| completion-face)))) 999 | ('past 1000 | (let* ((bg-color 1001 | (if completion-expected-today 1002 | without-completion-color 1003 | with-completion-color)) 1004 | (fg-color 1005 | (cond 1006 | (completion-expected-today 1007 | with-completion-color) 1008 | (completion-today-matters 1009 | org-window-habit-required-completion-foreground-color) 1010 | (t org-window-habit-non-required-completion-foreground-color))) 1011 | (face (org-window-habit-create-face bg-color fg-color)) 1012 | (character 1013 | (cond 1014 | ((> completions-in-interval 0) org-habit-completed-glyph) 1015 | (t ?\s)))) 1016 | (list character face))) 1017 | ('future 1018 | (let* ((bg-color 1019 | without-completion-color) 1020 | (fg-color 1021 | "#000000") 1022 | (face (org-window-habit-create-face bg-color fg-color)) 1023 | (character 1024 | (cond 1025 | (completion-expected-today 1026 | org-window-habit-completion-needed-today-glyph) 1027 | (t ?\s)))) 1028 | (list character face)))))) 1029 | 1030 | (provide 'org-window-habit) 1031 | ;;; org-window-habit.el ends here 1032 | --------------------------------------------------------------------------------