diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,3 @@ +# Changelog for timeutils + +## Unreleased changes diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# timeutils + +Copyright (C) 2019 Jonathan Lamothe + + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +## Executive Summary + +This package contains some simple time-based tools, and consists of +two parts: a library, and an executable. The library should be fairly +portable, and provides some simple timer/stopwatch functionality. The +executanle is a simple console-based program built on top of the +[brick](http://hackage.haskell.org/package/brick) package, and as +such, will presently only work on POSIX-compatible systems (sorry +Windows users). + +## Library + +The library provides its functionalty through the `Data.Time.Utils` +module, and is thoroughlly documented [on +Hackage](http://hackage.haskell.org/package/timeutils). + +## Executable + +This package provides the `timeutils` executable, a console-based +program with a rudimentary user interface. It has two modes: +stopwatch and countdown. You can toggle between these modes by +pressing the `` key. The program can be exited with the `` +key, the `q` key, or by hitting ``. + +### Stopwatch Mode + +The following is a list of keys and their effects in stopwatch mode: + +Key | Effect +--- | ------ +`` | start/stop stopwatch +`l` | start new lap +`r` | reset stopwatch + +### Countdown Mode + +The following is a list of keys and their effects in countdown mode: + +Key | Effect +--- | ------ +`n` | new countdown +``/`` | select countdown +`` | start/stop selected countdown +`` | delete selected countdown +`r` | reset selected countdown +`R` | delete all countdowns +`d`/`D` | increment/deincrement days in current countdown +`h`/`H` | increment/deincrement hours in current countdown +`m`/`M` | increment/deincrement minutes in current countdown +`s`/`S` | increment/deincrement seconds in current countdown diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/app/Logic.hs b/app/Logic.hs new file mode 100644 --- /dev/null +++ b/app/Logic.hs @@ -0,0 +1,197 @@ +{- + +timeutils + +Copyright (C) 2019 Jonathan Lamothe + + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +-} + +module Logic (handleEvent) where + +import Brick.BChan (writeBChan) +import Brick.Main (continue, halt) +import Brick.Types (BrickEvent (..), EventM, Next) +import Control.Concurrent (forkIO, threadDelay) +import Control.Monad (void) +import Control.Monad.IO.Class (liftIO) +import Data.Time (NominalDiffTime, getCurrentTime) +import Lens.Micro (over, sets) +import Graphics.Vty.Input.Events + ( Event (..) + , Key (..) + , Modifier (..) + ) + +import Data.Time.Utils +import Types + +handleEvent + :: ProgState + -> BrickEvent () () + -> EventM () (Next ProgState) +handleEvent s ev = do + t <- liftIO getCurrentTime + let s' = s { currentTime = t } + case ev of + VtyEvent (EvKey (KChar 'q') []) -> halt s' + VtyEvent (EvKey (KChar 'c') [MCtrl]) -> halt s' + VtyEvent (EvKey KEsc []) -> halt s' + VtyEvent (EvKey (KChar '\t') []) -> continue $ changeMode s' + AppEvent () -> ping s' >> continue s' + VtyEvent ev' -> continue $ + case progMode s of + StopwatchMode -> stopwatchEvent s' ev' + CountdownMode -> countdownEvent s' ev' + _ -> continue s' + +changeMode :: ProgState -> ProgState +changeMode s = s + { progMode = case progMode s of + StopwatchMode -> CountdownMode + CountdownMode -> StopwatchMode + } + +ping :: ProgState -> EventM () () +ping s = void $ liftIO $ forkIO $ do + threadDelay 100000 + writeBChan (channel s) () + +stopwatchEvent + :: ProgState + -> Event + -> ProgState +stopwatchEvent s (EvKey (KChar ' ') []) = let + t = currentTime s + sw = stopwatch s + sw' = if stopwatchIsRunning sw + then stopStopwatchAt t sw + else startStopwatchAt t sw + in s { stopwatch = sw' } +stopwatchEvent s (EvKey (KChar 'l') []) = let + t = currentTime s + sw = stopwatch s + sw' = newLapAt t sw + in s { stopwatch = sw' } +stopwatchEvent s (EvKey (KChar 'r') []) = + s { stopwatch = newStopwatch } +stopwatchEvent s _ = s + +countdownEvent + :: ProgState + -> Event + -> ProgState +countdownEvent s ev = case ev of + EvKey (KChar 'n') [] -> newCd s + EvKey KUp [] -> prevCd s + EvKey KDown [] -> nextCd s + EvKey (KChar ' ') [] -> startStopCd s + EvKey (KChar 'r') [] -> resetCd s + EvKey (KChar 'R') [] -> resetCds s + EvKey KDel [] -> deleteCd s + EvKey (KChar 'd') [] -> adjustCd day s + EvKey (KChar 'D') [] -> adjustCd (-day) s + EvKey (KChar 'h') [] -> adjustCd hour s + EvKey (KChar 'H') [] -> adjustCd (-hour) s + EvKey (KChar 'm') [] -> adjustCd minute s + EvKey (KChar 'M') [] -> adjustCd (-minute) s + EvKey (KChar 's') [] -> adjustCd second s + EvKey (KChar 'S') [] -> adjustCd (-second) s + _ -> s + +newCd :: ProgState -> ProgState +newCd s = s + { countdowns = newCountdown 0 : cds + , countdownSel = Just 0 + } where cds = countdowns s + +prevCd :: ProgState -> ProgState +prevCd s = s + { countdownSel = case countdownSel s of + Just 0 -> Nothing + Just n -> Just $ pred n + Nothing -> if null $ countdowns s + then Nothing + else Just $ pred $ length $ countdowns s + } + +nextCd :: ProgState -> ProgState +nextCd s = s + { countdownSel = case countdownSel s of + Nothing -> Just 0 + Just n -> let n' = succ n + in if n' >= length (countdowns s) + then Nothing + else Just n' + } + +startStopCd :: ProgState -> ProgState +startStopCd s = let + t = currentTime s + in updateCd + (\cd -> if countdownIsRunning cd + then stopCountdownAt t cd + else startCountdownAt t cd) + s + +resetCd :: ProgState -> ProgState +resetCd = updateCd $ \cd -> let + l = countdownLength cd + in newCountdown l + +resetCds :: ProgState -> ProgState +resetCds s = s + { countdowns = [] + , countdownSel = Nothing + } + +deleteCd :: ProgState -> ProgState +deleteCd s = s + { countdowns = foldr + (\(i, cd) cds -> if Just i == countdownSel s + then cds + else cd : cds) + [] + (zip [0..] $ countdowns s) + , countdownSel = Nothing + } + +adjustCd :: NominalDiffTime -> ProgState -> ProgState +adjustCd dt = over (sets updateCd . countdownLengthL) $ + max 0 . (+dt) + +updateCd :: (Countdown -> Countdown) -> ProgState -> ProgState +updateCd f s = s + { countdowns = map + (\(i, cd) -> if Just i == countdownSel s + then f cd + else cd) + (zip [0..] $ countdowns s) + } + +day :: NominalDiffTime +day = hour * 24 + +hour :: NominalDiffTime +hour = minute * 60 + +minute :: NominalDiffTime +minute = second * 60 + +second :: NominalDiffTime +second = 1 + +-- jl diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,52 @@ +{- + +timeutils + +Copyright (C) 2019 Jonathan Lamothe + + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +-} + +module Main where + +import Brick.BChan (writeBChan) +import Brick.Main (App (..), customMain, neverShowCursor) +import Graphics.Vty (mkVty) +import Graphics.Vty.Config (defaultConfig) +import Control.Monad (void) + +import Logic +import Types +import UI + +app :: App ProgState () () +app = App + { appDraw = draw + , appChooseCursor = neverShowCursor + , appHandleEvent = handleEvent + , appStartEvent = return + , appAttrMap = mkAttrMap + } + +main :: IO () +main = do + s <- newProgState + writeBChan (channel s) () + let buildVty = mkVty defaultConfig + vty <- buildVty + void $ customMain vty buildVty (Just $ channel s) app s + +-- jl diff --git a/app/Types.hs b/app/Types.hs new file mode 100644 --- /dev/null +++ b/app/Types.hs @@ -0,0 +1,59 @@ +{- + +timeutils + +Copyright (C) 2019 Jonathan Lamothe + + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +-} + +module Types + ( ProgState (..) + , ProgMode (..) + , newProgState + ) where + +import Brick.BChan (BChan, newBChan) +import Data.Time (UTCTime, getCurrentTime) + +import Data.Time.Utils + +data ProgState = ProgState + { currentTime :: UTCTime + , stopwatch :: Stopwatch + , countdowns :: [Countdown] + , progMode :: ProgMode + , countdownSel :: Maybe Int + , channel :: BChan () + } + +data ProgMode = StopwatchMode | CountdownMode + deriving (Eq, Show) + +newProgState :: IO ProgState +newProgState = do + t <- getCurrentTime + chan <- newBChan 10 + return ProgState + { currentTime = t + , stopwatch = newStopwatch + , countdowns = [] + , progMode = StopwatchMode + , countdownSel = Nothing + , channel = chan + } + +-- jl diff --git a/app/UI.hs b/app/UI.hs new file mode 100644 --- /dev/null +++ b/app/UI.hs @@ -0,0 +1,95 @@ +{- + +timeutils + +Copyright (C) 2019 Jonathan Lamothe + + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +-} + +module UI (draw, mkAttrMap) where + +import Brick.AttrMap (AttrMap, AttrName, attrMap, attrName) +import Brick.Types (Widget) +import Brick.Util (fg, on) +import Brick.Widgets.Center (center) +import Brick.Widgets.Core (hBox, str, vBox, withAttr) +import qualified Graphics.Vty.Attributes as A + +import Data.Time.Utils +import Types + +draw :: ProgState -> [Widget ()] +draw s = [center $ case progMode s of + StopwatchMode -> stopwatchW s + CountdownMode -> countdownsW s] + +mkAttrMap :: ProgState -> AttrMap +mkAttrMap _ = attrMap + (A.green `on` A.black) + [ ( titleAttr + , A.currentAttr `A.withStyle` (A.bold + A.reverseVideo) + ) + , ( labelAttr + , A.currentAttr `A.withStyle` A.bold + ) + , ( completedAttr + , fg A.red `A.withStyle` A.bold + ) + ] + +stopwatchW :: ProgState -> Widget () +stopwatchW s = vBox $ + [ withAttr titleAttr $ str "Stopwatch" + , hBox + [ withAttr labelAttr $ str "Total time: " + , str $ humanNDT $ totalStopwatchTimeAt t sw + ] + , withAttr labelAttr $ str "Laps:" + ] ++ map (str . humanNDT) (allLapsAt t sw) + where + t = currentTime s + sw = stopwatch s + +countdownsW :: ProgState -> Widget () +countdownsW s = vBox $ + withAttr titleAttr (str "Countdowns") : + if null cds + then [str "(no countdowns)"] + else map (uncurry display) cds + where + t = currentTime s + cds = zip [0..] $ countdowns s + display i cd = let + selected = countdownSel s == Just i + left = str $ if selected then ">" else " " + right = str $ if selected then "<" else " " + subW = str $ humanNDT $ timeRemainingAt t cd + mainW = if countdownIsCompletedAt t cd + then withAttr completedAttr subW + else subW + in hBox [left, mainW, right] + +titleAttr :: AttrName +titleAttr = attrName "title" + +labelAttr :: AttrName +labelAttr = attrName "label" + +completedAttr :: AttrName +completedAttr = attrName "completed" + +-- jl diff --git a/src/Data/Time/Utils.hs b/src/Data/Time/Utils.hs new file mode 100644 --- /dev/null +++ b/src/Data/Time/Utils.hs @@ -0,0 +1,611 @@ +{- | + +timeutils + +Copyright (C) 2019 Jonathan Lamothe + + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +-} + +module Data.Time.Utils ( + -- * Types + Timer (..), + TimeParts (..), + Countdown (..), + Stopwatch (..), + -- * Lenses + -- ** Timer Lenses + timerOffsetL, + timerStartTimeL, + -- ** TimeParts Lenses + tpDaysL, + tpHoursL, + tpMinutesL, + tpSecondsL, + tpMillisL, + -- ** Countdown Lenses + countdownLengthL, + countdownTimerL, + -- ** Stopwatch Lenses + stopwatchTimerL, + stopwatchLapsL, + -- * Constructors + newTimer, + newTimeParts, + newCountdown, + newStopwatch, + -- * Impure Functions + -- ** Timer Functions + startTimer, + stopTimer, + timeElapsed, + -- ** Countdown Functions + startCountdown, + stopCountdown, + timeRemaining, + countdownIsCompleted, + -- ** Stopwatch Functions + startStopwatch, + stopStopwatch, + newLap, + currentLap, + allLaps, + totalStopwatchTime, + -- * Pure Functions + decomposeNDT, + composeNDT, + humanNDT, + -- ** Timer Functions + timerIsRunning, + timerIsStarted, + startTimerAt, + stopTimerAt, + timeElapsedAt, + -- ** Countdown Functions + countdownIsRunning, + countdownIsStarted, + startCountdownAt, + stopCountdownAt, + timeRemainingAt, + countdownIsCompletedAt, + -- ** Stopwatch Functions + stopwatchIsRunning, + stopwatchIsStarted, + startStopwatchAt, + stopStopwatchAt, + newLapAt, + currentLapAt, + allLapsAt, + totalStopwatchTimeAt +) where + +import Data.Maybe (isJust, isNothing) +import Data.Time.Clock + ( NominalDiffTime + , UTCTime + , diffUTCTime + , getCurrentTime + ) +import Lens.Micro (Lens', lens) + +-- | A type that keeps track of the passage of time +data Timer = Timer + { timerOffset :: NominalDiffTime + -- ^ The amount of time previously logged + , timerStartTime :: Maybe UTCTime + -- ^ The time the 'Timer' was last started ('Nothing' if not + -- currently running) + } deriving (Eq, Show) + +-- | Lens for the 'timerOffset' attribute +timerOffsetL :: Lens' Timer NominalDiffTime +timerOffsetL = lens timerOffset $ + \t o -> t { timerOffset = o } + +-- | Lens for the 'timerStartTime' attribute +timerStartTimeL :: Lens' Timer (Maybe UTCTime) +timerStartTimeL = lens timerStartTime $ + \t st -> t { timerStartTime = st } + +-- | Represents a 'NominalDiffTime' broken down into days, hours, +-- minutes, seconds and milliseconds +data TimeParts = TimeParts + { tpDays :: Int + -- ^ The number of days + , tpHours :: Int + -- ^ The number of hours + , tpMinutes :: Int + -- ^ The number of minutes + , tpSeconds :: Int + -- ^ The number of seconds + , tpMillis :: Int + -- ^ The number of milliseconds + } deriving (Eq, Show) + +-- | Lens for the 'tpDays' attribute +tpDaysL :: Lens' TimeParts Int +tpDaysL = lens tpDays $ + \tp d -> tp { tpDays = d } + +-- | Lens for the 'tpHours' attribute +tpHoursL :: Lens' TimeParts Int +tpHoursL = lens tpHours $ + \tp h -> tp { tpHours = h } + +-- | Lens for the 'tpMinutes' attribute +tpMinutesL :: Lens' TimeParts Int +tpMinutesL = lens tpMinutes $ + \tp m -> tp { tpMinutes = m } + +-- | Lens for the 'tpSeconds' attribute +tpSecondsL :: Lens' TimeParts Int +tpSecondsL = lens tpSeconds $ + \tp s -> tp { tpSeconds = s } + +-- | Lens for the 'tpMillis' attribute +tpMillisL :: Lens' TimeParts Int +tpMillisL = lens tpMillis $ + \tp ms -> tp { tpMillis = ms } + +-- | Represents a timed countdown +data Countdown = Countdown + { countdownLength :: NominalDiffTime + -- ^ The length of time + , countdownTimer :: Timer + -- ^ The timer which runs the 'Countdown' + } deriving (Eq, Show) + +-- | Lens for the 'countdownLength' attribute +countdownLengthL :: Lens' Countdown NominalDiffTime +countdownLengthL = lens countdownLength $ + \cd l -> cd { countdownLength = l } + +-- | Lens for the 'countdownTimer' attribute +countdownTimerL :: Lens' Countdown Timer +countdownTimerL = lens countdownTimer $ + \cd t -> cd { countdownTimer = t } + +-- | Tracks the time of multiple laps +data Stopwatch = Stopwatch + { stopwatchTimer :: Timer + -- ^ The 'Timer' for the current lap + , stopwatchLaps :: [NominalDiffTime] + -- ^ The times of previous laps (most recent first) + } deriving (Eq, Show) + +-- | Lens for the 'stopwatchTimer' attribute +stopwatchTimerL :: Lens' Stopwatch Timer +stopwatchTimerL = lens stopwatchTimer $ + \sw t -> sw { stopwatchTimer = t } + +-- | Lens for the 'stopwatchLaps' attribute +stopwatchLapsL :: Lens' Stopwatch [NominalDiffTime] +stopwatchLapsL = lens stopwatchLaps $ + \sw l -> sw { stopwatchLaps = l } + +-- | New instance of a 'Timer' +newTimer :: Timer +newTimer = Timer 0 Nothing + +-- | New instance of a 'TimeParts' value +newTimeParts :: TimeParts +newTimeParts = TimeParts 0 0 0 0 0 + +-- | New instance of a 'Countdown' +newCountdown + :: NominalDiffTime + -- ^ The time length + -> Countdown +newCountdown l = Countdown l newTimer + +-- | New instance of a stopwatch +newStopwatch :: Stopwatch +newStopwatch = Stopwatch + { stopwatchTimer = newTimer + , stopwatchLaps = [] + } + +-- | Starts a 'Timer' +startTimer + :: Timer + -- ^ The 'Timer' being started + -> IO Timer + -- ^ The modified 'Timer' +startTimer timer = startTimerAt + <$> getCurrentTime + <*> return timer + +-- | Stops a 'Timer' +stopTimer + :: Timer + -- ^ The 'Timer' being stopped + -> IO Timer + -- ^ The modified 'Timer' +stopTimer timer = stopTimerAt + <$> getCurrentTime + <*> return timer + +-- | Calculates the amount of time elapsed on a 'Timer' +timeElapsed + :: Timer + -- ^ The 'Timer' being checked + -> IO NominalDiffTime + -- ^ The amount of time elapsed +timeElapsed timer = timeElapsedAt + <$> getCurrentTime + <*> return timer + +-- | Starts a 'Countdown' +startCountdown + :: Countdown + -- ^ The 'Countdown' being started + -> IO Countdown + -- ^ Returns the modified 'Countdown' +startCountdown countdown = startCountdownAt + <$> getCurrentTime + <*> return countdown + +-- | Stops a 'Countdown' +stopCountdown + :: Countdown + -- ^ The 'Countdown' being stopped + -> IO Countdown + -- ^ Returns the modified 'Countdown' +stopCountdown countdown = stopCountdownAt + <$> getCurrentTime + <*> return countdown + +-- | Calculates the amount of time remaining in a 'Countdown' +timeRemaining + :: Countdown + -- ^ The 'Countdown' being checked + -> IO NominalDiffTime + -- ^ The amount of time remaining +timeRemaining countdown = timeRemainingAt + <$> getCurrentTime + <*> return countdown + +-- | Determines whether or not a 'Countdown' has completed. +countdownIsCompleted + :: Countdown + -- ^ The 'Countdown' being checked + -> IO Bool + -- ^ Returns 'True' if the 'Countdown' has completed, 'False' + -- otherwise +countdownIsCompleted countdown = countdownIsCompletedAt + <$> getCurrentTime + <*> return countdown + +-- | Starts a 'Stopwatch' +startStopwatch + :: Stopwatch + -- ^ The 'Stopwatch' being started + -> IO Stopwatch + -- ^ Returns the modified 'Stopwatch' +startStopwatch stopwatch = startStopwatchAt + <$> getCurrentTime + <*> return stopwatch + +-- | Stops a 'Stopwatch' +stopStopwatch + :: Stopwatch + -- ^ The 'Stopwatch' being stopped + -> IO Stopwatch + -- ^ Returns the modified 'Stopwatch' +stopStopwatch stopwatch = stopStopwatchAt + <$> getCurrentTime + <*> return stopwatch + +-- | Starts a new lap +newLap + :: Stopwatch + -- ^ The 'Stopwatch' being modified + -> IO Stopwatch + -- ^ Returns the 'Stopwatch' being modified +newLap stopwatch = newLapAt + <$> getCurrentTime + <*> return stopwatch + +-- | Returns the time of the current lap from a 'Stopwatch' +currentLap + :: Stopwatch + -- ^ The 'Stopwatch' being checked + -> IO NominalDiffTime + -- ^ Returns the amount of time elapsed in the current lap +currentLap stopwatch = currentLapAt + <$> getCurrentTime + <*> return stopwatch + +-- | Returns the lap times for a 'Stopwatch' +allLaps + :: Stopwatch + -- ^ The 'Stopwatch' being checked + -> IO [NominalDiffTime] + -- ^ Returns the lap times (most recent first) +allLaps stopwatch = allLapsAt + <$> getCurrentTime + <*> return stopwatch + +-- | Calculates the total run time of a 'Stopwatch' +totalStopwatchTime + :: Stopwatch + -- ^ The 'Stopwatch' being checked + -> IO NominalDiffTime + -- ^ Returns the total run time +totalStopwatchTime stopwatch = totalStopwatchTimeAt + <$> getCurrentTime + <*> return stopwatch + +-- | Converts a 'NominalDiffTime' to a 'TimeParts' value +decomposeNDT :: NominalDiffTime -> TimeParts +decomposeNDT t = TimeParts + { tpDays = days + , tpHours = hours + , tpMinutes = minutes + , tpSeconds = seconds + , tpMillis = millis + } + where + days = h `quot` 24 + hours = h - days * 24 + minutes = m - h * 60 + seconds = s - m * 60 + millis = ms - s * 1000 + h = m `quot` 60 + m = s `quot` 60 + s = ms `quot` 1000 + ms = floor $ t * 1000 + +-- | Converts a 'TimeParts' value to a 'NominalDiffTime' +composeNDT :: TimeParts -> NominalDiffTime +composeNDT tp = fromInteger millis / 1000 + where + millis = seconds * 1000 + toInteger (tpMillis tp) + seconds = minutes * 60 + toInteger (tpSeconds tp) + minutes = hours * 60 + toInteger (tpMinutes tp) + hours = toInteger (tpDays tp) * 24 + toInteger (tpHours tp) + +-- | Converts a 'NominalDiffTime' into a more human-readable format +humanNDT :: NominalDiffTime -> String +humanNDT t = sign ++ d ++ h ++ m ++ s ++ ms + where + sign = if t < 0 then "-" else "" + d = show (tpDays tp) ++ "d " + h = fix 2 (tpHours tp) ++ "h " + m = fix 2 (tpMinutes tp) ++ "m " + s = fix 2 (tpSeconds tp) ++ "." + ms = fix 3 (tpMillis tp) ++ "s" + tp = decomposeNDT $ abs t + fix n x = let + str = show x + slen = length str + plen = n - slen + pad = replicate plen '0' + in pad ++ str + +-- | Determines whether or not a 'Timer' is running +timerIsRunning + :: Timer + -- ^ The 'Timer' being checked + -> Bool +timerIsRunning = isJust . timerStartTime + +-- | Determines whether or not a 'Timer' has been started (even if it +-- is currently stopped) +timerIsStarted + :: Timer + -- ^ The 'Timer' being checked + -> Bool + -- ^ 'True' if the timer has been started, 'False' otherwise +timerIsStarted timer = timerIsRunning timer || + timerOffset timer /= 0 + +-- | Starts a 'Timer' from a given time +startTimerAt + :: UTCTime + -- ^ The current time + -> Timer + -- ^ The 'Timer' being started + -> Timer + -- ^ The modified 'Timer' +startTimerAt t timer + | isNothing (timerStartTime timer) = + timer { timerStartTime = Just t } + | otherwise = timer + +-- | Stops a 'Timer' from a given time +stopTimerAt + :: UTCTime + -- ^ The current time + -> Timer + -- ^ The 'Timer' being stopped + -> Timer + -- ^ The modified 'Timer' +stopTimerAt t timer = newTimer { timerOffset = offset } + where offset = timeElapsedAt t timer + +-- | Calculates the amount of time elapsed on a 'Timer' from a given +-- time +timeElapsedAt + :: UTCTime + -- ^ The current time + -> Timer + -- ^ The 'Timer' being checked + -> NominalDiffTime + -- ^ The amount of time elapsed +timeElapsedAt t timer = case timerStartTime timer of + Nothing -> timerOffset timer + Just st -> timerOffset timer + diffUTCTime t st + +-- | Determines whether or not a 'Countdown' is running +countdownIsRunning + :: Countdown + -- ^ The 'Countdown' being checked + -> Bool + -- ^ 'True' if running, 'False' otherwise +countdownIsRunning countdown = timerIsRunning timer + where timer = countdownTimer countdown + +-- | Determines whether or not a 'Countdown' has been started (even if +-- subsequently stopped) +countdownIsStarted + :: Countdown + -- ^ The 'Countdown' being checked + -> Bool + -- ^ 'True' if it has been started, 'False' otherwise +countdownIsStarted countdown = timerIsStarted timer + where timer = countdownTimer countdown + +-- | Starts a 'Countdown' using a given time +startCountdownAt + :: UTCTime + -- ^ The current time + -> Countdown + -- ^ The 'Countdown' being started + -> Countdown + -- ^ The modified 'Countdown' +startCountdownAt t countdown = + countdown { countdownTimer = timer' } + where + timer' = startTimerAt t timer + timer = countdownTimer countdown + +-- | Stops a 'Countdown' using a given time +stopCountdownAt + :: UTCTime + -- ^ The current time + -> Countdown + -- ^ The 'Countdown' being stopped + -> Countdown + -- ^ The modified 'Countdown' +stopCountdownAt t countdown = + countdown { countdownTimer = timer' } + where + timer' = stopTimerAt t timer + timer = countdownTimer countdown + +-- | Calculates the amount of time remaining in a 'Countdown' at a +-- given time +timeRemainingAt + :: UTCTime + -- ^ The current time + -> Countdown + -- ^ The 'Countdown' being checked + -> NominalDiffTime + -- ^ The amount of time remaining +timeRemainingAt t countdown = len - timeElapsedAt t timer + where + len = countdownLength countdown + timer = countdownTimer countdown + +-- | Determines if a 'Countdown' is completed at a given time +countdownIsCompletedAt + :: UTCTime + -- ^ The current time + -> Countdown + -- ^ The 'Countdown' being checked + -> Bool + -- ^ Returns 'True' if the 'Countdown' has completed, 'False' + -- otherwise. +countdownIsCompletedAt t countdown = + timeRemainingAt t countdown <= 0 + +-- | Determines whether or not a 'Stopwatch' is running +stopwatchIsRunning + :: Stopwatch + -- ^ The 'Stopwatch' being checked + -> Bool + -- ^ 'True' if the 'Stopwatch' is running, 'False' otherwise +stopwatchIsRunning = timerIsRunning . stopwatchTimer + +-- | Determines whether or not a stopwatch has been started (even if +-- subsequently stopped) +stopwatchIsStarted + :: Stopwatch + -- ^ The 'Stopwatch' being checked + -> Bool + -- ^ 'True' if started, 'False' otherwise +stopwatchIsStarted = (/= newStopwatch) + +-- | Starts a 'Stopwatch' at a given time +startStopwatchAt + :: UTCTime + -- ^ The current time + -> Stopwatch + -- ^ The 'Stopwatch' being started + -> Stopwatch + -- ^ The modified 'Stopwatch' +startStopwatchAt t stopwatch = stopwatch { stopwatchTimer = timer } + where timer = startTimerAt t $ stopwatchTimer stopwatch + +-- | Stops a 'Stopwatch' at a given time +stopStopwatchAt + :: UTCTime + -- ^ The current time + -> Stopwatch + -- ^ The 'Stopwatch' being stopped + -> Stopwatch + -- ^ The modified 'Stopwatch' +stopStopwatchAt t stopwatch = stopwatch { stopwatchTimer = timer } + where timer = stopTimerAt t $ stopwatchTimer stopwatch + +-- | Starts a new lap at a given time +newLapAt + :: UTCTime + -- ^ The currebt time + -> Stopwatch + -- ^ The 'Stopwatch' being modified + -> Stopwatch + -- ^ The modified 'Stopwatch' +newLapAt t stopwatch = Stopwatch + { stopwatchTimer = startTimerAt t newTimer + , stopwatchLaps = allLapsAt t stopwatch + } + +-- | Determines the length of the current lap given a time +currentLapAt + :: UTCTime + -- ^ The current time + -> Stopwatch + -- ^ The 'Stopwatch' being checkwd + -> NominalDiffTime + -- ^ The elapsed time for the current lap +currentLapAt t stopwatch = timeElapsedAt t timer + where timer = stopwatchTimer stopwatch + +-- | Returns the lap times from a 'Stopwatch' given a time +allLapsAt + :: UTCTime + -- ^ The current time + -> Stopwatch + -- ^ The 'Stopwatch' being checked + -> [NominalDiffTime] + -- ^ The lap times (most recent first) +allLapsAt t stopwatch = currentLapAt t stopwatch : + stopwatchLaps stopwatch + +-- | Calculates the total runtime of a 'Stopwatch' given a time +totalStopwatchTimeAt + :: UTCTime + -- ^ The current time + -> Stopwatch + -- ^ The 'Stopwatch' being checked + -> NominalDiffTime + -- ^ The total run time +totalStopwatchTimeAt t stopwatch = + sum $ allLapsAt t stopwatch + +-- jl diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,493 @@ +{- + +timeutils + +Copyright (C) 2019 Jonathan Lamothe + + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +-} + +import Test.Hspec (Spec, context, describe, hspec, it, shouldBe) + +import Data.Time.Clock + ( NominalDiffTime + , UTCTime + , addUTCTime + , getCurrentTime + ) + +import Data.Time.Utils + +main :: IO () +main = hspec $ do + timeElapsedAtSpec + startTimerAtSpec + stopTimerAtSpec + decomposeNDTSpec + composeNDTSpec + timerIsRunningSpec + timerIsStartedSpec + timeRemainingAtSpec + countdownIsCompletedAtSpec + countdownIsRunningSpec + countdownIsStartedSpec + startCountdownSpec + stopCountdownSpec + currentLapAtSpec + allLapsAtSpec + totalStopwatchTimeAtSpec + stopwatchIsRunningSpec + stopwatchIsStartedSpec + startStopwatchSpec + stopStopwatchSpec + newLapAtSpec + humanNDTSpec + +timeElapsedAtSpec :: Spec +timeElapsedAtSpec = describe "timeElapsedAt" $ do + + context "newTimer" $ + it "should be 0" $ do + t <- getCurrentTime + timeElapsedAt t newTimer `shouldBe` 0 + + context "started, no previous" $ + it "should be 1 minute" $ do + (t, t') <- times 60 + let timer = newTimer { timerStartTime = Just t } + timeElapsedAt t' timer `shouldBe` 60 + + context "stopped, with previous" $ + it "should be 1 minute" $ do + t <- getCurrentTime + let timer = newTimer { timerOffset = 60 } + timeElapsedAt t timer `shouldBe` 60 + + context "started, with previous" $ + it "should be 2 minutes" $ do + (t, t') <- times 60 + let + timer = newTimer + { timerOffset = 60 + , timerStartTime = Just t + } + timeElapsedAt t' timer `shouldBe` 120 + +startTimerAtSpec :: Spec +startTimerAtSpec = describe "startTimerAt" $ do + + context "newTimer" $ + it "should set the start time" $ do + t <- getCurrentTime + let expected = newTimer { timerStartTime = Just t } + startTimerAt t newTimer `shouldBe` expected + + context "already started" $ + it "should not modify the timer" $ do + (t, t') <- times 60 + let timer = newTimer { timerStartTime = Just t } + startTimerAt t' timer `shouldBe` timer + + context "stopped" $ + it "should resume the timer" $ do + t <- getCurrentTime + let + timer = newTimer { timerOffset = 60 } + expected = timer { timerStartTime = Just t } + startTimerAt t timer `shouldBe` expected + +stopTimerAtSpec :: Spec +stopTimerAtSpec = describe "stopTimerAt" $ do + + context "newTimer" $ + it "should not change the timer" $ do + t <- getCurrentTime + stopTimerAt t newTimer `shouldBe` newTimer + + context "stopped timer" $ + it "should not change the timer" $ do + t <- getCurrentTime + let timer = newTimer { timerOffset = 60 } + stopTimerAt t timer `shouldBe` timer + + context "running timer" $ + it "should stop the timer, and calculate the new offset" $ do + (t, t') <- times 60 + let + timer = newTimer + { timerOffset = 60 + , timerStartTime = Just t + } + expected = newTimer { timerOffset = 120 } + stopTimerAt t' timer `shouldBe` expected + +decomposeNDTSpec :: Spec +decomposeNDTSpec = describe "decomposeNDT" $ do + let + days = 1 + hours = days * 24 + 2 + minutes = hours * 60 + 3 + seconds = minutes * 60 + 4 + millis = seconds * 1000 + 5 + time = millis / 1000 + + context "zero" $ + it "should be zero" $ + decomposeNDT 0 `shouldBe` newTimeParts + + context "positive" $ + it "should calculate the time parts" $ let + expected = TimeParts + { tpDays = 1 + , tpHours = 2 + , tpMinutes = 3 + , tpSeconds = 4 + , tpMillis = 5 + } + in decomposeNDT time `shouldBe` expected + + context "negative" $ + it "should calculate the time parts" $ let + expected = TimeParts + { tpDays = -1 + , tpHours = -2 + , tpMinutes = -3 + , tpSeconds = -4 + , tpMillis = -5 + } + in decomposeNDT (-time) `shouldBe` expected + +composeNDTSpec :: Spec +composeNDTSpec = describe "composeNDT" $ + it "should compose correctly" $ let + parts = TimeParts + { tpDays = 1 + , tpHours = 2 + , tpMinutes = 3 + , tpSeconds = 4 + , tpMillis = 5 + } + t = composeNDT parts + in decomposeNDT t `shouldBe` parts + +timerIsRunningSpec :: Spec +timerIsRunningSpec = describe "timerIsRunning" $ do + + context "not running" $ + it "should return False" $ + timerIsRunning newTimer `shouldBe` False + + context "running" $ + it "should return True" $ do + timer <- startTimer newTimer + timerIsRunning timer `shouldBe` True + +timerIsStartedSpec :: Spec +timerIsStartedSpec = describe "timerIsStarted" $ do + + context "newTimer" $ + it "should be False" $ + timerIsStarted newTimer `shouldBe` False + + context "started" $ + it "should be True" $ do + timer <- startTimer newTimer + timerIsStarted timer `shouldBe` True + + context "started, then stopped" $ + it "should be True" $ do + (t, t') <- times 60 + let + timer = startTimerAt t newTimer + timer' = stopTimerAt t' timer + timerIsStarted timer' `shouldBe` True + +timeRemainingAtSpec :: Spec +timeRemainingAtSpec = describe "timeRemainingAt" $ do + + context "not started" $ + it "should be one minute" $ do + t <- getCurrentTime + let countdown = newCountdown 60 + timeRemainingAt t countdown `shouldBe` 60 + + context "started" $ mapM_ + (\(len, dt, expected) -> let + label = "length: " ++ show len ++ + ", elapsed: " ++ show dt + expectation = "should be " ++ show expected + in + context label $ + it expectation $ do + (t, t') <- times dt + let + timer = startTimerAt t newTimer + countdown = Countdown + { countdownLength = len + , countdownTimer = timer + } + timeRemainingAt t' countdown `shouldBe` expected) + -- length, elapsed, expected + [ ( 60, 30, 30 ) + , ( 60, 60, 0 ) + , ( 30, 60, -30 ) + ] + +countdownIsCompletedAtSpec :: Spec +countdownIsCompletedAtSpec = describe "countdownIsCompletedAt" $ do + + context "not started" $ mapM_ + (\(label, dt, expected) -> + context label $ + it ("should be " ++ show expected) $ do + t <- getCurrentTime + let cd = newCountdown dt + countdownIsCompletedAt t cd `shouldBe` expected) + -- label, length, expected + [ ( "negative length", -60, True ) + , ( "zero length", 0, True ) + , ( "posititive length", 60, False ) + ] + + context "started" $ mapM_ + (\(len, dt, expected) -> let + label = "length: " ++ show len ++ + ", elapsed: " ++ show dt + in context label $ + it ("should be " ++ show expected) $ do + t1 <- getCurrentTime + let + t2 = addUTCTime dt t1 + timer = startTimerAt t1 newTimer + countdown = (newCountdown len) { countdownTimer = timer } + countdownIsCompletedAt t2 countdown `shouldBe` expected) + -- length, elapsed, expected + [ ( 60, 0, False ) + , ( 60, 30, False ) + , ( 60, 60, True ) + , ( 0, 0, True ) + , ( 30, 60, True ) + ] + +countdownIsRunningSpec :: Spec +countdownIsRunningSpec = describe "countdownIsRunning" $ do + + context "not running" $ + it "should return False" $ let + countdown = newCountdown 60 + in countdownIsRunning countdown `shouldBe` False + + context "running" $ + it "should return True" $ do + timer <- startTimer newTimer + let countdown = (newCountdown 60) { countdownTimer = timer } + countdownIsRunning countdown `shouldBe` True + +countdownIsStartedSpec :: Spec +countdownIsStartedSpec = describe "countdownIsStarted" $ do + + context "new countdown" $ + it "should be False" $ + countdownIsStarted (newCountdown 60) `shouldBe` False + + context "countdown started" $ + it "should be True" $ do + countdown <- startCountdown $ newCountdown 60 + countdownIsStarted countdown `shouldBe` True + + context "countdown started, then stopped" $ + it "should be True" $ do + (t, t') <- times 30 + let + countdown = startCountdownAt t $ newCountdown 60 + countdown' = stopCountdownAt t' countdown + countdownIsStarted countdown' `shouldBe` True + +startCountdownSpec :: Spec +startCountdownSpec = describe "startCountdown" $ + it "should start the countdown" $ do + let countdown = newCountdown 60 + countdown' <- startCountdown countdown + countdownIsRunning countdown' `shouldBe` True + +stopCountdownSpec :: Spec +stopCountdownSpec = describe "stopCountdown" $ + it "should stop the countdown" $ do + countdown <- startCountdown $ newCountdown 60 + countdown' <- stopCountdown countdown + countdownIsRunning countdown' `shouldBe` False + +currentLapAtSpec :: Spec +currentLapAtSpec = describe "currentLapAt" $ do + + context "newStopwatch" $ + it "should be zero" $ do + t <- getCurrentTime + currentLapAt t newStopwatch ` shouldBe` 0 + + context "running" $ + it "should be 1 minute" $ do + (t, t') <- times 60 + let stopwatch = runningStopwatch t + currentLapAt t' stopwatch `shouldBe` 60 + +allLapsAtSpec :: Spec +allLapsAtSpec = describe "allLapsAt" $ do + + context "newStopwatch" $ + it "should return a lap of zero length" $ do + t <- getCurrentTime + allLapsAt t newStopwatch `shouldBe` [0] + + context "single lap" $ + it "should return a single lap of 1 minute" $ do + (t, t') <- times 60 + let stopwatch = runningStopwatch t + allLapsAt t' stopwatch `shouldBe` [60] + + context "multiple laps" $ + it "should return the lap times" $ do + (t, t') <- times 60 + let + timer = startTimerAt t newTimer + stopwatch = Stopwatch + { stopwatchTimer = timer + , stopwatchLaps = [10, 20, 30] + } + allLapsAt t' stopwatch `shouldBe` [60, 10, 20, 30] + +totalStopwatchTimeAtSpec :: Spec +totalStopwatchTimeAtSpec = describe "totalStopwatchTimeAt" $ do + + context "newStopwatch" $ + it "should be zero" $ do + t <- getCurrentTime + totalStopwatchTimeAt t newStopwatch `shouldBe` 0 + + context "single lap" $ + it "should be 1 minute" $ do + (t, t') <- times 60 + let stopwatch = runningStopwatch t + totalStopwatchTimeAt t' stopwatch `shouldBe` 60 + + context "multiple laps" $ + it "should be 90 seconds" $ do + (t, t') <- times 60 + let + stopwatch = (runningStopwatch t) + { stopwatchLaps = [10, 20] } + totalStopwatchTimeAt t' stopwatch `shouldBe` 90 + +stopwatchIsRunningSpec :: Spec +stopwatchIsRunningSpec = describe "stopwatchIsRunning" $ do + + context "newStopwatch" $ + it "should be False" $ + stopwatchIsRunning newStopwatch `shouldBe` False + + context "running" $ + it "should be True" $ do + t <- getCurrentTime + let stopwatch = runningStopwatch t + stopwatchIsRunning stopwatch `shouldBe` True + +stopwatchIsStartedSpec :: Spec +stopwatchIsStartedSpec = describe "stopwatchIsStarted" $ do + + context "newStopwatch" $ + it "should be False" $ + stopwatchIsStarted newStopwatch `shouldBe` False + + context "started" $ + it "should be True" $ do + (t, t') <- times 60 + let + timer = startTimerAt t newTimer + stopwatch = newStopwatch { stopwatchTimer = timer } + stopwatchIsStarted stopwatch `shouldBe` True + + context "previous laps" $ + it "should be True" $ let + stopwatch = newStopwatch { stopwatchLaps = [60] } + in stopwatchIsStarted stopwatch `shouldBe` True + +startStopwatchSpec = describe "startStopwatch" $ + it "should start the stopwatch" $ do + stopwatch <- startStopwatch newStopwatch + stopwatchIsRunning stopwatch `shouldBe` True + +stopStopwatchSpec = describe "stopStopwatch" $ + it "should stop the Stopwatch" $ do + stopwatch <- startStopwatch newStopwatch + stopwatch' <- stopStopwatch stopwatch + stopwatchIsRunning stopwatch' `shouldBe` False + +newLapAtSpec :: Spec +newLapAtSpec = describe "newLapAt" $ do + + context "newStopwatch" $ + it "should record a zero length lap, and start a new one" $ do + (t, t') <- times 60 + let stopwatch = newLapAt t newStopwatch + allLapsAt t' stopwatch `shouldBe` [60, 0] + + context "running" $ + it "should start a new lap" $ do + (t, t') <- times 60 + let + stopwatch = runningStopwatch t + stopwatch' = newLapAt t' stopwatch + allLapsAt t' stopwatch' `shouldBe` [0, 60] + + context "previous lap" $ + it "should start a new lap" $ do + (t, t') <- times 60 + let + stopwatch = (runningStopwatch t) + { stopwatchLaps = [30] } + stopwatch' = newLapAt t' stopwatch + allLapsAt t' stopwatch' `shouldBe` [0, 60, 30] + +humanNDTSpec :: Spec +humanNDTSpec = describe "humanNDT" $ mapM_ + (\(val, expected) -> + context (show val) $ + it ("should be " ++ expected) $ + humanNDT val `shouldBe` expected) + -- value, expected + [ ( 0, "0d 00h 00m 00.000s" ) + , ( single, "1d 02h 03m 04.005s" ) + , ( double, "11d 12h 13m 14.015s" ) + , ( triple, "11d 12h 13m 14.123s" ) + , ( negative, "-1d 02h 03m 04.005s" ) + ] + where + single = composeNDT $ TimeParts 1 2 3 4 5 + double = composeNDT $ TimeParts 11 12 13 14 15 + triple = composeNDT $ TimeParts 11 12 13 14 123 + negative = -single + +times :: NominalDiffTime -> IO (UTCTime, UTCTime) +times dt = do + t <- getCurrentTime + let t' = addUTCTime dt t + return (t, t') + +runningStopwatch :: UTCTime -> Stopwatch +runningStopwatch t = newStopwatch { stopwatchTimer = timer } + where timer = startTimerAt t newTimer + +-- jl diff --git a/timeutils.cabal b/timeutils.cabal new file mode 100644 --- /dev/null +++ b/timeutils.cabal @@ -0,0 +1,76 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.31.2. +-- +-- see: https://github.com/sol/hpack +-- +-- hash: 9ae94588d222d19f2faf581e2466ad3f9af3ab5702b91bceae56a8a156092153 + +name: timeutils +version: 0.1.0 +synopsis: Time utilities +description: Please see the README on GitHub at +category: Time +homepage: https://github.com/jlamothe/timeutils#readme +bug-reports: https://github.com/jlamothe/timeutils/issues +author: Jonathan Lamothe +maintainer: jlamothe1980@gmail.com +copyright: Jonathan Lamothe +license: GPL-3 +license-file: LICENSE +build-type: Simple +extra-source-files: + README.md + ChangeLog.md + +source-repository head + type: git + location: https://github.com/jlamothe/timeutils + +library + exposed-modules: + Data.Time.Utils + other-modules: + Paths_timeutils + hs-source-dirs: + src + build-depends: + base >=4.7 && <5 + , microlens >=0.4.10 && <0.5 + , time >=1.8.0.2 && <1.9 + default-language: Haskell2010 + +executable timeutils + main-is: Main.hs + other-modules: + Logic + Types + UI + Paths_timeutils + hs-source-dirs: + app + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + base >=4.7 && <5 + , brick >=0.47.1 && <0.48 + , microlens >=0.4.10 && <0.5 + , time >=1.8.0.2 && <1.9 + , timeutils + , vty + default-language: Haskell2010 + +test-suite timeutils-test + type: exitcode-stdio-1.0 + main-is: Spec.hs + other-modules: + Paths_timeutils + hs-source-dirs: + test + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + base >=4.7 && <5 + , hspec >=2.6.1 && <2.7 + , microlens >=0.4.10 && <0.5 + , time >=1.8.0.2 && <1.9 + , timeutils + default-language: Haskell2010