diff options
author | Adam House <a@context.town> | 2024-06-21 08:23:19 -0500 |
---|---|---|
committer | Adam House <a@context.town> | 2024-06-21 08:28:03 -0500 |
commit | d5b2466c4340ca90acb0a165b4dd96638cb7b2b1 (patch) | |
tree | 41e032250d5918331d86fd76d06233fc132a06e3 |
-rw-r--r-- | .gitignore | 3 | ||||
-rw-r--r-- | COPYING | 674 | ||||
-rw-r--r-- | Makefile | 32 | ||||
-rw-r--r-- | README.md | 56 | ||||
-rw-r--r-- | errs/errors.ha | 58 | ||||
-rw-r--r-- | leddy.1.scd | 89 | ||||
-rw-r--r-- | leddy.5.scd | 140 | ||||
-rw-r--r-- | ledger/detail.ha | 31 | ||||
-rw-r--r-- | ledger/entry.ha | 164 | ||||
-rw-r--r-- | ledger/exchange_rates.ha | 158 | ||||
-rw-r--r-- | ledger/ledger.ha | 149 | ||||
-rw-r--r-- | ledger/parse.ha | 109 | ||||
-rw-r--r-- | main.ha | 223 | ||||
-rw-r--r-- | reports/reports.ha | 166 | ||||
-rw-r--r-- | reports/totals.ha | 92 |
15 files changed, 2144 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e97c7d4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +leddy +leddy.1 +leddy.5 @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..89ba290 --- /dev/null +++ b/Makefile @@ -0,0 +1,32 @@ +VERSION=0.1.1 +PREFIX?=/usr/local +BINDIR?=$(PREFIX)/bin +MANDIR?=$(PREFIX)/share/man + +.DEFAULT_GOAL=all + +leddy: + hare build + +leddy.1: leddy.1.scd + scdoc < $< > $@ + +leddy.5: leddy.5.scd + scdoc < $< > $@ + +all: leddy leddy.1 leddy.5 + +clean: + rm leddy leddy.1 leddy.5 + +install: all + mkdir -p $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man1 + mkdir -p $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man5 + install -m755 leddy $(DESTDIR)$(BINDIR)/leddy + install -m644 leddy.1 $(DESTDIR)$(MANDIR)/man1/leddy.1 + install -m644 leddy.5 $(DESTDIR)$(MANDIR)/man5/leddy.5 + +uninstall: + rm -f $(DESTDIR)$(BINDIR)/leddy + rm -f $(DESTDIR)$(MANDIR)/man1/leddy.1 + rm -f $(DESTDIR)$(MANDIR)/man5/leddy.5 diff --git a/README.md b/README.md new file mode 100644 index 0000000..c2f4a9b --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# leddy + +minimal plain text accounting tool + +`leddy` is a [plain text accounting](https://plaintextaccounting.org/) tool, +inspired by similar tools like [ledger](https://ledger-cli.org/), +[hledger](https://hledger.org/) and [beancount](https://beancount.github.io/). +It is implemented in [Hare](https://harelang.org) with an emphasis on parsing +speed, specificity and correctness, and is geared toward the accounting needs +of individuals. (That's somewhat by necessity because it is a young and modest +project.) + +`leddy` uses a unique ledger format that differs slightly from other plain text +accounting tools. Most notably, no row contents are inferred, so leaving an +amount blank to auto-balance it with the prior row is not allowed. Other +nuances, largely implemented at the author's preference, may exist; consulting +the man pages is recommended, but overall it should not feel intimidating to +those familiar with other plain text accounting tools. + +An example ledger file exists in the repo. + +# Installation + +Requires a working [Hare](https://harelang.org) toolchain. `scdoc` is optional, +but required if you want the man pages. + +``` +make +sudo make install +``` + +# Usage + +* Trial balance: + `leddy -f /path/to/ledgerfile tb` + +* Balance sheet (by default, equity and zero-balance accounts omitted): + `leddy -f /path/to/ledgerfile bs` + +* Balance sheet (traditional): + `leddy -f /path/to/ledgerfile -qz bs` + +* Income statement for 2024: + `leddy -f /path/to/ledgerfile -b 2024-01-01 -e 2024-12-31 is` + +* Balance sheet on 10-31-2023: + `leddy -f /path/to/ledgerfile -e 2023-10-31 bs` + +* Summary of currency conversion rates observed in Jan 2022: + `leddy -f /path/to/ledgerfile -b 2022-01-01 -e 2022-01-31 fx` + +# Contributing + +This is a modest project with modest goals, but patchsets are welcome. The goal +of this project is not to create a feature-competitive replacement for any of +the projects mentioned above. Emphasis is on simplicity and comprehensibility. diff --git a/errs/errors.ha b/errs/errors.ha new file mode 100644 index 0000000..fe6dd97 --- /dev/null +++ b/errs/errors.ha @@ -0,0 +1,58 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +// An error which indicates the desired account was not found. +export type notfound = !void; + +// An error which indicates the desired operation is not possible. +export type invalid = !void; + +// An error indicating inconsistent precision was used between multiple entries +// with the same currency. +export type precision = void; + +// An error which indicates the given entry is imbalanced. +export type imbalanced = !void; + +// An error which indicates the given entry is conceptually valid, but cannot +// be parsed due to an unsupported case. +export type unsupported = !void; + +// An error which indicates a filesystem access problem. +export type filesystem = !void; + +// Encapsulation of all the above. +export type error = ( + notfound | + invalid | + precision | + imbalanced | + unsupported | + filesystem +); + +export fn strerror(e: error) str = { + match (e) { + case notfound => return "not found"; + case invalid => return "invalid"; + case precision => { + return "inconsistent precision with same currency"; + }; + case imbalanced => return "imbalanced entry"; + case unsupported => return "unsupported entry"; + case filesystem => return "filesystem access error"; + }; +}; diff --git a/leddy.1.scd b/leddy.1.scd new file mode 100644 index 0000000..045a491 --- /dev/null +++ b/leddy.1.scd @@ -0,0 +1,89 @@ +leddy(1) + +# NAME + +*leddy* - plain text accounting tool + +# DESCRIPTION + +*leddy* is a read-only plain text accounting tool. It parses text files +containing financial transactions, as in a general ledger, and aggregates or +searches through them in varying ways depending on the passed command. For +safety, because it has the potential to parse sensitive and precise financial +data, *leddy* never modifies any files. + +*leddy* expects a file format that differs somewhat from that of other plain +text accounting tools. The file format is documented in *leddy*(5). + +# USAGE + +*leddy* expects a number of flags followed by a command. All flags must precede +the command. + +The available flags are as follows: + +*-b* _date_ + Ignore entries prior to the provided date. Date must be provided in + ISO 8601 (YYYY-MM-DD) format. Default is _null_. + +*-e* _date_ + Ignore entries after the provided date. Date must be provided in + ISO 8601 (YYYY-MM-DD) format. Default is _null_. + +*-f* _/path/to/ledgerfile_ + The ledger file to parse. This is always required. No default. + +*-q* + Include Equity accounts in balance sheet reports. Has no effect on + other reports. + +*-z* + Include zero balance accounts. By default, these are hidden, except on + trial balance reports. + +The available commands are as follows: + +*tb* + Print a trial balance report. This is a report showing the balances of + all accounts, and can be used for purposes including a general overview + of all activity in a given time, verifying that the ledger balances, + etc. + +*bs* + Print a balance sheet report. This is a report showing the balances of + each asset, liability and equity account at a given point in time. It + typically does not make conceptual sense to pass a *-b* parameter to a + balance sheet report, because all transactions prior to a given point + in time should be incorporated into a balance sheet. + + For financial reporting, balance sheets contain equity accounts. For + most people, however, equity accounts are not terribly useful, so + *leddy* does not show them by default on balance sheets. You can pass a + flag (as indicated in the prior section) to show these if you wish. + +*is* + Print an income statement report. This is a report showing the activity + of each income and expense account between two given points in time. + *leddy* produces these in a standard way without deviation from typical + accounting principles. + + Users unfamiliar with double-entry accounting should note that income + details are typically entered as credits, and expenses are typically + debits. Ordinary income looks negative on a balance sheet, and *leddy* + does not hide this from the user. + +*fx* + Print an exchange rates report. This is a report showing the exchange + rates that are implied to exist between currencies or commodities when + multiple currencies appear in the same entry. For example, if you write + an entry that debits 10 USD from an account and credits 15 CAD to + another, *leddy* assumes the entry is meant to balance and an exchange + rate of 1.5 CAD per USD is implied. + + The report only prints the final implied exchange rate between each + pair on each date. If multiple exchange rates were implicitly created + for each day, only the one from the last such entry on that date is + shown on the report. + + See *leddy*(5) for more details on using *leddy* with multiple + currencies. diff --git a/leddy.5.scd b/leddy.5.scd new file mode 100644 index 0000000..d7bed19 --- /dev/null +++ b/leddy.5.scd @@ -0,0 +1,140 @@ +leddy(5) + +# NAME + +*leddy* - file format and syntax reference + +# DESCRIPTION + +*leddy* uses a general ledger format similar to, but distinct from, other +common plain text accounting tools. This document assumes a general knowledge +of accounting principles, but no specific knowledge of other plain text +accounting tools. + +*leddy* expects plain text files with a particular syntax in valid UTF-8. If +any aspect of the file is unexpected, *leddy* will report this to the user with +a line number and exit. + +Lines beginning with '#' are interpreted as comments and ignored. Blank lines +and lines containing only whitespace are also ignored. + +# ENTRIES AND DETAILS + +An entry in a *leddy* ledger file is comprised of one _header_ line and two or +more _detail_ lines. The header line contains the date in ISO-8601 (YYYY-MM-DD) +format, followed by one space, followed by the name or description of the entry +in question. For example, to write a _header_ representing a fast food purchase: + + 2023-01-02 Taco Bell + +*leddy* is unopinionated about the content of the line after the date and one +space character that should follow it. + +A _detail_ line contains four elements, each separated by one or more spaces: + +1. leading whitespace, typically one tab character++ +2. a valid account string++ +3. the amount to debit or credit the account++ +4. the currency or commodity that the amount is denominated in + +Here is one possible complete fast food purchase entry, to finish our example: + + 2023-01-02 Taco Bell++ + Expenses:Food:Restaurants 5.00 USD++ + Liabilities:Cards:Chase -5.00 USD + +There is no limit to the number of detail lines you can include in an entry. It +is typically ideal to keep them as specific as possible, but complex events, +especially those involving taxes, equities, and debts can validly involve many. +Here is an example of how you may handle the monthly payment on a loan that +accrues interest: + + 2023-10-28 Navient++ + Assets:Checking:Chase -402.00 USD++ + Expenses:Fees:Interest 68.00 USD++ + Liabilities:Loans:Student 334.00 USD + +Here, we represent a payment of 402.00 USD, of which 68.00 went toward interest +and the remaining toward the principal balance. When summed up, all details on +an entry must balance, i.e. they must sum to zero. *leddy* will always verify +this and refuse to report anything if any entries in the ledger do not balance. + +Other plain text accounting tools typically allow you to optionally omit the +amount and currency of exactly one detail line, and the parser will infer that +the entry is intended to balance and insert the necessary debit or credit to +make the entry balance. *leddy* does not allow this; all detail amounts and +currencies must be explicit. + +There is one exception to the typical *leddy* balancing behavior related to +multi-currency entries. See *MULTI-CURRENCY*. + +## ACCOUNTS + +Accounts are strings that represent the location, application, or context of a +balance of money. They should contain at least two segments. The first segment +is always one of _Assets_, _Liabilities_, _Equity_, _Income_ or _Expenses_. +*leddy* enforces this. Subsequent segments can be organized however the user +wishes. Users are encouraged to consult educational accounting resources as +needed when considering how to best structure accounts. + +As shown in the examples throughout this document, segments are colon-delimited. +Segments cannot contain spaces. + +## AMOUNTS AND CURRENCIES + +A currency must always follow every amount, and be separated from that amount +by exactly one space. + +*leddy* handles amounts as integers internally, with precision determined by +the number of integers past the decimal point, if any. This ensures that no +floating point errors occur in processing. + +Each account-currency combination must have a consistent number of integers past +the decimal point every time it appears. In other words, the below combination +of entries is invalid even though, in concept, they both make sense: + + 2023-01-01 Entry One++ + Expenses:Fees:Interest 50 USD++ + Liabilities:Loans:Personal -50.00 USD + + 2023-01-02 Entry Two++ + Expenses:Fees:Interest 50.00 USD++ + Liabilities:Loans:Student -50.00 USD + +In parsing this, *leddy* would complain that the precision between entries on +the Expenses:Fees:Interest account differs from the first time it saw it. This +check is designed to prevent common data entry mistakes, and simplifies the +internal handling of balances. + +Currencies here are fiat currencies, but *leddy* is unopinionated about this. +Holdings of stocks, precious metals, crypto assets, or anything else with value +can and should be represented as a currency in this model. + +# MULTI-CURRENCY + +*leddy* has no knowledge of the outside world and therefore no way of knowing +the exchange rates between different declared currencies. Therefore, it trusts +the user to input valid, balanced entries when multiple currencies are +involved. + +When two currencies are used in one entry, *leddy* assumes the entry is balanced +and calculates an implied exchange rate between the two currencies that makes +the entry balance. These exchange rates can be observed in the *fx* report; +see *leddy*(1). + +Lastly, *leddy* must make each currency balance. To achieve this, *leddy* +inserts two new details into the entry that net each currency to zero, into a +special _Equity:Conversions_ account. This account does not need to be declared +and is automatically created when needed. This is the only time *leddy* will +implicitly alter the representation of an entry. (Of course, it doesn't edit +the ledger file.) The effect is that the _Equity:Conversions_ account will +tabulate the net gain or loss of each currency from conversions into other +currencies. + +Note the _Equity:Conversions_ account is not otherwise special, can be manually +declared and interacted with, etc. just like any other account. + +Entries are allowed to contain up to two currencies in total. Three or more is +not supported. This is because it would be impossible to implicitly calculate +exchange rates if three or more currencies were in the same entry, because +infinitely many valid solutions would exist. diff --git a/ledger/detail.ha b/ledger/detail.ha new file mode 100644 index 0000000..a546971 --- /dev/null +++ b/ledger/detail.ha @@ -0,0 +1,31 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +export type detail = struct { + account: str, + amount: i64, + precision: u64, + currency: str, +}; + +fn new_detail() detail = { + return detail { + account = "", + amount = 0, + precision = 0, + currency = "", + }; +}; diff --git a/ledger/entry.ha b/ledger/entry.ha new file mode 100644 index 0000000..2f6e7a5 --- /dev/null +++ b/ledger/entry.ha @@ -0,0 +1,164 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +use fmt; +use math; +use strings; + +use errs; + +export type entry = struct { + date: i64, // epoch timestamp of first second in day + datestr: str, // %F formatted date + name: str, + details: []detail, +}; + +export fn new_entry() entry = { + return entry { + date = 0, + datestr = "", + name = "", + details = [], + }; +}; + +export fn finish_entry(e: *entry) void = { + free(e.datestr); + free(e.name); + + for (let i = 0z; i < len(e.details); i += 1) { + free(e.details[i].account); + free(e.details[i].currency); + }; + free(e.details); +}; + +// Account to insert virtual currency conversion entries into +const conversion_account: str = "Equity:Conversions"; + +// Validates that an entry is coherent, and returns void if so, else error. +// +// Entries are not checked for balance if they involve multiple currencies. +// This is because we trust the user to handle implicit conversions, and all +// fields must be explicit in the ledger. +export fn validate(led: *ledger, e: *entry, r: *rates) (void | errs::error) = { + if (len(e.details) == 0) { + return errs::invalid; + }; + + const currency = e.details[0].currency; + + let processed_mult_cur = false; + let has_debit_entry = false; + let has_credit_entry = false; + let sum = 0i64; + let details_to_add = (new_detail(), new_detail()); + + for (let i = 0z; i < len(e.details); i += 1) { + // if multiple currencies are involved, we check for coherence + // only by ensuring the entry has at least one debit and at + // least one credit. We trust the user to input the proper + // values, and therefore the proper implicit exchange rate. + if (e.details[i].currency != currency) { + const implicits = match (get_implicit_exchange_rate(e)) { + case let r: (i64, i64, f64) => yield r; + case let e: errs::error => return e; + }; + insert_rate( + r, + e.datestr, + e.details[i].currency, + currency, + implicits.2, + ); + + details_to_add = (detail { + account = conversion_account, + amount = implicits.0 * -1, + precision = e.details[0].precision, + currency = currency, + }, detail { + account = conversion_account, + amount = implicits.1 * -1, + precision = e.details[i].precision, + currency = e.details[i].currency, + }); + + sum -= implicits.0 + implicits.1; + processed_mult_cur = true; + }; + + if (e.details[i].amount > 0) { + has_debit_entry = true; + } else if (e.details[i].amount < 0) { + has_credit_entry = true; + }; + + sum += e.details[i].amount; + }; + + if (!has_debit_entry && !has_credit_entry) { + return errs::invalid; + }; + + if (sum != 0) { + return errs::imbalanced; + }; + + if (details_to_add.0.account != "") { + append(e.details, details_to_add.0); + append(e.details, details_to_add.1); + }; +}; + +// Returns a formatted amount for use in displaying reports. +export fn resolve_amtstr(amt: i64, prec: u64) str = { + const a = fmt::asprint(amt); + defer free(a); + + if (prec == 0) { + return a; + }; + + if (len(a) <= prec: size) { + const p = fmt::asprint(prec); + defer free(p); + + const d = fmt::asprint("0.{:_0", p, "}"); + defer free(d); + + return fmt::asprintf(d, a); + }; + + const r = strings::torunes(a); + const before = strings::fromrunes(r[0..len(r) - prec: size]); + const after = strings::fromrunes(r[len(r) - prec: size..]); + free(r); + + defer free(before); + defer free(after); + + return strings::concat(before, ".", after); +}; + +// Should only be used as an intermediate step for displaying, +// things, not to perform calculations with the result. +// +// Floating point financial math bad! +export fn resolve_amtf(amt: i64, prec: u64) f64 = { + return amt: f64 / math::powf64(10.0, prec: f64); +}; diff --git a/ledger/exchange_rates.ha b/ledger/exchange_rates.ha new file mode 100644 index 0000000..4448ae2 --- /dev/null +++ b/ledger/exchange_rates.ha @@ -0,0 +1,158 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +use hash::fnv; +use math; +use sort; +use strings; + +use errs; + +export type rates = struct { + m: [8][]rate, +}; + +export type rate = struct { + hash: u32, + + t: str, // date formatted as %F + base: str, + quote: str, + price: f64, // quote per base +}; + +fn new_rates() rates = { + return rates{...}; +}; + +fn insert_rate(r: *rates, d: str, bs: str, q: str, amt: f64) void = { + const s = strings::join(";", d, bs, q); + defer free(s); + + const hash = fnv::string32(s); + + let b = &r.m[hash % len(r.m)]; + for (let i = 0z; i < len(*b); i += 1) { + if (b[i].t == d && b[i].base == bs && b[i].quote == q) { + b[i].price = amt; + + return; + }; + }; + + append(b, rate { + hash = hash, + t = d, + base = bs, + quote = q, + price = amt, + }); +}; + +// Returns a sorted slice of tuples containing the exchange rates. Tuple is +// (datestr, base, quote, price). +export fn get_rates(r: *rates) [](str, str, str, f64) = { + let output: [](str, str, str, f64) = []; + for (let i = 0z; i < len(r.m); i += 1) { + for (let j = 0z; j < len(r.m[i]); j += 1) { + append( + output, + ( + r.m[i][j].t, + r.m[i][j].base, + r.m[i][j].quote, + r.m[i][j].price, + ) + ); + }; + }; + + sort::sort(output, size((str, str, str, f64)), &sort_rate_tuples); + return output; +}; + +fn sort_rate_tuples(a: const *opaque, b: const *opaque) int = { + const aa = a: *(str, str, str, f64); + const bb = b: *(str, str, str, f64); + + let c = strings::compare((*aa).0, (*bb).0); + if (c != 0) { + return c; + }; + + c = strings::compare((*aa).1, (*bb).1); + if (c != 0) { + return c; + }; + + return strings::compare((*aa).2, (*bb).2); +}; + +// Given an entry with exactly two currencies used, returns a tuple of totals +// for each of the two currencies observed (where the first is the first +// currency appearing in the entry), then the implicit exchange rate between +// them. Fails if: +// 1. The entry is incoherent +// 2. The entry's details contain a number of currencies other than two +// +// The totals are in the native precision of each currency. +// +// Aborts if the entry has no details. +fn get_implicit_exchange_rate(e: *entry) ((i64, i64, f64) | errs::error) = { + const b_cur = e.details[0].currency; + let q_cur = ""; + + let b_sum = e.details[0].amount; + let q_sum = 0i64; + + let b_sumf = resolve_amtf(e.details[0].amount, e.details[0].precision); + let q_sumf = 0f64; + + for (let i = 1z; i < len(e.details); i += 1) { + if (len(q_cur) == 0 && e.details[i].currency != b_cur) { + q_cur = e.details[i].currency; + } else if ( + len(q_cur) > 0 && + e.details[i].currency != b_cur && + e.details[i].currency != q_cur + ) { + return errs::unsupported; + }; + + if (e.details[i].currency == b_cur) { + b_sum += e.details[i].amount; + b_sumf += resolve_amtf( + e.details[i].amount, e.details[i].precision + ); + } else if (e.details[i].currency == q_cur) { + q_sum += e.details[i].amount; + q_sumf += resolve_amtf( + e.details[i].amount, e.details[i].precision + ); + }; + }; + + if (math::isnegative(b_sumf) == math::isnegative(q_sumf)) { + // base and quote must be netted against each other + return errs::invalid; + }; + + if (b_sum == 0 || q_sum == 0) { + return errs::invalid; + }; + + return (b_sum, q_sum, q_sumf / b_sumf * -1f64); +}; diff --git a/ledger/ledger.ha b/ledger/ledger.ha new file mode 100644 index 0000000..20e74a1 --- /dev/null +++ b/ledger/ledger.ha @@ -0,0 +1,149 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +use hash::fnv; +use sort; +use strings; + +use errs; + +export type ledger = struct { + m: [64][]account, + e: []entry, + r: rates, + + // epoch timestamps + begin: i64, + end: i64, +}; + +export type account = struct { + hash: u32, + account: str, + currency: str, + bal: i64, + precision: u64, +}; + +export fn new(b: i64, e: i64) ledger = { + return ledger{ + begin = b, + end = e, + ... + }; +}; + +export fn finish(led: *ledger) void = { + for (let i = 0z; i < len(led.m); i += 1) { + for (let j = 0z; j < len(led.m[i]); j += 1) { + free(led.m[i][j].account); + free(led.m[i][j].currency); + }; + free(led.m[i]); + }; + + for (let i = 0z; i < len(led.e); i += 1) { + finish_entry(&led.e[i]); + }; + free(led.e); + + for (let i = 0z; i < len(led.r.m); i += 1) { + free(led.r.m[i]); + }; +}; + +export fn add_entry(led: *ledger, e: *entry) (void | errs::error) = { + if (led.begin != 0 && e.date < led.begin) { + return; + }; + if (led.end != 0 && e.date > led.end) { + return; + }; + + for (let i = 0z; i < len(e.details); i += 1) { + match (edit_bal(led, &e.details[i])) { + case void => continue; + case let e: errs::error => return e; + }; + }; + append(led.e, *e); +}; + +// Increments or decrements the appropriate balance in the given ledger. If the +// account name does not exist, an error is returned. +fn edit_bal(led: *ledger, d: *detail) (void | errs::error) = { + const key = strings::concat(d.account, d.currency); + defer free(key); + + const hash = fnv::string32(key); + + let b = &led.m[hash % len(led.m)]; + for (let i = 0z; i < len(*b); i += 1) { + if (b[i].account == d.account && b[i].currency == d.currency) { + if (d.precision != b[i].precision) { + return errs::precision; + }; + + b[i].precision = d.precision; + b[i].bal += d.amount; + + return void; + }; + }; + + // if not found, add it + append(b, account{ + hash = hash, + account = strings::dup(d.account), + currency = strings::dup(d.currency), + bal = d.amount, + precision = d.precision, + }); +}; + +// Returns a sorted slice of tuples containing the full account names and +// balances. Tuple is (name, currency, amount, precision). +export fn bals(led: *ledger) [](str, str, i64, u64) = { + let output: [](str, str, i64, u64) = []; + for (let i = 0z; i < len(led.m); i += 1) { + for (let j = 0z; j < len(led.m[i]); j += 1) { + append( + output, + ( + led.m[i][j].account, + led.m[i][j].currency, + led.m[i][j].bal, + led.m[i][j].precision, + ) + ); + }; + }; + + sort::sort(output, size((str, str, i64, u64)), &sort_tuples); + return output; +}; + +fn sort_tuples(a: const *opaque, b: const *opaque) int = { + const aa = a: *(str, str, i64, u64); + const bb = b: *(str, str, i64, f64); + + const cmp = strings::compare((*aa).0, (*bb).0); + if (cmp != 0) { + return cmp; + }; + + return strings::compare((*aa).1, (*bb).1); +}; diff --git a/ledger/parse.ha b/ledger/parse.ha new file mode 100644 index 0000000..b2dd69b --- /dev/null +++ b/ledger/parse.ha @@ -0,0 +1,109 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +use bufio; +use encoding::utf8; +use io; +use strconv; +use strings; +use time::date; + +use errs; + +export fn next_line(f: io::handle) (str | void | errs::error) = { + let b: []u8 = []; + defer free(b); + + match (bufio::read_line(f)) { + case let bytes: []u8 => b = bytes; + case io::EOF => return; + case let err: io::error => return errs::filesystem; + }; + + match (strings::fromutf8(b)) { + case let s: str => { + return strings::dup(strings::trim(s)); + }; + case let err: utf8::invalid => return errs::invalid; + }; +}; + +export fn parse(in: str) (entry | detail | errs::invalid) = { + const s = strings::trim(in); + const parts = strings::cut(s, " "); + + if (len(parts.1) == 0) { + return errs::invalid; + }; + + parts.1 = strings::trim(parts.1); + + match (isodate_to_unix(parts.0)) { + case let d: i64 => { + return entry { + date = d, + datestr = strings::dup(parts.0), + name = strings::dup(parts.1), + details = [], + }; + }; + case => { + if (!is_valid_account(parts.0)) { + return errs::invalid; + }; + + const (amt_str, c) = strings::cut(parts.1, " "); + const (whole, cents) = strings::cut(amt_str, "."); + + const a = strings::concat(whole, cents); + defer free(a); + + const final: i64 = match (strconv::stoi64(a)) { + case let n: i64 => yield n; + case => return errs::invalid; + }; + + c = strings::trim(c); + return detail { + account = strings::dup(parts.0), + amount = final, + currency = strings::dup(c), + precision = len(cents), + }; + }; + }; +}; + +export fn isodate_to_unix(s: str) (i64 | errs::invalid) = { + match (date::from_str("%F", s)) { + case let d: date::date => { + let s = date::asformat("%s", &d)!; + defer free(s); + return strconv::stoi64(s)!; + }; + case => return errs::invalid; + }; +}; + +fn is_valid_account(s: str) bool = { + return ( + strings::hasprefix(s, "Assets:") || + strings::hasprefix(s, "Liabilities:") || + strings::hasprefix(s, "Equity:") || + strings::hasprefix(s, "Income:") || + strings::hasprefix(s, "Expenses:") + ); +}; @@ -0,0 +1,223 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +use bufio; +use encoding::utf8; +use fmt; +use fs; +use getopt; +use io; +use os; +use strings; + +use errs; +use ledger; +use reports; + +const version: str = "0.1.1"; + +// TODO: Implement find (locate entries by name) and inspect (specific acct +// history) reports. + +export fn main() void = { + const cmd = getopt::parse(os::args, + "plain text accounting tool", + ('b', "date", "beginning date filter"), + ('e', "date", "ending date filter"), + ('f', "file", "ledger file path"), + ('q', "include equity in bs"), + ('v', "output version and exit"), + ('z', "include zero bals"), + "command", + ); + defer getopt::finish(&cmd); + + let b = 0i64; + let e = 0i64; + let f = ""; + let q = false; + let v = false; + let z = false; + + for (let i = 0z; i < len(cmd.opts); i += 1) { + const opt = cmd.opts[i]; + switch (opt.0) { + case 'b' => { + match (ledger::isodate_to_unix(opt.1)) { + case let n: i64 => { + b = n; + }; + case => fmt::fatal("FAIL invalid -b"); + }; + }; + case 'e' => { + match (ledger::isodate_to_unix(opt.1)) { + case let n: i64 => e = n; + case => fmt::fatal("FAIL invalid -e"); + }; + }; + case 'f' => f = opt.1; + case 'q' => q = true; + case 'v' => v = true; + case 'z' => z = true; + case => abort(); + }; + }; + + if (v) { + fmt::println(version)!; + return; + }; + + if (len(f) == 0) { + fmt::fatal("FAIL no ledger file"); + }; + + const file = match (os::open(f, fs::flag::RDONLY)) { + case let f: io::file => yield f; + case let err: fs::error => { + fmt::fatalf( + "FAIL bad read at {}: {}", f, fs::strerror(err) + ); + }; + }; + + let command = reports::report::BALANCE_SHEET; + if (len(cmd.args) >= 1) { + command = switch (cmd.args[0]) { + case "tb" => yield reports::report::TRIAL_BALANCE; + case "is" => yield reports::report::INCOME_STATEMENT; + case "bs" => yield reports::report::BALANCE_SHEET; + case "fx" => yield reports::report::EXCHANGE_RATES; + case => fmt::fatal("FAIL invalid command"); + }; + }; + + let led = ledger::new(b, e); + //defer ledger::finish(&led); + + let cur_entry = ledger::new_entry(); + let cur_line = 0; + for (true) { + cur_line += 1; + const line = match (ledger::next_line(file)) { + case let l: str => yield l; + case void => break; + case let e: errs::error => { + fmt::fatalf( + "FAIL (line {}): {}", + cur_line, + errs::strerror(e), + ); + }; + }; + + if ( + len(strings::trim(line)) == 0 || + strings::hasprefix(line, '#') + ) { + continue; + }; + + match (process_line(&led, line, &cur_entry, cur_line)) { + case void => free(line); + case let e: errs::error => { + fmt::fatalf( + "FAIL parse (line {} or preceding entry): {}", + cur_line, + errs::strerror(e) + ); + }; + }; + }; + + io::close(file)!; + + // finalize the last entry if it is not followed by anything + if (len(cur_entry.name) > 0) { + const res = finalize_entry(&led, &cur_entry); + if (res is errs::error) { + fmt::fatalf( + "FAIL parse (line {} or preceding entry): {}", + cur_line + 1, + errs::strerror(res: errs::error) + ); + }; + }; + + // display whatever report + switch (command) { + case reports::report::TRIAL_BALANCE => + reports::print_tb(&led); + case reports::report::INCOME_STATEMENT => + reports::print_is(&led, z); + case reports::report::BALANCE_SHEET => + reports::print_bs(&led, z, q); + case reports::report::EXCHANGE_RATES => + reports::print_exchange_rates(&led); + }; +}; + +fn process_line( + led: *ledger::ledger, l: str, e: *ledger::entry, line_num: int, +) (void | errs::error) = { + match (ledger::parse(l)) { + case let h: ledger::entry => { + if (len(e.name) == 0) { + *e = h; + return; + }; + + match (finalize_entry(led, e)) { + case void => *e = h; + case let e: errs::error => return e; + }; + }; + case let d: ledger::detail => { + if (len(e.name) == 0) { + fmt::fatalf( + "FAIL orphaned detail (line {})", + line_num + ); + }; + append(e.details, d); + }; + case let e: errs::invalid => { + fmt::fatalf( + "FAIL (line {}): {}", + line_num, + errs::strerror(e), + ); + }; + }; +}; + +fn finalize_entry( + led: *ledger::ledger, old: *ledger::entry +) (void | errs::error) = { + const res = ledger::validate(led, old, &led.r); + + if (res is errs::error) { + return res; + }; + + match (ledger::add_entry(led, old)) { + case void => ledger::finish_entry(old); + case let err: errs::error => { + return err; + }; + }; +}; diff --git a/reports/reports.ha b/reports/reports.ha new file mode 100644 index 0000000..a382b82 --- /dev/null +++ b/reports/reports.ha @@ -0,0 +1,166 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +use fmt; +use strings; + +use ledger; + +export type report = enum { + TRIAL_BALANCE, + BALANCE_SHEET, + INCOME_STATEMENT, + EXCHANGE_RATES, +}; + +// TODO: Resolve accounts by segment, so the display can be nested. + +export fn print_tb(led: *ledger::ledger) void = { + const b = ledger::bals(led); + defer free(b); + + let t = new_totals(); + defer finish(&t); + + print_header(" Trial Balance "); + + for (let i = 0z; i < len(b); i += 1) { + edit_bal(&t, b[i].1, b[i].2, b[i].3); + print_balance(b[i].0, b[i].2, b[i].3, b[i].1); + }; + + print_total_line(); + + let final = tabulate(&t); + defer free(final); + + for (let i = 0z; i < len(final); i += 1) { + print_total(final[i].0, final[i].1, final[i].2); + }; +}; + +export fn print_is(led: *ledger::ledger, include_zero: bool) void = { + const b = ledger::bals(led); + defer free(b); + + let t = new_totals(); + + print_header(" Income Statement "); + + for (let i = 0z; i < len(b); i += 1) { + if (!strings::hasprefix(b[i].0, "Income:") && + !strings::hasprefix(b[i].0, "Expenses:")) { + + continue; + }; + edit_bal(&t, b[i].1, b[i].2, b[i].3); + if (include_zero || b[i].2 != 0) { + print_balance(b[i].0, b[i].2, b[i].3, b[i].1); + }; + }; + + print_total_line(); + + let final = tabulate(&t); + defer free(final); + + for (let i = 0z; i < len(final); i += 1) { + print_total(final[i].0, final[i].1, final[i].2); + }; +}; + +export fn print_bs( + led: *ledger::ledger, include_zero: bool, include_equity: bool +) void = { + const b = ledger::bals(led); + defer free(b); + + let t = new_totals(); + + print_header(" Balance Sheet "); + + for (let i = 0z; i < len(b); i += 1) { + if (strings::hasprefix(b[i].0, "Equity:") && !include_equity) { + continue; + } else if (strings::hasprefix(b[i].0, "Income:") || + strings::hasprefix(b[i].0, "Expenses:")) { + + continue; + }; + edit_bal(&t, b[i].1, b[i].2, b[i].3); + if (include_zero || b[i].2 != 0) { + print_balance(b[i].0, b[i].2, b[i].3, b[i].1); + }; + }; + + print_total_line(); + + let final = tabulate(&t); + defer free(final); + + for (let i = 0z; i < len(final); i += 1) { + print_total(final[i].0, final[i].1, final[i].2); + }; +}; + +export fn print_exchange_rates(led: *ledger::ledger) void = { + const r = ledger::get_rates(&led.r); + + print_header(" Exchange Rates "); + + for (let i = 0z; i < len(r); i += 1) { + print_exchange_rate( + r[i].0, r[i].1, r[i].2, r[i].3, + ); + }; +}; + +fn print_header(content: str) void = { + fmt::printfln("{:_-=78}", content)!; +}; + +fn print_total_line() void = { + fmt::printfln("{:59}{:_-19}", "", "-")!; +}; + +fn print_total(currency: str, amt: i64, precision: u64) void = { + print_balance("", amt, precision, currency); +}; + +fn print_balance(acct: str, amt: i64, precision: u64, currency: str) void = { + const b = format_money(amt, precision); + defer free(b); + + if (amt >= 0) { + fmt::printfln("{:58} {:14} {:4}", acct, b, currency)!; + } else { + fmt::printfln("{:58} ({:13} {:4})", acct, b, currency)!; + }; +}; + +fn print_exchange_rate(date: str, from: str, to: str, amt: f64) void = { + fmt::printfln("{:22} {:12}/{:-12} {:.5f14} {}", date, to, from, amt, from)!; + fmt::printfln("{:22} {:12}/{:-12} {:.5f14} {}", "", from, to, 1f64 / amt, to)!; +}; + +fn format_money(amt: i64, prec: u64) str = { + let a = amt; + if (a < 0) { + a *= -1; + }; + + return ledger::resolve_amtstr(a, prec); +}; diff --git a/reports/totals.ha b/reports/totals.ha new file mode 100644 index 0000000..2b7eddb --- /dev/null +++ b/reports/totals.ha @@ -0,0 +1,92 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of leddy. +// +// leddy 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. +// +// leddy 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 +// leddy. If not, see <https://www.gnu.org/licenses/>. + +use hash::fnv; +use sort; +use strings; + +use errs; + +type totals = struct { + m: [4][]total, +}; + +type total = struct { + hash: u32, + currency: str, + bal: i64, + precision: u64, +}; + +fn new_totals() totals = { + return totals{...}; +}; + +fn finish(t: *totals) void = { + for (let i = 0z; i < len(t.m); i += 1) { + free(t.m[i]); + }; +}; + +fn edit_bal(t: *totals, cur: str, amt: i64, prec: u64) void = { + const hash = fnv::string32(cur); + + let b = &t.m[hash % len(t.m)]; + for (let i = 0z; i < len(*b); i += 1) { + if (b[i].currency == cur) { + b[i].bal += amt; + + return; + }; + }; + + append(b, total { + hash = hash, + currency = cur, + bal = amt, + precision = prec, + }); + + return; +}; + +// Returns a sorted slice of tuples containing the currency names and +// balances. Tuple is (currency, amount, precision). +fn tabulate(t: *totals) [](str, i64, u64) = { + let output: [](str, i64, u64) = []; + for (let i = 0z; i < len(t.m); i += 1) { + for (let j = 0z; j < len(t.m[i]); j += 1) { + append( + output, + ( + t.m[i][j].currency, + t.m[i][j].bal, + t.m[i][j].precision, + ) + ); + }; + }; + + sort::sort(output, size((str, i64, u64)), &sort_tuples); + return output; +}; + +fn sort_tuples(a: const *opaque, b: const *opaque) int = { + const aa = a: *(str, i64, u64); + const bb = b: *(str, i64, f64); + + return strings::compare((*aa).0, (*bb).0); +}; |