diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# tidal-parse +The parser of tidal formerly known as MiniTidal diff --git a/src/Sound/Tidal/Parse.hs b/src/Sound/Tidal/Parse.hs new file mode 100644 --- /dev/null +++ b/src/Sound/Tidal/Parse.hs @@ -0,0 +1,1094 @@ +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} + +module Sound.Tidal.Parse (parseTidal) where + +import Control.Applicative (Alternative (empty, (<|>))) +import Control.Monad.Except (MonadError (throwError)) +import Data.Bifunctor (Bifunctor (bimap)) +import Data.Char (isSpace) +import Data.List (dropWhileEnd) +import qualified Data.Text +import Language.Haskellish as Haskellish +import Sound.Tidal.Chords as T +import Sound.Tidal.Control as T +import Sound.Tidal.Core as T +import Sound.Tidal.Params as T +import Sound.Tidal.Parse.TH + ( fromHaskell, + fromTidal, + fromTidalList, + ) +import Sound.Tidal.ParseBP (Enumerable, Parseable, parseBP) +import Sound.Tidal.Pattern as T +import Sound.Tidal.Scales as T (scale) +import Sound.Tidal.Simple as T (silent) +import Sound.Tidal.UI as T + +type H = Haskellish () + +-- This is depended upon by Estuary, and changes to its type will cause problems downstream for Estuary. +parseTidal :: String -> Either String ControlPattern +parseTidal x = if null x' then return silence else r + where + x' = dropWhileEnd isSpace $ dropWhile isSpace $ Haskellish.removeComments x + r = bimap showSyntaxError fst $ Haskellish.parseAndRun parser () x + +showSyntaxError :: (Span, Data.Text.Text) -> String +showSyntaxError (((lineNumber, columnNumber), (_, _)), msg) = + show lineNumber ++ ":" ++ show columnNumber ++ " " ++ Data.Text.unpack msg + +-- The class Parse is a class for all of the types that we know how to parse. +-- For each type, we provide all the ways we can think of producing that type +-- via expressions in Parse. + +class Parse a where + parser :: H a + +instance Parse Bool where + parser = (True <$ reserved "True") <|> (False <$ reserved "False") "expected literal Bool" + +instance Parse Int where + parser = (fromIntegral <$> integer) "expected literal Int" + +instance Parse Integer where + parser = integer "expected literal Integer" + +instance Parse Time where + parser = (fromIntegral <$> integer) <|> rational "expected literal Time" + +instance Parse Double where + parser = (fromIntegral <$> integer) <|> (realToFrac <$> rational) "expected literal Double" + +instance Parse Note where + parser = (Note . fromIntegral <$> integer) <|> (Note . realToFrac <$> rational) "expected literal Note" + +instance Parse String where + parser = + string + <|> (parser :: H (String -> String)) + <*!> parser + "expected String" + +instance (Parse a, Parse b) => Parse (a, b) where + parser = Haskellish.tuple parser parser + +-- Parse instances for lists of things +-- for Num types we define the common pathway numList that includes chords +-- then for other types we default to just parsing "literal" lists [a,a,...] + +instance Parse [Int] where parser = numList + +instance Parse [Integer] where parser = numList + +instance Parse [Time] where parser = numList + +instance Parse [Double] where parser = numList + +instance Parse [Note] where parser = numList + +instance {-# OVERLAPPABLE #-} (Parse a) => Parse [a] where parser = list parser + +numList :: (Parse a, Num a) => H [a] +numList = list parser <|> chords + +chords :: (Num a) => H [a] +chords = + $( fromTidalList + [ "major", + "aug", + "six", + "sixNine", + "major7", + "major9", + "add9", + "major11", + "add11", + "major13", + "add13", + "dom7", + "dom9", + "dom11", + "dom13", + "sevenFlat5", + "sevenSharp5", + "sevenFlat9", + "nine", + "eleven", + "thirteen", + "minor", + "diminished", + "minorSharp5", + "minor6", + "minorSixNine", + "minor7flat5", + "minor7", + "minor7sharp5", + "minor7flat9", + "minor7sharp9", + "diminished7", + "minor9", + "minor11", + "minor13", + "one", + "five", + "sus2", + "sus4", + "sevenSus2", + "sevenSus4", + "nineSus4", + "sevenFlat10", + "nineSharp5", + "minor9sharp5", + "sevenSharp5flat9", + "minor7sharp5flat9", + "elevenSharp", + "minor11sharp" + ] + ) + +instance Parse ValueMap where + parser = Control.Applicative.empty + +instance Parse ControlPattern where + parser = + (parser :: H (Pattern String -> ControlPattern)) <*!> parser + <|> (parser :: H (Pattern Double -> ControlPattern)) <*!> parser + <|> (parser :: H (Pattern Note -> ControlPattern)) <*!> parser + <|> (parser :: H (Pattern Int -> ControlPattern)) <*!> parser + <|> listCp_cp <*!> parser + <|> genericPatternExpressions + "expected ControlPattern" + +genericPatternExpressions :: forall a. (Parse a, Parse (Pattern a), Parse (Pattern a -> Pattern a), Parse [a]) => H (Pattern a) +genericPatternExpressions = + (parser :: H (Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ([a] -> Pattern a)) <*!> parser + <|> (parser :: H ([Pattern a] -> Pattern a)) <*!> parser + <|> (parser :: H ([(Pattern a, Pattern Double)] -> Pattern a)) <*!> parser + <|> (parser :: H ([Pattern a -> Pattern a] -> Pattern a)) <*!> parser + <|> (parser :: H ([(Time, Pattern a)] -> Pattern a)) <*!> parser + <|> pInt_p <*!> parser + <|> list_p <*!> parser + <|> tupleApDouble_p <*!> parser + <|> listTupleStringTransformation_p <*!> parser + <|> parseSilence + +listTupleStringTransformation_p :: forall a. (Parse (Pattern a), Parse (Pattern a -> Pattern a)) => H ([(String, Pattern a -> Pattern a)] -> Pattern a) +listTupleStringTransformation_p = listTupleStringPattern_listTupleStringTransformation_p <*!> parser + +listTupleStringPattern_listTupleStringTransformation_p :: H ([(String, Pattern a)] -> [(String, Pattern a -> Pattern a)] -> Pattern a) +listTupleStringPattern_listTupleStringTransformation_p = pString_listTupleStringPattern_listTupleStringTransformation_p <*!> parser + +pString_listTupleStringPattern_listTupleStringTransformation_p :: H (Pattern String -> [(String, Pattern a)] -> [(String, Pattern a -> Pattern a)] -> Pattern a) +pString_listTupleStringPattern_listTupleStringTransformation_p = time_pString_listTupleStringPattern_listTupleStringTransformation_p <*!> parser + +time_pString_listTupleStringPattern_listTupleStringTransformation_p :: H (Time -> Pattern String -> [(String, Pattern a)] -> [(String, Pattern a -> Pattern a)] -> Pattern a) +time_pString_listTupleStringPattern_listTupleStringTransformation_p = $(fromTidal "ur") + +numPatternExpressions :: (Num a, Parse a, Parse [a]) => H (Pattern a) +numPatternExpressions = + $(fromTidal "irand") <*!> parser + <|> pInt_pNumA <*!> parser + +fractionalPatternExpressions :: (Fractional a) => H (Pattern a) +fractionalPatternExpressions = + $(fromTidal "rand") + <|> $(fromTidal "perlin") + <|> pInt_pFractionalA <*!> parser + <|> pDouble_pFractionalA <*!> parser + +parseSilence :: H (Pattern a) +parseSilence = $(fromTidal "silence") -- ie. silence <$ reserved "silence", see Sound.Tidal.Parse.TH + +instance Parse (Pattern Bool) where + parser = + haskellishParseBP + <|> (parser :: H (Pattern String -> Pattern Bool)) <*!> parser + <|> (parser :: H (Pattern Int -> Pattern Bool)) <*!> parser + <|> genericPatternExpressions + "expected Pattern Bool" + +instance Parse (Pattern String) where + parser = + haskellishParseBP + <|> genericPatternExpressions + <|> (parser :: H (Pattern Int -> Pattern String)) <*!> parser + <|> (parser :: H (String -> Pattern String)) <*!> parser + <|> (parser :: H ([(String, String)] -> Pattern String)) + <*!> parser + "expected Pattern String" + +haskellishParseBP :: (Enumerable a, Parseable a) => H (Pattern a) +haskellishParseBP = do + (b, _) <- Haskellish.span + p <- parseBP <$> string + case p of + Left e -> throwError $ Data.Text.pack $ show e + Right p' -> do + return $ withContext (updateContext b) p' + where + updateContext (dx, dy) c@Context {contextPosition = poss} = + c {contextPosition = map (\((bx, by), (ex, ey)) -> ((bx + dx, by + dy), (ex + dx, ey + dy))) poss} + +instance Parse (Pattern Int) where + parser = + pure . fromIntegral <$> integer + <|> haskellishParseBP + <|> genericPatternExpressions + <|> numPatternExpressions + "expected Pattern Int" + +instance Parse (Pattern Integer) where + parser = + pure <$> integer + <|> haskellishParseBP + <|> genericPatternExpressions + <|> numPatternExpressions + "expected Pattern Integer" + +instance Parse (Pattern Double) where + parser = + pure . fromIntegral <$> integer + <|> pure . realToFrac <$> rational + <|> haskellishParseBP + <|> genericPatternExpressions + <|> numPatternExpressions + <|> fractionalPatternExpressions + <|> $(fromTidal "sine") + <|> $(fromTidal "saw") + <|> $(fromTidal "isaw") + <|> $(fromTidal "tri") + <|> $(fromTidal "square") + <|> $(fromTidal "cosine") + <|> $(fromTidal "envEq") + <|> $(fromTidal "envEqR") + <|> $(fromTidal "envL") + <|> $(fromTidal "envLR") + <|> (parser :: H (String -> Pattern Double)) <*!> parser + <|> $(fromTidalList (fmap (\x -> "in" ++ show x) ([0 .. 127] :: [Int]))) + "expected Pattern Double" + +instance Parse (Pattern Note) where + parser = + pure . fromIntegral <$> integer + <|> pure . realToFrac <$> rational + <|> haskellishParseBP + <|> genericPatternExpressions + <|> numPatternExpressions + <|> fractionalPatternExpressions + "expected Pattern Note" + +instance Parse (Pattern Time) where + parser = + pure . fromIntegral <$> integer + <|> pure <$> rational + <|> haskellishParseBP + <|> genericPatternExpressions + <|> numPatternExpressions + <|> fractionalPatternExpressions + "expected Pattern Time" + +-- * -> * + +a_patternB :: forall a b. (Parse (a -> Pattern b)) => H (a -> Pattern b) +a_patternB = listAtoPatternB_a_patternB <*> parser "expected a -> Pattern b" + +listAtoPatternB_a_patternB :: H ([a -> Pattern b] -> a -> Pattern b) +listAtoPatternB_a_patternB = + $(fromTidal "layer") + <|> $(fromTidal "spreadf") + +{- -- a_patternB2 :: (Parse (a -> b -> Pattern c),Parse [a]) => H (b -> Pattern c) +-- a_patternB2 = return id +--listA_b_patternC <*!> parser "expected a -> Pattern b" + +-- listA_b_patternC :: forall a b c. Parse (a -> b -> Pattern c) => H ([a] -> b -> Pattern c) +listA_b_patternC = (parser :: H ((a -> b -> Pattern c) -> [a] -> b -> Pattern c)) <*!> parser +-} + +instance Parse (ControlPattern -> ControlPattern) where + parser = + genericTransformations + <|> $(fromTidal "ghost") + <|> $(fromTidal "silent") + <|> (parser :: H (Pattern Int -> ControlPattern -> ControlPattern)) <*!> parser + <|> (parser :: H (Pattern Double -> ControlPattern -> ControlPattern)) <*!> parser + <|> (parser :: H (Pattern Time -> ControlPattern -> ControlPattern)) + <*!> parser + -- lCpCp_cp_cp <*!> parser + "expected ControlPattern -> ControlPattern" + +instance Parse (Pattern Bool -> Pattern Bool) where + parser = genericTransformations <|> ordTransformations <|> fBool_fBool "expected Pattern Bool -> Pattern Bool" + +instance Parse (Pattern String -> Pattern String) where + parser = genericTransformations <|> ordTransformations "expected Pattern String -> Pattern String" + +instance Parse (Pattern Int -> Pattern Int) where + parser = genericTransformations <|> numTransformations <|> ordTransformations "expected Pattern Int -> Pattern Int" + +instance Parse (Pattern Integer -> Pattern Integer) where + parser = genericTransformations <|> numTransformations <|> ordTransformations "expected Pattern Integer -> Pattern Integer" + +instance Parse (Pattern Time -> Pattern Time) where + parser = genericTransformations <|> numTransformations <|> ordTransformations <|> realFracTransformations "expected Pattern Time -> Pattern Time" + +instance Parse (Pattern Double -> Pattern Double) where + parser = + genericTransformations + <|> numTransformations + <|> floatingTransformations + <|> ordTransformations + <|> realFracTransformations + <|> $(fromTidal "perlin2") + "expected Pattern Double -> Pattern Double" + +instance Parse (Pattern Note -> Pattern Note) where + parser = genericTransformations <|> numTransformations <|> floatingTransformations <|> ordTransformations "expected Pattern Note -> Pattern Note" + +genericTransformations :: forall a. (Parse (Pattern a), Parse (Pattern a -> Pattern a), Parse (Pattern a -> Pattern a -> Pattern a), Parse ((Pattern a -> Pattern a) -> Pattern a -> Pattern a), Parse ([Pattern a -> Pattern a] -> Pattern a -> Pattern a)) => H (Pattern a -> Pattern a) +genericTransformations = + simpleComposition + <|> $(fromHaskell "id") + <|> (parser :: H (Pattern a -> Pattern a -> Pattern a)) <*!> parser + <|> asRightSection (parser :: H (Pattern a -> Pattern a -> Pattern a)) (required parser) + <|> (parser :: H ((Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + <|> $(fromTidal "brak") + <|> $(fromTidal "rev") + <|> $(fromTidal "palindrome") + <|> $(fromTidal "stretch") + <|> $(fromTidal "loopFirst") + <|> $(fromTidal "degrade") + <|> $(fromTidal "arpeggiate") + <|> $(fromTidal "trigger") + <|> $(fromTidal "rolled") + <|> constParser <*!> parser + <|> + -- more complex possibilities that would involve overlapped Parse instances if they were instances + pTime_p_p <*!> parser + <|> pInt_p_p <*!> parser + <|> pDouble_p_p <*!> parser + <|> pBool_p_p <*!> parser + <|> lpInt_p_p <*!> parser + <|> pString_p_p <*!> parser + <|> + -- more complex possibilities that wouldn't involve overlapped Parse instances + (parser :: H (Time -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ((Time, Time) -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ([Time] -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ([Pattern Time] -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ([Pattern Double] -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ([Pattern a -> Pattern a] -> Pattern a -> Pattern a)) <*!> parser + <|> lp_p_p <*!> parser + <|> a_patternB + <|> pA_pB + +-- this only matches the case where the functions being composed are both a -> a (with the same a) +-- nonetheless, this is an extremely common case with Tidal +simpleComposition :: forall a. (Parse (a -> a)) => H (a -> a) +simpleComposition = $(fromHaskell ".") <*!> (parser :: H (a -> a)) <*!> (parser :: H (a -> a)) + +numTransformations :: (Num a, Enum a, Real a) => H (Pattern a -> Pattern a) +numTransformations = + $(fromTidal "run") + +ordTransformations :: (Ord a) => H (Pattern a -> Pattern a) +ordTransformations = + pInt_pOrd_pOrd <*!> parser + +floatingTransformations :: (Floating a, Parse a, Parse (Pattern a)) => H (Pattern a -> Pattern a) +floatingTransformations = + floatingMergeOperator <*!> parser + <|> floating_pFloating_pFloating <*!> parser + +realFracTransformations :: (RealFrac a, Parse a) => H (Pattern a -> Pattern a) +realFracTransformations = realFrac_pRealFrac_pRealFrac <*!> parser + +instance Parse ([a] -> Pattern a) where + parser = + $(fromTidal "listToPat") + <|> $(fromTidal "choose") + <|> $(fromTidal "cycleChoose") + <|> a_patternB + +instance Parse ([Pattern a] -> Pattern a) where + parser = + $(fromTidal "stack") + <|> $(fromTidal "fastcat") + <|> $(fromTidal "fastCat") + <|> $(fromTidal "slowcat") + <|> $(fromTidal "slowCat") + <|> $(fromTidal "cat") + <|> $(fromTidal "randcat") + <|> (parser :: H (Pattern Double -> [Pattern a] -> Pattern a)) <*!> parser + <|> (parser :: H (Pattern Int -> [Pattern a] -> Pattern a)) <*!> parser + <|> a_patternB + +instance Parse ([(Pattern a, Pattern Double)] -> Pattern a) where + parser = + $(fromTidal "wrandcat") + <|> a_patternB + +pInt_p :: (Parse [a]) => H (Pattern Int -> Pattern a) +pInt_p = + (parser :: H ([a] -> Pattern Int -> Pattern a)) <*!> parser + +-- ??? a_patternB -- also missing from all non-instance entries in this section +-- ??? pA_pB + +instance Parse (Pattern String -> ControlPattern) where + parser = + $(fromTidal "s") + <|> $(fromTidal "sound") + <|> $(fromTidal "vowel") + <|> (parser :: H (String -> Pattern String -> ControlPattern)) <*!> parser + <|> pA_pB + <|> a_patternB + +instance Parse (Pattern Int -> ControlPattern) where + parser = + $(fromTidal "cut") + <|> (parser :: H (String -> Pattern Int -> ControlPattern)) <*!> parser + <|> pA_pB + <|> a_patternB + +instance Parse (Pattern String -> Pattern Bool) where + parser = + $(fromTidal "ascii") + <|> pA_pB + <|> a_patternB + +instance Parse (Pattern Int -> Pattern Bool) where + parser = + $(fromTidal "binary") + <|> (parser :: H (Pattern Int -> Pattern Int -> Pattern Bool)) <*!> parser + <|> pA_pB + <|> a_patternB + +instance Parse (Pattern Note -> ControlPattern) where + parser = + $(fromTidal "up") + <|> $(fromTidal "n") + <|> $(fromTidal "note") + <|> (parser :: H (String -> Pattern Note -> ControlPattern)) <*!> parser + <|> pA_pB + <|> a_patternB + +instance Parse (Pattern Double -> ControlPattern) where + parser = + $(fromTidal "speed") + <|> $(fromTidal "pan") + <|> $(fromTidal "shape") + <|> $(fromTidal "gain") + <|> $(fromTidal "overgain") + <|> $(fromTidal "overshape") + <|> $(fromTidal "accelerate") + <|> $(fromTidal "bandf") + <|> $(fromTidal "bandq") + <|> $(fromTidal "begin") + <|> $(fromTidal "crush") + <|> $(fromTidal "legato") + <|> $(fromTidal "cutoff") + <|> $(fromTidal "delayfeedback") + <|> $(fromTidal "delaytime") + <|> $(fromTidal "delay") + <|> $(fromTidal "end") + <|> $(fromTidal "hcutoff") + <|> $(fromTidal "hresonance") + <|> $(fromTidal "resonance") + <|> $(fromTidal "loop") + <|> $(fromTidal "coarse") + <|> $(fromTidal "nudge") + <|> (parser :: H (String -> Pattern Double -> ControlPattern)) <*!> parser + <|> pA_pB + <|> a_patternB + +instance Parse (Pattern Int -> Pattern String) where + parser = + pString_pInt_pString <*!> parser + <|> pA_pB + <|> a_patternB + +instance Parse (String -> Pattern String) where + parser = + (parser :: H (String -> String -> Pattern String)) <*> parser + <|> (parser :: H ([String] -> String -> Pattern String)) <*> parser + +instance Parse ([(String, String)] -> Pattern String) where + parser = $(fromTidal "sseqs") + +instance Parse (String -> String) where + parser = (parser :: H (String -> String -> String)) <*!> parser + +-- note: missing pA_pB and a_patternB pathways +pInt_pNumA :: (Num a, Parse [a]) => H (Pattern Int -> Pattern a) +pInt_pNumA = listNumA_pInt_pA <*!> parser + +-- note: missing pA_pB and a_patternB pathways +pInt_pFractionalA :: (Fractional a) => H (Pattern Int -> Pattern a) +pInt_pFractionalA = (parser :: (Fractional a) => H (Pattern String -> Pattern Int -> Pattern a)) <*!> parser + +pDouble_pFractionalA :: (Fractional a) => H (Pattern Double -> Pattern a) +pDouble_pFractionalA = $(fromTidal "perlinWith") + +-- note: mising a_patternB pathway +listCp_cp :: H ([ControlPattern] -> ControlPattern) +listCp_cp = (parser :: H (ControlPattern -> [ControlPattern] -> ControlPattern)) <*!> parser + +instance (Parse (Pattern a)) => Parse ([Pattern a -> Pattern a] -> Pattern a) where + parser = + (parser :: H (Pattern a -> [Pattern a -> Pattern a] -> Pattern a)) <*!> parser + <|> a_patternB + +-- note: mising a_patternB pathway (? maybe not necessary here though ?) +pA_pB :: (Parse (Pattern a -> Pattern b)) => H (Pattern a -> Pattern b) +pA_pB = pAB_pA_pB <*!> parser + +fBool_fBool :: (Functor f) => H (f Bool -> f Bool) +fBool_fBool = $(fromTidal "inv") + +-- note: mising a_patternB pathway +list_p :: (Parse a) => H ([a] -> Pattern a) +list_p = pDouble_list_p <*!> parser + +-- note: mising a_patternB pathway +tupleApDouble_p :: (Parse a) => H ([(a, Pattern Double)] -> Pattern a) +tupleApDouble_p = + $(fromTidal "wchoose") + <|> pDouble_tupleApDouble_p <*!> parser + +instance Parse ([(Time, Pattern a)] -> Pattern a) where + parser = $(fromTidal "timeCat") <|> $(fromTidal "timecat") + +instance Parse (String -> Pattern Double) where + parser = + $(fromTidal "cF_") + <|> $(fromTidal "cF0") + <|> (parser :: H (Double -> String -> Pattern Double)) <*!> parser + +-- * -> * -> * + +instance Parse (Pattern Bool -> Pattern Bool -> Pattern Bool) where + parser = genericBinaryPatternFunctions "expected Pattern Bool -> Pattern Bool -> Pattern Bool" + +instance Parse (Pattern String -> Pattern String -> Pattern String) where + parser = + genericBinaryPatternFunctions "expected Pattern String -> Pattern String -> Pattern String" + +instance Parse (Pattern Int -> Pattern Int -> Pattern Int) where + parser = + genericBinaryPatternFunctions + <|> numMergeOperator + <|> pInt_p_p + "expected Pattern Int -> Pattern Int -> Pattern Int" + +instance Parse (Pattern Integer -> Pattern Integer -> Pattern Integer) where + parser = + genericBinaryPatternFunctions + <|> numMergeOperator + "expected Pattern Integer -> Pattern Integer -> Pattern Integer" + +instance Parse (Pattern Time -> Pattern Time -> Pattern Time) where + parser = + genericBinaryPatternFunctions + <|> numMergeOperator + <|> realMergeOperator + <|> fractionalMergeOperator + <|> pTime_p_p + "expected Pattern Time -> Pattern Time -> Pattern Time" + +instance Parse (Pattern Double -> Pattern Double -> Pattern Double) where + parser = + genericBinaryPatternFunctions + <|> numMergeOperator + <|> realMergeOperator + <|> fractionalMergeOperator + <|> $(fromTidal "perlin2With") + <|> pDouble_p_p + "expected Pattern Double -> Pattern Double -> Pattern Double" + +instance Parse (Pattern Note -> Pattern Note -> Pattern Note) where + parser = + genericBinaryPatternFunctions + <|> numMergeOperator + <|> realMergeOperator + <|> fractionalMergeOperator + "expected Pattern Note -> Pattern Note -> Pattern Note" + +instance Parse (ControlPattern -> ControlPattern -> ControlPattern) where + parser = + genericBinaryPatternFunctions + <|> numMergeOperator + <|> fractionalMergeOperator + <|> $(fromTidal "interlace") + <|> (parser :: H ((ControlPattern -> ControlPattern) -> ControlPattern -> ControlPattern -> ControlPattern)) + <*!> parser + "expected ControlPattern -> ControlPattern -> ControlPattern" + +genericBinaryPatternFunctions :: (Unionable a) => H (Pattern a -> Pattern a -> Pattern a) +genericBinaryPatternFunctions = + $(fromTidal "overlay") + <|> $(fromTidal "append") + <|> $(fromTidal "slowAppend") + <|> $(fromTidal "slowappend") + <|> $(fromTidal "fastAppend") + <|> $(fromTidal "fastappend") + <|> unionableMergeOperator + <|> pInt_p_p_p <*!> parser + <|> pBool_p_p_p <*!> parser + <|> pTime_p_p_p <*!> parser + <|> (parser :: H (Pattern Bool -> Pattern a -> Pattern a -> Pattern a)) <*!> parser + <|> constParser + +unionableMergeOperator :: (Unionable a) => H (Pattern a -> Pattern a -> Pattern a) +unionableMergeOperator = + $(fromTidal "#") + <|> $(fromTidal "|>|") + <|> $(fromTidal "|>") + <|> $(fromTidal ">|") + <|> $(fromTidal "|<|") + <|> $(fromTidal "|<") + <|> $(fromTidal "<|") + <|> $(fromHaskell "<>") + +numMergeOperator :: (Num a, Parse (Pattern a)) => H (Pattern a -> Pattern a -> Pattern a) +numMergeOperator = + numTernaryTransformations <*!> parser + <|> $(fromTidal "|+|") + <|> $(fromTidal "|+") + <|> $(fromTidal "+|") + <|> $(fromTidal "|-|") + <|> $(fromTidal "|-") + <|> $(fromTidal "-|") + <|> $(fromTidal "|*|") + <|> $(fromTidal "|*") + <|> $(fromTidal "*|") + <|> $(fromHaskell "+") + <|> $(fromHaskell "*") + <|> $(fromHaskell "-") + +realMergeOperator :: (Moddable a) => H (Pattern a -> Pattern a -> Pattern a) +realMergeOperator = + $(fromTidal "|%|") + <|> $(fromTidal "|%") + <|> $(fromTidal "%|") + +fractionalMergeOperator :: (Fractional a) => H (Pattern a -> Pattern a -> Pattern a) +fractionalMergeOperator = + $(fromTidal "|/|") + <|> $(fromTidal "|/") + <|> $(fromTidal "/|") + <|> $(fromHaskell "/") + +floatingMergeOperator :: (Floating a) => H (Pattern a -> Pattern a -> Pattern a) +floatingMergeOperator = + $(fromTidal "|**") + <|> $(fromTidal "**|") + <|> $(fromTidal "|**|") + +constParser :: H (a -> b -> a) +constParser = $(fromHaskell "const") + +instance Parse (Time -> Pattern a -> Pattern a) where + parser = + $(fromTidal "rotL") + <|> $(fromTidal "rotR") + <|> (parser :: H (Time -> Time -> Pattern a -> Pattern a)) <*!> parser + <|> integral_time_pA_pA <*!> (parser :: H Int) -- we over-specialized this to Int since don't know of case where this wouldn't suffice + +instance Parse (Pattern Int -> Pattern Int -> Pattern Bool) where + parser = $(fromTidal "binaryN") + +instance Parse ((Time, Time) -> Pattern a -> Pattern a) where + parser = + $(fromTidal "compress") + <|> $(fromTidal "zoom") + <|> $(fromTidal "compressTo") + +pString_pInt_pString :: H (Pattern String -> Pattern Int -> Pattern String) +pString_pInt_pString = $(fromTidal "samples") + +pTime_p_p :: H (Pattern Time -> Pattern a -> Pattern a) +pTime_p_p = + $(fromTidal "fast") + <|> $(fromTidal "fastGap") + <|> $(fromTidal "density") + <|> $(fromTidal "slow") + <|> $(fromTidal "trunc") + <|> $(fromTidal "densityGap") + <|> $(fromTidal "sparsity") + <|> $(fromTidal "linger") + <|> $(fromTidal "segment") + <|> $(fromTidal "discretise") + <|> $(fromTidal "timeLoop") + <|> $(fromTidal "swing") + <|> $(fromTidal "<~") + <|> $(fromTidal "~>") + <|> $(fromTidal "ply") + <|> (parser :: H (Pattern Time -> Pattern Time -> Pattern a -> Pattern a)) <*!> parser + +pInt_p_p :: H (Pattern Int -> Pattern a -> Pattern a) +pInt_p_p = + $(fromTidal "iter") + <|> $(fromTidal "iter'") + <|> $(fromTidal "substruct'") + <|> $(fromTidal "slowstripe") + <|> $(fromTidal "shuffle") + <|> $(fromTidal "scramble") + <|> $(fromTidal "repeatCycles") + <|> $(fromTidal "stripe") + <|> pInt_pInt_p_p <*!> parser + +pInt_pOrd_pOrd :: (Ord a) => H (Pattern Int -> Pattern a -> Pattern a) +pInt_pOrd_pOrd = $(fromTidal "rot") + +pDouble_p_p :: H (Pattern Double -> Pattern a -> Pattern a) +pDouble_p_p = + $(fromTidal "degradeBy") + <|> $(fromTidal "unDegradeBy") + <|> (parser :: H (Int -> Pattern Double -> Pattern a -> Pattern a)) <*!> parser + +pBool_p_p :: H (Pattern Bool -> Pattern a -> Pattern a) +pBool_p_p = + $(fromTidal "mask") + <|> $(fromTidal "struct") + <|> $(fromTidal "substruct") + +instance Parse ([ControlPattern -> ControlPattern] -> ControlPattern -> ControlPattern) where + parser = + $(fromTidal "jux'") + <|> $(fromTidal "juxcut'") + <|> lPatApatA_patA_patA + +-- *** pathway leading to spread(etc) should be incorporated above + +instance {-# OVERLAPPABLE #-} (Parse ((Pattern a -> Pattern a) -> Pattern a -> Pattern a)) => Parse ([Pattern a -> Pattern a] -> Pattern a -> Pattern a) where + parser = lPatApatA_patA_patA + +lPatApatA_patA_patA :: (Parse ((Pattern a -> Pattern a) -> Pattern a -> Pattern a)) => H ([Pattern a -> Pattern a] -> Pattern a -> Pattern a) +lPatApatA_patA_patA = + (parser :: H (((Pattern a -> Pattern a) -> Pattern a -> Pattern a) -> [Pattern a -> Pattern a] -> Pattern a -> Pattern a)) <*> parser + <|> (parser :: H (Pattern Int -> [Pattern a -> Pattern a] -> Pattern a -> Pattern a)) <*> parser + <|> (parser :: H (Pattern Double -> [Pattern a -> Pattern a] -> Pattern a -> Pattern a)) <*> parser + +lp_p_p :: (Parse (Pattern a -> Pattern a -> Pattern a)) => H ([Pattern a] -> Pattern a -> Pattern a) +lp_p_p = (parser :: H ((Pattern a -> Pattern a -> Pattern a) -> [Pattern a] -> Pattern a -> Pattern a)) <*> parser + +instance Parse ([Pattern Double] -> Pattern a -> Pattern a) where + parser = (parser :: H ((Pattern Double -> Pattern a -> Pattern a) -> [Pattern Double] -> Pattern a -> Pattern a)) <*> pDouble_p_p + +instance Parse ([Pattern Time] -> Pattern a -> Pattern a) where + parser = (parser :: H ((Pattern Time -> Pattern a -> Pattern a) -> [Pattern Time] -> Pattern a -> Pattern a)) <*> pTime_p_p + +lpInt_p_p :: H ([Pattern Int] -> Pattern a -> Pattern a) +lpInt_p_p = + $(fromTidal "distrib") + <|> (parser :: H ((Pattern Int -> Pattern a -> Pattern a) -> [Pattern Int] -> Pattern a -> Pattern a)) <*> pInt_p_p + +instance Parse ([Time] -> Pattern a -> Pattern a) where + parser = $(fromTidal "spaceOut") + +-- pathway leading to spread(etc) should be incorporated here + +instance Parse (Pattern Int -> ControlPattern -> ControlPattern) where + parser = + $(fromTidal "chop") + <|> $(fromTidal "striate") + <|> $(fromTidal "gap") + <|> $(fromTidal "randslice") + <|> $(fromTidal "spin") + <|> (parser :: H (Pattern Int -> Pattern Int -> ControlPattern -> ControlPattern)) <*!> parser + +instance Parse (Pattern Double -> ControlPattern -> ControlPattern) where + parser = + (parser :: H (Pattern Int -> Pattern Double -> ControlPattern -> ControlPattern)) <*!> parser + <|> (parser :: H (Pattern Rational -> Pattern Double -> ControlPattern -> ControlPattern)) <*!> parser + +instance Parse (Pattern Time -> ControlPattern -> ControlPattern) where + parser = + $(fromTidal "hurry") + <|> $(fromTidal "loopAt") + <|> $(fromTidal "rolledBy") + <|> (parser :: H (Pattern Double -> Pattern Time -> ControlPattern -> ControlPattern)) <*!> parser + +instance Parse ((ControlPattern -> ControlPattern) -> ControlPattern -> ControlPattern) where + parser = + genericAppliedTransformations + <|> $(fromTidal "jux") + <|> $(fromTidal "juxcut") + <|> $(fromTidal "jux4") + <|> pDouble_controlMapToValueMap_controlMap_controlMap <*!> parser + +instance Parse ((Pattern Bool -> Pattern Bool) -> Pattern Bool -> Pattern Bool) where + parser = genericAppliedTransformations + +instance Parse ((Pattern String -> Pattern String) -> Pattern String -> Pattern String) where + parser = genericAppliedTransformations + +instance Parse ((Pattern Int -> Pattern Int) -> Pattern Int -> Pattern Int) where + parser = genericAppliedTransformations + +instance Parse ((Pattern Integer -> Pattern Integer) -> Pattern Integer -> Pattern Integer) where + parser = genericAppliedTransformations + +instance Parse ((Pattern Time -> Pattern Time) -> Pattern Time -> Pattern Time) where + parser = genericAppliedTransformations + +instance Parse ((Pattern Double -> Pattern Double) -> Pattern Double -> Pattern Double) where + parser = genericAppliedTransformations + +instance Parse ((Pattern Note -> Pattern Note) -> Pattern Note -> Pattern Note) where + parser = genericAppliedTransformations + +genericAppliedTransformations :: H ((Pattern a -> Pattern a) -> Pattern a -> Pattern a) +genericAppliedTransformations = + $(fromHaskell "$") + <|> $(fromTidal "sometimes") + <|> $(fromTidal "often") + <|> $(fromTidal "rarely") + <|> $(fromTidal "almostNever") + <|> $(fromTidal "almostAlways") + <|> $(fromTidal "never") + <|> $(fromTidal "always") + <|> $(fromTidal "superimpose") + <|> $(fromTidal "someCycles") + <|> (parser :: H (Pattern Time -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H (Pattern Int -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H (Pattern Double -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ([Int] -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H ((Time, Time) -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H (Pattern Bool -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + +instance Parse ([a] -> Pattern Int -> Pattern a) where + parser = (parser :: H (Pattern Int -> [a] -> Pattern Int -> Pattern a)) <*!> parser + +-- pathway leading to spread(etc) should be incorporated here + +instance Parse (String -> Pattern Double -> ControlPattern) where + parser = $(fromTidal "pF") + +instance Parse (String -> Pattern Note -> ControlPattern) where + parser = $(fromTidal "pN") + +instance Parse (String -> Pattern Int -> ControlPattern) where + parser = $(fromTidal "pI") + +instance Parse (String -> Pattern String -> ControlPattern) where + parser = $(fromTidal "pS") + +instance Parse (Pattern Double -> [Pattern a] -> Pattern a) where + parser = $(fromTidal "select") + +instance Parse (Pattern Int -> [Pattern a] -> Pattern a) where + parser = $(fromTidal "squeeze") + +instance (Fractional a) => Parse (Pattern String -> Pattern Int -> Pattern a) where + parser = $(fromTidal "scale") + +listNumA_pInt_pA :: (Num a) => H ([a] -> Pattern Int -> Pattern a) +listNumA_pInt_pA = $(fromTidal "toScale") + +-- *** pathway leading to spread(etc) should be incorporated here + +pString_p_p :: H (Pattern String -> Pattern a -> Pattern a) +pString_p_p = $(fromTidal "arp") + +instance Parse (ControlPattern -> [ControlPattern] -> ControlPattern) where + parser = (parser :: H (Time -> ControlPattern -> [ControlPattern] -> ControlPattern)) <*!> parser + +instance Parse (Pattern a -> [Pattern a -> Pattern a] -> Pattern a) where + parser = (parser :: H (Time -> Pattern a -> [Pattern a -> Pattern a] -> Pattern a)) <*!> parser + +pAB_pA_pB :: H ((Pattern a -> Pattern b) -> Pattern a -> Pattern b) +pAB_pA_pB = pTime_pAB_pA_pB <*!> parser + +pDouble_list_p :: (Parse a) => H (Pattern Double -> [a] -> Pattern a) +pDouble_list_p = $(fromTidal "chooseBy") + +pDouble_tupleApDouble_p :: (Parse a) => H (Pattern Double -> [(a, Pattern Double)] -> Pattern a) +pDouble_tupleApDouble_p = $(fromTidal "wchooseBy") + +instance Parse (String -> String -> Pattern String) where + parser = $(fromTidal "sseq") + +instance Parse ([String] -> String -> Pattern String) where + parser = $(fromTidal "sseq'") + +instance Parse (String -> String -> String) where + parser = (parser :: H (Int -> String -> String -> String)) <*!> parser + +floating_pFloating_pFloating :: (Floating a, Parse a) => H (a -> Pattern a -> Pattern a) +floating_pFloating_pFloating = floating_floating_pFloating_pFloating <*!> parser + +realFrac_pRealFrac_pRealFrac :: (RealFrac a) => H (a -> Pattern a -> Pattern a) +realFrac_pRealFrac_pRealFrac = $(fromTidal "quantise") + +instance Parse (Double -> String -> Pattern Double) where + parser = $(fromTidal "cF") + +-- * -> * -> * -> * + +numTernaryTransformations :: (Num a) => H (Pattern a -> Pattern a -> Pattern a -> Pattern a) +numTernaryTransformations = $(fromTidal "range") + +instance Parse (Pattern Int -> Pattern Int -> ControlPattern -> ControlPattern) where + parser = + $(fromTidal "slice") + <|> $(fromTidal "splice") + <|> $(fromTidal "chew") + <|> $(fromTidal "bite") + +instance Parse (Time -> Time -> Pattern a -> Pattern a) where + parser = $(fromTidal "playFor") + +instance Parse (Pattern Time -> Pattern Time -> Pattern a -> Pattern a) where + parser = $(fromTidal "swingBy") + +pTime_p_p_p :: H (Pattern Time -> Pattern a -> Pattern a -> Pattern a) +pTime_p_p_p = $(fromTidal "wedge") + +instance Parse (Pattern Bool -> Pattern a -> Pattern a -> Pattern a) where + parser = $(fromTidal "sew") + +instance Parse (Pattern Bool -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = $(fromTidal "while") + +pInt_pInt_p_p :: H (Pattern Int -> Pattern Int -> Pattern a -> Pattern a) +pInt_pInt_p_p = + $(fromTidal "euclid") + <|> $(fromTidal "euclidInv") + <|> (parser :: H (Int -> Pattern Int -> Pattern Int -> Pattern a -> Pattern a)) <*!> parser + +instance Parse (Int -> Pattern Double -> Pattern a -> Pattern a) where + parser = $(fromTidal "degradeOverBy") + +instance Parse ((a -> b -> Pattern c) -> [a] -> b -> Pattern c) where + parser = + $(fromTidal "spread") + <|> $(fromTidal "slowspread") + <|> $(fromTidal "fastspread") + <|> $(fromTidal "spreadChoose") + <|> $(fromTidal "spreadr") + +pInt_p_p_p :: H (Pattern Int -> Pattern a -> Pattern a -> Pattern a) +pInt_p_p_p = (parser :: H (Pattern Int -> Pattern Int -> Pattern a -> Pattern a -> Pattern a)) <*!> parser + +pBool_p_p_p :: H (Pattern Bool -> Pattern a -> Pattern a -> Pattern a) +pBool_p_p_p = $(fromTidal "stitch") + +instance Parse (Pattern Int -> Pattern Double -> ControlPattern -> ControlPattern) where + parser = $(fromTidal "striate'") <|> $(fromTidal "striateBy") + +instance Parse (Pattern Double -> Pattern Time -> ControlPattern -> ControlPattern) where + parser = (parser :: H (Pattern Integer -> Pattern Double -> Pattern Time -> ControlPattern -> ControlPattern)) <*!> parser + +instance Parse (Pattern Time -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = + $(fromTidal "off") + <|> $(fromTidal "plyWith") + <|> (parser :: H (Pattern Time -> Pattern Time -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + <|> (parser :: H (Pattern Int -> Pattern Time -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser + +pTime_pAB_pA_pB :: H (Pattern Time -> (Pattern a -> Pattern b) -> Pattern a -> Pattern b) +pTime_pAB_pA_pB = + $(fromTidal "inside") + <|> $(fromTidal "outside") + +instance Parse (Pattern Int -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = + $(fromTidal "every") + <|> $(fromTidal "plyWith") + <|> $(fromTidal "chunk") + <|> $(fromTidal "chunk'") + <|> (parser :: H (Pattern Int -> Pattern Int -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a)) <*!> parser -- note: chunk' is actually generalized to Integral, but not clear what non-Int cases would be + +instance Parse (Pattern Double -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = + $(fromTidal "sometimesBy") + <|> $(fromTidal "someCyclesBy") + <|> $(fromTidal "plyWith") + +pDouble_controlMapToValueMap_controlMap_controlMap :: H (Pattern Double -> (Pattern ValueMap -> Pattern ValueMap) -> Pattern ValueMap -> Pattern ValueMap) +pDouble_controlMapToValueMap_controlMap_controlMap = + $(fromTidal "juxBy") + <|> (parser :: H (Pattern Double -> (Pattern ValueMap -> Pattern ValueMap) -> Pattern ValueMap -> Pattern ValueMap)) + +instance Parse ((ControlPattern -> ControlPattern) -> ControlPattern -> ControlPattern -> ControlPattern) where + parser = + $(fromTidal "fix") + <|> $(fromTidal "unfix") + <|> (parser :: H ((ControlPattern -> ControlPattern) -> (ControlPattern -> ControlPattern) -> ControlPattern -> ControlPattern -> ControlPattern)) + <*!> parser + "expected (ControlPattern -> ControlPattern) -> ControlPattern -> ControlPattern -> ControlPattern" + +instance Parse ([Int] -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = $(fromTidal "foldEvery") + +instance Parse ((Time, Time) -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = $(fromTidal "within") + +instance Parse (Pattern Int -> [a] -> Pattern Int -> Pattern a) where + parser = $(fromTidal "fit") + +instance Parse (Pattern Int -> [Pattern a -> Pattern a] -> Pattern a -> Pattern a) where + parser = $(fromTidal "pickF") + +instance Parse (Time -> ControlPattern -> [ControlPattern] -> ControlPattern) where + parser = $(fromTidal "weave") + +instance Parse (Time -> Pattern a -> [Pattern a -> Pattern a] -> Pattern a) where + parser = $(fromTidal "weaveWith") + +instance Parse (Pattern Double -> [Pattern a -> Pattern a] -> Pattern a -> Pattern a) where + parser = $(fromTidal "selectF") + +instance Parse (Int -> String -> String -> String) where + parser = $(fromTidal "lindenmayer") + +floating_floating_pFloating_pFloating :: (Floating a) => H (a -> a -> Pattern a -> Pattern a) +floating_floating_pFloating_pFloating = $(fromTidal "rangex") + +-- note: rangex actually generalized to Functor a rather than Pattern a, so we are over-specializing + +integral_time_pA_pA :: (Integral i) => H (i -> Time -> Pattern a -> Pattern a) +integral_time_pA_pA = $(fromTidal "stutter") + +instance Parse (Pattern Rational -> Pattern Double -> ControlPattern -> ControlPattern) where + parser = (parser :: H (Pattern Integer -> Pattern Rational -> Pattern Double -> ControlPattern -> ControlPattern)) <*!> parser + +-- * -> * -> * -> * -> * + +instance Parse (Pattern Int -> Pattern Int -> Pattern a -> Pattern a -> Pattern a) where + parser = $(fromTidal "euclidFull") + +instance Parse (Int -> Pattern Int -> Pattern Int -> Pattern a -> Pattern a) where + parser = (parser :: H (Pattern Time -> Int -> Pattern Int -> Pattern Int -> Pattern a -> Pattern a)) <*!> parser + +instance Parse (Pattern Integer -> Pattern Double -> Pattern Time -> ControlPattern -> ControlPattern) where + parser = $(fromTidal "stut") + +instance Parse (Pattern Integer -> Pattern Rational -> Pattern Double -> ControlPattern -> ControlPattern) where + parser = $(fromTidal "echo") + +instance Parse (Pattern Int -> Pattern Int -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = $(fromTidal "every'") + +instance Parse (Pattern Int -> Pattern Time -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = + $(fromTidal "stutWith") + <|> $(fromTidal "echoWith") + +instance Parse (Pattern Time -> Pattern Time -> (Pattern a -> Pattern a) -> Pattern a -> Pattern a) where + parser = $(fromTidal "whenmod") + +instance Parse ((ControlPattern -> ControlPattern) -> (ControlPattern -> ControlPattern) -> ControlPattern -> ControlPattern -> ControlPattern) where + parser = $(fromTidal "contrast") + +-- * -> * -> * -> * -> * -> * + +instance Parse (Pattern Time -> Int -> Pattern Int -> Pattern Int -> Pattern a -> Pattern a) where + parser = $(fromTidal "fit'") diff --git a/src/Sound/Tidal/Parse/TH.hs b/src/Sound/Tidal/Parse/TH.hs new file mode 100644 --- /dev/null +++ b/src/Sound/Tidal/Parse/TH.hs @@ -0,0 +1,28 @@ +{-# LANGUAGE TemplateHaskell #-} + +module Sound.Tidal.Parse.TH where + +import Language.Haskell.TH +import Language.Haskellish + +-- example: $(fromTidal "jux") ...is translated as... T.jux <$ reserved "jux" +fromTidal :: String -> Q Exp +fromTidal x = do + let y = return (VarE $ mkName $ "T." ++ x) + let z = appE [|reserved|] $ return (LitE $ StringL x) + uInfixE y [|(<$)|] z + +-- example: $(fromTidalList ["major","minor"]) +fromTidalList :: [String] -> Q Exp +fromTidalList xs = do + xs' <- mapM fromTidal xs -- :: Q [Exp] + choice <- [|(<|>)|] + let f a b = UInfixE a choice b + return $ foldl1 f xs' + +-- example: $(fromHaskell "+") ...is translated as... + <$ reserved "+" +fromHaskell :: String -> Q Exp +fromHaskell x = do + let y = return (VarE $ mkName $ x) + let z = appE [|reserved|] $ return (LitE $ StringL x) + uInfixE y [|(<$)|] z diff --git a/test/Sound/Tidal/TidalParseTest.hs b/test/Sound/Tidal/TidalParseTest.hs new file mode 100644 --- /dev/null +++ b/test/Sound/Tidal/TidalParseTest.hs @@ -0,0 +1,311 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Sound.Tidal.TidalParseTest where + +import Data.Either +import qualified Data.Map.Strict as Map + +import Sound.Tidal.Chords as Tidal +import Sound.Tidal.Control as Tidal +import Sound.Tidal.Core as Tidal +import Sound.Tidal.Params as Tidal +import Sound.Tidal.Pattern as Tidal +import Sound.Tidal.UI as Tidal + +import Sound.Tidal.Parse +import Sound.Tidal.Scales () +import Sound.Tidal.Show () +import Sound.Tidal.Simple () + +import Test.Hspec + +stripContext :: Pattern a -> Pattern a +stripContext = setContext $ Context [] + +parsesTo :: String -> ControlPattern -> Expectation +parsesTo str p = x `shouldBe` y + where + x = query . stripContext <$> parseTidal str <*> Right (State (Arc 0 16) Map.empty) + y = Right $ queryArc (stripContext p) (Arc 0 16) + +causesParseError :: String -> Expectation +causesParseError str = isLeft (parseTidal str :: Either String ControlPattern) `shouldBe` True + +run :: Spec +run = + describe "parseTidal" $ do + it "parses the empty string as silence" $ + "" `parsesTo` silence + + it "parses a string containing only spaces as silence" $ + " " `parsesTo` silence + + it "parses a string containing only a one-line comment as silence" $ + "-- commented out" `parsesTo` silence + + it "parses a string containing only a multi-line comment as silence" $ + "{- commented out \n this is another line}" `parsesTo` silence + + it "parses the identifier silence as silence" $ + "silence" `parsesTo` silence + + it "parses a very simple single 's' pattern" $ + "s \"bd cp\"" `parsesTo` s "bd cp" + + it "parses a very simple single 's' pattern with a same line comment" $ + "s \"bd cp\" -- comment " `parsesTo` s "bd cp" + + it "parses a very simple single 's' pattern with a multi line comment" $ + "s \"bd cp\" {- \n comment -}" `parsesTo` s "bd cp" + + it "parses a very simple single 'sound' pattern" $ + "sound \"bd cp\"" `parsesTo` sound "bd cp" + + it "parses a single 's' pattern that uses angle brackets" $ + "s \"\"" `parsesTo` s "" + + it "parses a single 's' pattern that uses square brackets" $ + "s \"[bd sn] cp\"" `parsesTo` s "[bd sn] cp" + + it "parses a single 's' pattern that uses square brackets and *" $ + "s \"[bd sn]*2 cp\"" `parsesTo` s "[bd sn]*2 cp" + + it "parses a single 's' pattern that uses Bjorklund rhythms" $ + "s \"sn(5,16)\"" `parsesTo` s "sn(5,16)" + + it "parses a literal int as a double pattern" $ + "pan 0" `parsesTo` (pan 0) + it "parses a literal double as a double pattern" $ + "pan 1.0" `parsesTo` (pan 1.0) + + it "parses a negative literal double as a double pattern" $ + "pan (-1.0)" `parsesTo` (pan (-1.0)) + + it "parses two merged patterns" $ + "s \"bd cp\" # pan \"0 1\"" `parsesTo` (s "bd cp" # pan "0 1") + + it "parses three merged patterns" $ + "s \"bd cp\" # pan \"0 1\" # gain \"0.5 0.7\"" + `parsesTo` (s "bd cp" # pan "0 1" # gain "0.5 0.7") + + it "parses three merged patterns, everything in brackets" $ + "(s \"bd cp\" # pan \"0 1\" # gain \"0.5 0.7\")" + `parsesTo` ((s "bd cp" # pan "0 1" # gain "0.5 0.7")) + + it "parses three merged patterns, everything in muliple layers of brackets" $ + "(((s \"bd cp\" # pan \"0 1\" # gain \"0.5 0.7\")))" + `parsesTo` ((((s "bd cp" # pan "0 1" # gain "0.5 0.7")))) + + it "parses three merged patterns with right associative brackets" $ + "s \"bd cp\" # (pan \"0 1\" # gain \"0.5 0.7\")" + `parsesTo` (s "bd cp" # (pan "0 1" # gain "0.5 0.7")) + + it "parses three merged patterns with left associative brackets" $ + "(s \"bd cp\" # pan \"0 1\") # gain \"0.5 0.7\"" + `parsesTo` ((s "bd cp" # pan "0 1") # gain "0.5 0.7") + + it "parses simple patterns in brackets applied to ParamPattern functions" $ + "s (\"bd cp\")" `parsesTo` (s ("bd cp")) + + it "parses simple patterns applied to ParamPattern functions with $" $ + "s $ \"bd cp\"" `parsesTo` (s $ "bd cp") + + it "parses addition of simple patterns" $ + "n (\"0 1\" + \"2 3\")" `parsesTo` (n ("0 1" + "2 3")) + + it "parses multiplication of simple patterns as a merged parampattern" $ + "s \"arpy*8\" # up (\"3\" * \"2\")" `parsesTo` (s "arpy*8" # up ("3" * "2")) + + it "parses pan patterns" $ + "pan \"0 0.25 0.5 0.75 1\"" `parsesTo` (pan "0 0.25 0.5 0.75 1") + + it "parses note patterns" $ + "note \"0 0.25 0.5 0.75 1\"" `parsesTo` (note "0 0.25 0.5 0.75 1") + + it "parses sine oscillators" $ + "pan sine" `parsesTo` (pan sine) + + it "parses sine oscillators used in pan patterns" $ + "s \"arpy*8\" # pan sine" `parsesTo` (s "arpy*8" # pan sine) + + it "parses striate transformations of s patterns" $ + "striate 8 $ s \"arpy*8\"" `parsesTo` (striate 8 $ s "arpy*8") + + it "parses chop transformations of s patterns" $ + "chop 8 $ s \"arpy*8\"" `parsesTo` (chop 8 $ s "arpy*8") + + it "parses fast transformations of parampatterns" $ + "fast 2 $ s \"bd cp\"" `parsesTo` (fast 2 $ s "bd cp") + + it "parses fast transformations of parampatterns when in brackets" $ + "(fast 2) $ s \"bd cp\"" `parsesTo` ((fast 2) $ s "bd cp") + + it "parses rev transformations of parampatterns" $ + "rev $ s \"bd cp\"" `parsesTo` (rev $ s "bd cp") + + it "parses rev transformations of parampatterns when in brackets" $ + "(rev) $ s \"bd cp\"" `parsesTo` ((rev) $ s "bd cp") + + it "parses jux transformations with transformations in brackets" $ + "jux (rev) $ s \"arpy*8\" # up \"0 2 3 5 3 5 7 8\"" + `parsesTo` (jux (rev) $ s "arpy*8" # up "0 2 3 5 3 5 7 8") + + it "parses jux transformations with transformations not in brackets" $ + "jux rev $ s \"arpy*8\" # up \"0 2 3 5 3 5 7 8\"" + `parsesTo` (jux rev $ s "arpy*8" # up "0 2 3 5 3 5 7 8") + + it "doesn't parse when a transformation requiring an argument is provided without parens or $ to jux" $ + causesParseError "jux fast 2 $ s \"bd*4 cp\"" + + it "parses multiple fast transformations of parampatterns" $ + "fast 2 $ fast 2 $ s \"bd cp\"" `parsesTo` (fast 2 $ fast 2 $ s "bd cp") + + it "parses an 'every' transformation applied to a simple s pattern" $ + "every 2 (fast 2) (s \"bd cp\")" `parsesTo` (every 2 (fast 2) (s "bd cp")) + + it "parses a transformed pattern merged with a pattern constructed from parampatterning an arithmetic expression on patterns" $ + "(every 2 (fast 2) $ s \"arpy*8\") # up (\"[0 4 7 2,16 12 12 16]\" - \"<0 3 5 7>\")" `parsesTo` ((every 2 (fast 2) $ s "arpy*8") # up ("[0 4 7 2,16 12 12 16]" - "<0 3 5 7>")) + + it "parses a fast transformation applied to a simple (ie. non-param) pattern" $ + "up (fast 2 \"<0 2 3 5>\")" + `parsesTo` (up (fast 2 "<0 2 3 5>")) + + it "parses a partially-applied pattern transformation spread over patterns" $ + "spread (fast) [2,1,1.5] $ s \"bd sn cp sn\"" + `parsesTo` (spread (fast) [2, 1, 1.5] $ s "bd sn cp sn") + + it "parses a binary Num function spread over a simple Num pattern" $ + "n (spread (+) [2,3,4] \"1 2 3\")" + `parsesTo` (n (spread (+) [2, 3, 4] "1 2 3")) + + it "parses an $ application spread over partially applied transformations of a non-Control Pattern" $ + "n (spread ($) [density 2, rev, slow 2] $ \"1 2 3 4\")" + `parsesTo` (n (spread ($) [density 2, rev, slow 2] $ "1 2 3 4")) + + it "parses an $ application spread over transformations of a control pattern" $ + "spread ($) [fast 2,fast 4] $ s \"bd cp\"" + `parsesTo` (spread ($) [fast 2, fast 4] $ s "bd cp") + + it "parses functions spread over transformations of a control pattern, via spreadf" $ + "spreadf [fast 2,fast 4] $ s \"bd cp\"" + `parsesTo` (spreadf [fast 2, fast 4] $ s "bd cp") + + it "parses an $ application spread over partially applied transformations of a Control Pattern" $ + "spread ($) [density 2, rev, slow 2, striate 3] $ sound \"[bd*2 [~ bd]] [sn future]*2 cp jvbass*4\"" + `parsesTo` (spread ($) [density 2, rev, slow 2, striate 3] $ sound "[bd*2 [~ bd]] [sn future]*2 cp jvbass*4") + + it "parses an off transformation" $ + "off 0.125 (fast 2) $ s \"bd sn cp glitch\"" + `parsesTo` (off 0.125 (fast 2) $ s "bd sn cp glitch") + + it "parses a pattern rotation operator (1)" $ + "0.25 <~ (s \"bd sn cp glitch\")" + `parsesTo` (0.25 <~ (s "bd sn cp glitch")) + + it "parses a pattern rotation operator (2)" $ + "0.25 <~ s \"bd sn cp glitch\"" + `parsesTo` (0.25 <~ s "bd sn cp glitch") + + it "parses a pattern rotation operator (3)" $ + "\"0.25 0.125 0 0.5\" <~ s \"bd sn cp glitch\"" + `parsesTo` ("0.25 0.125 0 0.5" <~ s "bd sn cp glitch") + + it "parses a pattern rotation operator (3) applied to a transformation with $" $ + "fast 4 $ \"<0 [0.125,0.25]>\" <~ s \"bd cp sn glitch:2\"" + `parsesTo` (fast 4 $ "<0 [0.125,0.25]>" <~ s "bd cp sn glitch:2") + + it "parses a left section transformation of a controlpattern" $ + "every 2 (s \"arpy*8\" #) $ s \"drum\"" + `parsesTo` (every 2 (s "arpy*8" #) $ s "drum") + + it "parses a right section transformation of a controlpattern" $ + "every 2 (# n \"3 4\") $ s \"drum\"" + `parsesTo` (every 2 (# n "3 4") $ s "drum") + + it "parses right sections in a list with spread" $ + "spread ($) [(# n \"4 5 6 7\"),(# n \"0 1 2 3\")] $ s \"drum*4\"" + `parsesTo` (spread ($) [(# n "4 5 6 7"), (# n "0 1 2 3")] $ s "drum*4") + + it "parses pattern merges spread with #" $ + "spread (#) [n \"4 5 6 7\",n \"0 1 2 3\"] $ s \"drum*4\"" + `parsesTo` (spread (#) [n "4 5 6 7", n "0 1 2 3"] $ s "drum*4") + + it "parses a left section pattern rotation operator in an every expression" $ + "every 2 (0.0625 ~>) $ (0.5 ~>) $ s \"snare\"" + `parsesTo` (every 2 (0.0625 ~>) $ (0.5 ~>) $ s "snare") + + it "parses a right section |> operator in an every expression" $ + "every 2 (|> speed \"2\") $ sound \"arpy*4\" |> speed \"1\"" + `parsesTo` (every 2 (|> speed "2") $ sound "arpy*4" |> speed "1") + + it "parses a complex expression with multiple every, left sections and |>" $ + "every 3 (|- note \"3\") $ every 2 (|+ up \"5\") $ sound \"arpy*4\" |> note \"0 2 4 5\"" + `parsesTo` (every 3 (|- note "3") $ every 2 (|+ up "5") $ sound "arpy*4" |> note "0 2 4 5") + + it "parses an expression with run" $ + "up (run 12) # sound \"arpy\"" + `parsesTo` (up (Tidal.run 12) # sound "arpy") + + it "parses an expression with range" $ + "sound \"bd*8 sn*8\" # speed (range 1 3 $ tri)" + `parsesTo` (sound "bd*8 sn*8" # speed (range 1 3 $ tri)) + + it "parses a rotation operator with BP pattern as left argument" $ + "\"[0 0.25]/4\" <~ (sound \"bd*2 cp*2 hh sn\")" + `parsesTo` ("[0 0.25]/4" <~ (sound "bd*2 cp*2 hh sn")) + + it "parses a sometimesBy application with a right section" $ + "sometimesBy 0.75 (# crush 4) $ sound \"bd arpy sn ~\"" + `parsesTo` (sometimesBy 0.75 (# crush 4) $ sound "bd arpy sn ~") + + it "parses a whenmod application" $ + "whenmod 8 6 (rev) $ sound \"bd*2 arpy*2 cp hh*4\"" + `parsesTo` (whenmod 8 6 (rev) $ sound "bd*2 arpy*2 cp hh*4") + + it "parses a complex example with const" $ + "every 12 (const $ sound \"bd*4 sn*2\") $ sound \"bd sn bass2 sn\"" + `parsesTo` (every 12 (const $ sound "bd*4 sn*2") $ sound "bd sn bass2 sn") + + it "parses an example with fastcat" $ + "fastcat [sound \"bd sn:2\" # vowel \"[a o]/2\", sound \"casio casio:1 casio:2*2\"]" + `parsesTo` (fastcat [sound "bd sn:2" # vowel "[a o]/2", sound "casio casio:1 casio:2*2"]) + + it "parses an example with stack" $ + "stack [s \"bd cp\",s \"arpy*8\"]" + `parsesTo` (stack [s "bd cp", s "arpy*8"]) + + it "parses an example with samples and cut" $ + "sound (samples \"arpy*8\" (run 8)) # speed \"0.25\" # cut \"1\"" + `parsesTo` (sound (samples "arpy*8" (Tidal.run 8)) # speed "0.25" # cut "1") + + it "parses an example with sew" $ + "sound \"cp*16\" |+| gain (sew \"t(3,8)\" \"1*8\" \"0.75*8\")" + `parsesTo` (sound "cp*16" |+| gain (sew "t(3,8)" "1*8" "0.75*8")) + + it "parses an example with stutWith" $ + "stutWith 16 0.125 (|* gain 0.9) $ s \"bass:2/2\"" + `parsesTo` (stutWith 16 0.125 (|* gain 0.9) $ s "bass:2/2") + + it "parses an example with choose and a chords from Sound.Tidal.Chords" $ + "s \"arpy*8\" # note (choose major)" + `parsesTo` (s "arpy*8" # note (Tidal.choose major)) + + it "parses an example with the SemiGroup operator" $ + "s \"bd*4\" <> s \"cp*5\"" + `parsesTo` (s "bd*4" <> s "cp*5") + + it "parses an example with sseq" $ + "s (sseq \"tink\" \"xx x\")" + `parsesTo` (s (sseq "tink" "xx x")) + + it "parses an example with sseq'" $ + "s (sseq' [\"tink\",\"feel\"] \"01 0\")" + `parsesTo` (s (sseq' ["tink", "feel"] "01 0")) + + it "parses an example with sseqs" $ + "s (sseqs [(\"tink\",\" x x\"),(\"feel\", \"x x \")])" + `parsesTo` (s (sseqs [("tink", " x x"), ("feel", "x x ")])) + + it "parses an example with times" $ + "rolledBy 0.45 $ n \"\"" + `parsesTo` (rolledBy 0.45 $ n "") diff --git a/test/Test.hs b/test/Test.hs new file mode 100644 --- /dev/null +++ b/test/Test.hs @@ -0,0 +1,8 @@ +{-# LANGUAGE OverloadedStrings #-} + +import Sound.Tidal.TidalParseTest +import Test.Hspec + +main :: IO () +main = hspec $ do + Sound.Tidal.TidalParseTest.run diff --git a/tidal-parse.cabal b/tidal-parse.cabal new file mode 100644 --- /dev/null +++ b/tidal-parse.cabal @@ -0,0 +1,61 @@ +name: tidal-parse +version: 0.0.3 +synopsis: Parser for TidalCycles +-- description: +homepage: http://tidalcycles.org/ +license: GPL-3 +license-file: LICENSE +author: David Ogborn +maintainer: David Ogborn , Alex McLean +Stability: Experimental +Copyright: (c) David Ogborn and contributors, 2025 +category: Sound +build-type: Simple +cabal-version: >=1.10 +tested-with: GHC == 7.10.3, GHC == 8.0.2, GHC == 8.2.2, GHC == 8.4.4, GHC == 8.6.3 + +Extra-source-files: README.md + +Description: A parser for TidalCycles, used for example to interpret Tidal in a web browser (via ghcjs) + +library + ghc-options: -Wall + hs-source-dirs: + src + + default-language: Haskell2010 + + Exposed-modules: Sound.Tidal.Parse + other-modules: Sound.Tidal.Parse.TH + + Build-depends: + base >=4.8 && <5 + , tidal-core >= 1.10.0 && < 1.11.0 + , transformers >= 0.5 && < 0.7 + , template-haskell + , haskellish >= 0.3.2 && < 0.4 + , containers < 0.9 + , mtl >= 2.2.2 && <2.4 + , text < 2.2 + + if !impl(ghc >= 8.4.1) + build-depends: semigroups >= 0.18 && < 0.20 + +test-suite tests + type: exitcode-stdio-1.0 + main-is: Test.hs + hs-source-dirs: + test + ghc-options: -Wall + other-modules: Sound.Tidal.TidalParseTest + build-depends: + base ==4.* + , hspec >=2.11.9 + , containers < 0.9 + , tidal-parse + , tidal-core + default-language: Haskell2010 + +source-repository head + type: git + location: https://codeberg.org/uzu/tidal