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 b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,18 @@ +Umm is an extremely minimal command-line program to read a plain-text +ledger file and report balance and other information. Although +minimal, it aims to be able to handle multiple accounts, currencies, +commodities, and securities. It doesn't abolutely force you to use +double-entry bookkeeping, although it tries to make it easy to do so. + +Umm should have no dependencies other than a haskell compiler and +standard libraries, although I've not tested it with anything except +ghc. I've built it with both ghc 6.8.3 on an iMac G3 running OSX +10.3.9 and ghc 6.10.3 on an x86 running Ubuntu. You should be able to +build umm simply by running + + cabal configure && cabal build + +For more information, build umm, then run "umm --help", and read the +output of that. Arguably, that info should be in this file... later. +Then look at the two files sample1.dat and sample2.dat; they are very +simple examples of ledgers. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,3 @@ +module Main where +import Distribution.Simple +main = defaultMain diff --git a/UMM.cabal b/UMM.cabal new file mode 100644 --- /dev/null +++ b/UMM.cabal @@ -0,0 +1,25 @@ +Name: UMM +Version: 0.1.0 +Homepage: http://www.korgwal.com/umm/ +Author: Uwe Hollerbach +Maintainer: Uwe Hollerbach +Synopsis: A small command-line accounting tool: + hledger + bugs - features? maybe... +Description: This is a very minimal command-line program to read a + plain-text ledger file and display balance information + and other reports. I could have used hledger or ledger + for this, but I had some things I wanted to do a little + differently... so I did. +License: GPL +License-File: LICENSE +Cabal-Version: >= 1.2 +Build-Type: Simple +Category: Finance + +Executable umm + Build-Depends: base >= 4 && < 5, haskell98, parsec, old-time + Main-is: UMM.hs + Other-Modules: UMMData + UMMParser + UMMEval + UMMHelp diff --git a/UMM.hs b/UMM.hs new file mode 100644 --- /dev/null +++ b/UMM.hs @@ -0,0 +1,228 @@ +{- Copyright 2009 Uwe Hollerbach + +This file is part of umm, Uwe's Money Manager. + +umm 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. + +umm 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 umm; if not, write to the Free Software Foundation, Inc., +59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +$Id: UMM.hs,v 1.38 2009/11/18 22:30:35 uwe Exp $ -} + +module Main where +import Prelude +import Control.Monad +import Data.List +import Data.Maybe +import Data.Ratio +import System +import System.Exit +import System.IO +import System.Time + +import UMMHelp +import UMMData +import UMMParser +import UMMEval + +processArgs = + do prog <- getProgName + args <- getArgs + now <- getClockTime >>= toCalendarTime + let argc = length args + fname = head args + nd = genDate now + cmd = if argc < 2 + then BalanceCmd (Name "") nd + else parseUCommand nd (intercalate " " (tail args)) + writeHdr + if argc < 1 || fname == "-h" || fname == "-help" || fname == "--help" + then putStr (usageMsg prog) >> exitWith ExitSuccess + else return (fname, cmd) + +-- A version of 'lines' which deals with all combinations of '\r' and '\n'. +-- It drops blank lines, which is perfectly fine here, but which might be +-- a problem elsewhere. + +mylines str = filter (/= "") (ml str) + where ml [] = [] + ml s = let (p, s1) = break (\c -> c == '\n' || c == '\r') s + in p : (if null s1 then [] else ml (tail s1)) + +getLines fp = + (if fp == "-" then getContents else readFile fp) >>= (return . mylines) + +-- Merge explicit (ps) and implicit (qs) prices: the inputs are sorted +-- by date, newest first, and the output is the same, preferring +-- explicit over implicit prices in case of a date match. + +mergePrices [] qs = qs +mergePrices ps [] = ps +mergePrices pa@(p:ps) qa@(q:qs) = + if cmpRecDate p q == LT + then q : mergePrices pa qs + else p : mergePrices ps qa + +-- Find an equivalent price in the default units for a given CCS, +-- if a suitable one can be found. If none can be found, or if the +-- ccs is already in the default units, return Nothing. + +equivPrice (CCSAmount n (Amount a)) dc date ps = + if n == dc then Nothing else xlat ps + where xlat [] = Nothing + xlat ((PriceRec dr _ (CCSAmount nr1 (Amount ar1)) + (CCSAmount nr2 (Amount ar2))):ps) = + if compare date dr /= LT && n == nr1 && nr2 == dc + then Just ((CCSAmount dc (Amount (a*ar2/ar1))), dr) + else xlat ps + xlat (_:ps) = xlat ps -- for non-PriceRec records + +-- Translate price if possible + +reprice ccs dc date prices = + let ep = equivPrice ccs dc date prices + in if isJust ep then fst (fromJust ep) else ccs + +-- Pretty-print accounts + +ppAccts es sp = + concat (map (ppe (sp + maximum (map (length . getN . fst) es))) es) + where getN (Name n) = n + ppe l (m,as) = + let isp = concat (repeat " ") + in zipWith gl ((take l (show m ++ isp)) : repeat (take l isp)) as + gl a b = concat [a, b] + +showPos dc da ps as = map f1 as + where f1 (n1,es) = (n1, if null es then ["[empty]"] else map f2 es) + f2 c2 = + let sv = show c2 + ep = equivPrice c2 dc da ps + jep = fromJust ep + CCSAmount n (Amount a) = fst jep + jer = CCSAmount n (Amount (roundP 2 a)) + sp = "\t~" ++ show jer ++ " (" ++ show (snd jep) ++ ")" + pad = " " ++ concat (take (18 - length sv) (repeat " ")) + in if isJust ep then sv ++ pad ++ sp else sv + +selAccts names accs = + (if length names == 1 && head names == noName + then id + else filter (\a -> elem (fst a) names)) accs + +-- Round a rational number val to np decimal places +-- This might not be ultimately exact, but it's for converted prices +-- which might be a couple of days out of date anyway, so no big deal + +roundP np val = + if val < 0 then negate (rp np (negate val)) else rp np val + where rp np val = + let e1 = 10^(max 0 np) + e2 = 10*e1 + vs = (fromInteger e2)*val + n = numerator vs + d = denominator vs + q1 = quot n d + q2 = quot (q1 + 4) 10 + in q2 % e1 + +-- Turn an account-group into a list of accounts. An account-group can +-- contain (names of) other account-groups, including recursively, and +-- loops aren't prohibited either... need to handle all those cases. + +expandGroup as gs ag = + if ag == noName || ag == todoName + then [ag] + else ff [ag] (map getRecName as) (map ggt gs) [] [] + where ff [] _ _ am _ = am + ff (q:qs) as gs am ab + | elem q am || elem q ab = ff qs as gs am ab + | elem q as = ff qs as gs (q:am) ab + | isJust (lookup q gs) = ff (qs ++ fromJust(lookup q gs)) + as gs am (q:ab) + | otherwise = error ("unknown account or group! " + ++ show q) + ggt (GroupRec n as) = (n,as) + +doList w dc ccs accts grps incs exps = + do when (chk w COLCCS) + (putStrLn "# Currencies, Commodities, Securities\n" >> + putStrLn ("# default ccs " ++ (show dc) ++ "\n") >> sh ccs) + when (chk w COLAccts) (putStrLn "\n# Accounts\n" >> sh accts) + when (chk w COLGrps) (putStrLn "\n# Groups\n" >> sh grps) + when (chk w COLIncs) (putStrLn "\n# Incomes\n" >> sh incs) + when (chk w COLExps) (putStrLn "\n# Expenses\n" >> sh exps) + where chk w1 w2 = w1 == w2 || w1 == COLAll + sh = mapM_ (putStrLn . show) + +doBalance date names dc accts trans prices = + do final <- getBalances start_time date Nothing False accts trans + let fsel = selAccts names final + fp = map (\e -> reprice e dc date prices) (concat (map snd fsel)) + gp = groupBy eqCCSAmountName (sortBy cmpCCSAmountName fp) + sp = filter (\e -> ccsA e /= 0) (map sumCCS gp) + if length names == 1 && head names == todoName + then putStr "" + else putStrLn ("Account balances as of " ++ show date) >> + mapM_ putStrLn (ppAccts (showPos dc date prices fsel) 8) >> + putStrLn ("Grand total: ~" ++ show sp) + where sumCCS cs = + CCSAmount (ccsN (head cs)) (Amount (roundP 2 (sum (map ccsA cs)))) + ccsN (CCSAmount n _) = n + ccsA (CCSAmount _ (Amount a)) = a + +doRegister d1 d2 name dc accts trans prices dorec = + do final <- getBalances d1 d2 (Just name) dorec accts trans + putStrLn ((if dorec then "Reconciled" else "Account") + ++ " balance as of " ++ show d2) + mapM_ putStrLn (ppAccts (showPos dc d2 prices (selAccts [name] final)) 8) + +doChange verbose d1 d2 name dc accts trans = + do let aux = if notElem name (map getRecName accts) + then [AccountRec name d1 ""] + else [] + trs = dropWhile (\t -> compare (getRecDate t) d1 /= GT) trans + mn = if verbose then Just name else Nothing + final <- getBalances d1 d2 mn False (aux ++ accts) trs + putStr "Change" + when (d1 /= start_time) (putStr (" from " ++ show d1)) + putStrLn (" to " ++ show d2) + mapM_ putStrLn (ppAccts (showPos dc d2 [] (selAccts [name] final)) 8) + +main = + do (file, action) <- processArgs + recs <- getLines file >>= mapM (return . parseURecord) >>= validateRecs + let (dc, ccs, incs, exps, accts, grps, trans, p1) = classifyRecs recs + validateTransPrices ccs incs exps accts (trans ++ p1) + let p2 = generateImplicitPrices dc trans + prices = mergePrices (reverse p1) p2 + case action of + ListDataCmd w -> + doList w dc ccs accts grps incs exps + BalanceCmd name date -> + doBalance date (expandGroup accts grps name) dc accts trans prices + BasisCmd name date -> + putStrLn "Sorry, basis command is not implemented yet!" + ToDoCmd date -> + doBalance date [todoName] dc accts trans prices + RegisterCmd name date1 date2 -> + doRegister date1 date2 name dc accts trans prices False + ReconcileCmd name date -> + doRegister start_time date name dc accts trans prices True + ChangeCmd verbose name date1 date2 -> + doChange verbose date1 date2 name dc accts trans + PriceCmd name date -> + if name == dc + then putStrLn ("Price of " ++ show name ++ " is always 1!") + else if notElem name (map getRecName ccs) + then putStrLn ("Error! unknown CCS " ++ show name) + else getPrices name dc date prices diff --git a/UMMData.hs b/UMMData.hs new file mode 100644 --- /dev/null +++ b/UMMData.hs @@ -0,0 +1,284 @@ +{- Copyright 2009 Uwe Hollerbach + +This file is part of umm, Uwe's Money Manager. + +umm 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. + +umm 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 umm; if not, write to the Free Software Foundation, Inc., +59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +$Id: UMMData.hs,v 1.29 2009/11/18 22:30:36 uwe Exp $ -} + +module UMMData (Name(Name), Date(Date), Amount(Amount), start_time, + Command(BalanceCmd, RegisterCmd, ReconcileCmd, ListDataCmd, + ToDoCmd, PriceCmd, ChangeCmd, BasisCmd), CmdOpt(COLAll, COLCCS, + COLAccts, COLGrps, COLIncs, COLExps), Record(CCSRec, IncomeRec, + ExpenseRec, AccountRec, ToDoRec, PriceRec, XferRec, ExchRec, + SplitRec, GroupRec, CommentRec, ErrorRec), genDate, + getRecDate, cmpRecDate, getRecName, cmpRecName, + Ledger(Ledger), runLedger, getResult, getInfo, getErrs, + recordInfo, recordErr, recordNil, BSE(B,S,E), + CCSAmt(CCSAmount), cmpCCSAmountName, eqCCSAmountName, + noName, todoName, joinDrop, isLeap, validDate) where +import Prelude +import Data.Char +import Data.List +import Data.Ratio +import System.Time + +-- UMM values: names, dates, amounts, records + +newtype Name = Name String deriving (Eq, Ord) +instance Show Name where + show (Name name) = name + +noName = Name "" +todoName = Name " todo " + +data Date = Date Int Int Int deriving (Eq) + +instance Show Date where + show (Date y m d) = show y ++ "-" ++ show2 m ++ "-" ++ show2 d + where show2 n = reverse (take 2 (reverse (show n) ++ "00")) + +instance Ord Date where + compare (Date y1 m1 d1) (Date y2 m2 d2) = + let dy = compare y1 y2 + dm = compare m1 m2 + in if dy /= EQ then dy else if dm /= EQ then dm else compare d1 d2 + +genDate (CalendarTime {ctYear = y, ctMonth = m, ctDay = d}) = + let m2 = case m of + January -> 1 + February -> 2 + March -> 3 + April -> 4 + May -> 5 + June -> 6 + July -> 7 + August -> 8 + September -> 9 + October -> 10 + November -> 11 + December -> 12 + in Date y m2 d + +start_time = Date (-4003) 10 23 -- 9 AM (GMT) + +newtype Amount = Amount Rational deriving (Eq, Ord) +instance Show Amount where + show (Amount amt) = if amt < 0 then "-" ++ shRat (-amt) else shRat amt + +shRat val = + let n = numerator val + d = denominator val + (p2,r2) = divout d 2 + (p5,r5) = divout r2 5 + e10 = max p2 p5 + vs1 = show (numerator (val * 10^e10)) + l1 = max (length vs1) (1 + e10) + vs2 = take l1 (reverse vs1 ++ cycle "0") + vsf = reverse (take e10 vs2) + vsi = reverse (drop e10 vs2) + in if r5 == 1 + then if e10 == 0 then show n else vsi ++ "." ++ vsf + else show n ++ "/" ++ show d + +divout n q = doit 0 n + where doit e v = if rem v q == 0 then doit (e + 1) (quot v q) else (e,v) + +data CCSAmt = CCSAmount Name Amount +instance Show CCSAmt where + show (CCSAmount name amount) = joinDrop [show amount, show name] + +-- Compare two CCSAmounts by name + +cmpCCSAmountName (CCSAmount n1 _) (CCSAmount n2 _) = compare n1 n2 +eqCCSAmountName (CCSAmount n1 _) (CCSAmount n2 _) = n1 == n2 + +data CmdOpt = COLAll + | COLCCS + | COLAccts + | COLGrps + | COLIncs + | COLExps + deriving (Eq) + +instance Show CmdOpt where + show COLAll = "all" + show COLCCS = "ccs" + show COLAccts = "accounts" + show COLGrps = "groups" + show COLIncs = "incomes" + show COLExps = "expenses" + +data Command = ListDataCmd CmdOpt + | ToDoCmd Date + | BalanceCmd Name Date + | BasisCmd Name Date + | RegisterCmd Name Date Date + | ReconcileCmd Name Date + | PriceCmd Name Date + | ChangeCmd Bool Name Date Date + +instance Show Command where + show (ListDataCmd opt) = joinDrop ["list", show opt] + show (ToDoCmd date) = joinDrop ["todo", show date] + show (PriceCmd name date) = joinDrop ["price", show name, show date] + show (BalanceCmd name date) = joinDrop ["balance", show name, show date] + show (BasisCmd name date) = joinDrop ["basis", show name, show date] + show (RegisterCmd name date1 date2) = + joinDrop ["register", show name, show date1, show date2] + show (ReconcileCmd name date) = joinDrop ["reconcile", show name, show date] + show (ChangeCmd verbose name date1 date2) = + joinDrop ["change", (if verbose then "verbose" else ""), + show name, show date1, show date2] + +-- No, not bovine spongiform encephalitis! Disambiguate buy, sell, and +-- exch records: internally, they are all treated as exch, because +-- that makes the code simple, but the user can enter "buy" or "sell", +-- and it seems only polite to echo that back on output. + +data BSE = B | S | E deriving (Eq) + +instance Show BSE where + show B = "buy" + show S = "sell" + show E = "exch" + +data Record = CCSRec Name String + | IncomeRec Name String + | ExpenseRec Name String + | AccountRec Name Date String + | GroupRec Name [Name] + | PriceRec Date Bool CCSAmt CCSAmt + | XferRec Date Bool Name Name CCSAmt String Int + | ExchRec BSE Date Bool Name CCSAmt CCSAmt String + | SplitRec Date Name Amount Amount + | CommentRec String + | ToDoRec Date Bool String + | ErrorRec String + +instance Show Record where + show = showR + +-- We use "show str" here to add quotes and escape any escapables + +optStr str = if str == "" then "" else show str + +shRec rec = if rec then "*" else "" + +joinDrop ss = intercalate " " (filter (\s -> s /= "") ss) + +showR (CCSRec n d) = joinDrop ["ccs", show n, optStr d] +showR (IncomeRec n d) = joinDrop ["income", show n, optStr d] +showR (ExpenseRec n d) = joinDrop ["expense", show n, optStr d] +showR (AccountRec n da de) = joinDrop ["account", show n, show da, optStr de] +showR (GroupRec n as) = joinDrop (["group", show n] ++ map show as) +showR (PriceRec d imp c1 c2) = + joinDrop ["price", shRec imp, show d, show c1, show c2] + +showR (XferRec d r a1 a2 c memo chknum) = + joinDrop ["xfer", shRec r, show d, show a1, show a2, + show c, optStr memo, (if chknum == 0 then "" else show chknum)] + +showR (ExchRec t d r a c1 c2 memo) = + let hs = if t == S then [show c2, show c1] else [show c1, show c2] + in joinDrop ([show t, shRec r, show d, show a] ++ hs ++ [optStr memo]) + +showR (SplitRec d n a1 a2) = + joinDrop ["split", show d, show n, show a1, show a2] + +showR (CommentRec c) = if c == "" then "" else joinDrop ["#", c] + +showR (ToDoRec d r memo) = + joinDrop ["todo", shRec r, show d, + (if memo == "" then "something! but what?" else memo)] + +showR (ErrorRec str) = joinDrop ["#err", str] + +-- Get the date (or at any rate /some/ date) from a Record + +getRecDate (AccountRec _ d _) = d +getRecDate (PriceRec d _ _ _) = d +getRecDate (XferRec d _ _ _ _ _ _) = d +getRecDate (ExchRec _ d _ _ _ _ _) = d +getRecDate (SplitRec d _ _ _) = d +getRecDate (ToDoRec d _ _) = d +getRecDate _ = start_time -- so it works for every Record + +-- Get the name (or at any rate /some/ name) from a Record + +getRecName (CCSRec n _) = n +getRecName (IncomeRec n _) = n +getRecName (ExpenseRec n _) = n +getRecName (AccountRec n _ _) = n +getRecName (GroupRec n _) = n +getRecName _ = Name " nil " -- so it works for every Record + +-- Compare two Records by date + +cmpRecDate v1 v2 = compare (getRecDate v1) (getRecDate v2) + +-- Compare two Records by name + +cmpRecName v1 v2 = compare (getRecName v1) (getRecName v2) + +-- Ledger monad: essentially a parametrized bi-level version of the Logger +-- monad from RWH. The first component of the tuple is "the final result", +-- whatever that may be, the second component is a list of ordinary bits +-- of information, and the third component is a list of extraordinary bits +-- of information, aka errors. + +newtype Ledger e i r = Ledger (r, [i], [e]) deriving (Show) + +runLedger (Ledger a) = a +getResult (Ledger (r,_,_)) = r +getInfo (Ledger (_,i,_)) = i +getErrs (Ledger (_,_,e)) = e + +-- Record a message + +recordInfo i = Ledger ((), [i], []) + +-- Record an error + +recordErr e = Ledger ((), [], [e]) + +-- Record nothing: a placeholder for conditionals: +-- if someCond then recordErr "someErr" else recordNil + +recordNil = Ledger ((), [], []) + +-- Note that because we use append (++) for lists here, this is fairly +-- low-performance: it's entirely ok for this application, where we +-- toss around a few to a few thousand list entries, but for longer +-- lists it might not be suitable. + +instance Monad (Ledger e i) where + return a = Ledger (a, [], []) + (>>=) m k = + let (a,li1,le1) = runLedger m + n = k a + (b,li2,le2) = runLedger n + in Ledger (b, li1 ++ li2, le1 ++ le2) + (>>) a f = a >>= \_ -> f + +-- Some miscellany + +-- divisible by 4 except if divisible by 100 except if divisible by 400 +isLeap y = rem y 4 == 0 && (rem y 100 /= 0 || rem y 400 == 0) + +validDate (Date y m d) = + let lim = [ 0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 ] !! m + in (m >= 1 && m <= 12 && d >= 1 && + (d <= lim || m == 2 && isLeap y && d <= 29)) diff --git a/UMMEval.hs b/UMMEval.hs new file mode 100644 --- /dev/null +++ b/UMMEval.hs @@ -0,0 +1,255 @@ +{- Copyright 2009 Uwe Hollerbach + +This file is part of umm, Uwe's Money Manager. + +umm 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. + +umm 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 umm; if not, write to the Free Software Foundation, Inc., +59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +$Id: UMMEval.hs,v 1.23 2009/11/18 22:30:36 uwe Exp $ -} + +module UMMEval (validateRecs, classifyRecs, validateTransPrices, + generateImplicitPrices, getBalances, getPrices) where +import Prelude +import Data.List +import Data.Maybe +import System.IO +import Control.Monad + +import UMMData + +-- Initial validation of records: filter out comments, highlight parse +-- errors, and check that dates are valid. This is kind of a trivial +-- use of runLedger, it could almost be accomplished by partition. + +validateRecs records = + do let (_,i,e) = runLedger (chk records) + if length e == 0 + then return i + else hPutStrLn stderr "There were parse or date errors in the input:" + >> mapM_ (hPutStrLn stderr . show) e + >> error "quitting now" + where chk [] = return () + chk (r@(ErrorRec _):rs) = recordErr r >> chk rs + chk ((CommentRec _):rs) = chk rs + chk (r:rs) = + (if validDate (getRecDate r) then recordInfo else recordErr) r + >> chk rs + +-- Classify records by type and sort accounts and +-- transaction-type records by date or name as needed + +uErr v1 v2 = + error ("duplicate records\n " ++ show v1 ++ "\n " ++ show v2) + +uChk [] = [] +uChk s@(_:[]) = s +uChk v@(v1:v2:[]) = + if getRecName v1 == getRecName v2 then uErr v1 v2 else v +uChk (v1:v2:vs) = + if getRecName v1 == getRecName v2 then uErr v1 v2 else v1 : uChk (v2:vs) + +-- TODO: should really check that there are no duplications among +-- account names and account group names together, rather than +-- separately (or just account groups, right now) + +classifyRecs recs = cw recs [] [] [] [] [] [] [] + where cw [] c i e a g t p = + let dc = if null c then Name "zorkmid" else getRecName (last c) + in (dc, vsN c, vsN i, vsN e, reverse a, vsN g, asD dc t, asD dc p) + cw (r:rs) c i e a g t p = + case r of + CommentRec _ -> cw rs c i e a g t p + CCSRec _ _ -> cw rs (r:c) i e a g t p + IncomeRec _ _ -> cw rs c (r:i) e a g t p + ExpenseRec _ _ -> cw rs c i (r:e) a g t p + AccountRec _ _ _ -> cw rs c i e (r:a) g t p + GroupRec _ _ -> cw rs c i e a (r:g) t p + PriceRec _ _ _ _ -> cw rs c i e a g t (r:p) + _ -> cw rs c i e a g (r:t) p + vsN rs = uChk (sortBy cmpRecName rs) + asD dc rs = sortBy cmpRecDate (reverse (map (addDC dc) rs)) + addDC dc (PriceRec d imp ccsa1 ccsa2) = + PriceRec d imp ccsa1 (addDCCA dc ccsa2) + addDC dc (XferRec d f a1 a2 ccsa m c) = + XferRec d f a1 a2 (addDCCA dc ccsa) m c + addDC dc (ExchRec t d f acc ccsa1 ccsa2 m) = + ExchRec t d f acc (addDCCA dc ccsa1) (addDCCA dc ccsa2) m + addDC _ r = r + addDCCA dc c@(CCSAmount n a) = + if n == noName then CCSAmount dc a else c + +-- Second validation of transactions: check that all from & to accounts +-- are valid, that splits aren't 1/0 or 0/1, etc + +-- TODO: if we want to give a reason for each failure, run this +-- through runLedger as above? then we could generate multiple output +-- records for (some of) each input record + +validateTransPrices ccs incs exps accts tps = + do let bads = filter chk tps + when (length bads > 0) + (hPutStrLn stderr "There were bad transactions in the input:" + >> mapM_ (hPutStrLn stderr . show) bads >> error "quitting now") + where chk (SplitRec _ c (Amount amt1) (Amount amt2)) = + amt1 == 0 || amt2 == 0 || notIn c ccs + chk (PriceRec _ _ (CCSAmount c1 amt1) (CCSAmount c2 _)) = + amt1 == Amount 0 || notIn c1 ccs || notIn c2 ccs + chk (XferRec _ _ af at (CCSAmount n _) _ _) = + (notIn af incs && notIn af accts) || + (notIn at exps && notIn at accts) || + notIn n ccs + chk (ExchRec _ _ _ a (CCSAmount c1 _) (CCSAmount c2 _) _) = + notIn a accts || notIn c1 ccs || notIn c2 ccs + chk (ToDoRec _ _ _) = False + chk _ = True + notIn _ [] = True + notIn s (r:rs) = s /= getRecName r && notIn s rs + +-- Generate implicit price/date information from buy and sell transactions; +-- presumably, these will have taken place at market price, which is what we +-- want. Only generate info for transactions involving the default currency, +-- other stuff is too hard to untangle at least for now. + +generateImplicitPrices dc trs = gip [] trs + where gip acc [] = filter pr acc + gip acc (t@(ExchRec _ _ _ _ _ _ _):ts) = gip ((genp t) : acc) ts + gip acc (_:ts) = gip acc ts + genp (ExchRec _ date _ _ (CCSAmount n1 a1) (CCSAmount n2 a2) _) + | n1 == dc = PriceRec date True (nC n2 a2 a2) (nC n1 a1 a2) + | n2 == dc = PriceRec date True (nC n1 a1 a1) (nC n2 a2 a1) + | otherwise = CommentRec "general exchange, no price generated" + pr (PriceRec _ _ _ _) = True + pr _ = False + nC n (Amount a1) (Amount a2) = + CCSAmount n (Amount (if a2 == 0 then a1 else a1/a2)) + +getCN (CCSAmount n _) = n +getCA (CCSAmount _ (Amount a)) = a + +addTo [] n = [n] +addTo (q:qs) d = + let qn = getCN q + qq = getCA q + dn = getCN d + dq = getCA d + nq = qq + dq + in if qn == dn + then if nq == 0 + then qs + else (CCSAmount qn (Amount nq)) : qs + else q : addTo qs d + +subFrom acc d = addTo acc (CCSAmount (getCN d) (Amount (-(getCA d)))) + +scaleBy qs d = map (s1 (getCN d) (getCA d)) qs + where s1 dn dq q = + let qn = getCN q + qq = getCA q + in if qn == dn then (CCSAmount qn (Amount (qq * dq))) else q + +maybeRecord reg record newaccs tst = + let isJ = isJust reg + rn = fromJust reg + acc = filter (\a -> fst a == rn) newaccs + nb = if length acc > 0 + then snd (head acc) + else [CCSAmount noName (Amount 0)] + in if isJ && (tst rn || rn == noName) + then recordInfo (record, nb) + else recordNil + +maybeDo reg dorec record isrec accs newaccs tst = + if dorec + then if isrec + then return newaccs + else maybeRecord reg record newaccs tst >> return accs + else maybeRecord reg record newaccs tst >> return newaccs + +exchTrans reg dorec record@(ExchRec _ _ isrec acc amtn amto _) accs = + maybeDo reg dorec record isrec accs + (doExch accs acc amtn amto) (\rn -> rn == acc) + where doExch [] _ _ _ = [] + doExch ((an,ab):as) n en eo = + if an == n + then (an, subFrom (addTo ab en) eo) : as + else (an,ab) : doExch as n en eo + +xferTrans reg dorec record@(XferRec _ isrec from to amt _ _) accs = + maybeDo reg dorec record isrec accs + (doXfer accs from to amt) (\rn -> rn == from || rn == to) + where doXfer [] _ _ _ = [] + doXfer (a@(an,ab):as) nf nt e + | an == nf = (an, subFrom ab e) : doXfer as nf nt e + | an == nt = (an, addTo ab e) : doXfer as nf nt e + | otherwise = a : doXfer as nf nt e + +-- TODO: look into account and see if split is applicable? yeah... cleaner +-- Also: does maybeDo apply here, too? I think probably it should... +-- but is this a reconcilable transaction? It reaches across accounts, +-- so maybe not + +splitTrans reg record@(SplitRec _ ccs (Amount an) (Amount ao)) acc = + let newaccs = map doST acc + in maybeRecord reg record newaccs (\_ -> True) >> return newaccs + where doST (a1,a2) = (a1, scaleBy a2 (CCSAmount ccs (Amount (an/ao)))) + +mkInit as = return (map (\a -> (getRecName a, [])) as) + +appTr _ _ _ [] as = return as +appTr d r f (t:ts) as = + if getRecDate t > d + then return as + else case t of + XferRec _ _ _ _ _ _ _ -> xferTrans r f t as >>= appTr d r f ts + ExchRec _ _ _ _ _ _ _ -> exchTrans r f t as >>= appTr d r f ts + SplitRec _ _ _ _ -> splitTrans r t as >>= appTr d r f ts + ToDoRec _ isrec _ -> + (if isrec then recordNil else recordInfo (t,[])) + >> appTr d r f ts as + _ -> recordErr t >> appTr d r f ts as + +showT (t,_) = putStrLn (show t) + +showTB e@(_,b) = showT e >> mapM_ sB b + where sB ccsa = putStrLn ("\t" ++ show ccsa) + +getBalances date1 date2 reg dorec accts trans = + do let (r,i1,e) = runLedger (mkInit accts >>= appTr date2 reg dorec trans) + i = dropWhile (\t -> compare (getRecDate (fst t)) date1 == LT) i1 + ss = if dorec then showT else showTB + when (length e > 0) + (hPutStrLn stderr "There were parse or date errors in the input:" + >> mapM_ (hPutStrLn stderr . show) e >> error "quitting now") + when (length i > 0) (putStrLn "Notes:" >> mapM_ ss i >> putStrLn "") + return r + +-- For now, we don't generate "swap prices" internally, so unless the user +-- enters some, we won't see any; see also generateImplicitPrices above. + +getPrices nm dc date prices = + do let p1 = dropWhile (\t -> compare date (getRecDate t) == LT) prices + (_,i,e) = runLedger (get p1) + when (length e > 0) (doShow "Swap \"Prices\"" e >> putStrLn "") + when (length i > 0) (doShow "Ordinary Prices" i) + when (length e == 0 && length i == 0) + (putStrLn ("No prices known for " ++ show nm)) + where get [] = return () + get (p@(PriceRec _ _ (CCSAmount nr1 _) (CCSAmount nr2 _)):ps) = + if (nr1 == nm && nr2 == dc) || (nr1 == dc && nr2 == nm) + then recordInfo p >> get ps + else if (nr1 == nm || nr2 == nm) + then recordErr p >> get ps + else get ps + get _ = recordNil + doShow t p = putStrLn t >> mapM_ (putStrLn . show) (reverse p) diff --git a/UMMHelp.hs b/UMMHelp.hs new file mode 100644 --- /dev/null +++ b/UMMHelp.hs @@ -0,0 +1,352 @@ +{- Copyright 2009 Uwe Hollerbach + +This file is part of umm, Uwe's Money Manager. + +umm 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. + +umm 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 umm; if not, write to the Free Software Foundation, Inc., +59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +$Id: UMMHelp.hs,v 1.14 2009/11/18 19:58:47 uwe Exp $ -} + +module UMMHelp (writeHdr, usageMsg) where +import Prelude + +version = "0.1.0" + +writeHdr = + putStrLn + ("Uwe's Money Manager -- umm " ++ version ++ + "\nCopyright 2009 Uwe Hollerbach \n" ++ + "Available under GPL V3 or later. Share and enjoy!\n" ++ + "http://www.korgwal.com/umm/\n") + +-- TODO: store these unadorned in some separate text files, and use +-- a program (Template Haskell?) to turn them into proper source code + +usageMsg prog = + "usage is '" ++ prog ++ " '\n" ++ + "where and can be any of the following:\n" ++ + "\n" ++ + " 'balance' [account-or-group] [date]\n" ++ + " 'change' acc-or-inc-or-exp [date] [date]\n" ++ + " 'list' ['all' | 'accounts' | 'ccs' | 'expenses' | 'incomes' | 'groups']\n" ++ + " 'price' ccs [date]\n" ++ + " 'register' account [date] [date]\n" ++ + " 'reconcile' [account] [date]\n" ++ + " 'todo' [date]\n" ++ + " 'basis' ccs [date]\n" ++ + "\n" ++ + "The commands may be shortened to the unique prefixes or anything\n" ++ + "longer: 'b', 'ba', 'bala' etc, 'reg', 'regi' etc, but not 'r'.\n" ++ + "If no command or options are specified, the default action is\n" ++ + "to show the balances of all accounts as of the current date.\n" ++ + "\n" ++ + "'account' is the name of an account; see the description of 'name'\n" ++ + "below for more details of formatting. Likewise, 'account-or-group'\n" ++ + "is the name of an account or an account group, and 'acc-or-inc-or-exp'\n" ++ + "is the name of an account or an income or expense pseudo-account.\n" ++ + "\n" ++ + "'ccs' is the name of a currency, commodity, or security; again, see\n" ++ + "the description of 'name' below for more details of formatting.\n" ++ + "\n" ++ + "'date' defaults to the current date if not specified; again, see\n" ++ + "below for details of formatting.\n" ++ + "\n" ++ + "--------\n" ++ + "\n" ++ + "* 'balance' shows the balance in the specified account or group,\n" ++ + " or in all accounts if none is specified, as of the given date.\n" ++ + "\n" ++ + "\n" ++ + "* 'price' shows the price history of the specified currency, commodity,\n" ++ + " or security, up to the specified date.\n" ++ + "\n" ++ + "\n" ++ + "* 'change' shows the change in the specified account or pseudo-account\n" ++ + " between the two given dates, or from the beginning of the ledger to\n" ++ + " the specified date.\n" ++ + "\n" ++ + "\n" ++ + "* 'price' shows the price history of the specified currency,\n" ++ + " commodity, or security, up to the specified date.\n" ++ + "\n" ++ + "\n" ++ + "* 'register' shows all transactions involving the specified\n" ++ + " account up to the given date, and shows the balance as of\n" ++ + " that date.\n" ++ + "\n" ++ + " If 'register' is given two dates, it prints transactions from\n" ++ + " the earlier to the later date.\n" ++ + "\n" ++ + "\n" ++ + "* 'reconcile' applies all reconciled transactions up to the\n" ++ + " given date, shows relevant unreconciled transactions up to\n" ++ + " that date, and shows the reconciled balance(s) as of that\n" ++ + " date.\n" ++ + "\n" ++ + " If 'reconcile' is given an account, then only unreconciled\n" ++ + " transactions involving that account are shown, otherwise all\n" ++ + " unreconciled transactions are shown\n" ++ + "\n" ++ + "\n" ++ + "* 'todo' shows all the unreconciled 'todo' items in the ledger\n" ++ + " up to the date specified, defaulting to the current date\n" ++ + "\n" ++ + "\n" ++ + "* 'list' shows summaries of the various kinds of non-transaction\n" ++ + " entries in the ledger file: currencies/commodities/securities,\n" ++ + " income and expense categories, accounts, and groups\n" ++ + "\n" ++ + "\n" ++ + "* 'basis' will eventually show the cost basis for a given currency\n" ++ + " or commodity or security. It is not yet implemented.\n" ++ + "\n" ++ + "--------\n" ++ + "\n" ++ + "There are several kinds of records in a ledger file:\n" ++ + "\n" ++ + " 'ccs' name [desc]\n" ++ + " 'income' name [desc]\n" ++ + " 'expense' name [desc]\n" ++ + " 'account' name date [desc]\n" ++ + " 'group' name [name...]\n" ++ + " 'price' date [amount1] name1 amount2 [name2]\n" ++ + " 'split' date name amount1 amount2\n" ++ + " 'todo' [rec] date text\n" ++ + " 'xfer' [rec] date name1 name2 amount [name] [desc] [id]\n" ++ + " 'exch' [rec] date name amount1 name1 amount2 [name2] [desc]\n" ++ + "\n" ++ + "There are also 'buy' and 'sell' records which are just\n" ++ + "syntactic sugar for 'exch'; see more details below in the\n" ++ + "section describing the meaning of each type of record. The\n" ++ + "individual fields for each record are separated by whitespace.\n" ++ + "\n" ++ + "Blank lines or lines whose first non-blank character is '#'\n" ++ + "are treated as comments and are ignored.\n" ++ + "\n" ++ + "Syntactically, all of these are optional: there are no\n" ++ + "required records, and an empty ledger file is syntactically\n" ++ + "legal. However, a minimally-useful ledger file will probably\n" ++ + "contain at least some 'xfer' records, which in turn require\n" ++ + "that there be at least a couple of 'account' or 'income' or\n" ++ + "'expense' records.\n" ++ + "\n" ++ + "The order of records in the ledger file is not significant;\n" ++ + "the program orders them by type and date, and applies\n" ++ + "transactions in order by date.\n" ++ + "\n" ++ + "\n" ++ + "The meaning of each record type is as follows:\n" ++ + "\n" ++ + "* 'ccs name [desc]' describes a currency or commodity or\n" ++ + " security: the things you want to keep track of. The first\n" ++ + " ccs record in the ledger file is the default unit; my ledger\n" ++ + " file has 'ccs US$' very near the top. However, you don't\n" ++ + " need one, in which case the program computes in Zorkmid\n" ++ + " ('zm'). If you don't enter any 'ccs' record, you can't\n" ++ + " specify any units in 'xfer' records, and you can't use any\n" ++ + " 'price' or 'split' records. You can use 'exch' (and 'buy'\n" ++ + " and 'sell') records, but they probably won't be very useful,\n" ++ + " since all you can do is to trade one amount of Zorkmids for\n" ++ + " another. The 'desc' field in a ccs record is currently just\n" ++ + " for documentation, it's not used by the program.\n" ++ + "\n" ++ + "\n" ++ + "* 'account name date [desc]' records specify accounts where you\n" ++ + " want to keep of the quantity of what's in the account as well\n" ++ + " as transactions which move stuff into or out of the account.\n" ++ + " An account can contain multiple types of ccs, for example a\n" ++ + " single account could be used to describe a brokerage account\n" ++ + " containing many securities as well as cash. The date and desc\n" ++ + " fields are currently just for documentation and are not used\n" ++ + " by the program.\n" ++ + "\n" ++ + "\n" ++ + "* 'group name [name...]' groups multiple accounts together into one\n" ++ + " group, so that it's possible to query the balances for a group of\n" ++ + " accounts as a whole.\n" ++ + "\n" ++ + "\n" ++ + "* 'income name [desc]' and 'expense name [desc]' records specify\n" ++ + " pseudo-accounts where you don't want to keep track of what's\n" ++ + " inside, just the transactions: think of these as categories.\n" ++ + " 'income' specifies a source of ccs, and 'expense' specifies a\n" ++ + " destination or sink. The desc field is currently just for\n" ++ + " documentation. You can, to some extent, circumvent the source\n" ++ + " or sink nature by entering a transaction from a source to an\n" ++ + " account, but with a negative amount: this would actually take\n" ++ + " money out of the account. This is intended for VERY OCCASIONAL\n" ++ + " overrides, say you overpaid a utility bill and get a credit\n" ++ + " which you don't want to just apply to the next bill. Don't\n" ++ + " abuse this!\n" ++ + "\n" ++ + "\n" ++ + "* 'price date [amount1] name1 amount2 [name2]' records are\n" ++ + " used to specify the price of one ccs in terms of another;\n" ++ + " usually a currency. If the first amount is not specified,\n" ++ + " it defaults to 1, and if the second name is not specified,\n" ++ + " it defaults to the default ccs. For example, if you are\n" ++ + " tracking ounces of gold using the ccs name 'Au', you might\n" ++ + " have a price record\n" ++ + "\n" ++ + " price 2009-10-21 Au 1063.70\n" ++ + "\n" ++ + " and if you track ounces but for some reason have a price quote\n" ++ + " in grams, you might write\n" ++ + "\n" ++ + " price 2009-10-21 0.03215075 Au 34.19875 US$\n" ++ + "\n" ++ + " 'name1' (and 'name2', if specified) must be specified in the\n" ++ + " ledger by 'ccs' records.\n" ++ + "\n" ++ + "\n" ++ + "* 'split date name amount1 amount2' records are used to specify\n" ++ + " stock splits: 'name' is the name of the security being split,\n" ++ + " which must be specified in the ledger by a 'ccs' record, 'date'\n" ++ + " is the date of the split, and 'amount1' and 'amount2' are the\n" ++ + " new and old numbers of shares, respectively. In the markets,\n" ++ + " these are usually integers, but the program does not require\n" ++ + " this. For example, General Electric did a 3:1 stock split on\n" ++ + " May 8, 2000, which could be specified as\n" ++ + "\n" ++ + " split 2000-5-8 GE 3 1\n" ++ + "\n" ++ + " but if you're feeling perverse you could also write any of\n" ++ + "\n" ++ + " split 2000-5-8 GE 1 1/3\n" ++ + " split 2000-5-8 GE 1.5 0.5\n" ++ + " split 2000-5-8 GE 15/7 5/7\n" ++ + "\n" ++ + "\n" ++ + "* 'xfer [rec] date name1 name2 amount [name] [desc] [id]'\n" ++ + " records are used to transfer 'amount' of 'name' from account\n" ++ + " 'name1' to account 'name2'; 'name1' may be either an account\n" ++ + " specified by an 'account' record, or a source specified by\n" ++ + " an 'income' record. If you don't specify the name of what's\n" ++ + " being transferred, the program assumes it's the default ccs,\n" ++ + " US$ or Zorkmids or whatever. For example, this record from my\n" ++ + " ledger file\n" ++ + "\n" ++ + " xfer* 2009/2/27 interest abc:savings 0.01\n" ++ + "\n" ++ + " says that on February 27, 2009, one penny interest was credited\n" ++ + " to my ABC Bank savings account, and this record\n" ++ + "\n" ++ + " xfer* 2009/9/26 checking utility:water 43.99 1216\n" ++ + "\n" ++ + " is the payment of my water bill, in the amount of US$ 43.99,\n" ++ + " with check #1216.\n" ++ + "\n" ++ + " Both of these are marked as reconciled; this affects only\n" ++ + " the 'reconcile' command: when that command is run, reconciled\n" ++ + " transactions are included in the reconciled balance and are\n" ++ + " not printed, whereas not-reconciled transactions are printed\n" ++ + " but not included in the reconciled balance.\n" ++ + "\n" ++ + "\n" ++ + "* 'exch [rec] date name amount1 name1 amount2 [name2] [desc]'\n" ++ + " records and their aliases 'buy and 'sell' are used to trade\n" ++ + " some amount of one ccs for another. To some extent, these\n" ++ + " are syntactic sugar: the same could be accomplished with a\n" ++ + " pair of 'xfer' records, but this is a little clearer and\n" ++ + " less error-prone. In 'exch' and 'buy' records,\n" ++ + " (amount1,name1) is the new quantity coming into the account\n" ++ + " named 'name', and (amount2,name2) is the quantity leaving\n" ++ + " the account; for example\n" ++ + "\n" ++ + " exch 2009-7-10 brokerage 300 MTLQQ.PK 300 GM \"rename GM\"\n" ++ + "\n" ++ + " might be an entry describing the name change of GM shares\n" ++ + " when GM went through bankruptcy (I'm not sure of the date though,\n" ++ + " and in any case shareholders of \"old GM\" wouldn't simply\n" ++ + " get shares of \"new GM\"... but ignore that), and\n" ++ + "\n" ++ + " buy 2009/10/2 brokerage 3.959 VTSMX 100\n" ++ + "\n" ++ + " might be an entry describing a regular automatic purchase of\n" ++ + " VTSMX. For 'sell' records, the order is reversed: the first\n" ++ + " pair (amount1,name1) describes what's being sold, ie, going\n" ++ + " out of the account, and the second pair (amount2,name2) shows\n" ++ + " what's being acquired in exchange. Thus\n" ++ + "\n" ++ + " sell 2009/10/2 brokerage 3.959 VTSMX 100\n" ++ + "\n" ++ + " would undo the previous 'buy' transaction. These could both be\n" ++ + " written as 'exch' instead, as follows; I've added the explicit\n" ++ + " specifier of US$.\n" ++ + "\n" ++ + " exch 2009/10/2 brokerage 3.959 VTSMX 100 US$\n" ++ + " exch 2009/10/2 brokerage 100 US$ 3.959 VTSMX\n" ++ + "\n" ++ + "\n" ++ + "* 'todo [rec] date text' is basically a sticky note in the\n" ++ + " ledger. If the record is not marked as reconciled, and the\n" ++ + " date falls within the range of the command being executed,\n" ++ + " the text is printed out. If the record is marked as\n" ++ + " reconciled, the text is not printed out; the record merely\n" ++ + " serves as a comment in the ledger. This is for leaving\n" ++ + " yourself reminders of stuff that needs to be done at some\n" ++ + " time: for example, my ledger file has entries\n" ++ + "\n" ++ + " todo 2009/12/1 Start actively gathering tax info\n" ++ + " todo 2010/4/10 Taxes better be done!!!\n" ++ + "\n" ++ + " yet I won't be bothered by seeing these until those dates\n" ++ + " have passed (or if I do a query for some time in the future).\n" ++ + "\n" ++ + "\n" ++ + "In the above:\n" ++ + "\n" ++ + "* 'name' is a sequence of non-blank characters whose first\n" ++ + " character is a letter and whose remaining characters are\n" ++ + " letters or digits or symbols from the set !$%&*+-/:<=>?@^_~\n" ++ + "\n" ++ + "\n" ++ + "* 'date' is a date formatted as Y/M/D or Y-M-D, where no\n" ++ + " assumptions are made about implicit century years etc:\n" ++ + " what you enter is what's there, so 98-1-27, for example,\n" ++ + " is a date describing the death of the roman emperor Nerva\n" ++ + " and the beginning of the reign of his successor Trajan,\n" ++ + " not January 27, 1998. The program knows that there are\n" ++ + " 12 months in a year, and how many days there are in each\n" ++ + " month (including leap years, for which it assumes the use\n" ++ + " of the proleptic Gregorian calendar), and it checks these\n" ++ + " for validity; it makes no assumptions about the validity\n" ++ + " of the year. Years BC cannot be entered... this is probably\n" ++ + " not a significant limitation.\n" ++ + "\n" ++ + "\n" ++ + "* 'desc' is an arbitrary string enclosed in double quotes:\n" ++ + " \"a string\". It may contain embedded escaped characters\n" ++ + " and escaped quotes, using a back-slash for escaping:\n" ++ + " \"this is a\\\" string with \\n embedded quote and newline\".\n" ++ + "\n" ++ + "\n" ++ + "* 'amount' is a rational number formatted in one of several\n" ++ + " ways: one or more digits, possibly followed by a decimal\n" ++ + " point '.' and zero or more digits ('\\d+(\\.\\d*)?' in perl\n" ++ + " regexp-speak), or a decimal point '.' followed by one or\n" ++ + " more digits ('\\.\\d+'), or two sequences of one or more\n" ++ + " digits each separated by '/' ('\\d+\\/\\d+'). In all cases,\n" ++ + " an optional sign, '+' or '-', may precede the rational\n" ++ + " number.\n" ++ + "\n" ++ + "\n" ++ + "* 'rec' is a reconciliation mark: an asterisk '*'. It may\n" ++ + " immediately follow the record type, or it may be separated\n" ++ + " from the record type by whitespace: ie, both 'todo*' and\n" ++ + " 'todo *' are legal.\n" ++ + "\n" ++ + "\n" ++ + "* 'id' (in an 'xfer' record) is a sequence of digits: a\n" ++ + " check number or other identifying number." diff --git a/UMMParser.hs b/UMMParser.hs new file mode 100644 --- /dev/null +++ b/UMMParser.hs @@ -0,0 +1,347 @@ +{- Copyright 2009 Uwe Hollerbach + +This file is part of umm, Uwe's Money Manager. + +umm 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. + +umm 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 umm; if not, write to the Free Software Foundation, Inc., +59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +$Id: UMMParser.hs,v 1.28 2009/11/14 22:41:36 uwe Exp $ -} + +-- TODO: template := + +module UMMParser (parseURecord, parseUDate, parseUCommand) where +import Prelude +import Data.Char +import Data.Ratio +import Text.ParserCombinators.Parsec as TPCP hiding (spaces) + +import UMMData + +readInt s = foldl ma 0 s + where ma v1 v2 = 10*v1 + (toInteger (digitToInt v2)) + +readAmt ip fp = + let l = length fp + e = 10^l + iv = readInt ip + fv = readInt fp + in (e*iv + fv) % e + +trimspace str = f (f str) + where f = dropWhile isSpace . reverse + +-- Hide parsec's spaces and substitute this one: +-- want "spaces" to mean an actual something there + +spaces = many1 space + +escChar = + do char '\\' + c <- anyChar + return (case c of + 'a' -> chr 7 + 'b' -> chr 8 + 't' -> '\t' + 'n' -> '\n' + 'v' -> chr 11 + 'f' -> chr 12 + 'r' -> '\r' + _ -> c) + +-- The usual quoted-string with escaped quotes inside + +parseString = + do spaces + char '"' + str <- many (escChar <|> (noneOf "\"")) + char '"' + return str + +parseOptionalString = option "" (TPCP.try parseString) + +-- TODO: are there some here that we need to add or remove? + +symbol = oneOf "!$%&*+-/:<=>?@^_~" + +parseName = + do spaces + first <- letter + rest <- many (letter <|> digit <|> symbol) + return (Name (first:rest)) + +parseOptionalName = option (Name "") (TPCP.try parseName) + +parseInt = many1 digit >>= return . readInt + +-- Parse first alternative for amounts: \d+(\.\d*)? + +parseAmt1 = + do ip <- many1 digit + fp <- option "" (char '.' >> many digit) + return (readAmt ip fp) + +-- Parse second alternative for amounts: \.\d+ + +parseAmt2 = + do char '.' + fp <- many1 digit + return (readAmt "0" fp) + +-- Parse third alternative for amounts: \d+/\d+: this is how rationals +-- get displayed if they're not integers scaled by a power of 10, so +-- we'd better be able to handle them... + +parseAmt3 = + do n <- parseInt + char '/' + d <- parseInt + return (n%d) + +-- Parse a floating-point-formatted number as either \d+(\.\d*)? or \.\d+ + +parseAmount = + do many space + s <- option '+' (oneOf "+-") + v <- (TPCP.try parseAmt3) <|> + parseAmt1 <|> + parseAmt2 + return (Amount (if s == '+' then v else negate v)) + +parseOptionalAmount = option (Amount 1) (TPCP.try parseAmount) + +-- A date: three groups of digits separated by '/' or '-' (but not mixed) +-- where the first group of digits is the year, the second the month, and +-- the third the day: YYYY/MM/DD or YYYY-MM-DD: no messing around with +-- whether days come first or months, and also no implicit 19xx or 20xx +-- or whatever. + +parseDate = + do spaces + y <- parseInt + m <- pMS '/' <|> pMS '-' + d <- parseInt + return (Date (fromInteger y) (fromInteger m) (fromInteger d)) + where pMS s = + do char s + m <- parseInt + char s + return m + +parseReconcile = + option False (TPCP.try (many space >> char '*' >> return True)) + +-- The top-level record parsers + +parseCIE = + do rtype <- string "ccs" <|> string "income" <|> string "expense" + name <- parseName + desc <- parseOptionalString + return (case rtype of + "ccs" -> CCSRec name desc + "income" -> IncomeRec name desc + "expense" -> ExpenseRec name desc) + +parseAccount = + do string "account" + name <- parseName + date <- parseDate + desc <- parseOptionalString + return (AccountRec name date desc) + +parseGroup = + do string "group" + names <- many1 parseName + return (GroupRec (head names) (tail names)) + +parsePrice = + do string "price" + date <- parseDate + amt1 <- parseOptionalAmount + name1 <- parseName + amt2 <- parseAmount + name2 <- parseOptionalName + return (PriceRec date False (CCSAmount name1 amt1) (CCSAmount name2 amt2)) + +parseXfer = + do string "xfer" + rec <- parseReconcile + date <- parseDate + acc1 <- parseName + acc2 <- parseName + amt <- parseAmount + ccs <- parseOptionalName + memo <- parseOptionalString + chknum <- option 0 (TPCP.try (spaces >> parseInt)) + return (XferRec date rec acc1 acc2 (CCSAmount ccs amt) + memo (fromInteger chknum)) + +-- 'buy' and 'sell' are purely syntactic sugar for 'exch': 'buy' is +-- exactly the same, and 'sell' is the same as if {amt1,ccs1} and +-- {amt2,ccs2} were swapped in an exch + +parseEBS = + do rtype <- string "buy" <|> string "sell" <|> string "exch" + rec <- parseReconcile + date <- parseDate + acct <- parseName + amt1 <- parseAmount + name1 <- parseName + amt2 <- parseAmount + name2 <- parseOptionalName + memo <- parseOptionalString + let et = case rtype of + "buy" -> B + "sell" -> S + "exch" -> E + ccsa1 = CCSAmount name1 amt1 + ccsa2 = CCSAmount name2 amt2 + if et == S + then return (ExchRec et date rec acct ccsa2 ccsa1 memo) + else return (ExchRec et date rec acct ccsa1 ccsa2 memo) + +parseSplit = + do string "split" + date <- parseDate + name <- parseName + amt1 <- parseAmount + amt2 <- parseAmount + return (SplitRec date name amt1 amt2) + +parseTodo = + do string "todo" + rec <- parseReconcile + date <- parseDate + spaces + memo <- many anyChar + return (ToDoRec date rec (trimspace memo)) + +parseComment = + do many1 (char '#') + many space + comment <- many anyChar + return (CommentRec (trimspace comment)) + +parseBlank = many space >> return (CommentRec "") + +parseRecord = + do many space + record <- parsePrice + <|> parseXfer + <|> (TPCP.try parseCIE) + <|> (TPCP.try parseEBS) + <|> parseSplit + <|> parseTodo + <|> (TPCP.try parseAccount) + <|> parseGroup + <|> parseComment + <|> parseBlank -- this must be last, as it can match nothing + many space + eof + return record + +parseURecord input = + case parse parseRecord "umm record" input of + Left _ -> ErrorRec input + Right val -> val + +parseUDate input = parse parseDate "umm date" (" " ++ input) + +parsePrefixOf n str = + string (take n str) >> opts (drop n str) >> return str + where opts [] = return () + opts (c:cs) = optional (char c >> opts cs) + +parseCmdBalance now = + do parsePrefixOf 3 "balance" + name <- parseOptionalName + date <- option now (TPCP.try parseDate) + return (BalanceCmd name date) + +parseCmdBasis now = + do parsePrefixOf 3 "basis" + name <- parseName + date <- option now (TPCP.try parseDate) + return (BasisCmd name date) + +-- TODO: make verbose/nonverbose work... somehow add optional verbosity +-- ok, this is really cheesy! make it better! + +parseCmdChange now = + do parsePrefixOf 1 "change" + name <- parseName + date1 <- option now parseDate + date2 <- option start_time parseDate + if compare date2 date1 == LT + then return (ChangeCmd True name date2 date1) + else return (ChangeCmd False name date1 date2) + +parseCmdList = + do parsePrefixOf 1 "list" + many space + w <- option "all" (parsePrefixOf 1 "ccs" <|> + parsePrefixOf 1 "groups" <|> + parsePrefixOf 1 "incomes" <|> + parsePrefixOf 1 "expenses" <|> + TPCP.try (parsePrefixOf 2 "all") <|> + parsePrefixOf 2 "accounts") + return (ListDataCmd (case w of + "all" -> COLAll + "ccs" -> COLCCS + "accounts" -> COLAccts + "groups" -> COLGrps + "incomes" -> COLIncs + "expenses" -> COLExps)) + +parseCmdPrice now = + do parsePrefixOf 1 "price" + name <- parseName + date <- option now (TPCP.try parseDate) + return (PriceCmd name date) + +parseCmdReconcile now = + do parsePrefixOf 3 "reconcile" + name <- parseOptionalName + date <- option now (TPCP.try parseDate) + return (ReconcileCmd name date) + +parseCmdRegister now = + do parsePrefixOf 3 "register" + name <- parseName + date1 <- option now (TPCP.try parseDate) + date2 <- option start_time (TPCP.try parseDate) + if compare date2 date1 == LT + then return (RegisterCmd name date2 date1) + else return (RegisterCmd name date1 date2) + +parseCmdToDo now = + do parsePrefixOf 1 "todo" + date <- option now (TPCP.try parseDate) + return (ToDoCmd date) + +parseCommand date = + do cmd <- parseCmdChange date + <|> parseCmdList + <|> parseCmdPrice date + <|> parseCmdToDo date + <|> TPCP.try (parseCmdBalance date) + <|> parseCmdBasis date + <|> TPCP.try (parseCmdRegister date) + <|> parseCmdReconcile date + eof + return cmd + +parseUCommand now input = + case parse (parseCommand now) "umm command" input of + Left err -> error (show err) + Right val -> val diff --git a/sample1.dat b/sample1.dat new file mode 100644 --- /dev/null +++ b/sample1.dat @@ -0,0 +1,39 @@ +ccs US$ "The Almighty Buck" + +income cash +income interest expense cash + +account acc1 2009-9-1 "test account 1" +account acc2 2009-9-1 "test account 2" + +group all acc1 acc2 ccs FOO "The Foo Companies" +ccs BAR "The Bar Companies" ccs CLAM "Groupe Mollusque" + +xfer 2009-9-1 cash acc1 100 buy 2009-9-1 acc1 10 FOO 15 +xfer 2009-9-2 interest acc1 0.25 buy 2009-9-2 acc1 20 FOO 27 +xfer 2009-9-3 acc1 cash 5.25 + +xfer 2009-9-1 cash acc2 100 buy 2009-9-1 acc2 10 BAR 25 +xfer 2009-9-2 interest acc2 0.25 + buy 2009-9-2 acc2 20 FOO 27 + xfer 2009-9-3 acc2 cash 5.25 + xfer 2009-9-4 acc1 acc2 25 + +xfer 2009-9-5 cash acc1 200 buy 2009-9-5 acc1 30 FOO 40 +buy 2009-9-5 acc1 30 BAR 40 + +price 2009-9-5 FOO 1.5 + +xfer 2009-9-6 cash acc1 20 CLAM + +price 2009-10-21 FOO 2.1 +price 2009-10-24 FOO 2.4 +price 2009-10-25 FOO 2.5 +price 2009-10-23 FOO 2.3 +price 2009-10-22 FOO 2.2 + +price 2009-10-25 BAR 3.25 +price 2009-10-27 3 BAR 10 + +split 2009-11-5 CLAM 2 1 +price 2009-11-11 CLAM 0.001 diff --git a/sample2.dat b/sample2.dat new file mode 100644 --- /dev/null +++ b/sample2.dat @@ -0,0 +1,323 @@ +# Copyright 2009 Uwe Hollerbach +# +# This file is part of umm, Uwe's Money Manager. +# +# $Id: sample1.dat,v 1.4 2009/11/09 23:07:22 uwe Exp $ + +# Sample ledger file: a small investment club with 6 people, +# investing 50 dollars each twice per month + +# NAMES AND VALUES OF SECURITIES ARE TOTALLY FAKE AND MADE UP + +todo 2009-10-15 Search for "run" in the ledger file, then run each command +todo 2009-10-15 as indicated, and follow along with the numbers. The club +todo 2009-10-15 doesn't begin until 2150, so you'll see all [empty] here! + +################################################################ +# actual ledger begins here + +# The format of the club will be: +# +# 1) at each meeting, we determine the value of a share, +# initially 50 US$ +# +# 2) from cash, we put money into each member's account, +# then transfer that cash into the club account +# then transfer the appropriate number of shares back to each member +# +# 3) the club account will therefore contain cash and/or securities +# and a negative number of club shares: its net value will always +# equal 0, which determines the value of a share; +# member accounts will contain increasing numbers of club shares +# and temporarily +# +# 4) periodically, the club invests, turning cash in the club account +# into securities + +ccs US$ "The Almighty Buck" + +income cash +income interest +expense cash + +# This is the source of contribution cash. This is slightly convoluted, +# we're doing it this way to easily track the total contributions over +# time. If desired, we could have an individual contributions account for +# each member, cont-Al, cont-Barb, etc, but that would be even worse. +# With macros, this would be a lot easier: a one-line macro could expand +# to several transactions. + +account contributions 2150-1-1 "The source of contributions" + +account Al 2150-1-1 "Alfred the Butler" +account Barb 2150-1-1 "Barbarella, Queen of the Galaxy" +account Chas 2150-1-1 "Karolus Magnus, Imperator Romanorum et Rex Francorum" +account Deb 2150-1-1 "Debutante Smashingella" +account Ed 2150-1-1 "AEthelraed the Unready" +account Frank 2150-1-1 "Dr Frank N Furter" + +account club 2150-1-1 "Le Club d'Investment" +ccs share "A share of Le Club" + +# Exclude contributions from this so that we see just the value of +# the club as a whole and of each member's shares, not also the +# contributions. + +group all Al Barb Chas Deb Ed Frank club + +# meeting 1 + +xfer 2150-1-1 contributions Al 50 +xfer 2150-1-1 Al club 50 +xfer 2150-1-1 club Al 1 share +xfer 2150-1-1 contributions Barb 50 +xfer 2150-1-1 Barb club 50 +xfer 2150-1-1 club Barb 1 share +xfer 2150-1-1 contributions Chas 50 +xfer 2150-1-1 Chas club 50 +xfer 2150-1-1 club Chas 1 share +xfer 2150-1-1 contributions Deb 50 +xfer 2150-1-1 Deb club 50 +xfer 2150-1-1 club Deb 1 share +xfer 2150-1-1 contributions Ed 50 +xfer 2150-1-1 Ed club 50 +xfer 2150-1-1 club Ed 1 share +xfer 2150-1-1 contributions Frank 50 +xfer 2150-1-1 Frank club 50 +xfer 2150-1-1 club Frank 1 share + +# run "umm sample1.dat bal 2150-1-14" +# to find that share price is 300/6 = 50 + +# meeting 2 + +xfer 2150-1-15 contributions Al 50 +xfer 2150-1-15 Al club 50 +xfer 2150-1-15 club Al 1 share +xfer 2150-1-15 contributions Barb 50 +xfer 2150-1-15 Barb club 50 +xfer 2150-1-15 club Barb 1 share +xfer 2150-1-15 contributions Chas 50 +xfer 2150-1-15 Chas club 50 +xfer 2150-1-15 club Chas 1 share +xfer 2150-1-15 contributions Deb 50 +xfer 2150-1-15 Deb club 50 +xfer 2150-1-15 club Deb 1 share +xfer 2150-1-15 contributions Ed 50 +xfer 2150-1-15 Ed club 50 +xfer 2150-1-15 club Ed 1 share +xfer 2150-1-15 contributions Frank 50 +xfer 2150-1-15 Frank club 50 +xfer 2150-1-15 club Frank 1 share + +xfer 2150-1-30 interest club 3 + +# run "umm sample1.dat bal 2150-1-30" +# to find that share price is 603/12 = 50.25, +# so each member buys $50/$50.25 = 0.995025... shares + +# meeting 3 + +xfer 2150-2-1 contributions Al 50 +xfer 2150-2-1 Al club 50 +xfer 2150-2-1 club Al 0.995025 share +xfer 2150-2-1 contributions Barb 50 +xfer 2150-2-1 Barb club 50 +xfer 2150-2-1 club Barb 0.995025 share +xfer 2150-2-1 contributions Chas 50 +xfer 2150-2-1 Chas club 50 +xfer 2150-2-1 club Chas 0.995025 share +xfer 2150-2-1 contributions Deb 50 +xfer 2150-2-1 Deb club 50 +xfer 2150-2-1 club Deb 0.995025 share +xfer 2150-2-1 contributions Ed 50 +xfer 2150-2-1 Ed club 50 +xfer 2150-2-1 club Ed 0.995025 share +xfer 2150-2-1 contributions Frank 50 +xfer 2150-2-1 Frank club 50 +xfer 2150-2-1 club Frank 0.995025 share + +# run "umm sample1.dat bal 2150-2-14" +# to find that share price is 903/17.97015 +# so each member still buys 0.995025... shares +# but AEthelraed doesn't contribute, +# and Frank can only afford $40 this time + +# meeting 4 + +xfer 2150-2-15 contributions Al 50 +xfer 2150-2-15 Al club 50 +xfer 2150-2-15 club Al 0.995025 share +xfer 2150-2-15 contributions Barb 50 +xfer 2150-2-15 Barb club 50 +xfer 2150-2-15 club Barb 0.995025 share +xfer 2150-2-15 contributions Chas 50 +xfer 2150-2-15 Chas club 50 +xfer 2150-2-15 club Chas 0.995025 share +xfer 2150-2-15 contributions Deb 50 +xfer 2150-2-15 Deb club 50 +xfer 2150-2-15 club Deb 0.995025 share +todo 2150-2-15 AEthelraed misses, Frank partial! +xfer 2150-2-15 contributions Frank 40 +xfer 2150-2-15 Frank club 40 +xfer 2150-2-15 club Frank 0.79602 share + +xfer 2150-2-28 interest club 6 + +# run "umm sample1.dat bal 2150-2-28" +# to find that share price is 1149/22.74627 = 50.513777 +# so each member buys $50/$50.513777 = 0.989829... shares + +# meeting 5 + +xfer 2150-3-1 contributions Al 50 +xfer 2150-3-1 Al club 50 +xfer 2150-3-1 club Al 0.989829 share +xfer 2150-3-1 contributions Barb 50 +xfer 2150-3-1 Barb club 50 +xfer 2150-3-1 club Barb 0.989829 share +xfer 2150-3-1 contributions Chas 50 +xfer 2150-3-1 Chas club 50 +xfer 2150-3-1 club Chas 0.989829 share +xfer 2150-3-1 contributions Deb 50 +xfer 2150-3-1 Deb club 50 +xfer 2150-3-1 club Deb 0.989829 share +xfer 2150-3-1 contributions Ed 50 +xfer 2150-3-1 Ed club 50 +xfer 2150-3-1 club Ed 0.989829 share +xfer 2150-3-1 contributions Frank 50 +xfer 2150-3-1 Frank club 50 +xfer 2150-3-1 club Frank 0.989829 share + +# members determine to buy shares in Insatiable Enterprises, +# which is currently trading about $44 per share; +# transaction gets executed a couple of days later + +ccs IE "Insatiable Enterprises" + +xfer 2150-3-4 club cash 9 "commission to broker" +buy 2150-3-4 club 32 IE 1415.36 "bought shares at 44.23" + +# IE has gone down slightly by next meeting +price 2150-3-14 IE 43.95 + +# run "umm sample1.dat bal 2150-3-14" +# to find that club owns 32 shares of IE worth $1406.40, plus $24.64 +# against 28.685244 shares outstanding: each share is worth $49.887670 +# so each member buys 1.002252 shares + +# meeting 6 + +xfer 2150-3-15 contributions Al 50 +xfer 2150-3-15 Al club 50 +xfer 2150-3-15 club Al 1.002252 share +xfer 2150-3-15 contributions Barb 50 +xfer 2150-3-15 Barb club 50 +xfer 2150-3-15 club Barb 1.002252 share +xfer 2150-3-15 contributions Chas 50 +xfer 2150-3-15 Chas club 50 +xfer 2150-3-15 club Chas 1.002252 share +xfer 2150-3-15 contributions Deb 50 +xfer 2150-3-15 Deb club 50 +xfer 2150-3-15 club Deb 1.002252 share +xfer 2150-3-15 contributions Ed 50 +xfer 2150-3-15 Ed club 50 +xfer 2150-3-15 club Ed 1.002252 share +xfer 2150-3-15 contributions Frank 50 +xfer 2150-3-15 Frank club 50 +xfer 2150-3-15 club Frank 1.002252 share + +# uh-oh, IE might not have been a good buy! +price 2150-3-30 IE 38.11 +xfer 2150-3-30 interest club 1.62 + +# run "umm sample1.dat bal 2150-3-30" +# to find that club owns 32 shares of IE worth $1219.52, plus $326.26 +# against 34.698756 shares outstanding: each share is worth $44.548571 +# so each member buys 1.122370 shares + +# meeting 7 + +xfer 2150-4-1 contributions Al 50 +xfer 2150-4-1 Al club 50 +xfer 2150-4-1 club Al 1.122370 share +xfer 2150-4-1 contributions Barb 50 +xfer 2150-4-1 Barb club 50 +xfer 2150-4-1 club Barb 1.122370 share +xfer 2150-4-1 contributions Chas 50 +xfer 2150-4-1 Chas club 50 +xfer 2150-4-1 club Chas 1.122370 share +xfer 2150-4-1 contributions Deb 50 +xfer 2150-4-1 Deb club 50 +xfer 2150-4-1 club Deb 1.122370 share +xfer 2150-4-1 contributions Ed 50 +xfer 2150-4-1 Ed club 50 +xfer 2150-4-1 club Ed 1.122370 share +xfer 2150-4-1 contributions Frank 50 +xfer 2150-4-1 Frank club 50 +xfer 2150-4-1 club Frank 1.122370 share + +# members still believe in IE, so decide to buy more + +xfer 2150-4-4 club cash 9 "commission to broker" +buy 2150-4-4 club 16 IE 607.20 "bought shares at 37.95" + +# IE has recovered a little bit +price 2150-4-14 IE 39.50 + +# run "umm sample1.dat bal 2150-4-14" +# to find that club owns 48 shares of IE worth $1896.00, plus $10.06 +# against 41.432976 shares outstanding: each share is worth $46.003454 +# so each member buys 1.086875 shares + +# meeting 8 + +xfer 2150-4-15 contributions Al 50 +xfer 2150-4-15 Al club 50 +xfer 2150-4-15 club Al 1.086875 share +xfer 2150-4-15 contributions Barb 50 +xfer 2150-4-15 Barb club 50 +xfer 2150-4-15 club Barb 1.086875 share +xfer 2150-4-15 contributions Chas 50 +xfer 2150-4-15 Chas club 50 +xfer 2150-4-15 club Chas 1.086875 share +xfer 2150-4-15 contributions Deb 50 +xfer 2150-4-15 Deb club 50 +xfer 2150-4-15 club Deb 1.086875 share +xfer 2150-4-15 contributions Ed 50 +xfer 2150-4-15 Ed club 50 +xfer 2150-4-15 club Ed 1.086875 share +xfer 2150-4-15 contributions Frank 50 +xfer 2150-4-15 Frank club 50 +xfer 2150-4-15 club Frank 1.086875 share + +# IE goes up very nicely! +price 2150-4-30 IE 51.43 +xfer 2150-4-30 interest club 1.54 + +# run "umm sample1.dat bal 2150-4-30" +# to find that club owns 48 shares of IE worth $2468.64, plus $311.60 +# against 47.954226 shares outstanding: each share is worth $57.976955 +# so each member buys 0.862412 shares... but AEthelraed misses again + +# meeting 9 + +xfer 2150-5-1 contributions Al 50 +xfer 2150-5-1 Al club 50 +xfer 2150-5-1 club Al 0.862412 share +xfer 2150-5-1 contributions Barb 50 +xfer 2150-5-1 Barb club 50 +xfer 2150-5-1 club Barb 0.862412 share +xfer 2150-5-1 contributions Chas 50 +xfer 2150-5-1 Chas club 50 +xfer 2150-5-1 club Chas 0.862412 share +xfer 2150-5-1 contributions Deb 50 +xfer 2150-5-1 Deb club 50 +xfer 2150-5-1 club Deb 0.862412 share +todo 2150-5-1 AEthelraed misses! +xfer 2150-5-1 contributions Frank 50 +xfer 2150-5-1 Frank club 50 +xfer 2150-5-1 club Frank 0.862412 share + +# And so on and on and on... make up your own numbers from here on! +