diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# MIDA + +[![License GPL 3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.txt) + +[![Build Status](https://travis-ci.org/mrkkrp/mida.svg?branch=master)](https://travis-ci.org/mrkkrp/mida) + +MIDA is a minimalistic declarative language for algorithmic generation of +MIDI files. MIDA is not interactive in sense that you cannot control result +of its activity in real time, it is intended for producers and should be +used with a DAW. MIDA can help you create variative elements in your music +in a very simple way. Since MIDI can control a lot of different instruments, +power of MIDA is truly great. + +Main reason for MIDA development is to create software tool that can +be used in such a way that does not change established workflow, so +people could use familiar plugins and software instruments. + +Currently MIDA can be used to translate source files into `.mid` files, and +also in interactive mode that will help you to understand how MIDA language +works. + +MIDA is a +[member of Linux Audio consortium](http://linuxaudio.org/members.html). + +## Installation + +1. Install [Haskell Platform](https://www.haskell.org/platform/); +2. Install [Cabal](https://www.haskell.org/cabal/); +3. Download and untar git repository of MIDA, or clone it: + + ``` + $ git clone https://github.com/mrkkrp/mida.git master + ``` + +4. Go to the root directory of the repository and execute: + + ``` + $ cabal update + $ cabal configure + $ cabal install --only-dependencies + $ cabal build + # sh install.sh + ``` + +5. Done (you can use `uninstall.sh` to uninstall the program). + +## Example + +Here is a simple example of MIDA program that demonstrates syntax and +declarative nature of the language. + +``` +# +# Example of MIDA program +# Recommended tempo is 60 +# + +dur0 = 12 6 6 +dur1 = @[dur0] +pch0 = {0 5 7} + [c5 {e5 d5} c6 {f5 g5}] +pch1 = pch0 +vel0 = {7..11} * 10 +vel1 = vel0 +``` + +See [MIDA Manual](https://mrkkrp.github.io/mida/) for more information. + +## How to control any parameter of any instrument / plugin? + +If you're into this sort of thing, you may like my another project, called +[ALGA](https://github.com/mrkkrp/alga). It allows to control automation in +various DAWs. + +## License + +Copyright © 2014, 2015 Mark Karpov + +Distributed under GNU GPL, version 3. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/mida.cabal b/mida.cabal new file mode 100644 --- /dev/null +++ b/mida.cabal @@ -0,0 +1,126 @@ +-- -*- Mode: Haskell-Cabal; -*- +-- +-- Cabal config for MIDA. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +name: mida +version: 0.4.3 +synopsis: Language for algorithmic generation of MIDI files +description: + + MIDA is a minimalistic language for algorithmic generation of MIDI + files. MIDA is not interactive in sense that you cannot control result of + its activity in real time, it is intended for producers and should be used + with a DAW. MIDA can help you create variative elements in your music in a + very simple way. Since MIDI can control a lot of different instruments, + power of MIDA is truly great. + + Main reason for MIDA development is to create software tool that can be + used in such a way that does not change established workflow, so people + could use familiar plugins and software instruments. + + The core concept of MIDA is building systems with complex behaviors from + very basic and easy-to-understand elements and powerful means of their + composition. + + Currently MIDA can be used to translate source files into .mid files, and + also in interactive mode that will help you to understand how MIDA + language works. + + See MIDA Manual for more information. + +homepage: https://github.com/mrkkrp/mida +license: GPL-3 +license-file: LICENSE.md +author: Mark Karpov +maintainer: Mark Karpov +copyright: Copyright © 2014, 2015 Mark Karpov +category: Language +build-type: Simple +extra-source-files: README.md +cabal-version: >= 1.10 + +library + hs-source-dirs: src + ghc-options: -O2 -Wall + ghc-prof-options: -O2 -Wall -prof -fprof-auto -fprof-cafs -rtsopts + build-depends: HCodecs >= 0.5 + , base >= 4.8 && < 5 + , containers >= 0.5.5.1 + , mersenne-random-pure64 >= 0.2.0.4 + , mtl >= 2.1.3.1 + , parsec >= 3.1.8 + , text >= 1.2.0.4 + , transformers >= 0.2.0.0 && < 0.5 + exposed-modules: Mida.Configuration + , Mida.Language + , Mida.Language.Element + , Mida.Language.Environment + , Mida.Language.Eval + , Mida.Language.SyntaxTree + , Mida.Midi + , Mida.Representation + , Mida.Representation.Parser + , Mida.Representation.Show + other-modules: Mida.Representation.Base + default-language: Haskell2010 + +executable mida + main-is: Main.hs + hs-source-dirs: src + other-modules: Mida.Interaction + ghc-options: -O2 -Wall + ghc-prof-options: -O2 -Wall -prof -fprof-auto -fprof-cafs -rtsopts + build-depends: HCodecs >= 0.5 + , base >= 4.8 && < 5 + , containers >= 0.5.5.1 + , directory >= 1.2.1.0 + , filepath >= 1.3.0.2 + , haskeline >= 0.7.1.3 + , mersenne-random-pure64 >= 0.2.0.4 + , mida >= 0.4.2 + , mtl >= 2.1.3.1 + , optparse-applicative >= 0.11.0.2 + , parsec >= 3.1.8 + , process >= 1.2.0.0 + , text >= 1.2.0.4 + , text-format >= 0.3.1.1 + , transformers >= 0.2.0.0 && < 0.5 + default-language: Haskell2010 + +test-suite tests + main-is: Main.hs + hs-source-dirs: tests + type: exitcode-stdio-1.0 + ghc-options: -O2 -Wall -rtsopts + default-language: Haskell2010 + build-depends: HCodecs >= 0.5 + , QuickCheck >= 2.4 && < 3 + , base >= 4.8 && < 5 + , containers >= 0.5.5.1 + , mersenne-random-pure64 >= 0.2.0.4 + , mida >= 0.4.2 + , mtl >= 2.1.3.1 + , parsec >= 3.1.8 + , test-framework >= 0.4 && < 1 + , test-framework-quickcheck2 >= 0.3 && < 0.4 + , text >= 1.2.0.4 + , transformers >= 0.2.0.0 && < 0.5 + +source-repository head + type: git + location: git://github.com/mrkkrp/mida.git diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,155 @@ +-- -*- Mode: Haskell; -*- +-- +-- Main module of MIDA describes logic of the program on top level. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE OverloadedStrings #-} + +module Main (main) where + +import Control.Monad +import Options.Applicative +import System.Directory (getHomeDirectory, doesFileExist, getCurrentDirectory) +import System.FilePath +import qualified Data.Map as M +import qualified Data.Text.Format as F +import qualified Data.Text.Lazy as T +import qualified Data.Text.Lazy.IO as T + +import Mida.Configuration +import Mida.Interaction + +data Opts = Opts + { opInterac :: Bool + , opSeed :: Int + , opQuarter :: Int + , opBeats :: Int + , opOutput :: String + , opLicense :: Bool + , opVersion :: Bool + , opFiles :: [String] } + +main :: IO () +main = execParser opts >>= f + where f Opts { opLicense = True } = T.putStr license + f Opts { opVersion = True } = F.print "MIDA {}\n" (F.Only version) + f Opts { opFiles = [] } = g $ interaction version + f Opts { opInterac = True + , opFiles = ns } = g $ cmdLoad ns >> interaction version + f Opts { opSeed = s + , opQuarter = q + , opBeats = b + , opOutput = out + , opFiles = ns } = g $ cmdLoad ns >> cmdMake s q b out + g x = T.putStrLn notice >> runMida x + version = "0.4.3" + +notice :: T.Text +notice = + "MIDA Copyright © 2014, 2015 Mark Karpov\n\n\ + \This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n\ + \and you are welcome to redistribute it under certain conditions; see\n\ + \GNU General Public License for details.\n" + +license :: T.Text +license = + "MIDA — realization of MIDA, language for generation of MIDI files.\n\ + \Copyright © 2014, 2015 Mark Karpov\n\ + \\n\ + \MIDA is free software: you can redistribute it and/or modify it under the\n\ + \terms of the GNU General Public License as published by the Free Software\n\ + \Foundation, either version 3 of the License, or (at your option) any\n\ + \later version.\n\ + \\n\ + \MIDA is distributed in the hope that it will be useful, but WITHOUT ANY\n\ + \WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n\ + \FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\n\ + \details.\n\ + \\n\ + \You should have received a copy of the GNU General Public License along\n\ + \with this program. If not, see .\n" + +runMida :: MidaIO () -> IO () +runMida e = do + params <- loadConfig + wdir <- getCurrentDirectory + void $ runMidaInt e + MidaSt { stPrevLen = lookupCfg params "prvlen" 18 + , stSrcFile = lookupCfg params "src" wdir "foo.da" + , stProg = lookupCfg params "prog" 0 + , stTempo = lookupCfg params "tempo" 120 } + MidaCfg { cfgPrompt = lookupCfg params "prompt" "> " + , cfgVerbose = lookupCfg params "verbose" True + , cfgPrvCmd = lookupCfg params "prvcmd" "timidity" + , cfgProgOp = lookupCfg params "progop" "--force-program" + , cfgTempoOp = lookupCfg params "tempop" "--adjust-tempo" } + +loadConfig :: IO Params +loadConfig = do + home <- getHomeDirectory + let file = home ".mida" + exist <- doesFileExist file + if exist + then do params <- parseConfig file <$> T.readFile file + case params of + Right x -> return x + Left _ -> return M.empty + else return M.empty + +opts :: ParserInfo Opts +opts = info (helper <*> options) + ( fullDesc + <> progDesc "starts MIDA interpreter or translates source into MIDI file" + <> header "mida — interpreter for MIDA language" ) + +options :: Parser Opts +options = Opts + <$> switch + ( long "interactive" + <> short 'i' + <> help "Start MIDA in interactive mode" ) + <*> option auto + ( long "seed" + <> short 's' + <> metavar "SEED" + <> value dfltSeed + <> help ("Set seed for MIDI generation, default is " ++ show dfltSeed) ) + <*> option auto + ( long "quarter" + <> short 'q' + <> metavar "TICKS" + <> value dfltQuarter + <> help ("Set ticks per quarter note, default is " ++ show dfltQuarter) ) + <*> option auto + ( long "beats" + <> short 'b' + <> metavar "BEATS" + <> value dfltBeats + <> help ("Set total time in quarter notes, default is " ++ show dfltBeats) ) + <*> strOption + ( long "output" + <> short 'o' + <> metavar "OUT" + <> value "" + <> help "Set name of output file" ) + <*> switch + ( long "license" + <> help "Show license of the program" ) + <*> switch + ( long "version" + <> help "Show version of the program" ) + <*> many (strArgument $ metavar "FILES") diff --git a/src/Mida/Configuration.hs b/src/Mida/Configuration.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Configuration.hs @@ -0,0 +1,104 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes how to parse Unix-style configuration files. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE TypeSynonymInstances #-} + +module Mida.Configuration + ( Params + , parseConfig + , lookupCfg ) +where + +import Data.Char (isSpace) +import Data.Functor.Identity +import Data.Maybe (fromMaybe, listToMaybe) +import qualified Data.Map as M +import qualified Data.Text.Lazy as T + +import Text.Parsec +import Text.Parsec.Language +import Text.Parsec.Text.Lazy +import qualified Text.Parsec.Token as Token + +type Params = M.Map String String + +class Parsable a where + parseValue :: String -> Maybe a + +instance Parsable String where + parseValue = Just + +instance Parsable Int where + parseValue = parseNum + +instance Parsable Bool where + parseValue "true" = Just True + parseValue "false" = Just False + parseValue _ = Nothing + +parseConfig :: String -> T.Text -> Either String Params +parseConfig file = either (Left . show) Right . parse pConfig file + +pConfig :: Parser Params +pConfig = M.fromList <$> (whiteSpace *> many pItem <* eof) + +pItem :: Parser (String, String) +pItem = (,) <$> identifier <* reservedOp "=" <*> (pString <|> pThing) + +pThing :: Parser String +pThing = lexeme $ many (satisfy $ not . isSpace) + +lookupCfg :: Parsable a => Params -> String -> a -> a +lookupCfg cfg v d = fromMaybe d $ M.lookup v cfg >>= parseValue + +lang :: GenLanguageDef T.Text () Identity +lang = Token.LanguageDef + { Token.commentStart = "" + , Token.commentEnd = "" + , Token.commentLine = "#" + , Token.nestedComments = True + , Token.identStart = letter <|> char '_' + , Token.identLetter = alphaNum <|> char '_' + , Token.opStart = Token.opLetter lang + , Token.opLetter = oneOf "=" + , Token.reservedNames = ["true", "false"] + , Token.reservedOpNames = ["="] + , Token.caseSensitive = True } + +lexer :: Token.GenTokenParser T.Text () Identity +lexer = Token.makeTokenParser lang + +identifier :: Parser String +identifier = Token.identifier lexer + +pString :: Parser String +pString = Token.stringLiteral lexer + +reservedOp :: String -> Parser () +reservedOp = Token.reservedOp lexer + +lexeme :: Parser a -> Parser a +lexeme = Token.lexeme lexer + +whiteSpace :: Parser () +whiteSpace = Token.whiteSpace lexer + +parseNum :: (Num a, Read a) => String -> Maybe a +parseNum = fmap fst . listToMaybe . reads diff --git a/src/Mida/Interaction.hs b/src/Mida/Interaction.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Interaction.hs @@ -0,0 +1,97 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes how MIDA processes commands in interactive +-- mode. These commands are also used in batch mode. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE OverloadedStrings #-} + +module Mida.Interaction + ( MidaIO + , MidaInt + , runMidaInt + , MidaSt (..) + , MidaCfg (..) + , cmdLoad + , cmdMake + , interaction + , dfltSeed + , dfltQuarter + , dfltBeats ) +where + +import Control.Monad.Reader +import Prelude hiding (mapM_) +import System.IO +import qualified Data.Text.Lazy as T +import qualified Data.Text.Lazy.IO as T + +import qualified Data.Text.Format as F +import qualified System.Console.Haskeline as L + +import Mida.Interaction.Base +import Mida.Interaction.Commands +import Mida.Language +import Mida.Representation + +interaction :: String -> MidaIO () +interaction version = do + liftIO $ hSetBuffering stdin LineBuffering + liftIO $ F.print "MIDA Interactive Environment {}\n" (F.Only version) + L.runInputT (L.setComplete completionFunc L.defaultSettings) midaRepl + +midaRepl :: L.InputT MidaIO () +midaRepl = do + input <- getMultiline "" + case input of + Just x -> do if T.pack cmdPrefix `T.isPrefixOf` T.strip x + then lift $ processCmd x + else lift $ processExpr x + midaRepl + Nothing -> return () + +getMultiline :: T.Text -> L.InputT MidaIO (Maybe T.Text) +getMultiline prv = do + prompt <- lift getPrompt + input <- L.getInputLine $ + if T.null prv then prompt else replicate (length prompt) ' ' + case input of + Just x -> let r = prv `T.append` T.pack x `T.append` "\n" + in if probeMida r + then return (Just r) + else getMultiline r + Nothing -> return Nothing + +processExpr :: T.Text -> MidaIO () +processExpr expr = do + file <- getSrcFile + case parseMida file expr of + Right x -> mapM_ f x + Left x -> liftIO $ F.print "Parse error in {}.\n" (F.Only x) + where f (Definition n t) = processDef n t + f (Exposition t) = + do len <- getPrevLen + verbose <- getVerbose + result <- liftEnv $ eval t + prin <- liftEnv $ toPrin t + liftIO $ when verbose + (F.print "≡ {}" (F.Only $ showPrinciple prin)) + spitList $ take len result + +spitList :: [Int] -> MidaIO () +spitList [] = liftIO $ T.putStrLn "⇒ ⊥" +spitList xs = liftIO $ F.print "⇒ {}…\n" (F.Only $ unwords (show <$> xs)) diff --git a/src/Mida/Language.hs b/src/Mida/Language.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Language.hs @@ -0,0 +1,47 @@ +-- -*- Mode: Haskell; -*- +-- +-- This is entry point of Mida.Lang library. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA is distributed in the hope that it will be useful, but WITHOUT ANY +-- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +-- FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +-- details. +-- +-- You should have received a copy of the GNU General Public License along +-- with this program. If not, see . + +module Mida.Language + ( SyntaxTree + , Sel (..) + , Principle + , Elt + , Element (..) + , MidaEnv (..) + , runMidaEnv + , addDef + , remDef + , clearDefs + , getPrin + , getSrc + , fullSrc + , getRefs + , purgeEnv + , checkRecur + , setRandGen + , newRandGen + , evalDef + , eval + , toPrin ) +where + +import Mida.Language.SyntaxTree (SyntaxTree, Sel (..)) +import Mida.Language.Element (Principle, Elt, Element (..)) +import Mida.Language.Environment +import Mida.Language.Eval (evalDef, eval, toPrin) diff --git a/src/Mida/Language/Element.hs b/src/Mida/Language/Element.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Language/Element.hs @@ -0,0 +1,47 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes internal representation of principle as list of +-- elements. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE DeriveFunctor #-} +{-# LANGUAGE DeriveFoldable #-} + +module Mida.Language.Element + ( Principle + , Elt + , Element (..) ) +where + +import Control.Arrow ((***)) + +type Principle = [Elt] +type Elt = Element Int + +data Element a + = Val a + | Sec [Element a] + | Mul [Element a] + | CMul [([Element a], [Element a])] + deriving (Eq, Show, Functor, Foldable) + +instance Applicative Element where + pure = Val + (Val f) <*> x = f <$> x + (Sec f) <*> x = Sec $ (<*> x) <$> f + (Mul f) <*> x = Mul $ (<*> x) <$> f + (CMul f) <*> x = CMul $ (((<*> x) <$>) *** ((<*> x) <$>)) <$> f diff --git a/src/Mida/Language/Environment.hs b/src/Mida/Language/Environment.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Language/Environment.hs @@ -0,0 +1,142 @@ +-- -*- Mode: Haskell; -*- +-- +-- Environment is formed via evaluation of definitions. This module +-- describes minimal MIDA environment in form of monad transformer. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE TupleSections #-} + +module Mida.Language.Environment + ( MidaEnv (..) + , runMidaEnv + , addDef + , remDef + , clearDefs + , getPrin + , getSrc + , fullSrc + , getRefs + , purgeEnv + , checkRecur + , setRandGen + , newRandGen ) +where + +import Control.Arrow ((***), (>>>)) +import Control.Monad.State.Strict +import Data.Maybe (fromMaybe) +import Data.Monoid ((<>)) +import qualified Data.Map.Strict as M +import qualified Data.Text.Lazy as T + +import System.Random.Mersenne.Pure64 + +import Mida.Language.SyntaxTree +import Mida.Representation.Base (noteAlias, modifiers) +import Mida.Representation.Show (showDefinition) + +data MidaEnvSt = MidaEnvSt + { stDefs :: Defs + , stRandGen :: PureMT } + +type Defs = M.Map String SyntaxTree + +newtype MidaEnv m a = MidaEnv + { unMidaEnv :: StateT MidaEnvSt m a } + deriving ( Functor + , Applicative + , Monad + , MonadState MidaEnvSt + , MonadTrans + , MonadIO ) + +runMidaEnv :: Monad m => MidaEnv m a -> m a +runMidaEnv e = evalStateT (unMidaEnv e) MidaEnvSt + { stDefs = defaultDefs + , stRandGen = pureMT 0 } + +defaultDefs :: Defs +defaultDefs = M.fromList $ zip noteAlias (f <$> [0..]) + <> zip modifiers (f <$> [128,256..]) + where f = return . Value + +getDefs :: Monad m => MidaEnv m Defs +getDefs = stDefs <$> get + +setDefs :: Monad m => Defs -> MidaEnv m () +setDefs x = modify $ \e -> e { stDefs = x } + +addDef :: Monad m => String -> SyntaxTree -> MidaEnv m () +addDef name tree = M.insert name tree <$> getDefs >>= setDefs + +remDef :: Monad m => String -> MidaEnv m () +remDef name = M.delete name <$> getDefs >>= setDefs + +clearDefs :: Monad m => MidaEnv m () +clearDefs = setDefs defaultDefs + +getPrin :: Monad m => String -> MidaEnv m SyntaxTree +getPrin name = (fromMaybe [] . M.lookup name) <$> getDefs + +getSrc :: Monad m => String -> MidaEnv m T.Text +getSrc name = showDefinition name <$> getPrin name + +fullSrc :: Monad m => MidaEnv m T.Text +fullSrc = (M.foldMapWithKey showDefinition . (M.\\ defaultDefs)) <$> getDefs + +getRefs :: Monad m => MidaEnv m [String] +getRefs = M.keys <$> getDefs + +tDefs :: String -> Defs -> [String] +tDefs name defs = maybe mzero cm $ name `M.lookup` defs + where cm = (>>= f) + f (Value _) = mempty + f (Section x) = cm x + f (Multi x) = cm x + f (CMulti x) = x >>= (cm *** cm >>> uncurry (<>)) + f (Reference x) = return x <> tDefs x defs + f (Range _ _) = mempty + f (Product x y) = f x <> f y + f (Division x y) = f x <> f y + f (Sum x y) = f x <> f y + f (Diff x y) = f x <> f y + f (Loop x y) = f x <> f y + f (Rotation x y) = f x <> f y + f (Reverse x) = f x + +purgeEnv :: Monad m => [String] -> MidaEnv m () +purgeEnv tops = f <$> getDefs >>= setDefs + where f defs = M.intersection defs $ M.unions [ts, ms defs, defaultDefs] + ms = M.unions . fmap toDefs . zipWith tDefs tops . repeat + ts = toDefs tops + +checkRecur :: Monad m => String -> SyntaxTree -> MidaEnv m Bool +checkRecur name tree = check <$> getDefs + where check = elem name . tDefs name . M.insert name tree + +setRandGen :: Monad m => Int -> MidaEnv m () +setRandGen x = modify $ \e -> e { stRandGen = pureMT (fromIntegral x) } + +newRandGen :: Monad m => MidaEnv m PureMT +newRandGen = do + (n, g) <- (randomWord64 . stRandGen) <$> get + modify $ \e -> e { stRandGen = pureMT n } + return . pureMT . fst . randomWord64 $ g + +toDefs :: [String] -> Defs +toDefs = M.fromList . fmap (, []) diff --git a/src/Mida/Language/Eval.hs b/src/Mida/Language/Eval.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Language/Eval.hs @@ -0,0 +1,168 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes process of evaluation of definitions and arbitrary +-- principles. Result of evaluation is infinite list of integers or empty +-- list. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +module Mida.Language.Eval + ( evalDef + , eval + , toPrin ) +where + +import Control.Arrow ((***)) +import Control.Monad.State.Lazy +import Data.List (tails) +import Data.Maybe (listToMaybe) +import Data.Monoid ((<>)) + +import System.Random.Mersenne.Pure64 + +import Mida.Language.SyntaxTree +import Mida.Language.Element +import Mida.Language.Environment + +data CalcSt = CalcSt + { clcHistory :: [Int] + , clcRandGen :: PureMT } + +newtype Calc a = Calc + { unCalc :: State CalcSt a } + deriving ( Functor + , Applicative + , Monad + , MonadState CalcSt ) + +evalDef :: Monad m => String -> MidaEnv m [Int] +evalDef name = getPrin name >>= eval + +eval :: Monad m => SyntaxTree -> MidaEnv m [Int] +eval tree = liftM2 runCalc (resolve . cycle' <$> toPrin tree) newRandGen + where cycle' p = if null $ foldMap (:[]) (Sec p) then [] else cycle p + +resolve :: Principle -> Calc [Int] +resolve [] = return [] +resolve xs = concat <$> mapM f xs + where f (Val x) = addHistory x >> return [x] + f (Sec x) = resolve x + f (Mul x) = choice x >>= maybe (return []) f + f (CMul x) = listToMaybe <$> filterM (matchHistory . fst) x >>= + maybe (f . toMul $ x) (f . Mul . snd) + +runCalc :: Calc a -> PureMT -> a +runCalc clc gen = evalState (unCalc clc) + CalcSt { clcHistory = mempty + , clcRandGen = gen } + +choice :: [a] -> Calc (Maybe a) +choice [] = return Nothing +choice xs = do + (n, g) <- randomInt . clcRandGen <$> get + modify $ \c -> c { clcRandGen = g } + return . Just $ xs !! (abs n `rem` length xs) + +condMatch :: [Int] -> Elt -> Bool +condMatch [] _ = False +condMatch (h:_) (Val x) = h == x +condMatch hs (Sec x) = and $ zipWith condMatch (tails hs) (reverse x) +condMatch hs (Mul x) = or $ condMatch hs <$> x +condMatch hs (CMul x) = condMatch hs (toMul x) + +toMul :: [([Elt], [Elt])] -> Elt +toMul xs = Mul (xs >>= snd) + +matchHistory :: [Elt] -> Calc Bool +matchHistory x = do + hs <- clcHistory <$> get + return . or $ condMatch hs <$> x + +addHistory :: Int -> Calc () +addHistory x = modify $ \c -> c { clcHistory = return x <> clcHistory c } + +toPrin :: Monad m => SyntaxTree -> MidaEnv m Principle +toPrin = fmap simplifySec . toPrin' + +simplifySec :: Principle -> Principle +simplifySec = (>>= f) + where f (Sec xs) = simplifySec xs + f x = simplifyElt x + +simplify :: Principle -> Principle +simplify = (>>= simplifyElt) + +simplifyElt :: Elt -> Principle +simplifyElt x@(Val _) = [x] +simplifyElt (Sec [x]) = simplify [x] +simplifyElt (Mul [x]) = simplify [x] +simplifyElt (CMul [(_, xs)]) = simplifyElt (Mul xs) +simplifyElt (Sec xs) = [Sec (simplifySec xs)] +simplifyElt (Mul xs) = [Mul (simplify xs)] +simplifyElt (CMul xs) = [CMul ((simplify *** simplify) <$> xs)] + +toPrin' :: Monad m => SyntaxTree -> MidaEnv m Principle +toPrin' = fmap concat . mapM f + where + fPair (c, x) = (,) <$> toPrin' c <*> toPrin' x + f (Value x) = return . Val <$> return x + f (Section xs) = return . Sec <$> toPrin' xs + f (Multi xs) = return . Mul <$> toPrin' xs + f (CMulti xs) = return . CMul <$> mapM fPair xs + f (Reference x) = getPrin x >>= toPrin' + f (Range x y) = return $ Val <$> if x > y then [x,x-1..y] else [x..y] + f (Product x y) = adb (\a b -> [(*) <$> a <*> b]) <$> f x <*> f y + f (Division x y) = adb (\a b -> [sdiv <$> a <*> b]) <$> f x <*> f y + f (Sum x y) = adb (\a b -> [(+) <$> a <*> b]) <$> f x <*> f y + f (Diff x y) = adb (\a b -> [sdif <$> a <*> b]) <$> f x <*> f y + f (Loop x y) = adb loop <$> f x <*> f y + f (Rotation x y) = adb (\a b -> [rotate a b]) <$> f x <*> f y + f (Reverse x) = adu reverse' <$> f x + adb _ [] _ = [] + adb _ xs [] = xs + adb g xs (y:ys) = init xs ++ g (last xs) y ++ ys + adu _ [] = [] + adu g (x:xs) = g x : xs + +sdiv :: Int -> Int -> Int +sdiv x 0 = x +sdiv x y = x `div` y + +sdif :: Int -> Int -> Int +sdif x y + | x < y = 0 + | otherwise = x - y + +loop :: Elt -> Elt -> Principle +loop x (Val y) = replicate y x +loop x (Mul y) = [Mul $ Sec . loop x <$> y] +loop (Sec x) (Sec y) = [Sec . concat $ zipWith loop x (cycle y)] +loop (Mul x) (Sec y) = [Mul . concat $ zipWith loop x (cycle y)] +loop x _ = [x] + +rotate :: Elt -> Elt -> Elt +rotate (Sec x) (Val y) = Sec $ zipWith const (drop y (cycle x)) x +rotate x@(Sec _) (Mul y) = Mul $ rotate x <$> y +rotate (Sec x) (Sec y) = Sec $ zipWith rotate x (cycle y) +rotate x _ = x + +reverse' :: Elt -> Elt +reverse' x@(Val _) = x +reverse' (Mul x) = Mul $ reverse' <$> x +reverse' (Sec x) = Sec $ reverse $ reverse' <$> x +reverse' (CMul x) = CMul $ ((reverse' <$>) *** (reverse' <$>)) <$> x diff --git a/src/Mida/Language/SyntaxTree.hs b/src/Mida/Language/SyntaxTree.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Language/SyntaxTree.hs @@ -0,0 +1,41 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module defines abstract syntax tree of MIDA language. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA is distributed in the hope that it will be useful, but WITHOUT ANY +-- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +-- FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +-- details. +-- +-- You should have received a copy of the GNU General Public License along +-- with this program. If not, see . + +module Mida.Language.SyntaxTree + ( SyntaxTree + , Sel (..) ) +where + +type SyntaxTree = [Sel] + +data Sel -- syntactic element + = Value Int + | Section [Sel] + | Multi [Sel] + | CMulti [([Sel], [Sel])] + | Reference String + | Range Int Int + | Product Sel Sel + | Division Sel Sel + | Sum Sel Sel + | Diff Sel Sel + | Loop Sel Sel + | Rotation Sel Sel + | Reverse Sel + deriving (Eq, Show) diff --git a/src/Mida/Midi.hs b/src/Mida/Midi.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Midi.hs @@ -0,0 +1,201 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes how to create MIDI file from MIDA environment. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE BangPatterns #-} + +module Mida.Midi + ( genMidi + , topDefs ) +where + +import Control.Monad.State.Strict +import Data.Foldable (foldl') +import Data.List (zipWith7) +import Data.Maybe (listToMaybe) +import Prelude hiding (mod) + +import qualified Codec.Midi as M + +import Mida.Language (MidaEnv, setRandGen, evalDef) + +data Batch = Batch + { btDur :: [Int] + , btVel :: [Int] + , btPch :: [Int] + , _btMod :: Maybe [Int] + , _btBth :: Maybe [Int] + , _btAft :: Maybe [Int] + , _btBnd :: Maybe [Int] } + +infixl 4 + +() :: ([Int] -> [Int]) -> Batch -> Batch +f (Batch d v p m t a b) = + Batch (f d) (f v) (f p) (f <$> m) (f <$> t) (f <$> a) (f <$> b) + +data ModParams = ModParams + { mpValue :: Int + , mpFigure :: Int + , mpDuration :: Int + , mpChannel :: Int + , mpProducer :: Int -> Int -> M.Message + , mpUpBounds :: (Int, Int) + , mpDnBounds :: (Int, Int) } + +modP :: ModParams +modP = ModParams + { mpValue = 0 + , mpFigure = 0 + , mpDuration = 0 + , mpChannel = 0 + , mpProducer = flip M.ControlChange 1 + , mpUpBounds = (0x0000, 0x007f) + , mpDnBounds = (0x007f, 0x0000) } + +bthP :: ModParams +bthP = modP { mpProducer = flip M.ControlChange 2 } + +aftP :: ModParams +aftP = modP { mpProducer = M.ChannelPressure } + +bndP :: ModParams +bndP = modP + { mpProducer = M.PitchWheel + , mpUpBounds = (0x2000, 0x3fff) + , mpDnBounds = (0x2000, 0x0000) } + +type Track = M.Track Int + +genMidi :: Monad m => Int -> Int -> Int -> MidaEnv m M.Midi +genMidi s q b = do + setRandGen s + voices <- filter defined <$> mapM request [0..mvIndex] + return M.Midi { M.fileType = M.MultiTrack + , M.timeDiv = M.TicksPerBeat q + , M.tracks = zipWith (toTrack . slice (b * q)) voices [0..] } + +request :: Monad m => Int -> MidaEnv m Batch +request n = do + dur <- eval' defDur + vel <- eval' defVel + pch <- eval' defPch + mod <- eval' defMod + bth <- eval' defBth + aft <- eval' defAft + bnd <- eval' defBnd + return $ Batch dur vel pch (f mod) (f bth) (f aft) (f bnd) + where eval' name = evalDef $ name ++ show n + f x = if null x then Nothing else Just x + +defined :: Batch -> Bool +defined Batch { btDur = d, btVel = v, btPch = p } = all (not . null) [d,v,p] + +slice :: Int -> Batch -> Batch +slice t batch@Batch { btDur = dur } = take (f 0 0 dur) batch + where f !i _ [] = i + f !i !a (x:xs) = if x + a >= t then succ i else f (succ i) (x + a) xs + +toTrack :: Batch -> Int -> Track +toTrack (Batch d v p m t a b) i = + concat (zipWith7 f d v p (r m) (r t) (r a) (r b)) ++ [(0, M.TrackEnd)] + where r = maybe (repeat Nothing) (Just <$>) + f d' v' p' m' t' a' b' = + mixEvents + [ figure m' d' i modP + , figure t' d' i bthP + , figure a' d' i aftP + , figure b' d' i bndP + , [(0, M.NoteOn i p' v'), (d', M.NoteOn i p' 0)] ] + +mixEvents :: [Track] -> Track +mixEvents = foldl' mixPair mempty + +mixPair :: Track -> Track -> Track +mixPair [] xs = xs +mixPair xs [] = xs +mixPair (x:xs) (y:ys) = r : mixPair xs' ys' + where (r, xs', ys') + | fst x <= fst y = (x, xs, f y (fst x) : ys) + | otherwise = (y, f x (fst y) : xs, ys) + f (i, msg) c = (i - c, msg) + +figure :: Maybe Int -> Int -> Int -> ModParams -> Track +figure Nothing _ _ _ = [] +figure (Just raw) d ch p = + fig p { mpValue = v + , mpFigure = f + , mpDuration = d + , mpChannel = ch } + where (f, v) = quotRem raw 128 + +fig :: ModParams -> Track +fig ModParams { mpDuration = 0 } = [] +fig (ModParams v f d ch p ub db) = + maybe [] (zip (0 : repeat 1) . fmap (p ch)) (gen <*> return v) + where gen = listToMaybe $ drop f -- generators: + [ figStc ub -- static + , figRtn ub d -- up & down + , figRtn db d -- down & up + , figLin ub d -- up + , figLin db d ] -- down + +figStc :: (Int, Int) -> Int -> [Int] +figStc be x = [draw be x 1] + +figRtn :: (Int, Int) -> Int -> Int -> [Int] +figRtn be q x = f <$> [0..l] ++ reverse [0..(q - l - 1)] + where f c = draw be (x * c) l + l = q `div` 2 + +figLin :: (Int, Int) -> Int -> Int -> [Int] +figLin be q x = f <$> [0..q] + where f c = draw be (x * c) q + +draw :: (Int, Int) -> Int -> Int -> Int +draw (b, e) n d = b + (n * (e - b)) `gdiv` (127 * d) + where x `gdiv` y = round (fromIntegral x / fromIntegral y :: Double) + +topDefs :: [String] +topDefs = [x ++ show n | + x <- [defDur,defVel,defPch,defMod,defBth,defAft,defBnd], + n <- [0..mvIndex]] + +mvIndex :: Int +mvIndex = 15 + +defDur :: String +defDur = "dur" + +defVel :: String +defVel = "vel" + +defPch :: String +defPch = "pch" + +defMod :: String +defMod = "mod" + +defBth :: String +defBth = "bth" + +defAft :: String +defAft = "aft" + +defBnd :: String +defBnd = "bnd" diff --git a/src/Mida/Representation.hs b/src/Mida/Representation.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Representation.hs @@ -0,0 +1,31 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module binds together syntax tree and textual representation of MIDA +-- language. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA is distributed in the hope that it will be useful, but WITHOUT ANY +-- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +-- FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +-- details. +-- +-- You should have received a copy of the GNU General Public License along +-- with this program. If not, see . + +module Mida.Representation + ( Statement (..) + , probeMida + , parseMida + , showStatement + , showSyntaxTree + , showPrinciple ) +where + +import Mida.Representation.Parser +import Mida.Representation.Show diff --git a/src/Mida/Representation/Base.hs b/src/Mida/Representation/Base.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Representation/Base.hs @@ -0,0 +1,71 @@ +-- -*- Mode: Haskell; -*- +-- +-- Textual representation of basic elements in MIDA language. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA is distributed in the hope that it will be useful, but WITHOUT ANY +-- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +-- FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +-- details. +-- +-- You should have received a copy of the GNU General Public License along +-- with this program. If not, see . + +module Mida.Representation.Base + ( noteAlias + , commentLine + , productOp + , divisionOp + , sumOp + , diffOp + , loopOp + , rotationOp + , reverseOp + , rangeOp + , defOp + , modifiers ) +where + +noteAlias :: [String] +noteAlias = zipWith f names ([0..127] :: [Int]) + where names = cycle ["c","cs","d","ds","e","f","fs","g","gs","a","as","b"] + f n i = n ++ show (i `div` 12) + +commentLine :: String +commentLine = "#" + +productOp :: String +productOp = "*" + +divisionOp :: String +divisionOp = "/" + +sumOp :: String +sumOp = "+" + +diffOp :: String +diffOp = "-" + +loopOp :: String +loopOp = "$" + +rotationOp :: String +rotationOp = "^" + +reverseOp :: String +reverseOp = "@" + +rangeOp :: String +rangeOp = ".." + +defOp :: String +defOp = "=" + +modifiers :: [String] +modifiers = ["_ud","_du","_u","_d"] diff --git a/src/Mida/Representation/Parser.hs b/src/Mida/Representation/Parser.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Representation/Parser.hs @@ -0,0 +1,180 @@ +-- -*- Mode: Haskell; -*- +-- +-- This module describes how to build syntax tree from textual +-- representation of MIDA statements. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE OverloadedStrings #-} + +module Mida.Representation.Parser + ( Statement (..) + , probeMida + , parseMida ) +where + +import Control.Monad (void) +import Data.Functor.Identity +import Data.List (nub) +import qualified Data.Text.Lazy as T + +import Text.Parsec +import Text.Parsec.Expr +import Text.Parsec.Language +import Text.Parsec.Text.Lazy +import qualified Text.Parsec.Token as Token + +import Mida.Language.SyntaxTree (SyntaxTree, Sel (..)) +import qualified Mida.Representation.Base as B + +data Statement + = Definition String SyntaxTree + | Exposition SyntaxTree + deriving (Eq, Show) + +probeMida :: T.Text -> Bool +probeMida txt = not $ or ["," `T.isSuffixOf` stripped + , f ("[", "]") + , f ("{", "}") + , f ("<", ">") + , f ("(", ")") ] + where stripped = T.strip txt + f (x, y) = (&&) <$> (> 0) <*> (/= g y) $ g x + g x = T.count x stripped + +parseMida :: String -> T.Text -> Either String [Statement] +parseMida file txt = + case parse parser file txt of + Right x -> if null x + then Left $ '\"' : file ++ "\":\ninvalid definition syntax" + else Right x + Left x -> Left . show $ x + where parser = if T.pack B.defOp `T.isInfixOf` txt + then pSource + else return <$> pExposition + +pSource :: Parser [Statement] +pSource = whiteSpace *> many pDefinition <* eof + +pDefinition :: Parser Statement +pDefinition = Definition <$> identifier <* reservedOp B.defOp <*> pPrinciple + +pExposition :: Parser Statement +pExposition = Exposition <$> (whiteSpace *> pPrinciple <* eof) + +pPrinciple :: Parser SyntaxTree +pPrinciple = sepBy (pExpression <|> pElement) (optional comma) + +pElement :: Parser Sel +pElement + = try pRange + <|> pValue + <|> try pReference + <|> pSection + <|> try pMulti + <|> pCMulti + "element" + +pRange :: Parser Sel +pRange = Range <$> pNatural <* reservedOp B.rangeOp <*> pNatural + +pValue :: Parser Sel +pValue = Value <$> pNatural + +pNatural :: Parser Int +pNatural = fromIntegral <$> natural "literal value" + +pReference :: Parser Sel +pReference = Reference <$> identifier <* notFollowedBy (reservedOp B.defOp) + +pSection :: Parser Sel +pSection = Section <$> brackets pPrinciple + +pMulti :: Parser Sel +pMulti = Multi <$> braces pPrinciple + +pCMulti :: Parser Sel +pCMulti = CMulti <$> braces (many $ (,) <$> angles pPrinciple <*> pPrinciple) + +pExpression :: Parser Sel +pExpression = buildExpressionParser optTable (parens pExpression <|> pElement) + "expression" + +optTable :: [[Operator T.Text () Identity Sel]] +optTable = + [[ Prefix (reservedOp B.reverseOp *> pure Reverse ) ] + , [ Infix (reservedOp B.productOp *> pure Product ) AssocLeft + , Infix (reservedOp B.divisionOp *> pure Division) AssocLeft + , Infix (reservedOp B.sumOp *> pure Sum ) AssocLeft + , Infix (reservedOp B.diffOp *> pure Diff ) AssocLeft + , Infix (reservedOp B.loopOp *> pure Loop ) AssocLeft + , Infix (reservedOp B.rotationOp *> pure Rotation) AssocLeft ]] + +lang :: GenLanguageDef T.Text () Identity +lang = Token.LanguageDef + { Token.commentStart = "" + , Token.commentEnd = "" + , Token.commentLine = B.commentLine + , Token.nestedComments = True + , Token.identStart = letter <|> char '_' + , Token.identLetter = alphaNum <|> char '_' + , Token.opStart = Token.opLetter lang + , Token.opLetter = oneOf . nub . concat $ langOps + , Token.reservedOpNames = langOps + , Token.reservedNames = [] + , Token.caseSensitive = True } + +langOps :: [String] +langOps = + [ B.productOp + , B.divisionOp + , B.sumOp + , B.diffOp + , B.loopOp + , B.rotationOp + , B.reverseOp + , B.rangeOp + , B.defOp ] + +lexer :: Token.GenTokenParser T.Text () Identity +lexer = Token.makeTokenParser lang + +angles :: Parser a -> Parser a +angles = Token.angles lexer + +braces :: Parser a -> Parser a +braces = Token.braces lexer + +brackets :: Parser a -> Parser a +brackets = Token.brackets lexer + +comma :: Parser () +comma = void $ Token.comma lexer + +identifier :: Parser String +identifier = Token.identifier lexer + +natural :: Parser Integer +natural = Token.natural lexer + +parens :: Parser a -> Parser a +parens = Token.parens lexer + +reservedOp :: String -> Parser () +reservedOp = Token.reservedOp lexer + +whiteSpace :: Parser () +whiteSpace = Token.whiteSpace lexer diff --git a/src/Mida/Representation/Show.hs b/src/Mida/Representation/Show.hs new file mode 100644 --- /dev/null +++ b/src/Mida/Representation/Show.hs @@ -0,0 +1,92 @@ +-- -*- Mode: Haskell; -*- +-- +-- Here we describe how to build textual representation of syntax trees and +-- principles. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{-# LANGUAGE OverloadedStrings #-} + +module Mida.Representation.Show + ( showStatement + , showDefinition + , showSyntaxTree + , showPrinciple ) +where + +import Control.Arrow ((***), (>>>)) +import Data.List (intersperse) +import Data.Monoid ((<>)) +import qualified Data.Text.Lazy as T +import qualified Data.Text.Lazy.Builder as T (Builder, fromString, toLazyText) +import qualified Data.Text.Lazy.Builder.Int as T (decimal) + +import Mida.Language.Element +import Mida.Language.SyntaxTree +import Mida.Representation.Parser (Statement (..)) +import qualified Mida.Representation.Base as B + +showStatement :: Statement -> T.Text +showStatement (Definition n t) = showDefinition n t +showStatement (Exposition t) = showSyntaxTree t + +showDefinition :: String -> SyntaxTree -> T.Text +showDefinition n = T.toLazyText . showDefinition' n + +showSyntaxTree :: SyntaxTree -> T.Text +showSyntaxTree = T.toLazyText . showSyntaxTree' + +showPrinciple :: Principle -> T.Text +showPrinciple = showSyntaxTree . toSyntaxTree + +showDefinition' :: String -> SyntaxTree -> T.Builder +showDefinition' n t = T.fromString n <> pad B.defOp <> showSyntaxTree' t + +showSyntaxTree' :: SyntaxTree -> T.Builder +showSyntaxTree' t = cm f t <> "\n" + where + cm g xs = mconcat . intersperse " " $ g <$> xs + p x@(Value _) = f x + p x@(Section _) = f x + p x@(Multi _) = f x + p x@(CMulti _) = f x + p x@(Reference _) = f x + p x@(Range _ _) = f x + p x = "(" <> f x <> ")" + f (Value x) = T.decimal x + f (Section x) = "[" <> cm f x <> "]" + f (Multi x) = "{" <> cm f x <> "}" + f (CMulti x) = "{" <> cm (c *** cm f >>> uncurry (<>)) x <> "}" + f (Reference x) = T.fromString x + f (Range x y) = T.decimal x <> T.fromString B.rangeOp <> T.decimal y + f (Product x y) = f x <> pad B.productOp <> p y + f (Division x y) = f x <> pad B.divisionOp <> p y + f (Sum x y) = f x <> pad B.sumOp <> p y + f (Diff x y) = f x <> pad B.diffOp <> p y + f (Loop x y) = f x <> pad B.loopOp <> p y + f (Rotation x y) = f x <> pad B.rotationOp <> p y + f (Reverse x) = T.fromString B.reverseOp <> p x + c xs = "<" <> cm f xs <> "> " + +toSyntaxTree :: Principle -> SyntaxTree +toSyntaxTree = (f <$>) + where f (Val x) = Value x + f (Sec x) = Section $ f <$> x + f (Mul x) = Multi $ f <$> x + f (CMul x) = CMulti $ (toSyntaxTree *** toSyntaxTree) <$> x + +pad :: String -> T.Builder +pad op = " " <> T.fromString op <> " " diff --git a/tests/Main.hs b/tests/Main.hs new file mode 100644 --- /dev/null +++ b/tests/Main.hs @@ -0,0 +1,100 @@ +-- -*- Mode: Haskell; -*- +-- +-- QuickCheck tests for MIDA. +-- +-- Copyright © 2014, 2015 Mark Karpov +-- +-- MIDA 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. +-- +-- MIDA 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 . + +{- + TODO: + - parser for configuration files; + - translation from syntax tree to internal language; + - process of translation Principle -> [Int]; + - generation of MIDI files. +-} + +{-# OPTIONS -fno-warn-orphans #-} + +module Main (main) where + +import Control.Arrow ((&&&), (>>>)) +import Data.Char (isLetter, isAlphaNum) + +import Test.Framework (defaultMain, testGroup, Test) +import Test.Framework.Providers.QuickCheck2 (testProperty) +import Test.QuickCheck + +import Mida.Language (Sel (..)) +import Mida.Representation + ( Statement (..) + , probeMida + , parseMida + , showStatement ) + +main :: IO () +main = defaultMain tests + +tests :: [Test] +tests = + [ testGroup "Printer and Parser" + [ testProperty "Valid MIDA Probe" prop_valid_probe + , testProperty "Printer and Parser Consistency" prop_pp_consistency ] ] + +prop_valid_probe :: Statement -> Bool +prop_valid_probe = probeMida . showStatement + +prop_pp_consistency :: Statement -> Bool +prop_pp_consistency = id &&& (parseMida "" . showStatement) >>> check + where check (x, Right [y]) = x == y + check _ = False + +instance Arbitrary Statement where + arbitrary = + oneof [ Definition <$> alphaNumIdentifier <*> arbitrary + , Exposition <$> arbitrary ] + +instance Arbitrary Sel where + arbitrary = sized arbitrarySel + +arbitrarySel :: Int -> Gen Sel +arbitrarySel 0 = + oneof [ Value <$> positive + , Reference <$> alphaNumIdentifier + , Range <$> positive <*> positive ] + where positive = arbitrary `suchThat` (>= 0) +arbitrarySel n = + oneof [ Section <$> listSel + , Multi <$> listSel + , CMulti <$> listCnd + , Product <$> leafSel <*> leafSel + , Division <$> leafSel <*> leafSel + , Sum <$> leafSel <*> leafSel + , Diff <$> leafSel <*> leafSel + , Loop <$> leafSel <*> leafSel + , Rotation <$> leafSel <*> leafSel + , Reverse <$> leafSel ] + where cnSel d = arbitrarySel (n `div` d) + vcSel d = arbitrarySizedIntegral `suchThat` (>= 0) + >>= \s -> vectorOf s (cnSel $ d * s) + leafSel = cnSel 2 + listSel = vcSel 1 + listCnd = arbitrarySizedIntegral `suchThat` (>= 1) + >>= \s -> vectorOf s $ (,) <$> vcSel s <*> vcSel s + +alphaNumIdentifier :: Gen String +alphaNumIdentifier = (:) <$> ch0 <*> chN + where ch0 = arbitrary `suchThat` underscoreOr isLetter + chN = arbitrary `suchThat` all (underscoreOr isAlphaNum) + underscoreOr f x = x == '_' || f x